From 2f711746366f18454e4ef689ce79b43ef76a3f3c Mon Sep 17 00:00:00 2001 From: Andy Date: Fri, 6 Jan 2017 12:36:57 -0800 Subject: [PATCH] Restructure to support old versions (#13811) * Restructure to support old versions * Fix tests --- .gitignore | 1 - acl/tsconfig.json | 4 +- adal/tsconfig.json | 4 +- ag-grid/ag-grid.d-2.1.2.ts | 1992 - amqplib/amqplib-0.3.d.ts | 219 - angular-clipboard/angular-clipboard-tests.ts | 3 - angular-material/angular-material-0.8.3.d.ts | 195 - angular-material/angular-material-0.9.0.d.ts | 204 - .../angular-permission-2.3.1-tests.ts | 92 - .../angular-permission-2.3.1.d.ts | 165 - angular/UNUSED_FILES.txt | 1 + angular/legacy/angular-1.0-tests.ts | 219 - angular/legacy/angular-1.0.d.ts | 760 - angular/legacy/angular-1.2-tests.ts | 571 - angular/legacy/angular-1.2.d.ts | 1189 - angular/legacy/angular-1.4.d.ts | 1877 - angular/legacy/angular-animate-1.2.d.ts | 110 - angular/legacy/angular-animate-1.3.d.ts | 261 - angular/legacy/angular-cookies-1.0.d.ts | 30 - angular/legacy/angular-cookies-1.2.d.ts | 43 - angular/legacy/angular-mocks-1.0.d.ts | 150 - angular/legacy/angular-mocks-1.2-tests.ts | 305 - angular/legacy/angular-mocks-1.2.d.ts | 226 - angular/legacy/angular-resource-1.0.d.ts | 82 - angular/legacy/angular-resource-1.2-tests.ts | 138 - angular/legacy/angular-resource-1.2.d.ts | 152 - angular/legacy/angular-resource-1.3.d.ts | 185 - angular/legacy/angular-route-1.2-tests.ts | 17 - angular/legacy/angular-route-1.2.d.ts | 145 - angular/legacy/angular-sanitize-1.0.d.ts | 22 - angular/legacy/angular-sanitize-1.2-tests.ts | 32 - angular/legacy/angular-sanitize-1.2.d.ts | 35 - angular/legacy/angular-scenario-1.0.d.ts | 155 - angular/legacy/angular-scenario-1.2.d.ts | 166 - angular/tsconfig.json | 2 +- async/asyncamd-tests.ts | 5 - async/tsconfig.json | 5 +- atom/tsconfig.json | 1 + aws4/aws4-tests.ts | 4 +- backbone/backbone-with-lodash-tests.ts | 5 +- backbone/tsconfig.json | 3 +- .../{base64url-test.ts => base64url-tests.ts} | 0 base64url/tsconfig.json | 2 +- .../bluebird-tests.ts} | 0 bluebird/{bluebird-1.0.d.ts => v1/index.d.ts} | 0 bluebird/v1/tsconfig.json | 23 + .../bluebird-tests.ts} | 2 - bluebird/{bluebird-2.0.d.ts => v2/index.d.ts} | 0 bluebird/v2/tsconfig.json | 23 + .../index.d.ts} | 2 +- bootstrap.v3.datetimepicker/v3/tsconfig.json | 22 + ...tests-global.ts => bowser-global-tests.ts} | 0 ...tests-module.ts => bowser-module-tests.ts} | 0 bowser/tsconfig.json | 4 +- business-rules-engine/tsconfig.json | 12 +- chai/chai-3.2.0-tests.ts | 1966 - chai/chai-3.2.0.d.ts | 391 - chai/{chai-2.0.0.d.ts => v2/index.d.ts} | 0 chai/v2/tsconfig.json | 22 + .../chroma-js-tests.ts} | 2 - .../{chroma-js-0.5.6.d.ts => v0/index.d.ts} | 0 chroma-js/v0/tsconfig.json | 23 + codemirror/codemirror-matchbrackets.d.ts | 4 +- codemirror/codemirror-runmode.d.ts | 4 +- codemirror/codemirror-showhint.d.ts | 4 +- codemirror/searchcursor.d.ts | 4 +- codemirror/tsconfig.json | 10 +- .../color-tests.ts} | 0 color/{index-0.12.0.d.ts => v0/index.d.ts} | 0 {xrm/v7.1 => color/v0}/tsconfig.json | 17 +- colors/tsconfig.json | 3 +- .../connect-modrewrite-tests.ts | 3 +- cordova/.gitignore | 1 - cryptojs/all-tests.ts | 57 - cryptojs/tsconfig.json | 56 +- cson/cson-test.cson | 1 - cson/cson-test.json | 1 - d3-dsv/v0/index.d.ts | 93 +- d3-dsv/v0/tsconfig.json | 23 + d3-dsv/v0/tslint.json | 1 + .../{d3-hexbin-test.ts => d3-hexbin-tests.ts} | 0 d3-hexbin/tsconfig.json | 2 +- d3-request/tsconfig.json | 2 +- d3/legacy/plugins/d3.superformula-tests.ts | 39 - d3/legacy/plugins/index.d.ts | 44 - d3/legacy/plugins/package.json | 5 - d3/{d3-v3.5-tests.ts => v3/d3-tests.ts} | 0 d3/{d3-v3.5.d.ts => v3/index.d.ts} | 0 {jasmine/legacy => d3/v3}/tsconfig.json | 12 +- .../d3kit-tests.ts} | 1 - d3kit/{d3kit-v1.1.0.d.ts => v1/index.d.ts} | 7 +- d3kit/v1/tsconfig.json | 24 + dc/dc-1.6.0.d.ts | 207 - devextreme/devextreme-15.1.3.d.ts | 6403 --- devextreme/devextreme-15.1.4.d.ts | 6448 --- devextreme/devextreme-15.1.5.d.ts | 6497 --- devextreme/devextreme-15.1.6.d.ts | 6621 --- devextreme/devextreme-15.1.7.d.ts | 6572 --- devextreme/devextreme-15.1.8.d.ts | 6580 --- devextreme/devextreme-15.2.10.d.ts | 7504 --- devextreme/devextreme-15.2.12.d.ts | 7531 --- devextreme/devextreme-15.2.4.d.ts | 7325 --- devextreme/devextreme-15.2.5.d.ts | 7383 --- devextreme/devextreme-15.2.7.d.ts | 7429 --- devextreme/devextreme-15.2.9.d.ts | 7443 --- devextreme/devextreme-16.1.6.d.ts | 8043 --- devextreme/devextreme-16.1.7.d.ts | 8052 --- devextreme/v15/devextreme-tests.ts | 320 + .../index.d.ts} | 2 +- devextreme/v15/tsconfig.json | 23 + dojo/tsconfig.json | 64 +- draft-js/draft-js-0.2.2.d.ts | 277 - draft-js/draft-js-tests-0.2.2.tsx | 183 - dragula/dragula-amd-tests.ts | 39 - dropzone/dropzone-commonjs-tests.ts | 285 - durandal/{durandal-1.x.d.ts => v1/index.d.ts} | 0 durandal/v1/tsconfig.json | 22 + easy-table/easy-table-0.2.0-tests.ts | 13 - easy-table/easy-table-0.2.0.d.ts | 40 - electron/electron-tests.ts | 6 +- electron/github-electron.d.ts | 5765 --- electron/tsconfig.json | 1 + ember/index.d.ts | 6 +- .../ember-tests.ts} | 1 - ember/{ember-1.11.3.d.ts => v1/index.d.ts} | 4 - ember/v1/tsconfig.json | 23 + enhanced-resolve/lib/lib-tests.ts | 2 +- enhanced-resolve/tsconfig.json | 67 +- enzyme/enzyme-1.2.0-tests.tsx | 605 - enzyme/enzyme-1.2.0.d.ts | 473 - eq.js/{eq.js.tests.ts => eq.js-tests.ts} | 0 eq.js/tsconfig.json | 2 +- es6-promise/es6-promise-commonjs-tests.ts | 160 - estree/UNUSED_FILES.txt | 1 + estree/estree-tests.ts | 2 +- .../eventemitter3-tests.ts.tscparams | 1 - expect.js/expect.js-commonjs-tests.ts | 129 - .../express-brute-mongo-tests.ts | 2 +- express-brute/express-brute-tests.ts | 2 +- express-useragent/express-useragent-tests.ts | 6 +- express/express-tests.ts | 2 +- ffi/tsconfig.json | 1 + field/{field-test.ts => field-tests.ts} | 0 field/tsconfig.json | 3 +- firebase/tsconfig.json | 4 +- .../fixed-data-table-0.4.7-tests.tsx | 39 - fixed-data-table/fixed-data-table-0.4.7.d.ts | 399 - freedom/UNUSED_FILES.txt | 2 + fullcalendar/v1/fullCalendar-tests.ts | 18 +- fullcalendar/v1/fullCalendar.d.ts | 431 - fullcalendar/v1/index.d.ts | 433 + fullcalendar/v1/package.json | 5 + fullcalendar/v1/tsconfig.json | 23 + fullcalendar/v1/tslint.json | 7 + gaussian/gaussian-tests.ts | 2 +- ...ns-tests.ts => generic-functions-tests.ts} | 2 - generic-functions/tsconfig.json | 3 +- git-config/gitconfig | 5 - gl-matrix/gl-matrix-legacy-tests.ts | 362 - gl-matrix/gl-matrix-legacy.d.ts | 2163 - glob-stream/glob-stream-tests.ts | 2 +- glob/glob-tests.ts | 2 +- globalize/globalize-0.1.3-tests.ts | 11 - globalize/globalize-0.1.3.d.ts | 25 - google-apps-script/index.d.ts | 2 +- graphql-relay/graphql-relay-tests.ts | 2 +- gulp-cheerio/gulp-cheerio-tests.ts | 2 +- gulp-istanbul/gulp-istanbul-0.8.1.d.ts | 50 - gulp-tslint/gulp-tslint-tests.ts | 2 +- halogen/tsconfig.json | 9 +- hammerjs/hammerjs-commonjs-tests.ts | 117 - .../hammerjs-tests.ts} | 0 .../{hammerjs-1.1.3.d.ts => v1/index.d.ts} | 0 hammerjs/v1/tsconfig.json | 23 + .../{handlebars-1.0.0.d.ts => v1/index.d.ts} | 0 handlebars/v1/tsconfig.json | 22 + .../{hapi-tests-8.2.0.ts => v8/hapi-tests.ts} | 0 hapi/{hapi-8.2.0.d.ts => v8/index.d.ts} | 2 +- hapi/v8/tsconfig.json | 23 + hashmap/hashmap-commonjs-tests.ts | 41 - .../hashmap-tests.ts} | 2 - hashmap/{hashmap-1.1.d.ts => v1/index.d.ts} | 0 hashmap/v1/tsconfig.json | 23 + helmet/helmet-tests.ts | 2 +- .../{highlightjs-7.5.0.d.ts => v7/index.d.ts} | 0 highlight.js/v7/tsconfig.json | 22 + html-to-text/h2t-test.html | 21 - i18n/i18n-node-tests.ts | 8 +- i18next/i18next-2.0.17.d.ts | 157 - i18next/i18next-tests-2.0.17.ts | 1379 - iconv-lite/iconv-lite-tests.ts | 2 +- inert/inert-tests-es6.ts | 7 - inert/inert-tests.ts | 12 +- inert/tsconfig.json | 3 +- ...ls-test.ts => inversify-devtools-tests.ts} | 0 inversify-devtools/package.json | 5 + inversify-devtools/tsconfig.json | 2 +- .../index.d.ts} | 0 .../ion.rangeSlider-tests.ts} | 1 - ion.rangeslider/v1/tsconfig.json | 23 + is-promise/is-promise-tests.ts | 2 +- iscroll/UNUSED_FILES.txt | 1 + iscroll/index.d.ts | 154 +- iscroll/iscroll-5-lite.d.ts | 39 - iscroll/iscroll-5-tests.ts | 41 - iscroll/iscroll-5.d.ts | 96 - iscroll/iscroll-lite.d.ts | 73 +- iscroll/iscroll-tests.ts | 24 +- iscroll/tsconfig.json | 10 +- iscroll/v4/UNUSED_FILES.txt | 1 + iscroll/v4/index.d.ts | 76 + iscroll/v4/iscroll-lite.d.ts | 48 + iscroll/v4/iscroll-tests.ts | 31 + iscroll/v4/tsconfig.json | 23 + ix.js/tsconfig.json | 3 +- jasmine/{legacy => v1}/index.d.ts | 0 .../jasmine-tests.ts} | 0 jasmine/v1/tsconfig.json | 23 + joi/{joi-6.5.0.d.ts => v6/index.d.ts} | 0 joi/{joi-6.5.0-tests.ts => v6/joi-tests.ts} | 0 {js-data/legacy => joi/v6}/tsconfig.json | 13 +- jquery.bbq/jquery.bbq-tests.ts | 3 +- .../jquery.dataTables-1.9.4.d.ts | 479 - jquery.payment/tsconfig.json | 3 +- .../{js-base64-test.ts => js-base64-tests.ts} | 2 - js-base64/tsconfig.json | 3 +- .../js-combinatorics-global-tests.ts | 99 - js-combinatorics/js-combinatorics-global.d.ts | 8 - js-data/js-data-node-tests.ts | 15 - js-data/legacy/js-data-node-1.5.4-tests.ts | 11 - js-data/{legacy => v1}/index.d.ts | 0 .../js-data-tests.ts} | 0 js-data/v1/tsconfig.json | 23 + js-quantities/js-quantities-tests.ts | 4 +- jsfl/tsconfig.json | 3 +- jsfl/xJSFL.d.ts | 2 +- jssha/jssha-1.6.0-tests.ts | 15 - jssha/jssha-1.6.0.d.ts | 65 - jwt-simple/jwt-simple-0.2.0-tests.ts | 12 - jwt-simple/jwt-simple-0.2.0.d.ts | 22 - karma/karma-0.12-tests.ts | 25 - karma/karma-0.12.d.ts | 23 - knockout/all-tests.ts | 3 - knockout/knockoutamd-tests.ts | 11 - knockout/tests/index.d.ts | 15 - .../knockout-templatingBehaviors-tests.ts | 7 + knockout/tsconfig.json | 3 +- koa/koa-1.1.2-tests.ts | 26 - koa/koa-1.1.2.d.ts | 592 - leaflet/{leaflet-0.7.d.ts => v0/index.d.ts} | 0 .../leaflet-tests.ts} | 2 - leaflet/v0/tsconfig.json | 23 + leapmotionts/leapmotionts-tests.ts | 2 +- loader-runner/tsconfig.json | 2 +- locutus/{ => scripts}/locutus_print.ts | 0 lodash-es/tsconfig.json | 1 + lodash/{ => scripts}/generate-modules.ts | 0 lodash/tsconfig.json | 1 + .../lodash-3.10.d.ts => v3/index.d.ts} | 0 .../lodash-tests.ts} | 53 +- lodash/v3/tsconfig.json | 23 + mapbox-gl/mapbox-gl-0.25.1.d.ts | 936 - mapbox-gl/mapbox-gl-0.26.0.d.ts | 948 - .../marker-animate-unobtrusive-amd-tests.ts | 5 - marker-animate-unobtrusive/tsconfig.json | 3 +- .../legacy/material-ui-0.11.1-tests.tsx | 477 - material-ui/legacy/material-ui-0.11.1.d.ts | 2096 - .../legacy/material-ui-0.12.1-tests.tsx | 468 - material-ui/legacy/material-ui-0.12.1.d.ts | 2249 - .../legacy/material-ui-0.13.4-tests.tsx | 534 - material-ui/legacy/material-ui-0.13.4.d.ts | 3283 -- .../legacy/material-ui-0.14.4-tests.tsx | 2302 - material-ui/legacy/material-ui-0.14.4.d.ts | 8246 --- .../legacy/material-ui-0.15.0-tests.tsx | 4913 -- material-ui/legacy/material-ui-0.15.0.d.ts | 8414 --- .../legacy/material-ui-0.15.1-tests.tsx | 4953 -- .../material-ui-0.15.1-tests.tsx.tscparams | 1 - material-ui/legacy/material-ui-0.15.1.d.ts | 8630 ---- material-ui/material-ui-global.d.ts | 8 - minimatch/minimatch-tests.ts | 2 +- mithril/mithril-tests.ts.tcsparams | 1 - mocha/tsconfig.json | 4 +- mongodb/{mongodb-1.4.9.d.ts => v1/index.d.ts} | 2 +- .../mongodb-tests.ts} | 2 +- mongodb/v1/tsconfig.json | 23 + mongoose/{mongoose-3.x.d.ts => v3/index.d.ts} | 0 .../mongoose-tests.ts} | 2 - mongoose/v3/tsconfig.json | 23 + mousetrap/index.d.ts | 3 + mousetrap/mousetrap-global-bind-tests.ts | 2 - mousetrap/mousetrap-global-bind.d.ts | 10 - mousetrap/tsconfig.json | 3 +- .../{msgpack5-test.ts => msgpack5-tests.ts} | 0 msgpack5/tsconfig.json | 2 +- mustache/mustache-0.7.3-tests.ts | 11 - mustache/mustache-0.7.3.d.ts | 55 - ng-cordova/actionSheet-tests.ts | 3 - ng-cordova/app-version-tests.ts | 3 - ng-cordova/appAvailability-tests.ts | 9 +- ng-cordova/badge-tests.ts | 3 - ng-cordova/camera-tests.ts | 5 - ng-cordova/datepicker-tests.ts | 3 - ng-cordova/device-tests.ts | 21 +- ng-cordova/deviceMotion-tests.ts | 6 - ng-cordova/deviceOrientation-tests.ts | 6 - ng-cordova/dialogs-tests.ts | 6 - ng-cordova/emailComposer-tests.ts | 4 - ng-cordova/file-tests.ts | 4 - ng-cordova/fileTransfer-tests.ts | 5 - ng-cordova/geolocation-tests.ts | 4 - ng-cordova/network-tests.ts | 4 - ng-cordova/toast-tests.ts | 22 +- ng-cordova/tsconfig.json | 26 +- nodal/nodal-tests.ts | 2 +- node-uuid/node-uuid-cjs-tests.ts | 25 - node-uuid/node-uuid-global-tests.ts | 23 - node/node-0.10.d.ts | 1442 - node/node-0.11-tests.ts | 175 - node/node-0.11.d.ts | 1365 - node/node-0.8.8.d.ts | 1109 - node/{node-0.12.d.ts => v0/index.d.ts} | 2 +- node/{node-0.12-tests.ts => v0/node-tests.ts} | 0 node/v0/tsconfig.json | 23 + node/{node-4.d.ts => v4/index.d.ts} | 2 +- node/{node-4-tests.ts => v4/node-tests.ts} | 3 +- node/v4/tsconfig.json | 23 + notNeededPackages.json | 5 - ...{notify.js.tests.ts => notify.js-tests.ts} | 0 notify.js/tsconfig.json | 2 +- .../{nouislider-7.0.10.d.ts => v7/index.d.ts} | 0 .../nouislider-tests.ts} | 0 nouislider/v7/tsconfig.json | 23 + .../{nouislider-8.0.2.d.ts => v8/index.d.ts} | 2 +- .../nouislider-tests.ts} | 2 - nouislider/v8/tsconfig.json | 23 + numbro/numbro-commonjs-tests.ts | 44 - numeral/numeraljs-commonjs-tests.ts | 44 - numeral/tsconfig.json | 2 +- .../{nvd3-test-boxplot.ts => test/boxplot.ts} | 0 nvd3/{nvd3-test-bullet.ts => test/bullet.ts} | 0 .../bulletChart.ts} | 0 .../candlestick.ts} | 0 .../candlestickChart.ts} | 0 .../cumulativeLineChart.ts} | 0 .../discreteBarChart.ts} | 0 .../donutChart.ts} | 0 .../furiousLegend.ts} | 0 .../historicalBar.ts} | 0 .../historicalBarChart.ts} | 0 nvd3/{nvd3-test-legend.ts => test/legend.ts} | 0 nvd3/{nvd3-test-line.ts => test/line.ts} | 0 .../lineChart.ts} | 0 .../lineChartLogScale.ts} | 0 .../lineChartSVGResize.ts} | 0 .../linePlusBarChart.ts} | 0 .../lineWithFocusChart.ts} | 0 .../lineWithFocusChartx2AxisLabel.ts} | 0 .../monitoringChart.ts} | 0 .../multiChart.ts} | 0 .../multibarChart.ts} | 0 .../multibarChart2.ts} | 0 .../multibarHorizontalChart.ts} | 0 nvd3/{nvd3-test-ohlc.ts => test/ohlc.ts} | 0 .../ohlcChart.ts} | 0 .../parallelCoordinates.ts} | 0 .../parallelCoordinatesChart.ts} | 0 nvd3/{nvd3-test-pie.ts => test/pie.ts} | 0 .../pieChart.ts} | 0 .../{nvd3-test-scatter.ts => test/scatter.ts} | 0 .../scatterChart.ts} | 2 +- .../scatterPlusLineChart.ts} | 0 .../sparkLine.ts} | 0 .../sparkLinePlus.ts} | 0 .../stackArea.ts} | 0 .../stackAreaChart.ts} | 0 .../sunburst.ts} | 0 .../timeSeries.ts} | 0 .../{nvd3-test-tooltip.ts => test/tooltip.ts} | 0 nvd3/tsconfig.json | 44 +- openlayers/openlayers-3.14.2-tests.ts | 724 - openlayers/openlayers-3.14.2.d.ts | 4893 -- openlayers/openlayers-3.6.0-tests.ts | 563 - openlayers/openlayers-3.6.0.d.ts | 5403 -- .../{openlayers-2.10.0.d.ts => v2/index.d.ts} | 0 openlayers/v2/tsconfig.json | 22 + openui5/tsconfig.json | 1 + oracledb/oracledb-1.5.0-tests.ts | 32 - oracledb/oracledb-1.5.0.d.ts | 308 - .../passport-http-bearer-tests.ts | 2 +- passport-local/passport-local-tests.ts | 2 +- .../passport-oauth2-client-password-tests.ts | 4 +- phantom/index.d.ts | 2 +- phantom/phantom-1.0.0-tests.ts | 166 - phantom/phantom-1.0.0.d.ts | 75 - physijs/physijs-tests.ts | 15 - physijs/{tests => test}/body.ts | 0 physijs/{tests => test}/collisions.ts | 0 physijs/{tests => test}/compound.ts | 0 physijs/{tests => test}/constraints_car.ts | 0 physijs/{tests => test}/heightfield.ts | 0 physijs/{tests => test}/jenga.ts | 0 .../{tests => test}/memorytest-compound.ts | 0 physijs/{tests => test}/memorytest-convex.ts | 0 physijs/{tests => test}/memorytest.ts | 0 physijs/{tests => test}/shapes.ts | 0 physijs/{tests => test}/vehicle.ts | 0 physijs/tsconfig.json | 12 +- pikaday/pikaday-tests.ts | 2 +- pixi.js/v3/{pixi.js.d.ts => index.d.ts} | 21 +- pixi.js/v3/pixi.js-tests.ts | 1 - pixi.js/v3/tsconfig.json | 23 + pixi.js/v3/tslint.json | 8 + postal/{postal-0.8.9.d.ts => v0/index.d.ts} | 0 postal/v0/tsconfig.json | 22 + promisify-node/tsconfig.json | 2 +- protobufjs/test.json | 123 - protobufjs/test.proto | 30 - purl/tsconfig.json | 3 +- qunit/{qunit-1.16.d.ts => v1/index.d.ts} | 0 .../qunit-tests.ts} | 0 qunit/v1/tsconfig.json | 23 + random-js/random-js-commonjs-tests.ts | 29 - random-js/tsconfig.json | 3 +- .../react-addons-shallow-compare-tests.ts | 2 - ...=> react-addons-shallow-compare-tests.tsx} | 0 .../tests/import-es6.tsx | 12 - react-addons-shallow-compare/tsconfig.json | 2 +- .../react-bootstrap-daterangepicker-tests.ts | 8 +- react-bootstrap-daterangepicker/tsconfig.json | 1 + react-fa/react-fa-4.0.0.d.ts | 28 - react-ga/react-ga-tests.tsx | 3 +- react-ga/tsconfig.json | 7 +- react-highlighter/react-highlighter-tests.tsx | 3 - react-highlighter/tsconfig.json | 7 +- .../{react-intl-1.2.0.d.ts => v1/index.d.ts} | 0 .../react-intl-tests.tsx} | 2 - react-intl/v1/tsconfig.json | 26 + react-native/react-native.0.29.d.ts | 6092 --- react-native/tsconfig.json | 1 + react-overlays/tsconfig.json | 1 + react-redux/react-redux-2.1.2-tests.tsx | 274 - react-redux/react-redux-2.1.2.d.ts | 69 - ...t-relay-test.tsx => react-relay-tests.tsx} | 0 react-relay/tsconfig.json | 2 +- .../index.d.ts} | 23 +- .../react-router-redux-tests.ts} | 0 react-router-redux/v3/tsconfig.json | 23 + react-router/react-router-0.13.3.d.ts | 354 - react-router/react-router-1.0.0.d.ts | 452 - react-select/react-select-0.9.10-tests.tsx | 29 - react-select/react-select-0.9.10.d.ts | 80 - ...t-slick-test.tsx => react-slick-tests.tsx} | 0 react-slick/tsconfig.json | 2 +- .../react-test-renderer-tests.ts | 2 +- recompose/recompose-tests.tsx | 4 +- recompose/tsconfig.json | 7 +- redux-devtools/redux-devtools-2.1.4-tests.tsx | 53 - redux-devtools/redux-devtools-2.1.4.d.ts | 10 - .../{redux-form-4.0.d.ts => v4/index.d.ts} | 0 .../redux-form-tests.tsx} | 0 redux-form/v4/tsconfig.json | 25 + redux-localstorage/tsconfig.json | 3 + ...data-test.ts => reflect-metadata-tests.ts} | 22 +- reflect-metadata/tsconfig.json | 7 +- rrule/{rrule-test.ts => rrule-tests.ts} | 2 - rrule/tsconfig.json | 3 +- sails.io.js/sails.io.js-tests.ts | 2 +- scripts/lint.js | 9 +- scroller/easyscroller.d.ts | 15 - scroller/index.d.ts | 10 +- sencha_touch/SenchaTouch-2.2.1.d.ts | 42741 ---------------- ...chaTouch-Tests.ts => SenchaTouch-tests.ts} | 0 sencha_touch/tsconfig.json | 2 +- .../{sendgrid-1.1.0.d.ts => v1/index.d.ts} | 0 sendgrid/v1/tsconfig.json | 22 + sequelize/sequelize-2.0.0.d.ts | 2790 - sequelize/sequelize-tests-2.0.0.ts | 426 - .../{sequelize-3.0.0.d.ts => v3/index.d.ts} | 0 .../sequelize-tests.ts} | 0 sequelize/v3/tsconfig.json | 23 + serve-static/serve-static-tests.ts | 4 +- ...pi-test.ts => service_worker_api-tests.ts} | 0 service_worker_api/tsconfig.json | 2 +- signalr/{signalr-1.0.d.ts => v1/index.d.ts} | 0 .../signalr-tests.ts} | 0 signalr/v1/tsconfig.json | 23 + sinon-mongoose/sinon-mongoose.d.ts | 18 - smtp-server/smtp-server-tests.ts | 2 +- snapsvg/{snapsvg-tests.ts => test/1.ts} | 0 snapsvg/{snapsvg-tests-2.ts => test/2.ts} | 0 snapsvg/{snapsvg-tests-3.ts => test/3.ts} | 2 - snapsvg/tsconfig.json | 6 +- .../statsd-client-import-asterisk-tests.ts | 3 - ...am-meter-test.ts => stream-meter-tests.ts} | 0 stream-meter/tsconfig.json | 3 +- .../index.d.ts} | 0 svg-pan-zoom/v2/tsconfig.json | 22 + swig/swig-tests.ts | 2 +- systemjs/systemjs-0.18.4-tests.ts | 10 - systemjs/systemjs-0.18.4.d.ts | 22 - tedious/tedious-tests.ts | 4 +- three/tests/math/test_unit_math.ts | 9 +- .../{through2-0.4.2.d.ts => v0/index.d.ts} | 0 .../through2-tests.ts} | 0 through2/v0/tsconfig.json | 23 + turf/{turf-2.0.d.ts => v2/index.d.ts} | 0 turf/v2/tsconfig.json | 23 + turf/{turf-2.0-tests.ts => v2/turf-tests.ts} | 2 - tv4/tv4-1.2.4-tests.ts | 43 - tv4/tv4-1.2.4.d.ts | 48 - uglify-js/uglify-js-tests.ts | 2 +- umzug/umzug-tests.ts | 4 +- vinyl/{vinyl-0.4.3.d.ts => v0/index.d.ts} | 0 vinyl/v0/tsconfig.json | 23 + .../vinyl-tests.ts} | 0 vivus/tsconfig.json | 6 +- waterline/waterline-tests.ts | 2 +- winjs/index.d.ts | 2 +- winjs/{winjs-1.0.d.ts => v1/index.d.ts} | 2 +- winjs/v1/tsconfig.json | 22 + winjs/{winjs-2.1.d.ts => v2/index.d.ts} | 4 +- winjs/v2/tsconfig.json | 22 + winjs/winjs-2.0.d.ts | 8656 ---- xrm/v6/index.d.ts | 2 +- xrm/v6/tsconfig.json | 19 +- xrm/v6/{xrm-v6-tests.ts => xrm-tests.ts} | 2 - xrm/v7.1/index.d.ts | 2590 - xrm/v7/index.d.ts | 1172 +- xrm/{ => v7}/parature.d.ts | 0 xrm/v7/tsconfig.json | 19 +- .../xrm-v7.1-tests.ts => v7/xrm-tests.ts} | 9 +- xrm/v7/xrm-v7-tests.ts | 73 - .../index.d.ts} | 2 +- zeroclipboard/v1/tsconfig.json | 23 + .../zeroclipboard-tests.ts} | 0 535 files changed, 3465 insertions(+), 258187 deletions(-) delete mode 100644 ag-grid/ag-grid.d-2.1.2.ts delete mode 100644 amqplib/amqplib-0.3.d.ts delete mode 100644 angular-material/angular-material-0.8.3.d.ts delete mode 100644 angular-material/angular-material-0.9.0.d.ts delete mode 100644 angular-permission/angular-permission-2.3.1-tests.ts delete mode 100644 angular-permission/angular-permission-2.3.1.d.ts create mode 100644 angular/UNUSED_FILES.txt delete mode 100644 angular/legacy/angular-1.0-tests.ts delete mode 100644 angular/legacy/angular-1.0.d.ts delete mode 100644 angular/legacy/angular-1.2-tests.ts delete mode 100644 angular/legacy/angular-1.2.d.ts delete mode 100644 angular/legacy/angular-1.4.d.ts delete mode 100644 angular/legacy/angular-animate-1.2.d.ts delete mode 100644 angular/legacy/angular-animate-1.3.d.ts delete mode 100644 angular/legacy/angular-cookies-1.0.d.ts delete mode 100644 angular/legacy/angular-cookies-1.2.d.ts delete mode 100644 angular/legacy/angular-mocks-1.0.d.ts delete mode 100644 angular/legacy/angular-mocks-1.2-tests.ts delete mode 100644 angular/legacy/angular-mocks-1.2.d.ts delete mode 100644 angular/legacy/angular-resource-1.0.d.ts delete mode 100644 angular/legacy/angular-resource-1.2-tests.ts delete mode 100644 angular/legacy/angular-resource-1.2.d.ts delete mode 100644 angular/legacy/angular-resource-1.3.d.ts delete mode 100644 angular/legacy/angular-route-1.2-tests.ts delete mode 100644 angular/legacy/angular-route-1.2.d.ts delete mode 100644 angular/legacy/angular-sanitize-1.0.d.ts delete mode 100644 angular/legacy/angular-sanitize-1.2-tests.ts delete mode 100644 angular/legacy/angular-sanitize-1.2.d.ts delete mode 100644 angular/legacy/angular-scenario-1.0.d.ts delete mode 100644 angular/legacy/angular-scenario-1.2.d.ts delete mode 100644 async/asyncamd-tests.ts rename base64url/{base64url-test.ts => base64url-tests.ts} (100%) rename bluebird/{bluebird-1.0-tests.ts => v1/bluebird-tests.ts} (100%) rename bluebird/{bluebird-1.0.d.ts => v1/index.d.ts} (100%) create mode 100644 bluebird/v1/tsconfig.json rename bluebird/{bluebird-2.0-tests.ts => v2/bluebird-tests.ts} (99%) rename bluebird/{bluebird-2.0.d.ts => v2/index.d.ts} (100%) create mode 100644 bluebird/v2/tsconfig.json rename bootstrap.v3.datetimepicker/{bootstrap.v3.datetimepicker-3.0.0.d.ts => v3/index.d.ts} (98%) create mode 100644 bootstrap.v3.datetimepicker/v3/tsconfig.json rename bowser/{bowser-tests-global.ts => bowser-global-tests.ts} (100%) rename bowser/{bowser-tests-module.ts => bowser-module-tests.ts} (100%) delete mode 100644 chai/chai-3.2.0-tests.ts delete mode 100644 chai/chai-3.2.0.d.ts rename chai/{chai-2.0.0.d.ts => v2/index.d.ts} (100%) create mode 100644 chai/v2/tsconfig.json rename chroma-js/{chroma-js-0.5.6-tests.ts => v0/chroma-js-tests.ts} (98%) rename chroma-js/{chroma-js-0.5.6.d.ts => v0/index.d.ts} (100%) create mode 100644 chroma-js/v0/tsconfig.json rename color/{color-tests-0.12.0.ts => v0/color-tests.ts} (100%) rename color/{index-0.12.0.d.ts => v0/index.d.ts} (100%) rename {xrm/v7.1 => color/v0}/tsconfig.json (69%) delete mode 100644 cordova/.gitignore delete mode 100644 cryptojs/all-tests.ts delete mode 100644 cson/cson-test.cson delete mode 100644 cson/cson-test.json create mode 100644 d3-dsv/v0/tsconfig.json create mode 100644 d3-dsv/v0/tslint.json rename d3-hexbin/{d3-hexbin-test.ts => d3-hexbin-tests.ts} (100%) delete mode 100644 d3/legacy/plugins/d3.superformula-tests.ts delete mode 100644 d3/legacy/plugins/index.d.ts delete mode 100644 d3/legacy/plugins/package.json rename d3/{d3-v3.5-tests.ts => v3/d3-tests.ts} (100%) rename d3/{d3-v3.5.d.ts => v3/index.d.ts} (100%) rename {jasmine/legacy => d3/v3}/tsconfig.json (55%) rename d3kit/{d3kit-v1.1.0-tests.ts => v1/d3kit-tests.ts} (99%) rename d3kit/{d3kit-v1.1.0.d.ts => v1/index.d.ts} (98%) create mode 100644 d3kit/v1/tsconfig.json delete mode 100644 dc/dc-1.6.0.d.ts delete mode 100644 devextreme/devextreme-15.1.3.d.ts delete mode 100644 devextreme/devextreme-15.1.4.d.ts delete mode 100644 devextreme/devextreme-15.1.5.d.ts delete mode 100644 devextreme/devextreme-15.1.6.d.ts delete mode 100644 devextreme/devextreme-15.1.7.d.ts delete mode 100644 devextreme/devextreme-15.1.8.d.ts delete mode 100644 devextreme/devextreme-15.2.10.d.ts delete mode 100644 devextreme/devextreme-15.2.12.d.ts delete mode 100644 devextreme/devextreme-15.2.4.d.ts delete mode 100644 devextreme/devextreme-15.2.5.d.ts delete mode 100644 devextreme/devextreme-15.2.7.d.ts delete mode 100644 devextreme/devextreme-15.2.9.d.ts delete mode 100644 devextreme/devextreme-16.1.6.d.ts delete mode 100644 devextreme/devextreme-16.1.7.d.ts create mode 100644 devextreme/v15/devextreme-tests.ts rename devextreme/{devextreme-15.2.13.d.ts => v15/index.d.ts} (99%) create mode 100644 devextreme/v15/tsconfig.json delete mode 100644 draft-js/draft-js-0.2.2.d.ts delete mode 100644 draft-js/draft-js-tests-0.2.2.tsx delete mode 100644 dragula/dragula-amd-tests.ts delete mode 100755 dropzone/dropzone-commonjs-tests.ts rename durandal/{durandal-1.x.d.ts => v1/index.d.ts} (100%) create mode 100644 durandal/v1/tsconfig.json delete mode 100644 easy-table/easy-table-0.2.0-tests.ts delete mode 100644 easy-table/easy-table-0.2.0.d.ts delete mode 100644 electron/github-electron.d.ts rename ember/{ember-1.11.3-tests.ts => v1/ember-tests.ts} (99%) rename ember/{ember-1.11.3.d.ts => v1/index.d.ts} (99%) create mode 100644 ember/v1/tsconfig.json delete mode 100644 enzyme/enzyme-1.2.0-tests.tsx delete mode 100644 enzyme/enzyme-1.2.0.d.ts rename eq.js/{eq.js.tests.ts => eq.js-tests.ts} (100%) delete mode 100644 es6-promise/es6-promise-commonjs-tests.ts create mode 100644 estree/UNUSED_FILES.txt delete mode 100644 eventemitter3/eventemitter3-tests.ts.tscparams delete mode 100644 expect.js/expect.js-commonjs-tests.ts rename field/{field-test.ts => field-tests.ts} (100%) delete mode 100644 fixed-data-table/fixed-data-table-0.4.7-tests.tsx delete mode 100644 fixed-data-table/fixed-data-table-0.4.7.d.ts create mode 100644 freedom/UNUSED_FILES.txt delete mode 100644 fullcalendar/v1/fullCalendar.d.ts create mode 100644 fullcalendar/v1/index.d.ts create mode 100644 fullcalendar/v1/package.json create mode 100644 fullcalendar/v1/tsconfig.json create mode 100644 fullcalendar/v1/tslint.json rename generic-functions/{genetic-functions-tests.ts => generic-functions-tests.ts} (91%) delete mode 100644 git-config/gitconfig delete mode 100644 gl-matrix/gl-matrix-legacy-tests.ts delete mode 100644 gl-matrix/gl-matrix-legacy.d.ts delete mode 100644 globalize/globalize-0.1.3-tests.ts delete mode 100644 globalize/globalize-0.1.3.d.ts delete mode 100644 gulp-istanbul/gulp-istanbul-0.8.1.d.ts delete mode 100644 hammerjs/hammerjs-commonjs-tests.ts rename hammerjs/{hammerjs-1.1.3-tests.ts => v1/hammerjs-tests.ts} (100%) rename hammerjs/{hammerjs-1.1.3.d.ts => v1/index.d.ts} (100%) create mode 100644 hammerjs/v1/tsconfig.json rename handlebars/{handlebars-1.0.0.d.ts => v1/index.d.ts} (100%) create mode 100644 handlebars/v1/tsconfig.json rename hapi/{hapi-tests-8.2.0.ts => v8/hapi-tests.ts} (100%) rename hapi/{hapi-8.2.0.d.ts => v8/index.d.ts} (99%) create mode 100644 hapi/v8/tsconfig.json delete mode 100644 hashmap/hashmap-commonjs-tests.ts rename hashmap/{hashmap-1.1-tests.ts => v1/hashmap-tests.ts} (90%) rename hashmap/{hashmap-1.1.d.ts => v1/index.d.ts} (100%) create mode 100644 hashmap/v1/tsconfig.json rename highlight.js/{highlightjs-7.5.0.d.ts => v7/index.d.ts} (100%) create mode 100644 highlight.js/v7/tsconfig.json delete mode 100644 html-to-text/h2t-test.html delete mode 100644 i18next/i18next-2.0.17.d.ts delete mode 100644 i18next/i18next-tests-2.0.17.ts delete mode 100644 inert/inert-tests-es6.ts rename inversify-devtools/{inversify-devtools-test.ts => inversify-devtools-tests.ts} (100%) create mode 100644 inversify-devtools/package.json rename ion.rangeslider/{ion.rangeSlider-1.9.1.d.ts => v1/index.d.ts} (100%) rename ion.rangeslider/{ion.rangeSlider-1.9.1-tests.ts => v1/ion.rangeSlider-tests.ts} (93%) create mode 100644 ion.rangeslider/v1/tsconfig.json create mode 100644 iscroll/UNUSED_FILES.txt delete mode 100644 iscroll/iscroll-5-lite.d.ts delete mode 100644 iscroll/iscroll-5-tests.ts delete mode 100644 iscroll/iscroll-5.d.ts create mode 100644 iscroll/v4/UNUSED_FILES.txt create mode 100644 iscroll/v4/index.d.ts create mode 100644 iscroll/v4/iscroll-lite.d.ts create mode 100644 iscroll/v4/iscroll-tests.ts create mode 100644 iscroll/v4/tsconfig.json rename jasmine/{legacy => v1}/index.d.ts (100%) rename jasmine/{legacy/jasmine-1.3-tests.ts => v1/jasmine-tests.ts} (100%) create mode 100644 jasmine/v1/tsconfig.json rename joi/{joi-6.5.0.d.ts => v6/index.d.ts} (100%) rename joi/{joi-6.5.0-tests.ts => v6/joi-tests.ts} (100%) rename {js-data/legacy => joi/v6}/tsconfig.json (51%) delete mode 100644 jquery.datatables/jquery.dataTables-1.9.4.d.ts rename js-base64/{js-base64-test.ts => js-base64-tests.ts} (90%) delete mode 100644 js-combinatorics/js-combinatorics-global-tests.ts delete mode 100644 js-combinatorics/js-combinatorics-global.d.ts delete mode 100644 js-data/js-data-node-tests.ts delete mode 100644 js-data/legacy/js-data-node-1.5.4-tests.ts rename js-data/{legacy => v1}/index.d.ts (100%) rename js-data/{legacy/js-data-1.5.4-tests.ts => v1/js-data-tests.ts} (100%) create mode 100644 js-data/v1/tsconfig.json delete mode 100644 jssha/jssha-1.6.0-tests.ts delete mode 100644 jssha/jssha-1.6.0.d.ts delete mode 100644 jwt-simple/jwt-simple-0.2.0-tests.ts delete mode 100644 jwt-simple/jwt-simple-0.2.0.d.ts delete mode 100644 karma/karma-0.12-tests.ts delete mode 100644 karma/karma-0.12.d.ts delete mode 100644 knockout/all-tests.ts delete mode 100644 knockout/knockoutamd-tests.ts delete mode 100644 knockout/tests/index.d.ts delete mode 100644 koa/koa-1.1.2-tests.ts delete mode 100644 koa/koa-1.1.2.d.ts rename leaflet/{leaflet-0.7.d.ts => v0/index.d.ts} (100%) rename leaflet/{leaflet-0.7-tests.ts => v0/leaflet-tests.ts} (99%) create mode 100644 leaflet/v0/tsconfig.json rename locutus/{ => scripts}/locutus_print.ts (100%) rename lodash/{ => scripts}/generate-modules.ts (100%) rename lodash/{legacy/lodash-3.10.d.ts => v3/index.d.ts} (100%) rename lodash/{legacy/lodash-3.10-tests.ts => v3/lodash-tests.ts} (99%) create mode 100644 lodash/v3/tsconfig.json delete mode 100644 mapbox-gl/mapbox-gl-0.25.1.d.ts delete mode 100644 mapbox-gl/mapbox-gl-0.26.0.d.ts delete mode 100644 marker-animate-unobtrusive/marker-animate-unobtrusive-amd-tests.ts delete mode 100644 material-ui/legacy/material-ui-0.11.1-tests.tsx delete mode 100644 material-ui/legacy/material-ui-0.11.1.d.ts delete mode 100644 material-ui/legacy/material-ui-0.12.1-tests.tsx delete mode 100644 material-ui/legacy/material-ui-0.12.1.d.ts delete mode 100644 material-ui/legacy/material-ui-0.13.4-tests.tsx delete mode 100644 material-ui/legacy/material-ui-0.13.4.d.ts delete mode 100644 material-ui/legacy/material-ui-0.14.4-tests.tsx delete mode 100644 material-ui/legacy/material-ui-0.14.4.d.ts delete mode 100644 material-ui/legacy/material-ui-0.15.0-tests.tsx delete mode 100644 material-ui/legacy/material-ui-0.15.0.d.ts delete mode 100644 material-ui/legacy/material-ui-0.15.1-tests.tsx delete mode 100644 material-ui/legacy/material-ui-0.15.1-tests.tsx.tscparams delete mode 100644 material-ui/legacy/material-ui-0.15.1.d.ts delete mode 100644 material-ui/material-ui-global.d.ts delete mode 100644 mithril/mithril-tests.ts.tcsparams rename mongodb/{mongodb-1.4.9.d.ts => v1/index.d.ts} (99%) rename mongodb/{mongodb-1.4.9-tests.ts => v1/mongodb-tests.ts} (95%) create mode 100644 mongodb/v1/tsconfig.json rename mongoose/{mongoose-3.x.d.ts => v3/index.d.ts} (100%) rename mongoose/{mongoose-3.x-tests.ts => v3/mongoose-tests.ts} (99%) create mode 100644 mongoose/v3/tsconfig.json delete mode 100644 mousetrap/mousetrap-global-bind.d.ts rename msgpack5/{msgpack5-test.ts => msgpack5-tests.ts} (100%) delete mode 100644 mustache/mustache-0.7.3-tests.ts delete mode 100644 mustache/mustache-0.7.3.d.ts delete mode 100644 node-uuid/node-uuid-cjs-tests.ts delete mode 100644 node-uuid/node-uuid-global-tests.ts delete mode 100644 node/node-0.10.d.ts delete mode 100644 node/node-0.11-tests.ts delete mode 100644 node/node-0.11.d.ts delete mode 100644 node/node-0.8.8.d.ts rename node/{node-0.12.d.ts => v0/index.d.ts} (99%) rename node/{node-0.12-tests.ts => v0/node-tests.ts} (100%) create mode 100644 node/v0/tsconfig.json rename node/{node-4.d.ts => v4/index.d.ts} (99%) rename node/{node-4-tests.ts => v4/node-tests.ts} (99%) create mode 100644 node/v4/tsconfig.json rename notify.js/{notify.js.tests.ts => notify.js-tests.ts} (100%) rename nouislider/{nouislider-7.0.10.d.ts => v7/index.d.ts} (100%) rename nouislider/{nouislider-tests-7.0.10.ts => v7/nouislider-tests.ts} (100%) create mode 100644 nouislider/v7/tsconfig.json rename nouislider/{nouislider-8.0.2.d.ts => v8/index.d.ts} (99%) rename nouislider/{nouislider-tests-8.0.2.ts => v8/nouislider-tests.ts} (97%) create mode 100644 nouislider/v8/tsconfig.json delete mode 100644 numbro/numbro-commonjs-tests.ts delete mode 100644 numeral/numeraljs-commonjs-tests.ts rename nvd3/{nvd3-test-boxplot.ts => test/boxplot.ts} (100%) rename nvd3/{nvd3-test-bullet.ts => test/bullet.ts} (100%) rename nvd3/{nvd3-test-bulletChart.ts => test/bulletChart.ts} (100%) rename nvd3/{nvd3-test-candlestick.ts => test/candlestick.ts} (100%) rename nvd3/{nvd3-test-candlestickChart.ts => test/candlestickChart.ts} (100%) rename nvd3/{nvd3-test-cumulativeLineChart.ts => test/cumulativeLineChart.ts} (100%) rename nvd3/{nvd3-test-discreteBarChart.ts => test/discreteBarChart.ts} (100%) rename nvd3/{nvd3-test-donutChart.ts => test/donutChart.ts} (100%) rename nvd3/{nvd3-test-furiousLegend.ts => test/furiousLegend.ts} (100%) rename nvd3/{nvd3-test-historicalBar.ts => test/historicalBar.ts} (100%) rename nvd3/{nvd3-test-historicalBarChart.ts => test/historicalBarChart.ts} (100%) rename nvd3/{nvd3-test-legend.ts => test/legend.ts} (100%) rename nvd3/{nvd3-test-line.ts => test/line.ts} (100%) rename nvd3/{nvd3-test-lineChart.ts => test/lineChart.ts} (100%) rename nvd3/{nvd3-test-lineChartLogScale.ts => test/lineChartLogScale.ts} (100%) rename nvd3/{nvd3-test-lineChartSVGResize.ts => test/lineChartSVGResize.ts} (100%) rename nvd3/{nvd3-test-linePlusBarChart.ts => test/linePlusBarChart.ts} (100%) rename nvd3/{nvd3-test-lineWithFocusChart.ts => test/lineWithFocusChart.ts} (100%) rename nvd3/{nvd3-test-lineWithFocusChartx2AxisLabel.ts => test/lineWithFocusChartx2AxisLabel.ts} (100%) rename nvd3/{nvd3-test-monitoringChart.ts => test/monitoringChart.ts} (100%) rename nvd3/{nvd3-test-multiChart.ts => test/multiChart.ts} (100%) rename nvd3/{nvd3-test-multibarChart.ts => test/multibarChart.ts} (100%) rename nvd3/{nvd3-test-multibarChart2.ts => test/multibarChart2.ts} (100%) rename nvd3/{nvd3-test-multibarHorizontalChart.ts => test/multibarHorizontalChart.ts} (100%) rename nvd3/{nvd3-test-ohlc.ts => test/ohlc.ts} (100%) rename nvd3/{nvd3-test-ohlcChart.ts => test/ohlcChart.ts} (100%) rename nvd3/{nvd3-test-parallelCoordinates.ts => test/parallelCoordinates.ts} (100%) rename nvd3/{nvd3-test-parallelCoordinatesChart.ts => test/parallelCoordinatesChart.ts} (100%) rename nvd3/{nvd3-test-pie.ts => test/pie.ts} (100%) rename nvd3/{nvd3-test-pieChart.ts => test/pieChart.ts} (100%) rename nvd3/{nvd3-test-scatter.ts => test/scatter.ts} (100%) rename nvd3/{nvd3-test-scatterChart.ts => test/scatterChart.ts} (95%) rename nvd3/{nvd3-test-scatterPlusLineChart.ts => test/scatterPlusLineChart.ts} (100%) rename nvd3/{nvd3-test-sparkLine.ts => test/sparkLine.ts} (100%) rename nvd3/{nvd3-test-sparkLinePlus.ts => test/sparkLinePlus.ts} (100%) rename nvd3/{nvd3-test-stackArea.ts => test/stackArea.ts} (100%) rename nvd3/{nvd3-test-stackAreaChart.ts => test/stackAreaChart.ts} (100%) rename nvd3/{nvd3-test-sunburst.ts => test/sunburst.ts} (100%) rename nvd3/{nvd3-test-timeSeries.ts => test/timeSeries.ts} (100%) rename nvd3/{nvd3-test-tooltip.ts => test/tooltip.ts} (100%) delete mode 100644 openlayers/openlayers-3.14.2-tests.ts delete mode 100644 openlayers/openlayers-3.14.2.d.ts delete mode 100644 openlayers/openlayers-3.6.0-tests.ts delete mode 100644 openlayers/openlayers-3.6.0.d.ts rename openlayers/{openlayers-2.10.0.d.ts => v2/index.d.ts} (100%) create mode 100644 openlayers/v2/tsconfig.json delete mode 100644 oracledb/oracledb-1.5.0-tests.ts delete mode 100644 oracledb/oracledb-1.5.0.d.ts delete mode 100644 phantom/phantom-1.0.0-tests.ts delete mode 100644 phantom/phantom-1.0.0.d.ts delete mode 100644 physijs/physijs-tests.ts rename physijs/{tests => test}/body.ts (100%) rename physijs/{tests => test}/collisions.ts (100%) rename physijs/{tests => test}/compound.ts (100%) rename physijs/{tests => test}/constraints_car.ts (100%) rename physijs/{tests => test}/heightfield.ts (100%) rename physijs/{tests => test}/jenga.ts (100%) rename physijs/{tests => test}/memorytest-compound.ts (100%) rename physijs/{tests => test}/memorytest-convex.ts (100%) rename physijs/{tests => test}/memorytest.ts (100%) rename physijs/{tests => test}/shapes.ts (100%) rename physijs/{tests => test}/vehicle.ts (100%) rename pixi.js/v3/{pixi.js.d.ts => index.d.ts} (99%) create mode 100644 pixi.js/v3/tsconfig.json create mode 100644 pixi.js/v3/tslint.json rename postal/{postal-0.8.9.d.ts => v0/index.d.ts} (100%) create mode 100644 postal/v0/tsconfig.json delete mode 100644 protobufjs/test.json delete mode 100644 protobufjs/test.proto rename qunit/{qunit-1.16.d.ts => v1/index.d.ts} (100%) rename qunit/{qunit-tests-1.16.ts => v1/qunit-tests.ts} (100%) create mode 100644 qunit/v1/tsconfig.json delete mode 100644 random-js/random-js-commonjs-tests.ts delete mode 100644 react-addons-shallow-compare/react-addons-shallow-compare-tests.ts rename react-addons-shallow-compare/{tests/import-commonjs.tsx => react-addons-shallow-compare-tests.tsx} (100%) delete mode 100644 react-addons-shallow-compare/tests/import-es6.tsx delete mode 100644 react-fa/react-fa-4.0.0.d.ts rename react-intl/{react-intl-1.2.0.d.ts => v1/index.d.ts} (100%) rename react-intl/{react-intl-tests-1.2.0.tsx => v1/react-intl-tests.tsx} (98%) create mode 100644 react-intl/v1/tsconfig.json delete mode 100644 react-native/react-native.0.29.d.ts delete mode 100644 react-redux/react-redux-2.1.2-tests.tsx delete mode 100644 react-redux/react-redux-2.1.2.d.ts rename react-relay/{react-relay-test.tsx => react-relay-tests.tsx} (100%) rename react-router-redux/{react-router-redux-2.x.d.ts => v3/index.d.ts} (66%) rename react-router-redux/{react-router-redux-2.x-tests.ts => v3/react-router-redux-tests.ts} (100%) create mode 100644 react-router-redux/v3/tsconfig.json delete mode 100644 react-router/react-router-0.13.3.d.ts delete mode 100644 react-router/react-router-1.0.0.d.ts delete mode 100644 react-select/react-select-0.9.10-tests.tsx delete mode 100644 react-select/react-select-0.9.10.d.ts rename react-slick/{react-slick-test.tsx => react-slick-tests.tsx} (100%) delete mode 100644 redux-devtools/redux-devtools-2.1.4-tests.tsx delete mode 100644 redux-devtools/redux-devtools-2.1.4.d.ts rename redux-form/{redux-form-4.0.d.ts => v4/index.d.ts} (100%) rename redux-form/{redux-form-4.0-tests.tsx => v4/redux-form-tests.tsx} (100%) create mode 100644 redux-form/v4/tsconfig.json rename reflect-metadata/{reflect-metadata-test.ts => reflect-metadata-tests.ts} (95%) rename rrule/{rrule-test.ts => rrule-tests.ts} (97%) delete mode 100644 scroller/easyscroller.d.ts delete mode 100644 sencha_touch/SenchaTouch-2.2.1.d.ts rename sencha_touch/{SenchaTouch-Tests.ts => SenchaTouch-tests.ts} (100%) rename sendgrid/{sendgrid-1.1.0.d.ts => v1/index.d.ts} (100%) create mode 100644 sendgrid/v1/tsconfig.json delete mode 100644 sequelize/sequelize-2.0.0.d.ts delete mode 100644 sequelize/sequelize-tests-2.0.0.ts rename sequelize/{sequelize-3.0.0.d.ts => v3/index.d.ts} (100%) rename sequelize/{sequelize-tests-3.0.0.ts => v3/sequelize-tests.ts} (100%) create mode 100644 sequelize/v3/tsconfig.json rename service_worker_api/{service_worker_api-test.ts => service_worker_api-tests.ts} (100%) rename signalr/{signalr-1.0.d.ts => v1/index.d.ts} (100%) rename signalr/{signalr-1.0-tests.ts => v1/signalr-tests.ts} (100%) create mode 100644 signalr/v1/tsconfig.json delete mode 100644 sinon-mongoose/sinon-mongoose.d.ts rename snapsvg/{snapsvg-tests.ts => test/1.ts} (100%) rename snapsvg/{snapsvg-tests-2.ts => test/2.ts} (100%) rename snapsvg/{snapsvg-tests-3.ts => test/3.ts} (99%) delete mode 100644 statsd-client/statsd-client-import-asterisk-tests.ts rename stream-meter/{stream-meter-test.ts => stream-meter-tests.ts} (100%) rename svg-pan-zoom/{svg-pan-zoom-2.3.9.d.ts => v2/index.d.ts} (100%) create mode 100644 svg-pan-zoom/v2/tsconfig.json delete mode 100644 systemjs/systemjs-0.18.4-tests.ts delete mode 100644 systemjs/systemjs-0.18.4.d.ts rename through2/{through2-0.4.2.d.ts => v0/index.d.ts} (100%) rename through2/{through2-0.4.2-test.ts => v0/through2-tests.ts} (100%) create mode 100644 through2/v0/tsconfig.json rename turf/{turf-2.0.d.ts => v2/index.d.ts} (100%) create mode 100644 turf/v2/tsconfig.json rename turf/{turf-2.0-tests.ts => v2/turf-tests.ts} (99%) delete mode 100644 tv4/tv4-1.2.4-tests.ts delete mode 100644 tv4/tv4-1.2.4.d.ts rename vinyl/{vinyl-0.4.3.d.ts => v0/index.d.ts} (100%) create mode 100644 vinyl/v0/tsconfig.json rename vinyl/{vinyl-0.4.3.tests.ts => v0/vinyl-tests.ts} (100%) rename winjs/{winjs-1.0.d.ts => v1/index.d.ts} (99%) create mode 100644 winjs/v1/tsconfig.json rename winjs/{winjs-2.1.d.ts => v2/index.d.ts} (99%) create mode 100644 winjs/v2/tsconfig.json delete mode 100644 winjs/winjs-2.0.d.ts rename xrm/v6/{xrm-v6-tests.ts => xrm-tests.ts} (95%) delete mode 100644 xrm/v7.1/index.d.ts rename xrm/{ => v7}/parature.d.ts (100%) rename xrm/{v7.1/xrm-v7.1-tests.ts => v7/xrm-tests.ts} (95%) delete mode 100644 xrm/v7/xrm-v7-tests.ts rename zeroclipboard/{zeroclipboard-1.x.x.d.ts => v1/index.d.ts} (98%) create mode 100644 zeroclipboard/v1/tsconfig.json rename zeroclipboard/{zeroclipboard-1.x.x-tests.ts => v1/zeroclipboard-tests.ts} (100%) diff --git a/.gitignore b/.gitignore index c2773bb5ad..f7927724d5 100644 --- a/.gitignore +++ b/.gitignore @@ -9,7 +9,6 @@ *.cs *.sln *.csproj -*.txt *.map *.swp .DS_Store diff --git a/acl/tsconfig.json b/acl/tsconfig.json index 96724a58aa..d4ffafa7de 100644 --- a/acl/tsconfig.json +++ b/acl/tsconfig.json @@ -15,6 +15,8 @@ }, "files": [ "index.d.ts", - "acl-tests.ts" + "acl-tests.ts", + "acl-mongodbBackend-tests.ts", + "acl-redisBackend-tests.ts" ] } \ No newline at end of file diff --git a/adal/tsconfig.json b/adal/tsconfig.json index 6afc0c793f..e8a928a6ac 100644 --- a/adal/tsconfig.json +++ b/adal/tsconfig.json @@ -15,6 +15,8 @@ }, "files": [ "index.d.ts", - "adal-tests.ts" + "adal-tests.ts", + "adal-angular.d.ts", + "adal-angular-tests.ts" ] } \ No newline at end of file diff --git a/ag-grid/ag-grid.d-2.1.2.ts b/ag-grid/ag-grid.d-2.1.2.ts deleted file mode 100644 index 615dc066cb..0000000000 --- a/ag-grid/ag-grid.d-2.1.2.ts +++ /dev/null @@ -1,1992 +0,0 @@ -// Type definitions for ag-grid v2.1.2 -// Project: http://www.ag-grid.com/ -// Definitions by: Niall Crosby -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -declare namespace ag.grid { - class ColumnChangeEvent { - private type; - private column; - private columnGroup; - private fromIndex; - private toIndex; - private pinnedColumnCount; - constructor(type: string); - toString(): string; - withColumn(column: Column): ColumnChangeEvent; - withColumnGroup(columnGroup: ColumnGroup): ColumnChangeEvent; - withFromIndex(fromIndex: number): ColumnChangeEvent; - withPinnedColumnCount(pinnedColumnCount: number): ColumnChangeEvent; - withToIndex(toIndex: number): ColumnChangeEvent; - getFromIndex(): number; - getToIndex(): number; - getPinnedColumnCount(): number; - getType(): string; - getColumn(): Column; - getColumnGroup(): ColumnGroup; - isPivotChanged(): boolean; - isValueChanged(): boolean; - isIndividualColumnResized(): boolean; - } -} -declare namespace ag.grid { - class Utils { - private static isSafari; - private static isIE; - static iterateObject(object: any, callback: (key: string, value: any) => void): void; - static cloneObject(object: any): any; - static map(array: TItem[], callback: (item: TItem) => TResult): TResult[]; - static forEach(array: T[], callback: (item: T, index: number) => void): void; - static filter(array: T[], callback: (item: T) => boolean): T[]; - static assign(object: any, source: any): void; - static getFunctionParameters(func: any): any; - static find(collection: any, predicate: any, value: any): any; - static toStrings(array: T[]): string[]; - static iterateArray(array: T[], callback: (item: T, index: number) => void): void; - static isNode(o: any): boolean; - static isElement(o: any): boolean; - static isNodeOrElement(o: any): boolean; - static addChangeListener(element: HTMLElement, listener: EventListener): void; - static makeNull(value: any): any; - static removeAllChildren(node: HTMLElement): void; - static removeElement(parent: HTMLElement, cssSelector: string): void; - static removeFromParent(node: Element): void; - static isVisible(element: HTMLElement): boolean; - /** - * loads the template and returns it as an element. makes up for no simple way in - * the dom api to load html directly, eg we cannot do this: document.createElement(template) - */ - static loadTemplate(template: string): Node; - static querySelectorAll_addCssClass(eParent: any, selector: string, cssClass: string): void; - static querySelectorAll_removeCssClass(eParent: any, selector: string, cssClass: string): void; - static querySelectorAll_replaceCssClass(eParent: any, selector: string, cssClassToRemove: string, cssClassToAdd: string): void; - static addOrRemoveCssClass(element: HTMLElement, className: string, addOrRemove: boolean): void; - static addCssClass(element: HTMLElement, className: string): void; - static offsetHeight(element: HTMLElement): number; - static offsetWidth(element: HTMLElement): number; - static removeCssClass(element: HTMLElement, className: string): void; - static removeFromArray(array: T[], object: T): void; - static defaultComparator(valueA: any, valueB: any): number; - static formatWidth(width: number | string): string; - /** - * Tries to use the provided renderer. - */ - static useRenderer(eParent: Element, eRenderer: (params: TParams) => Node | string, params: TParams): void; - /** - * If icon provided, use this (either a string, or a function callback). - * if not, then use the second parameter, which is the svgFactory function - */ - static createIcon(iconName: any, gridOptionsWrapper: any, colDefWrapper: any, svgFactoryFunc: () => Node): HTMLSpanElement; - static addStylesToElement(eElement: any, styles: any): void; - static getScrollbarWidth(): number; - static isKeyPressed(event: KeyboardEvent, keyToCheck: number): boolean; - static setVisible(element: HTMLElement, visible: boolean): void; - static isBrowserIE(): boolean; - static isBrowserSafari(): boolean; - } -} -declare namespace ag.grid { - class Constants { - static STEP_EVERYTHING: number; - static STEP_FILTER: number; - static STEP_SORT: number; - static STEP_MAP: number; - static ASC: string; - static DESC: string; - static ROW_BUFFER_SIZE: number; - static MIN_COL_WIDTH: number; - static SUM: string; - static MIN: string; - static MAX: string; - static KEY_TAB: number; - static KEY_ENTER: number; - static KEY_BACKSPACE: number; - static KEY_DELETE: number; - static KEY_ESCAPE: number; - static KEY_SPACE: number; - static KEY_DOWN: number; - static KEY_UP: number; - static KEY_LEFT: number; - static KEY_RIGHT: number; - } -} -declare namespace ag.grid { - class Column { - static colIdSequence: number; - colDef: ColDef; - actualWidth: any; - visible: any; - colId: any; - pinned: boolean; - index: number; - aggFunc: string; - pivotIndex: number; - sort: string; - sortedAt: number; - constructor(colDef: ColDef, actualWidth: any); - isGreaterThanMax(width: number): boolean; - getMinimumWidth(): number; - setMinimum(): void; - } -} -declare namespace ag.grid { - class ColumnGroup { - pinned: any; - name: any; - allColumns: Column[]; - displayedColumns: Column[]; - expandable: boolean; - expanded: boolean; - actualWidth: number; - constructor(pinned: any, name: any); - getMinimumWidth(): number; - addColumn(column: any): void; - calculateExpandable(): void; - calculateActualWidth(): void; - calculateDisplayedColumns(): void; - addToVisibleColumns(colsToAdd: any): void; - } -} -declare namespace ag.grid { - class GridOptionsWrapper { - private gridOptions; - private groupHeaders; - private headerHeight; - private rowHeight; - private floatingTopRowData; - private floatingBottomRowData; - init(gridOptions: GridOptions, eventService: EventService): void; - isRowSelection(): boolean; - isRowDeselection(): boolean; - isRowSelectionMulti(): boolean; - getContext(): any; - isVirtualPaging(): boolean; - isShowToolPanel(): boolean; - isToolPanelSuppressPivot(): boolean; - isToolPanelSuppressValues(): boolean; - isRowsAlreadyGrouped(): boolean; - isGroupSelectsChildren(): boolean; - isGroupHidePivotColumns(): boolean; - isGroupIncludeFooter(): boolean; - isGroupSuppressBlankHeader(): boolean; - isSuppressRowClickSelection(): boolean; - isSuppressCellSelection(): boolean; - isSuppressMultiSort(): boolean; - isGroupSuppressAutoColumn(): boolean; - isForPrint(): boolean; - isSuppressHorizontalScroll(): boolean; - isUnSortIcon(): boolean; - isSuppressMenuHide(): boolean; - getRowStyle(): any; - getRowClass(): any; - getRowStyleFunc(): any; - getRowClassFunc(): any; - getHeaderCellRenderer(): any; - getApi(): GridApi; - isEnableColResize(): boolean; - isSingleClickEdit(): boolean; - getGroupDefaultExpanded(): any; - getGroupKeys(): string[]; - getGroupAggFunction(): (nodes: any[]) => any; - getGroupAggFields(): string[]; - getRowData(): any[]; - isGroupUseEntireRow(): boolean; - getGroupColumnDef(): any; - isGroupSuppressRow(): boolean; - isAngularCompileRows(): boolean; - isAngularCompileFilters(): boolean; - isAngularCompileHeaders(): boolean; - isDebug(): boolean; - getColumnDefs(): any[]; - getDatasource(): any; - getRowBuffer(): number; - isEnableSorting(): boolean; - isEnableCellExpressions(): boolean; - isEnableServerSideSorting(): boolean; - isEnableFilter(): boolean; - isEnableServerSideFilter(): boolean; - isSuppressScrollLag(): boolean; - getIcons(): any; - getIsScrollLag(): () => boolean; - getSortingOrder(): string[]; - getSlaveGrids(): GridOptions[]; - getGroupRowRenderer(): Object | Function; - getRowHeight(): number; - getHeaderHeight(): number; - setHeaderHeight(headerHeight: number): void; - isGroupHeaders(): boolean; - setGroupHeaders(groupHeaders: boolean): void; - getFloatingTopRowData(): any[]; - setFloatingTopRowData(rows: any[]): void; - getFloatingBottomRowData(): any[]; - setFloatingBottomRowData(rows: any[]): void; - isExternalFilterPresent(): boolean; - doesExternalFilterPass(node: RowNode): boolean; - getGroupRowInnerRenderer(): (params: any) => void; - getColWidth(): number; - private checkForDeprecated(); - getPinnedColCount(): number; - getLocaleTextFunc(): Function; - globalEventHandler(eventName: string, event?: any): void; - private getCallbackForEvent(eventName); - } -} -declare namespace ag.grid { - class LoggerFactory { - private logging; - init(gridOptionsWrapper: GridOptionsWrapper): void; - create(name: string): Logger; - } - class Logger { - private logging; - private name; - constructor(name: string, logging: boolean); - log(message: string): void; - } -} -declare namespace ag.grid { - class Events { - /** A new set of columns has been entered, everything has potentially changed. */ - static EVENT_COLUMN_EVERYTHING_CHANGED: string; - /** A pivot column was added, removed or order changed. */ - static EVENT_COLUMN_PIVOT_CHANGE: string; - /** A value column was added, removed or agg function was changed. */ - static EVENT_COLUMN_VALUE_CHANGE: string; - /** A column was moved */ - static EVENT_COLUMN_MOVED: string; - /** One or more columns was shown / hidden */ - static EVENT_COLUMN_VISIBLE: string; - /** A column group was opened / closed */ - static EVENT_COLUMN_GROUP_OPENED: string; - /** One or more columns was resized. If just one, the column in the event is set. */ - static EVENT_COLUMN_RESIZED: string; - /** One or more columns was resized. If just one, the column in the event is set. */ - static EVENT_COLUMN_PINNED_COUNT_CHANGED: string; - static EVENT_MODEL_UPDATED: string; - static EVENT_CELL_CLICKED: string; - static EVENT_CELL_DOUBLE_CLICKED: string; - static EVENT_CELL_CONTEXT_MENU: string; - static EVENT_CELL_VALUE_CHANGED: string; - static EVENT_CELL_FOCUSED: string; - static EVENT_ROW_SELECTED: string; - static EVENT_SELECTION_CHANGED: string; - static EVENT_BEFORE_FILTER_CHANGED: string; - static EVENT_AFTER_FILTER_CHANGED: string; - static EVENT_FILTER_MODIFIED: string; - static EVENT_BEFORE_SORT_CHANGED: string; - static EVENT_AFTER_SORT_CHANGED: string; - static EVENT_VIRTUAL_ROW_REMOVED: string; - static EVENT_ROW_CLICKED: string; - static EVENT_READY: string; - } -} -declare namespace ag.grid { - class EventService { - private allListeners; - private globalListeners; - private getListenerList(eventType); - addEventListener(eventType: string, listener: Function): void; - addGlobalListener(listener: Function): void; - removeEventListener(eventType: string, listener: Function): void; - removeGlobalListener(listener: Function): void; - dispatchEvent(eventType: string, event?: any): void; - } -} -declare namespace ag.grid { - class MasterSlaveService { - private gridOptionsWrapper; - private columnController; - private gridPanel; - private logger; - private eventService; - private consuming; - init(gridOptionsWrapper: GridOptionsWrapper, columnController: ColumnController, gridPanel: GridPanel, loggerFactory: LoggerFactory, eventService: EventService): void; - private fireEvent(callback); - private onEvent(callback); - private fireColumnEvent(event); - fireHorizontalScrollEvent(horizontalScroll: number): void; - onScrollEvent(horizontalScroll: number): void; - onColumnEvent(event: ColumnChangeEvent): void; - } -} -declare namespace ag.grid { - class ColumnApi { - private _columnController; - constructor(_columnController: ColumnController); - sizeColumnsToFit(gridWidth: any): void; - hideColumns(colIds: any, hide: any): void; - columnGroupOpened(group: ColumnGroup, newValue: boolean): void; - getColumnGroup(name: string): ColumnGroup; - getDisplayNameForCol(column: any): string; - getColumn(key: any): Column; - setState(columnState: any): void; - getState(): [any]; - isPinning(): boolean; - getVisibleColAfter(col: Column): Column; - getVisibleColBefore(col: Column): Column; - setColumnVisible(column: Column, visible: boolean): void; - getAllColumns(): Column[]; - getDisplayedColumns(): Column[]; - getPivotedColumns(): Column[]; - getValueColumns(): Column[]; - moveColumn(fromIndex: number, toIndex: number): void; - movePivotColumn(fromIndex: number, toIndex: number): void; - setColumnAggFunction(column: Column, aggFunc: string): void; - setColumnWidth(column: Column, newWidth: number): void; - removeValueColumn(column: Column): void; - addValueColumn(column: Column): void; - removePivotColumn(column: Column): void; - setPinnedColumnCount(count: number): void; - addPivotColumn(column: Column): void; - getHeaderGroups(): ColumnGroup[]; - hideColumn(colId: any, hide: any): void; - } - class ColumnController { - private gridOptionsWrapper; - private angularGrid; - private selectionRendererFactory; - private expressionService; - private masterSlaveController; - private allColumns; - private visibleColumns; - private displayedColumns; - private pivotColumns; - private valueColumns; - private columnGroups; - private setupComplete; - private valueService; - private pinnedColumnCount; - private eventService; - constructor(); - init(angularGrid: Grid, selectionRendererFactory: SelectionRendererFactory, gridOptionsWrapper: GridOptionsWrapper, expressionService: ExpressionService, valueService: ValueService, masterSlaveController: MasterSlaveService, eventService: EventService): void; - getColumnApi(): ColumnApi; - isSetupComplete(): boolean; - getHeaderGroups(): ColumnGroup[]; - getPinnedContainerWidth(): number; - addPivotColumn(column: Column): void; - setPinnedColumnCount(count: number): void; - removePivotColumn(column: Column): void; - addValueColumn(column: Column): void; - removeValueColumn(column: Column): void; - private doesColumnExistInGrid(column); - setColumnWidth(column: Column, newWidth: number): void; - private updateGroupWidthsAfterColumnResize(column); - setColumnAggFunction(column: Column, aggFunc: string): void; - movePivotColumn(fromIndex: number, toIndex: number): void; - moveColumn(fromIndex: number, toIndex: number): void; - getBodyContainerWidth(): number; - getValueColumns(): Column[]; - getPivotedColumns(): Column[]; - getDisplayedColumns(): Column[]; - getAllColumns(): Column[]; - setColumnVisible(column: Column, visible: boolean): void; - getVisibleColBefore(col: any): Column; - getVisibleColAfter(col: Column): Column; - isPinning(): boolean; - getState(): [any]; - setState(columnState: any): void; - getColumns(keys: any[]): Column[]; - getColumn(key: any): Column; - getDisplayNameForCol(column: any): string; - getColumnGroup(name: string): ColumnGroup; - onColumnsChanged(): void; - private checkForDeprecatedItems(columnDefs); - columnGroupOpened(group: ColumnGroup, newValue: boolean): void; - hideColumns(colIds: any, hide: any): void; - private updateModel(); - private updateDisplayedColumns(); - sizeColumnsToFit(gridWidth: any): void; - private buildGroups(); - private updateGroups(); - private updateVisibleColumns(); - private updatePinnedColumns(); - private createColumns(colDefs); - private createPivotColumns(); - private createValueColumns(); - private createDummyColumn(field); - private calculateColInitialWidth(colDef); - private getTotalColWidth(includePinned); - } -} -declare namespace ag.grid { - interface CsvExportParams { - skipHeader?: boolean; - skipFooters?: boolean; - skipGroups?: boolean; - fileName?: string; - } - class CsvCreator { - private rowController; - private columnController; - private grid; - private valueService; - constructor(rowController: InMemoryRowController, columnController: ColumnController, grid: Grid, valueService: ValueService); - exportDataAsCsv(params?: CsvExportParams): void; - getDataAsCsv(params?: CsvExportParams): string; - private createValueForGroupNode(node); - private escape(value); - } -} -declare namespace ag.grid { - class ExpressionService { - private expressionToFunctionCache; - private logger; - init(loggerFactory: LoggerFactory): void; - evaluate(expression: string, params: any): any; - private createExpressionFunction(expression); - private createFunctionBody(expression); - } -} -declare namespace ag.grid { - interface TextAndNumberFilterParameters { - /** What to do when new rows are loaded. The default is to reset the filter, to keep it in line with 'set' filters. If you want to keep the selection, then set this value to 'keep'. */ - newRowsAction?: string; - } -} -declare namespace ag.grid { - class TextFilter implements Filter { - private filterParams; - private filterChangedCallback; - private filterModifiedCallback; - private localeTextFunc; - private valueGetter; - private filterText; - private filterType; - private api; - private eGui; - private eFilterTextField; - private eTypeSelect; - private applyActive; - private eApplyButton; - init(params: any): void; - onNewRowsLoaded(): void; - afterGuiAttached(): void; - doesFilterPass(node: any): boolean; - getGui(): any; - isFilterActive(): boolean; - private createTemplate(); - private createGui(); - private setupApply(); - private onTypeChanged(); - private onFilterChanged(); - private filterChanged(); - private createApi(); - private getApi(); - } -} -declare namespace ag.grid { - class NumberFilter implements Filter { - private filterParams; - private filterChangedCallback; - private filterModifiedCallback; - private localeTextFunc; - private valueGetter; - private filterNumber; - private filterType; - private api; - private eGui; - private eFilterTextField; - private eTypeSelect; - private applyActive; - private eApplyButton; - init(params: any): void; - onNewRowsLoaded(): void; - afterGuiAttached(): void; - doesFilterPass(node: any): boolean; - getGui(): any; - isFilterActive(): boolean; - private createTemplate(); - private createGui(); - private setupApply(); - private onTypeChanged(); - private filterChanged(); - private onFilterChanged(); - private createApi(); - private getApi(); - } -} -declare namespace ag.grid { - interface ColDef { - /** If sorting by default, set it here. Set to 'asc' or 'desc' */ - sort?: string; - /** If sorting more than one column by default, the milliseconds when this column was sorted, so we know what order to sort the columns in. */ - sortedAt?: number; - /** The sort order, provide an array with any of the following in any order ['asc','desc',null] */ - sortingOrder?: string[]; - /** The name to render in the column header */ - headerName: string; - /** The field of the row to get the cells data from */ - field: string; - /** Expression or function to get the cells value. */ - headerValueGetter?: string | Function; - /** The unique ID to give the column. This is optional. If missing, the ID will default to the field. If both field and colId are missing, a unique ID will be generated. - * This ID is used to identify the column in the API for sorting, filtering etc. */ - colId?: string; - /** Set to true for this column to be hidden. Naturally you might think, it would make more sense to call this field 'visible' and mark it false to hide, - * however we want all default values to be false and we want columns to be visible by default. */ - hide?: boolean; - /** Tooltip for the column header */ - headerTooltip?: string; - /** Expression or function to get the cells value. */ - valueGetter?: string | Function; - /** To provide custom rendering to the header. */ - headerCellRenderer?: Function | Object; - /** CSS class for the header */ - headerClass?: string | string[] | ((params: any) => string | string[]); - /** Initial width, in pixels, of the cell */ - width?: number; - /** Min width, in pixels, of the cell */ - minWidth?: number; - /** Max width, in pixels, of the cell */ - maxWidth?: number; - /** Class to use for the cell. Can be string, array of strings, or function. */ - cellClass?: string | string[] | ((cellClassParams: any) => string | string[]); - /** An object of css values. Or a function returning an object of css values. */ - cellStyle?: {} | ((params: any) => {}); - /** A function for rendering a cell. */ - cellRenderer?: Function | {}; - /** A function for rendering a floating cell. */ - floatingCellRenderer?: Function | {}; - /** Name of function to use for aggregation. One of [sum,min,max]. */ - aggFunc?: string; - /** Comparator function for custom sorting. */ - comparator?: Function; - /** Set to true to render a selection checkbox in the column. */ - checkboxSelection?: boolean; - /** Set to true if no menu should be shown for this column header. */ - suppressMenu?: boolean; - /** Set to true if no sorting should be done for this column. */ - suppressSorting?: boolean; - /** Set to true if you want the unsorted icon to be shown when no sort is applied to this column. */ - unSortIcon?: boolean; - /** Set to true if you want this columns width to be fixed during 'size to fit' operation. */ - suppressSizeToFit?: boolean; - /** Set to true if you do not want this column to be resizable by dragging it's edge. */ - suppressResize?: boolean; - /** If grouping columns, the group this column belongs to. */ - headerGroup?: string; - /** Whether to show the column when the group is open / closed. */ - headerGroupShow?: string; - /** Set to true if this col is editable, otherwise false. Can also be a function to have different rows editable. */ - editable?: boolean | (Function); - /** Callbacks for editing.See editing section for further details. */ - newValueHandler?: Function; - /** If true, this cell gets refreshed when api.softRefreshView() gets called. */ - volatile?: boolean; - /** Cell template to use for cell. Useful for AngularJS cells. */ - template?: string; - /** Cell template URL to load template from to use for cell. Useful for AngularJS cells. */ - templateUrl?: string; - /** one of the built in filter names: [set, number, text], or a filter function*/ - filter?: string | Function; - /** The filter params are specific to each filter! */ - filterParams?: SetFilterParameters | TextAndNumberFilterParameters; - /** Rules for applying css classes */ - cellClassRules?: { - [cssClassName: string]: (Function | string); - }; - /** Callbacks for editing.See editing section for further details. */ - onCellValueChanged?: Function; - /** Function callback, gets called when a cell is clicked. */ - onCellClicked?: Function; - /** Function callback, gets called when a cell is double clicked. */ - onCellDoubleClicked?: Function; - /** Function callback, gets called when a cell is right clicked. */ - onCellContextMenu?: Function; - } -} -declare namespace ag.grid { - class SetFilterModel { - private colDef; - private filterParams; - private rowModel; - private valueGetter; - private allUniqueValues; - private availableUniqueValues; - private displayedValues; - private miniFilter; - private selectedValuesCount; - private selectedValuesMap; - private showingAvailableOnly; - private usingProvidedSet; - private doesRowPassOtherFilters; - constructor(colDef: ColDef, rowModel: any, valueGetter: any, doesRowPassOtherFilters: any); - refreshAfterNewRowsLoaded(keepSelection: any, isSelectAll: boolean): void; - refreshAfterAnyFilterChanged(): void; - private createAllUniqueValues(); - private createAvailableUniqueValues(); - private getUniqueValues(filterOutNotAvailable); - setMiniFilter(newMiniFilter: any): boolean; - getMiniFilter(): any; - private processMiniFilter(); - getDisplayedValueCount(): any; - getDisplayedValue(index: any): any; - selectEverything(): void; - isFilterActive(): boolean; - selectNothing(): void; - getUniqueValueCount(): any; - getUniqueValue(index: any): any; - unselectValue(value: any): void; - selectValue(value: any): void; - isValueSelected(value: any): boolean; - isEverythingSelected(): boolean; - isNothingSelected(): boolean; - getModel(): any; - setModel(model: any, isSelectAll: boolean): void; - } -} -/** The filter parameters for set filter */ -declare namespace ag.grid { - interface SetFilterParameters { - /** Same as cell renderer for grid (you can use the same one in both locations). Setting it separatly here allows for the value to be rendered differently in the filter. */ - cellRenderer?: Function; - /** The height of the cell. */ - cellHeight?: number; - /** The values to display in the filter. */ - values?: any; - /** What to do when new rows are loaded. The default is to reset the filter, as the set of values to select from can have changed. If you want to keep the selection, then set this value to 'keep'. */ - newRowsAction?: string; - /** If true, the filter will not remove items that are no longer availabe due to other filters. */ - suppressRemoveEntries?: boolean; - } -} -declare namespace ag.grid { - class SetFilter implements Filter { - private eGui; - private filterParams; - private rowHeight; - private model; - private filterChangedCallback; - private filterModifiedCallback; - private valueGetter; - private rowsInBodyContainer; - private colDef; - private localeTextFunc; - private cellRenderer; - private eListContainer; - private eFilterValueTemplate; - private eSelectAll; - private eListViewport; - private eMiniFilter; - private api; - private applyActive; - private eApplyButton; - init(params: any): void; - afterGuiAttached(): void; - isFilterActive(): boolean; - doesFilterPass(node: any): boolean; - getGui(): any; - onNewRowsLoaded(): void; - onAnyFilterChanged(): void; - private createTemplate(); - private createGui(); - private setupApply(); - private setContainerHeight(); - private drawVirtualRows(); - private ensureRowsRendered(start, finish); - private removeVirtualRows(rowsToRemove); - private insertRow(value, rowIndex); - private onCheckboxClicked(eCheckbox, value); - private filterChanged(); - private onMiniFilterChanged(); - private refreshVirtualRows(); - private clearVirtualRows(); - private onSelectAll(); - private updateAllCheckboxes(checked); - private addScrollListener(); - getApi(): any; - private createApi(); - } -} -declare namespace ag.grid { - class PopupService { - private ePopupParent; - init(ePopupParent: any): void; - positionPopup(eventSource: any, ePopup: any, minWidth: any): void; - addAsModalPopup(eChild: any, closeOnEsc: boolean): (event: any) => void; - } -} -declare namespace ag.grid { - interface RowNode { - /** Unique ID for the node. Can be though of as the index of the row in the original list, - * however exceptions apply so don't depend on uniqueness. */ - id?: number; - /** The user provided data */ - data?: any; - /** The parent node to this node, or empty if top level */ - parent?: RowNode; - /** How many levels this node is from the top */ - level?: number; - /** True if this node is a group node (ie has children) */ - group?: boolean; - /** True if this is the first child in this group */ - firstChild?: boolean; - /** True if this is the last child in this group */ - lastChild?: boolean; - /** The index of this node in the group */ - childIndex?: number; - /** True if this row is a floating row */ - floating?: boolean; - /** True if this row is a floating top row */ - floatingTop?: boolean; - /** True if this row is a floating bottom row */ - floatingBottom?: boolean; - /** If using quick filter, stores a string representation of the row for searching against */ - quickFilterAggregateText?: string; - /** Groups only - True if row is a footer. Footers have group = true and footer = true */ - footer?: boolean; - /** Groups only - Children of this group */ - children?: RowNode[]; - /** Groups only - The field we are pivoting on eg Country*/ - field?: string; - /** Groups only - The key for the pivot eg Ireland, UK, USA */ - key?: any; - /** Groups only - Filtered children of this group */ - childrenAfterFilter?: RowNode[]; - /** Groups only - Sorted children of this group */ - childrenAfterSort?: RowNode[]; - /** Groups only - Number of children and grand children */ - allChildrenCount?: number; - /** Groups only - True if group is expanded, otherwise false */ - expanded?: boolean; - /** Groups only - If doing footers, reference to the footer node for this group */ - sibling?: RowNode; - /** Not to be used, internal temporary map used by the grid when creating groups */ - _childrenMap?: {}; - } -} -declare namespace ag.grid { - class FilterManager { - private $compile; - private $scope; - private gridOptionsWrapper; - private grid; - private allFilters; - private rowModel; - private popupService; - private valueService; - private columnController; - private quickFilter; - private advancedFilterPresent; - private externalFilterPresent; - init(grid: Grid, gridOptionsWrapper: GridOptionsWrapper, $compile: any, $scope: any, columnController: ColumnController, popupService: PopupService, valueService: ValueService): void; - setFilterModel(model: any): void; - private setModelOnFilterWrapper(filter, newModel); - getFilterModel(): any; - setRowModel(rowModel: any): void; - isAdvancedFilterPresent(): boolean; - isAnyFilterPresent(): boolean; - isFilterPresentForCol(colId: any): any; - private doesFilterPass(node, filterToSkip?); - setQuickFilter(newFilter: any): boolean; - onFilterChanged(): void; - isQuickFilterPresent(): boolean; - doesRowPassOtherFilters(filterToSkip: any, node: any): boolean; - doesRowPassFilter(node: any, filterToSkip?: any): boolean; - private aggregateRowForQuickFilter(node); - refreshDisplayedValues(): void; - onNewRowsLoaded(): void; - private createValueGetter(column); - getFilterApi(column: Column): any; - private getOrCreateFilterWrapper(column); - private createFilterWrapper(column); - private assertMethodHasNoParameters(theMethod); - showFilter(column: Column, eventSource: any): void; - } -} -declare namespace ag.grid { - class TemplateService { - templateCache: any; - waitingCallbacks: any; - $scope: any; - init($scope: any): void; - getTemplate(url: any, callback: any): any; - handleHttpResult(httpResult: any, url: any): void; - } -} -declare namespace ag.grid { - class SelectionRendererFactory { - private angularGrid; - private selectionController; - init(angularGrid: any, selectionController: any): void; - createSelectionCheckbox(node: any, rowIndex: any): HTMLInputElement; - } -} -declare namespace ag.vdom { - class VElement { - static idSequence: number; - private id; - private elementAttachedListeners; - constructor(); - getId(): number; - addElementAttachedListener(listener: (element: Element) => void): void; - protected fireElementAttached(element: Element): void; - elementAttached(element: Element): void; - toHtmlString(): string; - } -} -declare namespace ag.vdom { - class VHtmlElement extends VElement { - private type; - private classes; - private eventListeners; - private attributes; - private children; - private innerHtml; - private style; - private bound; - private element; - constructor(type: string); - getElement(): HTMLElement; - setInnerHtml(innerHtml: string): void; - addStyles(styles: any): void; - private attachEventListeners(node); - addClass(newClass: string): void; - removeClass(oldClass: string): void; - addClasses(classes: string[]): void; - toHtmlString(): string; - private toHtmlStringChildren(); - private toHtmlStringAttributes(); - private toHtmlStringClasses(); - private toHtmlStringStyles(); - appendChild(child: any): void; - setAttribute(key: string, value: string): void; - addEventListener(event: string, listener: EventListener): void; - elementAttached(element: Element): void; - fireElementAttachedToChildren(element: Element): void; - } -} -declare namespace ag.vdom { - class VWrapperElement extends VElement { - private wrappedElement; - constructor(wrappedElement: Element); - toHtmlString(): string; - elementAttached(element: Element): void; - } -} -declare namespace ag.grid { - class RenderedCell { - private vGridCell; - private vSpanWithValue; - private vCellWrapper; - private vParentOfValue; - private checkboxOnChangeListener; - private column; - private data; - private node; - private rowIndex; - private editingCell; - private scope; - private isFirstColumn; - private gridOptionsWrapper; - private expressionService; - private selectionRendererFactory; - private rowRenderer; - private selectionController; - private $compile; - private templateService; - private cellRendererMap; - private eCheckbox; - private columnController; - private valueService; - private eventService; - private value; - private checkboxSelection; - constructor(isFirstColumn: any, column: any, $compile: any, rowRenderer: RowRenderer, gridOptionsWrapper: GridOptionsWrapper, expressionService: ExpressionService, selectionRendererFactory: SelectionRendererFactory, selectionController: SelectionController, templateService: TemplateService, cellRendererMap: { - [key: string]: any; - }, node: any, rowIndex: number, scope: any, columnController: ColumnController, valueService: ValueService, eventService: EventService); - getColumn(): Column; - private getValue(); - getVGridCell(): ag.vdom.VHtmlElement; - private getDataForRow(); - private setupComponents(); - startEditing(key?: number): void; - focusCell(forceBrowserFocus: boolean): void; - private stopEditing(eInput, blurListener, reset?); - createParams(): any; - createEvent(event: any, eventSource: any): any; - private addCellDoubleClickedHandler(); - private addCellContextMenuHandler(); - isCellEditable(): any; - private addCellClickedHandler(); - private populateCell(); - private addStylesFromCollDef(); - private addClassesFromCollDef(); - private addClassesFromRules(); - private addCellNavigationHandler(); - private isKeycodeForStartEditing(key); - createSelectionCheckbox(): void; - setSelected(state: boolean): void; - private createParentOfValue(); - isVolatile(): boolean; - refreshCell(): void; - private putDataIntoCell(); - private useCellRenderer(cellRenderer); - private addClasses(); - } -} -declare namespace ag.grid { - class RenderedRow { - vPinnedRow: any; - vBodyRow: any; - private renderedCells; - private scope; - private node; - private rowIndex; - private cellRendererMap; - private gridOptionsWrapper; - private parentScope; - private angularGrid; - private columnController; - private expressionService; - private rowRenderer; - private selectionRendererFactory; - private $compile; - private templateService; - private selectionController; - private pinning; - private eBodyContainer; - private ePinnedContainer; - private valueService; - private eventService; - constructor(gridOptionsWrapper: GridOptionsWrapper, valueService: ValueService, parentScope: any, angularGrid: Grid, columnController: ColumnController, expressionService: ExpressionService, cellRendererMap: { - [key: string]: any; - }, selectionRendererFactory: SelectionRendererFactory, $compile: any, templateService: TemplateService, selectionController: SelectionController, rowRenderer: RowRenderer, eBodyContainer: HTMLElement, ePinnedContainer: HTMLElement, node: any, rowIndex: number, eventService: EventService); - onRowSelected(selected: boolean): void; - softRefresh(): void; - getRenderedCellForColumn(column: Column): RenderedCell; - getCellForCol(column: Column): any; - destroy(): void; - private destroyScope(); - isDataInList(rows: any[]): boolean; - isNodeInList(nodes: RowNode[]): boolean; - isGroup(): boolean; - private drawNormalRow(); - private bindVirtualElement(vElement); - private createGroupRow(); - private createGroupSpanningEntireRowCell(padding); - setMainRowWidth(width: number): void; - private createChildScopeOrNull(data); - private addDynamicStyles(); - private createRowContainer(); - getRowNode(): any; - getRowIndex(): any; - refreshCells(colIds: string[]): void; - private addDynamicClasses(); - } -} -declare namespace ag.grid { - class SvgFactory { - static theInstance: SvgFactory; - static getInstance(): SvgFactory; - createFilterSvg(): Element; - createColumnShowingSvg(): Element; - createColumnHiddenSvg(): Element; - createMenuSvg(): Element; - createArrowUpSvg(): Element; - createArrowLeftSvg(): Element; - createArrowDownSvg(): Element; - createArrowRightSvg(): Element; - createSmallArrowDownSvg(): Element; - createArrowUpDownSvg(): Element; - } -} -declare namespace ag.grid { - function groupCellRendererFactory(gridOptionsWrapper: GridOptionsWrapper, selectionRendererFactory: SelectionRendererFactory, expressionService: ExpressionService): (params: any) => HTMLSpanElement; -} -declare namespace ag.grid { - class RowRenderer { - private columnModel; - private gridOptionsWrapper; - private angularGrid; - private selectionRendererFactory; - private gridPanel; - private $compile; - private $scope; - private selectionController; - private expressionService; - private templateService; - private cellRendererMap; - private rowModel; - private firstVirtualRenderedRow; - private lastVirtualRenderedRow; - private focusedCell; - private valueService; - private eventService; - private renderedRows; - private renderedTopFloatingRows; - private renderedBottomFloatingRows; - private eAllBodyContainers; - private eAllPinnedContainers; - private eBodyContainer; - private eBodyViewport; - private ePinnedColsContainer; - private eFloatingTopContainer; - private eFloatingTopPinnedContainer; - private eFloatingBottomContainer; - private eFloatingBottomPinnedContainer; - private eParentsOfRows; - init(columnModel: any, gridOptionsWrapper: GridOptionsWrapper, gridPanel: GridPanel, angularGrid: Grid, selectionRendererFactory: SelectionRendererFactory, $compile: any, $scope: any, selectionController: SelectionController, expressionService: ExpressionService, templateService: TemplateService, valueService: ValueService, eventService: EventService): void; - setRowModel(rowModel: any): void; - onIndividualColumnResized(column: Column): void; - setMainRowWidths(): void; - private findAllElements(gridPanel); - refreshAllFloatingRows(): void; - private refreshFloatingRows(renderedRows, rowData, pinnedContainer, bodyContainer, isTop); - refreshView(refreshFromIndex?: any): void; - softRefreshView(): void; - refreshRows(rowNodes: RowNode[]): void; - refreshCells(rowNodes: RowNode[], colIds: string[]): void; - rowDataChanged(rows: any): void; - private refreshAllVirtualRows(fromIndex); - refreshGroupRows(): void; - private removeVirtualRow(rowsToRemove, fromIndex?); - private unbindVirtualRow(indexToRemove); - drawVirtualRows(): void; - getFirstVirtualRenderedRow(): number; - getLastVirtualRenderedRow(): number; - private ensureRowsRendered(); - private insertRow(node, rowIndex, mainRowWidth); - getRenderedNodes(): any[]; - getIndexOfRenderedNode(node: any): number; - navigateToNextCell(key: any, rowIndex: number, column: Column): void; - private getNextCellToFocus(key, lastCellToFocus); - onRowSelected(rowIndex: number, selected: boolean): void; - focusCell(eCell: any, rowIndex: number, colIndex: number, colDef: ColDef, forceBrowserFocus: any): void; - getFocusedCell(): any; - setFocusedCell(rowIndex: any, colIndex: any): void; - startEditingNextCell(rowIndex: any, column: any, shiftKey: any): void; - } -} -declare namespace ag.grid { - class SelectionController { - private eParentsOfRows; - private angularGrid; - private gridOptionsWrapper; - private $scope; - private rowRenderer; - private selectedRows; - private selectedNodesById; - private rowModel; - private eventService; - init(angularGrid: Grid, gridPanel: GridPanel, gridOptionsWrapper: GridOptionsWrapper, $scope: any, rowRenderer: RowRenderer, eventService: EventService): void; - private initSelectedNodesById(); - getSelectedNodesById(): any; - getSelectedRows(): any; - getSelectedNodes(): any; - getBestCostNodeSelection(): any; - setRowModel(rowModel: any): void; - deselectAll(): void; - selectAll(): void; - selectNode(node: any, tryMulti: any, suppressEvents?: any): void; - private recursivelySelectAllChildren(node, suppressEvents?); - private recursivelyDeselectAllChildren(node); - private doWorkOfSelectNode(node, suppressEvents); - private addCssClassForNode_andInformVirtualRowListener(node); - private doWorkOfDeselectAllNodes(nodeToKeepSelected?); - private deselectRealNode(node); - private removeCssClassForNode(node); - deselectIndex(rowIndex: any): void; - deselectNode(node: any): void; - selectIndex(index: any, tryMulti: any, suppressEvents?: any): void; - private syncSelectedRowsAndCallListener(suppressEvents?); - private recursivelyCheckIfSelected(node); - isNodeSelected(node: any): boolean; - private updateGroupParentsIfNeeded(); - } -} -declare namespace ag.grid { - class RenderedHeaderElement { - private eRoot; - private dragStartX; - constructor(eRoot: HTMLElement); - getERoot(): HTMLElement; - destroy(): void; - refreshFilterIcon(): void; - refreshSortIcon(): void; - onDragStart(): void; - onDragging(dragChange: number): void; - onIndividualColumnResized(column: Column): void; - addDragHandler(eDraggableElement: any): void; - stopDragging(listenersToRemove: any): void; - } -} -declare namespace ag.grid { - class RenderedHeaderCell extends RenderedHeaderElement { - private static DEFAULT_SORTING_ORDER; - private eHeaderCell; - private eSortAsc; - private eSortDesc; - private eSortNone; - private eFilterIcon; - private column; - private gridOptionsWrapper; - private parentScope; - private childScope; - private filterManager; - private columnController; - private $compile; - private angularGrid; - private parentGroup; - private startWidth; - constructor(column: Column, parentGroup: RenderedHeaderGroupCell, gridOptionsWrapper: GridOptionsWrapper, parentScope: any, filterManager: FilterManager, columnController: ColumnController, $compile: any, angularGrid: Grid, eRoot: HTMLElement); - getGui(): HTMLElement; - destroy(): void; - private createScope(); - private addAttributes(); - private addClasses(); - private addMenu(); - private addSortIcons(headerCellLabel); - private setupComponents(); - private useRenderer(headerNameValue, headerCellRenderer, headerCellLabel); - refreshFilterIcon(): void; - refreshSortIcon(): void; - private getNextSortDirection(); - private addSortHandling(headerCellLabel); - onDragStart(): void; - onDragging(dragChange: number): void; - onIndividualColumnResized(column: Column): void; - private addHeaderClassesFromCollDef(); - } -} -declare namespace ag.grid { - class RenderedHeaderGroupCell extends RenderedHeaderElement { - private eHeaderGroup; - private eHeaderGroupCell; - private eHeaderCellResize; - private columnGroup; - private gridOptionsWrapper; - private columnController; - private children; - private groupWidthStart; - private childrenWidthStarts; - private minWidth; - private parentScope; - private filterManager; - private $compile; - private angularGrid; - constructor(columnGroup: ColumnGroup, gridOptionsWrapper: GridOptionsWrapper, columnController: ColumnController, eRoot: HTMLElement, angularGrid: Grid, parentScope: any, filterManager: FilterManager, $compile: any); - getGui(): HTMLElement; - destroy(): void; - refreshFilterIcon(): void; - refreshSortIcon(): void; - onIndividualColumnResized(column: Column): void; - private setupComponents(); - private isColumnInOurDisplayedGroup(column); - private setWidthOfGroupHeaderCell(); - private addGroupExpandIcon(eGroupCellLabel); - onDragStart(): void; - onDragging(dragChange: any): void; - } -} -declare namespace ag.grid { - class HeaderRenderer { - private gridOptionsWrapper; - private columnController; - private angularGrid; - private filterManager; - private $scope; - private $compile; - private ePinnedHeader; - private eHeaderContainer; - private eRoot; - private headerElements; - init(gridOptionsWrapper: GridOptionsWrapper, columnController: ColumnController, gridPanel: GridPanel, angularGrid: Grid, filterManager: FilterManager, $scope: any, $compile: any): void; - private findAllElements(gridPanel); - refreshHeader(): void; - private insertHeadersWithGrouping(); - private insertHeadersWithoutGrouping(); - updateSortIcons(): void; - updateFilterIcons(): void; - onIndividualColumnResized(column: Column): void; - } -} -declare namespace ag.grid { - class GroupCreator { - private valueService; - init(valueService: ValueService): void; - group(rowNodes: RowNode[], groupedCols: Column[], expandByDefault: any): RowNode[]; - isExpanded(expandByDefault: any, level: any): boolean; - } -} -declare namespace ag.grid { - class InMemoryRowController { - private gridOptionsWrapper; - private columnController; - private angularGrid; - private filterManager; - private $scope; - private allRows; - private rowsAfterGroup; - private rowsAfterFilter; - private rowsAfterSort; - private rowsAfterMap; - private model; - private groupCreator; - private valueService; - private eventService; - constructor(); - init(gridOptionsWrapper: GridOptionsWrapper, columnController: ColumnController, angularGrid: any, filterManager: FilterManager, $scope: any, groupCreator: GroupCreator, valueService: ValueService, eventService: EventService): void; - private createModel(); - getModel(): any; - forEachInMemory(callback: Function): void; - forEachNode(callback: Function): void; - forEachNodeAfterFilter(callback: Function): void; - forEachNodeAfterFilterAndSort(callback: Function): void; - private recursivelyWalkNodesAndCallback(list, callback); - updateModel(step: any): void; - private defaultGroupAggFunctionFactory(valueColumns, valueKeys); - doAggregate(): void; - expandOrCollapseAll(expand: boolean, rowNodes: RowNode[]): void; - private recursivelyClearAggData(nodes); - private recursivelyCreateAggData(nodes, groupAggFunction, level); - private doSort(); - private recursivelyResetSort(rowNodes); - private sortList(nodes, sortOptions); - private updateChildIndexes(nodes); - onPivotChanged(): void; - private doPivoting(); - private doFilter(); - private filterItems(rowNodes); - private recursivelyResetFilter(nodes); - setAllRows(rows: RowNode[], firstId?: number): void; - private recursivelyAddIdToNodes(nodes, index); - private recursivelyCheckUserProvidedNodes(nodes, parent, level); - private getTotalChildCount(rowNodes); - private doGroupMapping(); - private addToMap(mappedData, originalNodes); - private createFooterNode(groupNode); - } -} -declare namespace ag.grid { - class VirtualPageRowController { - rowRenderer: any; - datasourceVersion: any; - gridOptionsWrapper: any; - angularGrid: any; - datasource: any; - virtualRowCount: any; - foundMaxRow: any; - pageCache: any; - pageCacheSize: any; - pageLoadsInProgress: any; - pageLoadsQueued: any; - pageAccessTimes: any; - accessTime: any; - maxConcurrentDatasourceRequests: any; - maxPagesInCache: any; - pageSize: any; - overflowSize: any; - init(rowRenderer: any, gridOptionsWrapper: any, angularGrid: any): void; - setDatasource(datasource: any): void; - reset(): void; - createNodesFromRows(pageNumber: any, rows: any): any; - removeFromLoading(pageNumber: any): void; - pageLoadFailed(pageNumber: any): void; - pageLoaded(pageNumber: any, rows: any, lastRow: any): void; - putPageIntoCacheAndPurge(pageNumber: any, rows: any): void; - checkMaxRowAndInformRowRenderer(pageNumber: any, lastRow: any): void; - isPageAlreadyLoading(pageNumber: any): boolean; - doLoadOrQueue(pageNumber: any): void; - addToQueueAndPurgeQueue(pageNumber: any): void; - findLeastRecentlyAccessedPage(pageIndexes: any): number; - checkQueueForNextLoad(): void; - loadPage(pageNumber: any): void; - requestIsDaemon(datasourceVersionCopy: any): boolean; - getVirtualRow(rowIndex: any): any; - forEachNode(callback: any): void; - getModel(): { - getVirtualRow: (index: any) => any; - getVirtualRowCount: () => any; - forEachInMemory: (callback: any) => void; - forEachNode: (callback: any) => void; - forEachNodeAfterFilter: (callback: any) => void; - forEachNodeAfterFilterAndSort: (callback: any) => void; - }; - } -} -declare namespace ag.grid { - class PaginationController { - eGui: any; - btNext: any; - btPrevious: any; - btFirst: any; - btLast: any; - lbCurrent: any; - lbTotal: any; - lbRecordCount: any; - lbFirstRowOnPage: any; - lbLastRowOnPage: any; - ePageRowSummaryPanel: any; - angularGrid: any; - callVersion: any; - gridOptionsWrapper: any; - datasource: any; - pageSize: any; - rowCount: any; - foundMaxRow: any; - totalPages: any; - currentPage: any; - init(angularGrid: any, gridOptionsWrapper: any): void; - setDatasource(datasource: any): void; - reset(): void; - setTotalLabels(): void; - calculateTotalPages(): void; - pageLoaded(rows: any, lastRowIndex: any): void; - updateRowLabels(): void; - loadPage(): void; - isCallDaemon(versionCopy: any): boolean; - onBtNext(): void; - onBtPrevious(): void; - onBtFirst(): void; - onBtLast(): void; - isZeroPagesToDisplay(): boolean; - enableOrDisableButtons(): void; - createTemplate(): string; - getGui(): any; - setupComponents(): void; - } -} -declare namespace ag.grid { - class BorderLayout { - private eNorthWrapper; - private eSouthWrapper; - private eEastWrapper; - private eWestWrapper; - private eCenterWrapper; - private eOverlayWrapper; - private eCenterRow; - private eNorthChildLayout; - private eSouthChildLayout; - private eEastChildLayout; - private eWestChildLayout; - private eCenterChildLayout; - private isLayoutPanel; - private fullHeight; - private layoutActive; - private eGui; - private id; - private childPanels; - private centerHeightLastTime; - private sizeChangeListners; - constructor(params: any); - addSizeChangeListener(listener: Function): void; - fireSizeChanged(): void; - private setupPanels(params); - private setupPanel(content, ePanel); - getGui(): any; - doLayout(): boolean; - private layoutChild(childPanel); - private layoutHeight(); - private layoutHeightFullHeight(); - private layoutHeightNormal(); - getCentreHeight(): number; - private layoutWidth(); - setEastVisible(visible: any): void; - setOverlayVisible(visible: any): void; - setSouthVisible(visible: any): void; - } -} -declare namespace ag.grid { - class GridPanel { - private masterSlaveService; - private gridOptionsWrapper; - private columnModel; - private rowRenderer; - private rowModel; - private layout; - private forPrint; - private scrollWidth; - private scrollLagCounter; - private eBodyViewport; - private eRoot; - private eBody; - private eBodyContainer; - private ePinnedColsContainer; - private eHeaderContainer; - private ePinnedHeader; - private eHeader; - private eParentsOfRows; - private eBodyViewportWrapper; - private ePinnedColsViewport; - private eFloatingTop; - private ePinnedFloatingTop; - private eFloatingTopContainer; - private eFloatingBottom; - private ePinnedFloatingBottom; - private eFloatingBottomContainer; - init(gridOptionsWrapper: GridOptionsWrapper, columnModel: ColumnController, rowRenderer: RowRenderer, masterSlaveService: MasterSlaveService): void; - getLayout(): BorderLayout; - private setupComponents(); - getPinnedFloatingTop(): HTMLElement; - getFloatingTopContainer(): HTMLElement; - getPinnedFloatingBottom(): HTMLElement; - getFloatingBottomContainer(): HTMLElement; - private createTemplate(); - ensureIndexVisible(index: any): void; - ensureColIndexVisible(index: any): void; - showLoading(loading: any): void; - getWidthForSizeColsToFit(): number; - setRowModel(rowModel: any): void; - getBodyContainer(): HTMLElement; - getBodyViewport(): HTMLElement; - getPinnedColsContainer(): HTMLElement; - getHeaderContainer(): HTMLElement; - getRoot(): HTMLElement; - getPinnedHeader(): HTMLElement; - getRowsParent(): HTMLElement[]; - private queryHtmlElement(selector); - private findElements(); - private mouseWheelListener(event); - setBodyContainerWidth(): void; - setPinnedColContainerWidth(): void; - showPinnedColContainersIfNeeded(): void; - onBodyHeightChange(): void; - private sizeHeaderAndBody(); - private sizeHeaderAndBodyNormal(); - private sizeHeaderAndBodyForPrint(); - setHorizontalScrollPosition(hScrollPosition: number): void; - private addScrollListener(); - private requestDrawVirtualRows(); - private scrollHeader(bodyLeftPosition); - private scrollPinned(bodyTopPosition); - } -} -declare namespace ag.grid { - class DragAndDropService { - static theInstance: DragAndDropService; - static getInstance(): DragAndDropService; - dragItem: any; - constructor(); - stopDragging(): void; - setDragCssClasses(eListItem: any, dragging: any): void; - addDragSource(eDragSource: any, dragSourceCallback: any): void; - onMouseDownDragSource(eDragSource: any, dragSourceCallback: any): void; - addDropTarget(eDropTarget: any, dropTargetCallback: any): void; - } -} -declare function require(name: string): any; -declare namespace ag.grid { - class AgList { - private eGui; - private uniqueId; - private modelChangedListeners; - private itemSelectedListeners; - private beforeDropListeners; - private itemMovedListeners; - private dragSources; - private emptyMessage; - private eFilterValueTemplate; - private eListParent; - private model; - private cellRenderer; - private readOnly; - constructor(); - setReadOnly(readOnly: boolean): void; - setEmptyMessage(emptyMessage: any): void; - getUniqueId(): any; - addStyles(styles: any): void; - addCssClass(cssClass: any): void; - addDragSource(dragSource: any): void; - addModelChangedListener(listener: Function): void; - addItemSelectedListener(listener: any): void; - addItemMovedListener(listener: any): void; - addBeforeDropListener(listener: any): void; - private fireItemMoved(fromIndex, toIndex); - private fireModelChanged(); - private fireItemSelected(item); - private fireBeforeDrop(item); - private setupComponents(); - setModel(model: any): void; - getModel(): any; - setCellRenderer(cellRenderer: any): void; - refreshView(): void; - private insertRows(); - private insertBlankMessage(); - private setupAsDropTarget(); - private externalAcceptDrag(dragEvent); - private externalDrop(dragEvent); - private externalNoDrop(); - private addItemToList(newItem); - private addDragAndDropToListItem(eListItem, item); - private internalAcceptDrag(targetColumn, dragItem, eListItem); - private internalDrop(targetColumn, draggedColumn); - private internalNoDrop(eListItem); - private dragAfterThisItem(targetColumn, draggedColumn); - private setDropCssClasses(eListItem, state); - getGui(): any; - } -} -declare namespace ag.grid { - class ColumnSelectionPanel { - private gridOptionsWrapper; - private columnController; - private cColumnList; - layout: any; - private eRootPanel; - constructor(columnController: ColumnController, gridOptionsWrapper: GridOptionsWrapper, eventService: EventService); - private columnsChanged(); - getDragSource(): any; - private columnCellRenderer(params); - private setupComponents(); - private onItemMoved(fromIndex, toIndex); - getGui(): any; - } -} -declare namespace ag.grid { - class GroupSelectionPanel { - gridOptionsWrapper: any; - columnController: ColumnController; - inMemoryRowController: any; - cColumnList: any; - layout: any; - constructor(columnController: ColumnController, inMemoryRowController: any, gridOptionsWrapper: GridOptionsWrapper, eventService: EventService); - private columnsChanged(); - addDragSource(dragSource: any): void; - private columnCellRenderer(params); - private setupComponents(); - private onBeforeDrop(newItem); - private onItemMoved(fromIndex, toIndex); - } -} -declare namespace ag.grid { - class AgDropdownList { - private itemSelectedListeners; - private eValue; - private agList; - private eGui; - private hidePopupCallback; - private selectedItem; - private cellRenderer; - private popupService; - constructor(popupService: PopupService); - setWidth(width: any): void; - addItemSelectedListener(listener: any): void; - fireItemSelected(item: any): void; - setupComponents(): void; - itemSelected(item: any): void; - onClick(): void; - getGui(): any; - setSelected(item: any): void; - setCellRenderer(cellRenderer: any): void; - refreshView(): void; - setModel(model: any): void; - } -} -declare namespace ag.grid { - class ValuesSelectionPanel { - private gridOptionsWrapper; - private columnController; - private cColumnList; - private layout; - private popupService; - constructor(columnController: ColumnController, gridOptionsWrapper: GridOptionsWrapper, popupService: PopupService, eventService: EventService); - getLayout(): any; - private columnsChanged(); - addDragSource(dragSource: any): void; - private cellRenderer(params); - private setupComponents(); - private beforeDropListener(newItem); - } -} -declare namespace ag.grid { - class VerticalStack { - isLayoutPanel: any; - childPanels: any; - eGui: any; - constructor(); - addPanel(panel: any, height: any): void; - getGui(): any; - doLayout(): void; - } -} -declare namespace ag.grid { - class ToolPanel { - layout: any; - constructor(); - init(columnController: any, inMemoryRowController: any, gridOptionsWrapper: GridOptionsWrapper, popupService: PopupService, eventService: EventService): void; - } -} -declare namespace ag.grid { - interface GridOptions { - virtualPaging?: boolean; - toolPanelSuppressPivot?: boolean; - toolPanelSuppressValues?: boolean; - rowsAlreadyGrouped?: boolean; - suppressRowClickSelection?: boolean; - suppressCellSelection?: boolean; - sortingOrder?: string[]; - suppressMultiSort?: boolean; - suppressHorizontalScroll?: boolean; - unSortIcon?: boolean; - rowHeight?: number; - rowBuffer?: number; - enableColResize?: boolean; - enableCellExpressions?: boolean; - enableSorting?: boolean; - enableServerSideSorting?: boolean; - enableFilter?: boolean; - enableServerSideFilter?: boolean; - colWidth?: number; - suppressMenuHide?: boolean; - singleClickEdit?: boolean; - debug?: boolean; - icons?: any; - angularCompileRows?: boolean; - angularCompileFilters?: boolean; - angularCompileHeaders?: boolean; - localeText?: any; - localeTextFunc?: Function; - suppressScrollLag?: boolean; - groupSuppressAutoColumn?: boolean; - groupSelectsChildren?: boolean; - groupHidePivotColumns?: boolean; - groupIncludeFooter?: boolean; - groupUseEntireRow?: boolean; - groupSuppressRow?: boolean; - groupSuppressBlankHeader?: boolean; - forPrint?: boolean; - groupColumnDef?: any; - context?: any; - rowStyle?: any; - rowClass?: any; - groupDefaultExpanded?: any; - slaveGrids?: GridOptions[]; - rowSelection?: string; - rowDeselection?: boolean; - rowData?: any[]; - floatingTopRowData?: any[]; - floatingBottomRowData?: any[]; - showToolPanel?: boolean; - groupKeys?: string[]; - groupAggFields?: string[]; - columnDefs?: any[]; - datasource?: any; - pinnedColumnCount?: number; - groupHeaders?: boolean; - headerHeight?: number; - groupRowInnerRenderer?(params: any): void; - groupRowRenderer?: Function | Object; - isScrollLag?(): boolean; - isExternalFilterPresent?(): boolean; - doesExternalFilterPass?(node: RowNode): boolean; - getRowStyle?: any; - getRowClass?: any; - headerCellRenderer?: any; - groupAggFunction?(nodes: any[]): any; - onReady?(api: any): void; - onModelUpdated?(): void; - onCellClicked?(params: any): void; - onCellDoubleClicked?(params: any): void; - onCellContextMenu?(params: any): void; - onCellValueChanged?(params: any): void; - onCellFocused?(params: any): void; - onRowSelected?(params: any): void; - onSelectionChanged?(): void; - onBeforeFilterChanged?(): void; - onAfterFilterChanged?(): void; - onFilterModified?(): void; - onBeforeSortChanged?(): void; - onAfterSortChanged?(): void; - onVirtualRowRemoved?(params: any): void; - onRowClicked?(params: any): void; - api?: GridApi; - columnApi?: ColumnApi; - } -} -declare namespace ag.grid { - class GridApi { - private grid; - private rowRenderer; - private headerRenderer; - private filterManager; - private columnController; - private inMemoryRowController; - private selectionController; - private gridOptionsWrapper; - private gridPanel; - private valueService; - private masterSlaveService; - private eventService; - private csvCreator; - constructor(grid: Grid, rowRenderer: RowRenderer, headerRenderer: HeaderRenderer, filterManager: FilterManager, columnController: ColumnController, inMemoryRowController: InMemoryRowController, selectionController: SelectionController, gridOptionsWrapper: GridOptionsWrapper, gridPanel: GridPanel, valueService: ValueService, masterSlaveService: MasterSlaveService, eventService: EventService); - /** Used internally by grid. Not intended to be used by the client. Interface may change between releases. */ - __getMasterSlaveService(): MasterSlaveService; - getDataAsCsv(params?: CsvExportParams): string; - exportDataAsCsv(params?: CsvExportParams): void; - setDatasource(datasource: any): void; - onNewDatasource(): void; - setRowData(rowData: any): void; - setRows(rows: any): void; - onNewRows(): void; - setFloatingTopRowData(rows: any[]): void; - setFloatingBottomRowData(rows: any[]): void; - onNewCols(): void; - setColumnDefs(colDefs: ColDef[]): void; - unselectAll(): void; - refreshRows(rowNodes: RowNode[]): void; - refreshCells(rowNodes: RowNode[], colIds: string[]): void; - rowDataChanged(rows: any): void; - refreshView(): void; - softRefreshView(): void; - refreshGroupRows(): void; - refreshHeader(): void; - isAnyFilterPresent(): boolean; - isAdvancedFilterPresent(): boolean; - isQuickFilterPresent(): boolean; - getModel(): any; - onGroupExpandedOrCollapsed(refreshFromIndex: any): void; - expandAll(): void; - collapseAll(): void; - addVirtualRowListener(rowIndex: any, callback: any): void; - setQuickFilter(newFilter: any): void; - selectIndex(index: any, tryMulti: any, suppressEvents: any): void; - deselectIndex(index: any): void; - selectNode(node: any, tryMulti: any, suppressEvents: any): void; - deselectNode(node: any): void; - selectAll(): void; - deselectAll(): void; - recomputeAggregates(): void; - sizeColumnsToFit(): void; - showLoading(show: any): void; - isNodeSelected(node: any): boolean; - getSelectedNodesById(): { - [nodeId: number]: RowNode; - }; - getSelectedNodes(): RowNode[]; - getSelectedRows(): any[]; - getBestCostNodeSelection(): any; - getRenderedNodes(): any[]; - ensureColIndexVisible(index: any): void; - ensureIndexVisible(index: any): void; - ensureNodeVisible(comparator: any): void; - forEachInMemory(callback: Function): void; - forEachNode(callback: Function): void; - forEachNodeAfterFilter(callback: Function): void; - forEachNodeAfterFilterAndSort(callback: Function): void; - getFilterApiForColDef(colDef: any): any; - getFilterApi(key: any): any; - getColumnDef(key: any): ColDef; - onFilterChanged(): void; - setSortModel(sortModel: any): void; - getSortModel(): any; - setFilterModel(model: any): void; - getFilterModel(): any; - getFocusedCell(): any; - setFocusedCell(rowIndex: any, colIndex: any): void; - setHeaderHeight(headerHeight: number): void; - setGroupHeaders(groupHeaders: boolean): void; - showToolPanel(show: any): void; - isToolPanelShowing(): boolean; - hideColumn(colId: any, hide: any): void; - hideColumns(colIds: any, hide: any): void; - getColumnState(): [any]; - setColumnState(state: any): void; - doLayout(): void; - getValue(colDef: ColDef, data: any, node: any): any; - addEventListener(eventType: string, listener: Function): void; - addGlobalListener(listener: Function): void; - removeEventListener(eventType: string, listener: Function): void; - removeGlobalListener(listener: Function): void; - refreshPivot(): void; - } -} -declare namespace ag.grid { - class ValueService { - private gridOptionsWrapper; - private expressionService; - private columnController; - init(gridOptionsWrapper: GridOptionsWrapper, expressionService: ExpressionService, columnController: ColumnController): void; - getValue(colDef: ColDef, data: any, node: any): any; - private executeValueGetter(valueGetter, data, colDef, node); - private getValueCallback(data, node, field); - } -} -declare namespace ag.grid { - class Grid { - private virtualRowCallbacks; - private gridOptions; - private gridOptionsWrapper; - private inMemoryRowController; - private doingVirtualPaging; - private paginationController; - private virtualPageRowController; - private finished; - private selectionController; - private columnController; - private rowRenderer; - private headerRenderer; - private filterManager; - private valueService; - private masterSlaveService; - private eventService; - private toolPanel; - private gridPanel; - private eRootPanel; - private toolPanelShowing; - private doingPagination; - private usingInMemoryModel; - private rowModel; - constructor(eGridDiv: any, gridOptions: any, globalEventListener?: Function, $scope?: any, $compile?: any, quickFilterOnScope?: any); - getRowModel(): any; - private periodicallyDoLayout(); - private setupComponents($scope, $compile, eUserProvidedDiv, globalEventListener); - private onColumnChanged(event); - refreshPivot(): void; - getEventService(): EventService; - private onIndividualColumnResized(column); - showToolPanel(show: any): void; - isToolPanelShowing(): boolean; - isUsingInMemoryModel(): boolean; - setDatasource(datasource?: any): void; - private refreshHeaderAndBody(); - setFinished(): void; - onQuickFilterChanged(newFilter: any): void; - onFilterModified(): void; - onFilterChanged(): void; - onRowClicked(event: any, rowIndex: any, node: any): void; - showLoadingPanel(show: any): void; - private setupColumns(); - updateModelAndRefresh(step: any, refreshFromIndex?: any): void; - setRows(rows?: any, firstId?: any): void; - ensureNodeVisible(comparator: any): void; - getFilterModel(): any; - setFocusedCell(rowIndex: any, colIndex: any): void; - getSortModel(): any; - setSortModel(sortModel: any): void; - onSortingChanged(): void; - addVirtualRowListener(rowIndex: any, callback: any): void; - onVirtualRowSelected(rowIndex: any, selected: any): void; - onVirtualRowRemoved(rowIndex: any): void; - setColumnDefs(colDefs?: ColDef[]): void; - updateBodyContainerWidthAfterColResize(): void; - updatePinnedColContainerWidthAfterColResize(): void; - doLayout(): void; - } -} -declare namespace ag.grid { - class ComponentUtil { - static SIMPLE_PROPERTIES: string[]; - static SIMPLE_NUMBER_PROPERTIES: string[]; - static SIMPLE_BOOLEAN_PROPERTIES: string[]; - static WITH_IMPACT_NUMBER_PROPERTIES: string[]; - static WITH_IMPACT_BOOLEAN_PROPERTIES: string[]; - static WITH_IMPACT_OTHER_PROPERTIES: string[]; - static CALLBACKS: string[]; - static ALL_PROPERTIES: string[]; - static copyAttributesToGridOptions(gridOptions: GridOptions, component: any): GridOptions; - static processOnChange(changes: any, gridOptions: GridOptions, component: any): void; - static toBoolean(value: any): boolean; - static toNumber(value: any): number; - } -} -declare namespace ag.grid { - class AgGridNg2 { - private elementDef; - private _agGrid; - private _initialised; - private gridOptions; - private api; - private columnApi; - modelUpdated: any; - cellClicked: any; - cellDoubleClicked: any; - cellContextMenu: any; - cellValueChanged: any; - cellFocused: any; - rowSelected: any; - selectionChanged: any; - beforeFilterChanged: any; - afterFilterChanged: any; - filterModified: any; - beforeSortChanged: any; - afterSortChanged: any; - virtualRowRemoved: any; - rowClicked: any; - ready: any; - columnEverythingChanged: any; - columnPivotChanged: any; - columnValueChanged: any; - columnMoved: any; - columnVisible: any; - columnGroupOpened: any; - columnResized: any; - columnPinnedCountChanged: any; - virtualPaging: boolean; - toolPanelSuppressPivot: boolean; - toolPanelSuppressValues: boolean; - rowsAlreadyGrouped: boolean; - suppressRowClickSelection: boolean; - suppressCellSelection: boolean; - sortingOrder: string[]; - suppressMultiSort: boolean; - suppressHorizontalScroll: boolean; - unSortIcon: boolean; - rowHeight: number; - rowBuffer: number; - enableColResize: boolean; - enableCellExpressions: boolean; - enableSorting: boolean; - enableServerSideSorting: boolean; - enableFilter: boolean; - enableServerSideFilter: boolean; - colWidth: number; - suppressMenuHide: boolean; - debug: boolean; - icons: any; - angularCompileRows: boolean; - angularCompileFilters: boolean; - angularCompileHeaders: boolean; - localeText: any; - localeTextFunc: Function; - groupSuppressAutoColumn: boolean; - groupSelectsChildren: boolean; - groupHidePivotColumns: boolean; - groupIncludeFooter: boolean; - groupUseEntireRow: boolean; - groupSuppressRow: boolean; - groupSuppressBlankHeader: boolean; - groupColumnDef: any; - forPrint: boolean; - context: any; - rowStyle: any; - rowClass: any; - headerCellRenderer: any; - groupDefaultExpanded: any; - slaveGrids: GridOptions[]; - rowSelection: string; - rowDeselection: boolean; - rowData: any[]; - floatingTopRowData: any[]; - floatingBottomRowData: any[]; - showToolPanel: boolean; - groupKeys: string[]; - groupAggFunction: (nodes: any[]) => void; - groupAggFields: string[]; - columnDefs: any[]; - datasource: any; - pinnedColumnCount: number; - quickFilterText: string; - groupHeaders: boolean; - headerHeight: number; - constructor(elementDef: any); - onInit(): void; - onChange(changes: any): void; - private globalEventListener(eventType, event); - } -} -declare namespace ag.grid { -} -declare var exports: any; -declare var module: any; -declare namespace ag.grid { - interface Filter { - getGui(): any; - isFilterActive(): boolean; - doesFilterPass(params: any): boolean; - afterGuiAttached?(params?: { - hidePopup?: Function; - }): void; - onNewRowsLoaded?(): void; - } -} diff --git a/amqplib/amqplib-0.3.d.ts b/amqplib/amqplib-0.3.d.ts deleted file mode 100644 index 3138f7494e..0000000000 --- a/amqplib/amqplib-0.3.d.ts +++ /dev/null @@ -1,219 +0,0 @@ -// Type definitions for amqplib 0.3.x -// Project: https://github.com/squaremo/amqp.node -// Definitions by: Michael Nahkies , Ab Reitsma -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -/// -/// - -declare module "amqplib/properties" { - namespace Replies { - interface Empty { - } - interface AssertQueue { - queue: string; - messageCount: number; - consumerCount: number; - } - interface PurgeQueue { - messageCount: number; - } - interface DeleteQueue { - messageCount: number; - } - interface AssertExchange { - exchange: string; - } - interface Consume { - consumerTag: string; - } - } - - namespace Options { - interface AssertQueue { - exclusive?: boolean; - durable?: boolean; - autoDelete?: boolean; - arguments?: any; - messageTtl?: number; - expires?: number; - deadLetterExchange?: string; - deadLetterRoutingKey?: string; - maxLength?: number; - } - interface DeleteQueue { - ifUnused?: boolean; - ifEmpty?: boolean; - } - interface AssertExchange { - durable?: boolean; - internal?: boolean; - autoDelete?: boolean; - alternateExchange?: string; - arguments?: any; - } - interface DeleteExchange { - ifUnused?: boolean; - } - interface Publish { - expiration?: string; - userId?: string; - CC?: string | string[]; - - mandatory?: boolean; - persistent?: boolean; - deliveryMode?: boolean | number; - BCC?: string | string[]; - - contentType?: string; - contentEncoding?: string; - headers?: any; - priority?: number; - correlationId?: string; - replyTo?: string; - messageId?: string; - timestamp?: number; - type?: string; - appId?: string; - } - interface Consume { - consumerTag?: string; - noLocal?: boolean; - noAck?: boolean; - exclusive?: boolean; - priority?: number; - arguments?: any; - } - interface Get { - noAck?: boolean; - } - } - - interface Message { - content: Buffer; - fields: any; - properties: any; - } -} - -declare module "amqplib" { - - import events = require("events"); - import when = require("when"); - import shared = require("amqplib/properties") - export import Replies = shared.Replies; - export import Options = shared.Options; - export import Message = shared.Message; - - interface Connection extends events.EventEmitter { - close(): when.Promise; - createChannel(): when.Promise; - createConfirmChannel(): when.Promise; - } - - interface Channel extends events.EventEmitter { - close(): when.Promise; - - assertQueue(queue: string, options?: Options.AssertQueue): when.Promise; - checkQueue(queue: string): when.Promise; - - deleteQueue(queue: string, options?: Options.DeleteQueue): when.Promise; - purgeQueue(queue: string): when.Promise; - - bindQueue(queue: string, source: string, pattern: string, args?: any): when.Promise; - unbindQueue(queue: string, source: string, pattern: string, args?: any): when.Promise; - - assertExchange(exchange: string, type: string, options?: Options.AssertExchange): when.Promise; - checkExchange(exchange: string): when.Promise; - - deleteExchange(exchange: string, options?: Options.DeleteExchange): when.Promise; - - bindExchange(destination: string, source: string, pattern: string, args?: any): when.Promise; - unbindExchange(destination: string, source: string, pattern: string, args?: any): when.Promise; - - publish(exchange: string, routingKey: string, content: Buffer, options?: Options.Publish): boolean; - sendToQueue(queue: string, content: Buffer, options?: Options.Publish): boolean; - - consume(queue: string, onMessage: (msg: Message) => any, options?: Options.Consume): when.Promise; - - cancel(consumerTag: string): when.Promise; - get(queue: string, options?: Options.Get): when.Promise; - - ack(message: Message, allUpTo?: boolean): void; - ackAll(): void; - - nack(message: Message, allUpTo?: boolean, requeue?: boolean): void; - nackAll(requeue?: boolean): void; - reject(message: Message, requeue?: boolean): void; - - prefetch(count: number, global?: boolean): when.Promise; - recover(): when.Promise; - } - - function connect(url: string, socketOptions?: any): when.Promise; -} - -declare module "amqplib/callback_api" { - - import events = require("events"); - import shared = require("amqplib/properties") - export import Replies = shared.Replies; - export import Options = shared.Options; - export import Message = shared.Message; - - interface Connection extends events.EventEmitter { - close(callback?: (err: any) => void): void; - createChannel(callback: (err: any, channel: Channel) => void): void; - createConfirmChannel(callback: (err: any, confirmChannel: ConfirmChannel) => void): void; - } - - interface Channel extends events.EventEmitter { - close(callback: (err: any) => void): void; - - assertQueue(queue?: string, options?: Options.AssertQueue, callback?: (err:any, ok: Replies.AssertQueue) => void): void; - checkQueue(queue: string, callback?: (err: any, ok: Replies.AssertQueue) => void): void; - - deleteQueue(queue: string, options?: Options.DeleteQueue, callback?: (err:any, ok: Replies.DeleteQueue) => void): void; - purgeQueue(queue: string, callback?: (err:any, ok: Replies.PurgeQueue) => void): void; - - bindQueue(queue: string, source: string, pattern: string, args?: any, callback?: (err: any, ok: Replies.Empty) => void): void; - unbindQueue(queue: string, source: string, pattern: string, args?: any, callback?: (err: any, ok: Replies.Empty) => void): void; - - assertExchange(exchange: string, type: string, options?: Options.AssertExchange, callback?: (err: any, ok: Replies.AssertExchange) => void): void; - checkExchange(exchange: string, callback?: (err: any, ok: Replies.Empty) => void): void; - - deleteExchange(exchange: string, options?: Options.DeleteExchange, callback?: (err: any, ok: Replies.Empty) => void): void; - - bindExchange(destination: string, source: string, pattern: string, args?: any, callback?: (err: any, ok: Replies.Empty) => void): void; - unbindExchange(destination: string, source: string, pattern: string, args?: any, callback?: (err: any, ok: Replies.Empty) => void): void; - - publish(exchange: string, routingKey: string, content: Buffer, options?: Options.Publish): boolean; - sendToQueue(queue: string, content: Buffer, options?: Options.Publish): boolean; - - consume(queue: string, onMessage: (msg: Message) => any, options?: Options.Consume, callback?: (err: any, ok: Replies.Consume) => void): void; - - cancel(consumerTag: string, callback?: (err: any, ok: Replies.Empty) => void): void; - get(queue: string, options?: Options.Get, callback?: (err: any, ok: Message | boolean) => void): void; - - ack(message: Message, allUpTo?: boolean): void; - ackAll(): void; - - nack(message: Message, allUpTo?: boolean, requeue?: boolean): void; - nackAll(requeue?: boolean): void; - reject(message: Message, requeue?: boolean): void; - - prefetch(count: number, global?: boolean): void; - recover(callback?: (err: any, ok: Replies.Empty) => void): void; - } - - interface ConfirmChannel extends Channel { - publish(exchange: string, routingKey: string, content: Buffer, options?: Options.Publish, callback?: (err: any, ok: Replies.Empty) => void): boolean; - sendToQueue(queue: string, content: Buffer, options?: Options.Publish, callback?: (err: any, ok: Replies.Empty) => void): boolean; - - waitForConfirms(callback?: (err: any) => void): void; - } - - function connect(callback: (err: any, connection: Connection) => void): void; - function connect(url: string, callback: (err: any, connection: Connection) => void): void; - function connect(url: string, socketOptions: any, callback: (err: any, connection: Connection) => void): void; -} diff --git a/angular-clipboard/angular-clipboard-tests.ts b/angular-clipboard/angular-clipboard-tests.ts index ccb1c7ce9a..b043a85d5a 100644 --- a/angular-clipboard/angular-clipboard-tests.ts +++ b/angular-clipboard/angular-clipboard-tests.ts @@ -1,6 +1,3 @@ -/// -/// - import * as angular from "angular"; import {ClipboardService} from "angular-clipboard"; diff --git a/angular-material/angular-material-0.8.3.d.ts b/angular-material/angular-material-0.8.3.d.ts deleted file mode 100644 index 0a19ec3764..0000000000 --- a/angular-material/angular-material-0.8.3.d.ts +++ /dev/null @@ -1,195 +0,0 @@ -// Type definitions for Angular Material 0.8.3+ (angular.material module) -// Project: https://github.com/angular/material -// Definitions by: Matt Traynham -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -/// -declare namespace angular.material { - - interface MDBottomSheetOptions { - templateUrl?: string; - template?: string; - controller?: any; - locals?: {[index: string]: any}; - targetEvent?: any; - resolve?: {[index: string]: angular.IPromise} - controllerAs?: string; - parent?: Element; - disableParentScroll?: boolean; - } - - interface MDBottomSheetService { - show(options: MDBottomSheetOptions): angular.IPromise; - hide(response?: any): void; - cancel(response?: any): void; - } - - interface MDPresetDialog { - title(title: string): T; - content(content: string): T; - ok(content: string): T; - theme(theme: string): T; - } - - interface MDAlertDialog extends MDPresetDialog { - } - - interface MDConfirmDialog extends MDPresetDialog { - cancel(reason?: string): MDConfirmDialog; - } - - interface MDDialogOptions { - templateUrl?: string; - template?: string; - domClickEvent?: any; - disableParentScroll?: boolean; - clickOutsideToClose?: boolean; - hasBackdrop?: boolean; - escapeToClose?: boolean; - controller?: any; - locals?: {[index: string]: any}; - bindToController?: boolean; - resolve?: {[index: string]: angular.IPromise} - controllerAs?: string; - parent?: Element; - onComplete?: Function; - } - - interface MDDialogService { - show(dialog: MDDialogOptions|MDPresetDialog): angular.IPromise; - confirm(): MDConfirmDialog; - alert(): MDAlertDialog; - hide(response?: any): angular.IPromise; - cancel(response?: any): void; - } - - interface MDIcon { - (path: string): angular.IPromise; - } - - interface MDIconProvider { - icon(id: string, url: string, iconSize?: string): MDIconProvider; - iconSet(id: string, url: string, iconSize?: string): MDIconProvider; - defaultIconSet(url: string, iconSize?: string): MDIconProvider; - defaultIconSize(iconSize: string): MDIconProvider; - } - - interface MDMedia { - (media: string): boolean; - } - - interface MDSidenavObject { - toggle(): void; - open(): void; - close(): void; - isOpen(): boolean; - isLockedOpen(): boolean; - } - - interface MDSidenavService { - (component: string): MDSidenavObject; - } - - interface MDToastPreset { - content(content: string): T; - action(action: string): T; - highlightAction(highlightAction: boolean): T; - capsule(capsule: boolean): T; - theme(theme: string): T; - hideDelay(delay: number): T; - } - - interface MDSimpleToastPreset extends MDToastPreset { - } - - interface MDToastOptions { - templateUrl?: string; - template?: string; - hideDelay?: number; - position?: string; - controller?: any; - locals?: {[index: string]: any}; - bindToController?: boolean; - resolve?: {[index: string]: angular.IPromise} - controllerAs?: string; - parent?: Element; - } - - interface MDToastService { - show(optionsOrPreset: MDToastOptions|MDToastPreset): angular.IPromise; - showSimple(): angular.IPromise; - simple(): MDSimpleToastPreset; - build(): MDToastPreset; - updateContent(): void; - hide(response?: any): void; - cancel(response?: any): void; - } - - interface MDPalette { - 0?: string; - 50?: string; - 100?: string; - 200?: string; - 300?: string; - 400?: string; - 500?: string; - 600?: string; - 700?: string; - 800?: string; - 900?: string; - A100?: string; - A200?: string; - A400?: string; - A700?: string; - contrastDefaultColor?: string; - contrastDarkColors?: string; - contrastStrongLightColors?: string; - } - - interface MDThemeHues { - default?: string; - 'hue-1'?: string; - 'hue-2'?: string; - 'hue-3'?: string; - } - - interface MDThemePalette { - name: string; - hues: MDThemeHues; - } - - interface MDThemeColors { - accent: MDThemePalette; - background: MDThemePalette; - primary: MDThemePalette; - warn: MDThemePalette; - } - - interface MDThemeGrayScalePalette { - 1: string; - 2: string; - 3: string; - 4: string; - name: string; - } - - interface MDTheme { - name: string; - colors: MDThemeColors; - foregroundPalette: MDThemeGrayScalePalette; - foregroundShadow: string; - accentPalette(name: string, hues?: MDThemeHues): MDTheme; - primaryPalette(name: string, hues?: MDThemeHues): MDTheme; - warnPalette(name: string, hues?: MDThemeHues): MDTheme; - backgroundPalette(name: string, hues?: MDThemeHues): MDTheme; - dark(isDark?: boolean): MDTheme; - } - - interface MDThemingProvider { - theme(name: string, inheritFrom?: string): MDTheme; - definePalette(name: string, palette: MDPalette): MDThemingProvider; - extendPalette(name: string, palette: MDPalette): MDPalette; - setDefaultTheme(theme: string): void; - alwaysWatchTheme(alwaysWatch: boolean): void; - } -} diff --git a/angular-material/angular-material-0.9.0.d.ts b/angular-material/angular-material-0.9.0.d.ts deleted file mode 100644 index 6ab01e7b13..0000000000 --- a/angular-material/angular-material-0.9.0.d.ts +++ /dev/null @@ -1,204 +0,0 @@ -// Type definitions for Angular Material 0.9.0-rc1+ (angular.material module) -// Project: https://github.com/angular/material -// Definitions by: Matt Traynham -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -/// -declare namespace angular.material { - - interface MDBottomSheetOptions { - templateUrl?: string; - template?: string; - scope?: angular.IScope; // default: new child scope - preserveScope?: boolean; // default: false - controller?: string|Function; - locals?: {[index: string]: any}; - targetEvent?: MouseEvent; - resolve?: {[index: string]: angular.IPromise} - controllerAs?: string; - parent?: string|Element|JQuery; // default: root node - disableParentScroll?: boolean; // default: true - } - - interface MDBottomSheetService { - show(options: MDBottomSheetOptions): angular.IPromise; - hide(response?: any): void; - cancel(response?: any): void; - } - - interface MDPresetDialog { - title(title: string): T; - content(content: string): T; - ok(ok: string): T; - theme(theme: string): T; - } - - interface MDAlertDialog extends MDPresetDialog { - } - - interface MDConfirmDialog extends MDPresetDialog { - cancel(cancel: string): MDConfirmDialog; - } - - interface MDDialogOptions { - templateUrl?: string; - template?: string; - targetEvent?: MouseEvent; - scope?: angular.IScope; // default: new child scope - preserveScope?: boolean; // default: false - disableParentScroll?: boolean; // default: true - hasBackdrop?: boolean // default: true - clickOutsideToClose?: boolean; // default: false - escapeToClose?: boolean; // default: true - focusOnOpen?: boolean; // default: true - controller?: string|Function; - locals?: {[index: string]: any}; - bindToController?: boolean; // default: false - resolve?: {[index: string]: angular.IPromise} - controllerAs?: string; - parent?: string|Element|JQuery; // default: root node - onComplete?: Function; - } - - interface MDDialogService { - show(dialog: MDDialogOptions|MDAlertDialog|MDConfirmDialog): angular.IPromise; - confirm(): MDConfirmDialog; - alert(): MDAlertDialog; - hide(response?: any): angular.IPromise; - cancel(response?: any): void; - } - - interface MDIcon { - (id: string): angular.IPromise; // id is a unique ID or URL - } - - interface MDIconProvider { - icon(id: string, url: string, iconSize?: string): MDIconProvider; // iconSize default: '24px' - iconSet(id: string, url: string, iconSize?: string): MDIconProvider; // iconSize default: '24px' - defaultIconSet(url: string, iconSize?: string): MDIconProvider; // iconSize default: '24px' - defaultIconSize(iconSize: string): MDIconProvider; // default: '24px' - } - - interface MDMedia { - (media: string): boolean; - } - - interface MDSidenavObject { - toggle(): angular.IPromise; - open(): angular.IPromise; - close(): angular.IPromise; - isOpen(): boolean; - isLockedOpen(): boolean; - } - - interface MDSidenavService { - (component: string): MDSidenavObject; - } - - interface MDToastPreset { - content(content: string): T; - action(action: string): T; - highlightAction(highlightAction: boolean): T; - capsule(capsule: boolean): T; - theme(theme: string): T; - hideDelay(delay: number): T; - position(position: string): T; - } - - interface MDSimpleToastPreset extends MDToastPreset { - } - - interface MDToastOptions { - templateUrl?: string; - template?: string; - scope?: angular.IScope; // default: new child scope - preserveScope?: boolean; // default: false - hideDelay?: number; // default (ms): 3000 - position?: string; // any combination of 'bottom'/'left'/'top'/'right'/'fit'; default: 'bottom left' - controller?: string|Function; - locals?: {[index: string]: any}; - bindToController?: boolean; // default: false - resolve?: {[index: string]: angular.IPromise} - controllerAs?: string; - parent?: string|Element|JQuery; // default: root node - } - - interface MDToastService { - show(optionsOrPreset: MDToastOptions|MDToastPreset): angular.IPromise; - showSimple(): angular.IPromise; - simple(): MDSimpleToastPreset; - build(): MDToastPreset; - updateContent(): void; - hide(response?: any): void; - cancel(response?: any): void; - } - - interface MDPalette { - 0?: string; - 50?: string; - 100?: string; - 200?: string; - 300?: string; - 400?: string; - 500?: string; - 600?: string; - 700?: string; - 800?: string; - 900?: string; - A100?: string; - A200?: string; - A400?: string; - A700?: string; - contrastDefaultColor?: string; - contrastDarkColors?: string|string[]; - contrastLightColors?: string|string[]; - } - - interface MDThemeHues { - default?: string; - 'hue-1'?: string; - 'hue-2'?: string; - 'hue-3'?: string; - } - - interface MDThemePalette { - name: string; - hues: MDThemeHues; - } - - interface MDThemeColors { - accent: MDThemePalette; - background: MDThemePalette; - primary: MDThemePalette; - warn: MDThemePalette; - } - - interface MDThemeGrayScalePalette { - 1: string; - 2: string; - 3: string; - 4: string; - name: string; - } - - interface MDTheme { - name: string; - isDark: boolean; - colors: MDThemeColors; - foregroundPalette: MDThemeGrayScalePalette; - foregroundShadow: string; - accentPalette(name: string, hues?: MDThemeHues): MDTheme; - primaryPalette(name: string, hues?: MDThemeHues): MDTheme; - warnPalette(name: string, hues?: MDThemeHues): MDTheme; - backgroundPalette(name: string, hues?: MDThemeHues): MDTheme; - dark(isDark?: boolean): MDTheme; - } - - interface MDThemingProvider { - theme(name: string, inheritFrom?: string): MDTheme; - definePalette(name: string, palette: MDPalette): MDThemingProvider; - extendPalette(name: string, palette: MDPalette): MDPalette; - setDefaultTheme(theme: string): void; - alwaysWatchTheme(alwaysWatch: boolean): void; - } -} diff --git a/angular-permission/angular-permission-2.3.1-tests.ts b/angular-permission/angular-permission-2.3.1-tests.ts deleted file mode 100644 index f0a3176d97..0000000000 --- a/angular-permission/angular-permission-2.3.1-tests.ts +++ /dev/null @@ -1,92 +0,0 @@ - - -import permission = angular.permission; - -angular - .module('fooModule', ['permission', 'user']) - .run(function (PermissionStore: permission.PermissionStore, User: any) { - // Define anonymous permission - PermissionStore - .definePermission('anonymous', function (stateParams) { - // If the returned value is *truthy* then the user has the permission, otherwise they don't - if (!User) { - return true; // Is anonymous - } - return false; - }); - }); - - interface BackendUserService { - checkSession(): angular.IPromise; - getAccessLevel(): angular.IPromise<{accessLevel: string}>; - hasPermissionDefinition(permission: string) : angular.IPromise; - } - - angular.module('barModule', ['permission', 'user']) - .run(function (PermissionStore: permission.PermissionStore, User: BackendUserService, $q: angular.IQService) { - PermissionStore - // Define user permission calling back-end - .definePermission('user', function (stateParams) { - // This time we will return a promise - // If the promise *resolves* then the user has the permission, if it *rejects* (you guessed it) - - // Let's assume this returns a promise that resolves or rejects if session is active - return User.checkSession(); - }); - - PermissionStore - // A different example for admin - .definePermission('admin', function (stateParams) { - var deferred = $q.defer(); - - User.getAccessLevel() - .then(function (data) { - if (data.accessLevel === 'admin') { - deferred.resolve(); - } else { - deferred.reject(); - } - }) - .catch(function () { - // Error with request - deferred.reject(); - }); - - return deferred.promise; - }); - - let arrayOfPermissionNames = ['p1', 'p2']; - PermissionStore.defineManyPermissions(arrayOfPermissionNames, function (stateParams: angular.ui.IStateParamsService, permissionName: string) { - return User.hasPermissionDefinition(permissionName); - }); - - PermissionStore.clearStore(); - - PermissionStore.removePermissionDefinition('user'); - - let permissions: Array = PermissionStore.getStore(); - - - }); - -angular - .module('fooModule', ['permission', 'user']) - .run(function (RoleStore: permission.RoleStore, User: any) { - RoleStore - // Permission array validated role - // Library will internally validate if 'user' and 'editor' permissions are valid when checking if role is valid - .defineRole('admin', ['user', 'editor']); - - RoleStore - // Server side validated role - .defineRole('accountant', [], function (stateParams) { - // Let's assume that we are making a request to server here and return response as promise - return User.hasRole('accountant'); - }); - - RoleStore.clearStore(); - - RoleStore.removeRoleDefinition('user'); - - let roles: Array = RoleStore.getStore(); - }); diff --git a/angular-permission/angular-permission-2.3.1.d.ts b/angular-permission/angular-permission-2.3.1.d.ts deleted file mode 100644 index 015ee62801..0000000000 --- a/angular-permission/angular-permission-2.3.1.d.ts +++ /dev/null @@ -1,165 +0,0 @@ -// Type definitions for angular-permission 2.3.1 -// Project: https://github.com/Narzerus/angular-permission -// Definitions by: Voislav Mishevski -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - - -/// - -declare namespace angular.permission { - - export interface PermissionStore { - /** - * Allows to define permission on application configuration - * @method - * - * @param permissionName {String} Name of defined permission - * @param validationFunction {Function} Function used to validate if permission is valid - */ - definePermission( - name: string, - validationFunction: (stateParams?: angular.ui.IStateParamsService, permission?: string) => boolean | angular.IPromise - ): void; - - /** - * Allows to define set of permissionNames with shared validation function on application configuration - * @method - * @throws {TypeError} - * - * @param permissionNames {Array} Set of permission names - * @param validationFunction {Function} Function used to validate if permission is valid - */ - defineManyPermissions( - permissions: string[], - validationFunction: (stateParams?: angular.ui.IStateParamsService, permission?: string) => boolean | angular.IPromise - ): void; - - clearStore(): void; - - /** - * Deletes permission - * @method - * - * @param permissionName {String} Name of defined permission - */ - removePermissionDefinition(permission: string): void; - - /** - * Checks if permission exists - * @method - * - * @param permissionName {String} Name of defined permission - * @returns {Boolean} - */ - hasPermissionDefinition(permissionName: string): boolean; - - /** - * Returns all permissions - * @method - * - * @returns {Object} Permissions collection - */ - getStore(): Permission[]; - } - - export interface RoleStore { - /** - * Allows to define role - * @method - * - * @param roleName {String} Name of defined role - * @param permissions {Array} Set of permission names - * @param [validationFunction] {Function} Function used to validate if permissions in role are valid - */ - defineRole( - role: string, - permissions: Array, - validationFunction: RoleValidationFunction - ): void; - - /** - * Allows to define role - * @method - * - * @param roleName {String} Name of defined role - * @param permissions {Array} Set of permission names - */ - defineRole(role: string, permissions: Array): void; - - /** - * Checks if role is defined in store - * @method - * - * @param roleName {String} Name of role - * @returns {Boolean} - */ - hasRoleDefinition(role: string): boolean; - - /** - * Returns role definition object by it's name - * @method - * - * @returns {permission.Role} Role definition object - */ - getRoleDefinition(roleName: string): Role; - - /** - * Removes all role definitions - * @method - */ - clearStore(): void; - - /** - * Deletes role from store - * @method - * - * @param roleName {String} Name of defined permission - */ - removeRoleDefinition(roleName: string): void; - - /** - * Returns all role definitions - * @method - * - * @returns {Object} Defined roles collection - */ - getStore(): Role[]; - } - - export interface Role { - roleName: string; - permissionNames: string[]; - validationFunction?: RoleValidationFunction; - } - - export interface Permission { - permissionName: string; - validationFunction?: PermissionValidationFunction; - } - - interface RoleValidationFunction { - (stateParams?: angular.ui.IStateParamsService, permission?: string): boolean | angular.IPromise; - } - - interface PermissionValidationFunction { - (stateParams?: angular.ui.IStateParamsService, permission?: string): boolean | angular.IPromise; - } - - export interface IPermissionState extends angular.ui.IState { - data?: any | DataWithPermissions; - } - - export interface DataWithPermissions { - permissions?: { - only?: (() => void) | Array | angular.IPromise; - except?: (() => void) | Array | angular.IPromise; - redirectTo: string | (() => string) | (() => PermissionRedirectConfigation) | {[index: string]: PermissionRedirectConfigation} - }; - } - - export interface PermissionRedirectConfigation { - state: string; - params?: {}; - options?: angular.ui.IStateOptions; - } -} diff --git a/angular/UNUSED_FILES.txt b/angular/UNUSED_FILES.txt new file mode 100644 index 0000000000..fc63be0214 --- /dev/null +++ b/angular/UNUSED_FILES.txt @@ -0,0 +1 @@ +angular-component-router.d.ts \ No newline at end of file diff --git a/angular/legacy/angular-1.0-tests.ts b/angular/legacy/angular-1.0-tests.ts deleted file mode 100644 index b0e7ed692c..0000000000 --- a/angular/legacy/angular-1.0-tests.ts +++ /dev/null @@ -1,219 +0,0 @@ - - -// issue: https://github.com/DefinitelyTyped/DefinitelyTyped/issues/369 -https://github.com/witoldsz/angular-http-auth/blob/master/src/angular-http-auth.js -/** - * @license HTTP Auth Interceptor Module for AngularJS - * (c) 2012 Witold Szczerba - * License: MIT - */ -angular.module('http-auth-interceptor', []) - - .provider('authService', function () { - /** - * Holds all the requests which failed due to 401 response, - * so they can be re-requested in future, once login is completed. - */ - var buffer = []; - - /** - * Required by HTTP interceptor. - * Function is attached to provider to be invisible for regular users of this service. - */ - this.pushToBuffer = function (config: ng.IRequestConfig, deferred: ng.IDeferred) { - buffer.push({ - config: config, - deferred: deferred - }); - } - - this.$get = ['$rootScope', '$injector', function ($rootScope: ng.IScope, $injector: ng.auto.IInjectorService) { - var $http: ng.IHttpService; //initialized later because of circular dependency problem - function retry(config: ng.IRequestConfig, deferred: ng.IDeferred) { - $http = $http || $injector.get('$http'); - $http(config).then(function (response) { - deferred.resolve(response); - }); - } - function retryAll() { - for (var i = 0; i < buffer.length; ++i) { - retry(buffer[i].config, buffer[i].deferred); - } - buffer = []; - } - - return { - loginConfirmed: function () { - $rootScope.$broadcast('event:auth-loginConfirmed'); - retryAll(); - } - } - }] - }) - -/** - * $http interceptor. - * On 401 response - it stores the request and broadcasts 'event:angular-auth-loginRequired'. - */ - .config(['$httpProvider', 'authServiceProvider', function ($httpProvider: ng.IHttpProvider, authServiceProvider) { - - var interceptor = ['$rootScope', '$q', function ($rootScope: ng.IScope, $q: ng.IQService) { - function success(response: ng.IHttpPromiseCallbackArg) { - return response; - } - - function error(response: ng.IHttpPromiseCallbackArg) { - if (response.status === 401) { - var deferred = $q.defer(); - authServiceProvider.pushToBuffer(response.config, deferred); - $rootScope.$broadcast('event:auth-loginRequired'); - return deferred.promise; - } - // otherwise - return $q.reject(response); - } - - return function (promise: ng.IHttpPromise) { - return promise.then(success, error); - } - - }]; - $httpProvider.responseInterceptors.push(interceptor); - }]); - - -namespace HttpAndRegularPromiseTests { - interface Person { - firstName: string; - lastName: string; - } - - interface ExpectedResponse extends Person { } - - interface SomeControllerScope extends ng.IScope { - person: Person; - theAnswer: number; - letters: string[]; - } - - var someController: Function = ($scope: SomeControllerScope, $http: ng.IHttpService, $q: ng.IQService) => { - $http.get("http://somewhere/some/resource") - .success((data: ExpectedResponse) => { - $scope.person = data; - }); - - $http.get("http://somewhere/some/resource") - .then((response: ng.IHttpPromiseCallbackArg) => { - // typing lost, so something like - // var i: number = response.data - // would type check - $scope.person = response.data; - }); - - $http.get("http://somewhere/some/resource") - .then((response: ng.IHttpPromiseCallbackArg) => { - // typing lost, so something like - // var i: number = response.data - // would NOT type check - $scope.person = response.data; - }); - - var aPromise: ng.IPromise = $q.when({ firstName: "Jack", lastName: "Sparrow" }); - aPromise.then((person: Person) => { - $scope.person = person; - }); - - var bPromise: ng.IPromise = $q.when(42); - bPromise.then((answer: number) => { - $scope.theAnswer = answer; - }); - - var cPromise: ng.IPromise = $q.when(["a", "b", "c"]); - cPromise.then((letters: string[]) => { - $scope.letters = letters; - }); - } - - // Test that we can pass around a type-checked success/error Promise Callback - var anotherController: Function = ($scope: SomeControllerScope, $http: - ng.IHttpService, $q: ng.IQService) => { - - var buildFooData: Function = () => 42; - - var doFoo: Function = (callback: ng.IHttpPromiseCallback) => { - $http.get('/foo', buildFooData()) - .success(callback); - } - - doFoo((data) => console.log(data)); - } -} - -// Test for AngularJS Syntax - -namespace My.Namespace { - export var x; // need to export something for module to kick in -} - -// IModule Registering Test -var mod = angular.module('tests', []); -mod.controller('name', function ($scope: ng.IScope) { }) -mod.controller('name', ['$scope', function ($scope: ng.IScope) { }]) -mod.controller(My.Namespace); -mod.directive('name', function ($scope: ng.IScope) { }) -mod.directive('name', ['$scope', function ($scope: ng.IScope) { }]) -mod.directive(My.Namespace); -mod.factory('name', function ($scope: ng.IScope) { }) -mod.factory('name', ['$scope', function ($scope: ng.IScope) { }]) -mod.factory(My.Namespace); -mod.filter('name', function ($scope: ng.IScope) { }) -mod.filter('name', ['$scope', function ($scope: ng.IScope) { }]) -mod.filter(My.Namespace); -mod.provider('name', function ($scope: ng.IScope) { }) -mod.provider('name', ['$scope', function ($scope: ng.IScope) { }]) -mod.provider(My.Namespace); -mod.service('name', function ($scope: ng.IScope) { }) -mod.service('name', ['$scope', function ($scope: ng.IScope) { }]) -mod.service(My.Namespace); -mod.constant('name', 23); -mod.constant('name', "23"); -mod.constant(My.Namespace); -mod.value('name', 23); -mod.value('name', "23"); -mod.value(My.Namespace); - -// Promise signature tests -var foo: ng.IPromise; -foo.then((x) => { - // x is inferred to be a number - return "asdf"; -}).then((x) => { - // x is inferred to be string - x.length; - return 123; -}).then((x) => { - // x is infered to be a number - x.toFixed(); - return; -}).then((x) => { - // x is infered to be void - // Typescript will prevent you to actually use x as a local variable - // Try object: - return { a: 123 }; -}).then((x) => { - // Object is inferred here - x.a = 123; - //Try a promise - var y: ng.IPromise; - return y; -}).then((x) => { - // x is infered to be a number, which is the resolved value of a promise - x.toFixed(); -}); - - -// angular.element() tests -var element = angular.element("div.myApp"); -var scope: ng.IScope = element.scope(); - - diff --git a/angular/legacy/angular-1.0.d.ts b/angular/legacy/angular-1.0.d.ts deleted file mode 100644 index 8c3fbca20a..0000000000 --- a/angular/legacy/angular-1.0.d.ts +++ /dev/null @@ -1,760 +0,0 @@ -// Type definitions for Angular JS 1.0 -// Project: http://angularjs.org -// Definitions by: Diego Vilar -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - - -/// - -declare var angular: ng.IAngularStatic; - -// Support for painless dependency injection -interface Function { - $inject:string[]; -} - -/////////////////////////////////////////////////////////////////////////////// -// ng module (angular.js) -/////////////////////////////////////////////////////////////////////////////// -declare namespace ng { - - // All service providers extend this interface - interface IServiceProvider { - $get(): any; - } - - /////////////////////////////////////////////////////////////////////////// - // AngularStatic - // see http://docs.angularjs.org/api - /////////////////////////////////////////////////////////////////////////// - interface IAngularStatic { - bind(context: any, fn: Function, ...args: any[]): Function; - bootstrap(element: string, modules?: any[]): auto.IInjectorService; - bootstrap(element: JQuery, modules?: any[]): auto.IInjectorService; - bootstrap(element: Element, modules?: any[]): auto.IInjectorService; - bootstrap(element: Document, modules?: any[]): auto.IInjectorService; - copy(source: any, destination?: any): any; - element: IAugmentedJQueryStatic; - equals(value1: any, value2: any): boolean; - extend(destination: any, ...sources: any[]): any; - forEach(obj: any, iterator: (value: any, key: any) => any, context?: any): any; - fromJson(json: string): any; - identity(arg?: any): any; - injector(modules?: any[]): auto.IInjectorService; - isArray(value: any): boolean; - isDate(value: any): boolean; - isDefined(value: any): boolean; - isElement(value: any): boolean; - isFunction(value: any): boolean; - isNumber(value: any): boolean; - isObject(value: any): boolean; - isString(value: any): boolean; - isUndefined(value: any): boolean; - lowercase(str: string): string; - /** construct your angular application - official docs: Interface for configuring angular modules. - see: http://docs.angularjs.org/api/angular.Module - */ - module( - /** name of your module you want to create */ - name: string, - /** name of modules yours depends on */ - requires?: string[], - configFunction?: any): IModule; - noop(...args: any[]): void; - toJson(obj: any, pretty?: boolean): string; - uppercase(str: string): string; - version: { - full: string; - major: number; - minor: number; - dot: number; - codename: string; - }; - } - - /////////////////////////////////////////////////////////////////////////// - // Module - // see http://docs.angularjs.org/api/angular.Module - /////////////////////////////////////////////////////////////////////////// - interface IModule { - animation(name: string, animationFactory: Function): IModule; - animation(name: string, inlineAnnotadedFunction: any[]): IModule; - animation(object: Object): IModule; - /** configure existing services. - Use this method to register work which needs to be performed on module loading - */ - config(configFn: Function): IModule; - /** configure existing services. - Use this method to register work which needs to be performed on module loading - */ - config(inlineAnnotadedFunction: any[]): IModule; - constant(name: string, value: any): IModule; - constant(object: Object): IModule; - controller(name: string, controllerConstructor: Function): IModule; - controller(name: string, inlineAnnotadedConstructor: any[]): IModule; - controller(object : Object): IModule; - directive(name: string, directiveFactory: (...params:any[])=> IDirective): IModule; - directive(name: string, inlineAnnotadedFunction: any[]): IModule; - directive(object: Object): IModule; - factory(name: string, serviceFactoryFunction: Function): IModule; - factory(name: string, inlineAnnotadedFunction: any[]): IModule; - factory(object: Object): IModule; - filter(name: string, filterFactoryFunction: Function): IModule; - filter(name: string, inlineAnnotadedFunction: any[]): IModule; - filter(object: Object): IModule; - provider(name: string, serviceProviderConstructor: Function): IModule; - provider(name: string, inlineAnnotadedConstructor: any[]): IModule; - provider(object: Object): IModule; - run(initializationFunction: Function): IModule; - run(inlineAnnotadedFunction: any[]): IModule; - service(name: string, serviceConstructor: Function): IModule; - service(name: string, inlineAnnotadedConstructor: any[]): IModule; - service(object: Object): IModule; - value(name: string, value: any): IModule; - value(object: Object): IModule; - - // Properties - name: string; - requires: string[]; - } - - /////////////////////////////////////////////////////////////////////////// - // Attributes - // see http://docs.angularjs.org/api/ng.$compile.directive.Attributes - /////////////////////////////////////////////////////////////////////////// - interface IAttributes { - $set(name: string, value: any): void; - $observe(name: string, fn:(value?:any)=>any):void; - $attr: any; - } - - /////////////////////////////////////////////////////////////////////////// - // FormController - // see http://docs.angularjs.org/api/ng.directive:form.FormController - /////////////////////////////////////////////////////////////////////////// - interface IFormController { - $pristine: boolean; - $dirty: boolean; - $valid: boolean; - $invalid: boolean; - $error: any; - $setDirty(): void; - $setPristine(): void; - } - - /////////////////////////////////////////////////////////////////////////// - // NgModelController - // see http://docs.angularjs.org/api/ng.directive:ngModel.NgModelController - /////////////////////////////////////////////////////////////////////////// - interface INgModelController { - $render(): void; - $setValidity(validationErrorKey: string, isValid: boolean): void; - $setViewValue(value: string): void; - - // XXX Not sure about the types here. Documentation states it's a string, but - // I've seen it receiving other types throughout the code. - // Falling back to any for now. - $viewValue: any; - - // XXX Same as avove - $modelValue: any; - - $parsers: IModelParser[]; - $formatters: IModelFormatter[]; - $error: any; - $pristine: boolean; - $dirty: boolean; - $valid: boolean; - $invalid: boolean; - } - - interface IModelParser { - (value: any): any; - } - - interface IModelFormatter { - (value: any): any; - } - - /////////////////////////////////////////////////////////////////////////// - // Scope - // see http://docs.angularjs.org/api/ng.$rootScope.Scope - /////////////////////////////////////////////////////////////////////////// - interface IScope { - $apply(): any; - $apply(exp: string): any; - $apply(exp: (scope: IScope) => any): any; - - $broadcast(name: string, ...args: any[]): IAngularEvent; - $destroy(): void; - $digest(): void; - $emit(name: string, ...args: any[]): IAngularEvent; - - // Documentation says exp is optional, but actual implementaton counts on it - $eval(expression: string): any; - $eval(expression: (scope: IScope) => any): any; - - // Documentation says exp is optional, but actual implementaton counts on it - $evalAsync(expression: string): void; - $evalAsync(expression: (scope: IScope) => any): void; - - // Defaults to false by the implementation checking strategy - $new(isolate?: boolean): IScope; - - $on(name: string, listener: (event: IAngularEvent, ...args: any[]) => any): Function; - - $watch(watchExpression: string, listener?: string, objectEquality?: boolean): Function; - $watch(watchExpression: string, listener?: (newValue: any, oldValue: any, scope: IScope) => any, objectEquality?: boolean): Function; - $watch(watchExpression: (scope: IScope) => any, listener?: string, objectEquality?: boolean): Function; - $watch(watchExpression: (scope: IScope) => any, listener?: (newValue: any, oldValue: any, scope: IScope) => any, objectEquality?: boolean): Function; - - $watchCollection(watchExpression: string, listener: (newValue: any, oldValue: any, scope: IScope) => any): Function; - $watchCollection(watchExpression: (scope: IScope) => any, listener: (newValue: any, oldValue: any, scope: IScope) => any): Function; - - $parent: IScope; - - $id: number; - - // Hidden members - $$isolateBindings: any; - $$phase: any; - } - - interface IAngularEvent { - targetScope: IScope; - currentScope: IScope; - name: string; - preventDefault: Function; - defaultPrevented: boolean; - - // Available only events that were $emit-ted - stopPropagation?: Function; - } - - /////////////////////////////////////////////////////////////////////////// - // WindowService - // see http://docs.angularjs.org/api/ng.$window - /////////////////////////////////////////////////////////////////////////// - interface IWindowService extends Window {} - - /////////////////////////////////////////////////////////////////////////// - // BrowserService - // TODO undocumented, so we need to get it from the source code - /////////////////////////////////////////////////////////////////////////// - interface IBrowserService {} - - /////////////////////////////////////////////////////////////////////////// - // TimeoutService - // see http://docs.angularjs.org/api/ng.$timeout - /////////////////////////////////////////////////////////////////////////// - interface ITimeoutService { - (func: Function, delay?: number, invokeApply?: boolean): IPromise; - cancel(promise: IPromise): boolean; - } - - /////////////////////////////////////////////////////////////////////////// - // FilterService - // see http://docs.angularjs.org/api/ng.$filter - // see http://docs.angularjs.org/api/ng.$filterProvider - /////////////////////////////////////////////////////////////////////////// - interface IFilterService { - (name: string): Function; - } - - interface IFilterProvider extends IServiceProvider { - register(name: string, filterFactory: Function): IServiceProvider; - } - - /////////////////////////////////////////////////////////////////////////// - // LocaleService - // see http://docs.angularjs.org/api/ng.$locale - /////////////////////////////////////////////////////////////////////////// - interface ILocaleService { - id: string; - - // These are not documented - // Check angular's i18n files for exemples - NUMBER_FORMATS: ILocaleNumberFormatDescriptor; - DATETIME_FORMATS: ILocaleDateTimeFormatDescriptor; - pluralCat: (num: any) => string; - } - - interface ILocaleNumberFormatDescriptor { - DECIMAL_SEP: string; - GROUP_SEP: string; - PATTERNS: ILocaleNumberPatternDescriptor[]; - CURRENCY_SYM: string; - } - - interface ILocaleNumberPatternDescriptor { - minInt: number; - minFrac: number; - maxFrac: number; - posPre: string; - posSuf: string; - negPre: string; - negSuf: string; - gSize: number; - lgSize: number; - } - - interface ILocaleDateTimeFormatDescriptor { - MONTH: string[]; - SHORTMONTH: string[]; - DAY: string[]; - SHORTDAY: string[]; - AMPMS: string[]; - medium: string; - short: string; - fullDate: string; - longDate: string; - mediumDate: string; - shortDate: string; - mediumTime: string; - shortTime: string; - } - - /////////////////////////////////////////////////////////////////////////// - // LogService - // see http://docs.angularjs.org/api/ng.$log - /////////////////////////////////////////////////////////////////////////// - interface ILogService { - debug: ILogCall; - error: ILogCall; - info: ILogCall; - log: ILogCall; - warn: ILogCall; - } - - // We define this as separete interface so we can reopen it later for - // the ngMock module. - interface ILogCall { - (...args: any[]): void; - } - - /////////////////////////////////////////////////////////////////////////// - // ParseService - // see http://docs.angularjs.org/api/ng.$parse - /////////////////////////////////////////////////////////////////////////// - interface IParseService { - (expression: string): ICompiledExpression; - } - - interface ICompiledExpression { - (context: any, locals?: any): any; - - // If value is not provided, undefined is gonna be used since the implementation - // does not check the parameter. Let's force a value for consistency. If consumer - // whants to undefine it, pass the undefined value explicitly. - assign(context: any, value: any): any; - } - - /////////////////////////////////////////////////////////////////////////// - // LocationService - // see http://docs.angularjs.org/api/ng.$location - // see http://docs.angularjs.org/api/ng.$locationProvider - // see http://docs.angularjs.org/guide/dev_guide.services.$location - /////////////////////////////////////////////////////////////////////////// - interface ILocationService { - absUrl(): string; - hash(): string; - hash(newHash: string): ILocationService; - host(): string; - path(): string; - path(newPath: string): ILocationService; - port(): number; - protocol(): string; - replace(): ILocationService; - search(): any; - search(parametersMap: any): ILocationService; - search(parameter: string, parameterValue: any): ILocationService; - url(): string; - url(url: string): ILocationService; - } - - interface ILocationProvider extends IServiceProvider { - hashPrefix(): string; - hashPrefix(prefix: string): ILocationProvider; - html5Mode(): boolean; - - // Documentation states that parameter is string, but - // implementation tests it as boolean, which makes more sense - // since this is a toggler - html5Mode(active: boolean): ILocationProvider; - } - - /////////////////////////////////////////////////////////////////////////// - // DocumentService - // see http://docs.angularjs.org/api/ng.$document - /////////////////////////////////////////////////////////////////////////// - interface IDocumentService extends Document {} - - /////////////////////////////////////////////////////////////////////////// - // ExceptionHandlerService - // see http://docs.angularjs.org/api/ng.$exceptionHandler - /////////////////////////////////////////////////////////////////////////// - interface IExceptionHandlerService { - (exception: Error, cause?: string): void; - } - - /////////////////////////////////////////////////////////////////////////// - // RootElementService - // see http://docs.angularjs.org/api/ng.$rootElement - /////////////////////////////////////////////////////////////////////////// - interface IRootElementService extends JQuery {} - - /////////////////////////////////////////////////////////////////////////// - // QService - // see http://docs.angularjs.org/api/ng.$q - /////////////////////////////////////////////////////////////////////////// - interface IQService { - all(promises: IPromise[]): IPromise; - defer(): IDeferred; - reject(reason?: any): IPromise; - when(value: T): IPromise; - } - - interface IPromise { - then(successCallback: (promiseValue: T) => IHttpPromise, errorCallback?: (reason: any) => any): IPromise; - then(successCallback: (promiseValue: T) => IPromise, errorCallback?: (reason: any) => any): IPromise; - then(successCallback: (promiseValue: T) => TResult, errorCallback?: (reason: any) => TResult): IPromise; - } - - interface IDeferred { - resolve(value?: T): void; - reject(reason?: any): void; - promise: IPromise; - } - - /////////////////////////////////////////////////////////////////////////// - // AnchorScrollService - // see http://docs.angularjs.org/api/ng.$anchorScroll - /////////////////////////////////////////////////////////////////////////// - interface IAnchorScrollService { - (): void; - } - - interface IAnchorScrollProvider extends IServiceProvider { - disableAutoScrolling(): void; - } - - /////////////////////////////////////////////////////////////////////////// - // CacheFactoryService - // see http://docs.angularjs.org/api/ng.$cacheFactory - /////////////////////////////////////////////////////////////////////////// - interface ICacheFactoryService { - // Lets not foce the optionsMap to have the capacity member. Even though - // it's the ONLY option considered by the implementation today, a consumer - // might find it useful to associate some other options to the cache object. - //(cacheId: string, optionsMap?: { capacity: number; }): CacheObject; - (cacheId: string, optionsMap?: { capacity: number; }): ICacheObject; - - // Methods bellow are not documented - info(): any; - get (cacheId: string): ICacheObject; - } - - interface ICacheObject { - info(): { - id: string; - size: number; - - // Not garanteed to have, since it's a non-mandatory option - //capacity: number; - }; - put(key: string, value?: any): void; - get (key: string): any; - remove(key: string): void; - removeAll(): void; - destroy(): void; - } - - /////////////////////////////////////////////////////////////////////////// - // CompileService - // see http://docs.angularjs.org/api/ng.$compile - // see http://docs.angularjs.org/api/ng.$compileProvider - /////////////////////////////////////////////////////////////////////////// - interface ICompileService { - (element: string, transclude?: ITemplateLinkingFunction, maxPriority?: number): ITemplateLinkingFunction; - (element: Element, transclude?: ITemplateLinkingFunction, maxPriority?: number): ITemplateLinkingFunction; - (element: JQuery, transclude?: ITemplateLinkingFunction, maxPriority?: number): ITemplateLinkingFunction; - } - - interface ICompileProvider extends IServiceProvider { - directive(name: string, directiveFactory: Function): ICompileProvider; - - // Undocumented, but it is there... - directive(directivesMap: any): ICompileProvider; - } - - interface ITemplateLinkingFunction { - // Let's hint but not force cloneAttachFn's signature - (scope: IScope, cloneAttachFn?: (clonedElement?: JQuery, scope?: IScope) => any): JQuery; - } - - /////////////////////////////////////////////////////////////////////////// - // ControllerService - // see http://docs.angularjs.org/api/ng.$controller - // see http://docs.angularjs.org/api/ng.$controllerProvider - /////////////////////////////////////////////////////////////////////////// - interface IControllerService { - // Although the documentation doesn't state this, locals are optional - (controllerConstructor: Function, locals?: any): any; - (controllerName: string, locals?: any): any; - } - - interface IControllerProvider extends IServiceProvider { - register(name: string, controllerConstructor: Function): void; - register(name: string, dependencyAnnotadedConstructor: any[]): void; - } - - /////////////////////////////////////////////////////////////////////////// - // HttpService - // see http://docs.angularjs.org/api/ng.$http - /////////////////////////////////////////////////////////////////////////// - interface IHttpService { - // At least moethod and url must be provided... - (config: IRequestConfig): IHttpPromise; - get (url: string, RequestConfig?: any): IHttpPromise; - delete (url: string, RequestConfig?: any): IHttpPromise; - head(url: string, RequestConfig?: any): IHttpPromise; - jsonp(url: string, RequestConfig?: any): IHttpPromise; - post(url: string, data: any, RequestConfig?: any): IHttpPromise; - put(url: string, data: any, RequestConfig?: any): IHttpPromise; - defaults: IRequestConfig; - - // For debugging, BUT it is documented as public, so... - pendingRequests: any[]; - } - - // This is just for hinting. - // Some opetions might not be available depending on the request. - // see http://docs.angularjs.org/api/ng.$http#Usage for options explanations - interface IRequestConfig { - method: string; - url: string; - params?: any; - - // XXX it has it's own structure... perhaps we should define it in the future - headers?: any; - - cache?: any; - timeout?: number; - withCredentials?: boolean; - - // These accept multiple types, so let's defile them as any - data?: any; - transformRequest?: any; - transformResponse?: any; - } - - interface IHttpPromiseCallback { - (data: T, status: number, headers: (headerName: string) => string, config: IRequestConfig): void; - } - - interface IHttpPromiseCallbackArg { - data?: T; - status?: number; - headers?: (headerName: string) => string; - config?: IRequestConfig; - } - - interface IHttpPromise extends IPromise { - success(callback: IHttpPromiseCallback): IHttpPromise; - error(callback: IHttpPromiseCallback): IHttpPromise; - then(successCallback: (response: IHttpPromiseCallbackArg) => TResult, errorCallback?: (response: IHttpPromiseCallbackArg) => any): IPromise; - then(successCallback: (response: IHttpPromiseCallbackArg) => IPromise, errorCallback?: (response: IHttpPromiseCallbackArg) => any): IPromise; - } - - interface IHttpProvider extends IServiceProvider { - defaults: IRequestConfig; - interceptors: any[]; - responseInterceptors: any[]; - } - - /////////////////////////////////////////////////////////////////////////// - // HttpBackendService - // see http://docs.angularjs.org/api/ng.$httpBackend - // You should never need to use this service directly. - /////////////////////////////////////////////////////////////////////////// - interface IHttpBackendService { - // XXX Perhaps define callback signature in the future - (method: string, url: string, post?: any, callback?: Function, headers?: any, timeout?: number, withCredentials?: boolean): void; - } - - /////////////////////////////////////////////////////////////////////////// - // InterpolateService - // see http://docs.angularjs.org/api/ng.$interpolate - // see http://docs.angularjs.org/api/ng.$interpolateProvider - /////////////////////////////////////////////////////////////////////////// - interface IInterpolateService { - (text: string, mustHaveExpression?: boolean): IInterpolationFunction; - endSymbol(): string; - startSymbol(): string; - } - - interface IInterpolationFunction { - (context: any): string; - } - - interface IInterpolateProvider extends IServiceProvider { - startSymbol(): string; - startSymbol(value: string): IInterpolateProvider; - endSymbol(): string; - endSymbol(value: string): IInterpolateProvider; - } - - /////////////////////////////////////////////////////////////////////////// - // RouteParamsService - // see http://docs.angularjs.org/api/ng.$routeParams - /////////////////////////////////////////////////////////////////////////// - interface IRouteParamsService {} - - /////////////////////////////////////////////////////////////////////////// - // TemplateCacheService - // see http://docs.angularjs.org/api/ng.$templateCache - /////////////////////////////////////////////////////////////////////////// - interface ITemplateCacheService extends ICacheObject {} - - /////////////////////////////////////////////////////////////////////////// - // RootScopeService - // see http://docs.angularjs.org/api/ng.$rootScope - /////////////////////////////////////////////////////////////////////////// - interface IRootScopeService extends IScope {} - - /////////////////////////////////////////////////////////////////////////// - // RouteService - // see http://docs.angularjs.org/api/ng.$route - // see http://docs.angularjs.org/api/ng.$routeProvider - /////////////////////////////////////////////////////////////////////////// - interface IRouteService { - reload(): void; - routes: any; - - // May not always be available. For instance, current will not be available - // to a controller that was not initialized as a result of a route maching. - current?: ICurrentRoute; - } - - // see http://docs.angularjs.org/api/ng.$routeProvider#when for options explanations - interface IRoute { - controller?: any; - name?: string; - template?: string; - templateUrl?: any; - resolve?: any; - redirectTo?: any; - reloadOnSearch?: boolean; - } - - // see http://docs.angularjs.org/api/ng.$route#current - interface ICurrentRoute extends IRoute { - locals: { - $scope: IScope; - $template: string; - }; - - params: any; - } - - interface IRouteProvider extends IServiceProvider { - otherwise(params: any): IRouteProvider; - when(path: string, route: IRoute): IRouteProvider; - } - - /////////////////////////////////////////////////////////////////////////// - // Directive - // see http://docs.angularjs.org/api/ng.$compileProvider#directive - // and http://docs.angularjs.org/guide/directive - /////////////////////////////////////////////////////////////////////////// - - interface IDirective{ - priority?: number; - template?: any; - templateUrl?: any; - replace?: boolean; - transclude?: any; - restrict?: string; - scope?: any; - link?: Function; - compile?: Function; - controller?: any; - } - - /////////////////////////////////////////////////////////////////////////// - // angular.element - // when calling angular.element, angular returns a jQuery object, - // augmented with additional methods like e.g. scope. - // see: http://docs.angularjs.org/api/angular.element - /////////////////////////////////////////////////////////////////////////// - interface IAugmentedJQueryStatic extends JQueryStatic { - (selector: string, context?: any): IAugmentedJQuery; - (element: Element): IAugmentedJQuery; - (object: {}): IAugmentedJQuery; - (elementArray: Element[]): IAugmentedJQuery; - (object: JQuery): IAugmentedJQuery; - (func: Function): IAugmentedJQuery; - (array: any[]): IAugmentedJQuery; - (): IAugmentedJQuery; - } - - interface IAugmentedJQuery extends JQuery { - // TODO: events, how to define? - //$destroy - - find(selector: string): IAugmentedJQuery; - find(element: any): IAugmentedJQuery; - find(obj: JQuery): IAugmentedJQuery; - - controller(name: string): any; - injector(): any; - scope(): IScope; - - inheritedData(key: string, value: any): JQuery; - inheritedData(obj: { [key: string]: any; }): JQuery; - inheritedData(key?: string): any; - - - } - - - /////////////////////////////////////////////////////////////////////////// - // AUTO module (angular.js) - /////////////////////////////////////////////////////////////////////////// - export module auto { - - /////////////////////////////////////////////////////////////////////// - // InjectorService - // see http://docs.angularjs.org/api/AUTO.$injector - /////////////////////////////////////////////////////////////////////// - interface IInjectorService { - annotate(fn: Function): string[]; - annotate(inlineAnnotadedFunction: any[]): string[]; - get (name: string): any; - instantiate(typeConstructor: Function, locals?: any): any; - invoke(func: Function, context?: any, locals?: any): any; - } - - /////////////////////////////////////////////////////////////////////// - // ProvideService - // see http://docs.angularjs.org/api/AUTO.$provide - /////////////////////////////////////////////////////////////////////// - interface IProvideService { - // Documentation says it returns the registered instance, but actual - // implementation does not return anything. - // constant(name: string, value: any): any; - constant(name: string, value: any): void; - - decorator(name: string, decorator: Function): void; - decorator(name: string, decoratorInline: any[]): void; - factory(name: string, serviceFactoryFunction: Function): ng.IServiceProvider; - provider(name: string, provider: ng.IServiceProvider): ng.IServiceProvider; - provider(name: string, serviceProviderConstructor: Function): ng.IServiceProvider; - service(name: string, constructor: Function): ng.IServiceProvider; - value(name: string, value: any): ng.IServiceProvider; - } - - } - -} diff --git a/angular/legacy/angular-1.2-tests.ts b/angular/legacy/angular-1.2-tests.ts deleted file mode 100644 index d618fa8d25..0000000000 --- a/angular/legacy/angular-1.2-tests.ts +++ /dev/null @@ -1,571 +0,0 @@ - - -// issue: https://github.com/DefinitelyTyped/DefinitelyTyped/issues/369 -// https://github.com/witoldsz/angular-http-auth/blob/master/src/angular-http-auth.js -/** - * @license HTTP Auth Interceptor Module for AngularJS - * (c) 2012 Witold Szczerba - * License: MIT - */ - -class AuthService { - /** - * Holds all the requests which failed due to 401 response, - * so they can be re-requested in future, once login is completed. - */ - buffer: { config: ng.IRequestConfig; deferred: ng.IDeferred; }[] = []; - - /** - * Required by HTTP interceptor. - * Function is attached to provider to be invisible for regular users of this service. - */ - pushToBuffer = function(config: ng.IRequestConfig, deferred: ng.IDeferred) { - this.buffer.push({ - config: config, - deferred: deferred - }); - } - - $get = [ - '$rootScope', '$injector', function($rootScope: ng.IScope, $injector: ng.auto.IInjectorService) { - var $http: ng.IHttpService; //initialized later because of circular dependency problem - function retry(config: ng.IRequestConfig, deferred: ng.IDeferred) { - $http = $http || $injector.get('$http'); - $http(config).then(function (response) { - deferred.resolve(response); - }); - } - function retryAll() { - for (var i = 0; i < this.buffer.length; ++i) { - retry(this.buffer[i].config, this.buffer[i].deferred); - } - this.buffer = []; - } - - return { - loginConfirmed: function () { - $rootScope.$broadcast('event:auth-loginConfirmed'); - retryAll(); - } - } - } - ]; -} - -angular.module('http-auth-interceptor', []) - - .provider('authService', AuthService) - -/** - * $http interceptor. - * On 401 response - it stores the request and broadcasts 'event:angular-auth-loginRequired'. - */ - .config(['$httpProvider', 'authServiceProvider', function ($httpProvider: ng.IHttpProvider, authServiceProvider: any) { - - var interceptor = ['$rootScope', '$q', function ($rootScope: ng.IScope, $q: ng.IQService) { - function success(response: ng.IHttpPromiseCallbackArg) { - return response; - } - - function error(response: ng.IHttpPromiseCallbackArg) { - if (response.status === 401) { - var deferred = $q.defer(); - authServiceProvider.pushToBuffer(response.config, deferred); - $rootScope.$broadcast('event:auth-loginRequired'); - return deferred.promise; - } - // otherwise - return $q.reject(response); - } - - return function (promise: ng.IHttpPromise) { - return promise.then(success, error); - } - - }]; - $httpProvider.responseInterceptors.push(interceptor); - }]); - - -namespace HttpAndRegularPromiseTests { - interface Person { - firstName: string; - lastName: string; - } - - interface ExpectedResponse extends Person { } - - interface SomeControllerScope extends ng.IScope { - person: Person; - theAnswer: number; - letters: string[]; - snack: string; - nothing?: string; - } - - var someController: Function = ($scope: SomeControllerScope, $http: ng.IHttpService, $q: ng.IQService) => { - $http.get("http://somewhere/some/resource") - .success((data: ExpectedResponse) => { - $scope.person = data; - }); - - $http.get("http://somewhere/some/resource") - .then((response: ng.IHttpPromiseCallbackArg) => { - // typing lost, so something like - // var i: number = response.data - // would type check - $scope.person = response.data; - }); - - $http.get("http://somewhere/some/resource") - .then((response: ng.IHttpPromiseCallbackArg) => { - // typing lost, so something like - // var i: number = response.data - // would NOT type check - $scope.person = response.data; - }); - - var aPromise: ng.IPromise = $q.when({ firstName: "Jack", lastName: "Sparrow" }); - aPromise.then((person: Person) => { - $scope.person = person; - }); - - var bPromise: ng.IPromise = $q.when(42); - bPromise.then((answer: number) => { - $scope.theAnswer = answer; - }); - - var cPromise: ng.IPromise = $q.when(["a", "b", "c"]); - cPromise.then((letters: string[]) => { - $scope.letters = letters; - }); - - // When $q.when is passed an IPromise, it returns an IPromise - var dPromise: ng.IPromise = $q.when($q.when("ALBATROSS!")); - dPromise.then((snack: string) => { - $scope.snack = snack; - }); - - // $q.when may be called without arguments - var ePromise: ng.IPromise = $q.when(); - ePromise.then(() => { - $scope.nothing = "really nothing"; - }); - } - - // Test that we can pass around a type-checked success/error Promise Callback - var anotherController: Function = ($scope: SomeControllerScope, $http: - ng.IHttpService, $q: ng.IQService) => { - - var buildFooData: Function = () => 42; - - var doFoo: Function = (callback: ng.IHttpPromiseCallback) => { - $http.get('/foo', buildFooData()) - .success(callback); - } - - doFoo((data: any) => console.log(data)); - } -} - -// Test for AngularJS Syntax - -namespace My.Namespace { - export var x: any; // need to export something for module to kick in -} - -// IModule Registering Test -var mod = angular.module('tests', []); -mod.controller('name', function ($scope: ng.IScope) { }) -mod.controller('name', ['$scope', function ($scope: ng.IScope) { }]) -mod.controller(My.Namespace); -mod.directive('name', function ($scope: ng.IScope) { }) -mod.directive('name', ['$scope', function ($scope: ng.IScope) { }]) -mod.directive(My.Namespace); -mod.factory('name', function ($scope: ng.IScope) { }) -mod.factory('name', ['$scope', function ($scope: ng.IScope) { }]) -mod.factory(My.Namespace); -mod.filter('name', function ($scope: ng.IScope) { }) -mod.filter('name', ['$scope', function ($scope: ng.IScope) { }]) -mod.filter(My.Namespace); -mod.provider('name', function ($scope: ng.IScope) { return { $get: () => { } } }) -mod.provider('name', TestProvider); -mod.provider('name', ['$scope', function ($scope: ng.IScope) { }]) -mod.provider(My.Namespace); -mod.service('name', function ($scope: ng.IScope) { }) -mod.service('name', ['$scope', function ($scope: ng.IScope) { }]) -mod.service(My.Namespace); -mod.constant('name', 23); -mod.constant('name', "23"); -mod.constant(My.Namespace); -mod.value('name', 23); -mod.value('name', "23"); -mod.value(My.Namespace); - -class TestProvider implements ng.IServiceProvider { - constructor(private $scope: ng.IScope) { - } - - $get() { - } -} - -// Promise signature tests -var foo: ng.IPromise; -foo.then((x) => { - // x is inferred to be a number - return "asdf"; -}).then((x) => { - // x is inferred to be string - x.length; - return 123; -}).then((x) => { - // x is infered to be a number - x.toFixed(); - return; -}).then((x) => { - // x is infered to be void - // Typescript will prevent you to actually use x as a local variable - // Try object: - return { a: 123 }; -}).then((x) => { - // Object is inferred here - x.a = 123; - //Try a promise - var y: ng.IPromise; - return y; -}).then((x) => { - // x is infered to be a number, which is the resolved value of a promise - x.toFixed(); -}); - - -var httpFoo: ng.IHttpPromise; -httpFoo.then((x) => { - // When returning a promise the generic type must be inferred. - var innerPromise : ng.IPromise; - return innerPromise; -}).then((x) => { - // must still be number. - x.toFixed(); -}); - - -function test_angular_forEach() { - var values: { [key: string]: string } = { name: 'misko', gender: 'male' }; - var log: string[] = []; - angular.forEach(values, function (value, key) { - this.push(key + ': ' + value); - }, log); - //expect(log).toEqual(['name: misko', 'gender: male']); -} - -// angular.element() tests -var element = angular.element("div.myApp"); -var scope: ng.IScope = element.scope(); -var isolateScope: ng.IScope = element.isolateScope(); - - - -function test_IAttributes(attributes: ng.IAttributes){ - return attributes; -} - -test_IAttributes({ - $addClass: function (classVal){}, - $removeClass: function(classVal){}, - $set: function(key, value){}, - $observe: function(name, fn){ - return fn; - }, - $attr: {} -}); - -class SampleDirective implements ng.IDirective { - public restrict = 'A'; - name = 'doh'; - - compile(templateElement: ng.IAugmentedJQuery) { - return { - post: this.link - }; - } - - static instance():ng.IDirective { - return new SampleDirective(); - } - - link(scope: ng.IScope) { - - } -} - -class SampleDirective2 implements ng.IDirective { - public restrict = 'EAC'; - - compile(templateElement: ng.IAugmentedJQuery) { - return { - pre: this.link - }; - } - - static instance():ng.IDirective { - return new SampleDirective2(); - } - - link(scope: ng.IScope) { - - } -} - -angular.module('SameplDirective', []).directive('sampleDirective', SampleDirective.instance).directive('sameplDirective2', SampleDirective2.instance); - -// test from https://docs.angularjs.org/guide/directive -angular.module('docsSimpleDirective', []) - .controller('Controller', ['$scope', function($scope: any) { - $scope.customer = { - name: 'Naomi', - address: '1600 Amphitheatre' - }; - }]) - .directive('myCustomer', function() { - return { - template: 'Name: {{customer.name}} Address: {{customer.address}}' - }; - }); - -angular.module('docsTemplateUrlDirective', []) - .controller('Controller', ['$scope', function($scope: any) { - $scope.customer = { - name: 'Naomi', - address: '1600 Amphitheatre' - }; - }]) - .directive('myCustomer', function() { - return { - templateUrl: 'my-customer.html' - }; - }); - -angular.module('docsRestrictDirective', []) - .controller('Controller', ['$scope', function($scope: any) { - $scope.customer = { - name: 'Naomi', - address: '1600 Amphitheatre' - }; - }]) - .directive('myCustomer', function() { - return { - restrict: 'E', - templateUrl: 'my-customer.html' - }; - }); - -angular.module('docsScopeProblemExample', []) - .controller('NaomiController', ['$scope', function($scope: any) { - $scope.customer = { - name: 'Naomi', - address: '1600 Amphitheatre' - }; - }]) - .controller('IgorController', ['$scope', function($scope: any) { - $scope.customer = { - name: 'Igor', - address: '123 Somewhere' - }; - }]) - .directive('myCustomer', function() { - return { - restrict: 'E', - templateUrl: 'my-customer.html' - }; - }); - -angular.module('docsIsolateScopeDirective', []) - .controller('Controller', ['$scope', function($scope: any) { - $scope.naomi = { name: 'Naomi', address: '1600 Amphitheatre' }; - $scope.igor = { name: 'Igor', address: '123 Somewhere' }; - }]) - .directive('myCustomer', function() { - return { - restrict: 'E', - scope: { - customerInfo: '=info' - }, - templateUrl: 'my-customer-iso.html' - }; - }); - -angular.module('docsIsolationExample', []) - .controller('Controller', ['$scope', function($scope: any) { - $scope.naomi = { name: 'Naomi', address: '1600 Amphitheatre' }; - $scope.vojta = { name: 'Vojta', address: '3456 Somewhere Else' }; - }]) - .directive('myCustomer', function() { - return { - restrict: 'E', - scope: { - customerInfo: '=info' - }, - templateUrl: 'my-customer-plus-vojta.html' - }; - }); - -angular.module('docsTimeDirective', []) - .controller('Controller', ['$scope', function($scope: any) { - $scope.format = 'M/d/yy h:mm:ss a'; - }]) - .directive('myCurrentTime', ['$interval', 'dateFilter', function($interval: any, dateFilter: any) { - - return { - link: function(scope: ng.IScope, element: ng.IAugmentedJQuery, attrs:ng.IAttributes) { - var format: any, - timeoutId: any; - - function updateTime() { - element.text(dateFilter(new Date(), format)); - } - - scope.$watch(attrs['myCurrentTime'], function (value: any) { - format = value; - updateTime(); - }); - - element.on('$destroy', function () { - $interval.cancel(timeoutId); - }); - - // start the UI update process; save the timeoutId for canceling - timeoutId = $interval(function () { - updateTime(); // update DOM - }, 1000); - } - }; - }]); - -angular.module('docsTransclusionDirective', []) - .controller('Controller', ['$scope', function($scope: any) { - $scope.name = 'Tobias'; - }]) - .directive('myDialog', function() { - return { - restrict: 'E', - transclude: true, - templateUrl: 'my-dialog.html' - }; - }); - -angular.module('docsTransclusionExample', []) - .controller('Controller', ['$scope', function($scope: any) { - $scope.name = 'Tobias'; - }]) - .directive('myDialog', function() { - return { - restrict: 'E', - transclude: true, - scope: {}, - templateUrl: 'my-dialog.html', - link: function (scope: ng.IScope, element: ng.IAugmentedJQuery) { - scope['name'] = 'Jeff'; - } - }; - }); - -angular.module('docsIsoFnBindExample', []) - .controller('Controller', ['$scope', '$timeout', function($scope: any, $timeout: any) { - $scope.name = 'Tobias'; - $scope.hideDialog = function () { - $scope.dialogIsHidden = true; - $timeout(function () { - $scope.dialogIsHidden = false; - }, 2000); - }; - }]) - .directive('myDialog', function() { - return { - restrict: 'E', - transclude: true, - scope: { - 'close': '&onClose' - }, - templateUrl: 'my-dialog-close.html' - }; - }); - -angular.module('dragModule', []) - .directive('myDraggable', ['$document', function($document: any) { - return function(scope: any, element: any, attr: any) { - var startX = 0, startY = 0, x = 0, y = 0; - - element.css({ - position: 'relative', - border: '1px solid red', - backgroundColor: 'lightgrey', - cursor: 'pointer' - }); - - element.on('mousedown', function(event: any) { - // Prevent default dragging of selected content - event.preventDefault(); - startX = event.pageX - x; - startY = event.pageY - y; - $document.on('mousemove', mousemove); - $document.on('mouseup', mouseup); - }); - - function mousemove(event: any) { - y = event.pageY - startY; - x = event.pageX - startX; - element.css({ - top: y + 'px', - left: x + 'px' - }); - } - - function mouseup() { - $document.off('mousemove', mousemove); - $document.off('mouseup', mouseup); - } - }; - }]); - -angular.module('docsTabsExample', []) - .directive('myTabs', function() { - return { - restrict: 'E', - transclude: true, - scope: {}, - controller: function($scope: ng.IScope) { - var panes: any = $scope['panes'] = []; - - $scope['select'] = function(pane: any) { - angular.forEach(panes, function(pane: any) { - pane.selected = false; - }); - pane.selected = true; - }; - - this.addPane = function(pane: any) { - if (panes.length === 0) { - $scope['select'](pane); - } - panes.push(pane); - }; - }, - templateUrl: 'my-tabs.html' - }; - }) - .directive('myPane', function() { - return { - require: '^myTabs', - restrict: 'E', - transclude: true, - scope: { - title: '@' - }, - link: function(scope: ng.IScope, element: ng.IAugmentedJQuery, attrs: ng.IAttributes, tabsCtrl: any) { - tabsCtrl.addPane(scope); - }, - templateUrl: 'my-pane.html' - }; - }); diff --git a/angular/legacy/angular-1.2.d.ts b/angular/legacy/angular-1.2.d.ts deleted file mode 100644 index 2c4fd8d014..0000000000 --- a/angular/legacy/angular-1.2.d.ts +++ /dev/null @@ -1,1189 +0,0 @@ -// Type definitions for Angular JS 1.2+ -// Project: http://angularjs.org -// Definitions by: Diego Vilar -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - - -/// - -declare var angular: ng.IAngularStatic; - -// Support for painless dependency injection -interface Function { - $inject?: string[]; -} - -/////////////////////////////////////////////////////////////////////////////// -// ng module (angular.js) -/////////////////////////////////////////////////////////////////////////////// -declare namespace ng { - - // not directly implemented, but ensures that constructed class implements $get - interface IServiceProviderClass { - new(...args: any[]): IServiceProvider; - } - - interface IServiceProviderFactory { - (...args: any[]): IServiceProvider; - } - - // All service providers extend this interface - interface IServiceProvider { - $get: any; - } - - /////////////////////////////////////////////////////////////////////////// - // AngularStatic - // see http://docs.angularjs.org/api - /////////////////////////////////////////////////////////////////////////// - interface IAngularStatic { - bind(context: any, fn: Function, ...args: any[]): Function; - bootstrap(element: string, modules?: any[]): auto.IInjectorService; - bootstrap(element: JQuery, modules?: any[]): auto.IInjectorService; - bootstrap(element: Element, modules?: any[]): auto.IInjectorService; - bootstrap(element: Document, modules?: any[]): auto.IInjectorService; - copy(source: any, destination?: any): any; - element: IAugmentedJQueryStatic; - equals(value1: any, value2: any): boolean; - extend(destination: any, ...sources: any[]): any; - - /** - * Invokes the iterator function once for each item in obj collection, which can be either an object or an array. The iterator function is invoked with iterator(value, key), where value is the value of an object property or an array element and key is the object property key or array element index. Specifying a context for the function is optional. - * - * It is worth noting that .forEach does not iterate over inherited properties because it filters using the hasOwnProperty method. - * - * @param obj Object to iterate over. - * @param iterator Iterator function. - * @param context Object to become context (this) for the iterator function. - */ - forEach(obj: T[], iterator: (value: T, key: number) => any, context?: any): any; - /** - * Invokes the iterator function once for each item in obj collection, which can be either an object or an array. The iterator function is invoked with iterator(value, key), where value is the value of an object property or an array element and key is the object property key or array element index. Specifying a context for the function is optional. - * - * It is worth noting that .forEach does not iterate over inherited properties because it filters using the hasOwnProperty method. - * - * @param obj Object to iterate over. - * @param iterator Iterator function. - * @param context Object to become context (this) for the iterator function. - */ - forEach(obj: { [index: string]: T; }, iterator: (value: T, key: string) => any, context?: any): any; - /** - * Invokes the iterator function once for each item in obj collection, which can be either an object or an array. The iterator function is invoked with iterator(value, key), where value is the value of an object property or an array element and key is the object property key or array element index. Specifying a context for the function is optional. - * - * It is worth noting that .forEach does not iterate over inherited properties because it filters using the hasOwnProperty method. - * - * @param obj Object to iterate over. - * @param iterator Iterator function. - * @param context Object to become context (this) for the iterator function. - */ - forEach(obj: any, iterator: (value: any, key: any) => any, context?: any): any; - - fromJson(json: string): any; - identity(arg?: any): any; - injector(modules?: any[]): auto.IInjectorService; - isArray(value: any): boolean; - isDate(value: any): boolean; - isDefined(value: any): boolean; - isElement(value: any): boolean; - isFunction(value: any): boolean; - isNumber(value: any): boolean; - isObject(value: any): boolean; - isString(value: any): boolean; - isUndefined(value: any): boolean; - lowercase(str: string): string; - - /** - * The angular.module is a global place for creating, registering and retrieving Angular modules. All modules (angular core or 3rd party) that should be available to an application must be registered using this mechanism. - * - * When passed two or more arguments, a new module is created. If passed only one argument, an existing module (the name passed as the first argument to module) is retrieved. - * - * @param name The name of the module to create or retrieve. - * @param requires The names of modules this module depends on. If specified then new module is being created. If unspecified then the module is being retrieved for further configuration. - * @param configFn Optional configuration function for the module. - */ - module( - name: string, - requires?: string[], - configFn?: Function): IModule; - - noop(...args: any[]): void; - toJson(obj: any, pretty?: boolean): string; - uppercase(str: string): string; - version: { - full: string; - major: number; - minor: number; - dot: number; - codename: string; - }; - } - - /////////////////////////////////////////////////////////////////////////// - // Module - // see http://docs.angularjs.org/api/angular.Module - /////////////////////////////////////////////////////////////////////////// - interface IModule { - animation(name: string, animationFactory: Function): IModule; - animation(name: string, inlineAnnotatedFunction: any[]): IModule; - animation(object: Object): IModule; - /** - * Use this method to register work which needs to be performed on module loading. - * - * @param configFn Execute this function on module load. Useful for service configuration. - */ - config(configFn: Function): IModule; - /** - * Use this method to register work which needs to be performed on module loading. - * - * @param inlineAnnotatedFunction Execute this function on module load. Useful for service configuration. - */ - config(inlineAnnotatedFunction: any[]): IModule; - /** - * Register a constant service, such as a string, a number, an array, an object or a function, with the $injector. Unlike value it can be injected into a module configuration function (see config) and it cannot be overridden by an Angular decorator. - * - * @param name The name of the constant. - * @param value The constant value. - */ - constant(name: string, value: any): IModule; - constant(object: Object): IModule; - /** - * The $controller service is used by Angular to create new controllers. - * - * This provider allows controller registration via the register method. - * - * @param name Controller name, or an object map of controllers where the keys are the names and the values are the constructors. - * @param controllerConstructor Controller constructor fn (optionally decorated with DI annotations in the array notation). - */ - controller(name: string, controllerConstructor: Function): IModule; - /** - * The $controller service is used by Angular to create new controllers. - * - * This provider allows controller registration via the register method. - * - * @param name Controller name, or an object map of controllers where the keys are the names and the values are the constructors. - * @param controllerConstructor Controller constructor fn (optionally decorated with DI annotations in the array notation). - */ - controller(name: string, inlineAnnotatedConstructor: any[]): IModule; - controller(object : Object): IModule; - directive(name: string, directiveFactory: IDirectiveFactory): IModule; - directive(name: string, inlineAnnotatedFunction: any[]): IModule; - directive(object: Object): IModule; - /** - * Register a service factory, which will be called to return the service instance. This is short for registering a service where its provider consists of only a $get property, which is the given service factory function. You should use $provide.factory(getFn) if you do not need to configure your service in a provider. - * - * @param name The name of the instance. - * @param $getFn The $getFn for the instance creation. Internally this is a short hand for $provide.provider(name, {$get: $getFn}). - */ - factory(name: string, $getFn: Function): IModule; - /** - * Register a service factory, which will be called to return the service instance. This is short for registering a service where its provider consists of only a $get property, which is the given service factory function. You should use $provide.factory(getFn) if you do not need to configure your service in a provider. - * - * @param name The name of the instance. - * @param inlineAnnotatedFunction The $getFn for the instance creation. Internally this is a short hand for $provide.provider(name, {$get: $getFn}). - */ - factory(name: string, inlineAnnotatedFunction: any[]): IModule; - factory(object: Object): IModule; - filter(name: string, filterFactoryFunction: Function): IModule; - filter(name: string, inlineAnnotatedFunction: any[]): IModule; - filter(object: Object): IModule; - provider(name: string, serviceProviderFactory: IServiceProviderFactory): IModule; - provider(name: string, serviceProviderConstructor: IServiceProviderClass): IModule; - provider(name: string, inlineAnnotatedConstructor: any[]): IModule; - provider(name: string, providerObject: IServiceProvider): IModule; - provider(object: Object): IModule; - /** - * Run blocks are the closest thing in Angular to the main method. A run block is the code which needs to run to kickstart the application. It is executed after all of the service have been configured and the injector has been created. Run blocks typically contain code which is hard to unit-test, and for this reason should be declared in isolated modules, so that they can be ignored in the unit-tests. - */ - run(initializationFunction: Function): IModule; - /** - * Run blocks are the closest thing in Angular to the main method. A run block is the code which needs to run to kickstart the application. It is executed after all of the service have been configured and the injector has been created. Run blocks typically contain code which is hard to unit-test, and for this reason should be declared in isolated modules, so that they can be ignored in the unit-tests. - */ - run(inlineAnnotatedFunction: any[]): IModule; - service(name: string, serviceConstructor: Function): IModule; - service(name: string, inlineAnnotatedConstructor: any[]): IModule; - service(object: Object): IModule; - /** - * Register a value service with the $injector, such as a string, a number, an array, an object or a function. This is short for registering a service where its provider's $get property is a factory function that takes no arguments and returns the value service. - - Value services are similar to constant services, except that they cannot be injected into a module configuration function (see config) but they can be overridden by an Angular decorator. - * - * @param name The name of the instance. - * @param value The value. - */ - value(name: string, value: any): IModule; - value(object: Object): IModule; - - // Properties - name: string; - requires: string[]; - } - - /////////////////////////////////////////////////////////////////////////// - // Attributes - // see http://docs.angularjs.org/api/ng.$compile.directive.Attributes - /////////////////////////////////////////////////////////////////////////// - interface IAttributes { - // this is necessary to be able to access the scoped attributes. it's not very elegant - // because you have to use attrs['foo'] instead of attrs.foo but I don't know of a better way - // this should really be limited to return string but it creates this problem: http://stackoverflow.com/q/17201854/165656 - [name: string]: any; - - // Adds the CSS class value specified by the classVal parameter to the - // element. If animations are enabled then an animation will be triggered - // for the class addition. - $addClass(classVal: string): void; - - // Removes the CSS class value specified by the classVal parameter from the - // element. If animations are enabled then an animation will be triggered for - // the class removal. - $removeClass(classVal: string): void; - - // Set DOM element attribute value. - $set(key: string, value: any): void; - - // Observes an interpolated attribute. - // The observer function will be invoked once during the next $digest - // following compilation. The observer is then invoked whenever the - // interpolated value changes. - $observe(name: string, fn:(value?:any)=>any): Function; - - // A map of DOM element attribute names to the normalized name. This is needed - // to do reverse lookup from normalized name back to actual name. - $attr: Object; - } - - /** - * form.FormController - type in module ng - * see https://docs.angularjs.org/api/ng/type/form.FormController - */ - interface IFormController { - - /** - * Indexer which should return ng.INgModelController for most properties but cannot because of "All named properties must be assignable to string indexer type" constraint - see https://github.com/Microsoft/TypeScript/issues/272 - */ - [name: string]: any; - - $pristine: boolean; - $dirty: boolean; - $valid: boolean; - $invalid: boolean; - $error: any; - $addControl(control: ng.INgModelController): void; - $removeControl(control: ng.INgModelController): void; - $setValidity(validationErrorKey: string, isValid: boolean, control: ng.INgModelController): void; - $setDirty(): void; - $setPristine(): void; - } - - /////////////////////////////////////////////////////////////////////////// - // NgModelController - // see http://docs.angularjs.org/api/ng.directive:ngModel.NgModelController - /////////////////////////////////////////////////////////////////////////// - interface INgModelController { - $render(): void; - $setValidity(validationErrorKey: string, isValid: boolean): void; - // Documentation states viewValue and modelValue to be a string but other - // types do work and it's common to use them. - $setViewValue(value: any): void; - $viewValue: any; - - $modelValue: any; - - $parsers: IModelParser[]; - $formatters: IModelFormatter[]; - $viewChangeListeners: IModelViewChangeListener[]; - $error: any; - $pristine: boolean; - $dirty: boolean; - $valid: boolean; - $invalid: boolean; - } - - interface IModelParser { - (value: any): any; - } - - interface IModelFormatter { - (value: any): any; - } - - interface IModelViewChangeListener { - (): void; - } - - /////////////////////////////////////////////////////////////////////////// - // Scope and RootScope - // see https://docs.angularjs.org/api/ng/type/$rootScope.Scope and http://docs.angularjs.org/api/ng.$rootScope - /////////////////////////////////////////////////////////////////////////// - interface IRootScopeService { - $apply(): any; - $apply(exp: string): any; - $apply(exp: (scope: IScope) => any): any; - - $broadcast(name: string, ...args: any[]): IAngularEvent; - $destroy(): void; - $digest(): void; - $emit(name: string, ...args: any[]): IAngularEvent; - - // Documentation says exp is optional, but actual implementaton counts on it - $eval(expression: string, args?: Object): any; - $eval(expression: (scope: IScope) => any, args?: Object): any; - - // Documentation says exp is optional, but actual implementaton counts on it - $evalAsync(expression: string): void; - $evalAsync(expression: (scope: IScope) => any): void; - - // Defaults to false by the implementation checking strategy - $new(isolate?: boolean): IScope; - - $on(name: string, listener: (event: IAngularEvent, ...args: any[]) => any): Function; - - $watch(watchExpression: string, listener?: string, objectEquality?: boolean): Function; - $watch(watchExpression: string, listener?: (newValue: any, oldValue: any, scope: IScope) => any, objectEquality?: boolean): Function; - $watch(watchExpression: (scope: IScope) => any, listener?: string, objectEquality?: boolean): Function; - $watch(watchExpression: (scope: IScope) => any, listener?: (newValue: any, oldValue: any, scope: IScope) => any, objectEquality?: boolean): Function; - - $watchCollection(watchExpression: string, listener: (newValue: any, oldValue: any, scope: IScope) => any): Function; - $watchCollection(watchExpression: (scope: IScope) => any, listener: (newValue: any, oldValue: any, scope: IScope) => any): Function; - - $watchGroup(watchExpressions: any[], listener: (newValue: any, oldValue: any, scope: IScope) => any): Function; - $watchGroup(watchExpressions: {(scope: IScope) : any}[], listener: (newValue: any, oldValue: any, scope: IScope) => any): Function; - - $parent: IScope; - - $root: IRootScopeService; - this: IRootScopeService; - - $id: string; - - // Hidden members - $$isolateBindings: any; - $$phase: any; - } - - interface IScope extends IRootScopeService { - [index: string]: any; - } - - interface IAngularEvent { - targetScope: IScope; - currentScope: IScope; - name: string; - preventDefault: Function; - defaultPrevented: boolean; - - // Available only events that were $emit-ted - stopPropagation?: Function; - } - - /////////////////////////////////////////////////////////////////////////// - // WindowService - // see http://docs.angularjs.org/api/ng.$window - /////////////////////////////////////////////////////////////////////////// - interface IWindowService extends Window { - [key: string]: any; - } - - /////////////////////////////////////////////////////////////////////////// - // BrowserService - // TODO undocumented, so we need to get it from the source code - /////////////////////////////////////////////////////////////////////////// - interface IBrowserService { - [key: string]: any; - } - - /////////////////////////////////////////////////////////////////////////// - // TimeoutService - // see http://docs.angularjs.org/api/ng.$timeout - /////////////////////////////////////////////////////////////////////////// - interface ITimeoutService { - (func: Function, delay?: number, invokeApply?: boolean): IPromise; - cancel(promise: IPromise): boolean; - } - - /////////////////////////////////////////////////////////////////////////// - // IntervalService - // see http://docs.angularjs.org/api/ng.$interval - /////////////////////////////////////////////////////////////////////////// - interface IIntervalService { - (func: Function, delay: number, count?: number, invokeApply?: boolean): IPromise; - cancel(promise: IPromise): boolean; - } - - /** - * The animation object which contains callback functions for each event that is expected to be animated. - */ - interface IAnimateCallbackObject { - eventFn(element: Node, doneFn: () => void): Function; - } - - /////////////////////////////////////////////////////////////////////////// - // FilterService - // see http://docs.angularjs.org/api/ng.$filter - // see http://docs.angularjs.org/api/ng.$filterProvider - /////////////////////////////////////////////////////////////////////////// - interface IFilterService { - (name: string): Function; - } - - interface IFilterProvider extends IServiceProvider { - register(name: string, filterFactory: Function): IServiceProvider; - } - - /////////////////////////////////////////////////////////////////////////// - // LocaleService - // see http://docs.angularjs.org/api/ng.$locale - /////////////////////////////////////////////////////////////////////////// - interface ILocaleService { - id: string; - - // These are not documented - // Check angular's i18n files for exemples - NUMBER_FORMATS: ILocaleNumberFormatDescriptor; - DATETIME_FORMATS: ILocaleDateTimeFormatDescriptor; - pluralCat: (num: any) => string; - } - - interface ILocaleNumberFormatDescriptor { - DECIMAL_SEP: string; - GROUP_SEP: string; - PATTERNS: ILocaleNumberPatternDescriptor[]; - CURRENCY_SYM: string; - } - - interface ILocaleNumberPatternDescriptor { - minInt: number; - minFrac: number; - maxFrac: number; - posPre: string; - posSuf: string; - negPre: string; - negSuf: string; - gSize: number; - lgSize: number; - } - - interface ILocaleDateTimeFormatDescriptor { - MONTH: string[]; - SHORTMONTH: string[]; - DAY: string[]; - SHORTDAY: string[]; - AMPMS: string[]; - medium: string; - short: string; - fullDate: string; - longDate: string; - mediumDate: string; - shortDate: string; - mediumTime: string; - shortTime: string; - } - - /////////////////////////////////////////////////////////////////////////// - // LogService - // see http://docs.angularjs.org/api/ng.$log - // see http://docs.angularjs.org/api/ng.$logProvider - /////////////////////////////////////////////////////////////////////////// - interface ILogService { - debug: ILogCall; - error: ILogCall; - info: ILogCall; - log: ILogCall; - warn: ILogCall; - } - - interface ILogProvider { - debugEnabled(enabled: boolean): ILogProvider; - debugEnabled(): boolean; - } - - // We define this as separete interface so we can reopen it later for - // the ngMock module. - interface ILogCall { - (...args: any[]): void; - } - - /////////////////////////////////////////////////////////////////////////// - // ParseService - // see http://docs.angularjs.org/api/ng.$parse - // see http://docs.angularjs.org/api/ng.$parseProvider - /////////////////////////////////////////////////////////////////////////// - interface IParseService { - (expression: string): ICompiledExpression; - } - - interface IParseProvider { - logPromiseWarnings(): boolean; - logPromiseWarnings(value: boolean): IParseProvider; - - unwrapPromises(): boolean; - unwrapPromises(value: boolean): IParseProvider; - } - - interface ICompiledExpression { - (context: any, locals?: any): any; - - // If value is not provided, undefined is gonna be used since the implementation - // does not check the parameter. Let's force a value for consistency. If consumer - // whants to undefine it, pass the undefined value explicitly. - assign(context: any, value: any): any; - } - - /////////////////////////////////////////////////////////////////////////// - // LocationService - // see http://docs.angularjs.org/api/ng.$location - // see http://docs.angularjs.org/api/ng.$locationProvider - // see http://docs.angularjs.org/guide/dev_guide.services.$location - /////////////////////////////////////////////////////////////////////////// - interface ILocationService { - absUrl(): string; - hash(): string; - hash(newHash: string): ILocationService; - host(): string; - path(): string; - path(newPath: string): ILocationService; - port(): number; - protocol(): string; - replace(): ILocationService; - search(): any; - search(parametersMap: any): ILocationService; - search(parameter: string, parameterValue: any): ILocationService; - url(): string; - url(url: string): ILocationService; - } - - interface ILocationProvider extends IServiceProvider { - hashPrefix(): string; - hashPrefix(prefix: string): ILocationProvider; - html5Mode(): boolean; - - // Documentation states that parameter is string, but - // implementation tests it as boolean, which makes more sense - // since this is a toggler - html5Mode(active: boolean): ILocationProvider; - } - - /////////////////////////////////////////////////////////////////////////// - // DocumentService - // see http://docs.angularjs.org/api/ng.$document - /////////////////////////////////////////////////////////////////////////// - interface IDocumentService extends IAugmentedJQuery {} - - /////////////////////////////////////////////////////////////////////////// - // ExceptionHandlerService - // see http://docs.angularjs.org/api/ng.$exceptionHandler - /////////////////////////////////////////////////////////////////////////// - interface IExceptionHandlerService { - (exception: Error, cause?: string): void; - } - - /////////////////////////////////////////////////////////////////////////// - // RootElementService - // see http://docs.angularjs.org/api/ng.$rootElement - /////////////////////////////////////////////////////////////////////////// - interface IRootElementService extends JQuery {} - - /** - * $q - service in module ng - * A promise/deferred implementation inspired by Kris Kowal's Q. - * See http://docs.angularjs.org/api/ng/service/$q - */ - interface IQService { - /** - * Combines multiple promises into a single promise that is resolved when all of the input promises are resolved. - * - * Returns a single promise that will be resolved with an array/hash of values, each value corresponding to the promise at the same index/key in the promises array/hash. If any of the promises is resolved with a rejection, this resulting promise will be rejected with the same rejection value. - * - * @param promises An array or hash of promises. - */ - all(promises: IPromise[]): IPromise; - /** - * Combines multiple promises into a single promise that is resolved when all of the input promises are resolved. - * - * Returns a single promise that will be resolved with an array/hash of values, each value corresponding to the promise at the same index/key in the promises array/hash. If any of the promises is resolved with a rejection, this resulting promise will be rejected with the same rejection value. - * - * @param promises An array or hash of promises. - */ - all(promises: { [id: string]: IPromise; }): IPromise<{ [id: string]: any }>; - /** - * Creates a Deferred object which represents a task which will finish in the future. - */ - defer(): IDeferred; - /** - * Creates a promise that is resolved as rejected with the specified reason. This api should be used to forward rejection in a chain of promises. If you are dealing with the last promise in a promise chain, you don't need to worry about it. - * - * When comparing deferreds/promises to the familiar behavior of try/catch/throw, think of reject as the throw keyword in JavaScript. This also means that if you "catch" an error via a promise error callback and you want to forward the error to the promise derived from the current promise, you have to "rethrow" the error by returning a rejection constructed via reject. - * - * @param reason Constant, message, exception or an object representing the rejection reason. - */ - reject(reason?: any): IPromise; - /** - * Wraps an object that might be a value or a (3rd party) then-able promise into a $q promise. This is useful when you are dealing with an object that might or might not be a promise, or if the promise comes from a source that can't be trusted. - * - * @param value Value or a promise - */ - when(value: IPromise): IPromise; - /** - * Wraps an object that might be a value or a (3rd party) then-able promise into a $q promise. This is useful when you are dealing with an object that might or might not be a promise, or if the promise comes from a source that can't be trusted. - * - * @param value Value or a promise - */ - when(value: T): IPromise; - /** - * Wraps an object that might be a value or a (3rd party) then-able promise into a $q promise. This is useful when you are dealing with an object that might or might not be a promise, or if the promise comes from a source that can't be trusted. - * - * @param value Value or a promise - */ - when(): IPromise; - } - - interface IPromise { - then(successCallback: (promiseValue: T) => IHttpPromise, errorCallback?: (reason: any) => any, notifyCallback?: (state: any) => any): IPromise; - then(successCallback: (promiseValue: T) => IPromise, errorCallback?: (reason: any) => any, notifyCallback?: (state: any) => any): IPromise; - then(successCallback: (promiseValue: T) => TResult, errorCallback?: (reason: any) => TResult, notifyCallback?: (state: any) => any): IPromise; - - - catch(onRejected: (reason: any) => IHttpPromise): IPromise; - catch(onRejected: (reason: any) => IPromise): IPromise; - catch(onRejected: (reason: any) => TResult): IPromise; - - finally(finallyCallback: ()=>any):IPromise; - } - - interface IDeferred { - resolve(value?: T): void; - reject(reason?: any): void; - notify(state?:any): void; - promise: IPromise; - } - - /////////////////////////////////////////////////////////////////////////// - // AnchorScrollService - // see http://docs.angularjs.org/api/ng.$anchorScroll - /////////////////////////////////////////////////////////////////////////// - interface IAnchorScrollService { - (): void; - } - - interface IAnchorScrollProvider extends IServiceProvider { - disableAutoScrolling(): void; - } - - /////////////////////////////////////////////////////////////////////////// - // CacheFactoryService - // see http://docs.angularjs.org/api/ng.$cacheFactory - /////////////////////////////////////////////////////////////////////////// - interface ICacheFactoryService { - // Lets not foce the optionsMap to have the capacity member. Even though - // it's the ONLY option considered by the implementation today, a consumer - // might find it useful to associate some other options to the cache object. - //(cacheId: string, optionsMap?: { capacity: number; }): CacheObject; - (cacheId: string, optionsMap?: { capacity: number; }): ICacheObject; - - // Methods bellow are not documented - info(): any; - get (cacheId: string): ICacheObject; - } - - interface ICacheObject { - info(): { - id: string; - size: number; - - // Not garanteed to have, since it's a non-mandatory option - //capacity: number; - }; - put(key: string, value?: any): void; - get (key: string): any; - remove(key: string): void; - removeAll(): void; - destroy(): void; - } - - /////////////////////////////////////////////////////////////////////////// - // CompileService - // see http://docs.angularjs.org/api/ng.$compile - // see http://docs.angularjs.org/api/ng.$compileProvider - /////////////////////////////////////////////////////////////////////////// - interface ICompileService { - (element: string, transclude?: ITranscludeFunction, maxPriority?: number): ITemplateLinkingFunction; - (element: Element, transclude?: ITranscludeFunction, maxPriority?: number): ITemplateLinkingFunction; - (element: JQuery, transclude?: ITranscludeFunction, maxPriority?: number): ITemplateLinkingFunction; - } - - interface ICompileProvider extends IServiceProvider { - directive(name: string, directiveFactory: Function): ICompileProvider; - - // Undocumented, but it is there... - directive(directivesMap: any): ICompileProvider; - - aHrefSanitizationWhitelist(): RegExp; - aHrefSanitizationWhitelist(regexp: RegExp): ICompileProvider; - - imgSrcSanitizationWhitelist(): RegExp; - imgSrcSanitizationWhitelist(regexp: RegExp): ICompileProvider; - } - - interface ICloneAttachFunction { - // Let's hint but not force cloneAttachFn's signature - (clonedElement?: JQuery, scope?: IScope): any; - } - - // This corresponds to the "publicLinkFn" returned by $compile. - interface ITemplateLinkingFunction { - (scope: IScope, cloneAttachFn?: ICloneAttachFunction): IAugmentedJQuery; - } - - // This corresponds to $transclude (and also the transclude function passed to link). - interface ITranscludeFunction { - // If the scope is provided, then the cloneAttachFn must be as well. - (scope: IScope, cloneAttachFn: ICloneAttachFunction): IAugmentedJQuery; - // If one argument is provided, then it's assumed to be the cloneAttachFn. - (cloneAttachFn?: ICloneAttachFunction): IAugmentedJQuery; - } - - /////////////////////////////////////////////////////////////////////////// - // ControllerService - // see http://docs.angularjs.org/api/ng.$controller - // see http://docs.angularjs.org/api/ng.$controllerProvider - /////////////////////////////////////////////////////////////////////////// - interface IControllerService { - // Although the documentation doesn't state this, locals are optional - (controllerConstructor: Function, locals?: any): any; - (controllerName: string, locals?: any): any; - } - - interface IControllerProvider extends IServiceProvider { - register(name: string, controllerConstructor: Function): void; - register(name: string, dependencyAnnotatedConstructor: any[]): void; - } - - /** - * HttpService - * see http://docs.angularjs.org/api/ng/service/$http - */ - interface IHttpService { - /** - * Object describing the request to be made and how it should be processed. - */ - (config: IRequestConfig): IHttpPromise; - - /** - * Shortcut method to perform GET request. - * - * @param url Relative or absolute URL specifying the destination of the request - * @param config Optional configuration object - */ - get(url: string, config?: IRequestShortcutConfig): IHttpPromise; - - /** - * Shortcut method to perform DELETE request. - * - * @param url Relative or absolute URL specifying the destination of the request - * @param config Optional configuration object - */ - delete(url: string, config?: IRequestShortcutConfig): IHttpPromise; - - /** - * Shortcut method to perform HEAD request. - * - * @param url Relative or absolute URL specifying the destination of the request - * @param config Optional configuration object - */ - head(url: string, config?: IRequestShortcutConfig): IHttpPromise; - - /** - * Shortcut method to perform JSONP request. - * - * @param url Relative or absolute URL specifying the destination of the request - * @param config Optional configuration object - */ - jsonp(url: string, config?: IRequestShortcutConfig): IHttpPromise; - - /** - * Shortcut method to perform POST request. - * - * @param url Relative or absolute URL specifying the destination of the request - * @param data Request content - * @param config Optional configuration object - */ - post(url: string, data: any, config?: IRequestShortcutConfig): IHttpPromise; - - /** - * Shortcut method to perform PUT request. - * - * @param url Relative or absolute URL specifying the destination of the request - * @param data Request content - * @param config Optional configuration object - */ - put(url: string, data: any, config?: IRequestShortcutConfig): IHttpPromise; - - /** - * Runtime equivalent of the $httpProvider.defaults property. Allows configuration of default headers, withCredentials as well as request and response transformations. - */ - defaults: IRequestConfig; - - /** - * Array of config objects for currently pending requests. This is primarily meant to be used for debugging purposes. - */ - pendingRequests: any[]; - } - - /** - * Object describing the request to be made and how it should be processed. - * see http://docs.angularjs.org/api/ng/service/$http#usage - */ - interface IRequestShortcutConfig { - /** - * {Object.} - * Map of strings or objects which will be turned to ?key1=value1&key2=value2 after the url. If the value is not a string, it will be JSONified. - */ - params?: any; - - /** - * Map of strings or functions which return strings representing HTTP headers to send to the server. If the return value of a function is null, the header will not be sent. - */ - headers?: any; - - /** - * Name of HTTP header to populate with the XSRF token. - */ - xsrfHeaderName?: string; - - /** - * Name of cookie containing the XSRF token. - */ - xsrfCookieName?: string; - - /** - * {boolean|Cache} - * If true, a default $http cache will be used to cache the GET request, otherwise if a cache instance built with $cacheFactory, this cache will be used for caching. - */ - cache?: any; - - /** - * whether to to set the withCredentials flag on the XHR object. See [requests with credentials]https://developer.mozilla.org/en/http_access_control#section_5 for more information. - */ - withCredentials?: boolean; - - /** - * {string|Object} - * Data to be sent as the request message data. - */ - data?: any; - - /** - * {function(data, headersGetter)|Array.} - * Transform function or an array of such functions. The transform function takes the http request body and headers and returns its transformed (typically serialized) version. - */ - transformRequest?: any; - - /** - * {function(data, headersGetter)|Array.} - * Transform function or an array of such functions. The transform function takes the http response body and headers and returns its transformed (typically deserialized) version. - */ - transformResponse?: any; - - /** - * {number|Promise} - * Timeout in milliseconds, or promise that should abort the request when resolved. - */ - timeout?: any; - - /** - * See requestType. - */ - responseType?: string; - } - - /** - * Object describing the request to be made and how it should be processed. - * see http://docs.angularjs.org/api/ng/service/$http#usage - */ - interface IRequestConfig extends IRequestShortcutConfig { - /** - * HTTP method (e.g. 'GET', 'POST', etc) - */ - method: string; - /** - * Absolute or relative URL of the resource that is being requested. - */ - url: string; - } - - interface IHttpPromiseCallback { - (data: T, status: number, headers: (headerName: string) => string, config: IRequestConfig): void; - } - - interface IHttpPromiseCallbackArg { - data?: T; - status?: number; - headers?: (headerName: string) => string; - config?: IRequestConfig; - statusText?: string; - } - - interface IHttpPromise extends IPromise { - success(callback: IHttpPromiseCallback): IHttpPromise; - error(callback: IHttpPromiseCallback): IHttpPromise; - then(successCallback: (response: IHttpPromiseCallbackArg) => IPromise, errorCallback?: (response: IHttpPromiseCallbackArg) => any): IPromise; - then(successCallback: (response: IHttpPromiseCallbackArg) => TResult, errorCallback?: (response: IHttpPromiseCallbackArg) => any): IPromise; - } - - interface IHttpProvider extends IServiceProvider { - defaults: IRequestConfig; - interceptors: any[]; - responseInterceptors: any[]; - } - - /////////////////////////////////////////////////////////////////////////// - // HttpBackendService - // see http://docs.angularjs.org/api/ng.$httpBackend - // You should never need to use this service directly. - /////////////////////////////////////////////////////////////////////////// - interface IHttpBackendService { - // XXX Perhaps define callback signature in the future - (method: string, url: string, post?: any, callback?: Function, headers?: any, timeout?: number, withCredentials?: boolean): void; - } - - /////////////////////////////////////////////////////////////////////////// - // InterpolateService - // see http://docs.angularjs.org/api/ng.$interpolate - // see http://docs.angularjs.org/api/ng.$interpolateProvider - /////////////////////////////////////////////////////////////////////////// - interface IInterpolateService { - (text: string, mustHaveExpression?: boolean): IInterpolationFunction; - endSymbol(): string; - startSymbol(): string; - } - - interface IInterpolationFunction { - (context: any): string; - } - - interface IInterpolateProvider extends IServiceProvider { - startSymbol(): string; - startSymbol(value: string): IInterpolateProvider; - endSymbol(): string; - endSymbol(value: string): IInterpolateProvider; - } - - /////////////////////////////////////////////////////////////////////////// - // TemplateCacheService - // see http://docs.angularjs.org/api/ng.$templateCache - /////////////////////////////////////////////////////////////////////////// - interface ITemplateCacheService extends ICacheObject {} - - /////////////////////////////////////////////////////////////////////////// - // SCEService - // see http://docs.angularjs.org/api/ng.$sce - /////////////////////////////////////////////////////////////////////////// - interface ISCEService { - getTrusted(type: string, mayBeTrusted: any): any; - getTrustedCss(value: any): any; - getTrustedHtml(value: any): any; - getTrustedJs(value: any): any; - getTrustedResourceUrl(value: any): any; - getTrustedUrl(value: any): any; - parse(type: string, expression: string): (context: any, locals: any) => any; - parseAsCss(expression: string): (context: any, locals: any) => any; - parseAsHtml(expression: string): (context: any, locals: any) => any; - parseAsJs(expression: string): (context: any, locals: any) => any; - parseAsResourceUrl(expression: string): (context: any, locals: any) => any; - parseAsUrl(expression: string): (context: any, locals: any) => any; - trustAs(type: string, value: any): any; - trustAsHtml(value: any): any; - trustAsJs(value: any): any; - trustAsResourceUrl(value: any): any; - trustAsUrl(value: any): any; - isEnabled(): boolean; - } - - /////////////////////////////////////////////////////////////////////////// - // SCEProvider - // see http://docs.angularjs.org/api/ng.$sceProvider - /////////////////////////////////////////////////////////////////////////// - interface ISCEProvider extends IServiceProvider { - enabled(value: boolean): void; - } - - /////////////////////////////////////////////////////////////////////////// - // SCEDelegateService - // see http://docs.angularjs.org/api/ng.$sceDelegate - /////////////////////////////////////////////////////////////////////////// - interface ISCEDelegateService { - getTrusted(type: string, mayBeTrusted: any): any; - trustAs(type: string, value: any): any; - valueOf(value: any): any; - } - - - /////////////////////////////////////////////////////////////////////////// - // SCEDelegateProvider - // see http://docs.angularjs.org/api/ng.$sceDelegateProvider - /////////////////////////////////////////////////////////////////////////// - interface ISCEDelegateProvider extends IServiceProvider { - resourceUrlBlacklist(blacklist: any[]): void; - resourceUrlWhitelist(whitelist: any[]): void; - } - - /////////////////////////////////////////////////////////////////////////// - // Directive - // see http://docs.angularjs.org/api/ng.$compileProvider#directive - // and http://docs.angularjs.org/guide/directive - /////////////////////////////////////////////////////////////////////////// - - interface IDirectiveFactory { - (...args: any[]): IDirective; - } - - interface IDirectiveLinkFn { - ( - scope: IScope, - instanceElement: IAugmentedJQuery, - instanceAttributes: IAttributes, - controller: any, - transclude: ITranscludeFunction - ): void; - } - - interface IDirectivePrePost { - pre?: IDirectiveLinkFn; - post?: IDirectiveLinkFn; - } - - interface IDirectiveCompileFn { - ( - templateElement: IAugmentedJQuery, - templateAttributes: IAttributes, - transclude: ITranscludeFunction - ): IDirectivePrePost; - } - - interface IDirective { - compile?: IDirectiveCompileFn; - controller?: any; - controllerAs?: string; - link?: IDirectiveLinkFn; - name?: string; - priority?: number; - replace?: boolean; - require?: any; - restrict?: string; - scope?: any; - template?: any; - templateUrl?: any; - terminal?: boolean; - transclude?: any; - } - - /////////////////////////////////////////////////////////////////////////// - // angular.element - // when calling angular.element, angular returns a jQuery object, - // augmented with additional methods like e.g. scope. - // see: http://docs.angularjs.org/api/angular.element - /////////////////////////////////////////////////////////////////////////// - interface IAugmentedJQueryStatic extends JQueryStatic { - (selector: string, context?: any): IAugmentedJQuery; - (element: Element): IAugmentedJQuery; - (object: {}): IAugmentedJQuery; - (elementArray: Element[]): IAugmentedJQuery; - (object: JQuery): IAugmentedJQuery; - (func: Function): IAugmentedJQuery; - (array: any[]): IAugmentedJQuery; - (): IAugmentedJQuery; - } - - interface IAugmentedJQuery extends JQuery { - // TODO: events, how to define? - //$destroy - - find(selector: string): IAugmentedJQuery; - find(element: any): IAugmentedJQuery; - find(obj: JQuery): IAugmentedJQuery; - - controller(name: string): any; - injector(): any; - scope(): IScope; - isolateScope(): IScope; - - inheritedData(key: string, value: any): JQuery; - inheritedData(obj: { [key: string]: any; }): JQuery; - inheritedData(key?: string): any; - } - - /////////////////////////////////////////////////////////////////////// - // AnimateService - // see http://docs.angularjs.org/api/ng.$animate - /////////////////////////////////////////////////////////////////////// - interface IAnimateService { - addClass(element: JQuery, className: string, done?: Function): void; - enter(element: JQuery, parent: JQuery, after: JQuery, done?: Function): void; - leave(element: JQuery, done?: Function): void; - move(element: JQuery, parent: JQuery, after: JQuery, done?: Function): void; - removeClass(element: JQuery, className: string, done?: Function): void; - } - - /////////////////////////////////////////////////////////////////////////// - // AUTO module (angular.js) - /////////////////////////////////////////////////////////////////////////// - export module auto { - - /////////////////////////////////////////////////////////////////////// - // InjectorService - // see http://docs.angularjs.org/api/AUTO.$injector - /////////////////////////////////////////////////////////////////////// - interface IInjectorService { - annotate(fn: Function): string[]; - annotate(inlineAnnotatedFunction: any[]): string[]; - get(name: string): any; - has(name: string): boolean; - instantiate(typeConstructor: Function, locals?: any): any; - invoke(inlineAnnotatedFunction: any[]): any; - invoke(func: Function, context?: any, locals?: any): any; - } - - /////////////////////////////////////////////////////////////////////// - // ProvideService - // see http://docs.angularjs.org/api/AUTO.$provide - /////////////////////////////////////////////////////////////////////// - interface IProvideService { - // Documentation says it returns the registered instance, but actual - // implementation does not return anything. - // constant(name: string, value: any): any; - /** - * Register a constant service, such as a string, a number, an array, an object or a function, with the $injector. Unlike value it can be injected into a module configuration function (see config) and it cannot be overridden by an Angular decorator. - * - * @param name The name of the constant. - * @param value The constant value. - */ - constant(name: string, value: any): void; - - /** - * Register a service decorator with the $injector. A service decorator intercepts the creation of a service, allowing it to override or modify the behaviour of the service. The object returned by the decorator may be the original service, or a new service object which replaces or wraps and delegates to the original service. - * - * @param name The name of the service to decorate. - * @param decorator This function will be invoked when the service needs to be instantiated and should return the decorated service instance. The function is called using the injector.invoke method and is therefore fully injectable. Local injection arguments: - * - * $delegate - The original service instance, which can be monkey patched, configured, decorated or delegated to. - */ - decorator(name: string, decorator: Function): void; - /** - * Register a service decorator with the $injector. A service decorator intercepts the creation of a service, allowing it to override or modify the behaviour of the service. The object returned by the decorator may be the original service, or a new service object which replaces or wraps and delegates to the original service. - * - * @param name The name of the service to decorate. - * @param inlineAnnotatedFunction This function will be invoked when the service needs to be instantiated and should return the decorated service instance. The function is called using the injector.invoke method and is therefore fully injectable. Local injection arguments: - * - * $delegate - The original service instance, which can be monkey patched, configured, decorated or delegated to. - */ - decorator(name: string, inlineAnnotatedFunction: any[]): void; - factory(name: string, serviceFactoryFunction: Function): ng.IServiceProvider; - factory(name: string, inlineAnnotatedFunction: any[]): ng.IServiceProvider; - provider(name: string, provider: ng.IServiceProvider): ng.IServiceProvider; - provider(name: string, serviceProviderConstructor: Function): ng.IServiceProvider; - service(name: string, constructor: Function): ng.IServiceProvider; - value(name: string, value: any): ng.IServiceProvider; - } - - } -} diff --git a/angular/legacy/angular-1.4.d.ts b/angular/legacy/angular-1.4.d.ts deleted file mode 100644 index 61f4edad02..0000000000 --- a/angular/legacy/angular-1.4.d.ts +++ /dev/null @@ -1,1877 +0,0 @@ -// Type definitions for Angular JS 1.4+ -// Project: http://angularjs.org -// Definitions by: Diego Vilar -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - - -/// - -declare var angular: angular.IAngularStatic; - -// Support for painless dependency injection -interface Function { - $inject?: string[]; -} - -// Collapse angular into ng -import ng = angular; -// Support AMD require -declare module 'angular' { - export = angular; -} - -/////////////////////////////////////////////////////////////////////////////// -// ng module (angular.js) -/////////////////////////////////////////////////////////////////////////////// -declare namespace angular { - - // not directly implemented, but ensures that constructed class implements $get - interface IServiceProviderClass { - new (...args: any[]): IServiceProvider; - } - - interface IServiceProviderFactory { - (...args: any[]): IServiceProvider; - } - - // All service providers extend this interface - interface IServiceProvider { - $get: any; - } - - interface IAngularBootstrapConfig { - strictDi?: boolean; - debugInfoEnabled?: boolean; - } - - /////////////////////////////////////////////////////////////////////////// - // AngularStatic - // see http://docs.angularjs.org/api - /////////////////////////////////////////////////////////////////////////// - interface IAngularStatic { - bind(context: any, fn: Function, ...args: any[]): Function; - - /** - * Use this function to manually start up angular application. - * - * @param element DOM element which is the root of angular application. - * @param modules An array of modules to load into the application. - * Each item in the array should be the name of a predefined module or a (DI annotated) - * function that will be invoked by the injector as a config block. - * @param config an object for defining configuration options for the application. The following keys are supported: - * - `strictDi`: disable automatic function annotation for the application. This is meant to assist in finding bugs which break minified code. - */ - bootstrap(element: string|Element|JQuery|Document, modules?: (string|Function|any[])[], config?: IAngularBootstrapConfig): auto.IInjectorService; - - /** - * Creates a deep copy of source, which should be an object or an array. - * - * - If no destination is supplied, a copy of the object or array is created. - * - If a destination is provided, all of its elements (for array) or properties (for objects) are deleted and then all elements/properties from the source are copied to it. - * - If source is not an object or array (inc. null and undefined), source is returned. - * - If source is identical to 'destination' an exception will be thrown. - * - * @param source The source that will be used to make a copy. Can be any type, including primitives, null, and undefined. - * @param destination Destination into which the source is copied. If provided, must be of the same type as source. - */ - copy(source: T, destination?: T): T; - - /** - * Wraps a raw DOM element or HTML string as a jQuery element. - * - * If jQuery is available, angular.element is an alias for the jQuery function. If jQuery is not available, angular.element delegates to Angular's built-in subset of jQuery, called "jQuery lite" or "jqLite." - */ - element: IAugmentedJQueryStatic; - equals(value1: any, value2: any): boolean; - extend(destination: any, ...sources: any[]): any; - - /** - * Invokes the iterator function once for each item in obj collection, which can be either an object or an array. The iterator function is invoked with iterator(value, key), where value is the value of an object property or an array element and key is the object property key or array element index. Specifying a context for the function is optional. - * - * It is worth noting that .forEach does not iterate over inherited properties because it filters using the hasOwnProperty method. - * - * @param obj Object to iterate over. - * @param iterator Iterator function. - * @param context Object to become context (this) for the iterator function. - */ - forEach(obj: T[], iterator: (value: T, key: number) => any, context?: any): any; - /** - * Invokes the iterator function once for each item in obj collection, which can be either an object or an array. The iterator function is invoked with iterator(value, key), where value is the value of an object property or an array element and key is the object property key or array element index. Specifying a context for the function is optional. - * - * It is worth noting that .forEach does not iterate over inherited properties because it filters using the hasOwnProperty method. - * - * @param obj Object to iterate over. - * @param iterator Iterator function. - * @param context Object to become context (this) for the iterator function. - */ - forEach(obj: { [index: string]: T; }, iterator: (value: T, key: string) => any, context?: any): any; - /** - * Invokes the iterator function once for each item in obj collection, which can be either an object or an array. The iterator function is invoked with iterator(value, key), where value is the value of an object property or an array element and key is the object property key or array element index. Specifying a context for the function is optional. - * - * It is worth noting that .forEach does not iterate over inherited properties because it filters using the hasOwnProperty method. - * - * @param obj Object to iterate over. - * @param iterator Iterator function. - * @param context Object to become context (this) for the iterator function. - */ - forEach(obj: any, iterator: (value: any, key: any) => any, context?: any): any; - - fromJson(json: string): any; - identity(arg?: T): T; - injector(modules?: any[], strictDi?: boolean): auto.IInjectorService; - isArray(value: any): boolean; - isDate(value: any): boolean; - isDefined(value: any): boolean; - isElement(value: any): boolean; - isFunction(value: any): boolean; - isNumber(value: any): boolean; - isObject(value: any): boolean; - isString(value: any): boolean; - isUndefined(value: any): boolean; - lowercase(str: string): string; - - /** - * Deeply extends the destination object dst by copying own enumerable properties from the src object(s) to dst. You can specify multiple src objects. If you want to preserve original objects, you can do so by passing an empty object as the target: var object = angular.merge({}, object1, object2). - * - * Unlike extend(), merge() recursively descends into object properties of source objects, performing a deep copy. - * - * @param dst Destination object. - * @param src Source object(s). - */ - merge(dst: any, ...src: any[]): any; - - /** - * The angular.module is a global place for creating, registering and retrieving Angular modules. All modules (angular core or 3rd party) that should be available to an application must be registered using this mechanism. - * - * When passed two or more arguments, a new module is created. If passed only one argument, an existing module (the name passed as the first argument to module) is retrieved. - * - * @param name The name of the module to create or retrieve. - * @param requires The names of modules this module depends on. If specified then new module is being created. If unspecified then the module is being retrieved for further configuration. - * @param configFn Optional configuration function for the module. - */ - module( - name: string, - requires?: string[], - configFn?: Function): IModule; - - noop(...args: any[]): void; - reloadWithDebugInfo(): void; - toJson(obj: any, pretty?: boolean): string; - uppercase(str: string): string; - version: { - full: string; - major: number; - minor: number; - dot: number; - codeName: string; - }; - - /** - * If window.name contains prefix NG_DEFER_BOOTSTRAP! when angular.bootstrap is called, the bootstrap process will be paused until angular.resumeBootstrap() is called. - * @param extraModules An optional array of modules that should be added to the original list of modules that the app was about to be bootstrapped with. - */ - resumeBootstrap?(extraModules?: string[]): ng.auto.IInjectorService; - } - - /////////////////////////////////////////////////////////////////////////// - // Module - // see http://docs.angularjs.org/api/angular.Module - /////////////////////////////////////////////////////////////////////////// - interface IModule { - animation(name: string, animationFactory: Function): IModule; - animation(name: string, inlineAnnotatedFunction: any[]): IModule; - animation(object: Object): IModule; - /** - * Use this method to register a component. - * - * @param name The name of the component. - * @param options A definition object passed into the component. - */ - component(name: string, options: IComponentOptions): IModule; - /** - * Use this method to register work which needs to be performed on module loading. - * - * @param configFn Execute this function on module load. Useful for service configuration. - */ - config(configFn: Function): IModule; - /** - * Use this method to register work which needs to be performed on module loading. - * - * @param inlineAnnotatedFunction Execute this function on module load. Useful for service configuration. - */ - config(inlineAnnotatedFunction: any[]): IModule; - config(object: Object): IModule; - /** - * Register a constant service, such as a string, a number, an array, an object or a function, with the $injector. Unlike value it can be injected into a module configuration function (see config) and it cannot be overridden by an Angular decorator. - * - * @param name The name of the constant. - * @param value The constant value. - */ - constant(name: string, value: any): IModule; - constant(object: Object): IModule; - /** - * The $controller service is used by Angular to create new controllers. - * - * This provider allows controller registration via the register method. - * - * @param name Controller name, or an object map of controllers where the keys are the names and the values are the constructors. - * @param controllerConstructor Controller constructor fn (optionally decorated with DI annotations in the array notation). - */ - controller(name: string, controllerConstructor: Function): IModule; - /** - * The $controller service is used by Angular to create new controllers. - * - * This provider allows controller registration via the register method. - * - * @param name Controller name, or an object map of controllers where the keys are the names and the values are the constructors. - * @param controllerConstructor Controller constructor fn (optionally decorated with DI annotations in the array notation). - */ - controller(name: string, inlineAnnotatedConstructor: any[]): IModule; - controller(object: Object): IModule; - /** - * Register a new directive with the compiler. - * - * @param name Name of the directive in camel-case (i.e. ngBind which will match as ng-bind) - * @param directiveFactory An injectable directive factory function. - */ - directive(name: string, directiveFactory: IDirectiveFactory): IModule; - /** - * Register a new directive with the compiler. - * - * @param name Name of the directive in camel-case (i.e. ngBind which will match as ng-bind) - * @param directiveFactory An injectable directive factory function. - */ - directive(name: string, inlineAnnotatedFunction: any[]): IModule; - directive(object: Object): IModule; - /** - * Register a service factory, which will be called to return the service instance. This is short for registering a service where its provider consists of only a $get property, which is the given service factory function. You should use $provide.factory(getFn) if you do not need to configure your service in a provider. - * - * @param name The name of the instance. - * @param $getFn The $getFn for the instance creation. Internally this is a short hand for $provide.provider(name, {$get: $getFn}). - */ - factory(name: string, $getFn: Function): IModule; - /** - * Register a service factory, which will be called to return the service instance. This is short for registering a service where its provider consists of only a $get property, which is the given service factory function. You should use $provide.factory(getFn) if you do not need to configure your service in a provider. - * - * @param name The name of the instance. - * @param inlineAnnotatedFunction The $getFn for the instance creation. Internally this is a short hand for $provide.provider(name, {$get: $getFn}). - */ - factory(name: string, inlineAnnotatedFunction: any[]): IModule; - factory(object: Object): IModule; - filter(name: string, filterFactoryFunction: Function): IModule; - filter(name: string, inlineAnnotatedFunction: any[]): IModule; - filter(object: Object): IModule; - provider(name: string, serviceProviderFactory: IServiceProviderFactory): IModule; - provider(name: string, serviceProviderConstructor: IServiceProviderClass): IModule; - provider(name: string, inlineAnnotatedConstructor: any[]): IModule; - provider(name: string, providerObject: IServiceProvider): IModule; - provider(object: Object): IModule; - /** - * Run blocks are the closest thing in Angular to the main method. A run block is the code which needs to run to kickstart the application. It is executed after all of the service have been configured and the injector has been created. Run blocks typically contain code which is hard to unit-test, and for this reason should be declared in isolated modules, so that they can be ignored in the unit-tests. - */ - run(initializationFunction: Function): IModule; - /** - * Run blocks are the closest thing in Angular to the main method. A run block is the code which needs to run to kickstart the application. It is executed after all of the service have been configured and the injector has been created. Run blocks typically contain code which is hard to unit-test, and for this reason should be declared in isolated modules, so that they can be ignored in the unit-tests. - */ - run(inlineAnnotatedFunction: any[]): IModule; - service(name: string, serviceConstructor: Function): IModule; - service(name: string, inlineAnnotatedConstructor: any[]): IModule; - service(object: Object): IModule; - /** - * Register a value service with the $injector, such as a string, a number, an array, an object or a function. This is short for registering a service where its provider's $get property is a factory function that takes no arguments and returns the value service. - - Value services are similar to constant services, except that they cannot be injected into a module configuration function (see config) but they can be overridden by an Angular decorator. - * - * @param name The name of the instance. - * @param value The value. - */ - value(name: string, value: any): IModule; - value(object: Object): IModule; - - /** - * Register a service decorator with the $injector. A service decorator intercepts the creation of a service, allowing it to override or modify the behaviour of the service. The object returned by the decorator may be the original service, or a new service object which replaces or wraps and delegates to the original service. - * @param name The name of the service to decorate - * @param decorator This function will be invoked when the service needs to be instantiated and should return the decorated service instance. The function is called using the injector.invoke method and is therefore fully injectable. Local injection arguments: $delegate - The original service instance, which can be monkey patched, configured, decorated or delegated to. - */ - decorator(name:string, decoratorConstructor: Function): IModule; - decorator(name:string, inlineAnnotatedConstructor: any[]): IModule; - - // Properties - name: string; - requires: string[]; - } - - /////////////////////////////////////////////////////////////////////////// - // Attributes - // see http://docs.angularjs.org/api/ng.$compile.directive.Attributes - /////////////////////////////////////////////////////////////////////////// - interface IAttributes { - /** - * this is necessary to be able to access the scoped attributes. it's not very elegant - * because you have to use attrs['foo'] instead of attrs.foo but I don't know of a better way - * this should really be limited to return string but it creates this problem: http://stackoverflow.com/q/17201854/165656 - */ - [name: string]: any; - - /** - * Converts an attribute name (e.g. dash/colon/underscore-delimited string, optionally prefixed with x- or data-) to its normalized, camelCase form. - * - * Also there is special case for Moz prefix starting with upper case letter. - * - * For further information check out the guide on @see https://docs.angularjs.org/guide/directive#matching-directives - */ - $normalize(name: string): string; - - /** - * Adds the CSS class value specified by the classVal parameter to the - * element. If animations are enabled then an animation will be triggered - * for the class addition. - */ - $addClass(classVal: string): void; - - /** - * Removes the CSS class value specified by the classVal parameter from the - * element. If animations are enabled then an animation will be triggered for - * the class removal. - */ - $removeClass(classVal: string): void; - - /** - * Set DOM element attribute value. - */ - $set(key: string, value: any): void; - - /** - * Observes an interpolated attribute. - * The observer function will be invoked once during the next $digest - * following compilation. The observer is then invoked whenever the - * interpolated value changes. - */ - $observe(name: string, fn: (value?: T) => any): Function; - - /** - * A map of DOM element attribute names to the normalized name. This is needed - * to do reverse lookup from normalized name back to actual name. - */ - $attr: Object; - } - - /** - * form.FormController - type in module ng - * see https://docs.angularjs.org/api/ng/type/form.FormController - */ - interface IFormController { - - /** - * Indexer which should return ng.INgModelController for most properties but cannot because of "All named properties must be assignable to string indexer type" constraint - see https://github.com/Microsoft/TypeScript/issues/272 - */ - [name: string]: any; - - $pristine: boolean; - $dirty: boolean; - $valid: boolean; - $invalid: boolean; - $submitted: boolean; - $error: any; - $addControl(control: INgModelController): void; - $removeControl(control: INgModelController): void; - $setValidity(validationErrorKey: string, isValid: boolean, control: INgModelController): void; - $setDirty(): void; - $setPristine(): void; - $commitViewValue(): void; - $rollbackViewValue(): void; - $setSubmitted(): void; - $setUntouched(): void; - } - - /////////////////////////////////////////////////////////////////////////// - // NgModelController - // see http://docs.angularjs.org/api/ng.directive:ngModel.NgModelController - /////////////////////////////////////////////////////////////////////////// - interface INgModelController { - $render(): void; - $setValidity(validationErrorKey: string, isValid: boolean): void; - // Documentation states viewValue and modelValue to be a string but other - // types do work and it's common to use them. - $setViewValue(value: any, trigger?: string): void; - $setPristine(): void; - $setDirty(): void; - $validate(): void; - $setTouched(): void; - $setUntouched(): void; - $rollbackViewValue(): void; - $commitViewValue(): void; - $isEmpty(value: any): boolean; - - $viewValue: any; - - $modelValue: any; - - $parsers: IModelParser[]; - $formatters: IModelFormatter[]; - $viewChangeListeners: IModelViewChangeListener[]; - $error: any; - $name: string; - - $touched: boolean; - $untouched: boolean; - - $validators: IModelValidators; - $asyncValidators: IAsyncModelValidators; - - $pending: any; - $pristine: boolean; - $dirty: boolean; - $valid: boolean; - $invalid: boolean; - } - - interface IModelValidators { - /** - * viewValue is any because it can be an object that is called in the view like $viewValue.name:$viewValue.subName - */ - [index: string]: (modelValue: any, viewValue: any) => boolean; - } - - interface IAsyncModelValidators { - [index: string]: (modelValue: any, viewValue: any) => IPromise; - } - - interface IModelParser { - (value: any): any; - } - - interface IModelFormatter { - (value: any): any; - } - - interface IModelViewChangeListener { - (): void; - } - - /** - * $rootScope - $rootScopeProvider - service in module ng - * see https://docs.angularjs.org/api/ng/type/$rootScope.Scope and https://docs.angularjs.org/api/ng/service/$rootScope - */ - interface IRootScopeService { - [index: string]: any; - - $apply(): any; - $apply(exp: string): any; - $apply(exp: (scope: IScope) => any): any; - - $applyAsync(): any; - $applyAsync(exp: string): any; - $applyAsync(exp: (scope: IScope) => any): any; - - /** - * Dispatches an event name downwards to all child scopes (and their children) notifying the registered $rootScope.Scope listeners. - * - * The event life cycle starts at the scope on which $broadcast was called. All listeners listening for name event on this scope get notified. Afterwards, the event propagates to all direct and indirect scopes of the current scope and calls all registered listeners along the way. The event cannot be canceled. - * - * Any exception emitted from the listeners will be passed onto the $exceptionHandler service. - * - * @param name Event name to broadcast. - * @param args Optional one or more arguments which will be passed onto the event listeners. - */ - $broadcast(name: string, ...args: any[]): IAngularEvent; - $destroy(): void; - $digest(): void; - /** - * Dispatches an event name upwards through the scope hierarchy notifying the registered $rootScope.Scope listeners. - * - * The event life cycle starts at the scope on which $emit was called. All listeners listening for name event on this scope get notified. Afterwards, the event traverses upwards toward the root scope and calls all registered listeners along the way. The event will stop propagating if one of the listeners cancels it. - * - * Any exception emitted from the listeners will be passed onto the $exceptionHandler service. - * - * @param name Event name to emit. - * @param args Optional one or more arguments which will be passed onto the event listeners. - */ - $emit(name: string, ...args: any[]): IAngularEvent; - - $eval(): any; - $eval(expression: string, locals?: Object): any; - $eval(expression: (scope: IScope) => any, locals?: Object): any; - - $evalAsync(): void; - $evalAsync(expression: string): void; - $evalAsync(expression: (scope: IScope) => any): void; - - // Defaults to false by the implementation checking strategy - $new(isolate?: boolean, parent?: IScope): IScope; - - /** - * Listens on events of a given type. See $emit for discussion of event life cycle. - * - * The event listener function format is: function(event, args...). - * - * @param name Event name to listen on. - * @param listener Function to call when the event is emitted. - */ - $on(name: string, listener: (event: IAngularEvent, ...args: any[]) => any): Function; - - $watch(watchExpression: string, listener?: string, objectEquality?: boolean): Function; - $watch(watchExpression: string, listener?: (newValue: T, oldValue: T, scope: IScope) => any, objectEquality?: boolean): Function; - $watch(watchExpression: (scope: IScope) => any, listener?: string, objectEquality?: boolean): Function; - $watch(watchExpression: (scope: IScope) => T, listener?: (newValue: T, oldValue: T, scope: IScope) => any, objectEquality?: boolean): Function; - - $watchCollection(watchExpression: string, listener: (newValue: T, oldValue: T, scope: IScope) => any): Function; - $watchCollection(watchExpression: (scope: IScope) => T, listener: (newValue: T, oldValue: T, scope: IScope) => any): Function; - - $watchGroup(watchExpressions: any[], listener: (newValue: any, oldValue: any, scope: IScope) => any): Function; - $watchGroup(watchExpressions: { (scope: IScope): any }[], listener: (newValue: any, oldValue: any, scope: IScope) => any): Function; - - $parent: IScope; - $root: IRootScopeService; - $id: number; - - // Hidden members - $$isolateBindings: any; - $$phase: any; - } - - interface IScope extends IRootScopeService { } - - /** - * $scope for ngRepeat directive. - * see https://docs.angularjs.org/api/ng/directive/ngRepeat - */ - interface IRepeatScope extends IScope { - - /** - * iterator offset of the repeated element (0..length-1). - */ - $index: number; - - /** - * true if the repeated element is first in the iterator. - */ - $first: boolean; - - /** - * true if the repeated element is between the first and last in the iterator. - */ - $middle: boolean; - - /** - * true if the repeated element is last in the iterator. - */ - $last: boolean; - - /** - * true if the iterator position $index is even (otherwise false). - */ - $even: boolean; - - /** - * true if the iterator position $index is odd (otherwise false). - */ - $odd: boolean; - - } - - interface IAngularEvent { - /** - * the scope on which the event was $emit-ed or $broadcast-ed. - */ - targetScope: IScope; - /** - * the scope that is currently handling the event. Once the event propagates through the scope hierarchy, this property is set to null. - */ - currentScope: IScope; - /** - * name of the event. - */ - name: string; - /** - * calling stopPropagation function will cancel further event propagation (available only for events that were $emit-ed). - */ - stopPropagation?: Function; - /** - * calling preventDefault sets defaultPrevented flag to true. - */ - preventDefault: Function; - /** - * true if preventDefault was called. - */ - defaultPrevented: boolean; - } - - /////////////////////////////////////////////////////////////////////////// - // WindowService - // see http://docs.angularjs.org/api/ng.$window - /////////////////////////////////////////////////////////////////////////// - interface IWindowService extends Window { - [key: string]: any; - } - - /////////////////////////////////////////////////////////////////////////// - // BrowserService - // TODO undocumented, so we need to get it from the source code - /////////////////////////////////////////////////////////////////////////// - interface IBrowserService { - defer: angular.ITimeoutService; - [key: string]: any; - } - - /////////////////////////////////////////////////////////////////////////// - // TimeoutService - // see http://docs.angularjs.org/api/ng.$timeout - /////////////////////////////////////////////////////////////////////////// - interface ITimeoutService { - (delay?: number, invokeApply?: boolean): IPromise; - (fn: (...args: any[]) => T, delay?: number, invokeApply?: boolean, ...args: any[]): IPromise; - cancel(promise?: IPromise): boolean; - } - - /////////////////////////////////////////////////////////////////////////// - // IntervalService - // see http://docs.angularjs.org/api/ng.$interval - /////////////////////////////////////////////////////////////////////////// - interface IIntervalService { - (func: Function, delay: number, count?: number, invokeApply?: boolean, ...args: any[]): IPromise; - cancel(promise: IPromise): boolean; - } - - /////////////////////////////////////////////////////////////////////////// - // AnimateProvider - // see http://docs.angularjs.org/api/ng/provider/$animateProvider - /////////////////////////////////////////////////////////////////////////// - interface IAnimateProvider { - /** - * Registers a new injectable animation factory function. - * - * @param name The name of the animation. - * @param factory The factory function that will be executed to return the animation object. - */ - register(name: string, factory: () => IAnimateCallbackObject): void; - - /** - * Gets and/or sets the CSS class expression that is checked when performing an animation. - * - * @param expression The className expression which will be checked against all animations. - * @returns The current CSS className expression value. If null then there is no expression value. - */ - classNameFilter(expression?: RegExp): RegExp; - } - - /** - * The animation object which contains callback functions for each event that is expected to be animated. - */ - interface IAnimateCallbackObject { - eventFn(element: Node, doneFn: () => void): Function; - } - - /** - * $filter - $filterProvider - service in module ng - * - * Filters are used for formatting data displayed to the user. - * - * see https://docs.angularjs.org/api/ng/service/$filter - */ - interface IFilterService { - (name: 'filter'): IFilterFilter; - (name: 'currency'): IFilterCurrency; - (name: 'number'): IFilterNumber; - (name: 'date'): IFilterDate; - (name: 'json'): IFilterJson; - (name: 'lowercase'): IFilterLowercase; - (name: 'uppercase'): IFilterUppercase; - (name: 'limitTo'): IFilterLimitTo; - (name: 'orderBy'): IFilterOrderBy; - /** - * Usage: - * $filter(name); - * - * @param name Name of the filter function to retrieve - */ - (name: string): T; - } - - interface IFilterFilter { - (array: T[], expression: string | IFilterFilterPatternObject | IFilterFilterPredicateFunc, comparator?: IFilterFilterComparatorFunc|boolean): T[]; - } - - interface IFilterFilterPatternObject { - [name: string]: any; - } - - interface IFilterFilterPredicateFunc { - (value: T, index: number, array: T[]): boolean; - } - - interface IFilterFilterComparatorFunc { - (actual: T, expected: T): boolean; - } - - interface IFilterCurrency { - /** - * Formats a number as a currency (ie $1,234.56). When no currency symbol is provided, default symbol for current locale is used. - * @param amount Input to filter. - * @param symbol Currency symbol or identifier to be displayed. - * @param fractionSize Number of decimal places to round the amount to, defaults to default max fraction size for current locale - * @return Formatted number - */ - (amount: number, symbol?: string, fractionSize?: number): string; - } - - interface IFilterNumber { - /** - * Formats a number as text. - * @param number Number to format. - * @param fractionSize Number of decimal places to round the number to. If this is not provided then the fraction size is computed from the current locale's number formatting pattern. In the case of the default locale, it will be 3. - * @return Number rounded to decimalPlaces and places a “,” after each third digit. - */ - (value: number|string, fractionSize?: number|string): string; - } - - interface IFilterDate { - /** - * Formats date to a string based on the requested format. - * - * @param date Date to format either as Date object, milliseconds (string or number) or various ISO 8601 datetime string formats (e.g. yyyy-MM-ddTHH:mm:ss.sssZ and its shorter versions like yyyy-MM-ddTHH:mmZ, yyyy-MM-dd or yyyyMMddTHHmmssZ). If no timezone is specified in the string input, the time is considered to be in the local timezone. - * @param format Formatting rules (see Description). If not specified, mediumDate is used. - * @param timezone Timezone to be used for formatting. It understands UTC/GMT and the continental US time zone abbreviations, but for general use, use a time zone offset, for example, '+0430' (4 hours, 30 minutes east of the Greenwich meridian) If not specified, the timezone of the browser will be used. - * @return Formatted string or the input if input is not recognized as date/millis. - */ - (date: Date | number | string, format?: string, timezone?: string): string; - } - - interface IFilterJson { - /** - * Allows you to convert a JavaScript object into JSON string. - * @param object Any JavaScript object (including arrays and primitive types) to filter. - * @param spacing The number of spaces to use per indentation, defaults to 2. - * @return JSON string. - */ - (object: any, spacing?: number): string; - } - - interface IFilterLowercase { - /** - * Converts string to lowercase. - */ - (value: string): string; - } - - interface IFilterUppercase { - /** - * Converts string to uppercase. - */ - (value: string): string; - } - - interface IFilterLimitTo { - /** - * Creates a new array containing only a specified number of elements. The elements are taken from either the beginning or the end of the source array, string or number, as specified by the value and sign (positive or negative) of limit. - * @param input Source array to be limited. - * @param limit The length of the returned array. If the limit number is positive, limit number of items from the beginning of the source array/string are copied. If the number is negative, limit number of items from the end of the source array are copied. The limit will be trimmed if it exceeds array.length. If limit is undefined, the input will be returned unchanged. - * @param begin Index at which to begin limitation. As a negative index, begin indicates an offset from the end of input. Defaults to 0. - * @return A new sub-array of length limit or less if input array had less than limit elements. - */ - (input: T[], limit: string|number, begin?: string|number): T[]; - /** - * Creates a new string containing only a specified number of elements. The elements are taken from either the beginning or the end of the source string or number, as specified by the value and sign (positive or negative) of limit. If a number is used as input, it is converted to a string. - * @param input Source string or number to be limited. - * @param limit The length of the returned string. If the limit number is positive, limit number of items from the beginning of the source string are copied. If the number is negative, limit number of items from the end of the source string are copied. The limit will be trimmed if it exceeds input.length. If limit is undefined, the input will be returned unchanged. - * @param begin Index at which to begin limitation. As a negative index, begin indicates an offset from the end of input. Defaults to 0. - * @return A new substring of length limit or less if input had less than limit elements. - */ - (input: string|number, limit: string|number, begin?: string|number): string; - } - - interface IFilterOrderBy { - /** - * Orders a specified array by the expression predicate. It is ordered alphabetically for strings and numerically for numbers. Note: if you notice numbers are not being sorted as expected, make sure they are actually being saved as numbers and not strings. - * @param array The array to sort. - * @param expression A predicate to be used by the comparator to determine the order of elements. - * @param reverse Reverse the order of the array. - * @return Reverse the order of the array. - */ - (array: T[], expression: string|((value: T) => any)|(((value: T) => any)|string)[], reverse?: boolean): T[]; - } - - /** - * $filterProvider - $filter - provider in module ng - * - * Filters are just functions which transform input to an output. However filters need to be Dependency Injected. To achieve this a filter definition consists of a factory function which is annotated with dependencies and is responsible for creating a filter function. - * - * see https://docs.angularjs.org/api/ng/provider/$filterProvider - */ - interface IFilterProvider extends IServiceProvider { - /** - * register(name); - * - * @param name Name of the filter function, or an object map of filters where the keys are the filter names and the values are the filter factories. Note: Filter names must be valid angular Expressions identifiers, such as uppercase or orderBy. Names with special characters, such as hyphens and dots, are not allowed. If you wish to namespace your filters, then you can use capitalization (myappSubsectionFilterx) or underscores (myapp_subsection_filterx). - */ - register(name: string | {}): IServiceProvider; - } - - /////////////////////////////////////////////////////////////////////////// - // LocaleService - // see http://docs.angularjs.org/api/ng.$locale - /////////////////////////////////////////////////////////////////////////// - interface ILocaleService { - id: string; - - // These are not documented - // Check angular's i18n files for exemples - NUMBER_FORMATS: ILocaleNumberFormatDescriptor; - DATETIME_FORMATS: ILocaleDateTimeFormatDescriptor; - pluralCat: (num: any) => string; - } - - interface ILocaleNumberFormatDescriptor { - DECIMAL_SEP: string; - GROUP_SEP: string; - PATTERNS: ILocaleNumberPatternDescriptor[]; - CURRENCY_SYM: string; - } - - interface ILocaleNumberPatternDescriptor { - minInt: number; - minFrac: number; - maxFrac: number; - posPre: string; - posSuf: string; - negPre: string; - negSuf: string; - gSize: number; - lgSize: number; - } - - interface ILocaleDateTimeFormatDescriptor { - MONTH: string[]; - SHORTMONTH: string[]; - DAY: string[]; - SHORTDAY: string[]; - AMPMS: string[]; - medium: string; - short: string; - fullDate: string; - longDate: string; - mediumDate: string; - shortDate: string; - mediumTime: string; - shortTime: string; - } - - /////////////////////////////////////////////////////////////////////////// - // LogService - // see http://docs.angularjs.org/api/ng.$log - // see http://docs.angularjs.org/api/ng.$logProvider - /////////////////////////////////////////////////////////////////////////// - interface ILogService { - debug: ILogCall; - error: ILogCall; - info: ILogCall; - log: ILogCall; - warn: ILogCall; - } - - interface ILogProvider extends IServiceProvider { - debugEnabled(): boolean; - debugEnabled(enabled: boolean): ILogProvider; - } - - // We define this as separate interface so we can reopen it later for - // the ngMock module. - interface ILogCall { - (...args: any[]): void; - } - - /////////////////////////////////////////////////////////////////////////// - // ParseService - // see http://docs.angularjs.org/api/ng.$parse - // see http://docs.angularjs.org/api/ng.$parseProvider - /////////////////////////////////////////////////////////////////////////// - interface IParseService { - (expression: string, interceptorFn?: (value: any, scope: IScope, locals: any) => any, expensiveChecks?: boolean): ICompiledExpression; - } - - interface IParseProvider { - logPromiseWarnings(): boolean; - logPromiseWarnings(value: boolean): IParseProvider; - - unwrapPromises(): boolean; - unwrapPromises(value: boolean): IParseProvider; - } - - interface ICompiledExpression { - (context: any, locals?: any): any; - - literal: boolean; - constant: boolean; - - // If value is not provided, undefined is gonna be used since the implementation - // does not check the parameter. Let's force a value for consistency. If consumer - // whants to undefine it, pass the undefined value explicitly. - assign(context: any, value: any): any; - } - - /** - * $location - $locationProvider - service in module ng - * see https://docs.angularjs.org/api/ng/service/$location - */ - interface ILocationService { - absUrl(): string; - hash(): string; - hash(newHash: string): ILocationService; - host(): string; - - /** - * Return path of current url - */ - path(): string; - - /** - * Change path when called with parameter and return $location. - * Note: Path should always begin with forward slash (/), this method will add the forward slash if it is missing. - * - * @param path New path - */ - path(path: string): ILocationService; - - port(): number; - protocol(): string; - replace(): ILocationService; - - /** - * Return search part (as object) of current url - */ - search(): any; - - /** - * Change search part when called with parameter and return $location. - * - * @param search When called with a single argument the method acts as a setter, setting the search component of $location to the specified value. - * - * If the argument is a hash object containing an array of values, these values will be encoded as duplicate search parameters in the url. - */ - search(search: any): ILocationService; - - /** - * Change search part when called with parameter and return $location. - * - * @param search New search params - * @param paramValue If search is a string or a Number, then paramValue will override only a single search property. If paramValue is null, the property specified via the first argument will be deleted. If paramValue is an array, it will override the property of the search component of $location specified via the first argument. If paramValue is true, the property specified via the first argument will be added with no value nor trailing equal sign. - */ - search(search: string, paramValue: string|number|string[]|boolean): ILocationService; - - state(): any; - state(state: any): ILocationService; - url(): string; - url(url: string): ILocationService; - } - - interface ILocationProvider extends IServiceProvider { - hashPrefix(): string; - hashPrefix(prefix: string): ILocationProvider; - html5Mode(): boolean; - - // Documentation states that parameter is string, but - // implementation tests it as boolean, which makes more sense - // since this is a toggler - html5Mode(active: boolean): ILocationProvider; - html5Mode(mode: { enabled?: boolean; requireBase?: boolean; rewriteLinks?: boolean; }): ILocationProvider; - } - - /////////////////////////////////////////////////////////////////////////// - // DocumentService - // see http://docs.angularjs.org/api/ng.$document - /////////////////////////////////////////////////////////////////////////// - interface IDocumentService extends IAugmentedJQuery {} - - /////////////////////////////////////////////////////////////////////////// - // ExceptionHandlerService - // see http://docs.angularjs.org/api/ng.$exceptionHandler - /////////////////////////////////////////////////////////////////////////// - interface IExceptionHandlerService { - (exception: Error, cause?: string): void; - } - - /////////////////////////////////////////////////////////////////////////// - // RootElementService - // see http://docs.angularjs.org/api/ng.$rootElement - /////////////////////////////////////////////////////////////////////////// - interface IRootElementService extends JQuery {} - - interface IQResolveReject { - (): void; - (value: T): void; - } - /** - * $q - service in module ng - * A promise/deferred implementation inspired by Kris Kowal's Q. - * See http://docs.angularjs.org/api/ng/service/$q - */ - interface IQService { - new (resolver: (resolve: IQResolveReject) => any): IPromise; - new (resolver: (resolve: IQResolveReject, reject: IQResolveReject) => any): IPromise; - (resolver: (resolve: IQResolveReject) => any): IPromise; - (resolver: (resolve: IQResolveReject, reject: IQResolveReject) => any): IPromise; - - /** - * Combines multiple promises into a single promise that is resolved when all of the input promises are resolved. - * - * Returns a single promise that will be resolved with an array of values, each value corresponding to the promise at the same index in the promises array. If any of the promises is resolved with a rejection, this resulting promise will be rejected with the same rejection value. - * - * @param promises An array of promises. - */ - all(promises: IPromise[]): IPromise; - /** - * Combines multiple promises into a single promise that is resolved when all of the input promises are resolved. - * - * Returns a single promise that will be resolved with a hash of values, each value corresponding to the promise at the same key in the promises hash. If any of the promises is resolved with a rejection, this resulting promise will be rejected with the same rejection value. - * - * @param promises A hash of promises. - */ - all(promises: { [id: string]: IPromise; }): IPromise<{ [id: string]: any; }>; - all(promises: { [id: string]: IPromise; }): IPromise; - /** - * Creates a Deferred object which represents a task which will finish in the future. - */ - defer(): IDeferred; - /** - * Creates a promise that is resolved as rejected with the specified reason. This api should be used to forward rejection in a chain of promises. If you are dealing with the last promise in a promise chain, you don't need to worry about it. - * - * When comparing deferreds/promises to the familiar behavior of try/catch/throw, think of reject as the throw keyword in JavaScript. This also means that if you "catch" an error via a promise error callback and you want to forward the error to the promise derived from the current promise, you have to "rethrow" the error by returning a rejection constructed via reject. - * - * @param reason Constant, message, exception or an object representing the rejection reason. - */ - reject(reason?: any): IPromise; - /** - * Wraps an object that might be a value or a (3rd party) then-able promise into a $q promise. This is useful when you are dealing with an object that might or might not be a promise, or if the promise comes from a source that can't be trusted. - * - * @param value Value or a promise - */ - resolve(value: IPromise|T): IPromise; - /** - * Wraps an object that might be a value or a (3rd party) then-able promise into a $q promise. This is useful when you are dealing with an object that might or might not be a promise, or if the promise comes from a source that can't be trusted. - */ - resolve(): IPromise; - /** - * Wraps an object that might be a value or a (3rd party) then-able promise into a $q promise. This is useful when you are dealing with an object that might or might not be a promise, or if the promise comes from a source that can't be trusted. - * - * @param value Value or a promise - */ - when(value: IPromise|T): IPromise; - /** - * Wraps an object that might be a value or a (3rd party) then-able promise into a $q promise. This is useful when you are dealing with an object that might or might not be a promise, or if the promise comes from a source that can't be trusted. - */ - when(): IPromise; - } - - interface IPromise { - /** - * Regardless of when the promise was or will be resolved or rejected, then calls one of the success or error callbacks asynchronously as soon as the result is available. The callbacks are called with a single argument: the result or rejection reason. Additionally, the notify callback may be called zero or more times to provide a progress indication, before the promise is resolved or rejected. - * The successCallBack may return IPromise for when a $q.reject() needs to be returned - * This method returns a new promise which is resolved or rejected via the return value of the successCallback, errorCallback. It also notifies via the return value of the notifyCallback method. The promise can not be resolved or rejected from the notifyCallback method. - */ - then(successCallback: (promiseValue: T) => IPromise|TResult, errorCallback?: (reason: any) => any, notifyCallback?: (state: any) => any): IPromise; - - /** - * Shorthand for promise.then(null, errorCallback) - */ - catch(onRejected: (reason: any) => IPromise|TResult): IPromise; - - /** - * Allows you to observe either the fulfillment or rejection of a promise, but to do so without modifying the final value. This is useful to release resources or do some clean-up that needs to be done whether the promise was rejected or resolved. See the full specification for more information. - * - * Because finally is a reserved word in JavaScript and reserved keywords are not supported as property names by ES3, you'll need to invoke the method like promise['finally'](callback) to make your code IE8 and Android 2.x compatible. - */ - finally(finallyCallback: () => any): IPromise; - } - - interface IDeferred { - resolve(value?: T|IPromise): void; - reject(reason?: any): void; - notify(state?: any): void; - promise: IPromise; - } - - /////////////////////////////////////////////////////////////////////////// - // AnchorScrollService - // see http://docs.angularjs.org/api/ng.$anchorScroll - /////////////////////////////////////////////////////////////////////////// - interface IAnchorScrollService { - (): void; - (hash: string): void; - yOffset: any; - } - - interface IAnchorScrollProvider extends IServiceProvider { - disableAutoScrolling(): void; - } - - /** - * $cacheFactory - service in module ng - * - * Factory that constructs Cache objects and gives access to them. - * - * see https://docs.angularjs.org/api/ng/service/$cacheFactory - */ - interface ICacheFactoryService { - /** - * Factory that constructs Cache objects and gives access to them. - * - * @param cacheId Name or id of the newly created cache. - * @param optionsMap Options object that specifies the cache behavior. Properties: - * - * capacity — turns the cache into LRU cache. - */ - (cacheId: string, optionsMap?: { capacity?: number; }): ICacheObject; - - /** - * Get information about all the caches that have been created. - * @returns key-value map of cacheId to the result of calling cache#info - */ - info(): any; - - /** - * Get access to a cache object by the cacheId used when it was created. - * - * @param cacheId Name or id of a cache to access. - */ - get(cacheId: string): ICacheObject; - } - - /** - * $cacheFactory.Cache - type in module ng - * - * A cache object used to store and retrieve data, primarily used by $http and the script directive to cache templates and other data. - * - * see https://docs.angularjs.org/api/ng/type/$cacheFactory.Cache - */ - interface ICacheObject { - /** - * Retrieve information regarding a particular Cache. - */ - info(): { - /** - * the id of the cache instance - */ - id: string; - - /** - * the number of entries kept in the cache instance - */ - size: number; - - //...: any additional properties from the options object when creating the cache. - }; - - /** - * Inserts a named entry into the Cache object to be retrieved later, and incrementing the size of the cache if the key was not already present in the cache. If behaving like an LRU cache, it will also remove stale entries from the set. - * - * It will not insert undefined values into the cache. - * - * @param key the key under which the cached data is stored. - * @param value the value to store alongside the key. If it is undefined, the key will not be stored. - */ - put(key: string, value?: T): T; - - /** - * Retrieves named data stored in the Cache object. - * - * @param key the key of the data to be retrieved - */ - get(key: string): T; - - /** - * Removes an entry from the Cache object. - * - * @param key the key of the entry to be removed - */ - remove(key: string): void; - - /** - * Clears the cache object of any entries. - */ - removeAll(): void; - - /** - * Destroys the Cache object entirely, removing it from the $cacheFactory set. - */ - destroy(): void; - } - - /////////////////////////////////////////////////////////////////////////// - // CompileService - // see http://docs.angularjs.org/api/ng.$compile - // see http://docs.angularjs.org/api/ng.$compileProvider - /////////////////////////////////////////////////////////////////////////// - interface ICompileService { - (element: string, transclude?: ITranscludeFunction, maxPriority?: number): ITemplateLinkingFunction; - (element: Element, transclude?: ITranscludeFunction, maxPriority?: number): ITemplateLinkingFunction; - (element: JQuery, transclude?: ITranscludeFunction, maxPriority?: number): ITemplateLinkingFunction; - } - - interface ICompileProvider extends IServiceProvider { - directive(name: string, directiveFactory: Function): ICompileProvider; - - // Undocumented, but it is there... - directive(directivesMap: any): ICompileProvider; - - aHrefSanitizationWhitelist(): RegExp; - aHrefSanitizationWhitelist(regexp: RegExp): ICompileProvider; - - imgSrcSanitizationWhitelist(): RegExp; - imgSrcSanitizationWhitelist(regexp: RegExp): ICompileProvider; - - debugInfoEnabled(enabled?: boolean): any; - } - - interface ICloneAttachFunction { - // Let's hint but not force cloneAttachFn's signature - (clonedElement?: JQuery, scope?: IScope): any; - } - - // This corresponds to the "publicLinkFn" returned by $compile. - interface ITemplateLinkingFunction { - (scope: IScope, cloneAttachFn?: ICloneAttachFunction): IAugmentedJQuery; - } - - // This corresponds to $transclude (and also the transclude function passed to link). - interface ITranscludeFunction { - // If the scope is provided, then the cloneAttachFn must be as well. - (scope: IScope, cloneAttachFn: ICloneAttachFunction): IAugmentedJQuery; - // If one argument is provided, then it's assumed to be the cloneAttachFn. - (cloneAttachFn?: ICloneAttachFunction): IAugmentedJQuery; - } - - /////////////////////////////////////////////////////////////////////////// - // ControllerService - // see http://docs.angularjs.org/api/ng.$controller - // see http://docs.angularjs.org/api/ng.$controllerProvider - /////////////////////////////////////////////////////////////////////////// - interface IControllerService { - // Although the documentation doesn't state this, locals are optional - (controllerConstructor: new (...args: any[]) => T, locals?: any, bindToController?: any): T; - (controllerConstructor: Function, locals?: any, bindToController?: any): T; - (controllerName: string, locals?: any, bindToController?: any): T; - } - - interface IControllerProvider extends IServiceProvider { - register(name: string, controllerConstructor: Function): void; - register(name: string, dependencyAnnotatedConstructor: any[]): void; - allowGlobals(): void; - } - - /** - * HttpService - * see http://docs.angularjs.org/api/ng/service/$http - */ - interface IHttpService { - /** - * Object describing the request to be made and how it should be processed. - */ - (config: IRequestConfig): IHttpPromise; - - /** - * Shortcut method to perform GET request. - * - * @param url Relative or absolute URL specifying the destination of the request - * @param config Optional configuration object - */ - get(url: string, config?: IRequestShortcutConfig): IHttpPromise; - - /** - * Shortcut method to perform DELETE request. - * - * @param url Relative or absolute URL specifying the destination of the request - * @param config Optional configuration object - */ - delete(url: string, config?: IRequestShortcutConfig): IHttpPromise; - - /** - * Shortcut method to perform HEAD request. - * - * @param url Relative or absolute URL specifying the destination of the request - * @param config Optional configuration object - */ - head(url: string, config?: IRequestShortcutConfig): IHttpPromise; - - /** - * Shortcut method to perform JSONP request. - * - * @param url Relative or absolute URL specifying the destination of the request - * @param config Optional configuration object - */ - jsonp(url: string, config?: IRequestShortcutConfig): IHttpPromise; - - /** - * Shortcut method to perform POST request. - * - * @param url Relative or absolute URL specifying the destination of the request - * @param data Request content - * @param config Optional configuration object - */ - post(url: string, data: any, config?: IRequestShortcutConfig): IHttpPromise; - - /** - * Shortcut method to perform PUT request. - * - * @param url Relative or absolute URL specifying the destination of the request - * @param data Request content - * @param config Optional configuration object - */ - put(url: string, data: any, config?: IRequestShortcutConfig): IHttpPromise; - - /** - * Shortcut method to perform PATCH request. - * - * @param url Relative or absolute URL specifying the destination of the request - * @param data Request content - * @param config Optional configuration object - */ - patch(url: string, data: any, config?: IRequestShortcutConfig): IHttpPromise; - - /** - * Runtime equivalent of the $httpProvider.defaults property. Allows configuration of default headers, withCredentials as well as request and response transformations. - */ - defaults: IHttpProviderDefaults; - - /** - * Array of config objects for currently pending requests. This is primarily meant to be used for debugging purposes. - */ - pendingRequests: IRequestConfig[]; - } - - /** - * Object describing the request to be made and how it should be processed. - * see http://docs.angularjs.org/api/ng/service/$http#usage - */ - interface IRequestShortcutConfig extends IHttpProviderDefaults { - /** - * {Object.} - * Map of strings or objects which will be turned to ?key1=value1&key2=value2 after the url. If the value is not a string, it will be JSONified. - */ - params?: any; - - /** - * {string|Object} - * Data to be sent as the request message data. - */ - data?: any; - - /** - * Timeout in milliseconds, or promise that should abort the request when resolved. - */ - timeout?: number|IPromise; - - /** - * See [XMLHttpRequest.responseType]https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest#xmlhttprequest-responsetype - */ - responseType?: string; - } - - /** - * Object describing the request to be made and how it should be processed. - * see http://docs.angularjs.org/api/ng/service/$http#usage - */ - interface IRequestConfig extends IRequestShortcutConfig { - /** - * HTTP method (e.g. 'GET', 'POST', etc) - */ - method: string; - /** - * Absolute or relative URL of the resource that is being requested. - */ - url: string; - } - - interface IHttpHeadersGetter { - (): { [name: string]: string; }; - (headerName: string): string; - } - - interface IHttpPromiseCallback { - (data: T, status: number, headers: IHttpHeadersGetter, config: IRequestConfig): void; - } - - interface IHttpPromiseCallbackArg { - data?: T; - status?: number; - headers?: IHttpHeadersGetter; - config?: IRequestConfig; - statusText?: string; - } - - interface IHttpPromise extends IPromise> { - success(callback: IHttpPromiseCallback): IHttpPromise; - error(callback: IHttpPromiseCallback): IHttpPromise; - } - - // See the jsdoc for transformData() at https://github.com/angular/angular.js/blob/master/src/ng/http.js#L228 - interface IHttpRequestTransformer { - (data: any, headersGetter: IHttpHeadersGetter): any; - } - - // The definition of fields are the same as IHttpPromiseCallbackArg - interface IHttpResponseTransformer { - (data: any, headersGetter: IHttpHeadersGetter, status: number): any; - } - - interface IHttpRequestConfigHeaders { - [requestType: string]: string|(() => string); - common?: string|(() => string); - get?: string|(() => string); - post?: string|(() => string); - put?: string|(() => string); - patch?: string|(() => string); - } - - /** - * Object that controls the defaults for $http provider. Not all fields of IRequestShortcutConfig can be configured - * via defaults and the docs do not say which. The following is based on the inspection of the source code. - * https://docs.angularjs.org/api/ng/service/$http#defaults - * https://docs.angularjs.org/api/ng/service/$http#usage - * https://docs.angularjs.org/api/ng/provider/$httpProvider The properties section - */ - interface IHttpProviderDefaults { - /** - * {boolean|Cache} - * If true, a default $http cache will be used to cache the GET request, otherwise if a cache instance built with $cacheFactory, this cache will be used for caching. - */ - cache?: any; - - /** - * Transform function or an array of such functions. The transform function takes the http request body and - * headers and returns its transformed (typically serialized) version. - * @see {@link https://docs.angularjs.org/api/ng/service/$http#transforming-requests-and-responses} - */ - transformRequest?: IHttpRequestTransformer |IHttpRequestTransformer[]; - - /** - * Transform function or an array of such functions. The transform function takes the http response body and - * headers and returns its transformed (typically deserialized) version. - */ - transformResponse?: IHttpResponseTransformer | IHttpResponseTransformer[]; - - /** - * Map of strings or functions which return strings representing HTTP headers to send to the server. If the - * return value of a function is null, the header will not be sent. - * The key of the map is the request verb in lower case. The "common" key applies to all requests. - * @see {@link https://docs.angularjs.org/api/ng/service/$http#setting-http-headers} - */ - headers?: IHttpRequestConfigHeaders; - - /** Name of HTTP header to populate with the XSRF token. */ - xsrfHeaderName?: string; - - /** Name of cookie containing the XSRF token. */ - xsrfCookieName?: string; - - /** - * whether to to set the withCredentials flag on the XHR object. See [requests with credentials]https://developer.mozilla.org/en/http_access_control#section_5 for more information. - */ - withCredentials?: boolean; - - /** - * A function used to the prepare string representation of request parameters (specified as an object). If - * specified as string, it is interpreted as a function registered with the $injector. Defaults to - * $httpParamSerializer. - */ - paramSerializer?: string | ((obj: any) => string); - } - - interface IHttpInterceptor { - request?: (config: IRequestConfig) => IRequestConfig|IPromise; - requestError?: (rejection: any) => any; - response?: (response: IHttpPromiseCallbackArg) => IPromise|T; - responseError?: (rejection: any) => any; - } - - interface IHttpInterceptorFactory { - (...args: any[]): IHttpInterceptor; - } - - interface IHttpProvider extends IServiceProvider { - defaults: IHttpProviderDefaults; - - /** - * Register service factories (names or implementations) for interceptors which are called before and after - * each request. - */ - interceptors: (string|IHttpInterceptorFactory|(string|IHttpInterceptorFactory)[])[]; - useApplyAsync(): boolean; - useApplyAsync(value: boolean): IHttpProvider; - - /** - * - * @param {boolean=} value If true, `$http` will return a normal promise without the `success` and `error` methods. - * @returns {boolean|Object} If a value is specified, returns the $httpProvider for chaining. - * otherwise, returns the current configured value. - */ - useLegacyPromiseExtensions(value:boolean) : boolean | IHttpProvider; - } - - /////////////////////////////////////////////////////////////////////////// - // HttpBackendService - // see http://docs.angularjs.org/api/ng.$httpBackend - // You should never need to use this service directly. - /////////////////////////////////////////////////////////////////////////// - interface IHttpBackendService { - // XXX Perhaps define callback signature in the future - (method: string, url: string, post?: any, callback?: Function, headers?: any, timeout?: number, withCredentials?: boolean): void; - } - - /////////////////////////////////////////////////////////////////////////// - // InterpolateService - // see http://docs.angularjs.org/api/ng.$interpolate - // see http://docs.angularjs.org/api/ng.$interpolateProvider - /////////////////////////////////////////////////////////////////////////// - interface IInterpolateService { - (text: string, mustHaveExpression?: boolean, trustedContext?: string, allOrNothing?: boolean): IInterpolationFunction; - endSymbol(): string; - startSymbol(): string; - } - - interface IInterpolationFunction { - (context: any): string; - } - - interface IInterpolateProvider extends IServiceProvider { - startSymbol(): string; - startSymbol(value: string): IInterpolateProvider; - endSymbol(): string; - endSymbol(value: string): IInterpolateProvider; - } - - /////////////////////////////////////////////////////////////////////////// - // TemplateCacheService - // see http://docs.angularjs.org/api/ng.$templateCache - /////////////////////////////////////////////////////////////////////////// - interface ITemplateCacheService extends ICacheObject {} - - /////////////////////////////////////////////////////////////////////////// - // SCEService - // see http://docs.angularjs.org/api/ng.$sce - /////////////////////////////////////////////////////////////////////////// - interface ISCEService { - getTrusted(type: string, mayBeTrusted: any): any; - getTrustedCss(value: any): any; - getTrustedHtml(value: any): any; - getTrustedJs(value: any): any; - getTrustedResourceUrl(value: any): any; - getTrustedUrl(value: any): any; - parse(type: string, expression: string): (context: any, locals: any) => any; - parseAsCss(expression: string): (context: any, locals: any) => any; - parseAsHtml(expression: string): (context: any, locals: any) => any; - parseAsJs(expression: string): (context: any, locals: any) => any; - parseAsResourceUrl(expression: string): (context: any, locals: any) => any; - parseAsUrl(expression: string): (context: any, locals: any) => any; - trustAs(type: string, value: any): any; - trustAsHtml(value: any): any; - trustAsJs(value: any): any; - trustAsResourceUrl(value: any): any; - trustAsUrl(value: any): any; - isEnabled(): boolean; - } - - /////////////////////////////////////////////////////////////////////////// - // SCEProvider - // see http://docs.angularjs.org/api/ng.$sceProvider - /////////////////////////////////////////////////////////////////////////// - interface ISCEProvider extends IServiceProvider { - enabled(value: boolean): void; - } - - /////////////////////////////////////////////////////////////////////////// - // SCEDelegateService - // see http://docs.angularjs.org/api/ng.$sceDelegate - /////////////////////////////////////////////////////////////////////////// - interface ISCEDelegateService { - getTrusted(type: string, mayBeTrusted: any): any; - trustAs(type: string, value: any): any; - valueOf(value: any): any; - } - - - /////////////////////////////////////////////////////////////////////////// - // SCEDelegateProvider - // see http://docs.angularjs.org/api/ng.$sceDelegateProvider - /////////////////////////////////////////////////////////////////////////// - interface ISCEDelegateProvider extends IServiceProvider { - resourceUrlBlacklist(blacklist: any[]): void; - resourceUrlWhitelist(whitelist: any[]): void; - resourceUrlBlacklist(): any[]; - resourceUrlWhitelist(): any[]; - } - - /** - * $templateRequest service - * see http://docs.angularjs.org/api/ng/service/$templateRequest - */ - interface ITemplateRequestService { - /** - * Downloads a template using $http and, upon success, stores the - * contents inside of $templateCache. - * - * If the HTTP request fails or the response data of the HTTP request is - * empty then a $compile error will be thrown (unless - * {ignoreRequestError} is set to true). - * - * @param tpl The template URL. - * @param ignoreRequestError Whether or not to ignore the exception - * when the request fails or the template is - * empty. - * - * @return A promise whose value is the template content. - */ - (tpl: string, ignoreRequestError?: boolean): IPromise; - /** - * total amount of pending template requests being downloaded. - * @type {number} - */ - totalPendingRequests: number; - } - - /////////////////////////////////////////////////////////////////////////// - // Component - // see http://angularjs.blogspot.com.br/2015/11/angularjs-15-beta2-and-14-releases.html - // and http://toddmotto.com/exploring-the-angular-1-5-component-method/ - /////////////////////////////////////////////////////////////////////////// - /** - * Runtime representation a type that a Component or other object is instances of. - * - * An example of a `Type` is `MyCustomComponent` class, which in JavaScript is be represented by - * the `MyCustomComponent` constructor function. - */ - interface Type extends Function { - } - - /** - * `RouteDefinition` defines a route within a {@link RouteConfig} decorator. - * - * Supported keys: - * - `path` or `aux` (requires exactly one of these) - * - `component`, `loader`, `redirectTo` (requires exactly one of these) - * - `name` or `as` (optional) (requires exactly one of these) - * - `data` (optional) - * - * See also {@link Route}, {@link AsyncRoute}, {@link AuxRoute}, and {@link Redirect}. - */ - interface RouteDefinition { - path?: string; - aux?: string; - component?: Type | ComponentDefinition | string; - loader?: Function; - redirectTo?: any[]; - as?: string; - name?: string; - data?: any; - useAsDefault?: boolean; - } - - /** - * Represents either a component type (`type` is `component`) or a loader function - * (`type` is `loader`). - * - * See also {@link RouteDefinition}. - */ - interface ComponentDefinition { - type: string; - loader?: Function; - component?: Type; - } - - /** - * Component definition object (a simplified directive definition object) - */ - interface IComponentOptions { - /** - * Controller constructor function that should be associated with newly created scope or the name of a registered - * controller if passed as a string. Empty function by default. - */ - controller?: any; - /** - * An identifier name for a reference to the controller. If present, the controller will be published to scope under - * the controllerAs name. If not present, this will default to be the same as the component name. - */ - controllerAs?: string; - /** - * html template as a string or a function that returns an html template as a string which should be used as the - * contents of this component. Empty string by default. - * If template is a function, then it is injected with the following locals: - * $element - Current element - * $attrs - Current attributes object for the element - */ - template?: string | Function; - /** - * path or function that returns a path to an html template that should be used as the contents of this component. - * If templateUrl is a function, then it is injected with the following locals: - * $element - Current element - * $attrs - Current attributes object for the element - */ - templateUrl?: string | Function; - /** - * Define DOM attribute binding to component properties. Component properties are always bound to the component - * controller and not to the scope. - */ - bindings?: any; - /** - * Whether transclusion is enabled. Enabled by default. - */ - transclude?: boolean; - require? : Object; - $canActivate?: () => boolean; - $routeConfig?: RouteDefinition[]; - } - - interface IComponentTemplateFn { - ( $element?: IAugmentedJQuery, $attrs?: IAttributes ): string; - } - - /////////////////////////////////////////////////////////////////////////// - // Directive - // see http://docs.angularjs.org/api/ng.$compileProvider#directive - // and http://docs.angularjs.org/guide/directive - /////////////////////////////////////////////////////////////////////////// - - interface IDirectiveFactory { - (...args: any[]): IDirective; - } - - interface IDirectiveLinkFn { - ( - scope: IScope, - instanceElement: IAugmentedJQuery, - instanceAttributes: IAttributes, - controller: {}, - transclude: ITranscludeFunction - ): void; - } - - interface IDirectivePrePost { - pre?: IDirectiveLinkFn; - post?: IDirectiveLinkFn; - } - - interface IDirectiveCompileFn { - ( - templateElement: IAugmentedJQuery, - templateAttributes: IAttributes, - transclude: ITranscludeFunction - ): IDirectivePrePost; - } - - interface IDirective { - compile?: IDirectiveCompileFn; - controller?: any; - controllerAs?: string; - bindToController?: boolean|Object; - link?: IDirectiveLinkFn | IDirectivePrePost; - name?: string; - priority?: number; - replace?: boolean; - require? : any; - restrict?: string; - scope?: any; - template?: string | Function; - templateNamespace?: string; - templateUrl?: string | Function; - terminal?: boolean; - transclude?: any; - } - - /** - * angular.element - * when calling angular.element, angular returns a jQuery object, - * augmented with additional methods like e.g. scope. - * see: http://docs.angularjs.org/api/angular.element - */ - interface IAugmentedJQueryStatic extends JQueryStatic { - (selector: string, context?: any): IAugmentedJQuery; - (element: Element): IAugmentedJQuery; - (object: {}): IAugmentedJQuery; - (elementArray: Element[]): IAugmentedJQuery; - (object: JQuery): IAugmentedJQuery; - (func: Function): IAugmentedJQuery; - (array: any[]): IAugmentedJQuery; - (): IAugmentedJQuery; - } - - interface IAugmentedJQuery extends JQuery { - // TODO: events, how to define? - //$destroy - - find(selector: string): IAugmentedJQuery; - find(element: any): IAugmentedJQuery; - find(obj: JQuery): IAugmentedJQuery; - controller(): any; - controller(name: string): any; - injector(): any; - scope(): IScope; - isolateScope(): IScope; - - inheritedData(key: string, value: any): JQuery; - inheritedData(obj: { [key: string]: any; }): JQuery; - inheritedData(key?: string): any; - } - - /////////////////////////////////////////////////////////////////////////// - // AUTO module (angular.js) - /////////////////////////////////////////////////////////////////////////// - export module auto { - - /////////////////////////////////////////////////////////////////////// - // InjectorService - // see http://docs.angularjs.org/api/AUTO.$injector - /////////////////////////////////////////////////////////////////////// - interface IInjectorService { - annotate(fn: Function): string[]; - annotate(inlineAnnotatedFunction: any[]): string[]; - get(name: string, caller?: string): T; - has(name: string): boolean; - instantiate(typeConstructor: Function, locals?: any): T; - invoke(inlineAnnotatedFunction: any[]): any; - invoke(func: Function, context?: any, locals?: any): any; - } - - /////////////////////////////////////////////////////////////////////// - // ProvideService - // see http://docs.angularjs.org/api/AUTO.$provide - /////////////////////////////////////////////////////////////////////// - interface IProvideService { - // Documentation says it returns the registered instance, but actual - // implementation does not return anything. - // constant(name: string, value: any): any; - /** - * Register a constant service, such as a string, a number, an array, an object or a function, with the $injector. Unlike value it can be injected into a module configuration function (see config) and it cannot be overridden by an Angular decorator. - * - * @param name The name of the constant. - * @param value The constant value. - */ - constant(name: string, value: any): void; - - /** - * Register a service decorator with the $injector. A service decorator intercepts the creation of a service, allowing it to override or modify the behaviour of the service. The object returned by the decorator may be the original service, or a new service object which replaces or wraps and delegates to the original service. - * - * @param name The name of the service to decorate. - * @param decorator This function will be invoked when the service needs to be instantiated and should return the decorated service instance. The function is called using the injector.invoke method and is therefore fully injectable. Local injection arguments: - * - * $delegate - The original service instance, which can be monkey patched, configured, decorated or delegated to. - */ - decorator(name: string, decorator: Function): void; - /** - * Register a service decorator with the $injector. A service decorator intercepts the creation of a service, allowing it to override or modify the behaviour of the service. The object returned by the decorator may be the original service, or a new service object which replaces or wraps and delegates to the original service. - * - * @param name The name of the service to decorate. - * @param inlineAnnotatedFunction This function will be invoked when the service needs to be instantiated and should return the decorated service instance. The function is called using the injector.invoke method and is therefore fully injectable. Local injection arguments: - * - * $delegate - The original service instance, which can be monkey patched, configured, decorated or delegated to. - */ - decorator(name: string, inlineAnnotatedFunction: any[]): void; - factory(name: string, serviceFactoryFunction: Function): IServiceProvider; - factory(name: string, inlineAnnotatedFunction: any[]): IServiceProvider; - provider(name: string, provider: IServiceProvider): IServiceProvider; - provider(name: string, serviceProviderConstructor: Function): IServiceProvider; - service(name: string, constructor: Function): IServiceProvider; - service(name: string, inlineAnnotatedFunction: any[]): IServiceProvider; - value(name: string, value: any): IServiceProvider; - } - - } -} diff --git a/angular/legacy/angular-animate-1.2.d.ts b/angular/legacy/angular-animate-1.2.d.ts deleted file mode 100644 index 0a74608c27..0000000000 --- a/angular/legacy/angular-animate-1.2.d.ts +++ /dev/null @@ -1,110 +0,0 @@ -// Type definitions for Angular JS 1.2 (ngAnimate module) -// Project: http://angularjs.org -// Definitions by: Michel Salib , Adi Dahiya -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - - - -/////////////////////////////////////////////////////////////////////////////// -// ngAnimate module (angular-animate.js) -/////////////////////////////////////////////////////////////////////////////// -declare namespace ng.animate { - - /////////////////////////////////////////////////////////////////////////// - // AnimateService - // see https://code.angularjs.org/1.2.26/docs/api/ngAnimate/service/$animate - /////////////////////////////////////////////////////////////////////////// - interface IAnimateService extends ng.IAnimateService { - /** - * Globally enables / disables animations. - * - * @param value If provided then set the animation on or off. - * @param element If provided then the element will be used to represent the enable/disable operation. - * @returns current animation state - */ - enabled(value?: boolean, element?: JQuery): boolean; - - /** - * Appends the element to the parentElement element that resides in the document and then runs the enter animation. - * - * @param element the element that will be the focus of the enter animation - * @param parentElement the parent element of the element that will be the focus of the enter animation - * @param afterElement the sibling element (which is the previous element) of the element that will be the focus of the enter animation - * @param doneCallback the callback function that will be called once the animation is complete - */ - enter(element: JQuery, parentElement: JQuery, afterElement?: JQuery, doneCallback?: () => void): void; - - /** - * Runs the leave animation operation and, upon completion, removes the element from the DOM. - * - * @param element the element that will be the focus of the leave animation - * @param doneCallback the callback function that will be called once the animation is complete - */ - leave(element: JQuery, doneCallback?: () => void): void; - - /** - * Fires the move DOM operation. Just before the animation starts, the animate service will either append - * it into the parentElement container or add the element directly after the afterElement element if present. - * Then the move animation will be run. - * - * @param element the element that will be the focus of the move animation - * @param parentElement the parent element of the element that will be the focus of the move animation - * @param afterElement the sibling element (which is the previous element) of the element that will be the focus of the move animation - * @param doneCallback the callback function that will be called once the animation is complete - */ - move(element: JQuery, parentElement: JQuery, afterElement?: JQuery, doneCallback?: () => void): void; - - /** - * Triggers a custom animation event based off the className variable and then attaches the className - * value to the element as a CSS class. - * - * @param element the element that will be animated - * @param className the CSS class that will be added to the element and then animated - * @param doneCallback the callback function that will be called once the animation is complete - */ - addClass(element: JQuery, className: string, doneCallback?: () => void): void; - - /** - * Triggers a custom animation event based off the className variable and then removes the CSS class - * provided by the className value from the element. - * - * @param element the element that will be animated - * @param className the CSS class that will be animated and then removed from the element - * @param doneCallback the callback function that will be called once the animation is complete - */ - removeClass(element: JQuery, className: string, doneCallback?: () => void): void; - - /** - * Adds and/or removes the given CSS classes to and from the element. Once complete, the done() callback - * will be fired (if provided). - * - * @param element the element which will have its CSS classes changed removed from it - * @param add the CSS classes which will be added to the element - * @param remove the CSS class which will be removed from the element CSS classes have been set on the element - * @param doneCallback done the callback function (if provided) that will be fired after the CSS classes have been set on the element - */ - setClass(element: JQuery, add: string, remove: string, doneCallback?: () => void): void; - } - - /////////////////////////////////////////////////////////////////////////// - // AngularProvider - // see https://code.angularjs.org/1.2.26/docs/api/ngAnimate/provider/$animateProvider - /////////////////////////////////////////////////////////////////////////// - interface IAnimateProvider { - /** - * Registers a new injectable animation factory function. - * - * @param name The name of the animation. - * @param factory The factory function that will be executed to return the animation object. - */ - register(name: string, factory: () => ng.IAnimateCallbackObject): void; - - /** - * Gets and/or sets the CSS class expression that is checked when performing an animation. - * - * @param expression The className expression which will be checked against all animations. - * @returns The current CSS className expression value. If null then there is no expression value. - */ - classNameFilter(expression?: RegExp): RegExp; - } -} diff --git a/angular/legacy/angular-animate-1.3.d.ts b/angular/legacy/angular-animate-1.3.d.ts deleted file mode 100644 index 6f103bc83c..0000000000 --- a/angular/legacy/angular-animate-1.3.d.ts +++ /dev/null @@ -1,261 +0,0 @@ -// Type definitions for Angular JS 1.3 (ngAnimate module) -// Project: http://angularjs.org -// Definitions by: Michel Salib , Adi Dahiya , Raphael Schweizer , Cody Schaaf -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - - - -declare module "angular-animate" { - var _: string; - export = _; -} - -/** - * ngAnimate module (angular-animate.js) - */ -declare namespace angular.animate { - interface IAnimateFactory extends Function { - enter?: (element: ng.IAugmentedJQuery, doneFn: Function) => IAnimateCssRunner|void; - leave?: (element: ng.IAugmentedJQuery, doneFn: Function) => IAnimateCssRunner|void; - addClass?: (element: ng.IAugmentedJQuery, className: string, doneFn: Function) => IAnimateCssRunner|void; - removeClass?: (element: ng.IAugmentedJQuery, className: string, doneFn: Function) => IAnimateCssRunner|void; - setClass?: (element: ng.IAugmentedJQuery, className: string, doneFn: Function) => IAnimateCssRunner|void; - } - - /** - * AnimateService - * see http://docs.angularjs.org/api/ngAnimate/service/$animate - */ - interface IAnimateService { - /** - * Globally enables / disables animations. - * - * @param element If provided then the element will be used to represent the enable/disable operation. - * @param value If provided then set the animation on or off. - * @returns current animation state - */ - enabled(element?: JQuery, value?: boolean): boolean; - - /** - * Performs an inline animation on the element. - * - * @param element the element that will be the focus of the animation - * @param from a collection of CSS styles that will be applied to the element at the start of the animation - * @param to a collection of CSS styles that the element will animate towards - * @param className an optional CSS class that will be added to the element for the duration of the animation (the default class is 'ng-inline-animate') - * @param options an optional collection of styles that will be picked up by the CSS transition/animation - * @returns the animation callback promise - */ - animate(element: JQuery, from: any, to: any, className?: string, options?: IAnimationOptions): IPromise; - - /** - * Appends the element to the parentElement element that resides in the document and then runs the enter animation. - * - * @param element the element that will be the focus of the enter animation - * @param parentElement the parent element of the element that will be the focus of the enter animation - * @param afterElement the sibling element (which is the previous element) of the element that will be the focus of the enter animation - * @param options an optional collection of styles that will be picked up by the CSS transition/animation - * @returns the animation callback promise - */ - enter(element: JQuery, parentElement: JQuery, afterElement?: JQuery, options?: IAnimationOptions): IPromise; - - /** - * Runs the leave animation operation and, upon completion, removes the element from the DOM. - * - * @param element the element that will be the focus of the leave animation - * @param options an optional collection of styles that will be picked up by the CSS transition/animation - * @returns the animation callback promise - */ - leave(element: JQuery, options?: IAnimationOptions): IPromise; - - /** - * Fires the move DOM operation. Just before the animation starts, the animate service will either append - * it into the parentElement container or add the element directly after the afterElement element if present. - * Then the move animation will be run. - * - * @param element the element that will be the focus of the move animation - * @param parentElement the parent element of the element that will be the focus of the move animation - * @param afterElement the sibling element (which is the previous element) of the element that will be the focus of the move animation - * @returns the animation callback promise - */ - move(element: JQuery, parentElement: JQuery, afterElement?: JQuery): IPromise; - - /** - * Triggers a custom animation event based off the className variable and then attaches the className - * value to the element as a CSS class. - * - * @param element the element that will be animated - * @param className the CSS class that will be added to the element and then animated - * @param options an optional collection of styles that will be picked up by the CSS transition/animation - * @returns the animation callback promise - */ - addClass(element: JQuery, className: string, options?: IAnimationOptions): IPromise; - - /** - * Triggers a custom animation event based off the className variable and then removes the CSS class - * provided by the className value from the element. - * - * @param element the element that will be animated - * @param className the CSS class that will be animated and then removed from the element - * @param options an optional collection of styles that will be picked up by the CSS transition/animation - * @returns the animation callback promise - */ - removeClass(element: JQuery, className: string, options?: IAnimationOptions): IPromise; - - /** - * Adds and/or removes the given CSS classes to and from the element. Once complete, the done() callback - * will be fired (if provided). - * - * @param element the element which will have its CSS classes changed removed from it - * @param add the CSS classes which will be added to the element - * @param remove the CSS class which will be removed from the element CSS classes have been set on the element - * @param options an optional collection of styles that will be picked up by the CSS transition/animation - * @returns the animation callback promise - */ - setClass(element: JQuery, add: string, remove: string, options?: IAnimationOptions): IPromise; - - /** - * Cancels the provided animation. - */ - cancel(animationPromise: IPromise): void; - } - - /** - * AnimateProvider - * see http://docs.angularjs.org/api/ngAnimate/provider/$animateProvider - */ - interface IAnimateProvider { - /** - * Registers a new injectable animation factory function. - * - * @param name The name of the animation. - * @param factory The factory function that will be executed to return the animation object. - */ - register(name: string, factory: () => IAnimateCallbackObject): void; - - /** - * Gets and/or sets the CSS class expression that is checked when performing an animation. - * - * @param expression The className expression which will be checked against all animations. - * @returns The current CSS className expression value. If null then there is no expression value. - */ - classNameFilter(expression?: RegExp): RegExp; - } - - /** - * Angular Animation Options - * see https://docs.angularjs.org/api/ngAnimate/#applying-directive-specific-styles-to-an-animation - */ - interface IAnimationOptions { - /** - * The ending CSS styles (a key/value object) that will be applied across the animation via a CSS transition. - */ - to?: Object; - - /** - * The starting CSS styles (a key/value object) that will be applied at the start of the animation. - */ - from?: Object; - - /** - * The DOM event (e.g. enter, leave, move). When used, a generated CSS class of ng-EVENT and - * ng-EVENT-active will be applied to the element during the animation. Multiple events can be provided when - * spaces are used as a separator. (Note that this will not perform any DOM operation.) - */ - event?: string; - - /** - * The CSS easing value that will be applied to the transition or keyframe animation (or both). - */ - easing?: string; - - /** - * The raw CSS transition style that will be used (e.g. 1s linear all). - */ - transition?: string; - - /** - * The raw CSS keyframe animation style that will be used (e.g. 1s my_animation linear). - */ - keyframe?: string; - - /** - * A space separated list of CSS classes that will be added to the element and spread across the animation. - */ - addClass?: string; - - /** - * A space separated list of CSS classes that will be removed from the element and spread across - * the animation. - */ - removeClass?: string; - - /** - * A number value representing the total duration of the transition and/or keyframe (note that a value - * of 1 is 1000ms). If a value of 0 is provided then the animation will be skipped entirely. - */ - duration?: number; - - /** - * A number value representing the total delay of the transition and/or keyframe (note that a value of - * 1 is 1000ms). If a value of true is used then whatever delay value is detected from the CSS classes will be - * mirrored on the elements styles (e.g. by setting delay true then the style value of the element will be - * transition-delay: DETECTED_VALUE). Using true is useful when you want the CSS classes and inline styles to - * all share the same CSS delay value. - */ - delay?: number; - - /** - * A numeric time value representing the delay between successively animated elements (Click here to - * learn how CSS-based staggering works in ngAnimate.) - */ - stagger?: number; - - /** - * The numeric index representing the stagger item (e.g. a value of 5 is equal to the sixth item - * in the stagger; therefore when a stagger option value of 0.1 is used then there will be a stagger delay of 600ms) - * applyClassesEarly - Whether or not the classes being added or removed will be used when detecting the animation. - * This is set by $animate when enter/leave/move animations are fired to ensure that the CSS classes are resolved in time. - * (Note that this will prevent any transitions from occuring on the classes being added and removed.) - */ - staggerIndex?: number; - } - - interface IAnimateCssRunner { - /** - * Starts the animation - * - * @returns The animation runner with a done function for supplying a callback. - */ - start(): IAnimateCssRunnerStart; - - /** - * Ends (aborts) the animation - */ - end(): void; - } - - interface IAnimateCssRunnerStart extends IPromise { - /** - * Allows you to add done callbacks to the running animation - * - * @param callbackFn: the callback function to be run - */ - done(callbackFn: (animationFinished: boolean) => void): void; - } - - /** - * AnimateCssService - * see http://docs.angularjs.org/api/ngAnimate/service/$animateCss - */ - interface IAnimateCssService { - (element: JQuery, animateCssOptions: IAnimationOptions): IAnimateCssRunner; - } - -} - -declare namespace angular { - interface IModule { - animate(cssSelector: string, animateFactory: angular.animate.IAnimateFactory): IModule; - } -} diff --git a/angular/legacy/angular-cookies-1.0.d.ts b/angular/legacy/angular-cookies-1.0.d.ts deleted file mode 100644 index 78c8bd4229..0000000000 --- a/angular/legacy/angular-cookies-1.0.d.ts +++ /dev/null @@ -1,30 +0,0 @@ -// Type definitions for Angular JS 1.0 (ngCookies module) -// Project: http://angularjs.org -// Definitions by: Diego Vilar -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - - - - -/////////////////////////////////////////////////////////////////////////////// -// ngCookies module (angular-cookies.js) -/////////////////////////////////////////////////////////////////////////////// -declare namespace ng.cookies { - - /////////////////////////////////////////////////////////////////////////// - // CookieService - // see http://docs.angularjs.org/api/ngCookies.$cookies - /////////////////////////////////////////////////////////////////////////// - interface ICookiesService {} - - /////////////////////////////////////////////////////////////////////////// - // CookieStoreService - // see http://docs.angularjs.org/api/ngCookies.$cookieStore - /////////////////////////////////////////////////////////////////////////// - interface ICookieStoreService { - get(key: string): any; - put(key: string, value: any): void; - remove(key: string): void; - } - -} diff --git a/angular/legacy/angular-cookies-1.2.d.ts b/angular/legacy/angular-cookies-1.2.d.ts deleted file mode 100644 index 662bf11662..0000000000 --- a/angular/legacy/angular-cookies-1.2.d.ts +++ /dev/null @@ -1,43 +0,0 @@ -// Type definitions for Angular JS 1.2 (ngCookies module) -// Project: http://angularjs.org -// Definitions by: Diego Vilar -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - - - - -/////////////////////////////////////////////////////////////////////////////// -// ngCookies module (angular-cookies.js) -/////////////////////////////////////////////////////////////////////////////// -declare namespace ng.cookies { - - /////////////////////////////////////////////////////////////////////////// - // CookieService - // see https://code.angularjs.org/1.2.26/docs/api/ngCookies/service/$cookies - /////////////////////////////////////////////////////////////////////////// - interface ICookiesService {} - - /////////////////////////////////////////////////////////////////////////// - // CookieStoreService - // see https://code.angularjs.org/1.2.26/docs/api/ngCookies/service/$cookieStore - /////////////////////////////////////////////////////////////////////////// - interface ICookieStoreService { - /** - * Returns the value of given cookie key - * @param key Id to use for lookup - */ - get(key: string): any; - /** - * Sets a value for given cookie key - * @param key Id for the value - * @param value Value to be stored - */ - put(key: string, value: any): void; - /** - * Remove given cookie - * @param key Id of the key-value pair to delete - */ - remove(key: string): void; - } - -} diff --git a/angular/legacy/angular-mocks-1.0.d.ts b/angular/legacy/angular-mocks-1.0.d.ts deleted file mode 100644 index 7ffa97f0ee..0000000000 --- a/angular/legacy/angular-mocks-1.0.d.ts +++ /dev/null @@ -1,150 +0,0 @@ -// Type definitions for Angular JS 1.0 (ngMock, ngMockE2E module) -// Project: http://angularjs.org -// Definitions by: Diego Vilar -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - - - - -/////////////////////////////////////////////////////////////////////////////// -// functions attached to global object (window) -/////////////////////////////////////////////////////////////////////////////// -declare var module: (...modules: any[]) => any; -declare var inject: (...fns: Function[]) => any; - -/////////////////////////////////////////////////////////////////////////////// -// ngMock module (angular-mocks.js) -/////////////////////////////////////////////////////////////////////////////// -declare namespace ng { - - /////////////////////////////////////////////////////////////////////////// - // AngularStatic - // We reopen it to add the MockStatic definition - /////////////////////////////////////////////////////////////////////////// - interface IAngularStatic { - mock: IMockStatic; - } - - interface IMockStatic { - // see http://docs.angularjs.org/api/angular.mock.debug - debug(obj: any): string; - - // see http://docs.angularjs.org/api/angular.mock.inject - inject(...fns: Function[]): any; - - // see http://docs.angularjs.org/api/angular.mock.module - module(...modules: any[]): any; - - // see http://docs.angularjs.org/api/angular.mock.TzDate - TzDate(offset: number, timestamp: number): Date; - TzDate(offset: number, timestamp: string): Date; - } - - /////////////////////////////////////////////////////////////////////////// - // ExceptionHandlerService - // see http://docs.angularjs.org/api/ngMock.$exceptionHandler - // see http://docs.angularjs.org/api/ngMock.$exceptionHandlerProvider - /////////////////////////////////////////////////////////////////////////// - interface IExceptionHandlerProvider extends IServiceProvider { - mode(mode: string): void; - } - - /////////////////////////////////////////////////////////////////////////// - // TimeoutService - // see http://docs.angularjs.org/api/ngMock.$timeout - // Augments the original service - /////////////////////////////////////////////////////////////////////////// - interface ITimeoutService { - flush(): void; - } - - /////////////////////////////////////////////////////////////////////////// - // LogService - // see http://docs.angularjs.org/api/ngMock.$log - // Augments the original service - /////////////////////////////////////////////////////////////////////////// - interface ILogService { - assertEmpty(): void; - reset(): void; - } - - interface LogCall { - logs: string[]; - } - - /////////////////////////////////////////////////////////////////////////// - // HttpBackendService - // see http://docs.angularjs.org/api/ngMock.$httpBackend - /////////////////////////////////////////////////////////////////////////// - interface IHttpBackendService { - flush(count?: number): void; - resetExpectations(): void; - verifyNoOutstandingExpectation(): void; - verifyNoOutstandingRequest(): void; - - expect(method: string, url: string, data?: any, headers?: any): mock.IRequestHandler; - expect(method: string, url: RegExp, data?: any, headers?: any): mock.IRequestHandler; - expect(method: RegExp, url: string, data?: any, headers?: any): mock.IRequestHandler; - expect(method: RegExp, url: RegExp, data?: any, headers?: any): mock.IRequestHandler; - - when(method: string, url: string, data?: string, headers?: any): mock.IRequestHandler; - when(method: string, url: RegExp, data?: string, headers?: any): mock.IRequestHandler; - when(method: string, url: string, data?: RegExp, headers?: any): mock.IRequestHandler; - when(method: string, url: RegExp, data?: RegExp, headers?: any): mock.IRequestHandler; - when(method: RegExp, url: string, data?: string, headers?: any): mock.IRequestHandler; - when(method: RegExp, url: RegExp, data?: string, headers?: any): mock.IRequestHandler; - when(method: RegExp, url: string, data?: RegExp, headers?: any): mock.IRequestHandler; - when(method: RegExp, url: RegExp, data?: RegExp, headers?: any): mock.IRequestHandler; - - expectDELETE(url: string, headers?: any): mock.IRequestHandler; - expectDELETE(url: RegExp, headers?: any): mock.IRequestHandler; - expectGET(url: string, headers?: any): mock.IRequestHandler; - expectGET(url: RegExp, headers?: any): mock.IRequestHandler; - expectHEAD(url: string, headers?: any): mock.IRequestHandler; - expectHEAD(url: RegExp, headers?: any): mock.IRequestHandler; - expectJSONP(url: string): mock.IRequestHandler; - expectJSONP(url: RegExp): mock.IRequestHandler; - expectPATCH(url: string, data?: any, headers?: any): mock.IRequestHandler; - expectPATCH(url: RegExp, data?: any, headers?: any): mock.IRequestHandler; - expectPOST(url: string, data?: any, headers?: any): mock.IRequestHandler; - expectPOST(url: RegExp, data?: any, headers?: any): mock.IRequestHandler; - expectPUT(url: string, data?: any, headers?: any): mock.IRequestHandler; - expectPUT(url: RegExp, data?: any, headers?: any): mock.IRequestHandler; - - whenDELETE(url: string, headers?: any): mock.IRequestHandler; - whenDELETE(url: RegExp, headers?: any): mock.IRequestHandler; - whenGET(url: string, headers?: any): mock.IRequestHandler; - whenGET(url: RegExp, headers?: any): mock.IRequestHandler; - whenHEAD(url: string, headers?: any): mock.IRequestHandler; - whenHEAD(url: RegExp, headers?: any): mock.IRequestHandler; - whenJSONP(url: string): mock.IRequestHandler; - whenJSONP(url: RegExp): mock.IRequestHandler; - whenPATCH(url: string, data?: string, headers?: any): mock.IRequestHandler; - whenPATCH(url: RegExp, data?: string, headers?: any): mock.IRequestHandler; - whenPATCH(url: string, data?: RegExp, headers?: any): mock.IRequestHandler; - whenPATCH(url: RegExp, data?: RegExp, headers?: any): mock.IRequestHandler; - whenPOST(url: string, data?: string, headers?: any): mock.IRequestHandler; - whenPOST(url: RegExp, data?: string, headers?: any): mock.IRequestHandler; - whenPOST(url: string, data?: RegExp, headers?: any): mock.IRequestHandler; - whenPOST(url: RegExp, data?: RegExp, headers?: any): mock.IRequestHandler; - whenPUT(url: string, data?: string, headers?: any): mock.IRequestHandler; - whenPUT(url: RegExp, data?: string, headers?: any): mock.IRequestHandler; - whenPUT(url: string, data?: RegExp, headers?: any): mock.IRequestHandler; - whenPUT(url: RegExp, data?: RegExp, headers?: any): mock.IRequestHandler; - } - - export module mock { - - // returned interface by the the mocked HttpBackendService expect/when methods - interface IRequestHandler { - respond(func: Function): void; - respond(status: number, data?: any, headers?: any): void; - respond(data: any, headers?: any): void; - - // Available wehn ngMockE2E is loaded - passThrough(): void; - } - - } - -} diff --git a/angular/legacy/angular-mocks-1.2-tests.ts b/angular/legacy/angular-mocks-1.2-tests.ts deleted file mode 100644 index 34e29addc0..0000000000 --- a/angular/legacy/angular-mocks-1.2-tests.ts +++ /dev/null @@ -1,305 +0,0 @@ - - -/////////////////////////////////////// -// IAngularStatic -/////////////////////////////////////// -var angular: ng.IAngularStatic; -var mock: ng.IMockStatic; - -mock = angular.mock; - - -/////////////////////////////////////// -// IMockStatic -/////////////////////////////////////// -var date: Date; - -mock.dump({ key: 'value' }); - -mock.inject( - function () { return 1; }, - function () { return 2; } - ); - -mock.inject( - ['$rootScope', function ($rootScope: ng.IRootScopeService) { return 1; }]); - -// This overload is not documented on the website, but flows from -// how the injector works. -mock.inject( - ['$rootScope', function ($rootScope: ng.IRootScopeService) { return 1; }], - ['$rootScope', function ($rootScope: ng.IRootScopeService) { return 2; }]); - -mock.module('module1', 'module2'); -mock.module( - function () { return 1; }, - function () { return 2; } - ); -mock.module({ module1: function () { return 1; } }); - -date = mock.TzDate(-7, '2013-1-1T15:00:00Z'); -date = mock.TzDate(-8, 12345678); - - -/////////////////////////////////////// -// IExceptionHandlerProvider -/////////////////////////////////////// -var exceptionHandlerProvider: ng.IExceptionHandlerProvider; - -exceptionHandlerProvider.mode('log'); - - -/////////////////////////////////////// -// ITimeoutService -/////////////////////////////////////// -var timeoutService: ng.ITimeoutService; - -timeoutService.flush(); -timeoutService.flush(1234); -timeoutService.flushNext(); -timeoutService.flushNext(1234); -timeoutService.verifyNoPendingTasks(); - -//////////////////////////////////////// -// IIntervalService -//////////////////////////////////////// -var intervalService: ng.IIntervalService; -var intervalServiceTimeActuallyAdvanced: number; - -intervalServiceTimeActuallyAdvanced = intervalService.flush(); -intervalServiceTimeActuallyAdvanced = intervalService.flush(1234); - -/////////////////////////////////////// -// ILogService, ILogCall -/////////////////////////////////////// -var logService: ng.ILogService; -var logCall: ng.ILogCall; -var logs: string[]; - -logService.assertEmpty(); -logService.reset(); - -logCall = logService.debug; -logCall = logService.error; -logCall = logService.info; -logCall = logService.log; -logCall = logService.warn; - -logs = logCall.logs; - - -/////////////////////////////////////// -// IHttpBackendService -/////////////////////////////////////// -var httpBackendService: ng.IHttpBackendService; -var requestHandler: ng.mock.IRequestHandler; - -httpBackendService.flush(); -httpBackendService.flush(1234); -httpBackendService.resetExpectations(); -httpBackendService.verifyNoOutstandingExpectation(); -httpBackendService.verifyNoOutstandingRequest(); - -requestHandler = httpBackendService.expect('GET', 'http://test.local'); -requestHandler = httpBackendService.expect('GET', 'http://test.local', 'response data'); -requestHandler = httpBackendService.expect('GET', 'http://test.local', 'response data', { header: 'value' }); -requestHandler = httpBackendService.expect('GET', 'http://test.local', 'response data', function (headers: Object): boolean { return true; }); -requestHandler = httpBackendService.expect('GET', 'http://test.local', /response data/); -requestHandler = httpBackendService.expect('GET', 'http://test.local', /response data/, { header: 'value' }); -requestHandler = httpBackendService.expect('GET', 'http://test.local', /response data/, function (headers: Object): boolean { return true; }); -requestHandler = httpBackendService.expect('GET', 'http://test.local', function (data: string): boolean { return true; }); -requestHandler = httpBackendService.expect('GET', 'http://test.local', function (data: string): boolean { return true; }, { header: 'value' }); -requestHandler = httpBackendService.expect('GET', 'http://test.local', function (data: string): boolean { return true; }, function (headers: Object): boolean { return true; }); -requestHandler = httpBackendService.expect('GET', 'http://test.local', { key: 'value' }); -requestHandler = httpBackendService.expect('GET', 'http://test.local', { key: 'value' }, { header: 'value' }); -requestHandler = httpBackendService.expect('GET', 'http://test.local', { key: 'value' }, function (headers: Object): boolean { return true; }); -requestHandler = httpBackendService.expect('GET', /test.local/); -requestHandler = httpBackendService.expect('GET', /test.local/, 'response data'); -requestHandler = httpBackendService.expect('GET', /test.local/, 'response data', { header: 'value' }); -requestHandler = httpBackendService.expect('GET', /test.local/, 'response data', function (headers: Object): boolean { return true; }); -requestHandler = httpBackendService.expect('GET', /test.local/, /response data/); -requestHandler = httpBackendService.expect('GET', /test.local/, /response data/, { header: 'value' }); -requestHandler = httpBackendService.expect('GET', /test.local/, /response data/, function (headers: Object): boolean { return true; }); -requestHandler = httpBackendService.expect('GET', /test.local/, function (data: string): boolean { return true; }); -requestHandler = httpBackendService.expect('GET', /test.local/, function (data: string): boolean { return true; }, { header: 'value' }); -requestHandler = httpBackendService.expect('GET', /test.local/, function (data: string): boolean { return true; }, function (headers: Object): boolean { return true; }); -requestHandler = httpBackendService.expect('GET', /test.local/, { key: 'value' }); -requestHandler = httpBackendService.expect('GET', /test.local/, { key: 'value' }, { header: 'value' }); -requestHandler = httpBackendService.expect('GET', /test.local/, { key: 'value' }, function (headers: Object): boolean { return true; }); - -requestHandler = httpBackendService.expectDELETE('http://test.local'); -requestHandler = httpBackendService.expectDELETE('http://test.local', { header: 'value' }); -requestHandler = httpBackendService.expectDELETE(/test.local/, { header: 'value' }); -requestHandler = httpBackendService.expectGET('http://test.local'); -requestHandler = httpBackendService.expectGET('http://test.local', { header: 'value' }); -requestHandler = httpBackendService.expectGET(/test.local/, { header: 'value' }); -requestHandler = httpBackendService.expectHEAD('http://test.local'); -requestHandler = httpBackendService.expectHEAD('http://test.local', { header: 'value' }); -requestHandler = httpBackendService.expectHEAD(/test.local/, { header: 'value' }); -requestHandler = httpBackendService.expectJSONP('http://test.local'); -requestHandler = httpBackendService.expectJSONP(/test.local/); - -requestHandler = httpBackendService.expectPATCH('http://test.local'); -requestHandler = httpBackendService.expectPATCH('http://test.local', 'response data'); -requestHandler = httpBackendService.expectPATCH('http://test.local', 'response data', { header: 'value' }); -requestHandler = httpBackendService.expectPATCH('http://test.local', /response data/); -requestHandler = httpBackendService.expectPATCH('http://test.local', /response data/, { header: 'value' }); -requestHandler = httpBackendService.expectPATCH('http://test.local', function (data: string): boolean { return true; }); -requestHandler = httpBackendService.expectPATCH('http://test.local', function (data: string): boolean { return true; }, { header: 'value' }); -requestHandler = httpBackendService.expectPATCH('http://test.local', { key: 'value' }); -requestHandler = httpBackendService.expectPATCH('http://test.local', { key: 'value' }, { header: 'value' }); -requestHandler = httpBackendService.expectPATCH(/test.local/); -requestHandler = httpBackendService.expectPATCH(/test.local/, 'response data'); -requestHandler = httpBackendService.expectPATCH(/test.local/, 'response data', { header: 'value' }); -requestHandler = httpBackendService.expectPATCH(/test.local/, /response data/); -requestHandler = httpBackendService.expectPATCH(/test.local/, /response data/, { header: 'value' }); -requestHandler = httpBackendService.expectPATCH(/test.local/, function (data: string): boolean { return true; }); -requestHandler = httpBackendService.expectPATCH(/test.local/, function (data: string): boolean { return true; }, { header: 'value' }); -requestHandler = httpBackendService.expectPATCH(/test.local/, { key: 'value' }); -requestHandler = httpBackendService.expectPATCH(/test.local/, { key: 'value' }, { header: 'value' }); - -requestHandler = httpBackendService.expectPOST('http://test.local'); -requestHandler = httpBackendService.expectPOST('http://test.local', 'response data'); -requestHandler = httpBackendService.expectPOST('http://test.local', 'response data', { header: 'value' }); -requestHandler = httpBackendService.expectPOST('http://test.local', /response data/); -requestHandler = httpBackendService.expectPOST('http://test.local', /response data/, { header: 'value' }); -requestHandler = httpBackendService.expectPOST('http://test.local', function (data: string): boolean { return true; }); -requestHandler = httpBackendService.expectPOST('http://test.local', function (data: string): boolean { return true; }, { header: 'value' }); -requestHandler = httpBackendService.expectPOST('http://test.local', { key: 'value' }); -requestHandler = httpBackendService.expectPOST('http://test.local', { key: 'value' }, { header: 'value' }); -requestHandler = httpBackendService.expectPOST(/test.local/); -requestHandler = httpBackendService.expectPOST(/test.local/, 'response data'); -requestHandler = httpBackendService.expectPOST(/test.local/, 'response data', { header: 'value' }); -requestHandler = httpBackendService.expectPOST(/test.local/, /response data/); -requestHandler = httpBackendService.expectPOST(/test.local/, /response data/, { header: 'value' }); -requestHandler = httpBackendService.expectPOST(/test.local/, function (data: string): boolean { return true; }); -requestHandler = httpBackendService.expectPOST(/test.local/, function (data: string): boolean { return true; }, { header: 'value' }); -requestHandler = httpBackendService.expectPOST(/test.local/, { key: 'value' }); -requestHandler = httpBackendService.expectPOST(/test.local/, { key: 'value' }, { header: 'value' }); - -requestHandler = httpBackendService.expectPUT('http://test.local'); -requestHandler = httpBackendService.expectPUT('http://test.local', 'response data'); -requestHandler = httpBackendService.expectPUT('http://test.local', 'response data', { header: 'value' }); -requestHandler = httpBackendService.expectPUT('http://test.local', /response data/); -requestHandler = httpBackendService.expectPUT('http://test.local', /response data/, { header: 'value' }); -requestHandler = httpBackendService.expectPUT('http://test.local', function (data: string): boolean { return true; }); -requestHandler = httpBackendService.expectPUT('http://test.local', function (data: string): boolean { return true; }, { header: 'value' }); -requestHandler = httpBackendService.expectPUT('http://test.local', { key: 'value' }); -requestHandler = httpBackendService.expectPUT('http://test.local', { key: 'value' }, { header: 'value' }); -requestHandler = httpBackendService.expectPUT(/test.local/); -requestHandler = httpBackendService.expectPUT(/test.local/, 'response data'); -requestHandler = httpBackendService.expectPUT(/test.local/, 'response data', { header: 'value' }); -requestHandler = httpBackendService.expectPUT(/test.local/, /response data/); -requestHandler = httpBackendService.expectPUT(/test.local/, /response data/, { header: 'value' }); -requestHandler = httpBackendService.expectPUT(/test.local/, function (data: string): boolean { return true; }); -requestHandler = httpBackendService.expectPUT(/test.local/, function (data: string): boolean { return true; }, { header: 'value' }); -requestHandler = httpBackendService.expectPUT(/test.local/, { key: 'value' }); -requestHandler = httpBackendService.expectPUT(/test.local/, { key: 'value' }, { header: 'value' }); - -requestHandler = httpBackendService.when('GET', 'http://test.local'); -requestHandler = httpBackendService.when('GET', 'http://test.local', 'response data'); -requestHandler = httpBackendService.when('GET', 'http://test.local', 'response data', { header: 'value' }); -requestHandler = httpBackendService.when('GET', 'http://test.local', 'response data', function (headers: Object): boolean { return true; }); -requestHandler = httpBackendService.when('GET', 'http://test.local', /response data/); -requestHandler = httpBackendService.when('GET', 'http://test.local', /response data/, { header: 'value' }); -requestHandler = httpBackendService.when('GET', 'http://test.local', /response data/, function (headers: Object): boolean { return true; }); -requestHandler = httpBackendService.when('GET', 'http://test.local', function (data: string): boolean { return true; }); -requestHandler = httpBackendService.when('GET', 'http://test.local', function (data: string): boolean { return true; }, { header: 'value' }); -requestHandler = httpBackendService.when('GET', 'http://test.local', function (data: string): boolean { return true; }, function (headers: Object): boolean { return true; }); -requestHandler = httpBackendService.when('GET', 'http://test.local', { key: 'value' }); -requestHandler = httpBackendService.when('GET', 'http://test.local', { key: 'value' }, { header: 'value' }); -requestHandler = httpBackendService.when('GET', 'http://test.local', { key: 'value' }, function (headers: Object): boolean { return true; }); -requestHandler = httpBackendService.when('GET', /test.local/); -requestHandler = httpBackendService.when('GET', /test.local/, 'response data'); -requestHandler = httpBackendService.when('GET', /test.local/, 'response data', { header: 'value' }); -requestHandler = httpBackendService.when('GET', /test.local/, 'response data', function (headers: Object): boolean { return true; }); -requestHandler = httpBackendService.when('GET', /test.local/, /response data/); -requestHandler = httpBackendService.when('GET', /test.local/, /response data/, { header: 'value' }); -requestHandler = httpBackendService.when('GET', /test.local/, /response data/, function (headers: Object): boolean { return true; }); -requestHandler = httpBackendService.when('GET', /test.local/, function (data: string): boolean { return true; }); -requestHandler = httpBackendService.when('GET', /test.local/, function (data: string): boolean { return true; }, { header: 'value' }); -requestHandler = httpBackendService.when('GET', /test.local/, function (data: string): boolean { return true; }, function (headers: Object): boolean { return true; }); -requestHandler = httpBackendService.when('GET', /test.local/, { key: 'value' }); -requestHandler = httpBackendService.when('GET', /test.local/, { key: 'value' }, { header: 'value' }); -requestHandler = httpBackendService.when('GET', /test.local/, { key: 'value' }, function (headers: Object): boolean { return true; }); - -requestHandler = httpBackendService.whenDELETE('http://test.local'); -requestHandler = httpBackendService.whenDELETE('http://test.local', { header: 'value' }); -requestHandler = httpBackendService.whenDELETE(/test.local/, { header: 'value' }); -requestHandler = httpBackendService.whenGET('http://test.local'); -requestHandler = httpBackendService.whenGET('http://test.local', { header: 'value' }); -requestHandler = httpBackendService.whenGET(/test.local/, { header: 'value' }); -requestHandler = httpBackendService.whenHEAD('http://test.local'); -requestHandler = httpBackendService.whenHEAD('http://test.local', { header: 'value' }); -requestHandler = httpBackendService.whenHEAD(/test.local/, { header: 'value' }); -requestHandler = httpBackendService.whenJSONP('http://test.local'); -requestHandler = httpBackendService.whenJSONP(/test.local/); - -requestHandler = httpBackendService.whenPATCH('http://test.local'); -requestHandler = httpBackendService.whenPATCH('http://test.local', 'response data'); -requestHandler = httpBackendService.whenPATCH('http://test.local', 'response data', { header: 'value' }); -requestHandler = httpBackendService.whenPATCH('http://test.local', /response data/); -requestHandler = httpBackendService.whenPATCH('http://test.local', /response data/, { header: 'value' }); -requestHandler = httpBackendService.whenPATCH('http://test.local', function (data: string): boolean { return true; }); -requestHandler = httpBackendService.whenPATCH('http://test.local', function (data: string): boolean { return true; }, { header: 'value' }); -requestHandler = httpBackendService.whenPATCH('http://test.local', { key: 'value' }); -requestHandler = httpBackendService.whenPATCH('http://test.local', { key: 'value' }, { header: 'value' }); -requestHandler = httpBackendService.whenPATCH(/test.local/); -requestHandler = httpBackendService.whenPATCH(/test.local/, 'response data'); -requestHandler = httpBackendService.whenPATCH(/test.local/, 'response data', { header: 'value' }); -requestHandler = httpBackendService.whenPATCH(/test.local/, /response data/); -requestHandler = httpBackendService.whenPATCH(/test.local/, /response data/, { header: 'value' }); -requestHandler = httpBackendService.whenPATCH(/test.local/, function (data: string): boolean { return true; }); -requestHandler = httpBackendService.whenPATCH(/test.local/, function (data: string): boolean { return true; }, { header: 'value' }); -requestHandler = httpBackendService.whenPATCH(/test.local/, { key: 'value' }); -requestHandler = httpBackendService.whenPATCH(/test.local/, { key: 'value' }, { header: 'value' }); - -requestHandler = httpBackendService.whenPOST('http://test.local'); -requestHandler = httpBackendService.whenPOST('http://test.local', 'response data'); -requestHandler = httpBackendService.whenPOST('http://test.local', 'response data', { header: 'value' }); -requestHandler = httpBackendService.whenPOST('http://test.local', /response data/); -requestHandler = httpBackendService.whenPOST('http://test.local', /response data/, { header: 'value' }); -requestHandler = httpBackendService.whenPOST('http://test.local', function (data: string): boolean { return true; }); -requestHandler = httpBackendService.whenPOST('http://test.local', function (data: string): boolean { return true; }, { header: 'value' }); -requestHandler = httpBackendService.whenPOST('http://test.local', { key: 'value' }); -requestHandler = httpBackendService.whenPOST('http://test.local', { key: 'value' }, { header: 'value' }); -requestHandler = httpBackendService.whenPOST(/test.local/); -requestHandler = httpBackendService.whenPOST(/test.local/, 'response data'); -requestHandler = httpBackendService.whenPOST(/test.local/, 'response data', { header: 'value' }); -requestHandler = httpBackendService.whenPOST(/test.local/, /response data/); -requestHandler = httpBackendService.whenPOST(/test.local/, /response data/, { header: 'value' }); -requestHandler = httpBackendService.whenPOST(/test.local/, function (data: string): boolean { return true; }); -requestHandler = httpBackendService.whenPOST(/test.local/, function (data: string): boolean { return true; }, { header: 'value' }); -requestHandler = httpBackendService.whenPOST(/test.local/, { key: 'value' }); -requestHandler = httpBackendService.whenPOST(/test.local/, { key: 'value' }, { header: 'value' }); - -requestHandler = httpBackendService.whenPUT('http://test.local'); -requestHandler = httpBackendService.whenPUT('http://test.local', 'response data'); -requestHandler = httpBackendService.whenPUT('http://test.local', 'response data', { header: 'value' }); -requestHandler = httpBackendService.whenPUT('http://test.local', /response data/); -requestHandler = httpBackendService.whenPUT('http://test.local', /response data/, { header: 'value' }); -requestHandler = httpBackendService.whenPUT('http://test.local', function (data: string): boolean { return true; }); -requestHandler = httpBackendService.whenPUT('http://test.local', function (data: string): boolean { return true; }, { header: 'value' }); -requestHandler = httpBackendService.whenPUT('http://test.local', { key: 'value' }); -requestHandler = httpBackendService.whenPUT('http://test.local', { key: 'value' }, { header: 'value' }); -requestHandler = httpBackendService.whenPUT(/test.local/); -requestHandler = httpBackendService.whenPUT(/test.local/, 'response data'); -requestHandler = httpBackendService.whenPUT(/test.local/, 'response data', { header: 'value' }); -requestHandler = httpBackendService.whenPUT(/test.local/, /response data/); -requestHandler = httpBackendService.whenPUT(/test.local/, /response data/, { header: 'value' }); -requestHandler = httpBackendService.whenPUT(/test.local/, function (data: string): boolean { return true; }); -requestHandler = httpBackendService.whenPUT(/test.local/, function (data: string): boolean { return true; }, { header: 'value' }); -requestHandler = httpBackendService.whenPUT(/test.local/, { key: 'value' }); -requestHandler = httpBackendService.whenPUT(/test.local/, { key: 'value' }, { header: 'value' }); - - -/////////////////////////////////////// -// IRequestHandler -/////////////////////////////////////// -requestHandler.passThrough(); -requestHandler.respond(function () { }); -requestHandler.respond({ key: 'value' }); -requestHandler.respond({ key: 'value' }, { header: 'value' }); -requestHandler.respond(404); -requestHandler.respond(404, { key: 'value' }); -requestHandler.respond(404, { key: 'value' }, { header: 'value' }); diff --git a/angular/legacy/angular-mocks-1.2.d.ts b/angular/legacy/angular-mocks-1.2.d.ts deleted file mode 100644 index 3b4f7e0405..0000000000 --- a/angular/legacy/angular-mocks-1.2.d.ts +++ /dev/null @@ -1,226 +0,0 @@ -// Type definitions for Angular JS 1.2 (ngMock, ngMockE2E module) -// Project: http://angularjs.org -// Definitions by: Diego Vilar -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - - - -/////////////////////////////////////////////////////////////////////////////// -// functions attached to global object (window) -/////////////////////////////////////////////////////////////////////////////// -declare var module: (...modules: any[]) => any; -declare var inject: (...fns: Function[]) => any; - -/////////////////////////////////////////////////////////////////////////////// -// ngMock module (angular-mocks.js) -/////////////////////////////////////////////////////////////////////////////// -declare namespace ng { - - /////////////////////////////////////////////////////////////////////////// - // AngularStatic - // We reopen it to add the MockStatic definition - /////////////////////////////////////////////////////////////////////////// - interface IAngularStatic { - mock: IMockStatic; - } - - interface IMockStatic { - // see https://code.angularjs.org/1.2.26/docs/api/ngMock/function/angular.mock.dump - dump(obj: any): string; - - // see https://code.angularjs.org/1.2.26/docs/api/ngMock/function/angular.mock.inject - inject(...fns: Function[]): any; - inject(...inlineAnnotatedConstructor: any[]): any; // this overload is undocumented, but works - - // see https://code.angularjs.org/1.2.26/docs/api/ngMock/function/angular.mock.module - module(...modules: any[]): any; - - // see https://code.angularjs.org/1.2.26/docs/api/ngMock/type/angular.mock.TzDate - TzDate(offset: number, timestamp: number): Date; - TzDate(offset: number, timestamp: string): Date; - } - - /////////////////////////////////////////////////////////////////////////// - // ExceptionHandlerService - // see https://code.angularjs.org/1.2.26/docs/api/ngMock/service/$exceptionHandler - // see https://code.angularjs.org/1.2.26/docs/api/ngMock/provider/$exceptionHandlerProvider - /////////////////////////////////////////////////////////////////////////// - interface IExceptionHandlerProvider extends IServiceProvider { - mode(mode: string): void; - } - - /////////////////////////////////////////////////////////////////////////// - // TimeoutService - // see https://code.angularjs.org/1.2.26/docs/api/ngMock/service/$timeout - // Augments the original service - /////////////////////////////////////////////////////////////////////////// - interface ITimeoutService { - flush(delay?: number): void; - flushNext(expectedDelay?: number): void; - verifyNoPendingTasks(): void; - } - - /////////////////////////////////////////////////////////////////////////// - // IntervalService - // see https://code.angularjs.org/1.2.26/docs/api/ngMock/service/$interval - // Augments the original service - /////////////////////////////////////////////////////////////////////////// - interface IIntervalService { - flush(millis?: number): number; - } - - /////////////////////////////////////////////////////////////////////////// - // LogService - // see https://code.angularjs.org/1.2.26/docs/api/ngMock/service/$log - // Augments the original service - /////////////////////////////////////////////////////////////////////////// - interface ILogService { - assertEmpty(): void; - reset(): void; - } - - interface ILogCall { - logs: string[]; - } - - /////////////////////////////////////////////////////////////////////////// - // HttpBackendService - // see https://code.angularjs.org/1.2.26/docs/api/ngMock/service/$httpBackend - /////////////////////////////////////////////////////////////////////////// - interface IHttpBackendService { - flush(count?: number): void; - resetExpectations(): void; - verifyNoOutstandingExpectation(): void; - verifyNoOutstandingRequest(): void; - - expect(method: string, url: string, data?: string, headers?: Object): mock.IRequestHandler; - expect(method: string, url: string, data?: string, headers?: (object: Object) => boolean): mock.IRequestHandler; - expect(method: string, url: string, data?: RegExp, headers?: Object): mock.IRequestHandler; - expect(method: string, url: string, data?: RegExp, headers?: (object: Object) => boolean): mock.IRequestHandler; - expect(method: string, url: string, data?: (data: string) => boolean, headers?: Object): mock.IRequestHandler; - expect(method: string, url: string, data?: (data: string) => boolean, headers?: (object: Object) => boolean): mock.IRequestHandler; - expect(method: string, url: string, data?: Object, headers?: Object): mock.IRequestHandler; - expect(method: string, url: string, data?: Object, headers?: (object: Object) => boolean): mock.IRequestHandler; - expect(method: string, url: RegExp, data?: string, headers?: Object): mock.IRequestHandler; - expect(method: string, url: RegExp, data?: string, headers?: (object: Object) => boolean): mock.IRequestHandler; - expect(method: string, url: RegExp, data?: RegExp, headers?: Object): mock.IRequestHandler; - expect(method: string, url: RegExp, data?: RegExp, headers?: (object: Object) => boolean): mock.IRequestHandler; - expect(method: string, url: RegExp, data?: (data: string) => boolean, headers?: Object): mock.IRequestHandler; - expect(method: string, url: RegExp, data?: (data: string) => boolean, headers?: (object: Object) => boolean): mock.IRequestHandler; - expect(method: string, url: RegExp, data?: Object, headers?: Object): mock.IRequestHandler; - expect(method: string, url: RegExp, data?: Object, headers?: (object: Object) => boolean): mock.IRequestHandler; - - expectDELETE(url: string, headers?: Object): mock.IRequestHandler; - expectDELETE(url: RegExp, headers?: Object): mock.IRequestHandler; - expectGET(url: string, headers?: Object): mock.IRequestHandler; - expectGET(url: RegExp, headers?: Object): mock.IRequestHandler; - expectHEAD(url: string, headers?: Object): mock.IRequestHandler; - expectHEAD(url: RegExp, headers?: Object): mock.IRequestHandler; - expectJSONP(url: string): mock.IRequestHandler; - expectJSONP(url: RegExp): mock.IRequestHandler; - - expectPATCH(url: string, data?: string, headers?: Object): mock.IRequestHandler; - expectPATCH(url: string, data?: RegExp, headers?: Object): mock.IRequestHandler; - expectPATCH(url: string, data?: (data: string) => boolean, headers?: Object): mock.IRequestHandler; - expectPATCH(url: string, data?: Object, headers?: Object): mock.IRequestHandler; - expectPATCH(url: RegExp, data?: string, headers?: Object): mock.IRequestHandler; - expectPATCH(url: RegExp, data?: RegExp, headers?: Object): mock.IRequestHandler; - expectPATCH(url: RegExp, data?: (data: string) => boolean, headers?: Object): mock.IRequestHandler; - expectPATCH(url: RegExp, data?: Object, headers?: Object): mock.IRequestHandler; - - expectPOST(url: string, data?: string, headers?: Object): mock.IRequestHandler; - expectPOST(url: string, data?: RegExp, headers?: Object): mock.IRequestHandler; - expectPOST(url: string, data?: (data: string) => boolean, headers?: Object): mock.IRequestHandler; - expectPOST(url: string, data?: Object, headers?: Object): mock.IRequestHandler; - expectPOST(url: RegExp, data?: string, headers?: Object): mock.IRequestHandler; - expectPOST(url: RegExp, data?: RegExp, headers?: Object): mock.IRequestHandler; - expectPOST(url: RegExp, data?: (data: string) => boolean, headers?: Object): mock.IRequestHandler; - expectPOST(url: RegExp, data?: Object, headers?: Object): mock.IRequestHandler; - - expectPUT(url: string, data?: string, headers?: Object): mock.IRequestHandler; - expectPUT(url: string, data?: RegExp, headers?: Object): mock.IRequestHandler; - expectPUT(url: string, data?: (data: string) => boolean, headers?: Object): mock.IRequestHandler; - expectPUT(url: string, data?: Object, headers?: Object): mock.IRequestHandler; - expectPUT(url: RegExp, data?: string, headers?: Object): mock.IRequestHandler; - expectPUT(url: RegExp, data?: RegExp, headers?: Object): mock.IRequestHandler; - expectPUT(url: RegExp, data?: (data: string) => boolean, headers?: Object): mock.IRequestHandler; - expectPUT(url: RegExp, data?: Object, headers?: Object): mock.IRequestHandler; - - when(method: string, url: string, data?: string, headers?: Object): mock.IRequestHandler; - when(method: string, url: string, data?: string, headers?: (object: Object) => boolean): mock.IRequestHandler; - when(method: string, url: string, data?: RegExp, headers?: Object): mock.IRequestHandler; - when(method: string, url: string, data?: RegExp, headers?: (object: Object) => boolean): mock.IRequestHandler; - when(method: string, url: string, data?: (data: string) => boolean, headers?: Object): mock.IRequestHandler; - when(method: string, url: string, data?: (data: string) => boolean, headers?: (object: Object) => boolean): mock.IRequestHandler; - when(method: string, url: string, data?: Object, headers?: Object): mock.IRequestHandler; - when(method: string, url: string, data?: Object, headers?: (object: Object) => boolean): mock.IRequestHandler; - when(method: string, url: RegExp, data?: string, headers?: Object): mock.IRequestHandler; - when(method: string, url: RegExp, data?: string, headers?: (object: Object) => boolean): mock.IRequestHandler; - when(method: string, url: RegExp, data?: RegExp, headers?: Object): mock.IRequestHandler; - when(method: string, url: RegExp, data?: RegExp, headers?: (object: Object) => boolean): mock.IRequestHandler; - when(method: string, url: RegExp, data?: (data: string) => boolean, headers?: Object): mock.IRequestHandler; - when(method: string, url: RegExp, data?: (data: string) => boolean, headers?: (object: Object) => boolean): mock.IRequestHandler; - when(method: string, url: RegExp, data?: Object, headers?: Object): mock.IRequestHandler; - when(method: string, url: RegExp, data?: Object, headers?: (object: Object) => boolean): mock.IRequestHandler; - - whenDELETE(url: string, headers?: Object): mock.IRequestHandler; - whenDELETE(url: string, headers?: (object: Object) => boolean): mock.IRequestHandler; - whenDELETE(url: RegExp, headers?: Object): mock.IRequestHandler; - whenDELETE(url: RegExp, headers?: (object: Object) => boolean): mock.IRequestHandler; - - whenGET(url: string, headers?: Object): mock.IRequestHandler; - whenGET(url: string, headers?: (object: Object) => boolean): mock.IRequestHandler; - whenGET(url: RegExp, headers?: Object): mock.IRequestHandler; - whenGET(url: RegExp, headers?: (object: Object) => boolean): mock.IRequestHandler; - - whenHEAD(url: string, headers?: Object): mock.IRequestHandler; - whenHEAD(url: string, headers?: (object: Object) => boolean): mock.IRequestHandler; - whenHEAD(url: RegExp, headers?: Object): mock.IRequestHandler; - whenHEAD(url: RegExp, headers?: (object: Object) => boolean): mock.IRequestHandler; - - whenJSONP(url: string): mock.IRequestHandler; - whenJSONP(url: RegExp): mock.IRequestHandler; - - whenPATCH(url: string, data?: string, headers?: Object): mock.IRequestHandler; - whenPATCH(url: string, data?: RegExp, headers?: Object): mock.IRequestHandler; - whenPATCH(url: string, data?: (data: string) => boolean, headers?: Object): mock.IRequestHandler; - whenPATCH(url: string, data?: Object, headers?: Object): mock.IRequestHandler; - whenPATCH(url: RegExp, data?: string, headers?: Object): mock.IRequestHandler; - whenPATCH(url: RegExp, data?: RegExp, headers?: Object): mock.IRequestHandler; - whenPATCH(url: RegExp, data?: (data: string) => boolean, headers?: Object): mock.IRequestHandler; - whenPATCH(url: RegExp, data?: Object, headers?: Object): mock.IRequestHandler; - - whenPOST(url: string, data?: string, headers?: Object): mock.IRequestHandler; - whenPOST(url: string, data?: RegExp, headers?: Object): mock.IRequestHandler; - whenPOST(url: string, data?: (data: string) => boolean, headers?: Object): mock.IRequestHandler; - whenPOST(url: string, data?: Object, headers?: Object): mock.IRequestHandler; - whenPOST(url: RegExp, data?: string, headers?: Object): mock.IRequestHandler; - whenPOST(url: RegExp, data?: RegExp, headers?: Object): mock.IRequestHandler; - whenPOST(url: RegExp, data?: (data: string) => boolean, headers?: Object): mock.IRequestHandler; - whenPOST(url: RegExp, data?: Object, headers?: Object): mock.IRequestHandler; - - whenPUT(url: string, data?: string, headers?: Object): mock.IRequestHandler; - whenPUT(url: string, data?: RegExp, headers?: Object): mock.IRequestHandler; - whenPUT(url: string, data?: (data: string) => boolean, headers?: Object): mock.IRequestHandler; - whenPUT(url: string, data?: Object, headers?: Object): mock.IRequestHandler; - whenPUT(url: RegExp, data?: string, headers?: Object): mock.IRequestHandler; - whenPUT(url: RegExp, data?: RegExp, headers?: Object): mock.IRequestHandler; - whenPUT(url: RegExp, data?: (data: string) => boolean, headers?: Object): mock.IRequestHandler; - whenPUT(url: RegExp, data?: Object, headers?: Object): mock.IRequestHandler; - } - - export module mock { - - // returned interface by the the mocked HttpBackendService expect/when methods - interface IRequestHandler { - respond(func: Function): void; - respond(status: number, data?: any, headers?: any): void; - respond(data: any, headers?: any): void; - - // Available wehn ngMockE2E is loaded - passThrough(): void; - } - - } - -} diff --git a/angular/legacy/angular-resource-1.0.d.ts b/angular/legacy/angular-resource-1.0.d.ts deleted file mode 100644 index 88ea0adcd8..0000000000 --- a/angular/legacy/angular-resource-1.0.d.ts +++ /dev/null @@ -1,82 +0,0 @@ -// Type definitions for Angular JS 1.0 (ngResource module) -// Project: http://angularjs.org -// Definitions by: Diego Vilar -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - - - - -/////////////////////////////////////////////////////////////////////////////// -// ngResource module (angular-resource.js) -/////////////////////////////////////////////////////////////////////////////// -declare namespace ng.resource { - - /////////////////////////////////////////////////////////////////////////// - // ResourceService - // see http://docs.angularjs.org/api/ngResource.$resource - // Most part of the following definitions were achieved by analyzing the - // actual implementation, since the documentation doesn't seem to cover - // that deeply. - /////////////////////////////////////////////////////////////////////////// - interface IResourceService { - (url: string, paramDefaults?: any, - /** example: {update: { method: 'PUT' }, delete: deleteDescriptor } - where deleteDescriptor : IActionDescriptor */ - actionDescriptors?: any): IResourceClass; - } - - // Just a reference to facilitate describing new actions - interface IActionDescriptor { - method: string; - isArray?: boolean; - params?: any; - headers?: any; - } - - // Baseclass for everyresource with default actions. - // If you define your new actions for the resource, you will need - // to extend this interface and typecast the ResourceClass to it. - interface IResourceClass { - get: IActionCall; - save: IActionCall; - query: IActionCall; - remove: IActionCall; - delete: IActionCall; - } - - // In case of passing the first argument as anything but a function, - // it's gonna be considered data if the action method is POST, PUT or - // PATCH (in other words, methods with body). Otherwise, it's going - // to be considered as parameters to the request. - interface IActionCall { - (): IResource; - (dataOrParams: any): IResource; - (dataOrParams: any, success: Function): IResource; - (success: Function, error?: Function): IResource; - (params: any, data: any, success?: Function, error?: Function): IResource; - } - - interface IResource { - $save: IActionCall; - $remove: IActionCall; - $delete: IActionCall; - - // No documented, but they are there, just as any custom action will be - $query: IActionCall; - $get: IActionCall; - } - - /** when creating a resource factory via IModule.factory */ - interface IResourceServiceFactoryFunction { - ($resource: ng.resource.IResourceService): ng.resource.IResourceClass; - } -} - -/** extensions to base ng based on using angular-resource */ -declare namespace ng { - - interface IModule { - /** creating a resource service factory */ - factory(name: string, resourceServiceFactoryFunction: ng.resource.IResourceServiceFactoryFunction): IModule; - } -} diff --git a/angular/legacy/angular-resource-1.2-tests.ts b/angular/legacy/angular-resource-1.2-tests.ts deleted file mode 100644 index f79b4752d3..0000000000 --- a/angular/legacy/angular-resource-1.2-tests.ts +++ /dev/null @@ -1,138 +0,0 @@ - - -interface IMyResource extends ng.resource.IResource { }; -interface IMyResourceClass extends ng.resource.IResourceClass { }; - -/////////////////////////////////////// -// IActionDescriptor -/////////////////////////////////////// -var actionDescriptor: ng.resource.IActionDescriptor; - -actionDescriptor.headers = { header: 'value' }; -actionDescriptor.isArray = true; -actionDescriptor.method = 'method action'; -actionDescriptor.params = { key: 'value' }; - - -/////////////////////////////////////// -// IResourceClass -/////////////////////////////////////// -var resourceClass: IMyResourceClass; -var resource: IMyResource; -var resourceArray: ng.resource.IResourceArray; - -resource = resourceClass.delete(); -resource = resourceClass.delete({ key: 'value' }); -resource = resourceClass.delete({ key: 'value' }, function () { }); -resource = resourceClass.delete(function () { }); -resource = resourceClass.delete(function () { }, function () { }); -resource = resourceClass.delete({ key: 'value' }, { key: 'value' }); -resource = resourceClass.delete({ key: 'value' }, { key: 'value' }, function () { }); -resource = resourceClass.delete({ key: 'value' }, { key: 'value' }, function () { }, function () { }); -resource.$promise.then(function(data: IMyResource) {}); - -resource = resourceClass.get(); -resource = resourceClass.get({ key: 'value' }); -resource = resourceClass.get({ key: 'value' }, function () { }); -resource = resourceClass.get(function () { }); -resource = resourceClass.get(function () { }, function () { }); -resource = resourceClass.get({ key: 'value' }, { key: 'value' }); -resource = resourceClass.get({ key: 'value' }, { key: 'value' }, function () { }); -resource = resourceClass.get({ key: 'value' }, { key: 'value' }, function () { }, function () { }); - -resourceArray = resourceClass.query(); -resourceArray = resourceClass.query({ key: 'value' }); -resourceArray = resourceClass.query({ key: 'value' }, function () { }); -resourceArray = resourceClass.query(function () { }); -resourceArray = resourceClass.query(function () { }, function () { }); -resourceArray = resourceClass.query({ key: 'value' }, { key: 'value' }); -resourceArray = resourceClass.query({ key: 'value' }, { key: 'value' }, function () { }); -resourceArray = resourceClass.query({ key: 'value' }, { key: 'value' }, function () { }, function () { }); -resourceArray.push(resource); -resourceArray.$promise.then(function(data: ng.resource.IResourceArray) {}); - -resource = resourceClass.remove(); -resource = resourceClass.remove({ key: 'value' }); -resource = resourceClass.remove({ key: 'value' }, function () { }); -resource = resourceClass.remove(function () { }); -resource = resourceClass.remove(function () { }, function () { }); -resource = resourceClass.remove({ key: 'value' }, { key: 'value' }); -resource = resourceClass.remove({ key: 'value' }, { key: 'value' }, function () { }); -resource = resourceClass.remove({ key: 'value' }, { key: 'value' }, function () { }, function () { }); - -resource = resourceClass.save(); -resource = resourceClass.save({ key: 'value' }); -resource = resourceClass.save({ key: 'value' }, function () { }); -resource = resourceClass.save(function () { }); -resource = resourceClass.save(function () { }, function () { }); -resource = resourceClass.save({ key: 'value' }, { key: 'value' }); -resource = resourceClass.save({ key: 'value' }, { key: 'value' }, function () { }); -resource = resourceClass.save({ key: 'value' }, { key: 'value' }, function () { }, function () { }); - -/////////////////////////////////////// -// IResource -/////////////////////////////////////// - -var promise : ng.IPromise; -var arrayPromise : ng.IPromise; - -promise = resource.$delete(); -promise = resource.$delete({ key: 'value' }); -promise = resource.$delete({ key: 'value' }, function () { }); -promise = resource.$delete(function () { }); -promise = resource.$delete(function () { }, function () { }); -promise = resource.$delete({ key: 'value' }, function () { }, function () { }); -promise.then(function(data: IMyResource) {}); - -promise = resource.$get(); -promise = resource.$get({ key: 'value' }); -promise = resource.$get({ key: 'value' }, function () { }); -promise = resource.$get(function () { }); -promise = resource.$get(function () { }, function () { }); -promise = resource.$get({ key: 'value' }, function () { }, function () { }); - -arrayPromise = resourceArray[0].$query(); -arrayPromise = resourceArray[0].$query({ key: 'value' }); -arrayPromise = resourceArray[0].$query({ key: 'value' }, function () { }); -arrayPromise = resourceArray[0].$query(function () { }); -arrayPromise = resourceArray[0].$query(function () { }, function () { }); -arrayPromise = resourceArray[0].$query({ key: 'value' }, function () { }, function () { }); -arrayPromise.then(function(data: ng.resource.IResourceArray) {}); - -promise = resource.$remove(); -promise = resource.$remove({ key: 'value' }); -promise = resource.$remove({ key: 'value' }, function () { }); -promise = resource.$remove(function () { }); -promise = resource.$remove(function () { }, function () { }); -promise = resource.$remove({ key: 'value' }, function () { }, function () { }); - -promise = resource.$save(); -promise = resource.$save({ key: 'value' }); -promise = resource.$save({ key: 'value' }, function () { }); -promise = resource.$save(function () { }); -promise = resource.$save(function () { }, function () { }); -promise = resource.$save({ key: 'value' }, function () { }, function () { }); - -/////////////////////////////////////// -// IResourceService -/////////////////////////////////////// -var resourceService: ng.resource.IResourceService; -resourceClass = resourceService('test'); -resourceClass = resourceService('test'); -resourceClass = resourceService('test'); - -/////////////////////////////////////// -// IModule -/////////////////////////////////////// -var mod: ng.IModule; -var resourceServiceFactoryFunction: ng.resource.IResourceServiceFactoryFunction; -var resourceService: ng.resource.IResourceService; - -resourceClass = resourceServiceFactoryFunction(resourceService); - -resourceServiceFactoryFunction = function (resourceService: ng.resource.IResourceService) { return resourceClass; }; -mod = mod.factory('factory name', resourceServiceFactoryFunction); - -/////////////////////////////////////// -// IResource -/////////////////////////////////////// \ No newline at end of file diff --git a/angular/legacy/angular-resource-1.2.d.ts b/angular/legacy/angular-resource-1.2.d.ts deleted file mode 100644 index 5270037426..0000000000 --- a/angular/legacy/angular-resource-1.2.d.ts +++ /dev/null @@ -1,152 +0,0 @@ -// Type definitions for Angular JS 1.2 (ngResource module) -// Project: http://angularjs.org -// Definitions by: Diego Vilar , Michael Jess -// Definitions: https://github.com/daptiv/DefinitelyTyped - - - - -/////////////////////////////////////////////////////////////////////////////// -// ngResource module (angular-resource.js) -/////////////////////////////////////////////////////////////////////////////// -declare namespace ng.resource { - - /////////////////////////////////////////////////////////////////////////// - // ResourceService - // see https://code.angularjs.org/1.2.26/docs/api/ngResource/service/$resource - // Most of the following definitions were achieved by analyzing the - // actual implementation, since the documentation doesn't seem to cover - // that deeply. - /////////////////////////////////////////////////////////////////////////// - interface IResourceService { - (url: string, paramDefaults?: any, - /** example: {update: { method: 'PUT' }, delete: deleteDescriptor } - where deleteDescriptor : IActionDescriptor */ - actionDescriptors?: any): IResourceClass>; - (url: string, paramDefaults?: any, - /** example: {update: { method: 'PUT' }, delete: deleteDescriptor } - where deleteDescriptor : IActionDescriptor */ - actionDescriptors?: any): U; - (url: string, paramDefaults?: any, - /** example: {update: { method: 'PUT' }, delete: deleteDescriptor } - where deleteDescriptor : IActionDescriptor */ - actionDescriptors?: any): IResourceClass; - } - - // Just a reference to facilitate describing new actions - interface IActionDescriptor { - method: string; - isArray?: boolean; - params?: any; - headers?: any; - } - - // Baseclass for everyresource with default actions. - // If you define your new actions for the resource, you will need - // to extend this interface and typecast the ResourceClass to it. - // - // In case of passing the first argument as anything but a function, - // it's gonna be considered data if the action method is POST, PUT or - // PATCH (in other words, methods with body). Otherwise, it's going - // to be considered as parameters to the request. - // https://github.com/angular/angular.js/blob/v1.2.0/src/ngResource/resource.js#L461-L465 - // - // Only those methods with an HTTP body do have 'data' as first parameter: - // https://github.com/angular/angular.js/blob/v1.2.0/src/ngResource/resource.js#L463 - // More specifically, those methods are POST, PUT and PATCH: - // https://github.com/angular/angular.js/blob/v1.2.0/src/ngResource/resource.js#L432 - // - // Also, static calls always return the IResource (or IResourceArray) retrieved - // https://github.com/angular/angular.js/blob/v1.2.0/src/ngResource/resource.js#L538-L549 - interface IResourceClass { - new(dataOrParams? : any) : T; - get(): T; - get(params: Object): T; - get(success: Function, error?: Function): T; - get(params: Object, success: Function, error?: Function): T; - get(params: Object, data: Object, success?: Function, error?: Function): T; - - query(): IResourceArray; - query(params: Object): IResourceArray; - query(success: Function, error?: Function): IResourceArray; - query(params: Object, success: Function, error?: Function): IResourceArray; - query(params: Object, data: Object, success?: Function, error?: Function): IResourceArray; - - save(): T; - save(data: Object): T; - save(success: Function, error?: Function): T; - save(data: Object, success: Function, error?: Function): T; - save(params: Object, data: Object, success?: Function, error?: Function): T; - - remove(): T; - remove(params: Object): T; - remove(success: Function, error?: Function): T; - remove(params: Object, success: Function, error?: Function): T; - remove(params: Object, data: Object, success?: Function, error?: Function): T; - - delete(): T; - delete(params: Object): T; - delete(success: Function, error?: Function): T; - delete(params: Object, success: Function, error?: Function): T; - delete(params: Object, data: Object, success?: Function, error?: Function): T; - } - - // Instance calls always return the the promise of the request which retrieved the object - // https://github.com/angular/angular.js/blob/v1.2.0/src/ngResource/resource.js#L538-L546 - interface IResource { - $get(): ng.IPromise; - $get(params?: Object, success?: Function, error?: Function): ng.IPromise; - $get(success: Function, error?: Function): ng.IPromise; - - $query(): ng.IPromise>; - $query(params?: Object, success?: Function, error?: Function): ng.IPromise>; - $query(success: Function, error?: Function): ng.IPromise>; - - $save(): ng.IPromise; - $save(params?: Object, success?: Function, error?: Function): ng.IPromise; - $save(success: Function, error?: Function): ng.IPromise; - - $remove(): ng.IPromise; - $remove(params?: Object, success?: Function, error?: Function): ng.IPromise; - $remove(success: Function, error?: Function): ng.IPromise; - - $delete(): ng.IPromise; - $delete(params?: Object, success?: Function, error?: Function): ng.IPromise; - $delete(success: Function, error?: Function): ng.IPromise; - - /** the promise of the original server interaction that created this instance. **/ - $promise : ng.IPromise; - $resolved : boolean; - } - - /** - * Really just a regular Array object with $promise and $resolve attached to it - */ - interface IResourceArray extends Array { - /** the promise of the original server interaction that created this collection. **/ - $promise : ng.IPromise>; - $resolved : boolean; - } - - /** when creating a resource factory via IModule.factory */ - interface IResourceServiceFactoryFunction { - ($resource: ng.resource.IResourceService): IResourceClass; - >($resource: ng.resource.IResourceService): U; - } -} - -/** extensions to base ng based on using angular-resource */ -declare namespace ng { - - interface IModule { - /** creating a resource service factory */ - factory(name: string, resourceServiceFactoryFunction: ng.resource.IResourceServiceFactoryFunction): IModule; - } -} - -interface Array -{ - /** the promise of the original server interaction that created this collection. **/ - $promise : ng.IPromise>; - $resolved : boolean; -} diff --git a/angular/legacy/angular-resource-1.3.d.ts b/angular/legacy/angular-resource-1.3.d.ts deleted file mode 100644 index 7390570991..0000000000 --- a/angular/legacy/angular-resource-1.3.d.ts +++ /dev/null @@ -1,185 +0,0 @@ -// Type definitions for Angular JS 1.3 (ngResource module) -// Project: http://angularjs.org -// Definitions by: Diego Vilar , Michael Jess -// Definitions: https://github.com/daptiv/DefinitelyTyped - - - -declare module 'angular-resource' { - var _: string; - export = _; -} - -/////////////////////////////////////////////////////////////////////////////// -// ngResource module (angular-resource.js) -/////////////////////////////////////////////////////////////////////////////// -declare namespace angular.resource { - - /** - * Currently supported options for the $resource factory options argument. - */ - interface IResourceOptions { - /** - * If true then the trailing slashes from any calculated URL will be stripped (defaults to true) - */ - stripTrailingSlashes?: boolean; - } - - - /////////////////////////////////////////////////////////////////////////// - // ResourceService - // see http://docs.angularjs.org/api/ngResource.$resource - // Most part of the following definitions were achieved by analyzing the - // actual implementation, since the documentation doesn't seem to cover - // that deeply. - /////////////////////////////////////////////////////////////////////////// - interface IResourceService { - (url: string, paramDefaults?: any, - /** example: {update: { method: 'PUT' }, delete: deleteDescriptor } - where deleteDescriptor : IActionDescriptor */ - actions?: any, options?: IResourceOptions): IResourceClass>; - (url: string, paramDefaults?: any, - /** example: {update: { method: 'PUT' }, delete: deleteDescriptor } - where deleteDescriptor : IActionDescriptor */ - actions?: any, options?: IResourceOptions): U; - (url: string, paramDefaults?: any, - /** example: {update: { method: 'PUT' }, delete: deleteDescriptor } - where deleteDescriptor : IActionDescriptor */ - actions?: any, options?: IResourceOptions): IResourceClass; - } - - // Just a reference to facilitate describing new actions - interface IActionDescriptor { - method: string; - params?: any; - url?: string; - isArray?: boolean; - transformRequest?: angular.IHttpRequestTransformer | angular.IHttpRequestTransformer[]; - transformResponse?: angular.IHttpResponseTransformer | angular.IHttpResponseTransformer[]; - headers?: any; - cache?: boolean | angular.ICacheObject; - timeout?: number | angular.IPromise; - withCredentials?: boolean; - responseType?: string; - interceptor?: any; - } - - // Baseclass for everyresource with default actions. - // If you define your new actions for the resource, you will need - // to extend this interface and typecast the ResourceClass to it. - // - // In case of passing the first argument as anything but a function, - // it's gonna be considered data if the action method is POST, PUT or - // PATCH (in other words, methods with body). Otherwise, it's going - // to be considered as parameters to the request. - // https://github.com/angular/angular.js/blob/v1.2.0/src/ngResource/resource.js#L461-L465 - // - // Only those methods with an HTTP body do have 'data' as first parameter: - // https://github.com/angular/angular.js/blob/v1.2.0/src/ngResource/resource.js#L463 - // More specifically, those methods are POST, PUT and PATCH: - // https://github.com/angular/angular.js/blob/v1.2.0/src/ngResource/resource.js#L432 - // - // Also, static calls always return the IResource (or IResourceArray) retrieved - // https://github.com/angular/angular.js/blob/v1.2.0/src/ngResource/resource.js#L538-L549 - interface IResourceClass { - new(dataOrParams? : any) : T; - get(): T; - get(params: Object): T; - get(success: Function, error?: Function): T; - get(params: Object, success: Function, error?: Function): T; - get(params: Object, data: Object, success?: Function, error?: Function): T; - - query(): IResourceArray; - query(params: Object): IResourceArray; - query(success: Function, error?: Function): IResourceArray; - query(params: Object, success: Function, error?: Function): IResourceArray; - query(params: Object, data: Object, success?: Function, error?: Function): IResourceArray; - - save(): T; - save(data: Object): T; - save(success: Function, error?: Function): T; - save(data: Object, success: Function, error?: Function): T; - save(params: Object, data: Object, success?: Function, error?: Function): T; - - remove(): T; - remove(params: Object): T; - remove(success: Function, error?: Function): T; - remove(params: Object, success: Function, error?: Function): T; - remove(params: Object, data: Object, success?: Function, error?: Function): T; - - delete(): T; - delete(params: Object): T; - delete(success: Function, error?: Function): T; - delete(params: Object, success: Function, error?: Function): T; - delete(params: Object, data: Object, success?: Function, error?: Function): T; - } - - // Instance calls always return the the promise of the request which retrieved the object - // https://github.com/angular/angular.js/blob/v1.2.0/src/ngResource/resource.js#L538-L546 - interface IResource { - $get(): angular.IPromise; - $get(params?: Object, success?: Function, error?: Function): angular.IPromise; - $get(success: Function, error?: Function): angular.IPromise; - - $query(): angular.IPromise>; - $query(params?: Object, success?: Function, error?: Function): angular.IPromise>; - $query(success: Function, error?: Function): angular.IPromise>; - - $save(): angular.IPromise; - $save(params?: Object, success?: Function, error?: Function): angular.IPromise; - $save(success: Function, error?: Function): angular.IPromise; - - $remove(): angular.IPromise; - $remove(params?: Object, success?: Function, error?: Function): angular.IPromise; - $remove(success: Function, error?: Function): angular.IPromise; - - $delete(): angular.IPromise; - $delete(params?: Object, success?: Function, error?: Function): angular.IPromise; - $delete(success: Function, error?: Function): angular.IPromise; - - /** the promise of the original server interaction that created this instance. **/ - $promise : angular.IPromise; - $resolved : boolean; - toJSON: () => { - [index: string]: any; - } - } - - /** - * Really just a regular Array object with $promise and $resolve attached to it - */ - interface IResourceArray extends Array> { - /** the promise of the original server interaction that created this collection. **/ - $promise : angular.IPromise>; - $resolved : boolean; - } - - /** when creating a resource factory via IModule.factory */ - interface IResourceServiceFactoryFunction { - ($resource: angular.resource.IResourceService): IResourceClass; - >($resource: angular.resource.IResourceService): U; - } - - // IResourceServiceProvider used to configure global settings - interface IResourceServiceProvider extends angular.IServiceProvider { - - defaults: IResourceOptions; - } - -} - -/** extensions to base ng based on using angular-resource */ -declare namespace angular { - - interface IModule { - /** creating a resource service factory */ - factory(name: string, resourceServiceFactoryFunction: angular.resource.IResourceServiceFactoryFunction): IModule; - } -} - -interface Array -{ - /** the promise of the original server interaction that created this collection. **/ - $promise : angular.IPromise>; - $resolved : boolean; -} diff --git a/angular/legacy/angular-route-1.2-tests.ts b/angular/legacy/angular-route-1.2-tests.ts deleted file mode 100644 index d076c148c2..0000000000 --- a/angular/legacy/angular-route-1.2-tests.ts +++ /dev/null @@ -1,17 +0,0 @@ - - -/** - * @license HTTP Auth Interceptor Module for AngularJS - * (c) 2013 Jonathan Park @ Daptiv Solutions Inc - * License: MIT - */ - -declare var $routeProvider: ng.route.IRouteProvider; -$routeProvider - .when('/projects/:projectId/dashboard',{ - controller: '', - templateUrl: '', - caseInsensitiveMatch: true, - reloadOnSearch: false - }) - .otherwise({redirectTo: '/'}); diff --git a/angular/legacy/angular-route-1.2.d.ts b/angular/legacy/angular-route-1.2.d.ts deleted file mode 100644 index 29b57a39b4..0000000000 --- a/angular/legacy/angular-route-1.2.d.ts +++ /dev/null @@ -1,145 +0,0 @@ -// Type definitions for Angular JS 1.2 (ngRoute module) -// Project: http://angularjs.org -// Definitions by: Jonathan Park -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - - - - -/////////////////////////////////////////////////////////////////////////////// -// ngRoute module (angular-route.js) -/////////////////////////////////////////////////////////////////////////////// -declare namespace ng.route { - - /////////////////////////////////////////////////////////////////////////// - // RouteParamsService - // see https://code.angularjs.org/1.2.26/docs/api/ngRoute/service/$routeParams - /////////////////////////////////////////////////////////////////////////// - interface IRouteParamsService { - [key: string]: any; - } - - /////////////////////////////////////////////////////////////////////////// - // RouteService - // see https://code.angularjs.org/1.2.26/docs/api/ngRoute/service/$route - // see https://code.angularjs.org/1.2.26/docs/api/ngRoute/provider/$routeProvider - /////////////////////////////////////////////////////////////////////////// - interface IRouteService { - /** - * Causes $route service to reload the current route even if $location hasn't changed. - * As a result of that, ngView creates new scope, reinstantiates the controller. - */ - reload(): void; - - /** - * Object with all route configuration Objects as its properties. - */ - routes: any; - - // May not always be available. For instance, current will not be available - // to a controller that was not initialized as a result of a route maching. - current?: ICurrentRoute; - } - - - /** - * see https://code.angularjs.org/1.2.26/docs/api/ngRoute/provider/$routeProvider#when for API documentation - */ - interface IRoute { - /** - * {(string|function()=} - * Controller fn that should be associated with newly created scope or the name of a registered controller if passed as a string. - */ - controller?: any; - /** - * A controller alias name. If present the controller will be published to scope under the controllerAs name. - */ - controllerAs?: string; - /** - * Undocumented? - */ - name?: string; - /** - * {string=|function()=} - * Html template as a string or a function that returns an html template as a string which should be used by ngView or ngInclude directives. This property takes precedence over templateUrl. - * - * If template is a function, it will be called with the following parameters: - * - * {Array.} - route parameters extracted from the current $location.path() by applying the current route - */ - template?: string; - /** - * {string=|function()=} - * Path or function that returns a path to an html template that should be used by ngView. - * - * If templateUrl is a function, it will be called with the following parameters: - * - * {Array.} - route parameters extracted from the current $location.path() by applying the current route - */ - templateUrl?: any; - /** - * {Object.=} - An optional map of dependencies which should be injected into the controller. If any of these dependencies are promises, the router will wait for them all to be resolved or one to be rejected before the controller is instantiated. If all the promises are resolved successfully, the values of the resolved promises are injected and $routeChangeSuccess event is fired. If any of the promises are rejected the $routeChangeError event is fired. The map object is: - * - * - key - {string}: a name of a dependency to be injected into the controller. - * - factory - {string|function}: If string then it is an alias for a service. Otherwise if function, then it is injected and the return value is treated as the dependency. If the result is a promise, it is resolved before its value is injected into the controller. Be aware that ngRoute.$routeParams will still refer to the previous route within these resolve functions. Use $route.current.params to access the new route parameters, instead. - */ - resolve?: {[key: string]: any}; - /** - * {(string|function())=} - * Value to update $location path with and trigger route redirection. - * - * If redirectTo is a function, it will be called with the following parameters: - * - * - {Object.} - route parameters extracted from the current $location.path() by applying the current route templateUrl. - * - {string} - current $location.path() - * - {Object} - current $location.search() - * - The custom redirectTo function is expected to return a string which will be used to update $location.path() and $location.search(). - */ - redirectTo?: any; - /** - * Reload route when only $location.search() or $location.hash() changes. - * - * This option defaults to true. If the option is set to false and url in the browser changes, then $routeUpdate event is broadcasted on the root scope. - */ - reloadOnSearch?: boolean; - /** - * Match routes without being case sensitive - * - * This option defaults to false. If the option is set to true, then the particular route can be matched without being case sensitive - */ - caseInsensitiveMatch?: boolean; - } - - // see https://code.angularjs.org/1.2.26/docs/api/ngRoute/service/$route#current - interface ICurrentRoute extends IRoute { - locals: { - $scope: IScope; - $template: string; - }; - - params: any; - } - - interface IRouteProvider extends IServiceProvider { - /** - * Sets route definition that will be used on route change when no other route definition is matched. - * - * @params Mapping information to be assigned to $route.current. - */ - otherwise(params: IRoute): IRouteProvider; - /** - * Adds a new route definition to the $route service. - * - * @param path Route path (matched against $location.path). If $location.path contains redundant trailing slash or is missing one, the route will still match and the $location.path will be updated to add or drop the trailing slash to exactly match the route definition. - * - * - path can contain named groups starting with a colon: e.g. :name. All characters up to the next slash are matched and stored in $routeParams under the given name when the route matches. - * - path can contain named groups starting with a colon and ending with a star: e.g.:name*. All characters are eagerly stored in $routeParams under the given name when the route matches. - * - path can contain optional named groups with a question mark: e.g.:name?. - * - * For example, routes like /color/:color/largecode/:largecode*\/edit will match /color/brown/largecode/code/with/slashes/edit and extract: color: brown and largecode: code/with/slashes. - * - * @param route Mapping information to be assigned to $route.current on route match. - */ - when(path: string, route: IRoute): IRouteProvider; - } -} diff --git a/angular/legacy/angular-sanitize-1.0.d.ts b/angular/legacy/angular-sanitize-1.0.d.ts deleted file mode 100644 index e883621105..0000000000 --- a/angular/legacy/angular-sanitize-1.0.d.ts +++ /dev/null @@ -1,22 +0,0 @@ -// Type definitions for Angular JS 1.0 (ngSanitize module) -// Project: http://angularjs.org -// Definitions by: Diego Vilar -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - - - - -/////////////////////////////////////////////////////////////////////////////// -// ngSanitize module (angular-sanitize.js) -/////////////////////////////////////////////////////////////////////////////// -declare namespace ng.sanitize { - - /////////////////////////////////////////////////////////////////////////// - // SanitizeService - // see http://docs.angularjs.org/api/ngSanitize.$sanitize - /////////////////////////////////////////////////////////////////////////// - interface ISanitizeService { - (html: string): string; - } - -} diff --git a/angular/legacy/angular-sanitize-1.2-tests.ts b/angular/legacy/angular-sanitize-1.2-tests.ts deleted file mode 100644 index 644d40b364..0000000000 --- a/angular/legacy/angular-sanitize-1.2-tests.ts +++ /dev/null @@ -1,32 +0,0 @@ - - -/////////////////////////////////////////////////////////////////////////////// -// Variables -/////////////////////////////////////////////////////////////////////////////// -let shouldBeString: string; -let testInputText: string = 'TEST'; - -/////////////////////////////////////////////////////////////////////////////// -// Test sanitize service -/////////////////////////////////////////////////////////////////////////////// -declare let $sanitizeService: ng.sanitize.ISanitizeService; -shouldBeString = $sanitizeService(testInputText); - -/////////////////////////////////////////////////////////////////////////////// -// Test `linky` filter -/////////////////////////////////////////////////////////////////////////////// -declare let $linky: ng.sanitize.filter.ILinky; - -// Should be string for simple text and target parameters -shouldBeString = $linky(testInputText, testInputText); - -// Should be string for simple text, target and attributes parameters -let attributesAsFunction = () => { -}; -shouldBeString = $linky(shouldBeString, testInputText, { - "attributeKey1": "attributeValue1", - "attributeKey2": "attributeValue2" -}); -shouldBeString = $linky(shouldBeString, testInputText, (url: string) => { - return {"attributeKey1": "attributeValue1"} -}); \ No newline at end of file diff --git a/angular/legacy/angular-sanitize-1.2.d.ts b/angular/legacy/angular-sanitize-1.2.d.ts deleted file mode 100644 index 88c3eec39e..0000000000 --- a/angular/legacy/angular-sanitize-1.2.d.ts +++ /dev/null @@ -1,35 +0,0 @@ -// Type definitions for Angular JS 1.2 (ngSanitize module) -// Project: http://angularjs.org -// Definitions by: Diego Vilar -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - - - - -/////////////////////////////////////////////////////////////////////////////// -// ngSanitize module (angular-sanitize.js) -/////////////////////////////////////////////////////////////////////////////// -declare namespace ng.sanitize { - - /////////////////////////////////////////////////////////////////////////// - // SanitizeService - // see https://code.angularjs.org/1.2.26/docs/api/ngSanitize/service/$sanitize - /////////////////////////////////////////////////////////////////////////// - interface ISanitizeService { - (html: string): string; - } - - /////////////////////////////////////////////////////////////////////////// - // Filters included with the ngSanitize - // see https://code.angularjs.org/1.2.26/docs/api/ngSanitize/filter - /////////////////////////////////////////////////////////////////////////// - export module filter { - - // Finds links in text input and turns them into html links. - // Supports http/https/ftp/mailto and plain email address links. - // see https://code.angularjs.org/1.2.26/docs/api/ngSanitize/filter/linky - interface ILinky { - (text: string, target?: string): string; - } - } -} diff --git a/angular/legacy/angular-scenario-1.0.d.ts b/angular/legacy/angular-scenario-1.0.d.ts deleted file mode 100644 index ff0c87075f..0000000000 --- a/angular/legacy/angular-scenario-1.0.d.ts +++ /dev/null @@ -1,155 +0,0 @@ -// Type definitions for Angular Scenario Testing 1.0 (ngScenario module) -// Project: http://angularjs.org -// Definitions by: RomanoLindano -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -declare namespace angularScenario { - export interface AngularModel { - scenario: any; - } - - export interface RunFunction { - (functionToRun: any): any; - } - export interface RunFunctionWithDescription { - (description: string, functionToRun: any): any; - } - - export interface PauseFunction { - (): any; - } - - export interface SleepFunction { - (seconds: number): any; - } - - export interface Future { - } - - export interface testWindow { - href(): Future; - path(): Future; - search(): Future; - hash(): Future; - } - - export interface testLocation { - url(): Future; - path(): Future; - search(): Future; - hash(): Future; - } - - export interface Browser { - navigateTo(url: string): void; - navigateTo(urlDescription: string, urlFunction: () => string): void; - reload(): void; - window(): testWindow; - location(): testLocation; - } - - export interface Matchers { - toEqual(value: any): void; - toBe(value: any): void; - toBeDefined(): void; - toBeTruthy(): void; - toBeFalsy(): void; - toMatch(regularExpression: any): void; - toBeNull(): void; - toContain(value: any): void; - toBeLessThan(value: any): void; - toBeGreaterThan(value: any): void; - } - - export interface CustomMatchers extends Matchers{ - } - - export interface Expect extends CustomMatchers { - not(): angularScenario.CustomMatchers; - } - - export interface UsingFunction { - (selector: string, selectorDescription?: string): void; - } - - export interface BindingFunction { - (bracketBindingExpression: string): Future; - } - - export interface Input { - enter(value: any); - check(): any; - select(radioButtonValue: any): any; - val(): Future; - } - - export interface Repeater { - count(): Future; - row(index: number): Future; - column(ngBindingExpression: string): Future; - } - - export interface Select { - option(value: any): any; - option(...listOfValues: any[]): any; - } - - export interface Element { - count(): Future; - click(): any; - query(callback: (selectedDOMElements: any[], callbackWhenDone: (objNull: any, futureValue: any) => any) =>any): any; - val(): Future; - text(): Future; - html(): Future; - height(): Future; - innerHeight(): Future; - outerHeight(): Future; - width(): Future; - innerWidth(): Future; - outerWidth(): Future; - position(): Future; - scrollLeft(): Future; - scrollTop(): Future; - offset(): Future; - - val(value: any): void; - text(value: any): void; - html(value: any): void; - height(value: any): void; - innerHeight(value: any): void; - outerHeight(value: any): void; - width(value: any): void; - innerWidth(value: any): void; - outerWidth(value: any): void; - position(value: any): void; - scrollLeft(value: any): void; - scrollTop(value: any): void; - offset(value: any): void; - - attr(key: any): Future; - prop(key: any): Future; - css(key: any): Future; - - attr(key: any, value: any): void; - prop(key: any, value: any): void; - css(key: any, value: any): void; - } -} - -declare var describe: angularScenario.RunFunctionWithDescription; -declare var xdescribe: angularScenario.RunFunctionWithDescription; -declare var beforeEach: angularScenario.RunFunction; -declare var afterEach: angularScenario.RunFunction; -declare var it: angularScenario.RunFunctionWithDescription; -declare var xit: angularScenario.RunFunctionWithDescription; -declare var pause: angularScenario.PauseFunction; -declare var sleep: angularScenario.SleepFunction; -declare function browser(): angularScenario.Browser; -declare function expect(expectation: angularScenario.Future): angularScenario.Expect; -declare var using: angularScenario.UsingFunction; -declare var binding: angularScenario.BindingFunction; -declare function input(ngModelBinding: string): angularScenario.Input; -declare function repeater(selector: string, repeaterDescription?: string): angularScenario.Repeater; -declare function select(ngModelBinding: string): angularScenario.Select; -declare function element(selector: string, elementDescription?: string): angularScenario.Element; -declare var angular: angularScenario.AngularModel; diff --git a/angular/legacy/angular-scenario-1.2.d.ts b/angular/legacy/angular-scenario-1.2.d.ts deleted file mode 100644 index 5dfa36fc5f..0000000000 --- a/angular/legacy/angular-scenario-1.2.d.ts +++ /dev/null @@ -1,166 +0,0 @@ -// Type definitions for Angular Scenario Testing 1.2 (ngScenario module) -// Project: http://angularjs.org -// Definitions by: RomanoLindano -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -/// - -declare namespace ng { - export interface IAngularStatic { - scenario: any; - } -} - -declare namespace angularScenario { - - export interface RunFunction { - (functionToRun: any): any; - } - export interface RunFunctionWithDescription { - (description: string, functionToRun: any): any; - } - - export interface PauseFunction { - (): any; - } - - export interface SleepFunction { - (seconds: number): any; - } - - export interface Future { - } - - export interface testWindow { - href(): Future; - path(): Future; - search(): Future; - hash(): Future; - } - - export interface testLocation { - url(): Future; - path(): Future; - search(): Future; - hash(): Future; - } - - export interface Browser { - navigateTo(url: string): void; - navigateTo(urlDescription: string, urlFunction: () => string): void; - reload(): void; - window(): testWindow; - location(): testLocation; - } - - export interface Matchers { - toEqual(value: any): void; - toBe(value: any): void; - toBeDefined(): void; - toBeTruthy(): void; - toBeFalsy(): void; - toMatch(regularExpression: any): void; - toBeNull(): void; - toContain(value: any): void; - toBeLessThan(value: any): void; - toBeGreaterThan(value: any): void; - } - - export interface CustomMatchers extends Matchers { - } - - export interface Expect extends CustomMatchers { - not(): angularScenario.CustomMatchers; - } - - export interface UsingFunction { - (selector: string, selectorDescription?: string): void; - } - - export interface BindingFunction { - (bracketBindingExpression: string): Future; - } - - export interface Input { - enter(value: any): any; - check(): any; - select(radioButtonValue: any): any; - val(): Future; - } - - export interface Repeater { - count(): Future; - row(index: number): Future; - column(ngBindingExpression: string): Future; - } - - export interface Select { - option(value: any): any; - option(...listOfValues: any[]): any; - } - - export interface Element { - count(): Future; - click(): any; - dblclick(): any; - mouseover(): any; - mousedown(): any; - mouseup(): any; - query(callback: (selectedDOMElements: JQuery, callbackWhenDone: (objNull: any, futureValue: any) => any) => any): any; - val(): Future; - text(): Future; - html(): Future; - height(): Future; - innerHeight(): Future; - outerHeight(): Future; - width(): Future; - innerWidth(): Future; - outerWidth(): Future; - position(): Future; - scrollLeft(): Future; - scrollTop(): Future; - offset(): Future; - - val(value: any): void; - text(value: any): void; - html(value: any): void; - height(value: any): void; - innerHeight(value: any): void; - outerHeight(value: any): void; - width(value: any): void; - innerWidth(value: any): void; - outerWidth(value: any): void; - position(value: any): void; - scrollLeft(value: any): void; - scrollTop(value: any): void; - offset(value: any): void; - - attr(key: any): Future; - prop(key: any): Future; - css(key: any): Future; - - attr(key: any, value: any): void; - prop(key: any, value: any): void; - css(key: any, value: any): void; - } -} - -declare var describe: angularScenario.RunFunctionWithDescription; -declare var ddescribe: angularScenario.RunFunctionWithDescription; -declare var xdescribe: angularScenario.RunFunctionWithDescription; -declare var beforeEach: angularScenario.RunFunction; -declare var afterEach: angularScenario.RunFunction; -declare var it: angularScenario.RunFunctionWithDescription; -declare var iit: angularScenario.RunFunctionWithDescription; -declare var xit: angularScenario.RunFunctionWithDescription; -declare var pause: angularScenario.PauseFunction; -declare var sleep: angularScenario.SleepFunction; -declare function browser(): angularScenario.Browser; -declare function expect(expectation: angularScenario.Future): angularScenario.Expect; -declare var using: angularScenario.UsingFunction; -declare var binding: angularScenario.BindingFunction; -declare function input(ngModelBinding: string): angularScenario.Input; -declare function repeater(selector: string, repeaterDescription?: string): angularScenario.Repeater; -declare function select(ngModelBinding: string): angularScenario.Select; -declare function element(selector: string, elementDescription?: string): angularScenario.Element; -declare var angular: ng.IAngularStatic; diff --git a/angular/tsconfig.json b/angular/tsconfig.json index ef071ac6ee..8cd61f15fb 100644 --- a/angular/tsconfig.json +++ b/angular/tsconfig.json @@ -6,7 +6,7 @@ "compilerOptions": { "module": "commonjs", "target": "es6", - "noImplicitAny": true, + "noImplicitAny": false, "noImplicitThis": false, "strictNullChecks": false, "baseUrl": "../", diff --git a/async/asyncamd-tests.ts b/async/asyncamd-tests.ts deleted file mode 100644 index 4bf6c2789d..0000000000 --- a/async/asyncamd-tests.ts +++ /dev/null @@ -1,5 +0,0 @@ - - -import async = require("async"); - -async.map(["a", "b", "c"], (item, cb) => cb(null, [item.toUpperCase()]), (err, results) => { }); diff --git a/async/tsconfig.json b/async/tsconfig.json index d62fccf232..412f9b97c6 100644 --- a/async/tsconfig.json +++ b/async/tsconfig.json @@ -4,7 +4,7 @@ "target": "es6", "noImplicitAny": true, "noImplicitThis": true, - "strictNullChecks": true, + "strictNullChecks": false, "baseUrl": "../", "typeRoots": [ "../" @@ -15,6 +15,7 @@ }, "files": [ "index.d.ts", - "async-tests.ts" + "async-tests.ts", + "async-explicit-tests.ts" ] } \ No newline at end of file diff --git a/atom/tsconfig.json b/atom/tsconfig.json index a2678c3d56..cbb243e6bb 100644 --- a/atom/tsconfig.json +++ b/atom/tsconfig.json @@ -15,6 +15,7 @@ }, "files": [ "index.d.ts", + "api-docs.d.ts", "atom-tests.ts" ] } \ No newline at end of file diff --git a/aws4/aws4-tests.ts b/aws4/aws4-tests.ts index b611951e45..d5915994c7 100644 --- a/aws4/aws4-tests.ts +++ b/aws4/aws4-tests.ts @@ -1,6 +1,4 @@ -/// - -import * as aws4 from "."; +import * as aws4 from "aws4"; let requestSigner = new aws4.RequestSigner({}, {}); requestSigner.matchHost(""); diff --git a/backbone/backbone-with-lodash-tests.ts b/backbone/backbone-with-lodash-tests.ts index 27da75d5f9..b44b2be988 100644 --- a/backbone/backbone-with-lodash-tests.ts +++ b/backbone/backbone-with-lodash-tests.ts @@ -1,6 +1,5 @@ -/// -/// -/// +import * as Backbone from "backbone"; +import * as _ from "lodash"; function test_events() { diff --git a/backbone/tsconfig.json b/backbone/tsconfig.json index b4a63b9ef0..43a64b9e25 100644 --- a/backbone/tsconfig.json +++ b/backbone/tsconfig.json @@ -15,6 +15,7 @@ }, "files": [ "index.d.ts", - "backbone-tests.ts" + "backbone-tests.ts", + "backbone-with-lodash-tests.ts" ] } \ No newline at end of file diff --git a/base64url/base64url-test.ts b/base64url/base64url-tests.ts similarity index 100% rename from base64url/base64url-test.ts rename to base64url/base64url-tests.ts diff --git a/base64url/tsconfig.json b/base64url/tsconfig.json index e5f6b4b0a6..a62c495fb3 100644 --- a/base64url/tsconfig.json +++ b/base64url/tsconfig.json @@ -15,6 +15,6 @@ }, "files": [ "index.d.ts", - "base64url-test.ts" + "base64url-tests.ts" ] } \ No newline at end of file diff --git a/bluebird/bluebird-1.0-tests.ts b/bluebird/v1/bluebird-tests.ts similarity index 100% rename from bluebird/bluebird-1.0-tests.ts rename to bluebird/v1/bluebird-tests.ts diff --git a/bluebird/bluebird-1.0.d.ts b/bluebird/v1/index.d.ts similarity index 100% rename from bluebird/bluebird-1.0.d.ts rename to bluebird/v1/index.d.ts diff --git a/bluebird/v1/tsconfig.json b/bluebird/v1/tsconfig.json new file mode 100644 index 0000000000..9207bdd01d --- /dev/null +++ b/bluebird/v1/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "target": "es5", + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": false, + "baseUrl": "../../", + "typeRoots": [ + "../../" + ], + "types": [], + "paths": { + "bluebird": ["bluebird/v1"] + }, + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "bluebird-tests.ts" + ] +} \ No newline at end of file diff --git a/bluebird/bluebird-2.0-tests.ts b/bluebird/v2/bluebird-tests.ts similarity index 99% rename from bluebird/bluebird-2.0-tests.ts rename to bluebird/v2/bluebird-tests.ts index 3a8ddaa383..8acdcb44bd 100644 --- a/bluebird/bluebird-2.0-tests.ts +++ b/bluebird/v2/bluebird-tests.ts @@ -1,5 +1,3 @@ -/// - // Tests by: Bart van der Schoor // Note: replicate changes to all overloads in both definition and test file diff --git a/bluebird/bluebird-2.0.d.ts b/bluebird/v2/index.d.ts similarity index 100% rename from bluebird/bluebird-2.0.d.ts rename to bluebird/v2/index.d.ts diff --git a/bluebird/v2/tsconfig.json b/bluebird/v2/tsconfig.json new file mode 100644 index 0000000000..8c7fd4c71f --- /dev/null +++ b/bluebird/v2/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "target": "es5", + "noImplicitAny": true, + "noImplicitThis": false, + "strictNullChecks": false, + "baseUrl": "../../", + "typeRoots": [ + "../../" + ], + "types": [], + "paths": { + "bluebird": ["bluebird/v2"] + }, + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "bluebird-tests.ts" + ] +} \ No newline at end of file diff --git a/bootstrap.v3.datetimepicker/bootstrap.v3.datetimepicker-3.0.0.d.ts b/bootstrap.v3.datetimepicker/v3/index.d.ts similarity index 98% rename from bootstrap.v3.datetimepicker/bootstrap.v3.datetimepicker-3.0.0.d.ts rename to bootstrap.v3.datetimepicker/v3/index.d.ts index a0d8a9bbd6..2c69607cb9 100644 --- a/bootstrap.v3.datetimepicker/bootstrap.v3.datetimepicker-3.0.0.d.ts +++ b/bootstrap.v3.datetimepicker/v3/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for Bootstrap datetimepicker v3 +// Type definitions for Bootstrap datetimepicker v3 3.x // Project: http://eonasdan.github.io/bootstrap-datetimepicker // Definitions by: Jesica N. Fera // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped diff --git a/bootstrap.v3.datetimepicker/v3/tsconfig.json b/bootstrap.v3.datetimepicker/v3/tsconfig.json new file mode 100644 index 0000000000..e368705f30 --- /dev/null +++ b/bootstrap.v3.datetimepicker/v3/tsconfig.json @@ -0,0 +1,22 @@ +{ + "compilerOptions": { + "module": "commonjs", + "target": "es6", + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "baseUrl": "../../", + "typeRoots": [ + "../../" + ], + "types": [], + "paths": { + "bootstrap.v3.datetimepicker": ["bootstrap.v3.datetimepicker/v3"] + }, + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts" + ] +} \ No newline at end of file diff --git a/bowser/bowser-tests-global.ts b/bowser/bowser-global-tests.ts similarity index 100% rename from bowser/bowser-tests-global.ts rename to bowser/bowser-global-tests.ts diff --git a/bowser/bowser-tests-module.ts b/bowser/bowser-module-tests.ts similarity index 100% rename from bowser/bowser-tests-module.ts rename to bowser/bowser-module-tests.ts diff --git a/bowser/tsconfig.json b/bowser/tsconfig.json index 51ffd1dd85..60a6d8803f 100644 --- a/bowser/tsconfig.json +++ b/bowser/tsconfig.json @@ -15,7 +15,7 @@ }, "files": [ "index.d.ts", - "bowser-tests-module.ts", - "bowser-tests-global.ts" + "bowser-module-tests.ts", + "bowser-global-tests.ts" ] } \ No newline at end of file diff --git a/business-rules-engine/tsconfig.json b/business-rules-engine/tsconfig.json index bc9aaa2d87..0bc7ba62c9 100644 --- a/business-rules-engine/tsconfig.json +++ b/business-rules-engine/tsconfig.json @@ -1,8 +1,4 @@ { - "files": [ - "index.d.ts", - "business-rules-engine-tests.ts" - ], "compilerOptions": { "module": "commonjs", "target": "es6", @@ -16,5 +12,11 @@ "types": [], "noEmit": true, "forceConsistentCasingInFileNames": true - } + }, + "files": [ + "index.d.ts", + "Utils.d.ts", + "Validation.d.ts", + "business-rules-engine-tests.ts" + ] } \ No newline at end of file diff --git a/chai/chai-3.2.0-tests.ts b/chai/chai-3.2.0-tests.ts deleted file mode 100644 index 0a69e52cae..0000000000 --- a/chai/chai-3.2.0-tests.ts +++ /dev/null @@ -1,1966 +0,0 @@ - -import chai = require('chai'); - -// ReSharper disable WrongExpressionStatement - -var expect = chai.expect; -var assert = chai.assert; -var should = chai.should(); -declare var err: Function; - -function chaiVersion() { - expect(chai).to.have.property('version'); - (<{}>chai).should.have.property('version'); -} - -function assertion() { - expect('test').to.be.a('string'); - 'test'.should.be.a('string'); - expect('foo').to.equal('foo'); - 'foo'.should.equal('foo'); - should.equal('foo', 'foo'); -} - -function fail() { - err(() => { - should.fail('foo', 'bar'); - }, 'expected fail to throw an AssertionError'); - err(() => { - should.fail('foo', 'bar', 'should fail'); - }, 'expected fail to throw an AssertionError'); - err(() => { - should.fail('foo', 'bar', 'should fail', 'equal'); - }, 'expected fail to throw an AssertionError'); - - err(() => { - expect.fail('foo', 'bar'); - }, 'expected fail to throw an AssertionError'); - err(() => { - expect.fail('foo', 'bar', 'should fail'); - }, 'expected fail to throw an AssertionError'); - err(() => { - expect.fail('foo', 'bar', 'should fail', 'equal'); - }, 'expected fail to throw an AssertionError'); -} - -// ReSharper disable once InconsistentNaming -function _true() { - expect(true).to.be.true; - true.should.be.true; - expect(false).to.not.be.true; - false.should.not.be.true; - expect(1).to.not.be.true; - (1).should.not.be.true; - - err(() => { - expect('test').to.be.true; - 'test'.should.be.true; - }, 'expected \'test\' to be true'); -} - -function ok() { - expect(true).to.be.ok; - true.should.be.ok; - expect(false).to.not.be.ok; - false.should.not.be.ok; - expect(1).to.be.ok; - (1).should.be.ok; - expect(0).to.not.be.ok; - (0).should.not.be.ok; - - err(() => { - expect('').to.be.ok; - ''.should.be.ok; - }, 'expected \'\' to be truthy'); - - err(() => { - expect('test').to.not.be.ok; - 'test'.should.not.be.ok; - }, 'expected \'test\' to be falsy'); -} - -function _false() { - expect(false).to.be.false; - false.should.be.false; - expect(true).to.not.be.false; - true.should.not.be.false; - expect(0).to.not.be.false; - (0).should.not.be.false; - - err(() => { - expect('').to.be.false; - ''.should.be.false; - }, 'expected \'\' to be false'); -} - -function _null() { - expect(null).to.be.null; - should.equal(null, null); - expect(false).to.not.be.null; - false.should.not.be.null; - - err(() => { - expect('').to.be.null; - ''.should.be.null; - }, 'expected \'\' to be null'); -} - -function _undefined() { - expect(undefined).to.be.undefined; - should.equal(undefined, undefined); - expect(null).to.not.be.undefined; - should.not.equal(null, undefined); - - err(() => { - expect('').to.be.undefined; - ''.should.be.undefined; - }, 'expected \'\' to be undefined'); -} - -function _NaN() { - expect(NaN).to.be.NaN; - expect(12).to.be.not.NaN; - expect("NaN").to.be.not.NaN; - (NaN).should.be.NaN; - (12).should.be.not.NaN; - ("NaN").should.be.not.NaN; -} - -function exist() { - var foo = 'bar'; - expect(foo).to.exist; - should.exist(foo); - expect(void (0)).to.not.exist; - should.not.exist(void (0)); -} - -function argumentsTest() { - var args = arguments; - expect(args).to.be.arguments; - args.should.be.arguments; - expect([]).to.not.be.arguments; - [].should.not.be.arguments; - expect(args).to.be.an('arguments').and.be.arguments; - args.should.be.an('arguments').and.be.arguments; - expect([]).to.be.an('array').and.not.be.Arguments; - [].should.be.an('array').and.not.be.Arguments; -} - -function equal() { - expect(undefined).to.equal(void (0)); - should.equal(undefined, void (0)); -} - -function _typeof() { - expect('test').to.be.a('string'); - 'test'.should.be.a('string'); - - err(() => { - expect('test').to.not.be.a('string'); - 'test'.should.not.be.a('string'); - }, 'expected \'test\' not to be a string'); - - expect(arguments).to.be.an('arguments'); - arguments.should.be.an('arguments'); - - expect(5).to.be.a('number'); - (5).should.be.a('number'); - - expect(new Number(1)).to.be.a('number'); - (new Number(1)).should.be.a('number'); - expect(Number(1)).to.be.a('number'); - Number(1).should.be.a('number'); - expect(true).to.be.a('boolean'); - true.should.be.a('boolean'); - expect(new Array()).to.be.a('array'); - (new Array()).should.be.a('array'); - expect(new Object()).to.be.a('object'); - (new Object()).should.be.a('object'); - expect({}).to.be.a('object'); - ({}).should.be.a('object'); - expect([]).to.be.a('array'); - [].should.be.a('array'); - expect(() => { }).to.be.a('function'); - (() => { }).should.be.a('function'); - expect(null).to.be.a('null'); - // N.B. previous line has no should equivalent - - err(() => { - expect(5).to.not.be.a('number', 'blah'); - (5).should.not.be.a('number', 'blah'); - }, 'blah: expected 5 not to be a number'); -} - -class Foo { } -function _instanceof() { - expect(new Foo()).to.be.an.instanceof(Foo); - (new Foo()).should.be.an.instanceof(Foo); - - err(() => { - expect(3).to.an.instanceof(Foo, 'blah'); - (3).should.an.instanceof(Foo, 'blah'); - }, 'blah: expected 3 to be an instance of Foo'); -} - -function within() { - expect(5).to.be.within(5, 10); - (5).should.be.within(5, 10); - expect(5).to.be.within(3, 6); - (5).should.be.within(3, 6); - expect(5).to.be.within(3, 5); - (5).should.be.within(3, 5); - expect(5).to.not.be.within(1, 3); - (5).should.not.be.within(1, 3); - expect('foo').to.have.length.within(2, 4); - 'foo'.should.have.length.within(2, 4); - expect([1, 2, 3]).to.have.length.within(2, 4); - [1, 2, 3].should.have.length.within(2, 4); - - err(() => { - expect(5).to.not.be.within(4, 6, 'blah'); - (5).should.not.be.within(4, 6, 'blah'); - }, 'blah: expected 5 to not be within 4..6', 'blah'); - - err(() => { - expect(10).to.be.within(50, 100, 'blah'); - (10).should.be.within(50, 100, 'blah'); - }, 'blah: expected 10 to be within 50..100'); - - err(() => { - expect('foo').to.have.length.within(5, 7, 'blah'); - 'foo'.should.have.length.within(5, 7, 'blah'); - }, 'blah: expected \'foo\' to have a length within 5..7'); - - err(() => { - expect([1, 2, 3]).to.have.length.within(5, 7, 'blah'); - [1, 2, 3].should.have.length.within(5, 7, 'blah'); - }, 'blah: expected [ 1, 2, 3 ] to have a length within 5..7'); -} - -function above() { - expect(5).to.be.above(2); - (5).should.be.above(2); - expect(5).to.be.greaterThan(2); - (5).should.be.greaterThan(2); - expect(5).to.not.be.above(5); - (5).should.not.be.above(5); - expect(5).to.not.be.above(6); - (5).should.not.be.above(6); - expect('foo').to.have.length.above(2); - 'foo'.should.have.length.above(2); - expect([1, 2, 3]).to.have.length.above(2); - [1, 2, 3].should.have.length.above(2); - - err(() => { - expect(5).to.be.above(6, 'blah'); - (5).should.be.above(6, 'blah'); - }, 'blah: expected 5 to be above 6', 'blah'); - - err(() => { - expect(10).to.not.be.above(6, 'blah'); - (10).should.not.be.above(6, 'blah'); - }, 'blah: expected 10 to be at most 6'); - - err(() => { - expect('foo').to.have.length.above(4, 'blah'); - 'foo'.should.have.length.above(4, 'blah'); - }, 'blah: expected \'foo\' to have a length above 4 but got 3'); - - err(() => { - expect([1, 2, 3]).to.have.length.above(4, 'blah'); - [1, 2, 3].should.have.length.above(4, 'blah'); - }, 'blah: expected [ 1, 2, 3 ] to have a length above 4 but got 3'); -} - -function least() { - expect(5).to.be.at.least(2); - (5).should.be.at.least(2); - expect(5).to.be.at.least(5); - (5).should.be.at.least(5); - expect(5).to.not.be.at.least(6); - (5).should.not.be.at.least(6); - expect('foo').to.have.length.of.at.least(2); - 'foo'.should.have.length.of.at.least(2); - expect([1, 2, 3]).to.have.length.of.at.least(2); - [1, 2, 3].should.have.length.of.at.least(2); - - err(() => { - expect(5).to.be.at.least(6, 'blah'); - (5).should.be.at.least(6, 'blah'); - }, 'blah: expected 5 to be at least 6', 'blah'); - - err(() => { - expect(10).to.not.be.at.least(6, 'blah'); - (10).should.not.be.at.least(6, 'blah'); - }, 'blah: expected 10 to be below 6'); - - err(() => { - expect('foo').to.have.length.of.at.least(4, 'blah'); - 'foo'.should.have.length.of.at.least(4, 'blah'); - }, 'blah: expected \'foo\' to have a length at least 4 but got 3'); - - err(() => { - expect([1, 2, 3]).to.have.length.of.at.least(4, 'blah'); - [1, 2, 3].should.have.length.of.at.least(4, 'blah'); - }, 'blah: expected [ 1, 2, 3 ] to have a length at least 4 but got 3'); - - err(() => { - expect([1, 2, 3, 4]).to.not.have.length.of.at.least(4, 'blah'); - [1, 2, 3, 4].should.not.have.length.of.at.least(4, 'blah'); - }, 'blah: expected [ 1, 2, 3, 4 ] to have a length below 4'); -} - -function below() { - expect(2).to.be.below(5); - (2).should.be.below(5); - expect(2).to.be.lessThan(5); - (2).should.be.lessThan(5); - expect(2).to.not.be.below(2); - (2).should.not.be.below(2); - expect(2).to.not.be.below(1); - (2).should.not.be.below(1); - expect('foo').to.have.length.below(4); - 'foo'.should.have.length.below(4); - expect([1, 2, 3]).to.have.length.below(4); - [1, 2, 3].should.have.length.below(4); - - err(() => { - expect(6).to.be.below(5, 'blah'); - (6).should.be.below(5, 'blah'); - }, 'blah: expected 6 to be below 5'); - - err(() => { - expect(6).to.not.be.below(10, 'blah'); - (6).should.not.be.below(10, 'blah'); - }, 'blah: expected 6 to be at least 10'); - - err(() => { - expect('foo').to.have.length.below(2, 'blah'); - 'foo'.should.have.length.below(2, 'blah'); - }, 'blah: expected \'foo\' to have a length below 2 but got 3'); - - err(() => { - expect([1, 2, 3]).to.have.length.below(2, 'blah'); - [1, 2, 3].should.have.length.below(2, 'blah'); - }, 'blah: expected [ 1, 2, 3 ] to have a length below 2 but got 3'); -} - -function most() { - expect(2).to.be.at.most(5); - (2).should.be.at.most(5); - expect(2).to.be.at.most(2); - (2).should.be.at.most(2); - expect(2).to.not.be.at.most(1); - (2).should.not.be.at.most(1); - expect(2).to.not.be.at.most(1); - (2).should.not.be.at.most(1); - expect('foo').to.have.length.of.at.most(4); - 'foo'.should.have.length.of.at.most(4); - expect([1, 2, 3]).to.have.length.of.at.most(4); - [1, 2, 3].should.have.length.of.at.most(4); - - err(() => { - expect(6).to.be.at.most(5, 'blah'); - (6).should.be.at.most(5, 'blah'); - }, 'blah: expected 6 to be at most 5'); - - err(() => { - expect(6).to.not.be.at.most(10, 'blah'); - (6).should.not.be.at.most(10, 'blah'); - }, 'blah: expected 6 to be above 10'); - - err(() => { - expect('foo').to.have.length.of.at.most(2, 'blah'); - 'foo'.should.have.length.of.at.most(2, 'blah'); - }, 'blah: expected \'foo\' to have a length at most 2 but got 3'); - - err(() => { - expect([1, 2, 3]).to.have.length.of.at.most(2, 'blah'); - [1, 2, 3].should.have.length.of.at.most(2, 'blah'); - }, 'blah: expected [ 1, 2, 3 ] to have a length at most 2 but got 3'); - - err(() => { - expect([1, 2]).to.not.have.length.of.at.most(2, 'blah'); - [1, 2].should.not.have.length.of.at.most(2, 'blah'); - }, 'blah: expected [ 1, 2 ] to have a length above 2'); -} - -function match() { - expect('foobar').to.match(/^foo/); - 'foobar'.should.match(/^foo/); - expect('foobar').to.not.match(/^bar/); - 'foobar'.should.not.match(/^bar/); - - expect('foobar').matches(/^foo/); - 'foobar'.should.not.matches(/^bar/); - - err(() => { - expect('foobar').to.match(/^bar/i, 'blah'); - 'foobar'.should.match(/^bar/i, 'blah'); - }, 'blah: expected \'foobar\' to match /^bar/i'); - - err(() => { - expect('foobar').to.not.match(/^foo/i, 'blah'); - 'foobar'.should.not.match(/^foo/i, 'blah'); - }, 'blah: expected \'foobar\' not to match /^foo/i'); -} - -function length2() { - expect('test').to.have.length(4); - 'test'.should.have.length(4); - expect('test').to.not.have.length(3); - 'test'.should.not.have.length(3); - expect([1, 2, 3]).to.have.length(3); - [1, 2, 3].should.have.length(3); - - err(() => { - expect(4).to.have.length(3, 'blah'); - (4).should.have.length(3, 'blah'); - }, 'blah: expected 4 to have a property \'length\''); - - err(() => { - expect('asd').to.not.have.length(3, 'blah'); - 'asd'.should.not.have.length(3, 'blah'); - }, 'blah: expected \'asd\' to not have a length of 3'); -} - -function eql() { - expect('test').to.eql('test'); - 'test'.should.eql('test'); - expect({ foo: 'bar' }).to.eql({ foo: 'bar' }); - ({ foo: 'bar' }).should.eql({ foo: 'bar' }); - expect(1).to.eql(1); - (1).should.eql(1); - expect('4').to.not.eql(4); - '4'.should.not.eql(4); - - err(() => { - expect(4).to.eql(3, 'blah'); - (4).should.eql(3, 'blah'); - }, 'blah: expected 4 to deeply equal 3'); -} - -class Buffer { - constructor(arr: number[]) { - } -} -function buffer() { - expect(new Buffer([1])).to.eql(new Buffer([1])); - (new Buffer([1])).should.eql(new Buffer([1])); - - err(() => { - expect(new Buffer([0])).to.eql(new Buffer([1])); - (new Buffer([0])).should.eql(new Buffer([1])); - }, 'expected to deeply equal '); -} - -function equal2() { - expect('test').to.equal('test'); - 'test'.should.equal('test'); - should.equal('test', 'test'); - expect(1).to.equal(1); - (1).should.equal(1); - should.equal(1, 1); - - err(() => { - expect(4).to.equal(3, 'blah'); - (4).should.equal(3, 'blah'); - should.equal(4, 3, 'blah'); - }, 'blah: expected 4 to equal 3'); - - err(() => { - expect('4').to.equal(4, 'blah'); - '4'.should.equal(4, 'blah'); - should.equal(4, 4, 'blah'); - }, 'blah: expected \'4\' to equal 4'); -} - -function deepEqual() { - expect({ foo: 'bar' }).to.deep.equal({ foo: 'bar' }); - ({ foo: 'bar' }).should.deep.equal({ foo: 'bar' }); - expect({ foo: 'bar' }).not.to.deep.equal({ foo: 'baz' }); -} - -function deepEqual2() { - expect(/a/).to.deep.equal(/a/); - /a/.should.deep.equal(/a/); - expect(/a/).not.to.deep.equal(/b/); - expect(/a/).not.to.deep.equal({}); - expect(/a/g).to.deep.equal(/a/g); - /a/g.should.deep.equal(/a/g); - expect(/a/g).not.to.deep.equal(/b/g); - expect(/a/i).to.deep.equal(/a/i); - /a/i.should.deep.equal(/a/i); - expect(/a/i).not.to.deep.equal(/b/i); - expect(/a/m).to.deep.equal(/a/m); - /a/m.should.deep.equal(/a/m); - expect(/a/m).not.to.deep.equal(/b/m); -} - -// ReSharper disable once InconsistentNaming -function deepEqual3() { - var a = new Date(1, 2, 3); - var b = new Date(4, 5, 6); - expect(a).to.deep.equal(a); - a.should.deep.equal(a); - expect(a).not.to.deep.equal(b); - a.should.not.deep.equal(b); - expect(a).not.to.deep.equal({}); - a.should.not.deep.equal({}); -} - -function deepInclude() { - expect(['foo', 'bar']).to.deep.include(['bar', 'foo']); - ['foo', 'bar'].should.deep.include(['bar', 'foo']); - expect(['foo', 'bar']).not.to.deep.equal(['foo', 'baz']); - ['foo', 'bar'].should.not.deep.equal(['foo', 'baz']); -} - -class FakeArgs { - length: number; -} - -function empty() { - FakeArgs.prototype.length = 0; - - expect('').to.be.empty; - - ''.should.be.empty; - expect('foo').not.to.be.empty; - 'foo'.should.not.be.empty; - expect([]).to.be.empty; - [].should.be.empty; - expect(['foo']).not.to.be.empty; - ['foo'].should.not.be.empty; - expect(new FakeArgs).to.be.empty; - (new FakeArgs).should.be.empty; - expect({ arguments: 0 }).not.to.be.empty; - ({ arguments: 0 }).should.not.be.empty; - expect({}).to.be.empty; - ({}).should.be.empty; - expect({ foo: 'bar' }).not.to.be.empty; - ({ foo: 'bar' }).should.not.be.empty; - - err(() => { - expect('').not.to.be.empty; - ''.should.not.be.empty; - }, 'expected \'\' not to be empty'); - - err(() => { - expect('foo').to.be.empty; - 'foo'.should.be.empty; - 'foo'.should.be.empty; - }, 'expected \'foo\' to be empty'); - - err(() => { - expect([]).not.to.be.empty; - [].should.not.be.empty; - }, 'expected [] not to be empty'); - - err(() => { - expect(['foo']).to.be.empty; - ['foo'].should.be.empty; - }, 'expected [ \'foo\' ] to be empty'); - - err(() => { - expect(new FakeArgs).not.to.be.empty; - (new FakeArgs).should.not.be.empty; - }, 'expected { length: 0 } not to be empty'); - - err(() => { - expect({ arguments: 0 }).to.be.empty; - ({ arguments: 0 }).should.be.empty; - }, 'expected { arguments: 0 } to be empty'); - - err(() => { - expect({}).not.to.be.empty; - ({}).should.not.be.empty; - }, 'expected {} not to be empty'); - - err(() => { - expect({ foo: 'bar' }).to.be.empty; - ({ foo: 'bar' }).should.be.empty; - }, 'expected { foo: \'bar\' } to be empty'); -} - -function property() { - expect('test').to.have.property('length'); - 'test'.should.have.property('length'); - expect(4).to.not.have.property('length'); - (4).should.not.have.property('length'); - - expect({ 'foo.bar': 'baz' }) - .to.have.property('foo.bar'); - ({ 'foo.bar': 'baz' }).should.have.property('foo.bar'); - expect({ foo: { bar: 'baz' } }) - .to.not.have.property('foo.bar'); - ({ foo: { bar: 'baz' } }).should.not.have.property('foo.bar'); - - err(() => { - expect('asd').to.have.property('foo'); - 'asd'.should.have.property('foo'); - }, 'expected \'asd\' to have a property \'foo\''); - err(() => { - expect({ foo: { bar: 'baz' } }) - .to.have.property('foo.bar'); - ({ foo: { bar: 'baz' } }).should.have.property('foo.bar'); - }, 'expected { foo: { bar: \'baz\' } } to have a property \'foo.bar\''); -} - -function deepProperty() { - expect({ 'foo.bar': 'baz' }) - .to.not.have.deep.property('foo.bar'); - ({ 'foo.bar': 'baz' }).should - .not.have.deep.property('foo.bar'); - expect({ foo: { bar: 'baz' } }) - .to.have.deep.property('foo.bar'); - ({ foo: { bar: 'baz' } }).should - .have.deep.property('foo.bar'); - - err(() => { - expect({ 'foo.bar': 'baz' }) - .to.have.deep.property('foo.bar'); - ({ 'foo.bar': 'baz' }).should - .have.deep.property('foo.bar'); - }, 'expected { \'foo.bar\': \'baz\' } to have a deep property \'foo.bar\''); -} - -function property2() { - expect('test').to.have.property('length', 4); - 'test'.should.have.property('length', 4); - expect('asd').to.have.property('constructor', String); - 'asd'.should.have.property('constructor', String); - - err(() => { - expect('asd').to.have.property('length', 4, 'blah'); - 'asd'.should.have.property('length', 4, 'blah'); - }, 'blah: expected \'asd\' to have a property \'length\' of 4, but got 3'); - - err(() => { - expect('asd').to.not.have.property('length', 3, 'blah'); - 'asd'.should.not.have.property('length', 3, 'blah'); - }, 'blah: expected \'asd\' to not have a property \'length\' of 3'); - - err(() => { - expect('asd').to.not.have.property('foo', 3, 'blah'); - 'asd'.should.not.have.property('foo', 3, 'blah'); - }, 'blah: \'asd\' has no property \'foo\''); - - err(() => { - expect('asd').to.have.property('constructor', Number, 'blah'); - 'asd'.should.have.property('constructor', Number, 'blah'); - }, 'blah: expected \'asd\' to have a property \'constructor\' of [Function: Number], but got [Function: String]'); -} - -function deepProperty2() { - expect({ foo: { bar: 'baz' } }) - .to.have.deep.property('foo.bar', 'baz'); - ({ foo: { bar: 'baz' } }).should - .have.deep.property('foo.bar', 'baz'); - - err(() => { - expect({ foo: { bar: 'baz' } }) - .to.have.deep.property('foo.bar', 'quux', 'blah'); - ({ foo: { bar: 'baz' } }).should - .have.deep.property('foo.bar', 'quux', 'blah'); - }, 'blah: expected { foo: { bar: \'baz\' } } to have a deep property \'foo.bar\' of \'quux\', but got \'baz\''); - err(() => { - expect({ foo: { bar: 'baz' } }) - .to.not.have.deep.property('foo.bar', 'baz', 'blah'); - ({ foo: { bar: 'baz' } }).should - .not.have.deep.property('foo.bar', 'baz', 'blah'); - }, 'blah: expected { foo: { bar: \'baz\' } } to not have a deep property \'foo.bar\' of \'baz\''); - err(() => { - expect({ foo: 5 }) - .to.not.have.deep.property('foo.bar', 'baz', 'blah'); - ({ foo: 5 }).should - .not.have.deep.property('foo.bar', 'baz', 'blah'); - }, 'blah: { foo: 5 } has no deep property \'foo.bar\''); -} - -function ownProperty() { - expect('test').to.have.ownProperty('length'); - 'test'.should.have.ownProperty('length'); - expect('test').to.haveOwnProperty('length'); - 'test'.should.haveOwnProperty('length'); - expect({ length: 12 }).to.have.ownProperty('length'); - ({ length: 12 }).should.have.ownProperty('length'); - - err(() => { - expect({ length: 12 }).to.not.have.ownProperty('length', 'blah'); - ({ length: 12 }).should.not.have.ownProperty('length', 'blah'); - }, 'blah: expected { length: 12 } to not have own property \'length\''); -} - -function ownPropertyDescriptor() { - expect('test').to.have.ownPropertyDescriptor('length'); - expect('test').to.have.ownPropertyDescriptor('length', { enumerable: false, configurable: false, writable: false, value: 4 }); - expect('test').not.to.have.ownPropertyDescriptor('length', { enumerable: false, configurable: false, writable: false, value: 3 }); - expect('test').to.haveOwnPropertyDescriptor('length').to.have.property('enumerable', false); - expect('test').to.haveOwnPropertyDescriptor('length').to.contain.keys('value'); - - 'test'.should.have.ownPropertyDescriptor('length'); - 'test'.should.have.ownPropertyDescriptor('length', { enumerable: false, configurable: false, writable: false, value: 4 }); - 'test'.should.not.have.ownPropertyDescriptor('length', { enumerable: false, configurable: false, writable: false, value: 3 }); - 'test'.should.haveOwnPropertyDescriptor('length').to.have.property('enumerable', false); - 'test'.should.haveOwnPropertyDescriptor('length').to.contain.keys('value'); -} - -function string() { - expect('foobar').to.have.string('bar'); - 'foobar'.should.have.string('bar'); - expect('foobar').to.have.string('foo'); - 'foobar'.should.have.string('foo'); - expect('foobar').to.not.have.string('baz'); - 'foobar'.should.not.have.string('baz'); - - err(() => { - expect(3).to.have.string('baz'); - (3).should.have.string('baz'); - }, 'expected 3 to be a string'); - - err(() => { - expect('foobar').to.have.string('baz', 'blah'); - 'foobar'.should.have.string('baz', 'blah'); - }, 'blah: expected \'foobar\' to contain \'baz\''); - - err(() => { - expect('foobar').to.not.have.string('bar', 'blah'); - 'foobar'.should.not.have.string('bar', 'blah'); - }, 'blah: expected \'foobar\' to not contain \'bar\''); -} - -function include() { - expect(['foo', 'bar']).to.include('foo'); - ['foo', 'bar'].should.include('foo'); - expect(['foo', 'bar']).to.include('foo'); - ['foo', 'bar'].should.include('foo'); - expect(['foo', 'bar']).to.include('bar'); - ['foo', 'bar'].should.include('bar'); - expect([1, 2]).to.include(1); - [1, 2].should.include(1); - expect(['foo', 'bar']).to.not.include('baz'); - ['foo', 'bar'].should.not.include('baz'); - expect(['foo', 'bar']).to.not.include(1); - ['foo', 'bar'].should.not.include(1); - // alias - - expect(['foo', 'bar']).includes('foo'); - ['foo', 'bar'].should.includes('foo'); - - err(() => { - expect(['foo']).to.include('bar', 'blah'); - ['foo'].should.include('bar', 'blah'); - }, 'blah: expected [ \'foo\' ] to include \'bar\''); - - err(() => { - expect(['bar', 'foo']).to.not.include('foo', 'blah'); - ['bar', 'foo'].should.not.include('foo', 'blah'); - }, 'blah: expected [ \'bar\', \'foo\' ] to not include \'foo\''); -} - -function keys() { - expect({ foo: 1 }).to.have.keys(['foo']); - ({ foo: 1 }).should.have.keys(['foo']); - expect({ foo: 1, bar: 2 }).to.have.keys(['foo', 'bar']); - ({ foo: 1, bar: 2 }).should.have.keys(['foo', 'bar']); - expect({ foo: 1, bar: 2 }).to.have.keys('foo', 'bar'); - ({ foo: 1, bar: 2 }).should.have.keys('foo', 'bar'); - expect({ foo: 1, bar: 2, baz: 3 }).to.contain.keys('foo', 'bar'); - ({ foo: 1, bar: 2, baz: 3 }).should.contain.keys('foo', 'bar'); - expect({ foo: 1, bar: 2, baz: 3 }).to.contain.keys('bar', 'foo'); - ({ foo: 1, bar: 2, baz: 3 }).should.contain.keys('bar', 'foo'); - expect({ foo: 1, bar: 2, baz: 3 }).to.contain.keys('baz'); - ({ foo: 1, bar: 2, baz: 3 }).should.contain.keys('baz'); - // alias - - expect({ foo: 1, bar: 2, baz: 3 }).contains.keys('baz'); - - expect({ foo: 1, bar: 2 }).to.have.all.keys(['foo', 'bar']); - expect({ foo: 1, bar: 2 }).to.have.any.keys(['foo', 'bar']); - ({ foo: 1, bar: 2, baz: 3 }).should.contain.all.keys('baz'); - ({ foo: 1, bar: 2, baz: 3 }).should.contain.any.keys('baz'); - - expect({ foo: 1, bar: 2 }).to.contain.keys('foo'); - ({ foo: 1, bar: 2 }).should.contain.keys('foo'); - expect({ foo: 1, bar: 2 }).to.contain.keys('bar', 'foo'); - ({ foo: 1, bar: 2 }).should.contain.keys('bar', 'foo'); - expect({ foo: 1, bar: 2 }).to.contain.keys(['foo']); - ({ foo: 1, bar: 2 }).should.contain.keys(['foo']); - expect({ foo: 1, bar: 2 }).to.contain.keys(['bar']); - ({ foo: 1, bar: 2 }).should.contain.keys(['bar']); - expect({ foo: 1, bar: 2 }).to.contain.keys(['bar', 'foo']); - ({ foo: 1, bar: 2 }).should.contain.keys(['bar', 'foo']); - - expect({ foo: 1, bar: 2 }).to.not.have.keys('baz'); - ({ foo: 1, bar: 2 }).should.not.have.keys('baz'); - expect({ foo: 1, bar: 2 }).to.not.have.keys('foo', 'baz'); - ({ foo: 1, bar: 2 }).should.not.have.keys('foo', 'baz'); - expect({ foo: 1, bar: 2 }).to.not.contain.keys('baz'); - ({ foo: 1, bar: 2 }).should.not.contain.keys('baz'); - expect({ foo: 1, bar: 2 }).to.not.contain.keys('foo', 'baz'); - ({ foo: 1, bar: 2 }).should.not.contain.keys('foo', 'baz'); - expect({ foo: 1, bar: 2 }).to.not.contain.keys('baz', 'foo'); - ({ foo: 1, bar: 2 }).should.not.contain.keys('baz', 'foo'); - - err(() => { - expect({ foo: 1 }).to.have.keys(); - ({ foo: 1 }).should.have.keys(); - }, 'keys required'); - - err(() => { - expect({ foo: 1 }).to.have.keys([]); - ({ foo: 1 }).should.have.keys([]); - }, 'keys required'); - - err(() => { - expect({ foo: 1 }).to.not.have.keys([]); - ({ foo: 1 }).should.not.have.keys([]); - }, 'keys required'); - - err(() => { - expect({ foo: 1 }).to.contain.keys([]); - ({ foo: 1 }).should.contain.keys([]); - }, 'keys required'); - - err(() => { - expect({ foo: 1 }).to.have.keys(['bar']); - ({ foo: 1 }).should.have.keys(['bar']); - }, 'expected { foo: 1 } to have key \'bar\''); - - err(() => { - expect({ foo: 1 }).to.have.keys(['bar', 'baz']); - ({ foo: 1 }).should.have.keys(['bar', 'baz']); - }, 'expected { foo: 1 } to have keys \'bar\', and \'baz\''); - - err(() => { - expect({ foo: 1 }).to.have.keys(['foo', 'bar', 'baz']); - ({ foo: 1 }).should.have.keys(['foo', 'bar', 'baz']); - }, 'expected { foo: 1 } to have keys \'foo\', \'bar\', and \'baz\''); - - err(() => { - expect({ foo: 1 }).to.not.have.keys(['foo']); - ({ foo: 1 }).should.not.have.keys(['foo']); - }, 'expected { foo: 1 } to not have key \'foo\''); - - err(() => { - expect({ foo: 1 }).to.not.have.keys(['foo']); - ({ foo: 1 }).should.not.have.keys(['foo']); - }, 'expected { foo: 1 } to not have key \'foo\''); - - err(() => { - expect({ foo: 1, bar: 2 }).to.not.have.keys(['foo', 'bar']); - ({ foo: 1, bar: 2 }).should.not.have.keys(['foo', 'bar']); - }, 'expected { foo: 1, bar: 2 } to not have keys \'foo\', and \'bar\''); - - err(() => { - expect({ foo: 1 }).to.not.contain.keys(['foo']); - ({ foo: 1 }).should.not.contain.keys(['foo']); - }, 'expected { foo: 1 } to not contain key \'foo\''); - - err(() => { - expect({ foo: 1 }).to.contain.keys('foo', 'bar'); - ({ foo: 1 }).should.contain.keys('foo', 'bar'); - }, 'expected { foo: 1 } to contain keys \'foo\', and \'bar\''); -} - -function chaining() { - var tea = { name: 'chai', extras: ['milk', 'sugar', 'smile'] }; - expect(tea).to.have.property('extras').with.lengthOf(3); - tea.should.have.property('extras').with.lengthOf(3); - - err(() => { - expect(tea).to.have.property('extras').with.lengthOf(4); - tea.should.have.property('extras').with.lengthOf(4); - }, 'expected [ \'milk\', \'sugar\', \'smile\' ] to have a length of 4 but got 3'); - - expect(tea).to.be.a('object').and.have.property('name', 'chai'); - tea.should.be.a('object').and.have.property('name', 'chai'); -} - -function exxtensible() { - expect({}).to.be.extensible; - expect(Object.preventExtensions({})).to.be.not.extensible; - ({}).should.be.extensible; - Object.preventExtensions({}).should.not.be.extensible; -} -function sealed() { - expect({}).to.be.not.sealed; - expect(Object.seal({})).to.be.sealed; - ({}).should.be.not.sealed; - Object.seal({}).should.be.sealed; -} - -function frozen() { - expect({}).to.be.not.frozen; - expect(Object.freeze({})).to.be.frozen; - ({}).should.be.not.frozen; - Object.freeze({}).should.be.frozen; -} - - -class PoorlyConstructedError { } -function _throw() { - // See GH-45: some poorly-constructed custom errors don't have useful names - // on either their constructor or their constructor prototype, but instead - // only set the name inside the constructor itself. - PoorlyConstructedError.prototype = Object.create(Error.prototype); - - var specificError = new RangeError('boo'); - - var goodFn = () => { } - , badFn = () => { throw new Error('testing'); } - , refErrFn = () => { throw new ReferenceError('hello'); } - , ickyErrFn = () => { throw new PoorlyConstructedError(); } - , specificErrFn = () => { throw specificError; }; - - expect(goodFn).to.not.throw(); - goodFn.should.not.throw(); - should.not.throw(goodFn); - expect(goodFn).to.not.throw(Error); - goodFn.should.not.throw(Error); - should.not.throw(goodFn, Error); - expect(goodFn).to.not.throw(specificError); - goodFn.should.not.throw(specificError); - should.not.throw(goodFn, specificError); - - expect(badFn).to.throw(); - badFn.should.throw(); - should.throw(badFn); - expect(badFn).to.throw(Error); - badFn.should.throw(Error); - should.throw(badFn, Error); - expect(badFn).to.not.throw(ReferenceError); - badFn.should.not.throw(ReferenceError); - should.not.throw(badFn, ReferenceError); - expect(badFn).to.not.throw(specificError); - badFn.should.not.throw(specificError); - should.not.throw(badFn, specificError); - - expect(refErrFn).to.throw(); - refErrFn.should.throw(); - should.throw(refErrFn); - expect(refErrFn).to.throw(ReferenceError); - refErrFn.should.throw(ReferenceError); - should.throw(refErrFn, ReferenceError); - expect(refErrFn).to.throw(Error); - refErrFn.should.throw(Error); - should.throw(refErrFn, Error); - expect(refErrFn).to.not.throw(TypeError); - refErrFn.should.not.throw(TypeError); - should.not.throw(refErrFn, TypeError); - expect(refErrFn).to.not.throw(specificError); - refErrFn.should.not.throw(specificError); - should.not.throw(refErrFn, specificError); - - expect(ickyErrFn).to.throw(); - ickyErrFn.should.throw(); - should.throw(ickyErrFn); - expect(ickyErrFn).to.throw(PoorlyConstructedError); - ickyErrFn.should.throw(PoorlyConstructedError); - should.throw(ickyErrFn, PoorlyConstructedError); - expect(ickyErrFn).to.throw(Error); - ickyErrFn.should.throw(Error); - should.throw(ickyErrFn, Error); - expect(ickyErrFn).to.not.throw(specificError); - ickyErrFn.should.not.throw(specificError); - should.not.throw(ickyErrFn, specificError); - expect(specificErrFn).to.throw(specificError); - specificErrFn.should.throw(specificError); - should.throw(ickyErrFn, specificError); - - expect(badFn).to.throw(/testing/); - badFn.should.throw(/testing/); - should.throw(badFn, /testing/); - expect(badFn).to.not.throw(/hello/); - badFn.should.not.throw(/hello/); - should.not.throw(badFn, /hello/); - expect(badFn).to.throw('testing'); - badFn.should.throw('testing'); - should.throw(badFn, 'testing'); - expect(badFn).to.not.throw('hello'); - badFn.should.not.throw('hello'); - should.not.throw(badFn, 'hello'); - - expect(badFn).to.throw(Error, /testing/); - badFn.should.throw(Error, /testing/); - should.throw(badFn, Error, /testing/); - expect(badFn).to.throw(Error, 'testing'); - badFn.should.throw(Error, 'testing'); - should.throw(badFn, Error, 'testing'); - - err(() => { - expect(goodFn).to.throw(); - goodFn.should.throw(); - should.throw(goodFn); - }, 'expected [Function] to throw an error'); - - err(() => { - expect(goodFn).to.throw(ReferenceError); - goodFn.should.throw(ReferenceError); - should.throw(goodFn, ReferenceError); - }, 'expected [Function] to throw ReferenceError'); - - err(() => { - expect(goodFn).to.throw(specificError); - goodFn.should.throw(specificError); - should.throw(goodFn, specificError); - }, 'expected [Function] to throw [RangeError: boo]'); - - err(() => { - expect(badFn).to.not.throw(); - badFn.should.not.throw(); - should.not.throw(badFn); - }, 'expected [Function] to not throw an error but [Error: testing] was thrown'); - - err(() => { - expect(badFn).to.throw(ReferenceError); - badFn.should.throw(ReferenceError); - should.throw(badFn, ReferenceError); - }, 'expected [Function] to throw \'ReferenceError\' but [Error: testing] was thrown'); - - err(() => { - expect(badFn).to.throw(specificError); - badFn.should.throw(specificError); - should.throw(badFn, specificError); - }, 'expected [Function] to throw [RangeError: boo] but [Error: testing] was thrown'); - - err(() => { - expect(badFn).to.not.throw(Error); - badFn.should.not.throw(Error); - should.not.throw(badFn, Error); - }, 'expected [Function] to not throw \'Error\' but [Error: testing] was thrown'); - - err(() => { - expect(refErrFn).to.not.throw(ReferenceError); - refErrFn.should.not.throw(ReferenceError); - should.not.throw(refErrFn, ReferenceError); - }, 'expected [Function] to not throw \'ReferenceError\' but [ReferenceError: hello] was thrown'); - - err(() => { - expect(badFn).to.throw(PoorlyConstructedError); - badFn.should.throw(PoorlyConstructedError); - should.throw(badFn, PoorlyConstructedError); - }, 'expected [Function] to throw \'PoorlyConstructedError\' but [Error: testing] was thrown'); - - err(() => { - expect(ickyErrFn).to.not.throw(PoorlyConstructedError); - ickyErrFn.should.not.throw(PoorlyConstructedError); - should.not.throw(ickyErrFn, PoorlyConstructedError); - }, /^(expected \[Function\] to not throw 'PoorlyConstructedError' but)(.*)(PoorlyConstructedError|\{ Object \()(.*)(was thrown)$/); - - err(() => { - expect(ickyErrFn).to.throw(ReferenceError); - ickyErrFn.should.throw(ReferenceError); - should.throw(ickyErrFn, ReferenceError); - }, /^(expected \[Function\] to throw 'ReferenceError' but)(.*)(PoorlyConstructedError|\{ Object \()(.*)(was thrown)$/); - - err(() => { - expect(specificErrFn).to.throw(new ReferenceError('eek')); - specificErrFn.should.throw(new ReferenceError('eek')); - should.throw(specificErrFn, new ReferenceError('eek')); - }, 'expected [Function] to throw [ReferenceError: eek] but [RangeError: boo] was thrown'); - - err(() => { - expect(specificErrFn).to.not.throw(specificError); - specificErrFn.should.not.throw(specificError); - should.not.throw(specificErrFn, specificError); - }, 'expected [Function] to not throw [RangeError: boo]'); - - err(() => { - expect(badFn).to.not.throw(/testing/); - badFn.should.not.throw(/testing/); - should.not.throw(badFn, /testing/); - }, 'expected [Function] to throw error not matching /testing/'); - - err(() => { - expect(badFn).to.throw(/hello/); - badFn.should.throw(/hello/); - should.throw(badFn, /hello/); - }, 'expected [Function] to throw error matching /hello/ but got \'testing\''); - - err(() => { - expect(badFn).to.throw(Error, /hello/, 'blah'); - badFn.should.throw(Error, /hello/, 'blah'); - should.throw(badFn, Error, /hello/, 'blah'); - }, 'blah: expected [Function] to throw error matching /hello/ but got \'testing\''); - - err(() => { - expect(badFn).to.throw(Error, 'hello', 'blah'); - badFn.should.throw(Error, 'hello', 'blah'); - should.throw(badFn, Error, 'hello', 'blah'); - }, 'blah: expected [Function] to throw error including \'hello\' but got \'testing\''); -} - -function use() { - // ReSharper disable once InconsistentNaming - chai.use((_chai) => { - _chai.can.use.any(); - }); -} - -class Klass { - val: number; - constructor() { this.val = 0; } - bar() { } - - static baz() { } -} - -function respondTo() { - var obj = new Klass(); - - expect(Klass).to.respondTo('bar'); - expect(obj).respondsTo('bar'); - Klass.should.respondTo('bar'); - Klass.should.respondsTo('bar'); - expect(Klass).to.not.respondTo('foo'); - Klass.should.not.respondTo('foo'); - expect(Klass).itself.to.respondTo('func'); - expect(Klass).itself.not.to.respondTo('bar'); - - expect(obj).not.to.respondTo('foo'); - obj.should.not.respondTo('foo'); - - err(() => { - expect(Klass).to.respondTo('baz', 'constructor'); - Klass.should.respondTo('baz', 'constructor'); - }, /^(constructor: expected)(.*)(\[Function: Klass\])(.*)(to respond to \'baz\')$/); - - err(() => { - expect(obj).to.respondTo('baz', 'object'); - obj.should.respondTo('baz', 'object'); - }, /^(object: expected)(.*)(\{ foo: \[Function\] \}|\{ Object \()(.*)(to respond to \'baz\')$/); -} - -function satisfy() { - function matcher(num: number) { - return num === 1; - } - - expect(1).to.satisfy(matcher); - (1).should.satisfy(matcher); - - err(() => { - expect(2).to.satisfy(matcher, 'blah'); - (2).should.satisfy(matcher, 'blah'); - }, 'blah: expected 2 to satisfy [Function: matcher]'); -} - -function closeTo() { - expect(1.5).to.be.closeTo(1.0, 0.5); - (1.5).should.be.closeTo(1.0, 0.5); - expect(10).to.be.closeTo(20, 20); - (10).should.be.closeTo(20, 20); - expect(-10).to.be.closeTo(20, 30); - (-10).should.be.closeTo(20, 30); - - err(() => { - expect(2).to.be.closeTo(1.0, 0.5, 'blah'); - (2).should.be.closeTo(1.0, 0.5, 'blah'); - }, 'blah: expected 2 to be close to 1 +/- 0.5'); - - err(() => { - expect(-10).to.be.closeTo(20, 29, 'blah'); - (-10).should.be.closeTo(20, 29, 'blah'); - }, 'blah: expected -10 to be close to 20 +/- 29'); -} - -function includeMembers() { - expect([1, 2, 3]).to.include.members([]); - [1, 2, 3].should.include.members([]); - - expect([1, 2, 3]).to.include.members([3, 2]); - - [1, 2, 3].should.include.members([3, 2]); - - expect([1, 2, 3]).to.not.include.members([8, 4]); - - [1, 2, 3].should.not.include.members([8, 4]); - - expect([1, 2, 3]).to.not.include.members([1, 2, 3, 4]); - - [1, 2, 3].should.not.include.members([1, 2, 3, 4]); -} - -function sameMembers() { - expect([5, 4]).to.have.same.members([4, 5]); - [5, 4].should.have.same.members([4, 5]); - expect([5, 4]).to.have.same.members([5, 4]); - [5, 4].should.have.same.members([5, 4]); - - expect([5, 4]).to.not.have.same.members([]); - [5, 4].should.not.have.same.members([]); - expect([5, 4]).to.not.have.same.members([6, 3]); - [5, 4].should.not.have.same.members([6, 3]); - expect([5, 4]).to.not.have.same.members([5, 4, 2]); - [5, 4].should.not.have.same.members([5, 4, 2]); - - assert.sameMembers([5, 4], [4, 5]); -} -function sameDeepMembers() { - expect([{ id: 5 }, { id: 4 }]).to.have.same.deep.members([{ id: 4 }, { id: 5 }]); - [{ id: 5 }, { id: 4 }].should.have.same.deep.members([{ id: 4 }, { id: 5 }]); - expect([{ id: 5 }, { id: 4 }]).to.have.same.members([{ id: 5 }, { id: 4 }]); - [{ id: 5 }, { id: 4 }].should.have.same.members([{ id: 5 }, { id: 4 }]); - - expect([{ id: 5 }, { id: 4 }]).to.not.have.same.members([]); - [{ id: 5 }, { id: 4 }].should.not.have.same.members([]); - expect([{ id: 5 }, { id: 4 }]).to.not.have.same.members([{ id: 6 }, { id: 3 }]); - [{ id: 5 }, { id: 4 }].should.not.have.same.members([{ id: 6 }, { id: 3 }]); - expect([{ id: 5 }, { id: 4 }]).to.not.have.same.members([{ id: 5 }, { id: 4 }, { id: 2 }]); - [{ id: 5 }, { id: 4 }].should.not.have.same.members([{ id: 5 }, { id: 4 }, { id: 2 }]); - - assert.sameDeepMembers([{ id: 5 }, { id: 4 }], [{ id: 4 }, { id: 5 }]); -} - -function members() { - expect([5, 4]).members([4, 5]); - expect([5, 4]).members([5, 4]); - - expect([5, 4]).not.members([]); - expect([5, 4]).not.members([6, 3]); - expect([5, 4]).not.members([5, 4, 2]); -} - -function increaseDecreaseChange() { - var obj = { val: 10 }; - var inc = () => { obj.val++; }; - var dec = () => { obj.val--; }; - var same = () => { }; - - expect(inc).to.increase(obj, "val"); - expect(inc).increases(obj, "val"); - expect(inc).to.change(obj, "val"); - - expect(dec).to.decrease(obj, "val"); - expect(dec).decreases(obj, "val"); - expect(dec).to.change(obj, "val"); - expect(dec).changes(obj, "val"); - - expect(inc).to.not.decrease(obj, "val"); - expect(dec).to.not.increase(obj, "val"); - expect(same).to.not.increase(obj, "val"); - expect(same).to.not.decrease(obj, "val"); - expect(same).to.not.change(obj, "val"); - - inc.should.increase(obj, "val"); - inc.should.change(obj, "val"); - - dec.should.decrease(obj, "val"); - dec.should.change(obj, "val"); - - inc.should.not.decrease(obj, "val"); - dec.should.not.increase(obj, "val"); - same.should.not.change(obj, "val"); -} - -//tdd -declare function suite(description: string, action: Function): void; -declare function test(description: string, action: Function): void; - -interface FieldObj { - field: any; -} - -class CrashyObject { - inspect(): void { - throw new Error('Arg\'s inspect() called even though the test passed'); - } -} - -suite('assert', () => { - - test('assert', () => { - var foo = 'bar'; - assert(foo === 'bar', 'expected foo to equal `bar`'); - - err(() => { - assert(foo === 'baz', 'expected foo to equal `bar`'); - }, 'expected foo to equal `bar`'); - }); - - test('isTrue', () => { - assert.isTrue(true); - - err(() => { - assert.isTrue(false); - }, 'expected false to be true'); - - err(() => { - assert.isTrue(1); - }, 'expected 1 to be true'); - - err(() => { - assert.isTrue('test'); - }, 'expected \'test\' to be true'); - }); - - test('ok', () => { - assert.ok(true); - assert.ok(1); - assert.ok('test'); - assert.isOk(true); - assert.isOk(1); - assert.isOk('test'); - - err(() => { - assert.ok(false); - }, 'expected false to be truthy'); - - err(() => { - assert.ok(0); - }, 'expected 0 to be truthy'); - - err(() => { - assert.ok(''); - }, 'expected \'\' to be truthy'); - }); - - test('notOk', () => { - assert.notOk(false); - assert.notOk(0); - assert.notOk(''); - assert.isNotOk(false); - assert.isNotOk(0); - assert.isNotOk(''); - - err(() => { - assert.notOk(true); - }, 'expected true to be falsy'); - - err(() => { - assert.notOk(1); - }, 'expected 1 to be falsy'); - - err(() => { - assert.notOk('test'); - }, 'expected \'test\' to be falsy'); - }); - - test('isFalse', () => { - assert.isFalse(false); - - err(() => { - assert.isFalse(true); - }, 'expected true to be false'); - - err(() => { - assert.isFalse(0); - }, 'expected 0 to be false'); - }); - - test('equal', () => { - assert.equal(void (0), undefined); - }); - - test('typeof / notTypeOf', () => { - assert.typeOf('test', 'string'); - assert.typeOf(true, 'boolean'); - assert.typeOf(5, 'number'); - - err(() => { - assert.typeOf(5, 'string'); - }, 'expected 5 to be a string'); - - }); - - test('notTypeOf', () => { - assert.notTypeOf('test', 'number'); - - err(() => { - assert.notTypeOf(5, 'number'); - }, 'expected 5 not to be a number'); - }); - - test('instanceOf', () => { - assert.instanceOf(new Foo(), Foo); - - err(() => { - assert.instanceOf(5, Foo); - }, 'expected 5 to be an instance of Foo'); - assert.instanceOf(new CrashyObject(), CrashyObject); - }); - - test('notInstanceOf', () => { - assert.notInstanceOf(new Foo(), String); - - err(() => { - assert.notInstanceOf(new Foo(), Foo); - }, 'expected {} to not be an instance of Foo'); - }); - - test('isObject', () => { - assert.isObject({}); - assert.isObject(new Foo()); - - err(() => { - assert.isObject(true); - }, 'expected true to be an object'); - - err(() => { - assert.isObject(Foo); - }, 'expected [Function: Foo] to be an object'); - - err(() => { - assert.isObject('foo'); - }, 'expected \'foo\' to be an object'); - }); - - test('isNotObject', () => { - assert.isNotObject(5); - - err(() => { - assert.isNotObject({}); - }, 'expected {} not to be an object'); - }); - - test('notEqual', () => { - assert.notEqual(3, 4); - - err(() => { - assert.notEqual(5, 5); - }, 'expected 5 to not equal 5'); - }); - - test('strictEqual', () => { - assert.strictEqual('foo', 'foo'); - - err(() => { - assert.strictEqual('5', 5); - }, 'expected \'5\' to equal 5'); - }); - - test('notStrictEqual', () => { - assert.notStrictEqual(5, '5'); - - err(() => { - assert.notStrictEqual(5, 5); - }, 'expected 5 to not equal 5'); - }); - - test('deepEqual', () => { - assert.deepEqual({ tea: 'chai' }, { tea: 'chai' }); - - err(() => { - assert.deepEqual({ tea: 'chai' }, { tea: 'black' }); - }, 'expected { tea: \'chai\' } to deeply equal { tea: \'black\' }'); - - var obja = Object.create({ tea: 'chai' }) - , objb = Object.create({ tea: 'chai' }); - - assert.deepEqual(obja, objb); - - var obj1 = Object.create({ tea: 'chai' }) - , obj2 = Object.create({ tea: 'black' }); - - err(() => { - assert.deepEqual(obj1, obj2); - }, 'expected { tea: \'chai\' } to deeply equal { tea: \'black\' }'); - }); - - test('deepEqual (ordering)', () => { - var a = { a: 'b', c: 'd' } - , b = { c: 'd', a: 'b' }; - assert.deepEqual(a, b); - }); - - test('deepEqual (circular)', () => { - var circularObject: any = {} - , secondCircularObject: any = {}; - circularObject.field = circularObject; - secondCircularObject.field = secondCircularObject; - - assert.deepEqual(circularObject, secondCircularObject); - - err(() => { - secondCircularObject.field2 = secondCircularObject; - assert.deepEqual(circularObject, secondCircularObject); - }, 'expected { field: [Circular] } to deeply equal { Object (field, field2) }'); - }); - - test('notDeepEqual', () => { - assert.notDeepEqual({ tea: 'jasmine' }, { tea: 'chai' }); - err(() => { - assert.notDeepEqual({ tea: 'chai' }, { tea: 'chai' }); - }, 'expected { tea: \'chai\' } to not deeply equal { tea: \'chai\' }'); - }); - - test('notDeepEqual (circular)', () => { - var circularObject: any = {} - , secondCircularObject: any = { tea: 'jasmine' }; - circularObject.field = circularObject; - secondCircularObject.field = secondCircularObject; - - assert.notDeepEqual(circularObject, secondCircularObject); - - err(() => { - delete secondCircularObject.tea; - assert.notDeepEqual(circularObject, secondCircularObject); - }, 'expected { field: [Circular] } to not deeply equal { field: [Circular] }'); - }); - - test('isNull', () => { - assert.isNull(null); - - err(() => { - assert.isNull(undefined); - }, 'expected undefined to equal null'); - }); - - test('isNotNull', () => { - assert.isNotNull(undefined); - - err(() => { - assert.isNotNull(null); - }, 'expected null to not equal null'); - }); - - test('isUndefined', () => { - assert.isUndefined(undefined); - - err(() => { - assert.isUndefined(null); - }, 'expected null to equal undefined'); - }); - - test('isDefined', () => { - assert.isDefined(null); - - err(() => { - assert.isDefined(undefined); - }, 'expected undefined to not equal undefined'); - }); - - test('isNaN', () => { - assert.isNaN(NaN); - - err(() => { - assert.isNaN(12); - }, 'expected 12 to be NaN'); - }); - - test('isNotNaN', () => { - assert.isNotNaN(12); - - err(() => { - assert.isNotNaN(NaN); - }, 'expected NaN to not NaN'); - }); - - test('isFunction', () => { - var func = () => { - }; - assert.isFunction(func); - - err(() => { - assert.isFunction({}); - }, 'expected {} to be a function'); - }); - - test('isNotFunction', () => { - assert.isNotFunction(5); - - err(() => { - assert.isNotFunction(() => { - }); - }, 'expected [Function] not to be a function'); - }); - - test('isArray', () => { - assert.isArray([]); - assert.isArray(new Array()); - - err(() => { - assert.isArray({}); - }, 'expected {} to be an array'); - }); - - test('isNotArray', () => { - assert.isNotArray(3); - - err(() => { - assert.isNotArray([]); - }, 'expected [] not to be an array'); - - err(() => { - assert.isNotArray(new Array()); - }, 'expected [] not to be an array'); - }); - - test('isString', () => { - assert.isString('Foo'); - assert.isString(new String('foo')); - - err(() => { - assert.isString(1); - }, 'expected 1 to be a string'); - }); - - test('isNotString', () => { - assert.isNotString(3); - assert.isNotString(['hello']); - - err(() => { - assert.isNotString('hello'); - }, 'expected \'hello\' not to be a string'); - }); - - test('isNumber', () => { - assert.isNumber(1); - assert.isNumber(Number('3')); - - err(() => { - assert.isNumber('1'); - }, 'expected \'1\' to be a number'); - }); - - test('isNotNumber', () => { - assert.isNotNumber('hello'); - assert.isNotNumber([5]); - - err(() => { - assert.isNotNumber(4); - }, 'expected 4 not to be a number'); - }); - - test('isBoolean', () => { - assert.isBoolean(true); - assert.isBoolean(false); - - err(() => { - assert.isBoolean('1'); - }, 'expected \'1\' to be a boolean'); - }); - - test('isNotBoolean', () => { - assert.isNotBoolean('true'); - - err(() => { - assert.isNotBoolean(true); - }, 'expected true not to be a boolean'); - - err(() => { - assert.isNotBoolean(false); - }, 'expected false not to be a boolean'); - }); - - test('include', () => { - assert.include('foobar', 'bar'); - assert.include([1, 2, 3], 3); - - err(() => { - assert.include('foobar', 'baz'); - }, 'expected \'foobar\' to contain \'baz\''); - - err(() => { - assert.include(undefined, 'bar'); - }, 'expected an array or string'); - }); - - test('notInclude', () => { - assert.notInclude('foobar', 'baz'); - assert.notInclude([1, 2, 3], 4); - - err(() => { - assert.notInclude('foobar', 'bar'); - }, 'expected \'foobar\' to not contain \'bar\''); - - err(() => { - assert.notInclude(undefined, 'bar'); - }, 'expected an array or string'); - }); - - test('lengthOf', () => { - assert.lengthOf([1, 2, 3], 3); - assert.lengthOf('foobar', 6); - - err(() => { - assert.lengthOf('foobar', 5); - }, 'expected \'foobar\' to have a length of 5 but got 6'); - - err(() => { - assert.lengthOf(1, 5); - }, 'expected 1 to have a property \'length\''); - }); - - test('match', () => { - assert.match('foobar', /^foo/); - assert.notMatch('foobar', /^bar/); - - err(() => { - assert.match('foobar', /^bar/i); - }, 'expected \'foobar\' to match /^bar/i'); - - err(() => { - assert.notMatch('foobar', /^foo/i); - }, 'expected \'foobar\' not to match /^foo/i'); - }); - - test('property', () => { - var obj = { foo: { bar: 'baz' } }; - var simpleObj = { foo: 'bar' }; - assert.property(obj, 'foo'); - assert.deepProperty(obj, 'foo.bar'); - assert.notProperty(obj, 'baz'); - assert.notProperty(obj, 'foo.bar'); - assert.notDeepProperty(obj, 'foo.baz'); - assert.deepPropertyVal(obj, 'foo.bar', 'baz'); - assert.deepPropertyNotVal(obj, 'foo.bar', 'flow'); - - err(() => { - assert.property(obj, 'baz'); - }, 'expected { foo: { bar: \'baz\' } } to have a property \'baz\''); - - err(() => { - assert.deepProperty(obj, 'foo.baz'); - }, 'expected { foo: { bar: \'baz\' } } to have a deep property \'foo.baz\''); - - err(() => { - assert.notProperty(obj, 'foo'); - }, 'expected { foo: { bar: \'baz\' } } to not have property \'foo\''); - - err(() => { - assert.notDeepProperty(obj, 'foo.bar'); - }, 'expected { foo: { bar: \'baz\' } } to not have deep property \'foo.bar\''); - - err(() => { - assert.propertyVal(simpleObj, 'foo', 'ball'); - }, 'expected { foo: \'bar\' } to have a property \'foo\' of \'ball\', but got \'bar\''); - - err(() => { - assert.deepPropertyVal(obj, 'foo.bar', 'ball'); - }, 'expected { foo: { bar: \'baz\' } } to have a deep property \'foo.bar\' of \'ball\', but got \'baz\''); - - err(() => { - assert.propertyNotVal(simpleObj, 'foo', 'bar'); - }, 'expected { foo: \'bar\' } to not have a property \'foo\' of \'bar\''); - - err(() => { - assert.deepPropertyNotVal(obj, 'foo.bar', 'baz'); - }, 'expected { foo: { bar: \'baz\' } } to not have a deep property \'foo.bar\' of \'baz\''); - }); - - test('throws', () => { - assert.throws(() => { - throw new Error('foo'); - }); - assert.throws(() => { - throw new Error('bar'); - }, 'bar'); - assert.throws(() => { - throw new Error('bar'); - }, /bar/); - assert.throws(() => { - throw new Error('bar'); - }, Error); - assert.throws(() => { - throw new Error('bar'); - }, Error, 'bar'); - - err(() => { - assert.throws(() => { - throw new Error('foo'); - }, TypeError); - }, 'expected [Function] to throw \'TypeError\' but [Error: foo] was thrown'); - - err(() => { - assert.throws(() => { - throw new Error('foo'); - }, 'bar'); - }, 'expected [Function] to throw error including \'bar\' but got \'foo\''); - - err(() => { - assert.throws(() => { - throw new Error('foo'); - }, Error, 'bar'); - }, 'expected [Function] to throw error including \'bar\' but got \'foo\''); - - err(() => { - assert.throws(() => { - throw new Error('foo'); - }, TypeError, 'bar'); - }, 'expected [Function] to throw \'TypeError\' but [Error: foo] was thrown'); - - err(() => { - assert.throws(() => { - }); - }, 'expected [Function] to throw an error'); - - err(() => { - assert.throws(() => { - throw new Error(''); - }, 'bar'); - }, 'expected [Function] to throw error including \'bar\' but got \'\''); - - err(() => { - assert.throws(() => { - throw new Error(''); - }, /bar/); - }, 'expected [Function] to throw error matching /bar/ but got \'\''); - }); - - test('doesNotThrow', () => { - assert.doesNotThrow(() => { - }); - assert.doesNotThrow(() => { - }, 'foo'); - - err(() => { - assert.doesNotThrow(() => { - throw new Error('foo'); - }); - }, 'expected [Function] to not throw an error but [Error: foo] was thrown'); - }); - - test('ifError', () => { - assert.ifError(false); - assert.ifError(null); - assert.ifError(undefined); - - err(() => { - assert.ifError('foo'); - }, 'expected \'foo\' to be falsy'); - }); - - test('operator', () => { - assert.operator(1, '<', 2); - assert.operator(2, '>', 1); - assert.operator(1, '==', 1); - assert.operator(1, '<=', 1); - assert.operator(1, '>=', 1); - assert.operator(1, '!=', 2); - assert.operator(1, '!==', 2); - - err(() => { - assert.operator(1, '=', 2); - }, 'Invalid operator "="'); - - err(() => { - assert.operator(2, '<', 1); - }, 'expected 2 to be < 1'); - - err(() => { - assert.operator(1, '>', 2); - }, 'expected 1 to be > 2'); - - err(() => { - assert.operator(1, '==', 2); - }, 'expected 1 to be == 2'); - - err(() => { - assert.operator(2, '<=', 1); - }, 'expected 2 to be <= 1'); - - err(() => { - assert.operator(1, '>=', 2); - }, 'expected 1 to be >= 2'); - - err(() => { - assert.operator(1, '!=', 1); - }, 'expected 1 to be != 1'); - - err(() => { - assert.operator(1, '!==', '1'); - }, 'expected 1 to be !== \'1\''); - }); - - test('closeTo', () => { - assert.closeTo(1.5, 1.0, 0.5); - assert.closeTo(10, 20, 20); - assert.closeTo(-10, 20, 30); - - err(() => { - assert.closeTo(2, 1.0, 0.5); - }, 'expected 2 to be close to 1 +/- 0.5'); - - err(() => { - assert.closeTo(-10, 20, 29); - }, 'expected -10 to be close to 20 +/- 29'); - }); - - test('members', () => { - assert.includeMembers([1, 2, 3], [2, 3]); - assert.includeMembers([1, 2, 3], []); - assert.includeMembers([1, 2, 3], [3]); - - err(() => { - assert.includeMembers([5, 6], [7, 8]); - }, 'expected [ 5, 6 ] to be a superset of [ 7, 8 ]'); - - err(() => { - assert.includeMembers([5, 6], [5, 6, 0]); - }, 'expected [ 5, 6 ] to be a superset of [ 5, 6, 0 ]'); - }); - - test('memberEquals', () => { - assert.sameMembers([], []); - assert.sameMembers([1, 2, 3], [3, 2, 1]); - assert.sameMembers([4, 2], [4, 2]); - - err(() => { - assert.sameMembers([], [1, 2]); - }, 'expected [] to have the same members as [ 1, 2 ]'); - - err(() => { - assert.sameMembers([1, 54], [6, 1, 54]); - }, 'expected [ 1, 54 ] to have the same members as [ 6, 1, 54 ]'); - }); - - - test('isAbove', () => { - assert.isAbove(10, 5); - - err(() => { - assert.isAbove(1, 5); - }, 'expected 1 to be above 5'); - err(() => { - assert.isAbove(5, 5); - }, 'expected 5 to be above 5'); - }); - - test('isBelow', () => { - assert.isBelow(5, 10); - - err(() => { - assert.isBelow(5, 1); - }, 'expected 5 to be above 1'); - err(() => { - assert.isBelow(5, 5); - }, 'expected 5 to be below 5'); - }); - - test('isAtLeast', () => { - assert.isAtLeast(5, 3); - assert.isAtLeast(5, 5); - - err(() => { - assert.isAtLeast(3, 5); - }, 'expected 3 to be greater than or equal to 5'); - }); - - test('isAtMost', () => { - assert.isAtMost(3, 5); - assert.isAtMost(5, 5); - - err(() => { - assert.isAtMost(5, 3); - }, 'expected 5 to be less than or equal to 3'); - }); - - test('extensible', () => { assert.extensible({}); }); - test('isExtensible', () => { assert.isExtensible({}); }); - test('notExtensible', () => { assert.notExtensible(Object.preventExtensions({})); }); - test('isNotExtensible', () => { assert.isNotExtensible(Object.preventExtensions({})); }); - - test('sealed', () => { assert.sealed(Object.seal({})); }); - test('isSealed', () => { assert.isSealed(Object.seal({})); }); - test('notSealed', () => { assert.notSealed({}); }); - test('isNotSealed', () => { assert.isNotSealed({}); }); - - test('frozen', () => { assert.frozen(Object.freeze({})); }); - test('isFrozen', () => { assert.isFrozen(Object.freeze({})); }); - test('notFrozen', () => { assert.notFrozen({}); }); - test('isNotFrozen', () => { assert.isNotFrozen({}); }); - -}); diff --git a/chai/chai-3.2.0.d.ts b/chai/chai-3.2.0.d.ts deleted file mode 100644 index 7e4e1a1ff4..0000000000 --- a/chai/chai-3.2.0.d.ts +++ /dev/null @@ -1,391 +0,0 @@ -// Type definitions for chai 3.2.0 -// Project: http://chaijs.com/ -// Definitions by: Jed Mao , -// Bart van der Schoor , -// Andrew Brown , -// Olivier Chevet -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -// - -declare namespace Chai { - - interface ChaiStatic { - expect: ExpectStatic; - should(): Should; - /** - * Provides a way to extend the internals of Chai - */ - use(fn: (chai: any, utils: any) => void): any; - assert: AssertStatic; - config: Config; - AssertionError: typeof AssertionError; - } - - export interface ExpectStatic extends AssertionStatic { - fail(actual?: any, expected?: any, message?: string, operator?: string): void; - } - - export interface AssertStatic extends Assert { - } - - export interface AssertionStatic { - (target: any, message?: string): Assertion; - } - - interface ShouldAssertion { - equal(value1: any, value2: any, message?: string): void; - Throw: ShouldThrow; - throw: ShouldThrow; - exist(value: any, message?: string): void; - } - - interface Should extends ShouldAssertion { - not: ShouldAssertion; - fail(actual: any, expected: any, message?: string, operator?: string): void; - } - - interface ShouldThrow { - (actual: Function): void; - (actual: Function, expected: string|RegExp, message?: string): void; - (actual: Function, constructor: Error|Function, expected?: string|RegExp, message?: string): void; - } - - interface Assertion extends LanguageChains, NumericComparison, TypeComparison { - not: Assertion; - deep: Deep; - any: KeyFilter; - all: KeyFilter; - a: TypeComparison; - an: TypeComparison; - include: Include; - includes: Include; - contain: Include; - contains: Include; - ok: Assertion; - true: Assertion; - false: Assertion; - null: Assertion; - undefined: Assertion; - NaN: Assertion; - exist: Assertion; - empty: Assertion; - arguments: Assertion; - Arguments: Assertion; - equal: Equal; - equals: Equal; - eq: Equal; - eql: Equal; - eqls: Equal; - property: Property; - ownProperty: OwnProperty; - haveOwnProperty: OwnProperty; - ownPropertyDescriptor: OwnPropertyDescriptor; - haveOwnPropertyDescriptor: OwnPropertyDescriptor; - length: Length; - lengthOf: Length; - match: Match; - matches: Match; - string(string: string, message?: string): Assertion; - keys: Keys; - key(string: string): Assertion; - throw: Throw; - throws: Throw; - Throw: Throw; - respondTo: RespondTo; - respondsTo: RespondTo; - itself: Assertion; - satisfy: Satisfy; - satisfies: Satisfy; - closeTo(expected: number, delta: number, message?: string): Assertion; - members: Members; - increase: PropertyChange; - increases: PropertyChange; - decrease: PropertyChange; - decreases: PropertyChange; - change: PropertyChange; - changes: PropertyChange; - extensible: Assertion; - sealed: Assertion; - frozen: Assertion; - - } - - interface LanguageChains { - to: Assertion; - be: Assertion; - been: Assertion; - is: Assertion; - that: Assertion; - which: Assertion; - and: Assertion; - has: Assertion; - have: Assertion; - with: Assertion; - at: Assertion; - of: Assertion; - same: Assertion; - } - - interface NumericComparison { - above: NumberComparer; - gt: NumberComparer; - greaterThan: NumberComparer; - least: NumberComparer; - gte: NumberComparer; - below: NumberComparer; - lt: NumberComparer; - lessThan: NumberComparer; - most: NumberComparer; - lte: NumberComparer; - within(start: number, finish: number, message?: string): Assertion; - } - - interface NumberComparer { - (value: number, message?: string): Assertion; - } - - interface TypeComparison { - (type: string, message?: string): Assertion; - instanceof: InstanceOf; - instanceOf: InstanceOf; - } - - interface InstanceOf { - (constructor: Object, message?: string): Assertion; - } - - interface Deep { - equal: Equal; - include: Include; - property: Property; - members: Members; - } - - interface KeyFilter { - keys: Keys; - } - - interface Equal { - (value: any, message?: string): Assertion; - } - - interface Property { - (name: string, value?: any, message?: string): Assertion; - } - - interface OwnProperty { - (name: string, message?: string): Assertion; - } - - interface OwnPropertyDescriptor { - (name: string, descriptor: PropertyDescriptor, message?: string): Assertion; - (name: string, message?: string): Assertion; - } - - interface Length extends LanguageChains, NumericComparison { - (length: number, message?: string): Assertion; - } - - interface Include { - (value: Object, message?: string): Assertion; - (value: string, message?: string): Assertion; - (value: number, message?: string): Assertion; - keys: Keys; - members: Members; - any: KeyFilter; - all: KeyFilter; - } - - interface Match { - (regexp: RegExp|string, message?: string): Assertion; - } - - interface Keys { - (...keys: string[]): Assertion; - (keys: any[]): Assertion; - (keys: Object): Assertion; - } - - interface Throw { - (): Assertion; - (expected: string, message?: string): Assertion; - (expected: RegExp, message?: string): Assertion; - (constructor: Error, expected?: string, message?: string): Assertion; - (constructor: Error, expected?: RegExp, message?: string): Assertion; - (constructor: Function, expected?: string, message?: string): Assertion; - (constructor: Function, expected?: RegExp, message?: string): Assertion; - } - - interface RespondTo { - (method: string, message?: string): Assertion; - } - - interface Satisfy { - (matcher: Function, message?: string): Assertion; - } - - interface Members { - (set: any[], message?: string): Assertion; - } - - interface PropertyChange { - (object: Object, prop: string, msg?: string): Assertion; - } - - export interface Assert { - /** - * @param expression Expression to test for truthiness. - * @param message Message to display on error. - */ - (expression: any, message?: string): void; - - fail(actual?: any, expected?: any, msg?: string, operator?: string): void; - - ok(val: any, msg?: string): void; - isOk(val: any, msg?: string): void; - notOk(val: any, msg?: string): void; - isNotOk(val: any, msg?: string): void; - - equal(act: any, exp: any, msg?: string): void; - notEqual(act: any, exp: any, msg?: string): void; - - strictEqual(act: any, exp: any, msg?: string): void; - notStrictEqual(act: any, exp: any, msg?: string): void; - - deepEqual(act: any, exp: any, msg?: string): void; - notDeepEqual(act: any, exp: any, msg?: string): void; - - isTrue(val: any, msg?: string): void; - isFalse(val: any, msg?: string): void; - - isNull(val: any, msg?: string): void; - isNotNull(val: any, msg?: string): void; - - isUndefined(val: any, msg?: string): void; - isDefined(val: any, msg?: string): void; - - isNaN(val: any, msg?: string): void; - isNotNaN(val: any, msg?: string): void; - - isAbove(val: number, abv: number, msg?: string): void; - isBelow(val: number, blw: number, msg?: string): void; - - isAtMost(val: number, atmst: number, msg?: string): void; - isAtLeast(val: number, atlst: number, msg?: string): void; - - isFunction(val: any, msg?: string): void; - isNotFunction(val: any, msg?: string): void; - - isObject(val: any, msg?: string): void; - isNotObject(val: any, msg?: string): void; - - isArray(val: any, msg?: string): void; - isNotArray(val: any, msg?: string): void; - - isString(val: any, msg?: string): void; - isNotString(val: any, msg?: string): void; - - isNumber(val: any, msg?: string): void; - isNotNumber(val: any, msg?: string): void; - - isBoolean(val: any, msg?: string): void; - isNotBoolean(val: any, msg?: string): void; - - typeOf(val: any, type: string, msg?: string): void; - notTypeOf(val: any, type: string, msg?: string): void; - - instanceOf(val: any, type: Function, msg?: string): void; - notInstanceOf(val: any, type: Function, msg?: string): void; - - include(exp: string, inc: any, msg?: string): void; - include(exp: any[], inc: any, msg?: string): void; - - notInclude(exp: string, inc: any, msg?: string): void; - notInclude(exp: any[], inc: any, msg?: string): void; - - match(exp: any, re: RegExp, msg?: string): void; - notMatch(exp: any, re: RegExp, msg?: string): void; - - property(obj: Object, prop: string, msg?: string): void; - notProperty(obj: Object, prop: string, msg?: string): void; - deepProperty(obj: Object, prop: string, msg?: string): void; - notDeepProperty(obj: Object, prop: string, msg?: string): void; - - propertyVal(obj: Object, prop: string, val: any, msg?: string): void; - propertyNotVal(obj: Object, prop: string, val: any, msg?: string): void; - - deepPropertyVal(obj: Object, prop: string, val: any, msg?: string): void; - deepPropertyNotVal(obj: Object, prop: string, val: any, msg?: string): void; - - lengthOf(exp: any, len: number, msg?: string): void; - //alias frenzy - throw(fn: Function, msg?: string): void; - throw(fn: Function, regExp: RegExp): void; - throw(fn: Function, errType: Function, msg?: string): void; - throw(fn: Function, errType: Function, regExp: RegExp): void; - - throws(fn: Function, msg?: string): void; - throws(fn: Function, regExp: RegExp): void; - throws(fn: Function, errType: Function, msg?: string): void; - throws(fn: Function, errType: Function, regExp: RegExp): void; - - Throw(fn: Function, msg?: string): void; - Throw(fn: Function, regExp: RegExp): void; - Throw(fn: Function, errType: Function, msg?: string): void; - Throw(fn: Function, errType: Function, regExp: RegExp): void; - - doesNotThrow(fn: Function, msg?: string): void; - doesNotThrow(fn: Function, regExp: RegExp): void; - doesNotThrow(fn: Function, errType: Function, msg?: string): void; - doesNotThrow(fn: Function, errType: Function, regExp: RegExp): void; - - operator(val: any, operator: string, val2: any, msg?: string): void; - closeTo(act: number, exp: number, delta: number, msg?: string): void; - - sameMembers(set1: any[], set2: any[], msg?: string): void; - sameDeepMembers(set1: any[], set2: any[], msg?: string): void; - includeMembers(superset: any[], subset: any[], msg?: string): void; - - ifError(val: any, msg?: string): void; - - isExtensible(obj: {}, msg?: string): void; - extensible(obj: {}, msg?: string): void; - isNotExtensible(obj: {}, msg?: string): void; - notExtensible(obj: {}, msg?: string): void; - - isSealed(obj: {}, msg?: string): void; - sealed(obj: {}, msg?: string): void; - isNotSealed(obj: {}, msg?: string): void; - notSealed(obj: {}, msg?: string): void; - - isFrozen(obj: Object, msg?: string): void; - frozen(obj: Object, msg?: string): void; - isNotFrozen(obj: Object, msg?: string): void; - notFrozen(obj: Object, msg?: string): void; - - - } - - export interface Config { - includeStack: boolean; - } - - export class AssertionError { - constructor(message: string, _props?: any, ssf?: Function); - name: string; - message: string; - showDiff: boolean; - stack: string; - } -} - -declare var chai: Chai.ChaiStatic; - -declare module "chai" { - export = chai; -} - -interface Object { - should: Chai.Assertion; -} diff --git a/chai/chai-2.0.0.d.ts b/chai/v2/index.d.ts similarity index 100% rename from chai/chai-2.0.0.d.ts rename to chai/v2/index.d.ts diff --git a/chai/v2/tsconfig.json b/chai/v2/tsconfig.json new file mode 100644 index 0000000000..4eb64088fc --- /dev/null +++ b/chai/v2/tsconfig.json @@ -0,0 +1,22 @@ +{ + "compilerOptions": { + "module": "commonjs", + "target": "es6", + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "baseUrl": "../../", + "typeRoots": [ + "../../" + ], + "types": [], + "paths": { + "chai": ["chai/v2"] + }, + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts" + ] +} \ No newline at end of file diff --git a/chroma-js/chroma-js-0.5.6-tests.ts b/chroma-js/v0/chroma-js-tests.ts similarity index 98% rename from chroma-js/chroma-js-0.5.6-tests.ts rename to chroma-js/v0/chroma-js-tests.ts index cb8b593d26..88a917dff9 100644 --- a/chroma-js/chroma-js-0.5.6-tests.ts +++ b/chroma-js/v0/chroma-js-tests.ts @@ -1,5 +1,3 @@ -/// - function test_chroma() { chroma("red"); chroma("#ff0000"); diff --git a/chroma-js/chroma-js-0.5.6.d.ts b/chroma-js/v0/index.d.ts similarity index 100% rename from chroma-js/chroma-js-0.5.6.d.ts rename to chroma-js/v0/index.d.ts diff --git a/chroma-js/v0/tsconfig.json b/chroma-js/v0/tsconfig.json new file mode 100644 index 0000000000..f4be951841 --- /dev/null +++ b/chroma-js/v0/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "target": "es6", + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "baseUrl": "../../", + "typeRoots": [ + "../../" + ], + "types": [], + "paths": { + "chroma-js": ["chroma-js/v0"] + }, + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "chroma-js-tests.ts" + ] +} \ No newline at end of file diff --git a/codemirror/codemirror-matchbrackets.d.ts b/codemirror/codemirror-matchbrackets.d.ts index cfae62deac..0de44246df 100644 --- a/codemirror/codemirror-matchbrackets.d.ts +++ b/codemirror/codemirror-matchbrackets.d.ts @@ -5,7 +5,9 @@ // See docs https://codemirror.net/doc/manual.html#addon_matchbrackets -declare namespace CodeMirror { +import * as CodeMirror from "codemirror"; + +declare module "codemirror" { interface EditorConfiguration { // when set to true, causes matching brackets to be highlighted whenever the cursor is next to them matchBrackets?: boolean; diff --git a/codemirror/codemirror-runmode.d.ts b/codemirror/codemirror-runmode.d.ts index 8c8e4fe7eb..2252eb9649 100644 --- a/codemirror/codemirror-runmode.d.ts +++ b/codemirror/codemirror-runmode.d.ts @@ -5,7 +5,9 @@ // See docs https://codemirror.net/doc/manual.html#addon_runmode -declare namespace CodeMirror { +import * as CodeMirror from "codemirror"; + +declare module "codemirror" { /** * Runs a CodeMirror mode over text without opening an editor instance. diff --git a/codemirror/codemirror-showhint.d.ts b/codemirror/codemirror-showhint.d.ts index e90c137117..72c34b6007 100644 --- a/codemirror/codemirror-showhint.d.ts +++ b/codemirror/codemirror-showhint.d.ts @@ -5,7 +5,9 @@ // See docs https://codemirror.net/doc/manual.html#addon_show-hint -declare namespace CodeMirror { +import * as CodeMirror from "codemirror"; + +declare module "codemirror" { var commands: any; /** Provides a framework for showing autocompletion hints. Defines editor.showHint, which takes an optional diff --git a/codemirror/searchcursor.d.ts b/codemirror/searchcursor.d.ts index fbf5e97965..45112b0f7e 100644 --- a/codemirror/searchcursor.d.ts +++ b/codemirror/searchcursor.d.ts @@ -3,7 +3,9 @@ // Definitions by: jacqt // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -declare namespace CodeMirror { +import * as CodeMirror from "codemirror"; + +declare module "codemirror" { interface Doc { /** This method can be used to implement search/replace functionality. * `query`: This can be a regular * expression or a string (only strings will match across lines - diff --git a/codemirror/tsconfig.json b/codemirror/tsconfig.json index a2002ceec6..6b0d828cdc 100644 --- a/codemirror/tsconfig.json +++ b/codemirror/tsconfig.json @@ -15,6 +15,14 @@ }, "files": [ "index.d.ts", - "codemirror-tests.ts" + "codemirror-tests.ts", + "codemirror-matchbrackets.d.ts", + "codemirror-matchbrackets-tests.ts", + "codemirror-runmode.d.ts", + "codemirror-runmode-tests.ts", + "codemirror-showhint.d.ts", + "codemirror-showhint-tests.ts", + "searchcursor.d.ts", + "searchcursor-tests.ts" ] } \ No newline at end of file diff --git a/color/color-tests-0.12.0.ts b/color/v0/color-tests.ts similarity index 100% rename from color/color-tests-0.12.0.ts rename to color/v0/color-tests.ts diff --git a/color/index-0.12.0.d.ts b/color/v0/index.d.ts similarity index 100% rename from color/index-0.12.0.d.ts rename to color/v0/index.d.ts diff --git a/xrm/v7.1/tsconfig.json b/color/v0/tsconfig.json similarity index 69% rename from xrm/v7.1/tsconfig.json rename to color/v0/tsconfig.json index ab52c3f626..c57fbb0ba1 100644 --- a/xrm/v7.1/tsconfig.json +++ b/color/v0/tsconfig.json @@ -1,20 +1,23 @@ { - "files": [ - "index.d.ts", - "xrm-v7.1-tests.ts" - ], "compilerOptions": { "module": "commonjs", "target": "es6", "noImplicitAny": true, "noImplicitThis": true, "strictNullChecks": true, - "baseUrl": "../", + "baseUrl": "../../", "typeRoots": [ - "../" + "../../" ], "types": [], + "paths": { + "color": ["color/v0"] + }, "noEmit": true, "forceConsistentCasingInFileNames": true - } + }, + "files": [ + "index.d.ts", + "color-tests.ts" + ] } \ No newline at end of file diff --git a/colors/tsconfig.json b/colors/tsconfig.json index 203d97e2fa..b41138a449 100644 --- a/colors/tsconfig.json +++ b/colors/tsconfig.json @@ -15,6 +15,7 @@ }, "files": [ "index.d.ts", - "colors-tests.ts" + "colors-tests.ts", + "safe.d.ts" ] } \ No newline at end of file diff --git a/connect-modrewrite/connect-modrewrite-tests.ts b/connect-modrewrite/connect-modrewrite-tests.ts index 9a976cbf7b..d1a5709e11 100644 --- a/connect-modrewrite/connect-modrewrite-tests.ts +++ b/connect-modrewrite/connect-modrewrite-tests.ts @@ -1,6 +1,5 @@ - import modRewrite = require('connect-modrewrite'); -import express = require('../express'); +import express = require('express'); var app = express(); diff --git a/cordova/.gitignore b/cordova/.gitignore deleted file mode 100644 index 3be8493bd7..0000000000 --- a/cordova/.gitignore +++ /dev/null @@ -1 +0,0 @@ -cordova-tests.js \ No newline at end of file diff --git a/cryptojs/all-tests.ts b/cryptojs/all-tests.ts deleted file mode 100644 index bd147a6aa6..0000000000 --- a/cryptojs/all-tests.ts +++ /dev/null @@ -1,57 +0,0 @@ - - -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// diff --git a/cryptojs/tsconfig.json b/cryptojs/tsconfig.json index 10bbd0e5f3..ffc46b0202 100644 --- a/cryptojs/tsconfig.json +++ b/cryptojs/tsconfig.json @@ -15,6 +15,60 @@ }, "files": [ "index.d.ts", - "all-tests.ts" + "test/aes-profile-tests.ts", + "test/aes-tests.ts", + "test/des-profile-tests.ts", + "test/des-tests.ts", + "test/enc-base64-tests.ts", + "test/enc-hex-tests.ts", + "test/enc-latin1-tests.ts", + "test/enc-utf8-tests.ts", + "test/enc-utf16-tests.ts", + "test/evpkdf-profile-tests.ts", + "test/evpkdf-tests.ts", + "test/format-openssl-tests.ts", + "test/hmac-profile-tests.ts", + "test/hmac-tests.ts", + "test/kdf-openssl-tests.ts", + "test/lib-base-tests.ts", + "test/lib-cipherparams-tests.ts", + "test/lib-passwordbasedcipher-tests.ts", + "test/lib-serializablecipher-tests.ts", + "test/lib-typedarrays-tests.ts", + "test/lib-wordarray-tests.ts", + "test/md5-profile-tests.ts", + "test/md5-tests.ts", + "test/mode-cbc-tests.ts", + "test/mode-cfb-tests.ts", + "test/mode-ctr-tests.ts", + "test/mode-ecb-tests.ts", + "test/mode-ofb-tests.ts", + "test/pad-ansix923-tests.ts", + "test/pad-iso10126-tests.ts", + "test/pad-iso97971-tests.ts", + "test/pad-pkcs7-tests.ts", + "test/pad-zeropadding-tests.ts", + "test/pbkdf2-profile-tests.ts", + "test/pbkdf2-tests.ts", + "test/rabbit-legacy-tests.ts", + "test/rabbit-profile-tests.ts", + "test/rabbit-tests.ts", + "test/rc4-profile-tests.ts", + "test/rc4-tests.ts", + "test/ripemd160-tests.ts", + "test/sha1-profile-tests.ts", + "test/sha1-tests.ts", + "test/sha3-profile-tests.ts", + "test/sha3-tests.ts", + "test/sha224-tests.ts", + "test/sha256-profile-tests.ts", + "test/sha256-tests.ts", + "test/sha384-tests.ts", + "test/sha512-profile-tests.ts", + "test/sha512-tests.ts", + "test/tripledes-profile-tests.ts", + "test/tripledes-tests.ts", + "test/x64-word-tests.ts", + "test/x64-wordarray-tests.ts" ] } \ No newline at end of file diff --git a/cson/cson-test.cson b/cson/cson-test.cson deleted file mode 100644 index a69eb2ef58..0000000000 --- a/cson/cson-test.cson +++ /dev/null @@ -1 +0,0 @@ -hello: 'world' diff --git a/cson/cson-test.json b/cson/cson-test.json deleted file mode 100644 index 56c8e28033..0000000000 --- a/cson/cson-test.json +++ /dev/null @@ -1 +0,0 @@ -{"hello": "world"} diff --git a/d3-dsv/v0/index.d.ts b/d3-dsv/v0/index.d.ts index ce39d46468..5547fccf6c 100644 --- a/d3-dsv/v0/index.d.ts +++ b/d3-dsv/v0/index.d.ts @@ -1,65 +1,68 @@ -// Type definitions for d3-dsv +// Type definitions for d3-dsv 0.4 // Project: https://www.npmjs.com/package/d3-dsv // Definitions by: Jason Swearingen // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - - /** A parser and formatter for DSV (CSV and TSV) files. -Extracted from D3. */ +/** A parser and formatter for DSV (CSV and TSV) files. Extracted from D3. */ declare var loader: ( /** the symbol used to seperate cells in the row.*/ delimiter: string, /** example: "text/plain" */ - encoding?: string) => _d3dsv.D3Dsv; + encoding?: string) => D3Dsv; + export = loader; export as namespace d3_dsv; -declare module _d3dsv { - /** A parser and formatter for DSV (CSV and TSV) files. -Extracted from D3. */ - export class D3Dsv { - /** Parses the specified string, which is the contents of a CSV file, returning an array of objects representing the parsed rows. - The string is assumed to be RFC4180-compliant. - Unlike the parseRows method, this method requires that the first line of the CSV file contains a comma-separated list of column names; - these column names become the attributes on the returned objects. - For example, consider the following CSV file: +/** A parser and formatter for DSV (CSV and TSV) files. Extracted from D3. */ +interface D3Dsv { + /** + Parses the specified string, which is the contents of a CSV file, returning an array of objects representing the parsed rows. + The string is assumed to be RFC4180-compliant. + Unlike the parseRows method, this method requires that the first line of the CSV file contains a comma-separated list of column names; + these column names become the attributes on the returned objects. + For example, consider the following CSV file: -Year,Make,Model,Length -1997,Ford,E350,2.34 -2000,Mercury,Cougar,2.38 + Year,Make,Model,Length + 1997,Ford,E350,2.34 + 2000,Mercury,Cougar,2.38 -The resulting JavaScript array is: + The resulting JavaScript array is: -[ {"Year": "1997", "Make": "Ford", "Model": "E350", "Length": "2.34"}, - {"Year": "2000", "Make": "Mercury", "Model": "Cougar", "Length": "2.38"} ] - */ - public parse( - table: string, - /** coerce cells (strings) into different types or modify them. return null to strip this row from the output results. */ - accessor?: (row: any) => TRow - ): TRow[]; - /** Parses the specified string, which is the contents of a CSV file, returning an array of arrays representing the parsed rows. The string is assumed to be RFC4180-compliant. Unlike the parse method, this method treats the header line as a standard row, and should be used whenever the CSV file does not contain a header. Each row is represented as an array rather than an object. Rows may have variable length. For example, consider the following CSV file: + [ {"Year": "1997", "Make": "Ford", "Model": "E350", "Length": "2.34"}, + {"Year": "2000", "Make": "Mercury", "Model": "Cougar", "Length": "2.38"} ] + */ + parse( + table: string, + /** coerce cells (strings) into different types or modify them. return null to strip this row from the output results. */ + accessor?: (row: any) => TRow + ): TRow[]; -1997,Ford,E350,2.34 -2000,Mercury,Cougar,2.38 -The resulting JavaScript array is: + /** + Parses the specified string, which is the contents of a CSV file, returning an array of arrays representing the parsed rows. The string is assumed to be RFC4180-compliant. Unlike the parse method, this method treats the header line as a standard row, and should be used whenever the CSV file does not contain a header. Each row is represented as an array rather than an object. Rows may have variable length. For example, consider the following CSV file: -[ ["1997", "Ford", "E350", "2.34"], - ["2000", "Mercury", "Cougar", "2.38"] ] -Note that the values themselves are always strings; they will not be automatically converted to numbers. See parse for details.*/ - public parseRows( - table: string, - /** coerce cells (strings) into different types or modify them. return null to strip this row from the output results.*/ - accessor?: (row: string[]) => TRow - ): TRow[]; - /** Converts the specified array of rows into comma-separated values format, returning a string. This operation is the reverse of parse. Each row will be separated by a newline (\n), and each column within each row will be separated by a comma (,). Values that contain either commas, double-quotes (") or newlines will be escaped using double-quotes. + 1997,Ford,E350,2.34 + 2000,Mercury,Cougar,2.38 + The resulting JavaScript array is: -Each row should be an object, and all object properties will be converted into fields. For greater control over which properties are converted, convert the rows into arrays containing only the properties that should be converted and use formatRows. */ - public format(rows: any[]): string; - /** Converts the specified array of rows into comma-separated values format, returning a string. This operation is the reverse of parseRows. Each row will be separated by a newline (\n), and each column within each row will be separated by a comma (,). Values that contain either commas, double-quotes (") or newlines will be escaped using double-quotes. */ - public formatRows(rows: any[]): string; + [ ["1997", "Ford", "E350", "2.34"], + ["2000", "Mercury", "Cougar", "2.38"] ] + Note that the values themselves are always strings; they will not be automatically converted to numbers. See parse for details. + */ + parseRows( + table: string, + /** coerce cells (strings) into different types or modify them. return null to strip this row from the output results.*/ + accessor?: (row: string[]) => TRow + ): TRow[]; + /** + Converts the specified array of rows into comma-separated values format, returning a string. This operation is the reverse of parse. Each row will be separated by a newline (\n), and each column within each row will be separated by a comma (,). Values that contain either commas, double-quotes (") or newlines will be escaped using double-quotes. - } + Each row should be an object, and all object properties will be converted into fields. For greater control over which properties are converted, convert the rows into arrays containing only the properties that should be converted and use formatRows. + */ + format(rows: any[]): string; -} \ No newline at end of file + /** + Converts the specified array of rows into comma-separated values format, returning a string. This operation is the reverse of parseRows. Each row will be separated by a newline (\n), and each column within each row will be separated by a comma (,). Values that contain either commas, double-quotes (") or newlines will be escaped using double-quotes. + */ + formatRows(rows: any[]): string; +} diff --git a/d3-dsv/v0/tsconfig.json b/d3-dsv/v0/tsconfig.json new file mode 100644 index 0000000000..b0d37a9812 --- /dev/null +++ b/d3-dsv/v0/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "target": "es6", + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "baseUrl": "../../", + "typeRoots": [ + "../../" + ], + "types": [], + "paths": { + "d3-dsv": ["d3-dsv/v0"] + }, + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "d3-dsv-tests.ts" + ] +} \ No newline at end of file diff --git a/d3-dsv/v0/tslint.json b/d3-dsv/v0/tslint.json new file mode 100644 index 0000000000..06eb30c7b9 --- /dev/null +++ b/d3-dsv/v0/tslint.json @@ -0,0 +1 @@ +{ "extends": "../../tslint.json" } \ No newline at end of file diff --git a/d3-hexbin/d3-hexbin-test.ts b/d3-hexbin/d3-hexbin-tests.ts similarity index 100% rename from d3-hexbin/d3-hexbin-test.ts rename to d3-hexbin/d3-hexbin-tests.ts diff --git a/d3-hexbin/tsconfig.json b/d3-hexbin/tsconfig.json index 5f13ea3dde..d90193a58d 100644 --- a/d3-hexbin/tsconfig.json +++ b/d3-hexbin/tsconfig.json @@ -15,6 +15,6 @@ }, "files": [ "index.d.ts", - "d3-hexbin-test.ts" + "d3-hexbin-tests.ts" ] } diff --git a/d3-request/tsconfig.json b/d3-request/tsconfig.json index bbb77ee4e9..6014c45ff1 100644 --- a/d3-request/tsconfig.json +++ b/d3-request/tsconfig.json @@ -3,7 +3,7 @@ "module": "commonjs", "target": "es6", "noImplicitAny": true, - "noImplicitThis": true, + "noImplicitThis": false, "strictNullChecks": false, "baseUrl": "../", "typeRoots": [ diff --git a/d3/legacy/plugins/d3.superformula-tests.ts b/d3/legacy/plugins/d3.superformula-tests.ts deleted file mode 100644 index 4515dd8d28..0000000000 --- a/d3/legacy/plugins/d3.superformula-tests.ts +++ /dev/null @@ -1,39 +0,0 @@ -import * as d3 from 'd3'; - -function superformula() { - var size = 1000; - - var x = d3.scale.ordinal() - .domain(d3.superformulaTypes) - .rangePoints([0, 960], 1); - - var svg = d3.select("body").append("svg") - .attr("width", 960) - .attr("height", 500); - - var small = d3.superformula() - .type(function (d) { return d; } ) - .size(size); - - var big = d3.superformula() - .type("square") - .size(size * 50) - .segments(360); - - svg.selectAll("a") - .data(d3.superformulaTypes) - .enter().append("a") - .attr("xlink:title", String) - .attr("transform", function (d, i) { return "translate(" + x(d) + ",40)"; } ) - .append("path") - .attr("class", "small") - .attr("d", small) - .on("mousedown", function () { d3.select(this).style("fill", "aliceblue"); } ) - .on("mouseup", function () { d3.select(this).style("fill", null); } ) - .on("click", function (d) { d3.select(".big").transition().duration(500).attr("d", big.type(d)); } ); - - svg.append("path") - .attr("class", "big") - .attr("transform", "translate(450,250)") - .attr("d", big); -} diff --git a/d3/legacy/plugins/index.d.ts b/d3/legacy/plugins/index.d.ts deleted file mode 100644 index 1e4727d3c7..0000000000 --- a/d3/legacy/plugins/index.d.ts +++ /dev/null @@ -1,44 +0,0 @@ -// Type definitions for d3JS plugins -// Project: http://d3js.org/ -// Definitions by: Alex Ford , Boris Yankov -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -/* tslint:disable */ - -import * as d3 from 'd3'; - -declare module 'd3' { - export function superformula(): Superformula; - - export namespace superformula { - interface Type { - m: number; - n1: number; - n2: number; - n3: number; - a: number; - b: number; - } - } - - export interface Superformula { - (datum: T, index: number): string; - - type(): (datum: T, index: number) => string; - type(type: string): Superformula; - type(type: (datum: T, index: number) => string): Superformula; - - size(): (datum: T, index: number) => number; - size(size: number): Superformula; - size(size: (datum: T, index: number) => number): Superformula; - - segments(): (datum: T, index: number) => number; - segments(segments: number): Superformula; - segments(segments: (datum: T, index: number) => number): Superformula; - - param(name: string): number; - param(name: string, value: number): Superformula; - } - - export var superformulaTypes: string[]; -} diff --git a/d3/legacy/plugins/package.json b/d3/legacy/plugins/package.json deleted file mode 100644 index 9996a98ea5..0000000000 --- a/d3/legacy/plugins/package.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "dependencies": { - "@types/d3": ">=3.5.36 <4.0.0" - } -} diff --git a/d3/d3-v3.5-tests.ts b/d3/v3/d3-tests.ts similarity index 100% rename from d3/d3-v3.5-tests.ts rename to d3/v3/d3-tests.ts diff --git a/d3/d3-v3.5.d.ts b/d3/v3/index.d.ts similarity index 100% rename from d3/d3-v3.5.d.ts rename to d3/v3/index.d.ts diff --git a/jasmine/legacy/tsconfig.json b/d3/v3/tsconfig.json similarity index 55% rename from jasmine/legacy/tsconfig.json rename to d3/v3/tsconfig.json index 989514403e..1401acf865 100644 --- a/jasmine/legacy/tsconfig.json +++ b/d3/v3/tsconfig.json @@ -3,15 +3,21 @@ "module": "commonjs", "target": "es6", "noImplicitAny": true, + "noImplicitThis": false, "strictNullChecks": false, "baseUrl": "../../", - "typeRoots": ["../../"], + "typeRoots": [ + "../../" + ], "types": [], + "paths": { + "d3": ["d3/v3"] + }, "noEmit": true, - "forceConsistentCasingInFileNames": true + "forceConsistentCasingInFileNames": true }, "files": [ "index.d.ts", - "jasmine-1.3-tests.ts" + "d3-tests.ts" ] } \ No newline at end of file diff --git a/d3kit/d3kit-v1.1.0-tests.ts b/d3kit/v1/d3kit-tests.ts similarity index 99% rename from d3kit/d3kit-v1.1.0-tests.ts rename to d3kit/v1/d3kit-tests.ts index 5eab2a4e79..d49891822b 100644 --- a/d3kit/d3kit-v1.1.0-tests.ts +++ b/d3kit/v1/d3kit-tests.ts @@ -1,4 +1,3 @@ -/// /// /// /// diff --git a/d3kit/d3kit-v1.1.0.d.ts b/d3kit/v1/index.d.ts similarity index 98% rename from d3kit/d3kit-v1.1.0.d.ts rename to d3kit/v1/index.d.ts index ef6405b04d..5da692ef1b 100644 --- a/d3kit/d3kit-v1.1.0.d.ts +++ b/d3kit/v1/index.d.ts @@ -3,7 +3,7 @@ // Definitions by: Morgan Benton // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -/// +import * as d3 from "d3"; declare namespace d3kit { @@ -150,6 +150,5 @@ declare namespace d3kit { } -declare module 'd3kit' { - export = d3kit; -} +export = d3kit; +export as namespace d3kit; diff --git a/d3kit/v1/tsconfig.json b/d3kit/v1/tsconfig.json new file mode 100644 index 0000000000..870e3487a1 --- /dev/null +++ b/d3kit/v1/tsconfig.json @@ -0,0 +1,24 @@ +{ + "compilerOptions": { + "module": "commonjs", + "target": "es6", + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": false, + "baseUrl": "../../", + "typeRoots": [ + "../../" + ], + "types": [], + "paths": { + "d3": ["d3/v3"], + "d3kit": ["d3kit/v1"] + }, + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "d3kit-tests.ts" + ] +} \ No newline at end of file diff --git a/dc/dc-1.6.0.d.ts b/dc/dc-1.6.0.d.ts deleted file mode 100644 index 9938d3bc45..0000000000 --- a/dc/dc-1.6.0.d.ts +++ /dev/null @@ -1,207 +0,0 @@ -// Type definitions for DCJS -// Project: https://github.com/dc-js -// Definitions by: hans windhoff -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -// this makes only sense together with d3 and crossfilter so you need the d3.d.ts and crossfilter.d.ts files - -/// -/// - - - -declare namespace dc { - - // helper for get/set situation - interface IGetSet { - (): T; - (t:T): V; - } -export interface ILegendwidget { - x: IGetSet; - y: IGetSet; - gap: IGetSet; - itemHeight: IGetSet; - horizontal: IGetSet; - legendWidth: IGetSet; - itemWidth: IGetSet; - } - export interface IBaseChart { - width: IGetSet; - height: IGetSet; - minWidth: IGetSet; - minHeight: IGetSet; - dimension: IGetSet; - group: IGetSet; // not sure here - transitionDuration: IGetSet; - colors: IGetSet; - keyAccessor: IGetSet<(d:any) => number, T>; - valueAccessor: IGetSet<(d:any) => number, T>; - label: IGetSet<(l:any) => string, T>; - renderLabel: IGetSet; - renderlet: (fnctn: (t:T) => void) => T; - title: IGetSet<(t:string) => string, T>; - filter: IGetSet; - filterAll: () => void; - expireCache: () => void; - legend: (l:ILegendwidget) => T; - chartID: () => number; - options: (o:Object)=>void ; - select: (selector: d3.Selection) => d3.Selection; - selectAll: (selector: d3.Selection) => d3.Selection; - } - - export interface IEvents { - trigger(fnctn: () => void, delay?: number):void; - } - - export var events: IEvents; - - export interface IListener { - on: { - (event: "preRender", fnctn: (c: T) => any): T; - (event: "postRender", fnctn: (c: T) => any): T; - (event: "preRedraw", fnctn: (c: T) => any): T; - (event: "postRedraw", fnctn: (c: T) => any): T; - (event: "filtered", fnctn: (c: T, filter: any) => any): T; - (event: "zoomed", fnctn: (c: T, filter: any) => any): T; - (event: string, fnctn: (c: T, ...args: any[]) => any): T; - }; - } - - export interface ImarginObj { - top: number; - right: number; - bottom: number; - left: number; - - } - - export interface IMarginable { - margins: IGetSet; - } - - // abstract interfaces - export interface IAbstractColorChart { - colorDomain: IGetSet; - } - export interface IAbstractStackableChart { - stack: (group: IChartGroup, name?:string, retriever?: (d:Object)=>number) => T; - } - - export interface IAbstractCoordinateGridChart { - x: IGetSet; - y: IGetSet; - elasticY: IGetSet; - xAxis: IGetSet; - yAxis: IGetSet; - yAxisPadding: IGetSet; - xAxisPadding: IGetSet; - renderHorizontalGridLines: IGetSet; - - } - - export interface IAbstractBubblechart { - r: IGetSet; - radiusValueAccessor: IGetSet<(d:any) => number, T>; - } - - - - // function interfaces - export interface columnFunction { - (rowinfo:any): string; - } - export interface sortbyFunction { - (rowinfo:any): any; - } - export interface orderFunction { - (a: T, b: T): number; - } - - - // chart interfaces - - - export interface IBubblechart extends - IBaseChart, - IAbstractColorChart, - IAbstractBubblechart, - IAbstractCoordinateGridChart, - IMarginable, - IListener { - } - - export interface IPiechart extends - IBaseChart, - IAbstractColorChart, - IAbstractBubblechart, - IAbstractCoordinateGridChart, - IMarginable, - IListener { - radius: IGetSet; - minAngleForLabel: IGetSet; - - } - - export interface IBarchart extends - IBaseChart, - IAbstractStackableChart, - IAbstractCoordinateGridChart, - IMarginable, - IListener { - centerBar: (b:boolean) => IBarchart; - gap: (gapBetweenBars: number) => IBarchart; - } - - export interface ILinechart extends - IBaseChart, - IAbstractStackableChart, - IAbstractCoordinateGridChart, - IMarginable, - IListener { - } - - - export interface IDatachart extends - IBaseChart, - IAbstractStackableChart, - IAbstractCoordinateGridChart, - IMarginable, - IListener { - size: IGetSet; - columns: IGetSet; - sortBy: IGetSet; - order: IGetSet; - } - - - export interface IRowchart extends - IBaseChart, - IAbstractColorChart, - IAbstractStackableChart, - IAbstractCoordinateGridChart, - IMarginable, - IListener { - } - - - - - // utilities - export interface IChartGroup { } - - export function filterAll(chartGroup?: IChartGroup): void; - export function renderAll(chartGroup?: IChartGroup): void; - export function redrawAll(chartGroup?: IChartGroup): void; - - - export function bubbleChart(cssSel: string): IBubblechart; - export function pieChart(cssSel: string): IPiechart; - export function barChart(cssSel: string): IBarchart; - export function lineChart(cssSel: string): ILinechart; - export function dataTable(cssSel: string): IDatachart; - export function rowChart(cssSel: string): IRowchart; - - -} diff --git a/devextreme/devextreme-15.1.3.d.ts b/devextreme/devextreme-15.1.3.d.ts deleted file mode 100644 index 432b6d4008..0000000000 --- a/devextreme/devextreme-15.1.3.d.ts +++ /dev/null @@ -1,6403 +0,0 @@ -// Type definitions for DevExtreme 15.1.3 -// Project: http://js.devexpress.com/ -// Definitions by: DevExpress Inc. -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -/// - -declare namespace DevExpress { - /** A mixin that provides a capability to fire and subscribe to events. */ - export interface EventsMixin { - /** Subscribes to a specified event. */ - on(eventName: string, eventHandler: Function): T; - /** Subscribes to the specified events. */ - on(events: { [eventName: string]: Function; }): T; - /** Detaches all event handlers from the specified event. */ - off(eventName: string): Object; - /** Detaches a particular event handler from the specified event. */ - off(eventName: string, eventHandler: Function): T; - } - /** An object that serves as a namespace for the methods required to perform validation. */ - export module validationEngine { - export interface IValidator { - validate(): ValidatorValidationResult; - reset(): void; - } - export interface ValidatorValidationResult { - isValid: boolean; - name?: string; - value: any; - brokenRule: any; - validationRules: any[]; - } - export interface ValidationGroupValidationResult { - isValid: boolean; - brokenRules: any[]; - validators: IValidator[]; - } - export interface GroupConfig extends EventsMixin { - group: any; - validators: IValidator[]; - validate(): ValidationGroupValidationResult; - reset(): void; - } - /** Provides access to the object that represents the specified validation group. */ - export function getGroupConfig(group: any): GroupConfig - /** Provides access to the object that represents the default validation group. */ - export function getGroupConfig(): GroupConfig - /** Validates rules of the validators that belong to the specified validation group. */ - export function validateGroup(group: any): ValidationGroupValidationResult; - /** Validates rules of the validators that belong to the default validation group. */ - export function validateGroup(): ValidationGroupValidationResult; - /** Resets the values and validation result of the editors that belong to the specified validation group. */ - export function resetGroup(group: any): void; - /** Resets the values and validation result of the editors that belong to the default validation group. */ - export function resetGroup(): void; - /** Validates the rules that are defined within the dxValidator objects that are registered for the specified ViewModel. */ - export function validateModel(model: Object): ValidationGroupValidationResult; - /** Registers all the dxValidator objects by which the fields of the specified ViewModel are extended. */ - export function registerModelForValidation(model: Object) : void; - } - export var hardwareBackButton: JQueryCallback; - /** Processes the hardware back button click. */ - export function processHardwareBackButton(): void; - /** Specifies whether or not the entire application/site supports right-to-left representation. */ - export var rtlEnabled: boolean; - /** Registers a new component in the DevExpress.ui namespace, and a jQuery plugin and Knockout binding for the required component. */ - export function registerComponent(name: string, componentClass: Object): void; - /** Registers a new component in the specified namespace as a jQuery plugin, Angular directive and Knockout binding. */ - export function registerComponent(name: string, namespace: Object, componentClass: Object): void; - /** Requests that the browser call a specified function to update animation before the next repaint. */ - export function requestAnimationFrame(callback: Function): number; - /** Cancels an animation frame request scheduled with the requestAnimationFrame method. */ - export function cancelAnimationFrame(requestID: number): void; - /** Custom Knockout binding that links an HTML element with a specific action. */ - export class Action { } - /** Used to get URLs that vary in a locally running application and the application running on production. */ - export class EndpointSelector { - constructor(options: { - [key: string]: { - local?: string; - production?: string; - } - }); - /** Returns a local or a productional URL depending on how the application is currently running. */ - urlFor(key: string): string; - } - /** An object that serves as a namespace for the methods that are used to animate UI elements. */ - export module fx { - /** Defines animation options. */ - export interface AnimationOptions { - /** A function called after animation is completed. */ - complete?: (element: JQuery, config: AnimationOptions) => void; - /** A number specifying wait time before animation execution. */ - delay?: number; - /** A number specifying the time period to wait before the animation of the next stagger item starts. */ - staggerDelay?: number; - /** A number specifying the time in milliseconds spent on animation. */ - duration?: number; - /** A string specifying the type of an easing function used for animation. */ - easing?: string; - /** Specifies the initial animation state. */ - from?: any; - /** A function called before animation is started. */ - start?: (element: JQuery, config: AnimationOptions) => void; - /** Specifies a final animation state. */ - to?: any; - /** A string value specifying the animation type. */ - type?: string; - /** Specifies the animation direction for the "slideIn" and "slideOut" animation types. */ - direction?: string; - } - /** Animates the specified element. */ - export function animate(element: HTMLElement, config: AnimationOptions): Object; - /** Returns a value indicating whether the specified element is being animated. */ - export function isAnimating(element: HTMLElement): boolean; - /** Stops the animation. */ - export function stop(element: HTMLElement, jumpToEnd: boolean): void; - } - /** The manager that performs several specified animations at a time. */ - export class TransitionExecutor { - /** Deletes all the animations registered in the Transition Executor by using the enter(elements, animation) and leave(elements, animation) methods. */ - reset(): void; - /** Registers a set of elements that should be animated as "entering" using the specified animation configuration. */ - enter(elements: JQuery, animation: any): void; - /** Registers a set of elements that should be animated as "leaving" using the specified animation configuration. */ - leave(elements: JQuery, animation: any): void; - /** Starts all the animations registered using the enter(elements, animation) and leave(elements, animation) methods beforehand. */ - start(config: Object): JQueryPromise; - } - export class AnimationPresetCollection { - /** Resets all the changes made in the animation repository. */ - resetToDefaults(): void; - /** Deletes the specified animation or clears all the animation repository, if an animation name is not passed. */ - clear(name: string): void; - /** Adds the specified animation preset to the animation repository by the specified name. */ - registerPreset(name: string, config: any): void; - /** Applies the changes made in the animation repository. */ - applyChanges(): void; - /** Returns the configuration of the animation found in the animation repository by the specified name for the current device. */ - getPreset(name: string): void; - /** Registers predefined animations in the animation repository. */ - registerDefaultPresets(): void; - } - /** A repository of animations. */ - export var animationPresets: AnimationPresetCollection; - /** An object that serves as a namespace for the methods and events specifying information on the current device. */ - export module devices { - /** The device object defines the device on which the application is running. */ - export interface Device { - /** Indicates whether or not the device platform is Android. */ - android?: boolean; - /** Specifies the type of the device on which the application is running. */ - deviceType?: string; - /** Indicates whether or not the device platform is generic, which means that the application will look and behave according to a generic "light" or "dark" theme. */ - generic?: boolean; - /** Indicates whether or not the device platform is iOS. */ - ios?: boolean; - /** Indicates whether or not the device type is 'phone'. */ - phone?: boolean; - /** Specifies the platform of the device on which the application is running. */ - platform?: string; - /** Indicates whether or not the device type is 'tablet'. */ - tablet?: boolean; - /** Specifies an array with the major and minor versions of the device platform. */ - version?: Array; - /** Indicates whether or not the device platform is Windows8. */ - win8?: boolean; - /** Specifies a performance grade of the current device. */ - grade?: string; - } - export var orientationChanged: JQueryCallback; - /** Overrides actual device information to force the application to operate as if it was running on the specified device. */ - export function current(deviceName: any): void; - /** Returns information about the current device. */ - export function current(): Device; - /** Returns the current device orientation. */ - export function orientation(): string; - /** Returns real information about the current device regardless of the value passed to the devices.current(deviceName) method. */ - export function real(): Device; - } - /** The position object specifies the widget positioning options. */ - export interface PositionOptions { - /** The target element position that the widget is positioned against. */ - at?: string; - /** The element within which the widget is positioned. */ - boundary?: Element; - /** A string value holding horizontal and vertical offset from the window's boundaries. */ - boundaryOffset?: string; - /** Specifies how to move the widget if it overflows the screen. */ - collision?: any; - /** The position of the widget to align against the target element. */ - my?: string; - /** The target element that the widget is positioned against. */ - of?: HTMLElement; - /** A string value holding horizontal and vertical offset in pixels, separated by a space (e.g., "5 -10"). */ - offset?: string; - } - export interface ComponentOptions { - /** A handler for the initialized event. */ - onInitialized?: Function; - /** A handler for the optionChanged event. */ - onOptionChanged?: Function; - /** A handler for the disposing event. */ - onDisposing?: Function; - } - /** A base class for all components and widgets. */ - export class Component { - constructor(options?: ComponentOptions) - /** Prevents the component from refreshing until the endUpdate method is called. */ - beginUpdate(): void; - /** Enables the component to refresh after the beginUpdate method call. */ - endUpdate(): void; - /** Returns an instance of this component class. */ - instance(): Component; - /** Sets one or more options of this component. */ - option(options: Object): void; - /** Returns the configuration options of this component. */ - option(): Object; - /** Gets the value of the specified configuration option of this component. */ - option(optionName: string): any; - /** Sets a value to the specified configuration option of this component. */ - option(optionName: string, optionValue: any): void; - } - export interface DOMComponentOptions extends ComponentOptions { - /** Specifies whether or not the current component supports a right-to-left representation. */ - rtlEnabled?: boolean; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies the width of the widget. */ - width?: any; - } - /** A base class for all components. */ - export class DOMComponent extends Component { - constructor(element: JQuery, options?: DOMComponentOptions); - constructor(element: HTMLElement, options?: DOMComponentOptions); - /** Returns the root HTML element of the widget. */ - element(): JQuery; - /** Specifies the device-dependent default configuration options for this component. */ - static defaultOptions(rule: { - device?: any; - options?: any; - }): void; - } - export module data { - export interface ODataError extends Error { - httpStatus?: number; - errorDetails?: any; - } - export interface StoreOptions { - inserted?: (values: Object, key: any) => void; - inserting?: (values: Object) => void; - loaded?: (result: Array) => void; - loading?: (loadOptions: LoadOptions) => void; - modified?: () => void; - modifying?: () => void; - removed?: (key: any) => void; - removing?: (key: any) => void; - updated?: (key: any, values: Object) => void; - updating?: (key: any, values: Object) => void; - /** A handler for the modified event. */ - onModified?: () => void; - /** A handler for the modifying event. */ - onModifying?: () => void; - /** A handler for the removed event. */ - onRemoved?: (key: any) => void; - /** A handler for the removing event. */ - onRemoving?: (key: any) => void; - /** A handler for the updated event. */ - onUpdated?: (key: any, values: Object) => void; - /** A handler for the updating event. */ - onUpdating?: (key: any, values: Object) => void; - /** A handler for the loaded event. */ - onLoaded?: (result: Array) => void; - /** A handler for the loading event. */ - onLoading?: (loadOptions: LoadOptions) => void; - /** A handler for the inserted event. */ - onInserted?: (values: Object, key: any) => void; - /** A handler for the inserting event. */ - onInserting?: (values: Object) => void; - /** Specifies the function called when the Store causes an error. */ - errorHandler?: (e: Error) => void; - /** Specifies the key properties within the data associated with the Store. */ - key?: any; - } - export interface LoadOptions { - filter?: Object; - sort?: Object; - select?: Object; - expand?: Object; - group?: Object; - skip?: number; - take?: number; - userData?: Object; - requireTotalCount?: boolean; - } - /** The base class for all Stores. */ - export class Store implements EventsMixin { - inserted: JQueryCallback; - inserting: JQueryCallback; - loaded: JQueryCallback; - loading: JQueryCallback; - modified: JQueryCallback; - modifying: JQueryCallback; - removed: JQueryCallback; - removing: JQueryCallback; - updated: JQueryCallback; - updating: JQueryCallback; - constructor(options?: StoreOptions); - /** Returns the data item specified by the key. */ - byKey(key: any): JQueryPromise; - /** Adds an item to the data associated with this Store. */ - insert(values: Object): JQueryPromise; - /** Returns the key expression specified via the key configuration option. */ - key(): any; - /** Returns the key of the Store item that matches the specified object. */ - keyOf(obj: Object): any; - /** Starts loading the data. */ - load(obj?: LoadOptions): JQueryPromise; - /** Removes the data item specified by the key. */ - remove(key: any): JQueryPromise; - /** Obtains the total count of items that will be returned by the load() function. */ - totalCount(obj?: { - filter?: Object; - select?: Object; - group?: Object; - sort?: Object; - }): JQueryPromise; - /** Updates the data item specified by the key. */ - update(key: any, values: Object): JQueryPromise; - on(eventName: "removing", eventHandler: (key: any) => void): Store; - on(eventName: "removed", eventHandler: (key: any) => void): Store; - on(eventName: "updating", eventHandler: (key: any, values: Object) => void): Store; - on(eventName: "updated", eventHandler: (key: any, values: Object) => void): Store; - on(eventName: "inserting", eventHandler: (values: Object) => void): Store; - on(eventName: "inserted", eventHandler: (values: Object, key: any) => void): Store; - on(eventName: "modifying", eventHandler: () => void): Store; - on(eventName: "modified", eventHandler: () => void): Store; - on(eventName: "loading", eventHandler: (loadOptions: LoadOptions) => void): Store; - on(eventName: "loaded", eventHandler: (result: Array) => void): Store; - on(eventName: string, eventHandler: Function): Store; - on(events: { [eventName: string]: Function; }): Store; - off(eventName: "removing"): Store; - off(eventName: "removed"): Store; - off(eventName: "updating"): Store; - off(eventName: "updated"): Store; - off(eventName: "inserting"): Store; - off(eventName: "inserted"): Store; - off(eventName: "modifying"): Store; - off(eventName: "modified"): Store; - off(eventName: "loading"): Store; - off(eventName: "loaded"): Store; - off(eventName: string): Store; - off(eventName: "removing", eventHandler: (key: any) => void): Store; - off(eventName: "removed", eventHandler: (key: any) => void): Store; - off(eventName: "updating", eventHandler: (key: any, values: Object) => void): Store; - off(eventName: "updated", eventHandler: (key: any, values: Object) => void): Store; - off(eventName: "inserting", eventHandler: (values: Object) => void): Store; - off(eventName: "inserted", eventHandler: (values: Object, key: any) => void): Store; - off(eventName: "modifying", eventHandler: () => void): Store; - off(eventName: "modified", eventHandler: () => void): Store; - off(eventName: "loading", eventHandler: (loadOptions: LoadOptions) => void): Store; - off(eventName: "loaded", eventHandler: (result: Array) => void): Store; - off(eventName: string, eventHandler: Function): Store; - } - export interface ArrayStoreOptions extends StoreOptions { - /** Specifies the array associated with this Store. */ - data?: Array; - } - /** A Store accessing an in-memory array. */ - export class ArrayStore extends Store { - constructor(options?: ArrayStoreOptions); - /** Clears all data associated with the current ArrayStore. */ - clear(): void; - /** Creates the Query object for the underlying array. */ - createQuery(): Query; - } - interface Promise { - then(doneFn?: Function, failFn?: Function, progressFn?: Function): Promise; - } - export interface CustomStoreOptions extends StoreOptions { - /** The user implementation of the byKey(key, extraOptions) method. */ - byKey?: (key: any) => Promise; - /** The user implementation of the insert(values) method. */ - insert?: (values: Object) => Promise; - /** The user implementation of the load(options) method. */ - load?: (options?: LoadOptions) => Promise; - /** The user implementation of the remove(key) method. */ - remove?: (key: any) => Promise; - /** The user implementation of the totalCount(options) method. */ - totalCount?: () => Promise; - /** The user implementation of the update(key, values) method. */ - update?: (key: any, values: Object) => Promise; - } - /** A Store object that enables you to implement your own data access logic. */ - export class CustomStore extends Store { - constructor(options: CustomStoreOptions); - } - export interface DataSourceOptions { - /** Specifies data filtering conditions. */ - filter?: Object; - /** Specifies data grouping conditions. */ - group?: Object; - /** The item mapping function. */ - map?: (record: any) => any; - /** Specifies the maximum number of items the page can contain. */ - pageSize?: number; - /** Specifies whether a DataSource loads data by pages, or all items at once. */ - paginate?: boolean; - /** The data post processing function. */ - postProcess?: (data: any[]) => any[]; - /** Specifies a value by which the required items are searched. */ - searchExpr?: Object; - /** Specifies the comparison operation used to search for the required items. */ - searchOperation?: string; - /** Specifies the value to which the search expression is compared. */ - searchValue?: Object; - /** Specifies the initial select option value. */ - select?: Object; - /** An array of the strings that represent the names of the navigation properties to be loaded simultaneously with the OData store's entity. */ - expand?: Object; - /** Specifies the initial sort option value. */ - sort?: Object; - /** Specifies the underlying Store instance used to access data. */ - store?: any; - /** A handler for the changed event. */ - onChanged?: () => void; - /** A handler for the loadingChanged event. */ - onLoadingChanged?: (isLoading: boolean) => void; - /** A handler for the loadError event. */ - onLoadError?: (e?: Error) => void; - } - /** An object that provides access to a data web service or local data storage for collection container widgets. */ - export class DataSource implements EventsMixin { - constructor(options?: DataSourceOptions); - changed: JQueryCallback; - loadError: JQueryCallback; - loadingChanged: JQueryCallback; - /** Disposes all resources associated with this DataSource. */ - dispose(): void; - /** Returns the current filter option value. */ - filter(): Object; - /** Sets the filter option value. */ - filter(filterExpr: Object): void; - /** Returns the current group option value. */ - group(): Object; - /** Sets the group option value. */ - group(groupExpr: Object): void; - /** Indicates whether or not the current page contains fewer items than the number of items specified by the pageSize configuration option. */ - isLastPage(): boolean; - /** Indicates whether or not at least one load() method execution has successfully finished. */ - isLoaded(): boolean; - /** Indicates whether or not the DataSource is currently being loaded. */ - isLoading(): boolean; - /** Returns the array of items currently operated by the DataSource. */ - items(): Array; - /** Returns the key expression. */ - key(): any; - /** Starts loading data. */ - load(): JQueryPromise>; - /** Returns an object that would be passed to the load() method of the underlying Store according to the current data shaping option values of the current DataSource instance. */ - loadOptions(): Object; - /** Returns the current pageSize option value. */ - pageSize(): number; - /** Sets the pageSize option value. */ - pageSize(value: number): void; - /** Specifies the index of the currently loaded page. */ - pageIndex(): number; - /** Specifies the index of the page to be loaded during the next load() method execution. */ - pageIndex(newIndex: number): void; - /** Returns the current paginate option value. */ - paginate(): boolean; - /** Sets the paginate option value. */ - paginate(value: boolean): void; - /** Returns the searchExpr option value. */ - searchExpr(): Object; - /** Sets the searchExpr option value. */ - searchExpr(expr: Object): void; - /** Returns the currently specified search operation. */ - searchOperation(): string; - /** Sets the current search operation. */ - searchOperation(op: string): void; - /** Returns the searchValue option value. */ - searchValue(): Object; - /** Sets the searchValue option value. */ - searchValue(value: Object): void; - /** Returns the current select option value. */ - select(): Object; - /** Sets the select option value. */ - select(expr: Object): void; - /** Returns the current sort option value. */ - sort(): Object; - /** Sets the sort option value. */ - sort(sortExpr: Object): void; - /** Returns the underlying Store instance. */ - store(): Store; - /** Returns the number of data items available in an underlying Store after the last load() operation without paging. */ - totalCount(): number; - on(eventName: "loadingChanged", eventHandler: (isLoading: boolean) => void): DataSource; - on(eventName: "loadError", eventHandler: (e?: Error) => void): DataSource; - on(eventName: "changed", eventHandler: () => void): DataSource; - on(eventName: string, eventHandler: Function): DataSource; - on(events: { [eventName: string]: Function; }): DataSource; - off(eventName: "loadingChanged"): DataSource; - off(eventName: "loadError"): DataSource; - off(eventName: "changed"): DataSource; - off(eventName: string): DataSource; - off(eventName: "loadingChanged", eventHandler: (isLoading: boolean) => void): DataSource; - off(eventName: "loadError", eventHandler: (e?: Error) => void): DataSource; - off(eventName: "changed", eventHandler: () => void): DataSource; - off(eventName: string, eventHandler: Function): DataSource; - } - /** An object used to work with primitive data types not supported by JavaScript when accessing an OData web service. */ - export class EdmLiteral { - /** Returns a string representation of the value associated with this EdmLiteral object. */ - valueOf(): string; - } - /** An object used to generate and hold the GUID. */ - export class Guid { - /** Creates a new Guid instance that holds the specified GUID. */ - constructor(value: string); - /** Creates a new Guid instance holding the generated GUID. */ - constructor(); - /** Returns a string representation of the Guid instance. */ - toString(): string; - /** Returns a string representation of the Guid instance. */ - valueOf(): string; - } - export interface LocalStoreOptions extends ArrayStoreOptions { - /** Specifies the time (in miliseconds) after the change operation, before the data is flushed. */ - flushInterval?: number; - /** Specifies whether the data is flushed immediatelly after each change operation, or after the delay specified via the flushInterval option. */ - immediate?: boolean; - /** The unique identifier used to distinguish the data within the HTML5 Web Storage. */ - name?: string; - } - /** A Store providing access to the HTML5 Web Storage. */ - export class LocalStore extends ArrayStore { - constructor(options?: LocalStoreOptions); - /** Removes all data associated with this Store. */ - clear(): void; - } - export interface ODataContextOptions extends ODataStoreOptions { - /** Specifies the list of entities to be accessed via the ODataContext. */ - entities?: Object; - /** Specifies the function called if the ODataContext causes an error. */ - errorHandler?: (e: Error) => void; - } - /** Provides access to the entire OData service. */ - export class ODataContext { - constructor(options?: ODataContextOptions); - /** Initiates the specified WebGet service operation that returns a value. For the information on service operations, refer to the OData documentation. */ - get(operationName: string, params: Object): JQueryPromise; - /** Initiates the specified WebGet service operation that returns nothing. For the information on service operations, refer to the OData documentation. */ - invoke(operationName: string, params: Object, httpMethod: Object): JQueryPromise; - /** Return a special proxy object to describe the entity link. */ - objectLink(entityAlias: string, key: any): Object; - } - export interface ODataStoreOptions extends StoreOptions { - /** A function used to customize a web request before it is sent. */ - beforeSend?: (request: Object) => void; - /** Specifies whether the ODataStore uses the JSONP approach to access non-CORS-compatible remote services. */ - jsonp?: boolean; - /** Specifies the type of the ODataStore key property. The following key types are supported out of the box: String, Int32, Int64, and Guid. */ - keyType?: any; - /** Specifies the URL of the data service being accessed via the current ODataContext. */ - url?: string; - /** Specifies the version of the OData protocol used to interact with the data service. */ - version?: number; - /** Specifies the value of the withCredentials field of the underlying jqXHR object. */ - withCredentials?: boolean; - } - /** A Store providing access to a separate OData web service entity. */ - export class ODataStore extends Store { - constructor(options?: ODataStoreOptions); - /** Creates the Query object for the OData endpoint. */ - createQuery(loadOptions: Object): Object; - /** Returns the data item specified by the key. */ - byKey(key: any, extraOptions?: { expand?: Object }): JQueryPromise; - } - /** An universal chainable data query interface object. */ - export interface Query { - /** Calculates a custom summary for the items in the current Query. */ - aggregate(step: (accumulator: any, value: any) => any): JQueryPromise; - /** Calculates a custom summary for the items in the current Query. */ - aggregate(seed: any, step: (accumulator: any, value: any) => any, finalize: (result: any) => any): JQueryPromise; - /** Calculates the average item value for the current Query. */ - avg(getter: Object): JQueryPromise; - /** Finds the item with the maximum getter value. */ - max(getter: Object): JQueryPromise; - /** Finds the item with the maximum value in the Query. */ - max(): JQueryPromise; - /** Finds the item with the minimum value in the Query. */ - min(): JQueryPromise; - /** Finds the item with the minimum getter value. */ - min(getter: Object): JQueryPromise; - /** Calculates the average item value for the current Query, if each Query item has a numeric type. */ - avg(): JQueryPromise; - /** Returns the total count of items in the current Query. */ - count(): JQueryPromise; - /** Executes the Query. */ - enumerate(): JQueryPromise; - /** Filters the current Query data. */ - filter(criteria: Array): Query; - /** Groups the current Query data. */ - groupBy(getter: Object): Query; - /** Applies the specified transformation to each item. */ - select(getter: Object): Query; - /** Limits the data item count. */ - slice(skip: number, take?: number): Query; - /** Sorts current Query data. */ - sortBy(getter: Object, desc: boolean): Query; - /** Sorts current Query data. */ - sortBy(getter: Object): Query; - /** Calculates the sum of item getter values in the current Query. */ - sum(getter: Object): JQueryPromise; - /** Calculates the sum of item values in the current Query. */ - sum(): JQueryPromise; - /** Adds one more sorting condition to the current Query. */ - thenBy(getter: Object): Query; - /** Adds one more sorting condition to the current Query. */ - thenBy(getter: Object, desc: boolean): Query; - /** Returns the array of current Query items. */ - toArray(): Array; - } - /** The global data layer error handler. */ - export var errorHandler: (e: Error) => void; - /** Encodes the specified string or array of bytes to base64 encoding. */ - export function base64_encode(input: any): string; - /** Creates a Query instance. */ - export function query(array: Array): Query; - /** Creates a Query instance for accessing the remote service specified by a URL. */ - export function query(url: string, queryOptions: Object): Query; - /** This section describes the utility objects provided by the DevExtreme data layer. */ - export var utils: { - /** Compiles a getter function from the getter expression. */ - compileGetter(expr: any): Function; - /** Compiles a setter function from the setter expression. */ - compileSetter(expr: any): Function; - odata: { - /** Holds key value converters for OData. */ - keyConverters: { - String(value: any): string; - Int32(value: any): number; - Int64(value: any): EdmLiteral; - Guid(value: any): Guid; - Boolean(value: any): boolean; - Single(value: any): EdmLiteral; - Decimal(value: any): EdmLiteral; - }; - } - } - } - /** An object that serves as a namespace for DevExtreme UI widgets as well as for methods implementing UI logic in DevExtreme sites/applications. */ - export module ui { - export interface WidgetOptions extends DOMComponentOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A Boolean value specifying whether or not the widget can respond to user interaction. */ - disabled?: boolean; - /** A Boolean value specifying whether or not the widget changes its state when being hovered by an end user. */ - hoverStateEnabled?: boolean; - /** Specifies whether or not the widget can be focused. */ - focusStateEnabled?: boolean; - /** Specifies a shortcut key that sets focus on the widget element. */ - accessKey?: string; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - /** Specifies the widget tab index. */ - tabIndex?: number; - /** Specifies the text of the hint displayed for the widget. */ - hint?: string; - } - /** The base class for widgets. */ - export class Widget extends DOMComponent { - constructor(options?: WidgetOptions); - /** Redraws the widget. */ - repaint(): void; - /** Sets focus on the widget. */ - focus(): void; - /** Registers a handler for pressing of the specified key. */ - registerKeyHandler(key: string, handler: Function): void; - } - export interface CollectionWidgetOptions extends WidgetOptions { - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - itemClickAction?: any; - itemHoldAction?: Function; - /** The time period in milliseconds before the onItemHold event is raised. */ - itemHoldTimeout?: number; - itemRender?: any; - itemRenderedAction?: Function; - /** An array of items displayed by the widget. */ - items?: Array; - /** - * A function performed when a widget item is selected. - * @deprecated onSelectionChanged.md - */ - itemSelectAction?: Function; - /** The template to be used for rendering items. */ - itemTemplate?: any; - loopItemFocus?: boolean; - /** The text or HTML markup displayed by the widget if the item collection is empty. */ - noDataText?: string; - onContentReady?: any; - contentReadyAction?: any; - /** A handler for the itemClick event. */ - onItemClick?: any; - /** A handler for the itemContextMenu event. */ - onItemContextMenu?: Function; - /** A handler for the itemHold event. */ - onItemHold?: Function; - /** A handler for the itemRendered event. */ - onItemRendered?: Function; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: Function; - /** The index of the currently selected widget item. */ - selectedIndex?: number; - /** The selected item object. */ - selectedItem?: Object; - /** An array of currently selected item objects. */ - selectedItems?: Array; - /** A handler for the itemDeleting event. */ - onItemDeleting?: Function; - /** A handler for the itemDeleted event. */ - onItemDeleted?: Function; - /** A handler for the itemReordered event. */ - onItemReordered?: Function; - } - /** The base class for widgets containing an item collection. */ - export class CollectionWidget extends Widget { - constructor(element: JQuery, options?: CollectionWidgetOptions); - constructor(element: HTMLElement, options?: CollectionWidgetOptions); - selectItem(itemElement: any): void; - unselectItem(itemElement: any): void; - deleteItem(itemElement: any): JQueryPromise; - isItemSelected(itemElement: any): boolean; - reorderItem(itemElement: any, toItemElement: any): JQueryPromise; - } - export interface DataExpressionMixinOptions { - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** Specifies the name of the data source item field whose value is displayed by the widget. */ - displayExpr?: any; - /** Specifies the name of a data source item field whose value is held in the value configuration option. */ - valueExpr?: any; - itemRender?: any; - /** An array of items displayed by the widget. */ - items?: Array; - /** The template to be used for rendering items. */ - itemTemplate?: any; - /** The currently selected value in the widget. */ - value?: Object; - } - export interface EditorOptions extends WidgetOptions { - /** The currently specified value. */ - value?: Object; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - valueChangeAction?: Function; - /** A Boolean value specifying whether or not the widget is read-only. */ - readOnly?: boolean; - /** Holds the object that defines the error that occurred during validation. */ - validationError?: Object; - /** Specifies whether the editor's value is valid. */ - isValid?: boolean; - /** Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed. */ - validationMessageMode?: string; - } - /** @docid Editor */ - export class Editor extends Widget { - /** @docid EditorMethods_reset */ - reset(): void; - } - /** An object that serves as a namespace for methods displaying a message in an application/site. */ - export var dialog: { - /** Creates an alert dialog message containing a single "OK" button. */ - alert(message: string, title: string): JQueryPromise; - /** Creates a confirm dialog that contains "Yes" and "No" buttons. */ - confirm(message: string, title: string): JQueryPromise; - /** Creates a custom dialog using the options specified by the passed configuration object. */ - custom(options: { title?: string; message?: string; buttons?: Array; }): { - show(): JQueryPromise; - hide(): void; - hide(value: any): void; - }; - }; - /** Creates a toast message. */ - export function notify(message: any, type: string, displayTime: number): void; - /** Creates a toast message. */ - export function notify(options: Object): void; - /** An object that serves as a namespace for the methods that work with DevExtreme CSS Themes. */ - export var themes: { - /** Returns the name of the currently applied theme. */ - current(): string; - /** Changes the current theme to the specified one. */ - current(themeName: string): void; - }; - /** Sets a specified template engine. */ - export function setTemplateEngine(name: string): void; - /** Sets a custom template engine defined via custom compile and render functions. */ - export function setTemplateEngine(options: Object): void; - /** An object that serves as a namespace for utility methods that can be helpful when working with the DevExtreme framework and UI widgets. */ - export var utils: { - /** Sets parameters for the viewport meta tag. */ - initMobileViewport(options: { allowZoom?: boolean; allowPan?: boolean; allowSelection?: boolean }): void; - }; - } -} -declare namespace DevExpress.data { - export interface XmlaStoreOptions { - /** The HTTP address to an XMLA OLAP server. */ - url?: string; - /** The name of the database associated with the Store. */ - catalog?: string; - /** The cube name. */ - cube?: string; - } - /** A Store that provides access to an OLAP cube using the XMLA standard. */ - export class XmlaStore { - constructor(options: XmlaStoreOptions); - } - export interface PivotGridField { - index?: number; - /** A boolean value specifying whether or not the field is visible in the pivot grid and the Field Chooser. */ - visible?: boolean; - /** Name of the data source field containing data for the pivot grid field. */ - dataField?: string; - /** A caption that will be displayed in the pivot grid's field chooser to identify the field. */ - caption?: string; - /** Specifies a type of field values. */ - dataType?: string; - /** Specifies how the values of the current field are combined into groups. Cannot be used for the XmlaStore store type. */ - groupInterval?: any; - /** Specifies how to aggregate field data. Cannot be used for th XmlaStore store type. */ - summaryType?: string; - /** Allows you to use a custom aggregate function to calculate the summary values. Cannot be used for the XmlaStore store type. */ - calculateCustomSummary?: (options: { - summaryProcess?: string; - value?: any; - totalValue?: any; - }) => void; - /** Specifies the function that determines how to split data from the data source into ranges for header items. Cannot be used for the XmlaStore store type. */ - selector?: (data: Object) => any; - /** Type of the area where the field is located. */ - area?: string; - /** Index among the other fields displayed within the same area. */ - areaIndex?: number; - /** The name of the folder in which the field is located. */ - displayFolder?: string; - /** The name of the group to which the field belongs. */ - groupName?: string; - /** The index of the field within a group. */ - groupIndex?: number; - /** Specifies the initial sort order of field values. */ - sortOrder?: string; - /** Specifies how field data should be sorted. Can be used for the XmlaStore store type only. */ - sortBy?: string; - /** Specifies the data field against which the header items of this field should be sorted. */ - sortBySummaryField?: string; - /** The array of field names that specify a path to column/row whose summary field is used for sorting of this field's header items. */ - sortBySummaryPath?: Array; - /** The filter values for the current field. */ - filterValues?: Array; - /** The filter type for the current field. */ - filterType?: string; - /** Indicates whether all header items of the field's header level are expanded. */ - expanded?: boolean; - /** Specifies whether the field should be treated as a Data Field. */ - isMeasure?: boolean; - /** Specifies a display format for field values. */ - format?: string; - /** Specifies a callback function that returns the text to be displayed in the cells of a field. */ - customizeText?: (cellInfo: { value: any; valueText: string }) => string; - /** Specifies a precision for formatted field values. */ - precision?: number; - /** Specifies how to sort the header items. */ - sortingMethod?: (a: Object, b: Object) => number; - /** Allows an end-user to change sorting options. */ - allowSorting?: boolean; - /** Allows an end-user to sort columns by summary values. */ - allowSortingBySummary?: boolean; - /** Allows an end-user to change filtering options. */ - allowFiltering?: boolean; - /** Allows an end-user to expand/collapse all header items within a header level. */ - allowExpandAll?: boolean; - /** Specifies the absolute width of the field in the pivot grid. */ - width?: number; - } - export interface PivotGridDataSourceOptions { - /** Specifies the underlying Store instance used to access data. */ - store?: any; - /** Indicates whether or not the automatic field generation from data in the Store is enabled. */ - retrieveFields?: boolean; - /** Specifies data filtering conditions. */ - filter?: Object; - /** An array of pivot grid fields. */ - fields?: Array; - /** Indicates whether or not the local sorting of the XMLA data should be performed. */ - localSorting?: boolean; - /** A handler for the changed event. */ - onChanged?: () => void; - /** A handler for the loadingChanged event. */ - onLoadingChanged?: (isLoading: boolean) => void; - /** A handler for the loadError event. */ - onLoadError?: (e?: Object) => void; - /** A handler for the fieldsPrepared event. */ - onFieldsPrepared?: (e?: Array) => void; - } - /** An object that provides access to data for the dxPivotGrid widget. */ - export class PivotGridDataSource implements EventsMixin { - constructor(options?: PivotGridDataSource); - /** Starts loading data. */ - load(): JQueryPromise; - /** Indicates whether or not the PivotGridDataSource is currently being loaded. */ - isLoading(): boolean; - /** Gets data displayed in a PivotGrid. */ - getData(): Object; - /** Gets all fields within a specified area. */ - getAreaFields(area: string, collectGroups: boolean): Array; - /** Gets all fields from the data source. */ - fields(): Array; - /** Sets the fields option. */ - fields(fields: Array): void; - /** Gets current options of a specified field. */ - field(id: number): PivotGridField; - /** Sets one or more options of a specified field. */ - field(id: number, field: PivotGridField): void; - /** Collapses a specified header item. */ - collapseHeaderItem(area: string, path: Array): void; - /** Expands a specified header item. */ - expandHeaderItem(area: string, path: Array): void; - /** Disposes of all resources associated with this PivotGridDataSource. */ - dispose(): void; - on(eventName: string, eventHandler: Function): PivotGridDataSource; - on(events: { [eventName: string]: Function; }): PivotGridDataSource; - off(eventName: string): PivotGridDataSource; - off(eventName: string, eventHandler: Function): PivotGridDataSource; - } -} -declare namespace DevExpress.framework { - /** An object used to store information on the views displayed in an application. */ - export class ViewCache { - viewRemoved: JQueryCallback; - /** Removes all the viewInfo objects from the cache. */ - clear(): void; - /** Obtains a viewInfo object from the cache by the specified key. */ - getView(key: string): Object; - /** Checks whether or not a viewInfo object is contained in the view cache under the specified key. */ - hasView(key: string): boolean; - /** Removes a viewInfo object from the cache by the specified key. */ - removeView(key: string): Object; - /** Adds the specified viewInfo object to the cache under the specified key. */ - setView(key: string, viewInfo: Object): void; - } - export interface dxCommandOptions extends DOMComponentOptions { - action?: any; - /** Specifies an action performed when the execute() method of the command is called. */ - onExecute?: any; - /** Indicates whether or not the widget that displays this command is disabled. */ - disabled?: boolean; - /** Specifies the name of the icon shown inside the widget associated with this command. */ - icon?: string; - iconSrc?: string; - /** The identifier of the command. */ - id?: string; - /** Specifies the title of the widget associated with this command. */ - title?: string; - /** Specifies the type of the button, if the command is rendered as a dxButton widget. */ - type?: string; - /** A Boolean value specifying whether or not the widget associated with this command is visible. */ - visible?: boolean; - } - /** A markup component used to define markup options for a command. */ - export class dxCommand extends DOMComponent { - constructor(element: JQuery, options: dxCommandOptions); - constructor(options: dxCommandOptions); - /** Executes the action associated with this command. */ - execute(): void; - } - /** An object responsible for routing. */ - export class Router { - /** Adds a routing rule to the list of registered rules. */ - register(pattern: string, defaults?: Object, constraints?: Object): void; - /** Decodes the specified URI to an object using the registered routing rules. */ - parse(uri: string): Object; - /** Formats an object to a URI. */ - format(obj: Object): string; - } - export interface StateManagerOptions { - /** A storage to which the state manager saves the application state. */ - storage?: Object; - } - /** An object used to store the current application state. */ - export class StateManager { - constructor(options?: StateManagerOptions); - /** Adds an object that implements an interface of a state source to the state manager's collection of state sources. */ - addStateSource(stateSource: Object): void; - /** Removes a specified state source from the state manager's collection of state sources. */ - removeStateSource(stateSource: Object): void; - /** Saves the current application state. */ - saveState(): void; - /** Restores the application state that has been saved by the saveState() method to the state storage. */ - restoreState(): void; - /** Removes the application state that has been saved by the saveState() method to the state storage. */ - clearState(): void; - } - export module html { - export var layoutSets: Array; - export var animationSets: { [animationSetName: string]: AnimationSet }; - export interface AnimationSet { - [animationName: string]: any - } - export interface HtmlApplicationOptions { - /** Specifies where the commands that are defined in the application's views must be displayed. */ - commandMapping?: Object; - /** Specifies whether or not view caching is disabled. */ - disableViewCache?: boolean; - /** An array of layout controllers that should be used to show application views in the current navigation context. */ - layoutSet?: any; - /** Specifies the animation presets that are used to animate different UI elements in the current application. */ - animationSet?: AnimationSet; - /** Specifies whether the current application must behave as a mobile or web application. */ - mode?: string; - /** Specifies the object that represents a root namespace of the application. */ - namespace?: Object; - /** Specifies application behavior when the user navigates to a root view. */ - navigateToRootViewMode?: string; - /** An array of dxCommand configuration objects used to define commands available from the application's global navigation. */ - navigation?: Array; - /** A state manager to be used in the application. */ - stateManager?: StateManager; - /** Specifies the storage to be used by the application's state manager to store the application state. */ - stateStorage?: Object; - /** Indicates whether on not to use the title of the previously displayed view as text on the Back button. */ - useViewTitleAsBackText?: boolean; - /** A custom view cache to be used in the application. */ - viewCache?: Object; - /** Specifies a limit for the views that can be cached. */ - viewCacheSize?: number; - /** Specifies options for the viewport meta tag of a mobile browser. */ - viewPort?: JQuery; - /** A custom router to be used in the application. */ - router?: Router; - } - /** An object used to manage views, as well as control the application life cycle. */ - export class HtmlApplication implements EventsMixin { - constructor(options: HtmlApplicationOptions); - afterViewSetup: JQueryCallback; - beforeViewSetup: JQueryCallback; - initialized: JQueryCallback; - navigating: JQueryCallback; - navigatingBack: JQueryCallback; - resolveLayoutController: JQueryCallback; - viewDisposed: JQueryCallback; - viewDisposing: JQueryCallback; - viewHidden: JQueryCallback; - viewRendered: JQueryCallback; - viewShowing: JQueryCallback; - viewShown: JQueryCallback; - /** Provides access to the ViewCache object. */ - viewCache: ViewCache; - /** An array of dxCommand components that are created based on the application's navigation option value. */ - navigation: Array; - /** Provides access to the StateManager object. */ - stateManager: StateManager; - /** Provides access to the Router object. */ - router: Router; - /** Navigates to the URI preceding the current one in the navigation history. */ - back(): void; - /** Returns a Boolean value indicating whether or not backwards navigation is currently possible. */ - canBack(): boolean; - /** Calls the clearState() method of the application's StateManager object. */ - clearState(): void; - /** Creates global navigation commands. */ - createNavigation(navigationConfig: Array): void; - /** Returns an HTML template of the specified view. */ - getViewTemplate(viewName: string): JQuery; - /** Returns a configuration object used to create a dxView component for a specified view. */ - getViewTemplateInfo(viewName: string): Object; - /** Adds a specified HTML template to a collection of view or layout templates. */ - loadTemplates(source: any): JQueryPromise; - /** Navigates to the specified URI. */ - navigate(uri?: any, options?: Object): void; - /** Renders navigation commands to the navigation command containers that are located in the layouts used in the application. */ - renderNavigation(): void; - /** Calls the restoreState() method of the application's StateManager object. */ - restoreState(): void; - /** Calls the saveState method of the application's StateManager object. */ - saveState(): void; - /** Provides access to the object that defines the current context to be considered when choosing an appropriate template for a view. */ - templateContext(): Object; - on(eventName: "initialized", eventHandler: () => void): HtmlApplication; - on(eventName: "afterViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "beforeViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "navigating", eventHandler: (e: { - currentUri: string; - uri: string; - cancel: boolean; - options: { - root: boolean; - target: string; - direction: string; - rootInDetailPane: boolean; - modal: boolean; - }; - }) => void): HtmlApplication; - on(eventName: "navigatingBack", eventHandler: (e: { - cancel: boolean; - isHardwareButton: boolean; - }) => void): HtmlApplication; - on(eventName: "resolveLayoutController", eventHandler: (e: { - viewInfo: Object; - layoutController: Object; - availableLayoutControllers: Array; - }) => void): HtmlApplication; - on(eventName: "viewDisposed", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewDisposing", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewHidden", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewRendered", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewShowing", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - on(eventName: "viewShown", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - on(eventName: string, eventHandler: Function): HtmlApplication; - on(events: { [eventName: string]: Function; }): HtmlApplication; - off(eventName: "initialized"): HtmlApplication; - off(eventName: "afterViewSetup"): HtmlApplication; - off(eventName: "beforeViewSetup"): HtmlApplication; - off(eventName: "navigating"): HtmlApplication; - off(eventName: "navigatingBack"): HtmlApplication; - off(eventName: "resolveLayoutController"): HtmlApplication; - off(eventName: "viewDisposed"): HtmlApplication; - off(eventName: "viewDisposing"): HtmlApplication; - off(eventName: "viewHidden"): HtmlApplication; - off(eventName: "viewRendered"): HtmlApplication; - off(eventName: "viewShowing"): HtmlApplication; - off(eventName: "viewShown"): HtmlApplication; - off(eventName: string): HtmlApplication; - off(eventName: "initialized", eventHandler: () => void): HtmlApplication; - off(eventName: "afterViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "beforeViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "navigating", eventHandler: (e: { - currentUri: string; - uri: string; - cancel: boolean; - options: { - root: boolean; - target: string; - direction: string; - rootInDetailPane: boolean; - modal: boolean; - }; - }) => void): HtmlApplication; - off(eventName: "navigatingBack", eventHandler: (e: { - cancel: boolean; - isHardwareButton: boolean; - }) => void): HtmlApplication; - off(eventName: "resolveLayoutController", eventHandler: (e: { - viewInfo: Object; - layoutController: Object; - availableLayoutControllers: Array; - }) => void): HtmlApplication; - off(eventName: "viewDisposed", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewDisposing", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewHidden", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewRendered", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewShowing", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - off(eventName: "viewShown", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - off(eventName: string, eventHandler: Function): HtmlApplication; - } - } -} -declare namespace DevExpress.ui { - export interface dxValidatorOptions extends DOMComponentOptions { - /** An array of validation rules to be checked for the editor with which the dxValidator object is associated. */ - validationRules?: Array; - /** Specifies the editor name to be used in the validation default messages. */ - name?: string; - /** An object that specifies what and when to validate and how to apply the validation result. */ - adapter?: Object; - /** Specifies the validation group the editor will be related to. */ - validationGroup?: string; - /** A handler for the validated event. */ - onValidated?: (params: validationEngine.ValidatorValidationResult) => void; - } - /** A widget that is used to validate the associated DevExtreme editors against the defined validation rules. */ - export class dxValidator extends DOMComponent implements validationEngine.IValidator { - constructor(element: JQuery, options?: dxValidatorOptions); - constructor(element: Element, options?: dxValidatorOptions); - /** Validates the value of the editor that is controlled by the current dxValidator object against the list of the specified validation rules. */ - validate(): validationEngine.ValidatorValidationResult; - /** Resets the value and validation result of the editor associated with the current dxValidator object. */ - reset(): void; - } - /** The widget that is used in the Knockout and Angular approaches to combine the editors to be validated. */ - export class dxValidationGroup extends DOMComponent { - constructor(element: JQuery); - constructor(element: Element); - /** Validates rules of the validators that belong to the current validation group. */ - validate(): validationEngine.ValidationGroupValidationResult; - /** Resets the value and validation result of the editors that are included to the current validation group. */ - reset(): void; - } - export interface dxValidationSummaryOptions extends CollectionWidgetOptions { - /** Specifies the validation group for which summary should be generated. */ - validationGroup?: string; - } - /** A widget for displaying the result of checking validation rules for editors. */ - export class dxValidationSummary extends CollectionWidget { - constructor(element: JQuery, options?: dxValidationSummaryOptions); - constructor(element: Element, options?: dxValidationSummaryOptions); - } - /** A widget that displays required content in a resizable element. */ - export interface dxResizableOptions extends DOMComponentOptions { - /** Specifies which borders of the widget element are used as a handle. */ - handles?: string; - /** Specifies the lower width boundary for resizing. */ - minWidth?: number; - /** Specifies the upper width boundary for resizing. */ - maxWidth?: number; - /** Specifies the lower height boundary for resizing. */ - minHeight?: number; - /** Specifies the upper height boundary for resizing. */ - maxHeight?: number; - /** A handler for the resizeStart event. */ - onResizeStart?: Function; - /** A handler for the resize event. */ - onResize?: Function; - /** A handler for the resizeEnd event. */ - onResizeEnd?: Function; - } - export interface dxTooltipOptions extends dxPopoverOptions { - } - /** A tooltip widget. */ - export class dxTooltip extends dxPopover { - constructor(element: JQuery, options?: dxTooltipOptions); - constructor(element: Element, options?: dxTooltipOptions); - } - export interface dxDropDownListOptions extends dxDropDownEditorOptions { - /** Returns the value currently displayed by the widget. */ - displayValue?: string; - /** The minimum number of characters that must be entered into the text box to begin a search. */ - minSearchLength?: number; - /** Specifies the name of a data source item field or an expression whose value is compared to the search criterion. */ - searchExpr?: Object; - /** Specifies the binary operation used to filter data. */ - searchMode?: string; - /** Specifies the time delay, in milliseconds, after the last character has been typed in, before a search is executed. */ - searchTimeout?: number; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - /** Specifies DOM event names that update a widget's value. */ - valueChangeEvent?: string; - /** Specifies whether or not the widget supports searching. */ - searchEnabled?: boolean; - /** - * Specifies whether or not the widget displays items by pages. - * @deprecated dataSource.paginate.md - */ - pagingEnabled?: boolean; - /** The text or HTML markup displayed by the widget if the item collection is empty. */ - noDataText?: string; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: Function; - /** A handler for the itemClick event. */ - onItemClick?: Function; - onContentReady?: Function; - /** Specifies whether or not the widget supports the focused state and keyboard navigation. */ - focusStateEnabled?: boolean; - } - /** A base class for drop-down list widgets. */ - export class dxDropDownList extends dxDropDownEditor { - constructor(element: JQuery, options?: dxDropDownListOptions); - constructor(element: Element, options?: dxDropDownListOptions); - } - export interface dxToolbarOptions extends CollectionWidgetOptions { - menuItemRender?: any; - /** The template used to render menu items. */ - menuItemTemplate?: any; - /** Informs the widget about its location in a view HTML markup. */ - renderAs?: string; - } - /** A toolbar widget. */ - export class dxToolbar extends CollectionWidget { - constructor(element: JQuery, options?: dxToolbarOptions); - constructor(element: Element, options?: dxToolbarOptions); - } - export interface dxToastOptions extends dxOverlayOptions { - animation?: fx.AnimationOptions; - /** The time span in milliseconds during which the dxToast widget is visible. */ - displayTime?: number; - height?: any; - /** The dxToast message text. */ - message?: string; - position?: PositionOptions; - shading?: boolean; - /** Specifies the dxToast widget type. */ - type?: string; - width?: any; - closeOnBackButton?: boolean; - } - /** The toast message widget. */ - export class dxToast extends dxOverlay { - constructor(element: JQuery, options?: dxToastOptions); - constructor(element: Element, options?: dxToastOptions); - } - export interface dxTextEditorOptions extends EditorOptions { - /** A handler for the change event. */ - onChange?: Function; - changeAction?: Function; - /** A handler for the copy event. */ - onCopy?: Function; - copyAction?: Function; - /** A handler for the cut event. */ - onCut?: Function; - cutAction?: Function; - /** A handler for the enterKey event. */ - onEnterKey?: Function; - enterKeyAction?: Function; - /** A handler for the focusIn event. */ - onFocusIn?: Function; - focusInAction?: Function; - /** A handler for the focusOut event. */ - onFocusOut?: Function; - focusOutAction?: Function; - /** A handler for the input event. */ - onInput?: Function; - inputAction?: Function; - /** A handler for the keyDown event. */ - onKeyDown?: Function; - keyDownAction?: Function; - /** A handler for the keyPress event. */ - onKeyPress?: Function; - keyPressAction?: Function; - /** A handler for the keyUp event. */ - onKeyUp?: Function; - keyUpAction?: Function; - /** A handler for the paste event. */ - onPaste?: Function; - pasteAction?: Function; - /** The text displayed by the widget when the widget value is empty. */ - placeholder?: string; - /** Specifies whether to display the Clear button in the widget. */ - showClearButton?: boolean; - /** Specifies the current value displayed by the widget. */ - value?: any; - /** Specifies DOM event names that update a widget's value. */ - valueChangeEvent?: string; - /** Specifies whether or not the widget checks the inner text for spelling mistakes. */ - spellcheck?: boolean; - /** Specifies HTML attributes applied to the inner input element of the widget. */ - attr?: Object; - /** The read-only option that holds the text displayed by the widget input element. */ - text?: string; - /** Specifies whether or not the widget supports the focused state and keyboard navigation. */ - focusStateEnabled?: boolean; - /** A Boolean value specifying whether or not the widget changes its state when being hovered by an end user. */ - hoverStateEnabled?: boolean; - /** The editor mask, which specifies the format of the entered string. */ - mask?: string; - /** Specifies a mask placeholder character. */ - maskChar?: string; - /** Specifies custom mask rules. */ - maskRules?: Object; - /** A message displayed when the entered text does not match the specified pattern. */ - maskInvalidMessage?: string; - } - /** A base class for text editing widgets. */ - export class dxTextEditor extends Editor { - constructor(element: JQuery, options?: dxTextEditorOptions); - constructor(element: Element, options?: dxTextEditorOptions); - /** Removes focus from the input element. */ - blur(): void; - /** Sets focus to the input element representing the widget. */ - focus(): void; - } - export interface dxTextBoxOptions extends dxTextEditorOptions { - /** Specifies the maximum number of characters you can enter into the textbox. */ - maxLength?: any; - /** The "mode" attribute value of the actual HTML input element representing the text box. */ - mode?: string; - } - /** A single-line text box widget. */ - export class dxTextBox extends dxTextEditor { - constructor(element: JQuery, options?: dxTextBoxOptions); - constructor(element: Element, options?: dxTextBoxOptions); - } - export interface dxTextAreaOptions extends dxTextBoxOptions { - /** Specifies whether or not the widget checks the inner text for spelling mistakes. */ - spellcheck?: boolean; - } - /** A widget used to display and edit multi-line text. */ - export class dxTextArea extends dxTextBox { - constructor(element: JQuery, options?: dxTextAreaOptions); - constructor(element: Element, options?: dxTextAreaOptions); - } - export interface dxTabsOptions extends CollectionWidgetOptions { - /** Specifies whether the widget enables an end-user to select only a single item or multiple items. */ - selectionMode?: string; - /** Specifies whether or not an end-user can scroll tabs by swiping. */ - scrollByContent?: boolean; - /** Specifies whether or not an end-user can scroll tabs. */ - scrollingEnabled?: boolean; - /** A Boolean value that specifies the availability of navigation buttons. */ - showNavButtons?: boolean; - } - /** A tab strip used to switch between pages. */ - export class dxTabs extends CollectionWidget { - constructor(element: JQuery, options?: dxTabsOptions); - constructor(element: Element, options?: dxTabsOptions); - } - export interface dxTabPanelOptions extends dxMultiViewOptions { - /** A handler for the titleClick event. */ - onTitleClick?: any; - /** A handler for the titleHold event. */ - onTitleHold?: Function; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - titleTemplate?: any; - /** The template to be used for rendering an item title. */ - itemTitleTemplate?: any; - } - /** A widget used to display a view and to switch between several views by clicking the appropriate tabs. */ - export class dxTabPanel extends dxMultiView { - constructor(element: JQuery, options?: dxTabPanelOptions); - constructor(element: Element, options?: dxTabPanelOptions); - } - export interface dxSelectBoxOptions extends dxDropDownListOptions { - /** The template to be used for rendering the widget text field. */ - fieldTemplate?: any; - /** The text that is provided as a hint in the select box editor. */ - placeholder?: string; - /** Specifies whether or not the widget allows an end-user to enter a custom value. */ - fieldEditEnabled?: boolean; - } - /** A widget that allows you to select an item in a dropdown list. */ - export class dxSelectBox extends dxDropDownList { - constructor(element: JQuery, options?: dxSelectBoxOptions); - constructor(element: Element, options?: dxSelectBoxOptions); - } - export interface dxTagBoxOptions extends dxSelectBoxOptions { - /** Holds the list of selected values. */ - values?: Array; - } - /** A widget that allows you to select multiple items from a dropdown list. */ - export class dxTagBox extends dxSelectBox { - constructor(element: JQuery, options?: dxTagBoxOptions); - constructor(element: Element, options?: dxTagBoxOptions); - } - export interface dxScrollViewOptions extends dxScrollableOptions { - /** A handler for the pullDown event. */ - onPullDown?: Function; - pullDownAction?: Function; - /** Specifies the text shown in the pullDown panel when pulling the content down lowers the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while pulling the content down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the reachBottom event. */ - onReachBottom?: Function; - reachBottomAction?: Function; - /** Specifies the text shown in the pullDown panel displayed when content is scrolled to the bottom. */ - reachBottomText?: string; - /** Specifies the text shown in the pullDown panel displayed when the content is being refreshed. */ - refreshingText?: string; - /** Returns a value indicating if the scrollView content is larger then the widget container. */ - isFull(): boolean; - /** Locks the widget until the release(preventScrollBottom) method is called and executes the function passed to the onPullDown option and the handler assigned to the pullDown event. */ - refresh(): void; - /** Notifies the scroll view that data loading is finished. */ - release(preventScrollBottom: boolean): JQueryPromise; - /** Toggles the loading state of the widget. */ - toggleLoading(showOrHide: boolean): void; - } - /** A widget used to display scrollable content. */ - export class dxScrollView extends dxScrollable { - constructor(element: JQuery, options?: dxScrollViewOptions); - constructor(element: Element, options?: dxScrollViewOptions); - } - export interface dxScrollableLocation { - top?: number; - left?: number; - } - export interface dxScrollableOptions extends DOMComponentOptions { - /** A string value specifying the available scrolling directions. */ - direction?: string; - /** A Boolean value specifying whether or not the widget can respond to user interaction. */ - disabled?: boolean; - /** A handler for the scroll event. */ - onScroll?: Function; - scrollAction?: Function; - /** Specifies when the widget shows the scrollbar. */ - showScrollbar?: string; - /** A handler for the update event. */ - onUpdated?: Function; - updateAction?: Function; - /** Indicates whether to use native or simulated scrolling. */ - useNative?: boolean; - /** A Boolean value specifying whether to enable or disable the bounce-back effect. */ - bounceEnabled?: boolean; - /** A Boolean value specifying whether or not an end-user can scroll the widget content swiping it up or down. */ - scrollByContent?: boolean; - /** A Boolean value specifying whether or not an end-user can scroll the widget content using the scrollbar. */ - scrollByThumb?: boolean; - } - /** A widget used to display scrollable content. */ - export class dxScrollable extends DOMComponent { - constructor(element: JQuery, options?: dxScrollableOptions); - constructor(element: Element, options?: dxScrollableOptions); - /** Returns the height of the scrollable widget in pixels. */ - clientHeight(): number; - /** Returns the width of the scrollable widget in pixels. */ - clientWidth(): number; - /** Returns an HTML element of the widget. */ - content(): JQuery; - /** Scrolls the widget content by the specified number of pixels. */ - scrollBy(distance: number): void; - /** Scrolls widget content by the specified number of pixels in horizontal and vertical directions. */ - scrollBy(distanceObject: dxScrollableLocation): void; - /** Returns the height of the scrollable content in pixels. */ - scrollHeight(): number; - /** Returns the current scroll position against the leftmost position. */ - scrollLeft(): number; - /** Returns how far the scrollable content is scrolled from the top and from the left. */ - scrollOffset(): dxScrollableLocation; - /** Scrolls widget content to the specified position. */ - scrollTo(targetLocation: number): void; - /** Scrolls widget content to a specified position. */ - scrollTo(targetLocation: dxScrollableLocation): void; - /** Scrolls widget content to the specified element. */ - scrollToElement(element: Element): void; - /** Returns the current scroll position against the topmost position. */ - scrollTop(): number; - /** Returns the width of the scrollable content in pixels. */ - scrollWidth(): number; - /** Updates the dimensions of the scrollable contents. */ - update(): void; - } - export interface dxRadioGroupOptions extends CollectionWidgetOptions { - /** Specifies the radio group layout. */ - layout?: string; - } - /** A widget that enables a user to select one item within a list of items represented by radio buttons. */ - export class dxRadioGroup extends CollectionWidget { - constructor(element: JQuery, options?: dxRadioGroupOptions); - constructor(element: Element, options?: dxRadioGroupOptions); - } - export interface dxPopupOptions extends dxOverlayOptions { - animation?: fx.AnimationOptions; - /** Specifies whether or not to allow a user to drag the popup window. */ - dragEnabled?: boolean; - /** A Boolean value specifying whether or not to display the widget in full-screen mode. */ - fullScreen?: boolean; - position?: PositionOptions; - /** A Boolean value specifying whether or not to display the title in the popup window. */ - showTitle?: boolean; - /** The title in the overlay window. */ - title?: string; - /** A template to be used for rendering the widget title. */ - titleTemplate?: any; - width?: any; - /** Specifies items displayed on the top or bottom toolbar of the popup window. */ - buttons?: Array; - /** Specifies whether or not the widget displays the Close button. */ - showCloseButton?: boolean; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - } - /** A widget that displays required content in a popup window. */ - export class dxPopup extends dxOverlay { - constructor(element: JQuery, options?: dxPopupOptions); - constructor(element: Element, options?: dxPopupOptions); - } - export interface dxPopoverOptions extends dxPopupOptions { - /** An object defining animation options of the widget. */ - animation?: fx.AnimationOptions; - /** Specifies the height of the widget. */ - height?: any; - /** An object defining widget positioning options. */ - position?: PositionOptions; - shading?: boolean; - /** A Boolean value specifying whether or not to display the title in the overlay window. */ - showTitle?: boolean; - /** The target element associated with a popover. */ - target?: any; - /** Specifies the width of the widget. */ - width?: any; - } - /** A widget that displays the required content in a popup window. */ - export class dxPopover extends dxPopup { - constructor(element: JQuery, options?: dxPopoverOptions); - constructor(element: Element, options?: dxPopoverOptions); - /** Displays the widget for the specified target element. */ - show(target?: any): JQueryPromise; - } - export interface dxOverlayOptions extends WidgetOptions { - /** An object that defines the animation options of the widget. */ - animation?: fx.AnimationOptions; - /** A Boolean value specifying whether or not the widget is closed if a user presses the Back hardware button. */ - closeOnBackButton?: boolean; - /** A Boolean value specifying whether or not the widget is closed if a user clicks outside of the overlapping window. */ - closeOnOutsideClick?: any; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - /** Specifies whether or not an end-user can drag the widget. */ - dragEnabled?: boolean; - /** Specifies whether or not an end user can resize the widget. */ - resizeEnabled?: boolean; - /** The height of the widget in pixels. */ - height?: any; - /** A handler for the hidden event. */ - onHidden?: Function; - hiddenAction?: Function; - /** A handler for the hiding event. */ - onHiding?: Function; - hidingAction?: Function; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** A Boolean value specifying whether or not the main screen is inactive while the widget is active. */ - shading?: boolean; - /** Specifies the shading color. */ - shadingColor?: string; - /** A handler for the showing event. */ - onShowing?: Function; - showingAction?: Function; - /** A handler for the shown event. */ - onShown?: Function; - shownAction?: Function; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - /** The widget width in pixels. */ - width?: any; - } - /** A widget displaying the required content in an overlay window. */ - export class dxOverlay extends Widget { - constructor(element: JQuery, options?: dxOverlayOptions); - constructor(element: Element, options?: dxOverlayOptions); - /** An HTML element of the widget. */ - content(): JQuery; - /** Hides the widget. */ - hide(): JQueryPromise; - /** Recalculates the overlay's size and position. */ - repaint(): void; - /** Shows the widget. */ - show(): JQueryPromise; - /** Toggles the visibility of the widget. */ - toggle(showing: boolean): JQueryPromise; - /** A static method that specifies the default z-index for all overlay widgets. */ - static baseZIndex(zIndex: number): void; - } - export interface dxNumberBoxOptions extends dxTextEditorOptions { - /** The maximum value accepted by the number box. */ - max?: number; - /** The minimum value accepted by the number box. */ - min?: number; - /** Specifies whether or not to show spin buttons. */ - showSpinButtons?: boolean; - useTouchSpinButtons?: boolean; - /** Specifies by which value the widget value changes when a spin button is clicked. */ - step?: number; - /** The current number box value. */ - value?: number; - } - /** A textbox widget that enables a user to enter numeric values. */ - export class dxNumberBox extends dxTextEditor { - constructor(element: JQuery, options?: dxNumberBoxOptions); - constructor(element: Element, options?: dxNumberBoxOptions); - } - export interface dxNavBarOptions extends dxTabsOptions { - scrollingEnabled?: boolean; - } - /** A widget that contains items used to navigate through application views. */ - export class dxNavBar extends dxTabs { - constructor(element: JQuery, options?: dxNavBarOptions); - constructor(element: Element, options?: dxNavBarOptions); - } - export interface dxMultiViewOptions extends CollectionWidgetOptions { - /** Specifies whether or not to animate the displayed item change. */ - animationEnabled?: boolean; - /** A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped. */ - loop?: boolean; - /** The index of the currently displayed item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to allow users to change the selected index by swiping. */ - swipeEnabled?: boolean; - } - /** A widget used to display a view and to switch between several views. */ - export class dxMultiView extends CollectionWidget { - constructor(element: JQuery, options?: dxMultiViewOptions); - constructor(element: Element, options?: dxMultiViewOptions); - } - export interface dxMapOptions extends WidgetOptions { - /** Specifies whether or not the widget automatically adjusts center and zoom option values when adding a new marker or route. */ - autoAdjust?: boolean; - bounds?: { - northEast?: { - lat?: number; - lng?: number; - }; - southWest?: { - lat?: number; - lng?: number; - }; - /** An object, a string, or an array specifying the location displayed at the center of the widget. */ - center?: { - /** The latitude location displayed in the center of the widget. */ - lat?: number; - /** The longitude location displayed in the center of the widget. */ - lng?: number; - }; - /** A handler for the click event. */ - onClick?: any; - clickAction?: any; - /** Specifies whether or not map widget controls are available. */ - controls?: boolean; - /** Specifies the height of the widget. */ - height?: number; - /** A key used to authenticate the application within the required map provider. */ - key?: { - /** A key used to authenticate the application within the "Bing" map provider. */ - bing?: string; - /** A key used to authenticate the application within the "Google" map provider. */ - google?: string; - /** A key used to authenticate the application within the "Google Static" map provider. */ - googleStatic?: string; - } - /** A handler for the markerAdded event. */ - onMarkerAdded?: Function; - markerAddedAction?: Function; - /** A URL pointing to the custom icon to be used for map markers. */ - markerIconSrc?: string; - /** A handler for the markerRemoved event. */ - onMarkerRemoved?: Function; - markerRemovedAction?: Function; - /** An array of markers displayed on a map. */ - markers?: Array; - /** The name of the current map data provider. */ - provider?: string; - /** A handler for the ready event. */ - onReady?: Function; - readyAction?: Function; - /** A handler for the routeAdded event. */ - onRouteAdded?: Function; - routeAddedAction?: Function; - /** A handler for the routeRemoved event. */ - onRouteRemoved?: Function; - routeRemovedAction?: Function; - /** An array of routes shown on the map. */ - routes?: Array; - /** The type of a map to display. */ - type?: string; - /** Specifies the width of the widget. */ - width?: number; - /** The zoom level of the map. */ - zoom?: number; - /** Adds a marker to the map. */ - addMarker(markerOptions: Object): JQueryPromise; - /** Adds a route to the map. */ - addRoute(options: Object): JQueryPromise; - /** Removes a marker from the map. */ - removeMarker(marker: Object): JQueryPromise; - /** Removes a route from the map. */ - removeRoute(route: any): JQueryPromise; - }; - } - /** An interactive map widget. */ - export class dxMap extends Widget { - constructor(element: JQuery, options?: dxMapOptions); - constructor(element: Element, options?: dxMapOptions); - } - export interface dxLookupOptions extends dxDropDownListOptions { - /** An object defining widget animation options. */ - animation?: fx.AnimationOptions; - /** The text displayed on the Cancel button. */ - cancelButtonText?: string; - /** The text displayed on the Clear button. */ - clearButtonText?: string; - /** Specifies whether or not the widget cleans the search box when the popup window is displayed. */ - cleanSearchOnOpening?: boolean; - /** A Boolean value specifying whether or not the widget is closed if a user clicks outside of the overlaying window. */ - closeOnOutsideClick?: any; - /** The text displayed on the Apply button. */ - applyButtonText?: string; - /** A Boolean value specifying whether or not to display the lookup in full-screen mode. */ - fullScreen?: boolean; - /** A Boolean value specifying whether or not to group widget items. */ - grouped?: boolean; - groupRender?: any; - /** The name of the template used to display a group header. */ - groupTemplate?: any; - /** The text displayed on the button used to load the next page from the data source. */ - nextButtonText?: string; - /** A handler for the pageLoading event. */ - onPageLoading?: Function; - /** Specifies whether the next page is loaded when a user scrolls the widget to the bottom or when the "next" button is clicked. */ - pageLoadMode?: string; - pageLoadingAction?: Function; - /** Specifies the text shown in the pullDown panel, which is displayed when the widget is scrolled to the bottom. */ - pageLoadingText?: string; - /** The text displayed by the widget when nothing is selected. */ - placeholder?: string; - /** The height of the widget popup element. */ - popupHeight?: any; - /** The width of the widget popup element. */ - popupWidth?: any; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** Specifies the text displayed in the pullDown panel when the widget is pulled below the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the pullRefresh event. */ - onPullRefresh?: Function; - pullRefreshAction?: Function; - /** A Boolean value specifying whether or not the widget supports the "pull down to refresh" gesture. */ - pullRefreshEnabled?: boolean; - /** Specifies the text displayed in the pullDown panel while the widget is being refreshed. */ - refreshingText?: string; - /** A handler for the scroll event. */ - onScroll?: Function; - scrollAction?: Function; - /** A Boolean value specifying whether or not the search bar is visible. */ - searchEnabled?: boolean; - /** The text that is provided as a hint in the lookup's search bar. */ - searchPlaceholder?: string; - /** A Boolean value specifying whether or not the main screen is inactive while the lookup is active. */ - shading?: boolean; - /** Specifies whether to display the Cancel button in the lookup window. */ - showCancelButton?: boolean; - /** - * A Boolean value specifying whether the widget loads the next page automatically when you reach the bottom of the list or when a button is clicked. - * @deprecated pageLoadMode.md - */ - showNextButton?: boolean; - /** The title of the lookup window. */ - title?: string; - /** A template to be used for rendering the widget title. */ - titleTemplate?: any; - /** Specifies whether or not the widget uses native scrolling. */ - useNativeScrolling?: boolean; - /** Specifies whether or not to show lookup contents in a dxPopover widget. */ - usePopover?: boolean; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - contentReadyAction?: Function; - titleRender?: any; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - /** Specifies whether or not the widget supports the focused state and keyboard navigation. */ - focusStateEnabled?: boolean; - /** A Boolean value specifying whether or not to display the title in the popup window. */ - showPopupTitle?: boolean; - } - /** A widget that allows a user to select predefined values from a lookup window. */ - export class dxLookup extends dxDropDownList { - constructor(element: JQuery, options?: dxLookupOptions); - constructor(element: Element, options?: dxLookupOptions); - /** This section lists the data source fields that are used in a default template for lookup drop-down items. */ - } - export interface dxLoadPanelOptions extends dxOverlayOptions { - /** An object defining the animation options of the widget. */ - animation?: fx.AnimationOptions; - /** The delay in milliseconds after which the load panel is displayed. */ - delay?: number; - /** The height of the widget. */ - height?: number; - /** A URL pointing to an image to be used as a load indicator. */ - indicatorSrc?: string; - /** The text displayed in the load panel. */ - message?: string; - /** A Boolean value specifying whether or not to show a load indicator. */ - showIndicator?: boolean; - /** A Boolean value specifying whether or not to show the pane behind the load indicator. */ - showPane?: boolean; - /** The width of the widget. */ - width?: number; - } - /** A widget used to indicate whether or not an element is loading. */ - export class dxLoadPanel extends dxOverlay { - constructor(element: JQuery, options?: dxLoadPanelOptions); - constructor(element: Element, options?: dxLoadPanelOptions); - } - export interface dxLoadIndicatorOptions extends WidgetOptions { - /** Specifies the path to an image used as the indicator. */ - indicatorSrc?: string; - } - /** The widget used to indicate the loading process. */ - export class dxLoadIndicator extends Widget { - constructor(element: JQuery, options?: dxLoadIndicatorOptions); - constructor(element: Element, options?: dxLoadIndicatorOptions); - } - export interface dxListOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not to display a grouped list. */ - grouped?: boolean; - groupRender?: any; - /** The template to be used for rendering item groups. */ - groupTemplate?: any; - onItemDeleting?: Function; - /** A handler for the itemDeleted event. */ - onItemDeleted?: Function; - /** A handler for the groupRendered event. */ - onGroupRendered?: Function; - itemDeleteAction?: Function; - /** A handler for the itemReordered event. */ - onItemReordered?: Function; - itemReorderAction?: Function; - /** A handler for the itemClick event. */ - onItemClick?: any; - /** A handler for the itemSwipe event. */ - onItemSwipe?: Function; - itemSwipeAction?: Function; - /** The text displayed on the button used to load the next page from the data source. */ - nextButtonText?: string; - /** A handler for the pageLoading event. */ - onPageLoading?: Function; - pageLoadingAction?: Function; - /** Specifies the text shown in the pullDown panel, which is displayed when the list is scrolled to the bottom. */ - pageLoadingText?: string; - /** Specifies the text displayed in the pullDown panel when the list is pulled below the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the pullRefresh event. */ - onPullRefresh?: Function; - pullRefreshAction?: Function; - /** A Boolean value specifying whether or not the widget supports the "pull down to refresh" gesture. */ - pullRefreshEnabled?: boolean; - /** Specifies the text displayed in the pullDown panel while the list is being refreshed. */ - refreshingText?: string; - /** A handler for the scroll event. */ - onScroll?: Function; - scrollAction?: Function; - /** A Boolean value specifying whether to enable or disable list scrolling. */ - scrollingEnabled?: boolean; - /** Specifies when the widget shows the scrollbar. */ - showScrollbar?: string; - /** Specifies whether or not the widget uses native scrolling. */ - useNativeScrolling?: boolean; - /** A Boolean value specifying whether to enable or disable the bounce-back effect. */ - bounceEnabled?: boolean; - /** A Boolean value specifying if the list is scrolled by content. */ - scrollByContent?: boolean; - /** A Boolean value specifying if the list is scrolled using the scrollbar. */ - scrollByThumb?: boolean; - itemUnselectAction?: Function; - onItemContextMenu?: Function; - onItemHold?: Function; - /** Specifies whether or not an end-user can collapse groups. */ - collapsibleGroups?: boolean; - /** Specifies whether the next page is loaded when a user scrolls the widget to the bottom or when the "next" button is clicked. */ - pageLoadMode?: string; - /** Specifies whether or not to display controls used to select list items. */ - showSelectionControls?: boolean; - /** Specifies whether the list supports single item selection or multi-selection. */ - selectionMode?: string; - selectAllText?: string; - /** Specifies the array of items for a context menu called for a list item. */ - menuItems?: Array; - /** Specifies whether an item context menu is shown when a user holds or swipes an item. */ - menuMode?: string; - /** Specifies whether or not an end user can delete list items. */ - allowItemDeleting?: boolean; - /** Specifies the way a user can delete items from the list. */ - itemDeleteMode?: string; - /** Specifies whether or not an end user can reorder list items. */ - allowItemReordering?: boolean; - /** Specifies whether or not to show the loading panel when the DataSource bound to the widget is loading data. */ - indicateLoading?: boolean; - } - /** A list widget. */ - export class dxList extends CollectionWidget { - constructor(element: JQuery, options?: dxListOptions); - constructor(element: Element, options?: dxListOptions); - /** Returns the height of the widget in pixels. */ - clientHeight(): number; - /** Removes the specified item from the list. */ - deleteItem(itemIndex: any): JQueryPromise; - /** Removes the specified item from the list. */ - deleteItem(itemElement: Element): JQueryPromise; - /** Returns a Boolean value that indicates whether or not the specified item is selected. */ - isItemSelected(itemIndex: any): boolean; - /** Returns a Boolean value that indicates whether or not the specified item is selected. */ - isItemSelected(itemElement: Element): boolean; - /** Reloads list data. */ - reload(): void; - /** Moves the specified item to the specified position in the list. */ - reorderItem(itemElement: Element, toItemElement: Element): JQueryPromise; - /** Moves the specified item to the specified position in the list. */ - reorderItem(itemIndex: any, toItemIndex: any): JQueryPromise; - /** Scrolls the list content by the specified number of pixels. */ - scrollBy(distance: number): void; - /** Returns the height of the list content in pixels. */ - scrollHeight(): number; - /** Scrolls list content to the specified position. */ - scrollTo(location: number): void; - /** Scrolls the list to the specified item. */ - scrollToItem(itemElement: Element): void; - /** Scrolls the list to the specified item. */ - scrollToItem(itemIndex: any): void; - /** Returns how far the list content is scrolled from the top. */ - scrollTop(): number; - /** Selects the specified item from the list. */ - selectItem(itemElement: Element): void; - /** Selects the specified item from the list. */ - selectItem(itemIndex: any): void; - /** Deselects the specified item from the list. */ - unselectItem(itemElement: Element): void; - /** Unselects the specified item from the list. */ - unselectItem(itemIndex: any): void; - /** Updates the widget scrollbar according to widget content size. */ - updateDimensions(): JQueryPromise; - /** Expands the specified group. */ - expandGroup(groupIndex: number): JQueryPromise; - /** Collapses the specified group. */ - collapseGroup(groupIndex: number): JQueryPromise; - } - export interface dxGalleryOptions extends CollectionWidgetOptions { - /** The time, in milliseconds, spent on slide animation. */ - animationDuration?: number; - /** Specifies whether or not to animate the displayed item change. */ - animationEnabled?: boolean; - /** A Boolean value specifying whether or not to allow users to switch between items by clicking an indicator. */ - indicatorEnabled?: boolean; - /** A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped. */ - loop?: boolean; - /** The index of the currently active gallery item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to display an indicator that points to the selected gallery item. */ - showIndicator?: boolean; - /** A Boolean value that specifies the availability of the "Forward" and "Back" navigation buttons. */ - showNavButtons?: boolean; - /** The time interval in milliseconds, after which the gallery switches to the next item. */ - slideshowDelay?: number; - /** A Boolean value specifying whether or not to allow users to switch between items by swiping. */ - swipeEnabled?: boolean; - /** Specifies whether or not to display parts of previous and next images along the sides of the current image. */ - wrapAround?: boolean; - /** Specifies if the widget stretches images to fit the total gallery width. */ - stretchImages?: boolean; - /** Specifies the width of an area used to display a single image. */ - initialItemWidth?: number; - } - /** An image gallery widget. */ - export class dxGallery extends CollectionWidget { - constructor(element: JQuery, options?: dxGalleryOptions); - constructor(element: Element, options?: dxGalleryOptions); - /** Shows the specified gallery item. */ - goToItem(itemIndex: number, animation: boolean): JQueryPromise; - /** Shows the next gallery item. */ - nextItem(animation: boolean): JQueryPromise; - /** Shows the previous gallery item. */ - prevItem(animation: boolean): JQueryPromise; - } - export interface dxDropDownEditorOptions extends dxTextBoxOptions { - /** Specifies the current value displayed by the widget. */ - value?: Object; - /** A handler for the closed event. */ - onClosed?: Function; - /** A handler for the opened event. */ - onOpened?: Function; - /** Specifies whether or not the drop-down editor is displayed. */ - opened?: boolean; - closeAction?: Function; - openAction?: Function; - shownAction?: Function; - hiddenAction?: Function; - /** Specifies whether or not the widget allows an end-user to enter a custom value. */ - fieldEditEnabled?: boolean; - editEnabled?: boolean; - /** Specifies the way an end-user applies the selected value. */ - applyValueMode?: string; - /** Specifies whether or not the widget supports the focused state and keyboard navigation. */ - focusStateEnabled?: boolean; - } - /** A drop-down editor widget. */ - export class dxDropDownEditor extends dxTextBox { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - /** Closes the drop-down editor. */ - close(): void; - /** Opens the drop-down editor. */ - open(): void; - /** Resets the widget's value to null. */ - reset(): void; - /** Returns an <input> element of the widget. */ - field(): JQuery; - /** Returns an HTML element of the popup window content. */ - content(): JQuery; - } - export interface dxDateBoxOptions extends dxTextEditorOptions { - /** A format used to display date/time information. */ - format?: string; - /** A Globalize format string specifying the date display format. */ - formatString?: string; - /** The last date that can be selected within the widget. */ - max?: Date; - /** The minimum date that can be selected within the widget. */ - min?: Date; - /** The text displayed by the widget when the widget value is not yet specified. This text is also used as a title of the date picker. */ - placeholder?: string; - /** - * Specifies whether or not a user can pick out a date using the drop-down calendar. - * @deprecated Use 'pickerType' option instead. - */ - useCalendar?: boolean; - /** A Date object specifying the date and time currently selected using the date box. */ - value?: Date; - /** - * Specifies whether or not the widget uses the native HTML input element. - * @deprecated Use 'pickerType' option instead. - */ - useNative?: boolean; - /** Specifies the interval between neighboring values in the popup list in minutes. */ - interval?: number; - /** Specifies the maximum zoom level of a calendar, which is used to pick the date. */ - maxZoomLevel?: string; - /** Specifies the type of date/time picker. */ - pickerType?: string; - } - /** A date box widget. */ - export class dxDateBox extends dxDropDownEditor { - constructor(element: JQuery, options?: dxDateBoxOptions); - constructor(element: Element, options?: dxDateBoxOptions); - } - export interface dxCheckBoxOptions extends EditorOptions { - /** Specifies the widget state. */ - value?: boolean; - /** Specifies the text displayed by the check box. */ - text?: string; - } - /** A check box widget. */ - export class dxCheckBox extends Editor { - constructor(element: JQuery, options?: dxCheckBoxOptions); - constructor(element: Element, options?: dxCheckBoxOptions); - } - export interface dxCalendarOptions extends EditorOptions { - /** Specifies a date displayed on the current calendar page. */ - currentDate?: Date; - /** Specifies the first day of a week. */ - firstDayOfWeek?: number; - /** The latest date the widget allows to select. */ - max?: Date; - /** The earliest date the widget allows to select. */ - min?: Date; - /** Specifies whether or not the widget displays a button that selects the current date. */ - showTodayButton?: boolean; - /** Specifies the current calendar zoom level. */ - zoomLevel?: string; - /** Specifies the maximum zoom level of the calendar. */ - maxZoomLevel?: string; - /** Specifies the minimum zoom level of the calendar. */ - minZoomLevel?: string; - /** The template to be used for rendering calendar cells. */ - cellTemplate?: any; - } - /** A calendar widget. */ - export class dxCalendar extends Editor { - constructor(element: JQuery, options?: dxCalendarOptions); - constructor(element: Element, options?: dxCalendarOptions); - } - export interface dxButtonOptions extends WidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A handler for the click event. */ - onClick?: any; - clickAction?: any; - /** The name of an icon to be displayed on the button. */ - icon?: string; - iconSrc?: string; - /** The text displayed on the button. */ - text?: string; - /** Specifies the button type. */ - type?: string; - /** Specifies the name of the validation group to be accessed in the click event handler. */ - validationGroup?: string; - } - /** A button widget. */ - export class dxButton extends Widget { - constructor(element: JQuery, options?: dxButtonOptions); - constructor(element: Element, options?: dxButtonOptions); - } - export interface dxBoxOptions extends CollectionWidget { - /** Specifies how widget items are aligned along the main direction. */ - align?: string; - /** Specifies the direction of item positioning in the widget. */ - direction?: string; - /** Specifies how widget items are aligned cross-wise. */ - crossAlign?: string; - } - /** A container widget used to arrange inner elements. */ - export class dxBox extends CollectionWidget { - constructor(element: JQuery, options?: dxBoxOptions); - constructor(element: Element, options?: dxBoxOptions); - } - export interface dxResponsiveBoxOptions extends CollectionWidgetOptions { - /** Specifies the collection of rows for the grid used to position layout elements. */ - rows?: Array; - /** Specifies the collection of columns for the grid used to position layout elements. */ - cols?: Array; - /** Specifies the function returning the screen factor depending on the screen width. */ - screenByWidth?: (width: number) => string; - /** Specifies the screen factor with which all elements are located in a single column. */ - singleColumnScreen?: string; - } - /** A widget used to build an adaptive markup that is dependent on screen resolution. */ - export class dxResponsiveBox extends CollectionWidget { - constructor(element: JQuery, options?: dxBoxOptions); - constructor(element: Element, options?: dxBoxOptions); - } - export interface dxAutocompleteOptions extends dxDropDownListOptions { - /** Specifies the current value displayed by the widget. */ - value?: string; - /** The minimum number of characters that must be entered into the text box to begin a search. */ - minSearchLength?: number; - /** Specifies the maximum count of items displayed by the widget. */ - maxItemCount?: number; - /** Specifies the currently selected item. */ - selectedItem?: Object; - } - /** A textbox widget that supports autocompletion. */ - export class dxAutocomplete extends dxDropDownList { - constructor(element: JQuery, options?: dxAutocompleteOptions); - constructor(element: Element, options?: dxAutocompleteOptions); - /** Opens the drop-down editor. */ - open(): void; - /** Closes the drop-down editor. */ - close(): void; - } - export interface dxAccordionOptions extends CollectionWidgetOptions { - /** A number specifying the time in milliseconds spent on the animation of the expanding or collapsing of a panel. */ - animationDuration?: number; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies whether all items can be collapsed or whether at least one item must always be expanded. */ - collapsible?: boolean; - /** Specifies whether the widget can expand several items or only a single item at once. */ - multiple?: boolean; - /** The template to be used for rendering dxAccordion items. */ - itemTemplate?: any; - /** A handler for the itemTitleClick event. */ - onItemTitleClick?: any; - /** A handler for the itemTitleHold event. */ - onItemTitleHold?: Function; - /** The template to be used for rendering an item title. */ - itemTitleTemplate?: any; - /** The index number of the currently selected item. */ - selectedIndex?: number; - } - /** A widget that displays data source items on collapsible panels. */ - export class dxAccordion extends CollectionWidget { - constructor(element: JQuery, options?: dxAccordionOptions); - constructor(element: Element, options?: dxAccordionOptions); - /** Collapses the specified item. */ - collapseItem(index: number): JQueryPromise; - /** Expands the specified item. */ - expandItem(index: number): JQueryPromise; - } - export interface dxFileUploaderOptions extends EditorOptions { - /** A read-only option that holds a File instance representing the selected file. */ - value?: File; - /** Holds the File instances representing files selected in the widget. */ - values?: Array; - buttonText?: string; - /** The text displayed on the button that opens the file browser. */ - selectButtonText?: string; - /** The text displayed on the button that starts uploading. */ - uploadButtonText?: string; - /** Specifies the text displayed on the area to which an end-user can drop a file. */ - labelText?: string; - /** Specifies the value passed to the name attribute of the underlying input element. */ - name?: string; - /** Specifies whether the widget enables an end-user to select a single file or multiple files. */ - multiple?: boolean; - /** Specifies a file type or several types accepted by the widget. */ - accept?: string; - /** Specifies a target Url for the upload request. */ - uploadUrl?: string; - /** Specifies if an end user can remove a just uploaded file. */ - allowCanceling?: boolean; - /** Specifies whether or not the widget displays the list of selected files. */ - showFileList?: boolean; - /** Gets the current progress in percentages. */ - progress?: number; - /** The message displayed by the widget when it is ready to upload the specified files. */ - readyToUploadMessage?: string; - /** The message displayed by the widget when uploading is finished. */ - uploadedMessage?: string; - /** The message displayed by the widget on uploading failure. */ - uploadFailedMessage?: string; - /** Specifies how the widget uploads files. */ - uploadMode?: string; - } - /** A widget used to select and upload a file or multiple files. */ - export class dxFileUploader extends Editor { - constructor(element: JQuery, options?: dxFileUploaderOptions); - constructor(element: Element, options?: dxFileUploaderOptions); - } - export interface dxTrackBarOptions extends EditorOptions { - /** The minimum value the widget can accept. */ - min?: number; - /** The maximum value the widget can accept. */ - max?: number; - /** The current widget value. */ - value?: number; - } - /** A base class for track bar widgets. */ - export class dxTrackBar extends Editor { - constructor(element: JQuery, options?: dxTrackBarOptions); - constructor(element: Element, options?: dxTrackBarOptions); - } - export interface dxProgressBarOptions extends dxTrackBarOptions { - /** Specifies a format for the progress status. */ - statusFormat?: any; - /** Specifies whether or not the widget displays a progress status. */ - showStatus?: boolean; - /** A handler for the complete event. */ - onComplete?: Function; - } - /** A widget used to indicate progress. */ - export class dxProgressBar extends dxTrackBar { - constructor(element: JQuery, options?: dxProgressBarOptions); - constructor(element: Element, options?: dxProgressBarOptions); - } - export interface dxSliderOptions extends dxTrackBarOptions { - /** The slider step size. */ - step?: number; - /** The current slider value. */ - value?: number; - /** Specifies whether or not to highlight a range selected within the widget. */ - showRange?: boolean; - /** Specifies the size of a step by which a slider handle is moved when a user uses the Page up or Page down keyboard shortcuts. */ - keyStep?: number; - /** Specifies options for the slider tooltip. */ - tooltip?: { - /** Specifies whether or not the tooltip is enabled. */ - enabled?: boolean; - /** Specifies format for the tooltip. */ - format?: any; - /** Specifies whether the tooltip is located over or under the slider. */ - position?: string; - /** Specifies whether the widget always shows a tooltip or only when a pointer is over the slider. */ - showMode?: string; - }; - /** Specifies options for labels displayed at the min and max values. */ - label?: { - /** Specifies whether or not slider labels are visible. */ - visible?: boolean; - /** Specifies whether labels are located over or under the scale. */ - position?: string; - /** Specifies a format for labels. */ - format?: any; - }; - } - /** A widget that allows a user to select a numeric value within a given range. */ - export class dxSlider extends dxTrackBar { - constructor(element: JQuery, options?: dxSliderOptions); - constructor(element: Element, options?: dxSliderOptions); - } - export interface dxRangeSliderOptions extends dxSliderOptions { - /** The left edge of the interval currently selected using the range slider. */ - start?: number; - /** The right edge of the interval currently selected using the range slider. */ - end?: number; - } - /** A widget that enables a user to select a range of numeric values. */ - export class dxRangeSlider extends dxSlider { - constructor(element: JQuery, options?: dxRangeSliderOptions); - constructor(element: Element, options?: dxRangeSliderOptions); - } - export interface dxTileViewOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** Specifies the height of the base tile view item. */ - baseItemHeight?: number; - /** Specifies the width of the base tile view item. */ - baseItemWidth?: number; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies the distance in pixels between adjacent tiles. */ - itemMargin?: number; - /** A Boolean value specifying whether or not to display a scrollbar. */ - showScrollbar?: boolean; - } - /** A widget displaying several blocks of data as tiles. */ - export class dxTileView extends CollectionWidget { - constructor(element: JQuery, options?: dxTileViewOptions); - constructor(element: Element, options?: dxTileViewOptions); - /** Returns the current scroll position of the widget content. */ - scrollPosition(): number; - } - export interface dxSwitchOptions extends EditorOptions { - /** Text displayed when the widget is in a disabled state. */ - offText?: string; - /** Text displayed when the widget is in an enabled state. */ - onText?: string; - /** A Boolean value specifying whether the current switch state is "On" or "Off". */ - value?: boolean; - } - /** A switch widget. */ - export class dxSwitch extends Editor { - constructor(element: JQuery, options?: dxSwitchOptions); - constructor(element: Element, options?: dxSwitchOptions); - } - export interface dxSlideOutViewOptions extends WidgetOptions { - /** Specifies whether or not the menu panel is visible. */ - menuVisible?: boolean; - /** Specifies whether or not the menu is shown when a user swipes the widget content. */ - swipeEnabled?: boolean; - /** A template to be used for rendering menu panel content. */ - menuTemplate?: any; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - } - /** The widget that allows you to slide-out the current view to reveal a custom menu. */ - export class dxSlideOutView extends Widget { - constructor(element: JQuery, options?: dxSlideOutViewOptions); - constructor(element: Element, options?: dxSlideOutViewOptions); - /** Returns an HTML element of the widget menu block. */ - menuContent(): JQuery; - /** Returns an HTML element of the widget content block. */ - content(): JQuery; - /** Displays the widget's menu block. */ - showMenu(): JQueryPromise; - /** Hides the widget's menu block. */ - hideMenu(): JQueryPromise; - /** Toggles the visibility of the widget's menu block. */ - toggleMenuVisibility(): JQueryPromise; - } - export interface dxSlideOutOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A Boolean value specifying whether or not to display a grouped menu. */ - menuGrouped?: boolean; - menuGroupRender?: any; - /** The name of the template used to display a group header. */ - menuGroupTemplate?: any; - menuItemRender?: any; - /** The template used to render menu items. */ - menuItemTemplate?: any; - /** A handler for the menuGroupRendered event. */ - onMenuGroupRendered?: Function; - /** A handler for the menuItemRendered event. */ - onMenuItemRendered?: Function; - /** Specifies whether or not the slide-out menu is displayed. */ - menuVisible?: boolean; - /** Indicates whether the menu can be shown/hidden by swiping the widget's main panel. */ - swipeEnabled?: boolean; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - } - /** The widget that allows you to slide-out the current view to reveal an item list. */ - export class dxSlideOut extends CollectionWidget { - constructor(element: JQuery, options?: dxSlideOutOptions); - constructor(element: Element, options?: dxSlideOutOptions); - /** Hides the widget's slide-out menu. */ - hideMenu(): JQueryPromise; - /** Displays the widget's slide-out menu. */ - showMenu(): JQueryPromise; - /** Toggles the visibility of the widget's slide-out menu. */ - toggleMenuVisibility(showing: boolean): JQueryPromise; - } - export interface dxPivotOptions extends CollectionWidgetOptions { - /** The index of the currently active pivot item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to allow users to switch between items by swiping. */ - swipeEnabled?: boolean; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - } - /** A widget that is similar to a traditional tab control, but optimized for the phone with simplified end-user interaction. */ - export class dxPivot extends CollectionWidget { - constructor(element: JQuery, options?: dxPivotOptions); - constructor(element: Element, options?: dxPivotOptions); - } - export interface dxPanoramaOptions extends CollectionWidgetOptions { - /** An object exposing options for setting a background image for the panorama. */ - backgroundImage?: { - /** Specifies the height of the panorama's background image. */ - height?: number; - /** Specifies the URL of the image that is used as the panorama's background image. */ - url?: string; - /** Specifies the width of the panorama's background image. */ - width?: number; - }; - /** The index of the currently active panorama item. */ - selectedIndex?: number; - /** Specifies the widget content title. */ - title?: string; - } - /** A widget displaying the required content in a long horizontal canvas that extends beyond the frames of the screen. */ - export class dxPanorama extends CollectionWidget { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - } - export interface dxDropDownMenuOptions extends WidgetOptions { - /** A handler for the buttonClick event. */ - onButtonClick?: any; - buttonClickAction?: any; - /** The name of the icon to be displayed by the DropDownMenu button. */ - buttonIcon?: string; - buttonIconSrc?: string; - /** The text displayed in the DropDownMenu button. */ - buttonText?: string; - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** A handler for the itemClick event. */ - onItemClick?: any; - itemClickAction?: any; - itemRender?: any; - /** An array of items displayed by the widget. */ - items?: Array; - /** The template to be used for rendering items. */ - itemTemplate?: any; - /** Specifies whether or not to show the drop down menu within a dxPopover widget. */ - usePopover?: boolean; - /** The width of the menu popup in pixels. */ - popupWidth?: any; - /** The height of the menu popup in pixels. */ - popupHeight?: any; - /** Specifies whether or not the drop-down menu is displayed. */ - opened?: boolean; - /** A Boolean value specifying whether or not the widget changes its state when being hovered by an end user. */ - hoverStateEnabled?: boolean; - } - /** A drop-down menu widget. */ - export class dxDropDownMenu extends Widget { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - /** This section lists the data source fields that are used in a default template for drop-down menu items. */ - /** Opens the drop-down menu. */ - open(): void; - /** Closes the drop-down menu. */ - close(): void; - } - export interface dxActionSheetOptions extends CollectionWidgetOptions { - cancelClickAction?: any; - /** A handler for the cancelClick event. */ - onCancelClick?: any; - /** The text displayed in the button that closes the action sheet. */ - cancelText?: string; - /** Specifies whether or not to display the Cancel button in action sheet. */ - showCancelButton?: boolean; - /** A Boolean value specifying whether or not the title of the action sheet is visible. */ - showTitle?: boolean; - /** Specifies the element the action sheet popover points at. */ - target?: any; - /** The title of the action sheet. */ - title?: string; - /** Specifies whether or not to show the action sheet within a dxPopover widget. */ - usePopover?: boolean; - /** A Boolean value specifying whether or not the dxActionSheet widget is visible. */ - visible?: boolean; - } - /** A widget consisting of a set of choices related to a certain task. */ - export class dxActionSheet extends CollectionWidget { - constructor(element: JQuery, options?: dxActionSheetOptions); - constructor(element: Element, options?: dxActionSheetOptions); - /** Hides the widget. */ - hide(): JQueryPromise; - /** Shows the widget. */ - show(): JQueryPromise; - /** Shows or hides the widget depending on the Boolean value passed as the parameter. */ - toggle(showing: boolean): JQueryPromise; - } - export interface dxSchedulerOptions extends WidgetOptions { - /** Specifies a date displayed on the current scheduler view by default. */ - currentDate?: Date; - /** Specifies the view used in the scheduler by default. */ - currentView?: string; - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** Specifies the first day of a week. */ - firstDayOfWeek?: number; - /** The template to be used for rendering appointments. */ - appointmentTemplate?: any; - /** Lists the views to be available within the scheduler's View Selector. */ - views?: Array; - /** Specifies the resource kinds by which the scheduler's appointments are grouped in a timetable. */ - groups?: Array; - /** Specifies a start hour in the scheduler view's time interval. */ - startDayHour?: number; - /** Specifies an end hour in the scheduler view's time interval. */ - endDayHour?: number; - /** Specifies an array of resources available in the scheduler. */ - resources?: Array<{ - /** Indicates whether or not several resources of this kind can be assigned to an appointment. */ - allowMultiple?: boolean; - /** Indicates whether or not resources of this kind have priority in the color identification of the appointments that have resources of different kinds assigned. */ - mainColor?: boolean; - /** A data source used to fetch resources to be available in the scheduler. */ - dataSource?: any; - /** Specifies the resource object field whose value is displayed by the Resource editor in the Appointment popup window. */ - displayExpr?: any; - /** Specifies the resource object field that is used as a value of the Resource editor in the Appointment popup window. */ - valueExpr?: any; - /** The name of the appointment object field that specifies a resource of this kind. */ - field?: string; - /** Specifies the label of the Appointment popup window field that allows end users to assign a resource of this kind. */ - label?: string; - }>; - /** A handler for the AppoinmentAdding event. */ - onAppointmentAdding?: Function; - /** A handler for the appointmentAdded event. */ - onAppointmentAdded?: Function; - /** A handler for the AppoinmentUpdating event. */ - onAppointmentUpdating?: Function; - /** A handler for the appointmentUpdated event. */ - onAppointmentUpdated?: Function; - /** A handler for the AppoinmentDeleting event. */ - onAppointmentDeleting?: Function; - /** A handler for the appointmentDeleted event. */ - onAppointmentDeleted?: Function; - /** A handler for the appointmentRendered event. */ - onAppointmentRendered?: Function; - } - /** A widget that displays scheduled data using different views and provides the capability to load, add and edit appointments. */ - export class dxScheduler extends Widget { - constructor(element: JQuery, options?: dxSchedulerOptions); - constructor(element: Element, options?: dxSchedulerOptions); - /** Add the appointment defined by the object passed as a parameter to the data associated with the widget. */ - addAppointment(appointment: Object): void; - /** Updates the appointment specified by the first method parameter by the appointment object specified by the second method parameter in the the data associated with the widget. */ - updateAppointment(target: Object, appointment: Object): void; - /** Deletes the appointment defined by the parameter from the the data associated with the widget. */ - deleteAppointment(appointment: Object): void; - } - export interface dxColorBoxOptions extends dxDropDownEditorOptions { - /** Specifies the text displayed on the button that applies changes and closes the drop-down editor. */ - applyButtonText?: string; - applyValueMode?: string; - /** Specifies the text displayed on the button that cancels changes and closes the drop-down editor. */ - cancelButtonText?: string; - /** Specifies whether or not the widget value includes the alpha channel component. */ - editAlphaChannel?: boolean; - /** Specifies the size of a step by which a handle is moved using a keyboard shortcut. */ - keyStep?: number; - } - /** A widget used to specify a color value. */ - export class dxColorBox extends dxDropDownEditor { - constructor(element: JQuery, options?: dxColorBoxOptions); - constructor(element: Element, options?: dxColorBoxOptions); - } - export interface dxColorPickerOptions extends dxColorBoxOptions { } - /** - * A widget used to specify a color value. - * @deprecated Use the dxColorBox widget instead - */ - export class dxColorPicker extends dxColorBox { - constructor(element: JQuery, options?: dxColorPickerOptions); - constructor(element: Element, options?: dxColorPickerOptions); - } - export interface dxTreeViewOptions extends CollectionWidgetOptions { - /** Specifies whether or not to animate item collapsing and expanding. */ - animationEnabled?: boolean; - /** Specifies whether a nested or plain array is used as a data source. */ - dataStructure?: string; - /** Specifies whether or not a user can expand all tree view items by the "*" hot key. */ - expandAllEnabled?: boolean; - /** - * An array of currently expanded item objects. - * @deprecated Use item.expanded field instead - */ - expandedItems?: Array; - /** Specifies whether or not a check box is displayed at each tree view item. */ - showCheckBoxes?: boolean; - /** Specifies whether or not to select nodes recursively. */ - selectNodesRecursive?: boolean; - /** Specifies whether the "Select All" check box is displayed over the tree view. */ - selectAllEnabled?: boolean; - /** Specifies the text displayed at the "Select All" check box. */ - selectAllText?: string; - /** Specifies the name of the data source item field used as a key. */ - keyExpr?: any; - /** Specifies the name of the data source item field whose value is displayed by the widget. */ - displayExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding node is selected. */ - selectedExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding node is expanded. */ - expandedExpr?: any; - /** Specifies the name of the data source item field that contains an array of nested items. */ - itemsExpr?: any; - /** Specifies the name of the data source item field that holds the key of the parent item. */ - parentIdExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding node is disabled. */ - disabledExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding node includes child nodes. */ - hasItemsExpr?: any; - /** Specifies if the virtual mode is enabled. */ - virtualModeEnabled?: boolean; - /** Specifies the parent ID value of the root item. */ - rootValue?: any; - /** A string value specifying available scrolling directions. */ - scrollDirection?: string; - /** A handler for the itemSelected event. */ - onItemSelected?: Function; - /** A handler for the itemExpanded event. */ - onItemExpanded?: Function; - /** A handler for the itemCollapsed event. */ - onItemCollapsed?: Function; - } - /** A widget displaying specified data items as a tree. */ - export class dxTreeView extends CollectionWidget { - constructor(element: JQuery, options?: dxTreeViewOptions); - constructor(element: Element, options?: dxTreeViewOptions); - /** Updates the tree view scrollbars according to the current size of the widget content. */ - updateDimensions(): JQueryPromise; - /** Selects the specified item. */ - selectItem(itemElement: any): void; - /** Unselects the specified item. */ - unselectItem(itemElement: any): void; - /** Expands the specified item. */ - expandItem(itemElement: any): void; - /** Collapses the specified item. */ - collapseItem(itemElement: any): void; - /** Returns all nodes of the tree view. */ - getNodes(): Array; - /** Selects all widget items. */ - selectAll(): void; - /** Unselects all widget items. */ - unselectAll(): void; - } - export interface dxMenuBaseOptions extends CollectionWidgetOptions { - /** An object that defines the animation options of the widget. */ - animation?: fx.AnimationOptions; - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** Specifies the name of the CSS class associated with the menu. */ - cssClass?: string; - /** Holds an array of menu items. */ - items?: Array; - /** Specifies whether or not an item becomes selected if an end-user clicks it. */ - selectionByClick?: boolean; - /** Specifies the selection mode supported by the menu. */ - selectionMode?: string; - /** Specifies options of submenu showing and hiding. */ - showSubmenuMode?: { - /** Specifies the mode name. */ - name?: string; - /** Specifies the delay of submenu show and hiding. */ - delay?: { - /** The time span after which the submenu is shown. */ - show?: number; - /** The time span after which the submenu is hidden. */ - hide?: number; - }; - }; - /** A Boolean value specifying whether or not the widget changes its state when being hovered by an end user. */ - hoverStateEnabled?: boolean; - } - export class dxMenuBase extends CollectionWidget { - constructor(element: JQuery, options?: dxMenuBaseOptions); - constructor(element: Element, options?: dxMenuBaseOptions); - /** Selects the specified item. */ - selectItem(itemElement: any): void; - /** Unselects the specified item. */ - unselectItem(itemElement: any): void; - } - export interface dxMenuOptions extends dxMenuBaseOptions { - /** Specifies whether or not the submenu is hidden when the mouse pointer leaves it. */ - hideSubmenuOnMouseLeave?: boolean; - /** Specifies whether the menu has horizontal or vertical orientation. */ - orientation?: string; - /** Specifies options for showing and hiding the first level submenu. */ - showFirstSubmenuMode?: { - /** Specifies the mode name. */ - name?: string; - /** Specifies the delay of submenu showing and hiding. */ - delay?: { - /** The time span after which the submenu is shown. */ - show?: number; - /** The time span after which the submenu is hidden. */ - hide?: number; - }; - }; - /** Specifies the direction at which the submenus are displayed. */ - submenuDirection?: string; - /** A handler for the submenuHidden event. */ - onSubmenuHidden?: Function; - submenuHiddenAction?: Function; - /** A handler for the submenuHiding event. */ - onSubmenuHiding?: Function; - submenuHidingAction?: Function; - /** A handler for the submenuShowing event. */ - onSubmenuShowing?: Function; - submenuShowingAction?: Function; - /** A handler for the submenuShown event. */ - onSubmenuShown?: Function; - submenuShownAction?: Function; - } - /** A menu widget. */ - export class dxMenu extends dxMenuBase { - constructor(element: JQuery, options?: dxMenuOptions); - constructor(element: Element, options?: dxMenuOptions); - } - export interface dxContextMenuOptions extends dxMenuBaseOptions { - /** Holds an object that specifies options of alternative menu invocation. */ - alternativeInvocationMode?: { - /** Specifies whether or not the standard context menu invocation (on a right mouse click or on a long tap) is disabled. */ - enabled?: Boolean; - /** Specifies the element used to invoke the context menu. */ - invokingElement?: any; - }; - /** A handler for the hidden event. */ - onHidden?: Function; - /** A handler for the hiding event. */ - onHiding?: Function; - /** A handler for the positioning event. */ - onPositioning?: Function; - /** A handler for the showing event. */ - onShowing?: Function; - /** A handler for the shown event. */ - onShown?: Function; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** Specifies the direction at which submenus are displayed. */ - submenuDirection?: string; - /** The target element associated with a popover. */ - target?: any; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - } - /** A context menu widget. */ - export class dxContextMenu extends dxMenuBase { - constructor(element: JQuery, options?: dxContextMenuOptions); - constructor(element: Element, options?: dxContextMenuOptions); - /** Toggles the visibility of the widget. */ - toggle(showing: boolean): JQueryPromise; - /** Shows the widget. */ - show(): JQueryPromise; - /** Hides the widget. */ - hide(): JQueryPromise; - } - export interface dxRemoteOperations { - /** Specifies whether or not filtering must be performed on the server side. */ - filtering?: boolean; - /** Specifies whether or not paging must be performed on the server side. */ - paging?: boolean; - /** Specifies whether or not sorting must be performed on the server side. */ - sorting?: boolean; - } - export interface dxDataGridColumn { - /** Specifies the content alignment within column cells. */ - alignment?: string; - /** Specifies whether the values in a column can be edited at runtime. Setting this option makes sense only when editing is enabled for a grid. */ - allowEditing?: boolean; - /** Specifies whether or not a column can be used for filtering grid records. Setting this option makes sense only when the filter row and column header filtering are visible. */ - allowFiltering?: boolean; - /** Specifies whether or not the column can be anchored to a grid edge by end users. Setting this option makes sense only when the columnFixing | enabled option is set to true. */ - allowFixing?: boolean; - /** Specifies if a column can be used for searching grid records. Setting this option makes sense only when the search panel is visible. */ - allowSearch?: boolean; - /** Specifies whether a column can be used for grouping grid records at runtime. Setting this option makes sense only when the group panel is visible. */ - allowGrouping?: boolean; - /** Specifies whether or not a column can be hidden by a user. Setting this option makes sense only when the column chooser is visible. */ - allowHiding?: boolean; - /** Specifies whether or not a particular column can be used in column reordering. Setting this option makes sense only when the allowColumnReordering option is set to true. */ - allowReordering?: boolean; - /** Specifies whether or not a particular column can be resized by a user. Setting this option makes sense only when the allowColumnResizing option is true. */ - allowResizing?: boolean; - /** Specifies whether grid records can be sorted by a specific column at runtime. Setting this option makes sense only when the sorting mode differs from none. */ - allowSorting?: boolean; - /** Specifies whether groups appear expanded or not when records are grouped by a specific column. Setting this option makes sense only when grouping is allowed for this column. */ - autoExpandGroup?: boolean; - /** Specifies a callback function that returns a value to be displayed in a column cell. */ - calculateCellValue?: (rowData: Object) => string; - /** Specifies a callback function that defines filters for customary calculated grid cells. */ - calculateFilterExpression?: (filterValue: any, selectedFilterOperation: string) => Array; - /** Specifies a caption for a column. */ - caption?: string; - /** Specifies a custom template for grid column cells. */ - cellTemplate?: any; - /** Specifies a CSS class to be applied to a column. */ - cssClass?: string; - /** Specifies a callback function that determines values for column cells to be used for grouping. */ - calculateGroupValue?: any; - /** Specifies a callback function that returns a value or the name of the field to be used for sorting column cells. */ - calculateSortValue?: any; - /** Specifies a callback function that returns the text to be displayed in the cells of a column. */ - customizeText?: (cellInfo: { value: any; valueText: string }) => string; - /** Specifies the field of a data source that provides data for a column. */ - dataField?: string; - /** Specifies the required type of column values. */ - dataType?: string; - /** Specifies a custom template for the cell of a grid column when it is in an editing state. */ - editCellTemplate?: any; - /** Specifies whether HTML tags are displayed as plain text or applied to the values of the column. */ - encodeHtml?: boolean; - /** In a boolean column, replaces all false items with a specified text. */ - falseText?: string; - /** Specifies the set of available filter operations. */ - filterOperations?: Array; - /** Specifies a filter value for a column. */ - filterValue?: any; - /** Specifies initial filter values for the column's header filter. */ - filterValues?: Array; - /** Specifies whether to include or exclude the records with the values selected in the column's header filter. */ - filterType?: string; - /** Indicates whether the column takes part in horizontal grid scrolling or is anchored to a grid edge. */ - fixed?: boolean; - /** Specifies the grid edge to which the column is anchored. */ - fixedPosition?: string; - /** Specifies a format for the values displayed in a column. */ - format?: string; - /** Specifies a custom template for the group cell of a grid column. */ - groupCellTemplate?: any; - /** Specifies the index of a column when grid records are grouped by the values of this column. */ - groupIndex?: number; - /** Specifies a custom template for the header of a grid column. */ - headerCellTemplate?: any; - /** Specifies options of a lookup column. */ - lookup?: { - /** Specifies whether or not a user can nullify values of a lookup column. */ - allowClearing?: boolean; - /** -Specifies the data source providing data for a lookup column. - */ - dataSource?: any; - /** Specifies the expression defining the data source field whose values must be displayed. */ - displayExpr?: any; - /** Specifies the expression defining the data source field whose values must be replaced. */ - valueExpr?: string; - }; - /** Specifies a precision for formatted values displayed in a column. */ - precision?: number; - /** Specifies a filter operation applied to a column. */ - selectedFilterOperation?: string; - /** Specifies whether or not the column displays its values by using editors. */ - showEditorAlways?: boolean; - /** Specifies whether or not to display the column when grid records are grouped by it. */ - showWhenGrouped?: boolean; - /** Specifies the index of a column when grid records are sorted by the values of this column. */ - sortIndex?: number; - /** Specifies the initial sort order of column values. */ - sortOrder?: string; - /** In a boolean column, replaces all true items with a specified text. */ - trueText?: string; - /** Specifies whether a column is visible or not. */ - visible?: boolean; - /** Specifies the sequence number of the column in the grid. */ - visibleIndex?: number; - /** Specifies a column width in pixels or percentages. */ - width?: any; - /** Specifies an array of validation rules to be checked when updating column cell values. */ - validationRules?: Array; - /** Specifies whether or not to display the header of a hidden column in the column chooser. */ - showInColumnChooser?: boolean; - /** Specifies the identifier of the column. */ - name?: string; - } - export interface dxDataGridOptions extends WidgetOptions { - /** Specifies whether the outer borders of the grid are visible or not. */ - showBorders?: boolean; - /** Indicates whether to show the error row for the grid. */ - errorRowEnabled?: boolean; - /** A handler for the rowValidating event. */ - onRowValidating?: (e: Object) => void; - /** A handler for the contextMenuPreparing event. */ - onContextMenuPreparing?: (e: Object) => void; - initNewRow?: (e: { data: Object }) => void; - /** A handler for the initNewRow event. */ - onInitNewRow?: (e: { data: Object }) => void; - rowInserted?: (e: { data: Object; key: any }) => void; - /** A handler for the rowInserted event. */ - onRowInserted?: (e: { data: Object; key: any }) => void; - rowInserting?: (e: { data: Object; cancel: boolean }) => void; - /** A handler for the rowInserting event. */ - onRowInserting?: (e: { data: Object; cancel: boolean }) => void; - rowRemoved?: (e: { data: Object; key: any }) => void; - /** A handler for the rowRemoved event. */ - onRowRemoved?: (e: { data: Object; key: any }) => void; - rowRemoving?: (e: { data: Object; key: any; cancel: boolean }) => void; - /** A handler for the rowRemoving event. */ - onRowRemoving?: (e: { data: Object; key: any; cancel: boolean }) => void; - rowUpdated?: (e: { data: Object; key: any }) => void; - /** A handler for the rowUpdated event. */ - onRowUpdated?: (e: { data: Object; key: any }) => void; - rowUpdating?: (e: { oldData: Object; newData: Object; key: any; cancel: boolean }) => void; - /** A handler for the rowUpdating event. */ - onRowUpdating?: (e: { oldData: Object; newData: Object; key: any; cancel: boolean }) => void; - /** Enables a hint that appears when a user hovers the mouse pointer over a cell with truncated content. */ - cellHintEnabled?: boolean; - /** Specifies whether or not grid columns can be reordered by a user. */ - allowColumnReordering?: boolean; - /** Specifies whether or not grid columns can be resized by a user. */ - allowColumnResizing?: boolean; - cellClick?: any; - /** A handler for the cellClick event. */ - onCellClick?: any; - cellHoverChanged?: (e: Object) => void; - /** A handler for the cellHoverChanged event. */ - onCellHoverChanged?: (e: Object) => void; - cellPrepared?: (e: Object) => void; - /** A handler for the cellPrepared event. */ - onCellPrepared?: (e: Object) => void; - /** Specifies whether or not the width of grid columns depends on column content. */ - columnAutoWidth?: boolean; - /** Specifies the options of a column chooser. */ - columnChooser?: { - /** Specifies text displayed by the column chooser panel when it does not contain any columns. */ - emptyPanelText?: string; - /** Specifies whether a user can invoke the column chooser or not. */ - enabled?: boolean; - /** Specifies the height of the column chooser panel. */ - height?: number; - /** Specifies text displayed in the title of the column chooser panel. */ - title?: string; - /** Specifies the width of the column chooser panel. */ - width?: number; - }; - /** Specifies options for column fixing. */ - columnFixing?: { - /** Indicates if column fixing is enabled. */ - enabled?: boolean; - /** Contains options that specify texts for column-fixing related commands in the column header's context menu. */ - texts?: { - /** Specifies text for a context menu item that fixes the column for which the context menu is invoked. */ - fix?: string; - /** Specifies text for a context menu item that unfixes the column for which the context menu is invoked. */ - unfix?: string; - /** Specifies text for a context menu subitem that fixes a column, for which the context menu is invoked, to the left grid edge. */ - leftPosition?: string; - /** Specifies text for a context menu subitem that fixes a column, for which the context menu is invoked, to the right grid edge. */ - rightPosition?: string; - }; - }; - /** Specifies options for filtering using a column header filter. */ - headerFilter?: { - /** Indicates whether or not the column header filter button is visible. */ - visible?: boolean; - /** Specifies the height of the dropdown menu invoked when using a column header filter. */ - height?: number; - /** Specifies the width of the dropdown menu invoked when using a column header filter. */ - width?: number; - /** Contains options that specify texts for the dropdown menu invoked when you use a column header filter. */ - texts?: { - /** Specifies text for the item specifying an empty value in the column header filter's dropdown menu. */ - emptyValue?: string; - /** Specifies text for a button that closes the column header filter's dropdown menu and applies specified filtering. */ - ok?: string; - /** Specifies text for a button that closes the column header filter's dropdown menu without applying performed selection. */ - cancel?: string; - } - }; - /** -An array of grid columns. - */ - columns?: Array; - onContentReady?: Function; - contentReadyAction?: Function; - /** Specifies a function that customizes grid columns after they are created. */ - customizeColumns?: (columns: Array) => void; - dataErrorOccurred?: (errorObject: Error) => void; - /** Specifies a data source for the grid. */ - dataSource?: any; - editingStart?: (e: { - data: Object; - key: any; - cancel: boolean; - column: dxDataGridColumn - }) => void; - /** A handler for the editingStart event. */ - onEditingStart?: (e: { - data: Object; - key: any; - cancel: boolean; - column: dxDataGridColumn - }) => void; - editorPrepared?: (e: Object) => void; - /** A handler for the editorPrepared event. */ - onEditorPrepared?: (e: Object) => void; - editorPreparing?: (e: Object) => void; - /** A handler for the editorPreparing event. */ - onEditorPreparing?: (e: Object) => void; - /** Contains options that specify how grid content can be changed. */ - editing?: { - /** Specifies whether or not grid records can be edited at runtime. */ - editEnabled?: boolean; - /** Specifies how grid values can be edited manually. */ - editMode?: string; - /** Specifies whether or not new records can be inserted into a grid. */ - insertEnabled?: boolean; - /** Specifies whether or not records can be deleted from a grid. */ - removeEnabled?: boolean; - /** Contains options that specify texts for editing-related grid controls. */ - texts?: { - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Save" button. Setting this option makes sense only when the editMode option is set to batch. */ - saveAllChanges?: string; - /** Specifies text for a cancel button displayed when a row is in the editing state. Setting this option makes sense only when the editEnabled option is set to true. */ - cancelRowChanges?: string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Revert" button. Setting this option makes sense only when the editMode option is set to batch. */ - cancelAllChanges?: string; - /** Specifies a message to be displayed by a confirmation window. Setting this option makes sense only when the edit mode is "row". */ - confirmDeleteMessage?: string; - /** Specifies text to be displayed in the title of a confirmation window. Setting this option makes sense only when the edit mode is "row". */ - confirmDeleteTitle?: string; - /** Specifies text for a button that deletes a row from a grid. Setting this option makes sense only when the removeEnabled option is set to true. */ - deleteRow?: string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Add" button. Setting this option makes sense only when the insertEnabled option is true. */ - addRow?: string; - /** Specifies text for a button that turns a row into the editing state. Setting this option makes sense only when the editEnabled option is set to true. */ - editRow?: string; - /** Specifies text for a save button displayed when a row is in the editing state. Setting this option makes sense only when the editEnabled option is set to true. */ - saveRowChanges?: string; - /** Specifies text for a button that recovers a deleted row. Setting this option makes sense only if the grid uses the batch edit mode and the removeEnabled option is set to true. */ - undeleteRow?: string; - }; - }; - /** Specifies filter row options. */ - filterRow?: { - /** Specifies when to apply a filter. */ - applyFilter?: string; - /** Specifies text for the hint that pops up when a user hovers the mouse pointer over the "Apply Filter" button. */ - applyFilterText?: string; - /** Specifies descriptions for filter operations. */ - operationDescriptions?: { - "=": string; - "<>": string; - "<": string; - "<=": string; - ">": string; - ">=": string; - "startswith": string; - "contains": string; - "notcontains": string; - "endswith": string; - }; - /** Specifies text for the reset operation in a filter list. */ - resetOperationText?: string; - /** Specifies text for the operation of clearing the applied filter when a select box is used. */ - showAllText?: string; - /** Specifies whether or not an icon that allows the user to choose a filter operation is visible. */ - showOperationChooser?: boolean; - /** Specifies whether the filter row is visible or not. */ - visible?: boolean; - }; - /** Specifies the behavior of grouped grid records. */ - grouping?: { - /** Specifies whether the user can collapse grouped records in a grid or not. */ - allowCollapsing?: boolean; - /** Specifies whether groups appear expanded or not. */ - autoExpandAll?: boolean; - /** Specifies the message displayed in a group row when the corresponding group is continued from the previous page. */ - groupContinuedMessage?: string; - /** -Specifies the message displayed in a group row when the corresponding group continues on the next page. - */ - groupContinuesMessage?: string; - }; - /** Specifies options that configure the group panel. */ - groupPanel?: { - /** Specifies whether columns can be dragged onto or from the group panel. */ - allowColumnDragging?: boolean; - /** Specifies text displayed by the group panel when it does not contain any columns. */ - emptyPanelText?: string; - /** Specifies whether the group panel is visible or not. */ - visible?: boolean; - }; - /** Specifies options configuring the load panel. */ - loadPanel?: { - /** Specifies whether to show the load panel or not. */ - enabled?: boolean; - /** Specifies the height of the load panel in pixels. */ - height?: number; - /** Specifies a URL pointing to an image to be used as a loading indicator. */ - indicatorSrc?: string; - /** Specifies whether or not a loading indicator must be displayed on the load panel. */ - showIndicator?: boolean; - /** Specifies whether or not the pane of the load panel must be displayed. */ - showPane?: boolean; - /** Specifies text displayed by the load panel. */ - text?: string; - /** Specifies the width of the load panel in pixels. */ - width?: number; - }; - /** Specifies text displayed when a grid does not contain any records. */ - noDataText?: string; - /** Specifies the options of a grid pager. */ - pager?: { - /** Specifies the page sizes that can be selected at runtime. */ - allowedPageSizes?: any; - /** Specifies whether to show the page size selector or not. */ - showPageSizeSelector?: boolean; - /** Specifies whether to show the pager or not. */ - visible?: any; - /** Specifies the text accompanying the page navigator. */ - infoText?: string; - /** Specifies whether or not to display the text accompanying the page navigator. This text is specified by the infoText option. */ - showInfo?: boolean; - /** Specifies whether or not to display buttons that switch the grid to the previous or next page. */ - showNavigationButtons?: boolean; - }; - /** Specifies paging options. */ - paging?: { - /** Specifies whether dxDataGrid loads data page by page or all at once. */ - enabled?: boolean; - /** Specifies the grid page that should be displayed by default. */ - pageIndex?: number; - /** Specifies the size of grid pages. */ - pageSize?: number; - }; - /** Specifies whether or not grid rows must be shaded in a different way. */ - rowAlternationEnabled?: boolean; - rowClick?: any; - /** A handler for the rowClick event. */ - onRowClick?: any; - rowPrepared?: (e: Object) => void; - /** A handler for the rowPrepared event. */ - onRowPrepared?: (e: Object) => void; - /** Specifies a custom template for grid rows. */ - rowTemplate?: any; - /** A configuration object specifying scrolling options. */ - scrolling?: { - /** Specifies the scrolling mode. */ - mode?: string; - /** Specifies whether or not a grid must preload pages adjacent to the current page when using virtual scrolling. */ - preloadEnabled?: boolean; - }; - /** Specifies options of the search panel. */ - searchPanel?: { - /** Specifies whether or not search strings in the located grid records should be highlighted. */ - highlightSearchText?: boolean; - /** Specifies text displayed by the search panel when no search string was typed. */ - placeholder?: string; - /** Specifies whether the search panel is visible or not. */ - visible?: boolean; - /** Specifies the width of the search panel in pixels. */ - width?: number; - /** Sets a search string for the search panel. */ - text?: string; - }; - /** Specifies the operations that must be performed on the server side. */ - remoteOperations?: any; - /** Allows you to sort groups according to the values of group summary items. */ - sortByGroupSummaryInfo?: Array<{ - /** Specifies the group summary item whose values must be used to sort groups. */ - summaryItem?: string; - /** Specifies the identifier of the column that must be used in grouping so that sorting by group summary item values be applied. */ - groupColumn?: string; - /** Specifies the sort order of group summary item values. */ - sortOrder?: string; - }>; - /** Allows you to build a master-detail interface in the grid. */ - masterDetail?: { - /** Enables an end-user to expand/collapse detail sections. */ - enabled?: boolean; - /** Specifies whether detail sections appear expanded or collapsed. */ - autoExpandAll?: boolean; - /** Specifies the template for detail sections. */ - template?: any; - }; - /** Specifies options for exporting grid data. */ - export?: { - /** Indicates if the export feature is enabled in the grid. */ - enabled?: boolean; - /** Specifies a default name for the file to which grid data is exported. */ - fileName?: string; - /** Specifies whether to enable Excel filtering for the exported data in the resulting XLSX file. */ - excelFilterEnabled?: boolean; - /** Specifies whether to enable word wrapping for the exported data in the resulting XLSX file. */ - excelWrapTextEnabled?: boolean; - /** Specifies the URL of the server-side proxy that streams the resulting file to the end user to enable export in IE8, IE9 and Safari browsers. */ - proxyUrl?: string; - /** Indicates whether to allow end users to export not only the data displayed in the grid, but the selected rows only. */ - allowExportSelectedData?: boolean; - /** Contains options that specify texts for the export-related commands and hints. */ - texts?: { - /** Specifies text for the Export button when this button invokes a dropdown menu so you can choose the required export format. */ - exportTo?: string; - /** Specifies text for the Export button when this button exports to the XSLX format. */ - exportToExcel?: string; - /** Specifies text for the item in the Export dropdown menu that exports grid data to Excel. */ - excelFormat?: string; - /** Specifies text for the option in the Export dropdown menu that allows you to choose whether to export all the grid data or the selected rows only. */ - selectedRows?: string; - } - }; - /** Specifies the keys of the records that must appear selected initially. */ - selectedRowKeys?: Array; - /** Specifies options of runtime selection. */ - selection?: { - /** Specifies whether the user can select all grid records at once. */ - allowSelectAll?: boolean; - /** Specifies the selection mode. */ - mode?: string; - }; - selectionChanged?: (e: { - currentSelectedRowKeys: Array; - currentDeselectedRowKeys: Array; - selectedRowKeys: Array; - selectedRowsData: Array; - }) => void; - /** A handler for the dataErrorOccured event. */ - onDataErrorOccurred?: (e: { error: Error }) => void; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: (e: { - currentSelectedRowKeys: Array; - currentDeselectedRowKeys: Array; - selectedRowKeys: Array; - selectedRowsData: Array; - }) => void; - /** A handler for the exporting event. */ - onExporting?: (e: { - fileName: string; - format: string; - cancel: boolean; - }) => void; - /** A handler for the exported event. */ - onExported?: (e: Object) => void; - /** A handler for the rowExpanding event. */ - onRowExpanding?: (e: Object) => void; - /** A handler for the rowExpanded event. */ - onRowExpanded?: (e: Object) => void; - /** A handler for the rowCollapsing event. */ - onRowCollapsing?: (e: Object) => void; - /** A handler for the rowCollapsed event. */ - onRowCollapsed?: (e: Object) => void; - /** Specifies whether column headers are visible or not. */ - showColumnHeaders?: boolean; - /** Specifies whether or not vertical lines separating one grid column from another are visible. */ - showColumnLines?: boolean; - /** Specifies whether or not horizontal lines separating one grid row from another are visible. */ - showRowLines?: boolean; - /** Specifies options of runtime sorting. */ - sorting?: { - /** Specifies text for the context menu item that sets an ascending sort order in a column. */ - ascendingText?: string; - /** Specifies text for the context menu item that resets sorting settings for a column. */ - clearText?: string; - /** Specifies text for the context menu item that sets a descending sort order in a column. */ - descendingText?: string; - /** Specifies the runtime sorting mode. */ - mode?: string; - }; - /** Specifies options of state storing. */ - stateStoring?: { - /** Specifies a callback function that performs specific actions on state loading. */ - customLoad?: () => JQueryPromise; - /** Specifies a callback function that performs specific actions on state saving. */ - customSave?: (gridState: Object) => void; - /** Specifies whether or not a grid saves its state. */ - enabled?: boolean; - /** Specifies the delay between the last change of a grid state and the operation of saving this state in milliseconds. */ - savingTimeout?: number; - /** Specifies a unique key to be used for storing the grid state. */ - storageKey?: string; - /** Specifies the type of storage to be used for state storing. */ - type?: string; - }; - /** Specifies the options of the grid summary. */ - summary?: { - /** Contains options that specify text patterns for summary items. */ - texts?: { - /** Specifies a pattern for the 'sum' summary items when they are displayed in the parent column. */ - sum?: string; - /** Specifies a pattern for the 'sum' summary items displayed in a group row or in any other column rather than the parent one. */ - sumOtherColumn?: string; - /** Specifies a pattern for the 'min' summary items when they are displayed in the parent column. */ - min?: string; - /** Specifies a pattern for the 'min' summary items displayed in a group row or in any other column rather than the parent one. */ - minOtherColumn?: string; - /** Specifies a pattern for the 'max' summary items when they are displayed in the parent column. */ - max?: string; - /** Specifies a pattern for the 'max' summary items displayed in a group row or in any other column rather than the parent one. */ - maxOtherColumn?: string; - /** Specifies a pattern for the 'avg' summary items when they are displayed in the parent column. */ - avg?: string; - /** Specifies a pattern for the 'avg' summary items displayed in a group row or in any other column rather than the parent one. */ - avgOtherColumn?: string; - /** Specifies a pattern for the 'count' summary items. */ - count?: string; - }; - /** Specifies items of the group summary. */ - groupItems?: Array<{ - /** Specifies the identifier of a summary item. */ - name?: string; - /** Specifies the column that provides data for a group summary item. */ - column?: string; - /** Customizes the text to be displayed in the summary item. */ - customizeText?: (itemInfo: { - value: any; - valueText: string; - }) => string; - /** Specifies a pattern for the summary item text. */ - displayFormat?: string; - /** Specifies a precision for the summary item value of a numeric format. */ - precision?: number; - /** Specifies whether or not a summary item must be displayed in the group footer. */ - showInGroupFooter?: boolean; - /** Indicates whether to display group summary items in brackets of the group row header or to align them by the corresponding columns within the group row. */ - alignByColumn?: boolean; - /** Specifies the column that must hold the summary item when this item is displayed in the group footer or aligned by a column in the group row. */ - showInColumn?: string; - /** Specifies how to aggregate data for a summary item. */ - summaryType?: string; - /** Specifies a format for the summary item value. */ - valueFormat?: string; - }>; - /** Specifies items of the total summary. */ - totalItems?: Array<{ - /** Specifies the identifier of a summary item. */ - name?: string; - /** Specifies the alignment of a summary item. */ - alignment?: string; - /** Specifies the column that provides data for a summary item. */ - column?: string; - /** Specifies a CSS class to be applied to a summary item. */ - cssClass?: string; - /** Customizes the text to be displayed in the summary item. */ - customizeText?: (itemInfo: { - value: any; - valueText: string; - }) => string; - /** Specifies a pattern for the summary item text. */ - displayFormat?: string; - /** Specifies a precision for the summary item value of a numeric format. */ - precision?: number; - /** Specifies the column that must hold the summary item. */ - showInColumn?: string; - /** Specifies how to aggregate data for a summary item. */ - summaryType?: string; - /** Specifies a format for the summary item value. */ - valueFormat?: string; - }>; - /** Allows you to use a custom aggregate function to calculate the value of a summary item. */ - calculateCustomSummary?: (options: { - component: dxDataGrid; - name?: string; - value: any; - totalValue: any; - summaryProcess: string - }) => void; - }; - /** Specifies whether text that does not fit into a column should be wrapped. */ - wordWrapEnabled?: boolean; - } - /** A data grid widget. */ - export class dxDataGrid extends Widget { - constructor(element: JQuery, options?: dxDataGridOptions); - constructor(element: Element, options?: dxDataGridOptions); - /** Ungroups grid records. */ - clearGrouping(): void; - /** Clears sorting settings of all grid columns at once. */ - clearSorting(): void; - /** Allows you to obtain a cell by its row index and the data field of its column. */ - getCellElement(rowIndex: number, dataField: string): any; - /** Allows you to obtain a cell by its row index and the visible index of its column. */ - getCellElement(rowIndex: number, visibleColumnIndex: number): any; - /** Returns the current state of the grid. */ - state(): Object; - /** Sets the grid state. */ - state(state: Object): void; - /** Allows you to obtain the row index by a data key. */ - getRowIndexByKey(key: any): number; - /** Allows you to obtain the data key by a row index. */ - getKeyByRowIndex(rowIndex: number): any; - /** Adds a new column to a grid. */ - addColumn(columnOptions: dxDataGridColumn): void; - /** Displays the load panel. */ - beginCustomLoading(messageText: string): void; - /** Discards changes made in a grid. */ - cancelEditData(): void; - /** Clears all the filters applied to grid records. */ - clearFilter(): void; - /** Deselects all grid records. */ - clearSelection(): void; - /** Draws the cell being edited from the editing state. Use this method when the edit mode is batch. */ - closeEditCell(): void; - /** Collapses groups or master rows in a grid. */ - collapseAll(groupIndex?: number): void; - /** Returns the number of data columns in a grid. */ - columnCount(): number; - /** Returns the value of a specific column option. */ - columnOption(id: number, optionName: string): any; - /** Sets an option of a specific column. */ - columnOption(id: number, optionName: string, optionValue: any): void; - /** Returns the options of a column by an identifier. */ - columnOption(id: any): Object; - /** Sets several options of a column at once. */ - columnOption(id: any, options: Object): void; - /** Sets a specific cell into the editing state. */ - editCell(rowIndex: number, columnIndex: number): void; - /** Sets a specific row into the editing state. */ - editRow(rowIndex: number): void; - /** Hides the load panel. */ - endCustomLoading(): void; - /** Expands groups or master rows in a grid. */ - expandAll(groupIndex: number): void; - /** Allows you to find out whether a specific group or master row is expanded or collapsed. */ - isRowExpanded(key: any): boolean; - /** Allows you to expand a specific group or master row by its key. */ - expandRow(key: any): void; - /** Allows you to collapse a specific group or master row by its key. */ - collapseRow(key: any): void; - /** Applies a filter to the grid's data source. */ - filter(filterExpr?: any): void; - /** Returns a filter expression applied to the grid's data source using the filter(filterExpr) method. */ - filter(): any; - /** Returns a filter expression applied to the grid using all possible scenarious. */ - getCombinedFilter(): any; - /** Gets the keys of currently selected grid records. */ - getSelectedRowKeys(): Array; - /** Gets the data objects of currently selected grid records. */ - getSelectedRowsData(): Array; - /** Hides the column chooser panel. */ - hideColumnChooser(): void; - /** Adds a new data row to a grid. */ - insertRow(): void; - /** Returns the key corresponding to the passed data object. */ - keyOf(obj: Object): any; - /** Switches a grid to a specified page. */ - pageIndex(newIndex: number): void; - /** Gets the index of the current page. */ - pageIndex(): number; - /** Sets the page size. */ - pageSize(value: number): void; - /** Gets the current page size. */ - pageSize(): number; - /** Refreshes grid data. */ - refresh(): void; - /** Removes a specific row from a grid. */ - removeRow(rowIndex: number): void; - /** Saves changes made in a grid. */ - saveEditData(): void; - /** -Searches grid records by a search string. - */ - searchByText(text: string): void; - /** Selects all grid records. */ - selectAll(): void; - /** Deselects the rows that are currently selected within the applied filter. */ - deselectAll(): void; - /** Selects specific grid records. */ - selectRows(keys: Array, preserve: boolean): void; - /** Deselects specific grid records. */ - deselectRows(keys: Array): void; - /** Selects grid rows by indexes. */ - selectRowsByIndexes(indexes: Array): void; - /** Allows you to find out whether a row is selected or not. */ - isRowSelected(key: any): boolean; - /** Invokes the column chooser panel. */ - showColumnChooser(): void; - startSelectionWithCheckboxes(): boolean; - /** Returns the number of records currently held by a grid. */ - totalCount(): number; - /** Recovers a row deleted in the batch edit mode. */ - undeleteRow(rowIndex: number): void; - /** Allows you to obtain a data object by its key. */ - byKey(key: any): JQueryPromise; - /** Gets the value of a total summary item. */ - getTotalSummaryValue(summaryItemName: string): any; - /** Exports grid data to Excel. */ - exportToExcel(selectionOnly: boolean): void; - /** Updates the grid to the size of its content. */ - updateDimensions(): void; - /** Focuses the specified cell element in the grid. */ - focus(element?: JQuery): void; - } - export interface dxPivotGridOptions extends WidgetOptions { - /** Specifies a data source for the pivot grid. */ - dataSource?: any; - useNativeScrolling?: any; - /** Allows an end-user to change sorting options. */ - allowSorting?: boolean; - /** Allows an end-user to sort columns by summary values. */ - allowSortingBySummary?: boolean; - /** Allows an end-user to change filtering options. */ - allowFiltering?: boolean; - /** Allows an end-user to expand/collapse all header items within a header level. */ - allowExpandAll?: boolean; - /** Specifies whether to display the Total rows. */ - showRowTotals?: boolean; - /** Specifies whether to display the Grand Total row. */ - showRowGrandTotals?: boolean; - /** Specifies whether to display the Total columns. */ - showColumnTotals?: boolean; - /** Specifies whether to display the Grand Total column. */ - showColumnGrandTotals?: boolean; - /** The Field Chooser configuration options. */ - fieldChooser?: { - /** Enables or disables the field chooser. */ - enabled?: boolean; - /** Specifies the field chooser layout. */ - layout?: number; - /** Specifies the text to display as a title of the field chooser popup window. */ - title?: string; - /** Specifies the field chooser width. */ - width?: number; - /** Specifies the field chooser height. */ - height?: number; - /** Strings that can be changed or localized in the pivot grid's integrated Field Chooser. */ - texts?: { - /** The string to display instead of Row Fields. */ - rowFields?: string; - /** The string to display instead of Column Fields. */ - columnFields?: string; - /** The string to display instead of Data Fields. */ - dataFields?: string; - /** The string to display instead of Filter Fields. */ - filterFields?: string; - /** The string to display instead of All Fields. */ - allFields?: string; - }; - } - /** Strings that can be changed or localized in the dxPivotGrid widget. */ - texts?: { - /** The string to display as a header of the Grand Total row and column. */ - grandTotal?: string; - /** The string to display as a header of the Total row and column. */ - total?: string; - /** Specifies the text displayed when a pivot grid does not contain any fields. */ - noData?: string; - /** The string to display as a Show Field Chooser context menu item. */ - showFieldChooser?: string; - /** The string to display as an Expand All context menu item. */ - expandAll?: string; - /** The string to display as a Collapse All context menu item. */ - collapseAll?: string; - /** The string to display as a Sort Column by Summary Value context menu item. */ - sortColumnBySummary?: string; - /** The string to display as a Sort Row by Summary Value context menu item. */ - sortRowBySummary?: string; - /** The string to display as a Remove All Sorting context menu item. */ - removeAllSorting?: string; - }; - /** The Load panel configuration options. */ - loadPanel?: { - /** Enables or disables the load panel. */ - enabled?: boolean; - /** Specifies the height of the load panel. */ - height?: number; - /** Specifies the URL pointing to an image that will be used as a load indicator. */ - indicatorSrc?: string; - /** Specifies whether or not to show a load indicator. */ - showIndicator?: boolean; - /** Specifies whether or not to show load panel background. */ - showPane?: boolean; - /** Specifies the text to display inside a load panel. */ - text?: string; - /** Specifies the width of the load panel. */ - width?: number; - }; - /** A handler for the cellClick event. */ - onCellClick?: (e: any) => void; - /** A handler for the cellPrepared event. */ - onCellPrepared?: (e: any) => void; - } - /** A data summarization widget for multi-dimensional data analysis and data mining. */ - export class dxPivotGrid extends Widget { - constructor(element: JQuery, options?: dxPivotGridOptions); - constructor(element: Element, options?: dxPivotGridOptions); - /** Gets the PivotGridDataSource instance. */ - getDataSource(): DevExpress.data.PivotGridDataSource; - /** Updates the widget to the size of its content. */ - updateDimensions(): void; - } - export interface dxPivotGridFieldChooserOptions extends WidgetOptions { - /** Specifies the field chooser layout. */ - layout?: number; - /** The data source of a dxPivotGrid widget. */ - dataSource?: DevExpress.data.PivotGridDataSource; - onContentReady?: Function; - /** Strings that can be changed or localized in the dxPivotGridFieldChooser widget. */ - texts?: { - /** The string to display instead of Row Fields. */ - rowFields?: string; - /** The string to display instead of Column Fields. */ - columnFields?: string; - /** The string to display instead of Data Fields. */ - dataFields?: string; - /** The string to display instead of Filter Fields. */ - filterFields?: string; - /** The string to display instead of All Fields. */ - allFields?: string; - }; - } - /** A complementary widget for dxPivotGrid that allows you to manage data displayed in the dxPivotGrid. */ - export class dxPivotGridFieldChooser extends Widget { - constructor(element: JQuery, options?: dxPivotGridFieldChooserOptions); - constructor(element: Element, options?: dxPivotGridFieldChooserOptions); - /** Updates the widget to the size of its content. */ - updateDimensions(): void; - } -} -declare namespace DevExpress.viz.charts { - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface BaseSeries { - /** Provides information about the state of the series object. */ - fullState: number; - /** Returns the type of the series. */ - type: string; - /** Unselects all the selected points of the series. The points are displayed in an initial style. */ - clearSelection(): void; - /** Gets the color of a particular series. */ - getColor(): string; - /** - * Gets a point from the series point collection based on the specified argument. - * @deprecated getPointsByArg(pointArg).md - */ - getPointByArg(pointArg: any): Object; - /** Gets points from the series point collection based on the specified argument. */ - getPointsByArg(pointArg: any): Array; - /** Gets a point from the series point collection based on the specified point position. */ - getPointByPos(positionIndex: number): Object; - /** Selects the series. The series is displayed in a 'selected' style until another series is selected or the current series is deselected programmatically. */ - select(): void; - /** Selects the specified point. The point is displayed in a 'selected' style. */ - selectPoint(point: BasePoint): void; - /** Deselects the specified point. The point is displayed in an initial style. */ - deselectPoint(point: BasePoint): void; - /** Returns an array of all points in the series. */ - getAllPoints(): Array; - /** Returns visible series points. */ - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface BasePoint { - /** Provides information about the state of the point object. */ - fullState: number; - /** Returns the point's argument value that was set in the data source. */ - originalArgument: any; - /** Returns the point's value that was set in the data source. */ - originalValue: any; - /** Returns the tag of the point. */ - tag: string; - /** Deselects the point. */ - clearSelection(): void; - /** Gets the color of a particular point. */ - getColor(): string; - /** Hides the tooltip of the point. */ - hideTooltip(): void; - /** Provides information about the hover state of a point. */ - isHovered(): any; - /** Provides information about the selection state of a point. */ - isSelected(): any; - /** Selects the point. The point is displayed in a 'selected' style until another point is selected or the current point is deselected programmatically. */ - select(): void; - /** Shows the tooltip of the point. */ - showTooltip(): void; - /** Allows you to obtain the label of a series point. */ - getLabel(): any; - /** Returns the series object to which the point belongs. */ - series: BaseSeries; - } - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface ChartSeries extends BaseSeries { - /** Returns the name of the series pane. */ - pane: string; - /** Returns the name of the value axis of the series. */ - axis: string; - /** Returns the name of the series. */ - name: string; - /** Returns the tag of the series. */ - tag: string; - /** Hides a series. */ - hide(): void; - /** Provides information about the hover state of a series. */ - isHovered(): any; - /** Provides information about the selection state of a series. */ - isSelected(): any; - /** Provides information about the visibility state of a series. */ - isVisible(): boolean; - /** Makes a particular series visible. */ - show(): void; - selectPoint(point: ChartPoint): void; - deselectPoint(point: ChartPoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface ChartPoint extends BasePoint { - /** Contains the close value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalCloseValue: any; - /** Contains the high value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalHighValue: any; - /** Contains the low value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalLowValue: any; - /** Contains the first value of the point. This field is useful for points belonging to a series of the range area or range bar type only. */ - originalMinValue: any; - /** Contains the open value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalOpenValue: any; - /** Contains the size of the bubble as it was set in the data source. This field is useful for points belonging to a series of the bubble type only. */ - size: any; - /** Gets the parameters of the point's minimum bounding rectangle (MBR). */ - getBoundingRect(): { x: number; y: number; width: number; height: number; }; - series: ChartSeries; - } - /** This section describes the methods that can be used in code to manipulate the Label object. */ - export interface Label { - /** Gets the parameters of the label's minimum bounding rectangle (MBR). */ - getBoundingRect(): { x: number; y: number; width: number; height: number; }; - /** Hides the point label. */ - hide(): void; - /** Shows the point label. */ - show(): void; - } - export interface PieSeries extends BaseSeries { - selectPoint(point: PiePoint): void; - deselectPoint(point: PiePoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface PiePoint extends BasePoint { - /** Gets the percentage value of the specific point. */ - percent: any; - /** Provides information about the visibility state of a point. */ - isVisible(): boolean; - /** Makes a specific point visible. */ - show(): void; - /** Hides a specific point. */ - hide(): void; - series: PieSeries; - } - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface PolarSeries extends BaseSeries { - /** Returns the name of the value axis of the series. */ - axis: string; - /** Returns the name of the series. */ - name: string; - /** Returns the tag of the series. */ - tag: string; - /** Hides a series. */ - hide(): void; - /** Provides information about the hover state of a series. */ - isHovered(): any; - /** Provides information about the selection state of a series. */ - isSelected(): any; - /** Provides information about the visibility state of a series. */ - isVisible(): boolean; - /** Makes a particular series visible. */ - show(): void; - selectPoint(point: PolarPoint): void; - deselectPoint(point: PolarPoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface PolarPoint extends BasePoint { - series: PolarSeries; - } - export interface Strip { - /** Specifies a color for a strip. */ - color?: string; - /** An object that defines the label configuration options of a strip. */ - label?: { - /** Specifies the text displayed in a strip. */ - text?: string; - }; - /** Specifies a start value for a strip. */ - startValue?: any; - /** Specifies an end value for a strip. */ - endValue?: any; - } - export interface BaseSeriesConfigLabel { - /** Specifies a format for arguments displayed by point labels. */ - argumentFormat?: string; - /** Specifies a precision for formatted point arguments displayed in point labels. */ - argumentPrecision?: number; - /** Specifies a background color for point labels. */ - backgroundColor?: string; - /** Specifies border options for point labels. */ - border?: viz.core.DashedBorder; - /** Specifies connector options for series point labels. */ - connector?: { - /** Specifies the color of label connectors. */ - color?: string; - /** Indicates whether or not label connectors are visible. */ - visible?: boolean; - /** Specifies the width of label connectors. */ - width?: number; - }; - /** Specifies a callback function that returns the text to be displayed by point labels. */ - customizeText?: (pointInfo: Object) => string; - /** Specifies font options for the text displayed in point labels. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed by point labels. */ - format?: string; - position?: string; - /** Specifies a precision for formatted point values displayed in point labels. */ - precision?: number; - /** Specifies the angle used to rotate point labels from their initial position. */ - rotationAngle?: number; - /** Specifies the visibility of point labels. */ - visible?: boolean; - } - export interface SeriesConfigLabel extends BaseSeriesConfigLabel { - /** Specifies whether or not to show a label when the point has a zero value. */ - showForZeroValues?: boolean; - } - export interface ChartSeriesConfigLabel extends SeriesConfigLabel { - /** Specifies how to align point labels relative to the corresponding data points that they represent. */ - alignment?: string; - /** Specifies how to shift point labels horizontally from their initial positions. */ - horizontalOffset?: number; - /** Specifies how to shift point labels vertically from their initial positions. */ - verticalOffset?: number; - /** Specifies a precision for the percentage values displayed in the labels of a full-stacked-like series. */ - percentPrecision?: number; - } - export interface BaseCommonSeriesConfig { - /** Specifies the data source field that provides arguments for series points. */ - argumentField?: string; - axis?: string; - /** An object defining the label configuration options for a series in the dxChart widget. */ - label?: ChartSeriesConfigLabel; - /** Specifies border options for point labels. */ - border?: viz.core.DashedBorder; - /** Specifies a series color. */ - color?: string; - /** Specifies the dash style of the series' line. */ - dashStyle?: string; - hoverMode?: string; - /** An object defining configuration options for a hovered series. */ - hoverStyle?: { - /** An object defining the border options for a hovered series. */ - border?: viz.core.DashedBorder; - /**

Sets a color for a series when it is hovered over.

*/ - color?: string; - /** Specifies the dash style for the line in a hovered series. */ - dashStyle?: string; - /** Specifies the hatching options to be applied when a series is hovered over. */ - hatching?: viz.core.Hatching; - /** Specifies the width of a line in a hovered series. */ - width?: number; - }; - /** Specifies whether a chart ignores null data points or not. */ - ignoreEmptyPoints?: boolean; - /** Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed. */ - maxLabelCount?: number; - /** Specifies the minimal length of a displayed bar in pixels. */ - minBarSize?: number; - /** Specifies opacity for a series. */ - opacity?: number; - /** Specifies the series elements to highlight when the series is selected. */ - selectionMode?: string; - /** An object defining configuration options for a selected series. */ - selectionStyle?: { - /** An object defining the border options for a selected series. */ - border?: viz.core.DashedBorder; - /** Sets a color for a series when it is selected. */ - color?: string; - /** Specifies the dash style for the line in a selected series. */ - dashStyle?: string; - /** Specifies the hatching options to be applied when a series is selected. */ - hatching?: viz.core.Hatching; - /** Specifies the width of a line in a selected series. */ - width?: number; - }; - /** Specifies whether or not to show the series in the chart's legend. */ - showInLegend?: boolean; - /** Specifies the name of the stack where the values of the _stackedBar_ series must be located. */ - stack?: string; - /** Specifies the name of the data source field that provides data about a point. */ - tagField?: string; - /** Specifies the data source field that provides values for series points. */ - valueField?: string; - /** Specifies the visibility of a series. */ - visible?: boolean; - /** Specifies a line width. */ - width?: number; - /** Configures error bars. */ - valueErrorBar?: { - /** Specifies whether error bars must be displayed in full or partially. */ - displayMode?: string; - /** Specifies the data field that provides data for low error values. */ - lowValueField?: string; - /** Specifies the data field that provides data for high error values. */ - highValueField?: string; - /** Specifies how error bar values must be calculated. */ - type?: string; - /** Specifies the value to be used for generating error bars. */ - value?: number; - /** Specifies the color of error bars. */ - color?: string; - /** Specifies the opacity of error bars. */ - opacity?: number; - /** Specifies the length of the lines that indicate the error bar edges. */ - edgeLength?: number; - /** Specifies the width of the error bar line. */ - lineWidth?: number; - }; - } - export interface CommonPointOptions { - /** Specifies border options for points in the line and area series. */ - border?: viz.core.Border; - /** Specifies the points color. */ - color?: string; - /** Specifies what series points to highlight when a point is hovered over. */ - hoverMode?: string; - /** An object defining configuration options for a hovered point. */ - hoverStyle?: { - /** An object defining the border options for a hovered point. */ - border?: viz.core.Border; - /** Sets a color for a point when it is hovered over. */ - color?: string; - /** Specifies the diameter of a hovered point in the series that represents data points as symbols (not as bars for instance). */ - size?: number; - }; - /** Specifies what series points to highlight when a point is selected. */ - selectionMode?: string; - /** An object defining configuration options for a selected point. */ - selectionStyle?: { - /** An object defining the border options for a selected point. */ - border?: viz.core.Border; - /**

Sets a color for a point when it is selected.

*/ - color?: string; - /** Specifies the diameter of a selected point in the series that represents data points as symbols (not as bars for instance). */ - size?: number; - }; - /** Specifies the point diameter in pixels for those series that represent data points as symbols (not as bars for instance). */ - size?: number; - /** Specifies a symbol for presenting points of the line and area series. */ - symbol?: string; - visible?: boolean; - } - export interface ChartCommonPointOptions extends CommonPointOptions { - /** An object specifying the parameters of an image that is used as a point marker. */ - image?: { - /** Specifies the height of an image that is used as a point marker. */ - height?: any; - /** Specifies a URL leading to the image to be used as a point marker. */ - url?: any; - /** Specifies the width of an image that is used as a point marker. */ - width?: any; - }; - } - export interface PolarCommonPointOptions extends CommonPointOptions { - /** An object specifying the parameters of an image that is used as a point marker. */ - image?: { - /** Specifies the height of an image that is used as a point marker. */ - height?: number; - /** Specifies a URL leading to the image to be used as a point marker. */ - url?: string; - /** Specifies the width of an image that is used as a point marker. */ - width?: number; - }; - } - /** An object that defines configuration options for chart series. */ - export interface CommonSeriesConfig extends BaseCommonSeriesConfig { - /** Specifies the data source field that provides a 'close' value for a _candleStick_ or _stock_ series. */ - closeValueField?: string; - /** Specifies a radius for bar corners. */ - cornerRadius?: number; - /** Specifies the data source field that provides a 'high' value for a _candleStick_ or _stock_ series. */ - highValueField?: string; - /** Specifies the color for the body (rectangle) of a _candleStick_ series. */ - innerColor?: string; - /** Specifies the data source field that provides a 'low' value for a _candleStick_ or _stock_ series. */ - lowValueField?: string; - /** Specifies the data source field that provides an 'open' value for a _candleStick_ or _stock_ series. */ - openValueField?: string; - /** Specifies the pane that will be used to display a series. */ - pane?: string; - /** An object defining configuration options for points in line-, scatter- and area-like series. */ - point?: ChartCommonPointOptions; - /** Specifies the data source field that provides values for one end of a range series. To set the data source field for the other end of the range series, use the rangeValue2Field property. */ - rangeValue1Field?: string; - /** Specifies the data source field that provides values for the second end of a range series. To set the data source field for the other end of the range series, use the rangeValue1Field property. */ - rangeValue2Field?: string; - /** Specifies reduction options for the stock or candleStick series. */ - reduction?: { - /** Specifies a color for the points whose reduction level price is lower in comparison to the value in the previous point. */ - color?: string; - /** Specifies for which price level (open, high, low or close) to enable reduction options in the series. */ - level?: string; - }; - /** Specifies the data source field that defines the size of bubbles. */ - sizeField?: string; - } - export interface CommonSeriesSettings extends CommonSeriesConfig { - /**

An object that specifies configuration options for all series of the area type in the chart.

*/ - area?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _bar_ type in the chart. */ - bar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the bubble type in the chart. */ - bubble?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _candleStick_ type in the chart. */ - candlestick?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _fullStackedArea_ type in the chart. */ - fullstackedarea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Full-Stacked Spline Area type in the chart. */ - fullstackedsplinearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _fullStackedBar_ type in the chart. */ - fullstackedbar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _fullStackedLine_ type in the chart. */ - fullstackedline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Full-Stacked Spline type in the chart. */ - fullstackedspline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _line_ type in the chart. */ - line?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _rangeArea_ type in the chart. */ - rangearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _rangeBar_ type in the chart. */ - rangebar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _scatter_ type in the chart. */ - scatter?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _spline_ type in the chart. */ - spline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _splineArea_ type in the chart. */ - splinearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedArea_ type in the chart. */ - stackedarea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Stacked Spline Area type in the chart. */ - stackedsplinearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedBar_ type in the chart. */ - stackedbar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedLine_ type in the chart. */ - stackedline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Stacked Spline type in the chart. */ - stackedspline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stepArea_ type in the chart. */ - steparea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stepLine_ type in the chart. */ - stepline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stock_ type in the chart. */ - stock?: CommonSeriesConfig; - /** Sets a series type. */ - type?: string; - } - export interface SeriesConfig extends CommonSeriesConfig { - /** Specifies the name that identifies the series. */ - name?: string; - /** Specifies data about a series. */ - tag?: any; - /** Sets the series type. */ - type?: string; - } - /** An object that defines configuration options for polar chart series. */ - export interface CommonPolarSeriesConfig extends BaseCommonSeriesConfig { - /** Specifies whether or not to close the chart by joining the end point with the first point. */ - closed?: boolean; - label?: SeriesConfigLabel; - point?: PolarCommonPointOptions; - } - export interface CommonPolarSeriesSettings extends CommonPolarSeriesConfig { - /** An object that specifies configuration options for all series of the area type in the chart. */ - area?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _bar_ type in the chart. */ - bar?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _line_ type in the chart. */ - line?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _scatter_ type in the chart. */ - scatter?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedBar_ type in the chart. */ - stackedbar?: CommonPolarSeriesConfig; - /** Sets a series type. */ - type?: string; - } - export interface PolarSeriesConfig extends CommonPolarSeriesConfig { - /** Specifies the name that identifies the series. */ - name?: string; - /** Specifies data about a series. */ - tag?: any; - /** Sets the series type. */ - type?: string; - } - export interface PieSeriesConfigLabel extends BaseSeriesConfigLabel { - /** Specifies how to shift labels from their initial position in a radial direction in pixels. */ - radialOffset?: number; - /** Specifies a precision for the percentage values displayed in labels. */ - percentPrecision?: number; - } - /** An object that defines configuration options for chart series. */ - export interface CommonPieSeriesConfig { - /** Specifies the data source field that provides arguments for series points. */ - argumentField?: string; - /** Specifies the required type for series arguments. */ - argumentType?: string; - /** An object defining the series border configuration options. */ - border?: viz.core.DashedBorder; - /** Specifies a series color. */ - color?: string; - /** Specifies the chart elements to highlight when a series is hovered over. */ - hoverMode?: string; - /** An object defining configuration options for a hovered series. */ - hoverStyle?: { - /** An object defining the border options for a hovered series. */ - border?: viz.core.DashedBorder; - /** Sets a color for the series when it is hovered over. */ - color?: string; - /** Specifies the hatching options to be applied when a point is hovered over. */ - hatching?: viz.core.Hatching; - }; - /** Specifies the fraction of the inner radius relative to the total radius in the series of the 'doughnut' type. */ - innerRadius?: number; - /** An object defining the label configuration options. */ - label?: PieSeriesConfigLabel; - /** Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed. */ - maxLabelCount?: number; - /** Specifies a minimal size of a displayed pie segment. */ - minSegmentSize?: number; - /** Specifies the direction in which the dxPieChart's series points are located. */ - segmentsDirection?: string; - /**

Specifies the chart elements to highlight when the series is selected.

*/ - selectionMode?: string; - /** An object defining configuration options for the series when it is selected. */ - selectionStyle?: { - /** An object defining the border options for a selected series. */ - border?: viz.core.DashedBorder; - /** Sets a color for a series when it is selected. */ - color?: string; - /** Specifies the hatching options to be applied when a point is selected. */ - hatching?: viz.core.Hatching; - }; - /** Specifies chart segment grouping options. */ - smallValuesGrouping?: { - /** Specifies the name of the grouped chart segment. This name represents the segment in the chart legend. */ - groupName?: string; - /** Specifies the segment grouping mode. */ - mode?: string; - /** Specifies a threshold for segment values. */ - threshold?: number; - /** Specifies how many segments must not be grouped. */ - topCount?: number; - }; - /** Specifies a start angle for a pie chart in arc degrees. */ - startAngle?: number; - /**

Specifies the name of the data source field that provides data about a point.

*/ - tagField?: string; - /** Specifies the data source field that provides values for series points. */ - valueField?: string; - } - export interface PieSeriesConfig extends CommonPieSeriesConfig { - /** Sets the series type. */ - type?: string; - } - export interface SeriesTemplate { - /** Specifies a callback function that returns a series object with individual series settings. */ - customizeSeries?: (seriesName: string) => SeriesConfig; - /** Specifies a data source field that represents the series name. */ - nameField?: string; - } - export interface PolarSeriesTemplate { - /** Specifies a callback function that returns a series object with individual series settings. */ - customizeSeries?: (seriesName: string) => PolarSeriesConfig; - /** Specifies a data source field that represents the series name. */ - nameField?: string; - } - export interface ChartCommonConstantLineLabel { - /** Specifies font options for a constant line label. */ - font?: viz.core.Font; - /** Specifies the position of the constant line label relative to the chart plot. */ - position?: string; - /** Indicates whether or not to display labels for the axis constant lines. */ - visible?: boolean; - } - export interface PolarCommonConstantLineLabel { - /** Indicates whether or not to display labels for the axis constant lines. */ - visible?: boolean; - /** Specifies font options for a constant line label. */ - font?: viz.core.Font; - } - export interface ConstantLineStyle { - /** Specifies a color for a constant line. */ - color?: string; - /** Specifies a dash style for a constant line. */ - dashStyle?: string; - /** Specifies a constant line width in pixels. */ - width?: number; - } - export interface ChartCommonConstantLineStyle extends ConstantLineStyle { - /** An object defining constant line label options. */ - label?: ChartCommonConstantLineLabel; - /** Specifies the space between the constant line label and the left/right side of the constant line. */ - paddingLeftRight?: number; - /** Specifies the space between the constant line label and the top/bottom side of the constant line. */ - paddingTopBottom?: number; - } - export interface PolarCommonConstantLineStyle extends ConstantLineStyle { - /** An object defining constant line label options. */ - label?: PolarCommonConstantLineLabel; - } - export interface CommonAxisLabel { - /** Specifies font options for axis labels. */ - font?: viz.core.Font; - /** Specifies the spacing between an axis and its labels in pixels. */ - indentFromAxis?: number; - /** Indicates whether or not axis labels are visible. */ - visible?: boolean; - } - export interface ChartCommonAxisLabel extends CommonAxisLabel { - /** Specifies the label's position relative to the tick (grid line). */ - alignment?: string; - /** Specifies the overlap resolving algorithm to be applied to axis labels. */ - overlappingBehavior?: { - /** Specifies how to arrange axis labels. */ - mode?: string; - /** Specifies the angle used to rotate axis labels. */ - rotationAngle?: number; - /** Specifies the spacing that must be set between staggered rows when the 'stagger' algorithm is applied. */ - staggeringSpacing?: number; - }; - } - export interface PolarCommonAxisLabel extends CommonAxisLabel { - /** Specifies the overlap resolving algorithm to be applied to axis labels. */ - overlappingBehavior?: string; - } - export interface CommonAxisTitle { - /** Specifies font options for an axis title. */ - font?: viz.core.Font; - /** Specifies a margin for an axis title in pixels. */ - margin?: number; - } - export interface BaseCommonAxisSettings { - /** Specifies the color of the line that represents an axis. */ - color?: string; - /** Specifies whether ticks/grid lines of a discrete axis are located between labels or cross the labels. */ - discreteAxisDivisionMode?: string; - /** An object defining the configuration options for the grid lines of an axis in the dxPolarChart widget. */ - grid?: { - /** Specifies a color for grid lines. */ - color?: string; - /** Specifies an opacity for grid lines. */ - opacity?: number; - /** Indicates whether or not the grid lines of an axis are visible. */ - visible?: boolean; - /** Specifies the width of grid lines. */ - width?: number; - }; - /** Specifies the options of the minor grid. */ - minorGrid?: { - /** Specifies a color for the lines of the minor grid. */ - color?: string; - /** Specifies an opacity for the lines of the minor grid. */ - opacity?: number; - /** Indicates whether the minor grid is visible or not. */ - visible?: boolean; - /** Specifies a width for the lines of the minor grid. */ - width?: number; - }; - /** Indicates whether or not an axis is inverted. */ - inverted?: boolean; - /** Specifies the opacity of the line that represents an axis. */ - opacity?: number; - /** Indicates whether or not to set ticks/grid lines of a continuous axis of the 'date-time' type at the beginning of each date-time interval. */ - setTicksAtUnitBeginning?: boolean; - /** An object defining the configuration options for axis ticks. */ - tick?: { - /** Specifies ticks color. */ - color?: string; - /** Specifies tick opacity. */ - opacity?: number; - /** Indicates whether or not ticks are visible on an axis. */ - visible?: boolean; - }; - /** Specifies the options of the minor ticks. */ - minorTick?: { - /** Specifies a color for the minor ticks. */ - color?: string; - /** Specifies an opacity for the minor ticks. */ - opacity?: number; - /** Indicates whether or not the minor ticks are displayed on an axis. */ - visible?: boolean; - }; - /** Indicates whether or not the line that represents an axis in a chart is visible. */ - visible?: boolean; - /** Specifies the width of the line that represents an axis in the chart. */ - width?: number; - } - export interface ChartCommonAxisSettings extends BaseCommonAxisSettings { - /** Specifies the appearance of all the widget's constant lines. */ - constantLineStyle?: ChartCommonConstantLineStyle; - /** An object defining the label configuration options that are common for all axes in the dxChart widget. */ - label?: ChartCommonAxisLabel; - /** Specifies a coefficient that determines the spacing between the maximum series point and the axis. */ - maxValueMargin?: number; - /** Specifies a coefficient that determines the spacing between the minimum series point and the axis. */ - minValueMargin?: number; - /** Specifies, in pixels, the space reserved for an axis. */ - placeholderSize?: number; - /** An object defining configuration options for strip style. */ - stripStyle?: { - /** An object defining the configuration options for a strip label style. */ - label?: { - /** Specifies font options for a strip label. */ - font?: viz.core.Font; - /** Specifies the label's position on a strip. */ - horizontalAlignment?: string; - /** Specifies a label's position on a strip. */ - verticalAlignment?: string; - }; - /** Specifies the spacing, in pixels, between the left/right strip border and the strip label. */ - paddingLeftRight?: number; - /** Specifies the spacing, in pixels, between the top/bottom strip borders and the strip label. */ - paddingTopBottom?: number; - }; - /** An object defining the title configuration options that are common for all axes in the dxChart widget. */ - title?: CommonAxisTitle; - /** Indicates whether or not to display series with indents from axis boundaries. */ - valueMarginsEnabled?: boolean; - } - export interface PolarCommonAxisSettings extends BaseCommonAxisSettings { - /** Specifies the appearance of all the widget's constant lines. */ - constantLineStyle?: PolarCommonConstantLineStyle; - /** An object defining the label configuration options that are common for all axes in the dxPolarChart widget. */ - label?: PolarCommonAxisLabel; - /** An object defining configuration options for strip style. */ - stripStyle?: { - /** An object defining the configuration options for a strip label style. */ - label?: { - /** Specifies font options for a strip label. */ - font?: viz.core.Font; - }; - }; - } - export interface ChartConstantLineLabel extends ChartCommonConstantLineLabel { - /** Specifies the horizontal alignment of a constant line label. */ - horizontalAlignment?: string; - /** Specifies the vertical alignment of a constant line label. */ - verticalAlignment?: string; - /** Specifies the text to be displayed in a constant line label. */ - text?: string; - } - export interface PolarConstantLineLabel extends PolarCommonConstantLineLabel { - /** Specifies the text to be displayed in a constant line label. */ - text?: string; - } - export interface AxisLabel { - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a label on the value axis. */ - customizeHint?: (argument: { value: any; valueText: string }) => string; - /** Specifies a callback function that returns the text to be displayed in value axis labels. */ - customizeText?: (argument: { value: any; valueText: string }) => string; - /** Specifies a format for the text displayed by axis labels. */ - format?: string; - /** Specifies a precision for the formatted value displayed in the axis labels. */ - precision?: number; - } - export interface ChartAxisLabel extends ChartCommonAxisLabel, AxisLabel {} - export interface PolarAxisLabel extends PolarCommonAxisLabel, AxisLabel {} - export interface AxisTitle extends CommonAxisTitle { - /** Specifies the text for the value axis title. */ - text?: string; - } - export interface ChartConstantLineStyle extends ChartCommonConstantLineStyle { - /** An object defining constant line label options. */ - label?: ChartConstantLineLabel; - } - export interface ChartConstantLine extends ChartConstantLineStyle { - /** An object defining constant line label options. */ - label?: ChartConstantLineLabel; - /** Specifies a value to be displayed by a constant line. */ - value?: any; - } - export interface PolarConstantLine extends PolarCommonConstantLineStyle { - /** An object defining constant line label options. */ - label?: PolarConstantLineLabel; - /** Specifies a value to be displayed by a constant line. */ - value?: any; - } - export interface Axis { - /** Specifies a coefficient for dividing the value axis. */ - axisDivisionFactor?: number; - /** Specifies the order in which discrete values are arranged on the value axis. */ - categories?: Array; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic axis. */ - logarithmBase?: number; - /** Specifies an interval between axis ticks/grid lines. */ - tickInterval?: any; - /** Specifies the interval between minor ticks. */ - minorTickInterval?: any; - /** Specifies the number of minor ticks between two neighboring major ticks. */ - minorTickCount?: number; - /** Specifies the required type of the value axis. */ - type?: string; - /** Specifies the pane on which the current value axis will be displayed. */ - pane?: string; - /** Specifies options for value axis strips. */ - strips?: Array; - } - export interface ChartAxis extends ChartCommonAxisSettings, Axis { - /** Defines an array of the value axis constant lines. */ - constantLines?: Array; - /** Specifies the appearance options for the constant lines of the value axis. */ - constantLineStyle?: ChartCommonConstantLineStyle; - /** Specifies options for value axis labels. */ - label?: ChartAxisLabel; - /** Specifies the maximum value on the value axis. */ - max?: any; - /** Specifies the minimum value on the value axis. */ - min?: any; - /** Specifies the position of the value axis on a chart. */ - position?: string; - /** Specifies the title for a value axis. */ - title?: AxisTitle; - } - export interface PolarAxis extends PolarCommonAxisSettings, Axis { - /** Defines an array of the value axis constant lines. */ - constantLines?: Array; - /** Specifies options for value axis labels. */ - label?: PolarAxisLabel; - } - export interface ArgumentAxis { - /** Specifies the desired type of axis values. */ - argumentType?: string; - /** Specifies the elements that will be highlighted when the argument axis is hovered over. */ - hoverMode?: string; - } - export interface ChartArgumentAxis extends ChartAxis, ArgumentAxis {} - export interface PolarArgumentAxis extends PolarAxis, ArgumentAxis { - /** Specifies a start angle for the argument axis in degrees. */ - startAngle?: number; - /** Specifies whether or not to display the first point at the angle specified by the startAngle option. */ - firstPointOnStartAngle?: boolean; - /** Specifies the period of the argument values in the data source. */ - period?: number; - } - export interface ValueAxis { - /** Specifies the name of the value axis. */ - name?: string; - /** Specifies whether or not to indicate a zero value on the value axis. */ - showZero?: boolean; - /** Specifies the desired type of axis values. */ - valueType?: string; - } - export interface ChartValueAxis extends ChartAxis, ValueAxis { - /** Specifies the spacing, in pixels, between multiple value axes in a chart. */ - multipleAxesSpacing?: number; - /** Specifies the value by which the chart's value axes are synchronized. */ - synchronizedValue?: number; - } - export interface PolarValueAxis extends PolarAxis, ValueAxis { - /** Indicates whether to display series with indents from axis boundaries. */ - valueMarginsEnabled?: boolean; - /** Specifies a coefficient that determines the spacing between the maximum series point and the axis. */ - maxValueMargin?: number; - /** Specifies a coefficient that determines the spacing between the minimum series point and the axis. */ - minValueMargin?: number; - tick?: { - visible?: boolean; - } - } - export interface CommonPane { - /** Specifies a background color in a pane. */ - backgroundColor?: string; - /** Specifies the border options of a chart's pane. */ - border?: PaneBorder; - } - export interface Pane extends CommonPane { - /** Specifies the name of a pane. */ - name?: string; - } - export interface PaneBorder extends viz.core.DashedBorderWithOpacity { - /** Specifies the bottom border's visibility state in a pane. */ - bottom?: boolean; - /** Specifies the left border's visibility state in a pane. */ - left?: boolean; - /** Specifies the right border's visibility state in a pane. */ - right?: boolean; - /** Specifies the top border's visibility state in a pane. */ - top?: boolean; - } - export interface ChartAnimation extends viz.core.Animation { - /** Specifies the maximum series point count in the chart that the animation supports. */ - maxPointCountSupported?: number; - } - export interface BaseChartTooltip extends viz.core.Tooltip { - /** Specifies a format for arguments of the chart's series points. */ - argumentFormat?: string; - /** Specifies a precision for formatted arguments displayed in tooltips. */ - argumentPrecision?: number; - /** Specifies a precision for a percent value displayed in tooltips for stacked series and dxPieChart series. */ - percentPrecision?: number; - } - export interface BaseChartOptions extends viz.core.BaseWidgetOptions { - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - /** Specifies the width of the widget container that is small enough for the layout to begin adapting. */ - width?: number; - /** Specifies the height of the widget container that is small enough for the layout to begin adapting. */ - height?: number; - /** Specifies whether or not point labels can be hidden when the layout is adapting. */ - keepLabels?: boolean; - }; - /** Specifies animation options. */ - animation?: ChartAnimation; - /** Specifies a callback function that returns an object with options for a specific point label. */ - customizeLabel?: (labelInfo: Object) => Object; - /** Specifies a callback function that returns an object with options for a specific point. */ - customizePoint?: (pointInfo: Object) => Object; - /** Specifies a data source for the chart. */ - dataSource?: any; - done?: Function; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies options of a dxChart's (dxPieChart's) legend. */ - legend?: core.BaseLegend; - /** Specifies the blank space between the chart's extreme elements and the boundaries of the area provided for the widget (see size) in pixels. */ - margin?: viz.core.Margins; - /** Sets the name of the palette to be used in the chart. Alternatively, an array of colors can be set as a custom palette to be used within this chart. */ - palette?: any; - /** A handler for the done event. */ - onDone?: (e: { - component: BaseChart; - element: Element; - }) => void; - /** A handler for the pointClick event. */ - onPointClick?: any; - pointClick?: any; - /** A handler for the pointHoverChanged event. */ - onPointHoverChanged?: (e: { - component: BaseChart; - element: Element; - target: TPoint; - }) => void; - pointHoverChanged?: (point: TPoint) => void; - /** A handler for the pointSelectionChanged event. */ - onPointSelectionChanged?: (e: { - component: BaseChart; - element: Element; - target: TPoint; - }) => void; - pointSelectionChanged?: (point: TPoint) => void; - /** Specifies whether a single point or multiple points can be selected in the chart. */ - pointSelectionMode?: string; - /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */ - redrawOnResize?: boolean; - /** Specifies options for the dxChart and dxPieChart widget series. */ - series?: any; - /** Specifies the size of the widget in pixels. */ - size?: viz.core.Size; - /** Specifies a title for the chart. */ - title?: { - /** Specifies font options for the title. */ - font?: viz.core.Font; - /** Specifies the title's horizontal position in the chart. */ - horizontalAlignment?: string; - /** Specifies a title's position on the chart in the vertical direction. */ - verticalAlignment?: string; - /** Specifies the distance between the title and surrounding chart elements in pixels. */ - margin?: viz.core.Margins; - /** Specifies the height of the space reserved for the title. */ - placeholderSize?: number; - /** Specifies a text for the chart's title. */ - text?: string; - }; - /** Specifies tooltip options. */ - tooltip?: BaseChartTooltip; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: BaseChart; - element: Element; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: BaseChart; - element: Element; - }) => void; - tooltipHidden?: (point: TPoint) => void; - tooltipShown?: (point: TPoint) => void; - } - /** A base class for all chart widgets included in the ChartJS library. */ - export class BaseChart extends viz.core.BaseWidget { - /** Deselects the chart's selected series. The series is displayed in an initial style. */ - clearSelection(): void; - /** Gets the current size of the widget. */ - getSize(): { width: number; height: number }; - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Hides all widget tooltips. */ - hideTooltip(): void; - /** Redraws a widget. */ - render(renderOptions?: { - force?: boolean; - animate?: boolean; - asyncSeriesRendering?: boolean; - }): void; - } - export interface AdvancedLegend extends core.BaseLegend { - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item. */ - customizeHint?: (seriesInfo: { seriesName: string; seriesIndex: number; seriesColor: string; }) => string; - /**

Specifies a callback function that returns the text to be displayed by legend items.

*/ - customizeText?: (seriesInfo: { seriesName: string; seriesIndex: number; seriesColor: string; }) => string; - /** Specifies what series elements to highlight when a corresponding item in the legend is hovered over. */ - hoverMode?: string; - } - export interface AdvancedOptions extends BaseChartOptions { - /** A handler for the argumentAxisClick event. */ - onArgumentAxisClick?: any; - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** An object providing options for managing data from a data source. */ - dataPrepareSettings?: { - /** Specifies whether or not to validate the values from a data source. */ - checkTypeForAllData?: boolean; - /** Specifies whether or not to convert the values from a data source into the data type of an axis. */ - convertToAxisDataType?: boolean; - /** Specifies how to sort the series points. */ - sortingMethod?: any; - }; - /** A handler for the legendClick event. */ - onLegendClick?: any; - /** A handler for the seriesClick event. */ - onSeriesClick?: any; - /** A handler for the seriesHoverChanged event. */ - onSeriesHoverChanged?: (e: { - component: BaseChart; - element: Element; - target: TSeries; - }) => void; - /** A handler for the seriesSelectionChanged event. */ - onSeriesSelectionChanged?: (e: { - component: BaseChart; - element: Element; - target: TSeries; - }) => void; - /** Specifies whether a single series or multiple series can be selected in the chart. */ - seriesSelectionMode?: string; - /** Specifies how the chart must behave when series point labels overlap. */ - resolveLabelOverlapping?: string; - } - export interface Legend extends AdvancedLegend { - /** Specifies whether the legend is located outside or inside the chart's plot. */ - position?: string; - } - export interface ChartTooltip extends BaseChartTooltip { - /** Specifies whether the tooltip must be located in the center of a bar or on its edge. Applies only to the Bar series. */ - location?: string; - /** Specifies the kind of information to display in a tooltip. */ - shared?: boolean; - } - export interface dxChartOptions extends AdvancedOptions { - /** Specifies a value indicating whether all bars in a series must have the same width, or may have different widths if any points in other series are missing. */ - equalBarWidth?: any; - adaptiveLayout?: { - keepLabels?: boolean; - }; - /** Indicates whether or not to synchronize value axes when they are displayed on a single pane. */ - synchronizeMultiAxes?: boolean; - /** Specifies whether or not to filter the series points depending on their quantity. */ - useAggregation?: boolean; - /** Indicates whether or not to adjust a value axis to the current minimum and maximum values of a zoomed chart. */ - adjustOnZoom?: boolean; - /** Specifies argument axis options for the dxChart widget. */ - argumentAxis?: ChartArgumentAxis; - argumentAxisClick?: any; - /** An object defining the configuration options that are common for all axes of the dxChart widget. */ - commonAxisSettings?: ChartCommonAxisSettings; - /** An object defining the configuration options that are common for all panes in the dxChart widget. */ - commonPaneSettings?: CommonPane; - /** An object defining the configuration options that are common for all series of the dxChart widget. */ - commonSeriesSettings?: CommonSeriesSettings; - /** An object that specifies the appearance options of the chart crosshair. */ - crosshair?: { - /** Specifies a color for the crosshair lines. */ - color?: string; - /** Specifies a dash style for the crosshair lines. */ - dashStyle?: string; - /** Specifies whether to enable the crosshair or not. */ - enabled?: boolean; - /** Specifies the opacity of the crosshair lines. */ - opacity?: number; - /** Specifies the width of the crosshair lines. */ - width?: number; - /** Specifies the appearance of the horizontal crosshair line. */ - horizontalLine?: CrosshaierWithLabel; - /** Specifies the appearance of the vertical crosshair line. */ - verticalLine?: CrosshaierWithLabel; - /** Specifies the options of the crosshair labels. */ - label?: { - /** Specifies a color for the background of the crosshair labels. */ - backgroundColor?: string; - /** Specifies whether the crosshair labels are visible or not. */ - visible?: boolean; - /** Specifies font options for the text of the crosshair labels. */ - font?: viz.core.Font; - } - }; - /** Specifies a default pane for the chart's series. */ - defaultPane?: string; - /** Specifies a coefficient determining the diameter of the largest bubble. */ - maxBubbleSize?: number; - /** Specifies the diameter of the smallest bubble measured in pixels. */ - minBubbleSize?: number; - /** Defines the dxChart widget's pane(s). */ - panes?: Array; - /** Swaps the axes round so that the value axis becomes horizontal and the argument axes becomes vertical. */ - rotated?: boolean; - /** Specifies the options of a chart's legend. */ - legend?: Legend; - /** Specifies options for dxChart widget series. */ - series?: Array; - legendClick?: any; - seriesClick?: any; - seriesHoverChanged?: (series: ChartSeries) => void; - seriesSelectionChanged?: (series: ChartSeries) => void; - /** Defines options for the series template. */ - seriesTemplate?: SeriesTemplate; - /** Specifies tooltip options. */ - tooltip?: ChartTooltip; - /** Specifies value axis options for the dxChart widget. */ - valueAxis?: Array; - /** Enables scrolling in your chart. */ - scrollingMode?: string; - /** Enables zooming in your chart. */ - zoomingMode?: string; - /** Specifies the settings of the scroll bar. */ - scrollBar?: { - /** Specifies whether the scroll bar is visible or not. */ - visible?: boolean; - /** Specifies the spacing between the scroll bar and the chart's plot in pixels. */ - offset?: number; - /** Specifies the color of the scroll bar. */ - color?: string; - /** Specifies the width of the scroll bar in pixels. */ - width?: number; - /** Specifies the opacity of the scroll bar. */ - opacity?: number; - /** Specifies the position of the scroll bar in the chart. */ - position?: string; - }; - } - /** A widget used to embed charts into HTML JS applications. */ - export class dxChart extends BaseChart { - constructor(element: JQuery, options?: dxChartOptions); - constructor(element: Element, options?: dxChartOptions); - /** Returns an array of all series in the chart. */ - getAllSeries(): Array; - /** Gets a series within the chart's series collection by the specified name (see the name option). */ - getSeriesByName(seriesName: string): ChartSeries; - /** Gets a series within the chart's series collection by its position number. */ - getSeriesByPos(seriesIndex: number): ChartSeries; - /** Sets the specified start and end values for the chart's argument axis. */ - zoomArgument(startValue: any, endValue: any): void; - } - interface CrosshaierWithLabel extends viz.core.DashedBorderWithOpacity { - /** Configures the label that belongs to the horizontal crosshair line. */ - label?: { - /** Specifies a color for the background of the label that belongs to the horizontal crosshair line. */ - backgroundColor?: string; - /** Specifies whether the label of the horizontal crosshair line is visible or not. */ - visible?: boolean; - /** Specifies font options for the text of the label that belongs to the horizontal crosshair line. */ - font?: viz.core.Font; - } - } - export interface PolarChartTooltip extends BaseChartTooltip { - /** Specifies the kind of information to display in a tooltip. */ - shared?: boolean; - } - export interface dxPolarChartOptions extends AdvancedOptions { - /** Specifies a value indicating whether all bars in a series must have the same angle, or may have different angles if any points in other series are missing. */ - equalBarWidth?: boolean; - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - width?: number; - height?: number; - /** Specifies whether or not point labels can be hidden when the layout is adapting. */ - keepLabels?: boolean; - }; - /** Indicates whether or not to display a "spider web". */ - useSpiderWeb?: boolean; - /** Specifies argument axis options for the dxPolarChart widget. */ - argumentAxis?: PolarArgumentAxis; - /** An object defining the configuration options that are common for all axes of the dxPolarChart widget. */ - commonAxisSettings?: PolarCommonAxisSettings; - /** An object defining the configuration options that are common for all series of the dxPolarChart widget. */ - commonSeriesSettings?: CommonPolarSeriesSettings; - /** Specifies the options of a chart's legend. */ - legend?: AdvancedLegend; - /** Specifies options for dxPolarChart widget series. */ - series?: Array; - /** Defines options for the series template. */ - seriesTemplate?: PolarSeriesTemplate; - /** Specifies tooltip options. */ - tooltip?: PolarChartTooltip; - /** Specifies value axis options for the dxPolarChart widget. */ - valueAxis?: PolarValueAxis; - } - /** A chart widget displaying data in a polar coordinate system. */ - export class dxPolarChart extends BaseChart { - constructor(element: JQuery, options?: dxPolarChartOptions); - constructor(element: Element, options?: dxPolarChartOptions); - /** Returns an array of all series in the chart. */ - getAllSeries(): Array; - /** Gets a series within the chart's series collection by the specified name (see the name option). */ - getSeriesByName(seriesName: string): PolarSeries; - /** Gets a series within the chart's series collection by its position number. */ - getSeriesByPos(seriesIndex: number): PolarSeries; - } - export interface PieLegend extends core.BaseLegend { - /** Specifies what chart elements to highlight when a corresponding item in the legend is hovered over. */ - hoverMode?: string; - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item. */ - customizeHint?: (pointInfo: { pointName: string; pointIndex: number; pointColor: string; }) => string; - /** Specifies a callback function that returns the text to be displayed by a legend item. */ - customizeText?: (pointInfo: { pointName: string; pointIndex: number; pointColor: string; }) => string; - } - export interface dxPieChartOptions extends BaseChartOptions { - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - /** Specifies whether or not point labels can be hidden when the layout is adapting. */ - keepLabels?: boolean; - }; - /** Specifies dxPieChart legend options. */ - legend?: PieLegend; - /** Specifies options for the series of the dxPieChart widget. */ - series?: Array; - /** Specifies the diameter of the pie. */ - diameter?: number; - /** A handler for the legendClick event. */ - onLegendClick?: any; - legendClick?: any; - /** Specifies how the chart must behave when series point labels overlap. */ - resolveLabelOverlapping?: string; - } - /** A circular chart widget for HTML JS applications. */ - export class dxPieChart extends BaseChart { - constructor(element: JQuery, options?: dxPieChartOptions); - constructor(element: Element, options?: dxPieChartOptions); - /** Provides access to the dxPieChart series. */ - getSeries(): PieSeries; - } -} -declare namespace DevExpress.viz.core { - export interface Border { - /** Sets a border color for a selected series. */ - color?: string; - /** Sets border visibility for a selected series. */ - visible?: boolean; - /** Sets a border width for a selected series. */ - width?: number; - } - export interface DashedBorder extends Border { - /** Specifies a dash style for the border of a selected series point. */ - dashStyle?: string; - } - export interface DashedBorderWithOpacity extends DashedBorder { - /** Specifies the opacity of the tooltip's border. */ - opacity?: number; - } - export interface Font { - /** Specifies the font color for a strip label. */ - color?: string; - /** Specifies the font family for a strip label. */ - family?: string; - /** Specifies the font opacity for a strip label. */ - opacity?: number; - /** Specifies the font size for a strip label. */ - size?: any; - /** Specifies the font weight for the text displayed in strips. */ - weight?: number; - } - export interface Hatching { - /** Specifies how to apply hatching to highlight a selected series. */ - direction?: string; - /** Specifies the opacity of hatching lines. */ - opacity?: number; - /** Specifies the distance between hatching lines in pixels. */ - step?: number; - /** Specifies the width of hatching lines in pixels. */ - width?: number; - } - export interface Margins { - /** Specifies the legend's bottom margin in pixels. */ - bottom?: number; - /** Specifies the legend's left margin in pixels. */ - left?: number; - /** Specifies the legend's right margin in pixels. */ - right?: number; - /** Specifies the legend's bottom margin in pixels. */ - top?: number; - } - export interface Size { - /** Specifies the width of the widget. */ - width?: number; - /** Specifies the height of the widget. */ - height?: number; - } - export interface Tooltip { - /** Specifies the length of the tooltip's arrow in pixels. */ - arrowLength?: number; - /** Specifies the appearance of the tooltip's border. */ - border?: viz.core.DashedBorderWithOpacity; - /** Specifies a color for the tooltip. */ - color?: string; - /** Specifies text and appearance of a set of tooltips. */ - customizeTooltip?: (arg: Object) => { color?: string; text?: string }; - /** Specifies whether or not the tooltip is enabled. */ - enabled?: boolean; - /** Specifies font options for the text displayed by the tooltip. */ - font?: Font; - /** Specifies a format for the text displayed by the tooltip. */ - format?: string; - /** Specifies the opacity of a tooltip. */ - opacity?: number; - /** Specifies a distance from the tooltip's left/right boundaries to the inner text in pixels. */ - paddingLeftRight?: number; - /** Specifies a distance from the tooltip's top/bottom boundaries to the inner text in pixels. */ - paddingTopBottom?: number; - /** Specifies a precision for formatted values displayed by the tooltip. */ - precision?: number; - /** Specifies options of the tooltip's shadow. */ - shadow?: { - /** Specifies the blur distance of the tooltip's shadow. */ - blur?: number; - /** Specifies the color of the tooltip's shadow. */ - color?: string; - /** Specifies the horizontal offset of the tooltip's shadow relative to the tooltip in pixels. */ - offsetX?: number; - /** Specifies the vertical offset of the tooltip's shadow relative to the tooltip in pixels. */ - offsetY?: number; - /** Specifies the opacity of the tooltip's shadow. */ - opacity?: number; - }; - } - export interface Animation { - /** Determines how long animation runs. */ - duration?: number; - /** Specifies the animation easing mode. */ - easing?: string; - /** Indicates whether or not animation is enabled. */ - enabled?: boolean; - } - export interface LoadingIndicator { - /** Specifies a color for the loading indicator background. */ - backgroundColor?: string; - /** Specifies font options for the loading indicator text. */ - font?: viz.core.Font; - /** Specifies whether to show the loading indicator or not. */ - show?: boolean; - /** Specifies a text to be displayed by the loading indicator. */ - text?: string; - } - export interface LegendBorder extends viz.core.DashedBorderWithOpacity { - /** Specifies a radius for the corners of the legend border. */ - cornerRadius?: number; - } - export interface BaseLegend { - /** Specifies the color of the legend's background. */ - backgroundColor?: string; - /** Specifies legend border settings. */ - border?: viz.core.LegendBorder; - /** Specifies how many columns must be taken to arrange legend items. */ - columnCount?: number; - /** Specifies the spacing between a pair of neighboring legend columns in pixels. */ - columnItemSpacing?: number; - /** Specifies font options for legend items. */ - font?: viz.core.Font; - /** Specifies the legend's position on the map. */ - horizontalAlignment?: string; - /** Specifies the alignment of legend items. */ - itemsAlignment?: string; - /** Specifies the position of text relative to the item marker. */ - itemTextPosition?: string; - /** Specifies the distance between the legend and the container borders in pixels. */ - margin?: viz.core.Margins; - /** Specifies the size of item markers in the legend in pixels. */ - markerSize?: number; - /** Specifies whether to arrange legend items horizontally or vertically. */ - orientation?: string; - /** Specifies the spacing between the legend left/right border and legend items in pixels. */ - paddingLeftRight?: number; - /** Specifies the spacing between the legend top/bottom border and legend items in pixels. */ - paddingTopBottom?: number; - /** Specifies how many rows must be taken to arrange legend items. */ - rowCount?: number; - /** Specifies the spacing between a pair of neighboring legend rows in pixels. */ - rowItemSpacing?: number; - /** Specifies the legend's position on the map. */ - verticalAlignment?: string; - /** Specifies whether or not the legend is visible on the map. */ - visible?: boolean; - } - export interface BaseWidgetOptions { - drawn?: (widget: Object) => void; - /** A handler for the drawn event. */ - onDrawn?: (e: { - component: BaseWidget; - element: Element; - }) => void; - incidentOccured?: (incidentInfo: { - id: string; - type: string; - args: any; - text: string; - widget: string; - version: string; - }) => void; - /** A handler for the incidentOccurred event. */ - onIncidentOccurred?: ( - component: BaseWidget, - element: Element, - target: { - id: string; - type: string; - args: any; - text: string; - widget: string; - version: string; - } - ) => void; - /** Notifies a widget that it is embedded into an HTML page that uses a path modifier. */ - pathModified?: boolean; - /** Specifies whether or not the widget supports right-to-left representation. */ - rtlEnabled?: boolean; - /** Sets the name of the theme to be used in the widget. */ - theme?: string; - } - /** This section describes options and methods that are common to all widgets. */ - export class BaseWidget extends DOMComponent { - /** Returns the widget's SVG markup. */ - svg(): string; - } -} -declare namespace DevExpress.viz.gauges { - export interface BaseRangeContainer { - /** Specifies a range container's background color. */ - backgroundColor?: string; - /** Specifies the offset of the range container from an invisible scale line in pixels. */ - offset?: number; - /** Sets the name of the palette or an array of colors to be used for coloring the gauge range container. */ - palette?: any; - /** An array of objects representing ranges contained in the range container. */ - ranges?: Array<{ startValue: number; endValue: number; color: string }>; - /** Specifies a color of a range. */ - color?: string; - /** Specifies an end value of a range. */ - endValue?: number; - /** Specifies a start value of a range. */ - startValue?: number; - } - export interface ScaleTick { - /** Specifies the color of the scale's minor ticks. */ - color?: string; - /** Specifies an array of custom minor ticks. */ - customTickValues?: Array; - /** Specifies the length of the scale's minor ticks. */ - length?: number; - /** Indicates whether automatically calculated minor ticks are visible or not. */ - showCalculatedTicks?: boolean; - /** Specifies an interval between minor ticks. */ - tickInterval?: number; - /** Indicates whether scale minor ticks are visible or not. */ - visible?: boolean; - /** Specifies the width of the scale's minor ticks. */ - width?: number; - } - export interface ScaleMajorTick extends ScaleTick { - /** Specifies whether or not to expand the current major tick interval if labels overlap each other. */ - useTicksAutoArrangement?: boolean; - } - export interface BaseScaleLabel { - /** Specifies whether or not scale labels should be colored similarly to their corresponding ranges in the range container. */ - useRangeColors?: boolean; - /** Specifies a callback function that returns the text to be displayed in scale labels. */ - customizeText?: (scaleValue: { value: number; valueText: string }) => string; - /** Specifies font options for the text displayed in the scale labels of the gauge. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in scale labels. */ - format?: string; - /** Specifies a precision for the formatted value displayed in the scale labels. */ - precision?: number; - /** Specifies whether or not scale labels are visible on the gauge. */ - visible?: boolean; - } - export interface BaseScale { - /** Specifies the end value for the scale of the gauge. */ - endValue?: number; - /** Specifies whether or not to hide the first scale label. */ - hideFirstLabel?: boolean; - /** Specifies whether or not to hide the first major tick on the scale. */ - hideFirstTick?: boolean; - /** Specifies whether or not to hide the last scale label. */ - hideLastLabel?: boolean; - /** Specifies whether or not to hide the last major tick on the scale. */ - hideLastTick?: boolean; - /** Specifies common options for scale labels. */ - label?: BaseScaleLabel; - /** Specifies options of the gauge's major ticks. */ - majorTick?: ScaleMajorTick; - /** Specifies options of the gauge's minor ticks. */ - minorTick?: ScaleTick; - /** Specifies the start value for the scale of the gauge. */ - startValue?: number; - } - export interface BaseValueIndicator { - /** Specifies the type of subvalue indicators. */ - type?: string; - /** Specifies the background color for the indicator of the rangeBar type. */ - backgroundColor?: string; - /** Specifies the base value for the indicator of the rangeBar type. */ - baseValue?: number; - /** Specifies a color of the indicator. */ - color?: string; - /** Specifies the range bar size for an indicator of the rangeBar type. */ - size?: number; - text?: { - /** Specifies a callback function that returns the text to be displayed in an indicator. */ - customizeText?: (indicatedValue: { value: number; valueText: string }) => string; - font?: viz.core.Font; - /** Specifies a format for the text displayed in an indicator. */ - format?: string; - /** Specifies the range bar's label indent in pixels. */ - indent?: number; - /** Specifies a precision for the formatted value displayed by an indicator. */ - precision?: number; - }; - offset?: number; - length?: number; - width?: number; - /** Specifies the length of an arrow for the indicator of the textCloud type in pixels. */ - arrowLength?: number; - /** Sets the array of colors to be used for coloring subvalue indicators. */ - palette?: Array; - /** Specifies the distance between the needle and the center of a gauge for the indicator of a needle-like type. */ - indentFromCenter?: number; - /** Specifies the second color for the indicator of the twoColorNeedle type. */ - secondColor?: string; - /** Specifies the length of a twoNeedleColor type indicator tip as a percentage. */ - secondFraction?: number; - /** Specifies the spindle's diameter in pixels for the indicator of a needle-like type. */ - spindleSize?: number; - /** Specifies the inner diameter in pixels, so that the spindle has the shape of a ring. */ - spindleGapSize?: number; - /** Specifies the orientation of the rangeBar indicator on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - /** Specifies the orientation of the rangeBar indicator on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - } - export interface SharedGaugeOptions { - /** Specifies animation options. */ - animation?: viz.core.Animation; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */ - redrawOnResize?: boolean; - /** Specifies the size of the widget in pixels. */ - size?: viz.core.Size; - /** Specifies a subtitle for a gauge. */ - subtitle?: { - /** Specifies font options for the subtitle. */ - font?: viz.core.Font; - /** Specifies a text for the subtitle. */ - text?: string; - }; - /** Specifies a title for a gauge. */ - title?: { - /** Specifies font options for the title. */ - font?: viz.core.Font; - /** Specifies a title's position on the gauge. */ - position?: string; - /** Specifies a text for the title. */ - text?: string; - }; - /** Specifies options for gauge tooltips. */ - tooltip?: viz.core.Tooltip; - } - export interface BaseGaugeOptions extends viz.core.BaseWidgetOptions, SharedGaugeOptions { - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** Specifies the blank space in pixels between the widget's extreme elements and the boundaries of the area provided for the widget (see the size option). */ - margin?: viz.core.Margins; - /** Specifies options of the gauge's range container. */ - rangeContainer?: BaseRangeContainer; - /** Specifies a gauge's scale options. */ - scale?: BaseScale; - /** Specifies the appearance options of subvalue indicators. */ - subvalueIndicator?: BaseValueIndicator; - /** Specifies a set of subvalues to be designated by the subvalue indicators. */ - subvalues?: Array; - /** Specifies the main value on a gauge. */ - value?: number; - /** Specifies the appearance options of the value indicator. */ - valueIndicator?: BaseValueIndicator; - } - /** A gauge widget. */ - export class dxBaseGauge extends viz.core.BaseWidget { - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(): void; - /** Returns the main gauge value. */ - value(): number; - /** Updates a gauge value. */ - value(value: number): void; - /** Returns an array of gauge subvalues. */ - subvalues(): Array; - /** Updates gauge subvalues. */ - subvalues(subvalues: Array): void; - } - export interface LinearRangeContainer extends BaseRangeContainer { - /** Specifies the orientation of the range container on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - /** Specifies the orientation of a range container on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - /** Specifies the width of the range container's start and end boundaries in the dxLinearGauge widget. */ - width?: any; - /** Specifies an end width of a range container. */ - end?: number; - /** Specifies a start width of a range container. */ - start?: number; - } - export interface LinearScaleLabel extends BaseScaleLabel { - /** Specifies the spacing between scale labels and ticks. */ - indentFromTick?: number; - } - export interface LinearScale extends BaseScale { - /** Specifies the orientation of scale ticks on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - label?: LinearScaleLabel; - /** Specifies the orientation of scale ticks on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - } - export interface dxLinearGaugeOptions extends BaseGaugeOptions { - /** Specifies the options required to set the geometry of the dxLinearGauge widget. */ - geometry?: { - /** Indicates whether to display the dxLinearGauge widget vertically or horizontally. */ - orientation?: string; - }; - /** Specifies gauge range container options. */ - rangeContainer?: LinearRangeContainer; - scale?: LinearScale; - } - /** A widget that represents a gauge with a linear scale. */ - export class dxLinearGauge extends dxBaseGauge { - constructor(element: JQuery, options?: dxLinearGaugeOptions); - constructor(element: Element, options?: dxLinearGaugeOptions); - } - export interface CircularRangeContainer extends BaseRangeContainer { - /** Specifies the orientation of the range container in the dxCircularGauge widget. */ - orientation?: string; - /** Specifies the range container's width in pixels. */ - width?: number; - } - export interface CircularScaleLabel extends BaseScaleLabel { - /** Specifies the spacing between scale labels and ticks. */ - indentFromTick?: number; - } - export interface CircularScale extends BaseScale { - label?: CircularScaleLabel; - /** Specifies the orientation of scale ticks. */ - orientation?: string; - } - export interface dxCircularGaugeOptions extends BaseGaugeOptions { - /** Specifies the options required to set the geometry of the dxCircularGauge widget. */ - geometry?: { - /** Specifies the end angle of the circular gauge's arc. */ - endAngle?: number; - /** Specifies the start angle of the circular gauge's arc. */ - startAngle?: number; - }; - /** Specifies gauge range container options. */ - rangeContainer?: CircularRangeContainer; - scale?: CircularScale; - } - /** A widget that represents a gauge with a circular scale. */ - export class dxCircularGauge extends dxBaseGauge { - constructor(element: JQuery, options?: dxCircularGaugeOptions); - constructor(element: Element, options?: dxCircularGaugeOptions); - } - export interface dxBarGaugeOptions extends viz.core.BaseWidgetOptions, SharedGaugeOptions { - /** Specifies a color for the remaining segment of the bar's track. */ - backgroundColor?: string; - /** Specifies a distance between bars in pixels. */ - barSpacing?: number; - /** Specifies a base value for bars. */ - baseValue?: number; - /** Specifies an end value for the gauge's invisible scale. */ - endValue?: number; - /** Defines the shape of the gauge's arc. */ - geometry?: { - /** Specifies the end angle of the bar gauge's arc. */ - endAngle?: number; - /** Specifies the start angle of the bar gauge's arc. */ - startAngle?: number; - }; - /** Specifies the options of the labels that accompany gauge bars. */ - label?: { - /** Specifies a color for the label connector text. */ - connectorColor?: string; - /** Specifies the width of the label connector in pixels. */ - connectorWidth?: number; - /** Specifies a callback function that returns a text for labels. */ - customizeText?: (barValue: { value: number; valueText: string }) => string; - /** Specifies font options for bar labels. */ - font?: viz.core.Font; - /** Specifies a format for bar labels. */ - format?: string; - /** Specifies the distance between the upper bar and bar labels in pixels. */ - indent?: number; - /** Specifies a precision for the formatted value displayed by labels. */ - precision?: number; - /** Specifies whether bar labels appear on a gauge or not. */ - visible?: boolean; - }; - /** Sets the name of the palette or an array of colors to be used for coloring the gauge range container. */ - palette?: string; - /** Defines the radius of the bar that is closest to the center relatively to the radius of the topmost bar. */ - relativeInnerRadius?: number; - /** Specifies a start value for the gauge's invisible scale. */ - startValue?: number; - /** Specifies the array of values to be indicated on a bar gauge. */ - values?: Array; - } - /** A circular bar widget. */ - export class dxBarGauge extends viz.core.BaseWidget { - constructor(element: JQuery, options?: dxBarGaugeOptions); - constructor(element: Element, options?: dxBarGaugeOptions); - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws the widget. */ - render(): void; - /** Returns an array of gauge values. */ - values(): Array; - /** Updates the values displayed by a gauge. */ - values(values: Array): void; - } -} -declare namespace DevExpress.viz.map { - /** This section describes the fields and methods that can be used in code to manipulate the Area object. */ - export interface Area { - /** Contains the element type. */ - type: string; - /** Return the value of an attribute. */ - attribute(name: string): any; - /** Provides information about the selection state of an area. */ - selected(): boolean; - /** Sets a new selection state for an area. */ - selected(state: boolean): void; - /** Applies the area settings specified as a parameter and updates the area appearance. */ - applySettings(settings: any): void; - } - /** This section describes the fields and methods that can be used in code to manipulate the Markers object. */ - export interface Marker { - /** Contains the descriptive text accompanying the map marker. */ - text: string; - /** Contains the type of the element. */ - type: string; - /** Contains the URL of an image map marker. */ - url: string; - /** Contains the value of a bubble map marker. */ - value: number; - /** Contains the values of a pie map marker. */ - values: Array; - /** Returns the value of an attribute. */ - attribute(name: string): any; - /** Returns the coordinates of a specific marker. */ - coordinates(): Array; - /** Provides information about the selection state of a marker. */ - selected(): boolean; - /** Sets a new selection state for a marker. */ - selected(state: boolean): void; - /** Applies the marker settings specified as a parameter and updates the marker appearance. */ - applySettings(settings: any): void; - } - export interface AreaSettings { - /** Specifies the width of the area border in pixels. */ - borderWidth?: number; - /** Specifies a color for the area border. */ - borderColor?: string; - click?: any; - /** Specifies a color for an area. */ - color?: string; - /** Specifies the function that customizes each area individually. */ - customize?: (areaInfo: Area) => AreaSettings; - /** Specifies a color for the area border when the area is hovered over. */ - hoveredBorderColor?: string; - /** Specifies the pixel-measured width of the area border when the area is hovered over. */ - hoveredBorderWidth?: number; - /** Specifies a color for an area when this area is hovered over. */ - hoveredColor?: string; - /** Specifies whether or not to change the appearance of an area when it is hovered over. */ - hoverEnabled?: boolean; - /** Configures area labels. */ - label?: { - /** Specifies the data field that provides data for area labels. */ - dataField?: string; - /** Enables area labels. */ - enabled?: boolean; - /** Specifies font options for area labels. */ - font?: viz.core.Font; - }; - /** Specifies the name of the palette or a custom range of colors to be used for coloring a map. */ - palette?: any; - /** Specifies the number of colors in a palette. */ - paletteSize?: number; - /** Allows you to paint areas with similar attributes in the same color. */ - colorGroups?: Array; - /** Specifies the field that provides data to be used for coloring areas. */ - colorGroupingField?: string; - /** Specifies a color for the area border when the area is selected. */ - selectedBorderColor?: string; - /** Specifies a color for an area when this area is selected. */ - selectedColor?: string; - /** Specifies the pixel-measured width of the area border when the area is selected. */ - selectedBorderWidth?: number; - selectionChanged?: (area: Area) => void; - /** Specifies whether single or multiple areas can be selected on a vector map. */ - selectionMode?: string; - } - export interface MarkerSettings { - /** Specifies a color for the marker border. */ - borderColor?: string; - /** Specifies the width of the marker border in pixels. */ - borderWidth?: number; - click?: any; - /** Specifies a color for a marker of the dot or bubble type. */ - color?: string; - /** Specifies the function that customizes each marker individually. */ - customize?: (markerInfo: Marker) => MarkerSettings; - font?: Object; - /** Specifies the pixel-measured width of the marker border when the marker is hovered over. */ - hoveredBorderWidth?: number; - /** Specifies a color for the marker border when the marker is hovered over. */ - hoveredBorderColor?: string; - /** Specifies a color for a marker of the dot or bubble type when this marker is hovered over. */ - hoveredColor?: string; - /** Specifies whether or not to change the appearance of a marker when it is hovered over. */ - hoverEnabled?: boolean; - /** Specifies marker label options. */ - label?: { - /** Enables marker labels. */ - enabled?: boolean; - /** Specifies font options for marker labels. */ - font?: viz.core.Font; - }; - /** Specifies the pixel-measured diameter of the marker that represents the biggest value. Setting this option makes sense only if you use markers of the bubble type. */ - maxSize?: number; - /** Specifies the pixel-measured diameter of the marker that represents the smallest value. Setting this option makes sense only if you use markers of the bubble type. */ - minSize?: number; - /** Specifies the opacity of markers. Setting this option makes sense only if you use markers of the bubble type. */ - opacity?: number; - /** Specifies the pixel-measured width of the marker border when the marker is selected. */ - selectedBorderWidth?: number; - /** Specifies a color for the marker border when the marker is selected. */ - selectedBorderColor?: string; - /** Specifies a color for a marker of the dot or bubble type when this marker is selected. */ - selectedColor?: string; - selectionChanged?: (marker: Marker) => void; - /** Specifies whether a single or multiple markers can be selected on a vector map. */ - selectionMode?: string; - /** Specifies the size of markers. Setting this option makes sense for any type of marker except bubble. */ - size?: number; - /** Specifies the type of markers to be used on the map. */ - type?: string; - /** Specifies the name of a palette or a custom set of colors to be used for coloring markers of the pie type. */ - palette?: any; - /** Allows you to paint markers with similar attributes in the same color. */ - colorGroups?: Array; - /** Specifies the field that provides data to be used for coloring markers. */ - colorGroupingField?: string; - /** Allows you to display bubbles with similar attributes in the same size. */ - sizeGroups?: Array; - /** Specifies the field that provides data to be used for sizing bubble markers. */ - sizeGroupingField?: string; - } - export interface dxVectorMapOptions extends viz.core.BaseWidgetOptions { - /** An object specifying options for the map areas. */ - areaSettings?: AreaSettings; - /** Specifies the options for the map background. */ - background?: { - /** Specifies a color for the background border. */ - borderColor?: string; - /** Specifies a color for the background. */ - color?: string; - }; - /** Specifies the positioning of a map in geographical coordinates. */ - bounds?: Array; - /** Specifies the options of the control bar. */ - controlBar?: { - /** Specifies a color for the outline of the control bar elements. */ - borderColor?: string; - /** Specifies a color for the inner area of the control bar elements. */ - color?: string; - /** Specifies whether or not to display the control bar. */ - enabled?: boolean; - /** Specifies the margin of the control bar in pixels. */ - margin?: number; - /** Specifies the position of the control bar. */ - horizontalAlignment?: string; - /** Specifies the position of the control bar. */ - verticalAlignment?: string; - /** Specifies the opacity of the Control_Bar. */ - opacity?: number; - }; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies a data source for the map area. */ - mapData?: any; - /** Specifies a data source for the map markers. */ - markers?: any; - /** An object specifying options for the map markers. */ - markerSettings?: MarkerSettings; - /** Specifies the size of the dxVectorMap widget. */ - size?: viz.core.Size; - /** Specifies tooltip options. */ - tooltip?: viz.core.Tooltip; - /** Configures map legends. */ - legends?: Array; - /** Specifies whether or not the map should respond when a user rolls the mouse wheel. */ - wheelEnabled?: boolean; - /** Specifies whether the map should respond to touch gestures. */ - touchEnabled?: boolean; - /** Disables the zooming capability. */ - zoomingEnabled?: boolean; - /** Specifies the geographical coordinates of the center for a map. */ - center?: Array; - centerChanged?: (center: Array) => void; - /** A handler for the centerChanged event. */ - onCenterChanged?: (e: { - center: Array; - component: dxVectorMap; - element: Element; - }) => void; - /** Specifies a number that is used to zoom a map initially. */ - zoomFactor?: number; - /** Specifies a map's maximum zoom factor. */ - maxZoomFactor?: number; - zoomFactorChanged?: (zoomFactor: number) => void; - /** A handler for the zoomFactorChanged event. */ - onZoomFactorChanged?: (e: { - zoomFactor: number; - component: dxVectorMap; - element: Element; - }) => void; - click?: any; - /** A handler for the click event. */ - onClick?: any; - /** A handler for the areaClick event. */ - onAreaClick?: any; - /** A handler for the areaSelectionChanged event. */ - onAreaSelectionChanged?: (e: { - target: Area; - component: dxVectorMap; - element: Element; - }) => void; - /** A handler for the markerClick event. */ - onMarkerClick?: any; - /** A handler for the markerSelectionChanged event. */ - onMarkerSelectionChanged?: (e: { - target: Marker; - component: dxVectorMap; - element: Element; - }) => void; - /** Disables the panning capability. */ - panningEnabled?: boolean; - } - export interface Legend extends viz.core.BaseLegend { - /** Specifies text for legend items. */ - customizeText?: (itemInfo: { start: number; end: number; index: number; color: string; size: number; }) => string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the text of a legend item. */ - customizeHint?: (itemInfo: { start: number; end: number; index: number; color: string; size: number }) => string; - /** Specifies the source of data for the legend. */ - source?: string; - } - /** A vector map widget. */ - export class dxVectorMap extends viz.core.BaseWidget { - constructor(element: JQuery, options?: dxVectorMapOptions); - constructor(element: Element, options?: dxVectorMapOptions); - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(): void; - /** Gets the current coordinates of the map center. */ - center(): Array; - /** Sets the coordinates of the map center. */ - center(centerCoordinates: Array): void; - /** Deselects all the selected areas on a map. The areas are displayed in their initial style after. */ - clearAreaSelection(): void; - /** Deselects all the selected markers on a map. The markers are displayed in their initial style after. */ - clearMarkerSelection(): void; - /** Deselects all the selected area and markers on a map at once. The areas and markers are displayed in their initial style after. */ - clearSelection(): void; - /** Converts client area coordinates into map coordinates. */ - convertCoordinates(x: number, y: number): Array; - /** Returns an array with all the map areas. */ - getAreas(): Array; - /** Returns an array with all the map markers. */ - getMarkers(): Array; - /** Gets the current coordinates of the map viewport. */ - viewport(): Array; - /** Sets the coordinates of the map viewport. */ - viewport(viewportCoordinates: Array): void; - /** Gets the current value of the map zoom factor. */ - zoomFactor(): number; - /** Sets the value of the map zoom factor. */ - zoomFactor(zoomFactor: number): void; - } -} -declare namespace DevExpress.viz.rangeSelector { - export interface dxRangeSelectorOptions extends viz.core.BaseWidgetOptions { - /** Specifies the options for the range selector's background. */ - background?: { - /** Specifies the background color for the dxRangeSelector. */ - color?: string; - /** Specifies image options. */ - image?: { - /** Specifies a location for the image in the background of a range selector. */ - location?: string; - /** Specifies the image's URL. */ - url?: string; - }; - /** Indicates whether or not the background (background color and/or image) is visible. */ - visible?: boolean; - }; - /** Specifies the dxRangeSelector's behavior options. */ - behavior?: { - /** Indicates whether or not you can swap sliders. */ - allowSlidersSwap?: boolean; - /** -Indicates whether or not animation is enabled. - */ - animationEnabled?: boolean; - /** Specifies when to call the onSelectedRangeChanged function. */ - callSelectedRangeChanged?: string; - /** Indicates whether or not an end user can specify the range using a mouse, without the use of sliders. */ - manualRangeSelectionEnabled?: boolean; - /** Indicates whether or not an end user can shift the selected range to the required location on a scale by clicking. */ - moveSelectedRangeByClick?: boolean; - /** Indicates whether to snap a slider to ticks. */ - snapToTicks?: boolean; - }; - /** Specifies the options required to display a chart as the range selector's background. */ - chart?: { - /** Specifies a coefficient for determining an indent from the bottom background boundary to the lowest chart point. */ - bottomIndent?: number; - /** An object defining the common configuration options for the chart’s series. */ - commonSeriesSettings?: viz.charts.CommonSeriesSettings; - /** An object providing options for managing data from a data source. */ - dataPrepareSettings?: { - /** Specifies whether or not to validate values from a data source. */ - checkTypeForAllData?: boolean; - /** Specifies whether or not to convert the values from a data source into the data type of an axis. */ - convertToAxisDataType?: boolean; - /** Specifies how to sort series points. */ - sortingMethod?: any; - }; - /** Specifies a value indicating whether all bars in a series must have the same width, or may have different widths if any points in other series are missing. */ - equalBarWidth?: any; - /** An object defining the chart’s series. */ - series?: Array; - /** Defines options for the series template. */ - seriesTemplate?: viz.charts.SeriesTemplate; - /** Specifies a coefficient for determining an indent from the background's top boundary to the topmost chart point. */ - topIndent?: number; - /** Specifies whether or not to filter the series points depending on their quantity. */ - useAggregation?: boolean; - /** Specifies options for the chart's value axis. */ - valueAxis?: { - /** Indicates whether or not the chart's value axis must be inverted. */ - inverted?: boolean; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic value axis. */ - logarithmBase?: number; - /** Specifies the maximum value of the chart's value axis. */ - max?: number; - /** Specifies the minimum value of the chart's value axis. */ - min?: number; - /** Specifies the type of the value axis. */ - type?: string; - /** Specifies the desired type of axis values. */ - valueType?: string; - }; - }; - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** Specifies a data source for the scale values and for the chart at the background. */ - dataSource?: any; - /** Specifies the data source field that provides data for the scale. */ - dataSourceField?: string; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies the blank space in pixels between the dxRangeSelector widget's extreme elements and the boundaries of the area provided for the widget (see size). */ - margin?: viz.core.Margins; - /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */ - redrawOnResize?: boolean; - /** Specifies options of the range selector's scale. */ - scale?: { - /** Specifies the scale's end value. */ - endValue?: any; - /** Specifies common options for scale labels. */ - label?: { - /** Specifies a callback function that returns the text to be displayed in scale labels. */ - customizeText?: (scaleValue: { value: any; valueText: string; }) => string; - /** Specifies font options for the text displayed in the range selector's scale labels. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in scale labels. */ - format?: string; - /** Specifies a precision for the formatted value displayed in the scale labels. */ - precision?: number; - /** Specifies a spacing between scale labels and the background bottom edge. */ - topIndent?: number; - /** Specifies whether or not the scale's labels are visible. */ - visible?: boolean; - }; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic scale. */ - logarithmBase?: number; - /** Specifies an interval between major ticks. */ - majorTickInterval?: any; - /** Specifies options for the date-time scale's markers. */ - marker?: { - /** Defines the options that can be set for the text that is displayed by the scale markers. */ - label?: { - /** Specifies a callback function that returns the text to be displayed in scale markers. */ - customizeText?: (markerValue: { value: any; valueText: string }) => string; - /** Specifies a format for the text displayed in scale markers. */ - format?: string; - }; - /** Specifies the height of the marker's separator. */ - separatorHeight?: number; - /** Specifies the space between the marker label and the marker separator. */ - textLeftIndent?: number; - /** Specifies the space between the marker's label and the top edge of the marker's separator. */ - textTopIndent?: number; - /** Specified the indent between the marker and the scale lables. */ - topIndent?: number; - /** Indicates whether scale markers are visible. */ - visible?: boolean; - }; - /** Specifies the maximum range that can be selected. */ - maxRange?: any; - /** Specifies the number of minor ticks between neighboring major ticks. */ - minorTickCount?: number; - /** -Specifies an interval between minor ticks. - */ - minorTickInterval?: any; - /** Specifies the minimum range that can be selected. */ - minRange?: any; - /** Specifies the height of the space reserved for the scale in pixels. */ - placeholderHeight?: number; - /** Indicates whether or not to set ticks of a date-time scale at the beginning of each date-time interval. */ - setTicksAtUnitBeginning?: boolean; - /** Specifies whether or not to show ticks for the boundary scale values, when neither major ticks nor minor ticks are created for these values. */ - showCustomBoundaryTicks?: boolean; - /** Indicates whether or not to show minor ticks on the scale. */ - showMinorTicks?: boolean; - /** Specifies the scale's start value. */ - startValue?: any; - /** Specifies options defining the appearance of scale ticks. */ - tick?: { - /** Specifies the color of scale ticks (both major and minor ticks). */ - color?: string; - /** Specifies the opacity of scale ticks (both major and minor ticks). */ - opacity?: number; - /** Specifies the width of the scale's ticks (both major and minor ticks). */ - width?: number; - }; - /** Specifies the type of the scale. */ - type?: string; - /** Specifies whether or not to expand the current tick interval if labels overlap each other. */ - useTicksAutoArrangement?: boolean; - /** Specifies the type of values on the scale. */ - valueType?: string; - /** Specifies the order of arguments on a discrete scale. */ - categories?: Array; - }; - /** Specifies the range to be selected when displaying the dxRangeSelector. */ - selectedRange?: { - /** Specifies the start value of the range to be selected when displaying the dxRangeSelector widget on a page. */ - startValue?: any; - /** Specifies the end value of the range to be selected when displaying the dxRangeSelector widget on a page. */ - endValue?: any; - }; - /** Specifies the color of the selected range. */ - selectedRangeColor?: string; - /** Range selector's indent options. */ - indent?: { - /** Specifies range selector's left indent. */ - left?: number; - /** Specifies range selector's right indent. */ - right?: number; - }; - selectedRangeChanged?: (selectedRange: { startValue: any; endValue: any; }) => void; - /** A handler for the selectedRangeChanged event. */ - onSelectedRangeChanged?: (e: { - startValue: any; - endValue: any; - component: dxRangeSelector; - element: Element; - }) => void; - /** Specifies range selector shutter options. */ - shutter?: { - /** Specifies shutter color. */ - color?: string; - /** Specifies the opacity of the color of shutters. */ - opacity?: number; - }; - /** Specifies in pixels the size of the dxRangeSelector widget. */ - size?: viz.core.Size; - /** Specifies the appearance of the range selector's slider handles. */ - sliderHandle?: { - /** Specifies the color of the slider handles. */ - color?: string; - /** Specifies the opacity of the slider handles. */ - opacity?: number; - /** Specifies the width of the slider handles. */ - width?: number; - }; - /** Defines the options of the range selector slider markers. */ - sliderMarker?: { - /** Specifies the color of the slider markers. */ - color?: string; - /** Specifies a callback function that returns the text to be displayed by slider markers. */ - customizeText?: (scaleValue: { value: any; valueText: any; }) => string; - /** Specifies font options for the text displayed by the range selector slider markers. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in slider markers. */ - format?: string; - /** Specifies the color used for the slider marker text when the currently selected range does not match the minRange and maxRange values. */ - invalidRangeColor?: string; - /** - * Specifies the empty space between the marker's border and the marker’s text. - * @deprecated Use the 'paddingTopBottom' and 'paddingLeftRight' options instead - */ - padding?: number; - /** Specifies the empty space between the marker's top and bottom borders and the marker's text. */ - paddingTopBottom?: number; - /** Specifies the empty space between the marker's left and right borders and the marker's text. */ - paddingLeftRight?: number; - /** Specifies the placeholder height of the slider marker. */ - placeholderHeight?: number; - /** - * Specifies in pixels the height and width of the space reserved for the range selector slider markers. - * @deprecated Use the 'placeholderHeight' and 'indent' options instead - */ - placeholderSize?: { - /** Specifies the height of the placeholder for the left and right slider markers. */ - height?: number; - /** Specifies the width of the placeholder for the left and right slider markers. */ - width?: { - /** Specifies the width of the left slider marker's placeholder. */ - left?: number; - /** Specifies the width of the right slider marker's placeholder. */ - right?: number; - }; - }; - /** Specifies a precision for the formatted value displayed in slider markers. */ - precision?: number; - /** Indicates whether or not the slider markers are visible. */ - visible?: boolean; - }; - } - /** A widget that allows end users to select a range of values on a scale. */ - export class dxRangeSelector extends viz.core.BaseWidget { - constructor(element: JQuery, options?: dxRangeSelectorOptions); - constructor(element: Element, options?: dxRangeSelectorOptions); - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(skipChartAnimation?: boolean): void; - /** Returns the currently selected range. */ - getSelectedRange(): { startValue: any; endValue: any; }; - /** Sets a specified range. */ - setSelectedRange(selectedRange: { startValue: any; endValue: any; }): void; - } -} -declare namespace DevExpress.viz.sparklines { - export interface SparklineTooltip extends viz.core.Tooltip { - /** - * Specifies how a tooltip is horizontally aligned relative to the graph. - * @deprecated Tooltip alignment is no more available. - */ - horizontalAlignment?: string; - /** - * Specifies how a tooltip is vertically aligned relative to the graph. - * @deprecated Tooltip alignment is no more available. - */ - verticalAlignment?: string; - } - export interface BaseSparklineOptions extends viz.core.BaseWidgetOptions { - /** Specifies the blank space between the widget's extreme elements and the boundaries of the area provided for the widget in pixels. */ - margin?: viz.core.Margins; - /** Specifies the size of the widget. */ - size?: viz.core.Size; - /** Specifies tooltip options. */ - tooltip?: SparklineTooltip; - } - /** Overridden by descriptions for particular widgets. */ - export class BaseSparkline extends viz.core.BaseWidget { - /** Redraws a widget. */ - render(): void; - } - export interface dxBulletOptions extends BaseSparkline { - /** Specifies a color for the bullet bar. */ - color?: string; - /** Specifies an end value for the invisible scale. */ - endScaleValue?: number; - /** Specifies whether or not to show the target line. */ - showTarget?: boolean; - /** Specifies whether or not to show the line indicating zero on the invisible scale. */ - showZeroLevel?: boolean; - /** Specifies a start value for the invisible scale. */ - startScaleValue?: number; - /** Specifies the value indicated by the target line. */ - target?: number; - /** Specifies a color for both the target and zero level lines. */ - targetColor?: string; - /** Specifies the width of the target line. */ - targetWidth?: number; - /** Specifies the primary value indicated by the bullet bar. */ - value?: number; - } - /** A bullet graph widget. */ - export class dxBullet extends BaseSparkline { - constructor(element: JQuery, options?: dxBulletOptions); - constructor(element: Element, options?: dxBulletOptions); - } - export interface dxSparklineOptions extends BaseSparklineOptions { - /** Specifies the data source field that provides arguments for a sparkline. */ - argumentField?: string; - /** Sets a color for the bars indicating negative values. Available for a sparkline of the bar type only. */ - barNegativeColor?: string; - /** Sets a color for the bars indicating positive values. Available for a sparkline of the bar type only. */ - barPositiveColor?: string; - /** Specifies a data source for the sparkline. */ - dataSource?: Array; - /** Sets a color for the boundary of both the first and last points on a sparkline. */ - firstLastColor?: string; - /** Specifies whether a sparkline ignores null data points or not. */ - ignoreEmptyPoints?: boolean; - /** Sets a color for a line on a sparkline. Available for the sparklines of the line- and area-like types. */ - lineColor?: string; - /** Specifies a width for a line on a sparkline. Available for the sparklines of the line- and area-like types. */ - lineWidth?: number; - /** Sets a color for the bars indicating the values that are less than the winloss threshold. Available for a sparkline of the winloss type only. */ - lossColor?: string; - /** Sets a color for the boundary of the maximum point on a sparkline. */ - maxColor?: string; - /** Sets a color for the boundary of the minimum point on a sparkline. */ - minColor?: string; - /** Sets a color for points on a sparkline. Available for the sparklines of the line- and area-like types. */ - pointColor?: string; - /** Specifies the diameter of sparkline points in pixels. Available for the sparklines of line- and area-like types. */ - pointSize?: number; - /** Specifies a symbol to use as a point marker on a sparkline. Available for the sparklines of the line- and area-like types. */ - pointSymbol?: string; - /** Specifies whether or not to indicate both the first and last values on a sparkline. */ - showFirstLast?: boolean; - /** Specifies whether or not to indicate both the minimum and maximum values on a sparkline. */ - showMinMax?: boolean; - /** Determines the type of a sparkline. */ - type?: string; - /** Specifies the data source field that provides values for a sparkline. */ - valueField?: string; - /** Sets a color for the bars indicating the values greater than a winloss threshold. Available for a sparkline of the winloss type only. */ - winColor?: string; - /** Specifies a value that serves as a threshold for the sparkline of the winloss type. */ - winlossThreshold?: number; - /** Specifies the minimum value of the sparkline value axis. */ - minValue?: number; - /** Specifies the maximum value of the sparkline's value axis. */ - maxValue?: number; - } - /** A sparkline widget. */ - export class dxSparkline extends BaseSparkline { - constructor(element: JQuery, options?: dxSparklineOptions); - constructor(element: Element, options?: dxSparklineOptions); - } -} -interface JQuery { - dxProgressBar(): JQuery; - dxProgressBar(options: "instance"): DevExpress.ui.dxProgressBar; - dxProgressBar(options: string): any; - dxProgressBar(options: string, ...params: any[]): any; - dxProgressBar(options: DevExpress.ui.dxProgressBarOptions): JQuery; - dxSlider(): JQuery; - dxSlider(options: "instance"): DevExpress.ui.dxSlider; - dxSlider(options: string): any; - dxSlider(options: string, ...params: any[]): any; - dxSlider(options: DevExpress.ui.dxSliderOptions): JQuery; - dxRangeSlider(): JQuery; - dxRangeSlider(options: "instance"): DevExpress.ui.dxRangeSlider; - dxRangeSlider(options: string): any; - dxRangeSlider(options: string, ...params: any[]): any; - dxRangeSlider(options: DevExpress.ui.dxRangeSliderOptions): JQuery; - dxFileUploader(): JQuery; - dxFileUploader(options: "instance"): DevExpress.ui.dxFileUploader; - dxFileUploader(options: string): any; - dxFileUploader(options: string, ...params: any[]): any; - dxFileUploader(options: DevExpress.ui.dxFileUploaderOptions): JQuery; - dxValidator(): JQuery; - dxValidator(options: "instance"): DevExpress.ui.dxValidator; - dxValidator(options: string): any; - dxValidator(options: string, ...params: any[]): any; - dxValidationGroup(): JQuery; - dxValidationGroup(options: "instance"): DevExpress.ui.dxValidationGroup; - dxValidationGroup(options: string): any; - dxValidationGroup(options: string, ...params: any[]): any; - dxValidationSummary(): JQuery; - dxValidationSummary(options: "instance"): DevExpress.ui.dxValidationSummary; - dxValidationSummary(options: string): any; - dxValidationSummary(options: string, ...params: any[]): any; - dxTooltip(): JQuery; - dxTooltip(options: "instance"): DevExpress.ui.dxTooltip; - dxTooltip(options: string): any; - dxTooltip(options: string, ...params: any[]): any; - dxTooltip(options: DevExpress.ui.dxTooltipOptions): JQuery; - dxDropDownList(): JQuery; - dxDropDownList(options: "instance"): DevExpress.ui.dxDropDownList; - dxDropDownList(options: string): any; - dxDropDownList(options: string, ...params: any[]): any; - dxDropDownList(options: DevExpress.ui.dxDropDownListOptions): JQuery; - dxToolbar(): JQuery; - dxToolbar(options: "instance"): DevExpress.ui.dxToolbar; - dxToolbar(options: string): any; - dxToolbar(options: string, ...params: any[]): any; - dxToolbar(options: DevExpress.ui.dxToolbarOptions): JQuery; - dxToast(): JQuery; - dxToast(options: "instance"): DevExpress.ui.dxToast; - dxToast(options: string): any; - dxToast(options: string, ...params: any[]): any; - dxToast(options: DevExpress.ui.dxToastOptions): JQuery; - dxTextEditor(): JQuery; - dxTextEditor(options: "instance"): DevExpress.ui.dxTextEditor; - dxTextEditor(options: string): any; - dxTextEditor(options: string, ...params: any[]): any; - dxTextEditor(options: DevExpress.ui.dxTextEditorOptions): JQuery; - dxTextBox(): JQuery; - dxTextBox(options: "instance"): DevExpress.ui.dxTextBox; - dxTextBox(options: string): any; - dxTextBox(options: string, ...params: any[]): any; - dxTextBox(options: DevExpress.ui.dxTextBoxOptions): JQuery; - dxTextArea(): JQuery; - dxTextArea(options: "instance"): DevExpress.ui.dxTextArea; - dxTextArea(options: string): any; - dxTextArea(options: string, ...params: any[]): any; - dxTextArea(options: DevExpress.ui.dxTextAreaOptions): JQuery; - dxTabs(): JQuery; - dxTabs(options: "instance"): DevExpress.ui.dxTabs; - dxTabs(options: string): any; - dxTabs(options: string, ...params: any[]): any; - dxTabs(options: DevExpress.ui.dxTabsOptions): JQuery; - dxTabPanel(): JQuery; - dxTabPanel(options: "instance"): DevExpress.ui.dxTabPanel; - dxTabPanel(options: string): any; - dxTabPanel(options: string, ...params: any[]): any; - dxTabPanel(options: DevExpress.ui.dxTabPanelOptions): JQuery; - dxSelectBox(): JQuery; - dxSelectBox(options: "instance"): DevExpress.ui.dxSelectBox; - dxSelectBox(options: string): any; - dxSelectBox(options: string, ...params: any[]): any; - dxSelectBox(options: DevExpress.ui.dxSelectBoxOptions): JQuery; - dxScrollView(): JQuery; - dxScrollView(options: "instance"): DevExpress.ui.dxScrollView; - dxScrollView(options: string): any; - dxScrollView(options: string, ...params: any[]): any; - dxScrollView(options: DevExpress.ui.dxScrollViewOptions): JQuery; - dxScrollable(): JQuery; - dxScrollable(options: "instance"): DevExpress.ui.dxScrollable; - dxScrollable(options: string): any; - dxScrollable(options: string, ...params: any[]): any; - dxScrollable(options: DevExpress.ui.dxScrollableOptions): JQuery; - dxRadioGroup(): JQuery; - dxRadioGroup(options: "instance"): DevExpress.ui.dxRadioGroup; - dxRadioGroup(options: string): any; - dxRadioGroup(options: string, ...params: any[]): any; - dxRadioGroup(options: DevExpress.ui.dxRadioGroupOptions): JQuery; - dxPopup(): JQuery; - dxPopup(options: "instance"): DevExpress.ui.dxPopup; - dxPopup(options: string): any; - dxPopup(options: string, ...params: any[]): any; - dxPopup(options: DevExpress.ui.dxPopupOptions): JQuery; - dxPopover(): JQuery; - dxPopover(options: "instance"): DevExpress.ui.dxPopover; - dxPopover(options: string): any; - dxPopover(options: string, ...params: any[]): any; - dxPopover(options: DevExpress.ui.dxPopoverOptions): JQuery; - dxOverlay(): JQuery; - dxOverlay(options: "instance"): DevExpress.ui.dxOverlay; - dxOverlay(options: string): any; - dxOverlay(options: string, ...params: any[]): any; - dxOverlay(options: DevExpress.ui.dxOverlayOptions): JQuery; - dxNumberBox(): JQuery; - dxNumberBox(options: "instance"): DevExpress.ui.dxNumberBox; - dxNumberBox(options: string): any; - dxNumberBox(options: string, ...params: any[]): any; - dxNumberBox(options: DevExpress.ui.dxNumberBoxOptions): JQuery; - dxNavBar(): JQuery; - dxNavBar(options: "instance"): DevExpress.ui.dxNavBar; - dxNavBar(options: string): any; - dxNavBar(options: string, ...params: any[]): any; - dxNavBar(options: DevExpress.ui.dxNavBarOptions): JQuery; - dxMultiView(): JQuery; - dxMultiView(options: "instance"): DevExpress.ui.dxMultiView; - dxMultiView(options: string): any; - dxMultiView(options: string, ...params: any[]): any; - dxMultiView(options: DevExpress.ui.dxMultiViewOptions): JQuery; - dxMap(): JQuery; - dxMap(options: "instance"): DevExpress.ui.dxMap; - dxMap(options: string): any; - dxMap(options: string, ...params: any[]): any; - dxMap(options: DevExpress.ui.dxMapOptions): JQuery; - dxLookup(): JQuery; - dxLookup(options: "instance"): DevExpress.ui.dxLookup; - dxLookup(options: string): any; - dxLookup(options: string, ...params: any[]): any; - dxLookup(options: DevExpress.ui.dxLookupOptions): JQuery; - dxLoadPanel(): JQuery; - dxLoadPanel(options: "instance"): DevExpress.ui.dxLoadPanel; - dxLoadPanel(options: string): any; - dxLoadPanel(options: string, ...params: any[]): any; - dxLoadPanel(options: DevExpress.ui.dxLoadPanelOptions): JQuery; - dxLoadIndicator(): JQuery; - dxLoadIndicator(options: "instance"): DevExpress.ui.dxLoadIndicator; - dxLoadIndicator(options: string): any; - dxLoadIndicator(options: string, ...params: any[]): any; - dxLoadIndicator(options: DevExpress.ui.dxLoadIndicatorOptions): JQuery; - dxList(): JQuery; - dxList(options: "instance"): DevExpress.ui.dxList; - dxList(options: string): any; - dxList(options: string, ...params: any[]): any; - dxList(options: DevExpress.ui.dxListOptions): JQuery; - dxGallery(): JQuery; - dxGallery(options: "instance"): DevExpress.ui.dxGallery; - dxGallery(options: string): any; - dxGallery(options: string, ...params: any[]): any; - dxGallery(options: DevExpress.ui.dxGalleryOptions): JQuery; - dxDropDownEditor(): JQuery; - dxDropDownEditor(options: "instance"): DevExpress.ui.dxDropDownEditor; - dxDropDownEditor(options: string): any; - dxDropDownEditor(options: string, ...params: any[]): any; - dxDropDownEditor(options: DevExpress.ui.dxDropDownEditorOptions): JQuery; - dxDateBox(): JQuery; - dxDateBox(options: "instance"): DevExpress.ui.dxDateBox; - dxDateBox(options: string): any; - dxDateBox(options: string, ...params: any[]): any; - dxDateBox(options: DevExpress.ui.dxDateBoxOptions): JQuery; - dxCheckBox(): JQuery; - dxCheckBox(options: "instance"): DevExpress.ui.dxCheckBox; - dxCheckBox(options: string): any; - dxCheckBox(options: string, ...params: any[]): any; - dxCheckBox(options: DevExpress.ui.dxCheckBoxOptions): JQuery; - dxBox(): JQuery; - dxBox(options: "instance"): DevExpress.ui.dxBox; - dxBox(options: string): any; - dxBox(options: string, ...params: any[]): any; - dxBox(options: DevExpress.ui.dxBoxOptions): JQuery; - dxButton(): JQuery; - dxButton(options: "instance"): DevExpress.ui.dxButton; - dxButton(options: string): any; - dxButton(options: string, ...params: any[]): any; - dxButton(options: DevExpress.ui.dxButtonOptions): JQuery; - dxCalendar(): JQuery; - dxCalendar(options: "instance"): DevExpress.ui.dxCalendar; - dxCalendar(options: string): any; - dxCalendar(options: string, ...params: any[]): any; - dxCalendar(options: DevExpress.ui.dxCalendarOptions): JQuery; - dxAccordion(): JQuery; - dxAccordion(options: "instance"): DevExpress.ui.dxAccordion; - dxAccordion(options: string): any; - dxAccordion(options: string, ...params: any[]): any; - dxAccordion(options: DevExpress.ui.dxAccordionOptions): JQuery; - dxAutocomplete(): JQuery; - dxAutocomplete(options: "instance"): DevExpress.ui.dxAutocomplete; - dxAutocomplete(options: string): any; - dxAutocomplete(options: string, ...params: any[]): any; - dxAutocomplete(options: DevExpress.ui.dxAutocompleteOptions): JQuery; - dxTileView(): JQuery; - dxTileView(options: "instance"): DevExpress.ui.dxTileView; - dxTileView(options: string): any; - dxTileView(options: string, ...params: any[]): any; - dxTileView(options: DevExpress.ui.dxTileViewOptions): JQuery; - dxSwitch(): JQuery; - dxSwitch(options: "instance"): DevExpress.ui.dxSwitch; - dxSwitch(options: string): any; - dxSwitch(options: string, ...params: any[]): any; - dxSwitch(options: DevExpress.ui.dxSwitchOptions): JQuery; - dxSlideOut(): JQuery; - dxSlideOut(options: "instance"): DevExpress.ui.dxSlideOut; - dxSlideOut(options: string): any; - dxSlideOut(options: string, ...params: any[]): any; - dxSlideOut(options: DevExpress.ui.dxSlideOutOptions): JQuery; - dxPivot(): JQuery; - dxPivot(options: "instance"): DevExpress.ui.dxPivot; - dxPivot(options: string): any; - dxPivot(options: string, ...params: any[]): any; - dxPivot(options: DevExpress.ui.dxPivotOptions): JQuery; - dxPanorama(): JQuery; - dxPanorama(options: "instance"): DevExpress.ui.dxPanorama; - dxPanorama(options: string): any; - dxPanorama(options: string, ...params: any[]): any; - dxPanorama(options: DevExpress.ui.dxPanoramaOptions): JQuery; - dxActionSheet(): JQuery; - dxActionSheet(options: "instance"): DevExpress.ui.dxActionSheet; - dxActionSheet(options: string): any; - dxActionSheet(options: string, ...params: any[]): any; - dxActionSheet(options: DevExpress.ui.dxActionSheetOptions): JQuery; - dxDropDownMenu(): JQuery; - dxDropDownMenu(options: "instance"): DevExpress.ui.dxDropDownMenu; - dxDropDownMenu(options: string): any; - dxDropDownMenu(options: string, ...params: any[]): any; - dxDropDownMenu(options: DevExpress.ui.dxDropDownMenuOptions): JQuery; - dxTreeView(): JQuery; - dxTreeView(options: "instance"): DevExpress.ui.dxTreeView; - dxTreeView(options: string): any; - dxTreeView(options: string, ...params: any[]): any; - dxTreeView(options: DevExpress.ui.dxTreeViewOptions): JQuery; - dxMenuBase(): JQuery; - dxMenuBase(options: "instance"): DevExpress.ui.dxMenuBase; - dxMenuBase(options: string): any; - dxMenuBase(options: string, ...params: any[]): any; - dxMenuBase(options: DevExpress.ui.dxMenuBaseOptions): JQuery; - dxMenu(): JQuery; - dxMenu(options: "instance"): DevExpress.ui.dxMenu; - dxMenu(options: string): any; - dxMenu(options: string, ...params: any[]): any; - dxMenu(options: DevExpress.ui.dxMenuOptions): JQuery; - dxContextMenu(): JQuery; - dxContextMenu(options: "instance"): DevExpress.ui.dxContextMenu; - dxContextMenu(options: string): any; - dxContextMenu(options: string, ...params: any[]): any; - dxContextMenu(options: DevExpress.ui.dxContextMenuOptions): JQuery; - dxColorBox(): JQuery; - dxColorBox(options: "instance"): DevExpress.ui.dxColorBox; - dxColorBox(options: string): any; - dxColorBox(options: string, ...params: any[]): any; - dxColorBox(options: DevExpress.ui.dxColorBoxOptions): JQuery; - dxDataGrid(): JQuery; - dxDataGrid(options: "instance"): DevExpress.ui.dxDataGrid; - dxDataGrid(options: string): any; - dxDataGrid(options: string, ...params: any[]): any; - dxDataGrid(options: DevExpress.ui.dxDataGridOptions): JQuery; - dxPivotGrid(): JQuery; - dxPivotGrid(options: "instance"): DevExpress.ui.dxPivotGrid; - dxPivotGrid(options: string): any; - dxPivotGrid(options: string, ...params: any[]): any; - dxPivotGrid(options: DevExpress.ui.dxPivotGridOptions): JQuery; - dxPivotGridFieldChooser(): JQuery; - dxPivotGridFieldChooser(options: "instance"): DevExpress.ui.dxPivotGridFieldChooser; - dxPivotGridFieldChooser(options: string): any; - dxPivotGridFieldChooser(options: string, ...params: any[]): any; - dxPivotGridFieldChooser(options: DevExpress.ui.dxPivotGridFieldChooserOptions): JQuery; - dxScheduler(): JQuery; - dxScheduler(options: "instance"): DevExpress.ui.dxScheduler; - dxScheduler(options: string): any; - dxScheduler(options: string, ...params: any[]): any; - dxScheduler(options: DevExpress.ui.dxSchedulerOptions): JQuery; - dxChart(options?: DevExpress.viz.charts.dxChartOptions): JQuery; - dxChart(methodName: string, ...params: any[]): any; - dxChart(methodName: "instance"): DevExpress.viz.charts.dxChart; - dxPieChart(options?: DevExpress.viz.charts.dxPieChartOptions): JQuery; - dxPieChart(methodName: string, ...params: any[]): any; - dxPieChart(methodName: "instance"): DevExpress.viz.charts.dxPieChart; - dxPolarChart(options?: DevExpress.viz.charts.dxPolarChartOptions): JQuery; - dxPolarChart(methodName: string, ...params: any[]): any; - dxPolarChart(methodName: "instance"): DevExpress.viz.charts.dxPolarChart; - dxLinearGauge(options?: DevExpress.viz.gauges.dxLinearGaugeOptions): JQuery; - dxLinearGauge(methodName: string, ...params: any[]): any; - dxLinearGauge(methodName: "instance"): DevExpress.viz.gauges.dxLinearGauge; - dxCircularGauge(options?: DevExpress.viz.gauges.dxCircularGaugeOptions): JQuery; - dxCircularGauge(methodName: string, ...params: any[]): any; - dxCircularGauge(methodName: "instance"): DevExpress.viz.gauges.dxCircularGauge; - dxBarGauge(options?: DevExpress.viz.gauges.dxBarGaugeOptions): JQuery; - dxBarGauge(methodName: string, ...params: any[]): any; - dxBarGauge(methodName: "instance"): DevExpress.viz.gauges.dxBarGauge; - dxRangeSelector(options?: DevExpress.viz.rangeSelector.dxRangeSelectorOptions): JQuery; - dxRangeSelector(methodName: string, ...params: any[]): any; - dxRangeSelector(methodName: "instance"): DevExpress.viz.rangeSelector.dxRangeSelector; - dxVectorMap(options?: DevExpress.viz.map.dxVectorMapOptions): JQuery; - dxVectorMap(methodName: string, ...params: any[]): any; - dxVectorMap(methodName: "instance"): DevExpress.viz.map.dxVectorMap; - dxBullet(options?: DevExpress.viz.sparklines.dxBulletOptions): JQuery; - dxBullet(methodName: string, ...params: any[]): any; - dxBullet(methodName: "instance"): DevExpress.viz.sparklines.dxBullet; - dxSparkline(options?: DevExpress.viz.sparklines.dxSparklineOptions): JQuery; - dxSparkline(methodName: string, ...params: any[]): any; - dxSparkline(methodName: "instance"): DevExpress.viz.sparklines.dxSparkline; -} diff --git a/devextreme/devextreme-15.1.4.d.ts b/devextreme/devextreme-15.1.4.d.ts deleted file mode 100644 index 9f9ae875ed..0000000000 --- a/devextreme/devextreme-15.1.4.d.ts +++ /dev/null @@ -1,6448 +0,0 @@ -// Type definitions for DevExtreme 15.1.4 -// Project: http://js.devexpress.com/ -// Definitions by: DevExpress Inc. -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -/// - -declare namespace DevExpress { - /** A mixin that provides a capability to fire and subscribe to events. */ - export interface EventsMixin { - /** Subscribes to a specified event. */ - on(eventName: string, eventHandler: Function): T; - /** Subscribes to the specified events. */ - on(events: { [eventName: string]: Function; }): T; - /** Detaches all event handlers from the specified event. */ - off(eventName: string): Object; - /** Detaches a particular event handler from the specified event. */ - off(eventName: string, eventHandler: Function): T; - } - /** An object that serves as a namespace for the methods required to perform validation. */ - export module validationEngine { - export interface IValidator { - validate(): ValidatorValidationResult; - reset(): void; - } - export interface ValidatorValidationResult { - isValid: boolean; - name?: string; - value: any; - brokenRule: any; - validationRules: any[]; - } - export interface ValidationGroupValidationResult { - isValid: boolean; - brokenRules: any[]; - validators: IValidator[]; - } - export interface GroupConfig extends EventsMixin { - group: any; - validators: IValidator[]; - validate(): ValidationGroupValidationResult; - reset(): void; - } - /** Provides access to the object that represents the specified validation group. */ - export function getGroupConfig(group: any): GroupConfig - /** Provides access to the object that represents the default validation group. */ - export function getGroupConfig(): GroupConfig - /** Validates rules of the validators that belong to the specified validation group. */ - export function validateGroup(group: any): ValidationGroupValidationResult; - /** Validates rules of the validators that belong to the default validation group. */ - export function validateGroup(): ValidationGroupValidationResult; - /** Resets the values and validation result of the editors that belong to the specified validation group. */ - export function resetGroup(group: any): void; - /** Resets the values and validation result of the editors that belong to the default validation group. */ - export function resetGroup(): void; - /** Validates the rules that are defined within the dxValidator objects that are registered for the specified ViewModel. */ - export function validateModel(model: Object): ValidationGroupValidationResult; - /** Registers all the dxValidator objects by which the fields of the specified ViewModel are extended. */ - export function registerModelForValidation(model: Object) : void; - } - export var hardwareBackButton: JQueryCallback; - /** Processes the hardware back button click. */ - export function processHardwareBackButton(): void; - /** Specifies whether or not the entire application/site supports right-to-left representation. */ - export var rtlEnabled: boolean; - /** Registers a new component in the DevExpress.ui namespace, and a jQuery plugin and Knockout binding for the required component. */ - export function registerComponent(name: string, componentClass: Object): void; - /** Registers a new component in the specified namespace as a jQuery plugin, Angular directive and Knockout binding. */ - export function registerComponent(name: string, namespace: Object, componentClass: Object): void; - /** Requests that the browser call a specified function to update animation before the next repaint. */ - export function requestAnimationFrame(callback: Function): number; - /** Cancels an animation frame request scheduled with the requestAnimationFrame method. */ - export function cancelAnimationFrame(requestID: number): void; - /** Custom Knockout binding that links an HTML element with a specific action. */ - export class Action { } - /** Used to get URLs that vary in a locally running application and the application running on production. */ - export class EndpointSelector { - constructor(options: { - [key: string]: { - local?: string; - production?: string; - } - }); - /** Returns a local or a productional URL depending on how the application is currently running. */ - urlFor(key: string): string; - } - /** An object that serves as a namespace for the methods that are used to animate UI elements. */ - export module fx { - /** Defines animation options. */ - export interface AnimationOptions { - /** A function called after animation is completed. */ - complete?: (element: JQuery, config: AnimationOptions) => void; - /** A number specifying wait time before animation execution. */ - delay?: number; - /** A number specifying the time period to wait before the animation of the next stagger item starts. */ - staggerDelay?: number; - /** A number specifying the time in milliseconds spent on animation. */ - duration?: number; - /** A string specifying the type of an easing function used for animation. */ - easing?: string; - /** Specifies the initial animation state. */ - from?: any; - /** A function called before animation is started. */ - start?: (element: JQuery, config: AnimationOptions) => void; - /** Specifies a final animation state. */ - to?: any; - /** A string value specifying the animation type. */ - type?: string; - /** Specifies the animation direction for the "slideIn" and "slideOut" animation types. */ - direction?: string; - } - /** Animates the specified element. */ - export function animate(element: HTMLElement, config: AnimationOptions): Object; - /** Returns a value indicating whether the specified element is being animated. */ - export function isAnimating(element: HTMLElement): boolean; - /** Stops the animation. */ - export function stop(element: HTMLElement, jumpToEnd: boolean): void; - } - /** The manager that performs several specified animations at a time. */ - export class TransitionExecutor { - /** Deletes all the animations registered in the Transition Executor by using the enter(elements, animation) and leave(elements, animation) methods. */ - reset(): void; - /** Registers a set of elements that should be animated as "entering" using the specified animation configuration. */ - enter(elements: JQuery, animation: any): void; - /** Registers a set of elements that should be animated as "leaving" using the specified animation configuration. */ - leave(elements: JQuery, animation: any): void; - /** Starts all the animations registered using the enter(elements, animation) and leave(elements, animation) methods beforehand. */ - start(config: Object): JQueryPromise; - } - export class AnimationPresetCollection { - /** Resets all the changes made in the animation repository. */ - resetToDefaults(): void; - /** Deletes the specified animation or clears all the animation repository, if an animation name is not passed. */ - clear(name: string): void; - /** Adds the specified animation preset to the animation repository by the specified name. */ - registerPreset(name: string, config: any): void; - /** Applies the changes made in the animation repository. */ - applyChanges(): void; - /** Returns the configuration of the animation found in the animation repository by the specified name for the current device. */ - getPreset(name: string): void; - /** Registers predefined animations in the animation repository. */ - registerDefaultPresets(): void; - } - /** A repository of animations. */ - export var animationPresets: AnimationPresetCollection; - /** The device object defines the device on which the application is running. */ - export interface Device { - /** Indicates whether or not the device platform is Android. */ - android?: boolean; - /** Specifies the type of the device on which the application is running. */ - deviceType?: string; - /** Indicates whether or not the device platform is generic, which means that the application will look and behave according to a generic "light" or "dark" theme. */ - generic?: boolean; - /** Indicates whether or not the device platform is iOS. */ - ios?: boolean; - /** Indicates whether or not the device type is 'phone'. */ - phone?: boolean; - /** Specifies the platform of the device on which the application is running. */ - platform?: string; - /** Indicates whether or not the device type is 'tablet'. */ - tablet?: boolean; - /** Specifies an array with the major and minor versions of the device platform. */ - version?: Array; - /** Indicates whether or not the device platform is Windows8. */ - win8?: boolean; - /** Specifies a performance grade of the current device. */ - grade?: string; - } - export class Devices implements EventsMixin { - constructor(options: { window: Window }); - /** Overrides actual device information to force the application to operate as if it was running on the specified device. */ - current(deviceName: any): void; - /** Returns information about the current device. */ - current(): Device; - orientationChanged: JQueryCallback; - /** Returns the current device orientation. */ - orientation(): string; - /** Returns real information about the current device regardless of the value passed to the devices.current(deviceName) method. */ - real(): Device; - on(eventName: "orientationChanged", eventHandler: (e: { orientation: string }) => void): Devices; - on(eventName: string, eventHandler: Function): Devices; - on(events: { [eventName: string]: Function; }): Devices; - off(eventName: "orientationChanged"): Devices; - off(eventName: string): Devices; - off(eventName: "orientationChanged", eventHandler: (e: { orientation: string }) => void): Devices; - off(eventName: string, eventHandler: Function): Devices; - } - /** An object that serves as a namespace for the methods and events specifying information on the current device. */ - export var devices: Devices; - /** The position object specifies the widget positioning options. */ - export interface PositionOptions { - /** The target element position that the widget is positioned against. */ - at?: string; - /** The element within which the widget is positioned. */ - boundary?: Element; - /** A string value holding horizontal and vertical offset from the window's boundaries. */ - boundaryOffset?: string; - /** Specifies how to move the widget if it overflows the screen. */ - collision?: any; - /** The position of the widget to align against the target element. */ - my?: string; - /** The target element that the widget is positioned against. */ - of?: HTMLElement; - /** A string value holding horizontal and vertical offset in pixels, separated by a space (e.g., "5 -10"). */ - offset?: string; - } - export interface ComponentOptions { - /** A handler for the initialized event. */ - onInitialized?: Function; - /** A handler for the optionChanged event. */ - onOptionChanged?: Function; - /** A handler for the disposing event. */ - onDisposing?: Function; - } - /** A base class for all components and widgets. */ - export class Component { - constructor(options?: ComponentOptions) - /** Prevents the component from refreshing until the endUpdate method is called. */ - beginUpdate(): void; - /** Enables the component to refresh after the beginUpdate method call. */ - endUpdate(): void; - /** Returns an instance of this component class. */ - instance(): Component; - /** Sets one or more options of this component. */ - option(options: Object): void; - /** Returns the configuration options of this component. */ - option(): Object; - /** Gets the value of the specified configuration option of this component. */ - option(optionName: string): any; - /** Sets a value to the specified configuration option of this component. */ - option(optionName: string, optionValue: any): void; - } - export interface DOMComponentOptions extends ComponentOptions { - /** Specifies whether or not the current component supports a right-to-left representation. */ - rtlEnabled?: boolean; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies the width of the widget. */ - width?: any; - } - /** A base class for all components. */ - export class DOMComponent extends Component { - constructor(element: JQuery, options?: DOMComponentOptions); - constructor(element: HTMLElement, options?: DOMComponentOptions); - /** Returns the root HTML element of the widget. */ - element(): JQuery; - /** Specifies the device-dependent default configuration options for this component. */ - static defaultOptions(rule: { - device?: any; - options?: any; - }): void; - } - export module data { - export interface ODataError extends Error { - httpStatus?: number; - errorDetails?: any; - } - export interface StoreOptions { - inserted?: (values: Object, key: any) => void; - inserting?: (values: Object) => void; - loaded?: (result: Array) => void; - loading?: (loadOptions: LoadOptions) => void; - modified?: () => void; - modifying?: () => void; - removed?: (key: any) => void; - removing?: (key: any) => void; - updated?: (key: any, values: Object) => void; - updating?: (key: any, values: Object) => void; - /** A handler for the modified event. */ - onModified?: () => void; - /** A handler for the modifying event. */ - onModifying?: () => void; - /** A handler for the removed event. */ - onRemoved?: (key: any) => void; - /** A handler for the removing event. */ - onRemoving?: (key: any) => void; - /** A handler for the updated event. */ - onUpdated?: (key: any, values: Object) => void; - /** A handler for the updating event. */ - onUpdating?: (key: any, values: Object) => void; - /** A handler for the loaded event. */ - onLoaded?: (result: Array) => void; - /** A handler for the loading event. */ - onLoading?: (loadOptions: LoadOptions) => void; - /** A handler for the inserted event. */ - onInserted?: (values: Object, key: any) => void; - /** A handler for the inserting event. */ - onInserting?: (values: Object) => void; - /** Specifies the function called when the Store causes an error. */ - errorHandler?: (e: Error) => void; - /** Specifies the key properties within the data associated with the Store. */ - key?: any; - } - export interface LoadOptions { - filter?: Object; - sort?: Object; - select?: Object; - expand?: Object; - group?: Object; - skip?: number; - take?: number; - userData?: Object; - requireTotalCount?: boolean; - } - /** The base class for all Stores. */ - export class Store implements EventsMixin { - inserted: JQueryCallback; - inserting: JQueryCallback; - loaded: JQueryCallback; - loading: JQueryCallback; - modified: JQueryCallback; - modifying: JQueryCallback; - removed: JQueryCallback; - removing: JQueryCallback; - updated: JQueryCallback; - updating: JQueryCallback; - constructor(options?: StoreOptions); - /** Returns the data item specified by the key. */ - byKey(key: any): JQueryPromise; - /** Adds an item to the data associated with this Store. */ - insert(values: Object): JQueryPromise; - /** Returns the key expression specified via the key configuration option. */ - key(): any; - /** Returns the key of the Store item that matches the specified object. */ - keyOf(obj: Object): any; - /** Starts loading the data. */ - load(obj?: LoadOptions): JQueryPromise; - /** Removes the data item specified by the key. */ - remove(key: any): JQueryPromise; - /** Obtains the total count of items that will be returned by the load() function. */ - totalCount(obj?: { - filter?: Object; - select?: Object; - group?: Object; - sort?: Object; - }): JQueryPromise; - /** Updates the data item specified by the key. */ - update(key: any, values: Object): JQueryPromise; - on(eventName: "removing", eventHandler: (key: any) => void): Store; - on(eventName: "removed", eventHandler: (key: any) => void): Store; - on(eventName: "updating", eventHandler: (key: any, values: Object) => void): Store; - on(eventName: "updated", eventHandler: (key: any, values: Object) => void): Store; - on(eventName: "inserting", eventHandler: (values: Object) => void): Store; - on(eventName: "inserted", eventHandler: (values: Object, key: any) => void): Store; - on(eventName: "modifying", eventHandler: () => void): Store; - on(eventName: "modified", eventHandler: () => void): Store; - on(eventName: "loading", eventHandler: (loadOptions: LoadOptions) => void): Store; - on(eventName: "loaded", eventHandler: (result: Array) => void): Store; - on(eventName: string, eventHandler: Function): Store; - on(events: { [eventName: string]: Function; }): Store; - off(eventName: "removing"): Store; - off(eventName: "removed"): Store; - off(eventName: "updating"): Store; - off(eventName: "updated"): Store; - off(eventName: "inserting"): Store; - off(eventName: "inserted"): Store; - off(eventName: "modifying"): Store; - off(eventName: "modified"): Store; - off(eventName: "loading"): Store; - off(eventName: "loaded"): Store; - off(eventName: string): Store; - off(eventName: "removing", eventHandler: (key: any) => void): Store; - off(eventName: "removed", eventHandler: (key: any) => void): Store; - off(eventName: "updating", eventHandler: (key: any, values: Object) => void): Store; - off(eventName: "updated", eventHandler: (key: any, values: Object) => void): Store; - off(eventName: "inserting", eventHandler: (values: Object) => void): Store; - off(eventName: "inserted", eventHandler: (values: Object, key: any) => void): Store; - off(eventName: "modifying", eventHandler: () => void): Store; - off(eventName: "modified", eventHandler: () => void): Store; - off(eventName: "loading", eventHandler: (loadOptions: LoadOptions) => void): Store; - off(eventName: "loaded", eventHandler: (result: Array) => void): Store; - off(eventName: string, eventHandler: Function): Store; - } - export interface ArrayStoreOptions extends StoreOptions { - /** Specifies the array associated with this Store. */ - data?: Array; - } - /** A Store accessing an in-memory array. */ - export class ArrayStore extends Store { - constructor(options?: ArrayStoreOptions); - /** Clears all data associated with the current ArrayStore. */ - clear(): void; - /** Creates the Query object for the underlying array. */ - createQuery(): Query; - } - interface Promise { - then(doneFn?: Function, failFn?: Function, progressFn?: Function): Promise; - } - export interface CustomStoreOptions extends StoreOptions { - /** The user implementation of the byKey(key, extraOptions) method. */ - byKey?: (key: any) => Promise; - /** The user implementation of the insert(values) method. */ - insert?: (values: Object) => Promise; - /** The user implementation of the load(options) method. */ - load?: (options?: LoadOptions) => Promise; - /** The user implementation of the remove(key) method. */ - remove?: (key: any) => Promise; - /** The user implementation of the totalCount(options) method. */ - totalCount?: () => Promise; - /** The user implementation of the update(key, values) method. */ - update?: (key: any, values: Object) => Promise; - } - /** A Store object that enables you to implement your own data access logic. */ - export class CustomStore extends Store { - constructor(options: CustomStoreOptions); - } - export interface DataSourceOptions { - /** Specifies data filtering conditions. */ - filter?: Object; - /** Specifies data grouping conditions. */ - group?: Object; - /** The item mapping function. */ - map?: (record: any) => any; - /** Specifies the maximum number of items the page can contain. */ - pageSize?: number; - /** Specifies whether a DataSource loads data by pages, or all items at once. */ - paginate?: boolean; - /** The data post processing function. */ - postProcess?: (data: any[]) => any[]; - /** Specifies a value by which the required items are searched. */ - searchExpr?: Object; - /** Specifies the comparison operation used to search for the required items. */ - searchOperation?: string; - /** Specifies the value to which the search expression is compared. */ - searchValue?: Object; - /** Specifies the initial select option value. */ - select?: Object; - /** An array of the strings that represent the names of the navigation properties to be loaded simultaneously with the OData store's entity. */ - expand?: Object; - /** Specifies the initial sort option value. */ - sort?: Object; - /** Specifies the underlying Store instance used to access data. */ - store?: any; - /** A handler for the changed event. */ - onChanged?: () => void; - /** A handler for the loadingChanged event. */ - onLoadingChanged?: (isLoading: boolean) => void; - /** A handler for the loadError event. */ - onLoadError?: (e?: Error) => void; - } - /** An object that provides access to a data web service or local data storage for collection container widgets. */ - export class DataSource implements EventsMixin { - constructor(options?: DataSourceOptions); - changed: JQueryCallback; - loadError: JQueryCallback; - loadingChanged: JQueryCallback; - /** Disposes all resources associated with this DataSource. */ - dispose(): void; - /** Returns the current filter option value. */ - filter(): Object; - /** Sets the filter option value. */ - filter(filterExpr: Object): void; - /** Returns the current group option value. */ - group(): Object; - /** Sets the group option value. */ - group(groupExpr: Object): void; - /** Indicates whether or not the current page contains fewer items than the number of items specified by the pageSize configuration option. */ - isLastPage(): boolean; - /** Indicates whether or not at least one load() method execution has successfully finished. */ - isLoaded(): boolean; - /** Indicates whether or not the DataSource is currently being loaded. */ - isLoading(): boolean; - /** Returns the array of items currently operated by the DataSource. */ - items(): Array; - /** Returns the key expression. */ - key(): any; - /** Starts loading data. */ - load(): JQueryPromise>; - /** Returns an object that would be passed to the load() method of the underlying Store according to the current data shaping option values of the current DataSource instance. */ - loadOptions(): Object; - /** Returns the current pageSize option value. */ - pageSize(): number; - /** Sets the pageSize option value. */ - pageSize(value: number): void; - /** Specifies the index of the currently loaded page. */ - pageIndex(): number; - /** Specifies the index of the page to be loaded during the next load() method execution. */ - pageIndex(newIndex: number): void; - /** Returns the current paginate option value. */ - paginate(): boolean; - /** Sets the paginate option value. */ - paginate(value: boolean): void; - /** Returns the searchExpr option value. */ - searchExpr(): Object; - /** Sets the searchExpr option value. */ - searchExpr(expr: Object): void; - /** Returns the currently specified search operation. */ - searchOperation(): string; - /** Sets the current search operation. */ - searchOperation(op: string): void; - /** Returns the searchValue option value. */ - searchValue(): Object; - /** Sets the searchValue option value. */ - searchValue(value: Object): void; - /** Returns the current select option value. */ - select(): Object; - /** Sets the select option value. */ - select(expr: Object): void; - /** Returns the current sort option value. */ - sort(): Object; - /** Sets the sort option value. */ - sort(sortExpr: Object): void; - /** Returns the underlying Store instance. */ - store(): Store; - /** Returns the number of data items available in an underlying Store after the last load() operation without paging. */ - totalCount(): number; - on(eventName: "loadingChanged", eventHandler: (isLoading: boolean) => void): DataSource; - on(eventName: "loadError", eventHandler: (e?: Error) => void): DataSource; - on(eventName: "changed", eventHandler: () => void): DataSource; - on(eventName: string, eventHandler: Function): DataSource; - on(events: { [eventName: string]: Function; }): DataSource; - off(eventName: "loadingChanged"): DataSource; - off(eventName: "loadError"): DataSource; - off(eventName: "changed"): DataSource; - off(eventName: string): DataSource; - off(eventName: "loadingChanged", eventHandler: (isLoading: boolean) => void): DataSource; - off(eventName: "loadError", eventHandler: (e?: Error) => void): DataSource; - off(eventName: "changed", eventHandler: () => void): DataSource; - off(eventName: string, eventHandler: Function): DataSource; - } - /** An object used to work with primitive data types not supported by JavaScript when accessing an OData web service. */ - export class EdmLiteral { - /** Returns a string representation of the value associated with this EdmLiteral object. */ - valueOf(): string; - } - /** An object used to generate and hold the GUID. */ - export class Guid { - /** Creates a new Guid instance that holds the specified GUID. */ - constructor(value: string); - /** Creates a new Guid instance holding the generated GUID. */ - constructor(); - /** Returns a string representation of the Guid instance. */ - toString(): string; - /** Returns a string representation of the Guid instance. */ - valueOf(): string; - } - export interface LocalStoreOptions extends ArrayStoreOptions { - /** Specifies the time (in miliseconds) after the change operation, before the data is flushed. */ - flushInterval?: number; - /** Specifies whether the data is flushed immediatelly after each change operation, or after the delay specified via the flushInterval option. */ - immediate?: boolean; - /** The unique identifier used to distinguish the data within the HTML5 Web Storage. */ - name?: string; - } - /** A Store providing access to the HTML5 Web Storage. */ - export class LocalStore extends ArrayStore { - constructor(options?: LocalStoreOptions); - /** Removes all data associated with this Store. */ - clear(): void; - } - export interface ODataContextOptions extends ODataStoreOptions { - /** Specifies the list of entities to be accessed via the ODataContext. */ - entities?: Object; - /** Specifies the function called if the ODataContext causes an error. */ - errorHandler?: (e: Error) => void; - } - /** Provides access to the entire OData service. */ - export class ODataContext { - constructor(options?: ODataContextOptions); - /** Initiates the specified WebGet service operation that returns a value. For the information on service operations, refer to the OData documentation. */ - get(operationName: string, params: Object): JQueryPromise; - /** Initiates the specified WebGet service operation that returns nothing. For the information on service operations, refer to the OData documentation. */ - invoke(operationName: string, params: Object, httpMethod: Object): JQueryPromise; - /** Return a special proxy object to describe the entity link. */ - objectLink(entityAlias: string, key: any): Object; - } - export interface ODataStoreOptions extends StoreOptions { - /** A function used to customize a web request before it is sent. */ - beforeSend?: (request: { - url: string; - method: string; - timeout: number; - params: Object; - payload: Object; - headers: Object; - }) => void; - /** Specifies whether the ODataStore uses the JSONP approach to access non-CORS-compatible remote services. */ - jsonp?: boolean; - /** Specifies the type of the ODataStore key property. The following key types are supported out of the box: String, Int32, Int64, and Guid. */ - keyType?: any; - /** Specifies the URL of the data service being accessed via the current ODataContext. */ - url?: string; - /** Specifies the version of the OData protocol used to interact with the data service. */ - version?: number; - /** Specifies the value of the withCredentials field of the underlying jqXHR object. */ - withCredentials?: boolean; - } - /** A Store providing access to a separate OData web service entity. */ - export class ODataStore extends Store { - constructor(options?: ODataStoreOptions); - /** Creates the Query object for the OData endpoint. */ - createQuery(loadOptions: Object): Object; - /** Returns the data item specified by the key. */ - byKey(key: any, extraOptions?: { expand?: Object }): JQueryPromise; - } - /** An universal chainable data query interface object. */ - export interface Query { - /** Calculates a custom summary for the items in the current Query. */ - aggregate(step: (accumulator: any, value: any) => any): JQueryPromise; - /** Calculates a custom summary for the items in the current Query. */ - aggregate(seed: any, step: (accumulator: any, value: any) => any, finalize: (result: any) => any): JQueryPromise; - /** Calculates the average item value for the current Query. */ - avg(getter: Object): JQueryPromise; - /** Finds the item with the maximum getter value. */ - max(getter: Object): JQueryPromise; - /** Finds the item with the maximum value in the Query. */ - max(): JQueryPromise; - /** Finds the item with the minimum value in the Query. */ - min(): JQueryPromise; - /** Finds the item with the minimum getter value. */ - min(getter: Object): JQueryPromise; - /** Calculates the average item value for the current Query, if each Query item has a numeric type. */ - avg(): JQueryPromise; - /** Returns the total count of items in the current Query. */ - count(): JQueryPromise; - /** Executes the Query. */ - enumerate(): JQueryPromise; - /** Filters the current Query data. */ - filter(criteria: Array): Query; - /** Groups the current Query data. */ - groupBy(getter: Object): Query; - /** Applies the specified transformation to each item. */ - select(getter: Object): Query; - /** Limits the data item count. */ - slice(skip: number, take?: number): Query; - /** Sorts current Query data. */ - sortBy(getter: Object, desc: boolean): Query; - /** Sorts current Query data. */ - sortBy(getter: Object): Query; - /** Calculates the sum of item getter values in the current Query. */ - sum(getter: Object): JQueryPromise; - /** Calculates the sum of item values in the current Query. */ - sum(): JQueryPromise; - /** Adds one more sorting condition to the current Query. */ - thenBy(getter: Object): Query; - /** Adds one more sorting condition to the current Query. */ - thenBy(getter: Object, desc: boolean): Query; - /** Returns the array of current Query items. */ - toArray(): Array; - } - /** The global data layer error handler. */ - export var errorHandler: (e: Error) => void; - /** Encodes the specified string or array of bytes to base64 encoding. */ - export function base64_encode(input: any): string; - /** Creates a Query instance. */ - export function query(array: Array): Query; - /** Creates a Query instance for accessing the remote service specified by a URL. */ - export function query(url: string, queryOptions: Object): Query; - /** This section describes the utility objects provided by the DevExtreme data layer. */ - export var utils: { - /** Compiles a getter function from the getter expression. */ - compileGetter(expr: any): Function; - /** Compiles a setter function from the setter expression. */ - compileSetter(expr: any): Function; - odata: { - /** Holds key value converters for OData. */ - keyConverters: { - String(value: any): string; - Int32(value: any): number; - Int64(value: any): EdmLiteral; - Guid(value: any): Guid; - Boolean(value: any): boolean; - Single(value: any): EdmLiteral; - Decimal(value: any): EdmLiteral; - }; - } - } - } - /** An object that serves as a namespace for DevExtreme UI widgets as well as for methods implementing UI logic in DevExtreme sites/applications. */ - export module ui { - export interface WidgetOptions extends DOMComponentOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A Boolean value specifying whether or not the widget can respond to user interaction. */ - disabled?: boolean; - /** A Boolean value specifying whether or not the widget changes its state when being hovered by an end user. */ - hoverStateEnabled?: boolean; - /** Specifies whether or not the widget can be focused. */ - focusStateEnabled?: boolean; - /** Specifies a shortcut key that sets focus on the widget element. */ - accessKey?: string; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - /** Specifies the widget tab index. */ - tabIndex?: number; - /** Specifies the text of the hint displayed for the widget. */ - hint?: string; - } - /** The base class for widgets. */ - export class Widget extends DOMComponent { - constructor(options?: WidgetOptions); - /** Redraws the widget. */ - repaint(): void; - /** Sets focus on the widget. */ - focus(): void; - /** Registers a handler for pressing of the specified key. */ - registerKeyHandler(key: string, handler: Function): void; - } - export interface CollectionWidgetOptions extends WidgetOptions { - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - itemClickAction?: any; - itemHoldAction?: Function; - /** The time period in milliseconds before the onItemHold event is raised. */ - itemHoldTimeout?: number; - itemRender?: any; - itemRenderedAction?: Function; - /** An array of items displayed by the widget. */ - items?: Array; - /** - * A function performed when a widget item is selected. - * @deprecated onSelectionChanged.md - */ - itemSelectAction?: Function; - /** The template to be used for rendering items. */ - itemTemplate?: any; - loopItemFocus?: boolean; - /** The text or HTML markup displayed by the widget if the item collection is empty. */ - noDataText?: string; - onContentReady?: any; - contentReadyAction?: any; - /** A handler for the itemClick event. */ - onItemClick?: any; - /** A handler for the itemContextMenu event. */ - onItemContextMenu?: Function; - /** A handler for the itemHold event. */ - onItemHold?: Function; - /** A handler for the itemRendered event. */ - onItemRendered?: Function; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: Function; - /** The index of the currently selected widget item. */ - selectedIndex?: number; - /** The selected item object. */ - selectedItem?: Object; - /** An array of currently selected item objects. */ - selectedItems?: Array; - /** A handler for the itemDeleting event. */ - onItemDeleting?: Function; - /** A handler for the itemDeleted event. */ - onItemDeleted?: Function; - /** A handler for the itemReordered event. */ - onItemReordered?: Function; - } - /** The base class for widgets containing an item collection. */ - export class CollectionWidget extends Widget { - constructor(element: JQuery, options?: CollectionWidgetOptions); - constructor(element: HTMLElement, options?: CollectionWidgetOptions); - selectItem(itemElement: any): void; - unselectItem(itemElement: any): void; - deleteItem(itemElement: any): JQueryPromise; - isItemSelected(itemElement: any): boolean; - reorderItem(itemElement: any, toItemElement: any): JQueryPromise; - } - export interface DataExpressionMixinOptions { - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** Specifies the name of the data source item field whose value is displayed by the widget. */ - displayExpr?: any; - /** Specifies the name of a data source item field whose value is held in the value configuration option. */ - valueExpr?: any; - itemRender?: any; - /** An array of items displayed by the widget. */ - items?: Array; - /** The template to be used for rendering items. */ - itemTemplate?: any; - /** The currently selected value in the widget. */ - value?: Object; - } - export interface EditorOptions extends WidgetOptions { - /** The currently specified value. */ - value?: Object; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - valueChangeAction?: Function; - /** A Boolean value specifying whether or not the widget is read-only. */ - readOnly?: boolean; - /** Holds the object that defines the error that occurred during validation. */ - validationError?: Object; - /** Specifies whether the editor's value is valid. */ - isValid?: boolean; - /** Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed. */ - validationMessageMode?: string; - } - /** A base class for editors. */ - export class Editor extends Widget { - /** Resets the editor's value to undefined. */ - reset(): void; - } - /** An object that serves as a namespace for methods displaying a message in an application/site. */ - export var dialog: { - /** Creates an alert dialog message containing a single "OK" button. */ - alert(message: string, title: string): JQueryPromise; - /** Creates a confirm dialog that contains "Yes" and "No" buttons. */ - confirm(message: string, title: string): JQueryPromise; - /** Creates a custom dialog using the options specified by the passed configuration object. */ - custom(options: { title?: string; message?: string; buttons?: Array; }): { - show(): JQueryPromise; - hide(): void; - hide(value: any): void; - }; - }; - /** Creates a toast message. */ - export function notify(message: any, type: string, displayTime: number): void; - /** Creates a toast message. */ - export function notify(options: Object): void; - /** An object that serves as a namespace for the methods that work with DevExtreme CSS Themes. */ - export var themes: { - /** Returns the name of the currently applied theme. */ - current(): string; - /** Changes the current theme to the specified one. */ - current(themeName: string): void; - }; - /** Sets a specified template engine. */ - export function setTemplateEngine(name: string): void; - /** Sets a custom template engine defined via custom compile and render functions. */ - export function setTemplateEngine(options: Object): void; - /** An object that serves as a namespace for utility methods that can be helpful when working with the DevExtreme framework and UI widgets. */ - export var utils: { - /** Sets parameters for the viewport meta tag. */ - initMobileViewport(options: { allowZoom?: boolean; allowPan?: boolean; allowSelection?: boolean }): void; - }; - } -} -declare namespace DevExpress.ui { - export interface dxValidatorOptions extends DOMComponentOptions { - /** An array of validation rules to be checked for the editor with which the dxValidator object is associated. */ - validationRules?: Array; - /** Specifies the editor name to be used in the validation default messages. */ - name?: string; - /** An object that specifies what and when to validate and how to apply the validation result. */ - adapter?: Object; - /** Specifies the validation group the editor will be related to. */ - validationGroup?: string; - /** A handler for the validated event. */ - onValidated?: (params: validationEngine.ValidatorValidationResult) => void; - } - /** A widget that is used to validate the associated DevExtreme editors against the defined validation rules. */ - export class dxValidator extends DOMComponent implements validationEngine.IValidator { - constructor(element: JQuery, options?: dxValidatorOptions); - constructor(element: Element, options?: dxValidatorOptions); - /** Validates the value of the editor that is controlled by the current dxValidator object against the list of the specified validation rules. */ - validate(): validationEngine.ValidatorValidationResult; - /** Resets the value and validation result of the editor associated with the current dxValidator object. */ - reset(): void; - } - /** The widget that is used in the Knockout and Angular approaches to combine the editors to be validated. */ - export class dxValidationGroup extends DOMComponent { - constructor(element: JQuery); - constructor(element: Element); - /** Validates rules of the validators that belong to the current validation group. */ - validate(): validationEngine.ValidationGroupValidationResult; - /** Resets the value and validation result of the editors that are included to the current validation group. */ - reset(): void; - } - export interface dxValidationSummaryOptions extends CollectionWidgetOptions { - /** Specifies the validation group for which summary should be generated. */ - validationGroup?: string; - } - /** A widget for displaying the result of checking validation rules for editors. */ - export class dxValidationSummary extends CollectionWidget { - constructor(element: JQuery, options?: dxValidationSummaryOptions); - constructor(element: Element, options?: dxValidationSummaryOptions); - } - export interface dxResizableOptions extends DOMComponentOptions { - /** Specifies which borders of the widget element are used as a handle. */ - handles?: string; - /** Specifies the lower width boundary for resizing. */ - minWidth?: number; - /** Specifies the upper width boundary for resizing. */ - maxWidth?: number; - /** Specifies the lower height boundary for resizing. */ - minHeight?: number; - /** Specifies the upper height boundary for resizing. */ - maxHeight?: number; - /** A handler for the resizeStart event. */ - onResizeStart?: Function; - /** A handler for the resize event. */ - onResize?: Function; - /** A handler for the resizeEnd event. */ - onResizeEnd?: Function; - } - /** A widget that displays required content in a resizable element. */ - export class dxResizable extends DOMComponent { - constructor(element: JQuery, options?: dxResizableOptions); - constructor(element: Element, options?: dxResizableOptions); - } - export interface dxTooltipOptions extends dxPopoverOptions { - } - /** A tooltip widget. */ - export class dxTooltip extends dxPopover { - constructor(element: JQuery, options?: dxTooltipOptions); - constructor(element: Element, options?: dxTooltipOptions); - } - export interface dxDropDownListOptions extends dxDropDownEditorOptions { - /** Returns the value currently displayed by the widget. */ - displayValue?: string; - /** The minimum number of characters that must be entered into the text box to begin a search. */ - minSearchLength?: number; - /** Specifies the name of a data source item field or an expression whose value is compared to the search criterion. */ - searchExpr?: Object; - /** Specifies the binary operation used to filter data. */ - searchMode?: string; - /** Specifies the time delay, in milliseconds, after the last character has been typed in, before a search is executed. */ - searchTimeout?: number; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - /** Specifies DOM event names that update a widget's value. */ - valueChangeEvent?: string; - /** Specifies whether or not the widget supports searching. */ - searchEnabled?: boolean; - /** - * Specifies whether or not the widget displays items by pages. - * @deprecated dataSource.paginate.md - */ - pagingEnabled?: boolean; - /** The text or HTML markup displayed by the widget if the item collection is empty. */ - noDataText?: string; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: Function; - /** A handler for the itemClick event. */ - onItemClick?: Function; - onContentReady?: Function; - } - /** A base class for drop-down list widgets. */ - export class dxDropDownList extends dxDropDownEditor { - constructor(element: JQuery, options?: dxDropDownListOptions); - constructor(element: Element, options?: dxDropDownListOptions); - } - export interface dxToolbarOptions extends CollectionWidgetOptions { - menuItemRender?: any; - /** The template used to render menu items. */ - menuItemTemplate?: any; - /** Informs the widget about its location in a view HTML markup. */ - renderAs?: string; - } - /** A toolbar widget. */ - export class dxToolbar extends CollectionWidget { - constructor(element: JQuery, options?: dxToolbarOptions); - constructor(element: Element, options?: dxToolbarOptions); - } - export interface dxToastOptions extends dxOverlayOptions { - animation?: fx.AnimationOptions; - /** The time span in milliseconds during which the dxToast widget is visible. */ - displayTime?: number; - height?: any; - /** The dxToast message text. */ - message?: string; - position?: PositionOptions; - shading?: boolean; - /** Specifies the dxToast widget type. */ - type?: string; - width?: any; - closeOnBackButton?: boolean; - } - /** The toast message widget. */ - export class dxToast extends dxOverlay { - constructor(element: JQuery, options?: dxToastOptions); - constructor(element: Element, options?: dxToastOptions); - } - export interface dxTextEditorOptions extends EditorOptions { - /** A handler for the change event. */ - onChange?: Function; - changeAction?: Function; - /** A handler for the copy event. */ - onCopy?: Function; - copyAction?: Function; - /** A handler for the cut event. */ - onCut?: Function; - cutAction?: Function; - /** A handler for the enterKey event. */ - onEnterKey?: Function; - enterKeyAction?: Function; - /** A handler for the focusIn event. */ - onFocusIn?: Function; - focusInAction?: Function; - /** A handler for the focusOut event. */ - onFocusOut?: Function; - focusOutAction?: Function; - /** A handler for the input event. */ - onInput?: Function; - inputAction?: Function; - /** A handler for the keyDown event. */ - onKeyDown?: Function; - keyDownAction?: Function; - /** A handler for the keyPress event. */ - onKeyPress?: Function; - keyPressAction?: Function; - /** A handler for the keyUp event. */ - onKeyUp?: Function; - keyUpAction?: Function; - /** A handler for the paste event. */ - onPaste?: Function; - pasteAction?: Function; - /** The text displayed by the widget when the widget value is empty. */ - placeholder?: string; - /** Specifies whether to display the Clear button in the widget. */ - showClearButton?: boolean; - /** Specifies the current value displayed by the widget. */ - value?: any; - /** Specifies DOM event names that update a widget's value. */ - valueChangeEvent?: string; - /** Specifies whether or not the widget checks the inner text for spelling mistakes. */ - spellcheck?: boolean; - /** Specifies HTML attributes applied to the inner input element of the widget. */ - attr?: Object; - /** The read-only option that holds the text displayed by the widget input element. */ - text?: string; - /** Specifies whether or not the widget supports the focused state and keyboard navigation. */ - focusStateEnabled?: boolean; - /** A Boolean value specifying whether or not the widget changes its state when being hovered by an end user. */ - hoverStateEnabled?: boolean; - /** The editor mask, which specifies the format of the entered string. */ - mask?: string; - /** Specifies a mask placeholder character. */ - maskChar?: string; - /** Specifies custom mask rules. */ - maskRules?: Object; - /** A message displayed when the entered text does not match the specified pattern. */ - maskInvalidMessage?: string; - } - /** A base class for text editing widgets. */ - export class dxTextEditor extends Editor { - constructor(element: JQuery, options?: dxTextEditorOptions); - constructor(element: Element, options?: dxTextEditorOptions); - /** Removes focus from the input element. */ - blur(): void; - /** Sets focus to the input element representing the widget. */ - focus(): void; - } - export interface dxTextBoxOptions extends dxTextEditorOptions { - /** Specifies the maximum number of characters you can enter into the textbox. */ - maxLength?: any; - /** The "mode" attribute value of the actual HTML input element representing the text box. */ - mode?: string; - } - /** A single-line text box widget. */ - export class dxTextBox extends dxTextEditor { - constructor(element: JQuery, options?: dxTextBoxOptions); - constructor(element: Element, options?: dxTextBoxOptions); - } - export interface dxTextAreaOptions extends dxTextBoxOptions { - /** Specifies whether or not the widget checks the inner text for spelling mistakes. */ - spellcheck?: boolean; - } - /** A widget used to display and edit multi-line text. */ - export class dxTextArea extends dxTextBox { - constructor(element: JQuery, options?: dxTextAreaOptions); - constructor(element: Element, options?: dxTextAreaOptions); - } - export interface dxTabsOptions extends CollectionWidgetOptions { - /** Specifies whether the widget enables an end-user to select only a single item or multiple items. */ - selectionMode?: string; - /** Specifies whether or not an end-user can scroll tabs by swiping. */ - scrollByContent?: boolean; - /** Specifies whether or not an end-user can scroll tabs. */ - scrollingEnabled?: boolean; - /** A Boolean value that specifies the availability of navigation buttons. */ - showNavButtons?: boolean; - } - /** A tab strip used to switch between pages. */ - export class dxTabs extends CollectionWidget { - constructor(element: JQuery, options?: dxTabsOptions); - constructor(element: Element, options?: dxTabsOptions); - } - export interface dxTabPanelOptions extends dxMultiViewOptions { - /** A handler for the titleClick event. */ - onTitleClick?: any; - /** A handler for the titleHold event. */ - onTitleHold?: Function; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - titleTemplate?: any; - /** The template to be used for rendering an item title. */ - itemTitleTemplate?: any; - } - /** A widget used to display a view and to switch between several views by clicking the appropriate tabs. */ - export class dxTabPanel extends dxMultiView { - constructor(element: JQuery, options?: dxTabPanelOptions); - constructor(element: Element, options?: dxTabPanelOptions); - } - export interface dxSelectBoxOptions extends dxDropDownListOptions { - /** The template to be used for rendering the widget text field. */ - fieldTemplate?: any; - /** The text that is provided as a hint in the select box editor. */ - placeholder?: string; - /** Specifies whether or not the widget allows an end-user to enter a custom value. */ - fieldEditEnabled?: boolean; - } - /** A widget that allows you to select an item in a dropdown list. */ - export class dxSelectBox extends dxDropDownList { - constructor(element: JQuery, options?: dxSelectBoxOptions); - constructor(element: Element, options?: dxSelectBoxOptions); - } - export interface dxTagBoxOptions extends dxSelectBoxOptions { - /** Holds the list of selected values. */ - values?: Array; - } - /** A widget that allows you to select multiple items from a dropdown list. */ - export class dxTagBox extends dxSelectBox { - constructor(element: JQuery, options?: dxTagBoxOptions); - constructor(element: Element, options?: dxTagBoxOptions); - } - export interface dxScrollViewOptions extends dxScrollableOptions { - /** A handler for the pullDown event. */ - onPullDown?: Function; - pullDownAction?: Function; - /** Specifies the text shown in the pullDown panel when pulling the content down lowers the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while pulling the content down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the reachBottom event. */ - onReachBottom?: Function; - reachBottomAction?: Function; - /** Specifies the text shown in the pullDown panel displayed when content is scrolled to the bottom. */ - reachBottomText?: string; - /** Specifies the text shown in the pullDown panel displayed when the content is being refreshed. */ - refreshingText?: string; - /** Returns a value indicating if the scrollView content is larger then the widget container. */ - isFull(): boolean; - /** Locks the widget until the release(preventScrollBottom) method is called and executes the function passed to the onPullDown option and the handler assigned to the pullDown event. */ - refresh(): void; - /** Notifies the scroll view that data loading is finished. */ - release(preventScrollBottom: boolean): JQueryPromise; - /** Toggles the loading state of the widget. */ - toggleLoading(showOrHide: boolean): void; - } - /** A widget used to display scrollable content. */ - export class dxScrollView extends dxScrollable { - constructor(element: JQuery, options?: dxScrollViewOptions); - constructor(element: Element, options?: dxScrollViewOptions); - } - export interface dxScrollableLocation { - top?: number; - left?: number; - } - export interface dxScrollableOptions extends DOMComponentOptions { - /** A string value specifying the available scrolling directions. */ - direction?: string; - /** A Boolean value specifying whether or not the widget can respond to user interaction. */ - disabled?: boolean; - /** A handler for the scroll event. */ - onScroll?: Function; - scrollAction?: Function; - /** Specifies when the widget shows the scrollbar. */ - showScrollbar?: string; - /** A handler for the update event. */ - onUpdated?: Function; - updateAction?: Function; - /** Indicates whether to use native or simulated scrolling. */ - useNative?: boolean; - /** A Boolean value specifying whether to enable or disable the bounce-back effect. */ - bounceEnabled?: boolean; - /** A Boolean value specifying whether or not an end-user can scroll the widget content swiping it up or down. */ - scrollByContent?: boolean; - /** A Boolean value specifying whether or not an end-user can scroll the widget content using the scrollbar. */ - scrollByThumb?: boolean; - } - /** A widget used to display scrollable content. */ - export class dxScrollable extends DOMComponent { - constructor(element: JQuery, options?: dxScrollableOptions); - constructor(element: Element, options?: dxScrollableOptions); - /** Returns the height of the scrollable widget in pixels. */ - clientHeight(): number; - /** Returns the width of the scrollable widget in pixels. */ - clientWidth(): number; - /** Returns an HTML element of the widget. */ - content(): JQuery; - /** Scrolls the widget content by the specified number of pixels. */ - scrollBy(distance: number): void; - /** Scrolls widget content by the specified number of pixels in horizontal and vertical directions. */ - scrollBy(distanceObject: dxScrollableLocation): void; - /** Returns the height of the scrollable content in pixels. */ - scrollHeight(): number; - /** Returns the current scroll position against the leftmost position. */ - scrollLeft(): number; - /** Returns how far the scrollable content is scrolled from the top and from the left. */ - scrollOffset(): dxScrollableLocation; - /** Scrolls widget content to the specified position. */ - scrollTo(targetLocation: number): void; - /** Scrolls widget content to a specified position. */ - scrollTo(targetLocation: dxScrollableLocation): void; - /** Scrolls widget content to the specified element. */ - scrollToElement(element: Element): void; - /** Returns the current scroll position against the topmost position. */ - scrollTop(): number; - /** Returns the width of the scrollable content in pixels. */ - scrollWidth(): number; - /** Updates the dimensions of the scrollable contents. */ - update(): void; - } - export interface dxRadioGroupOptions extends CollectionWidgetOptions { - /** Specifies the radio group layout. */ - layout?: string; - } - /** A widget that enables a user to select one item within a list of items represented by radio buttons. */ - export class dxRadioGroup extends CollectionWidget { - constructor(element: JQuery, options?: dxRadioGroupOptions); - constructor(element: Element, options?: dxRadioGroupOptions); - } - export interface dxPopupOptions extends dxOverlayOptions { - animation?: fx.AnimationOptions; - /** Specifies whether or not to allow a user to drag the popup window. */ - dragEnabled?: boolean; - /** A Boolean value specifying whether or not to display the widget in full-screen mode. */ - fullScreen?: boolean; - position?: PositionOptions; - /** A Boolean value specifying whether or not to display the title in the popup window. */ - showTitle?: boolean; - /** The title in the overlay window. */ - title?: string; - /** A template to be used for rendering the widget title. */ - titleTemplate?: any; - width?: any; - /** Specifies items displayed on the top or bottom toolbar of the popup window. */ - buttons?: Array; - /** Specifies whether or not the widget displays the Close button. */ - showCloseButton?: boolean; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - } - /** A widget that displays required content in a popup window. */ - export class dxPopup extends dxOverlay { - constructor(element: JQuery, options?: dxPopupOptions); - constructor(element: Element, options?: dxPopupOptions); - } - export interface dxPopoverOptions extends dxPopupOptions { - /** An object defining animation options of the widget. */ - animation?: fx.AnimationOptions; - /** Specifies the height of the widget. */ - height?: any; - /** An object defining widget positioning options. */ - position?: PositionOptions; - shading?: boolean; - /** A Boolean value specifying whether or not to display the title in the overlay window. */ - showTitle?: boolean; - /** The target element associated with a popover. */ - target?: any; - /** Specifies the width of the widget. */ - width?: any; - } - /** A widget that displays the required content in a popup window. */ - export class dxPopover extends dxPopup { - constructor(element: JQuery, options?: dxPopoverOptions); - constructor(element: Element, options?: dxPopoverOptions); - /** Displays the widget for the specified target element. */ - show(target?: any): JQueryPromise; - } - export interface dxOverlayOptions extends WidgetOptions { - /** An object that defines the animation options of the widget. */ - animation?: fx.AnimationOptions; - /** A Boolean value specifying whether or not the widget is closed if a user presses the Back hardware button. */ - closeOnBackButton?: boolean; - /** A Boolean value specifying whether or not the widget is closed if a user clicks outside of the overlapping window. */ - closeOnOutsideClick?: any; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - /** Specifies whether or not an end-user can drag the widget. */ - dragEnabled?: boolean; - /** Specifies whether or not an end user can resize the widget. */ - resizeEnabled?: boolean; - /** The height of the widget in pixels. */ - height?: any; - /** A handler for the hidden event. */ - onHidden?: Function; - hiddenAction?: Function; - /** A handler for the hiding event. */ - onHiding?: Function; - hidingAction?: Function; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** A Boolean value specifying whether or not the main screen is inactive while the widget is active. */ - shading?: boolean; - /** Specifies the shading color. */ - shadingColor?: string; - /** A handler for the showing event. */ - onShowing?: Function; - showingAction?: Function; - /** A handler for the shown event. */ - onShown?: Function; - shownAction?: Function; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - /** The widget width in pixels. */ - width?: any; - } - /** A widget displaying the required content in an overlay window. */ - export class dxOverlay extends Widget { - constructor(element: JQuery, options?: dxOverlayOptions); - constructor(element: Element, options?: dxOverlayOptions); - /** An HTML element of the widget. */ - content(): JQuery; - /** Hides the widget. */ - hide(): JQueryPromise; - /** Recalculates the overlay's size and position. */ - repaint(): void; - /** Shows the widget. */ - show(): JQueryPromise; - /** Toggles the visibility of the widget. */ - toggle(showing: boolean): JQueryPromise; - /** A static method that specifies the base z-index for all overlay widgets. */ - static baseZIndex(zIndex: number): void; - } - export interface dxNumberBoxOptions extends dxTextEditorOptions { - /** The maximum value accepted by the number box. */ - max?: number; - /** The minimum value accepted by the number box. */ - min?: number; - /** Specifies whether or not to show spin buttons. */ - showSpinButtons?: boolean; - useTouchSpinButtons?: boolean; - /** Specifies by which value the widget value changes when a spin button is clicked. */ - step?: number; - /** The current number box value. */ - value?: number; - } - /** A textbox widget that enables a user to enter numeric values. */ - export class dxNumberBox extends dxTextEditor { - constructor(element: JQuery, options?: dxNumberBoxOptions); - constructor(element: Element, options?: dxNumberBoxOptions); - } - export interface dxNavBarOptions extends dxTabsOptions { - scrollingEnabled?: boolean; - } - /** A widget that contains items used to navigate through application views. */ - export class dxNavBar extends dxTabs { - constructor(element: JQuery, options?: dxNavBarOptions); - constructor(element: Element, options?: dxNavBarOptions); - } - export interface dxMultiViewOptions extends CollectionWidgetOptions { - /** Specifies whether or not to animate the displayed item change. */ - animationEnabled?: boolean; - /** A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped. */ - loop?: boolean; - /** The index of the currently displayed item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to allow users to change the selected index by swiping. */ - swipeEnabled?: boolean; - } - /** A widget used to display a view and to switch between several views. */ - export class dxMultiView extends CollectionWidget { - constructor(element: JQuery, options?: dxMultiViewOptions); - constructor(element: Element, options?: dxMultiViewOptions); - } - export interface dxMapOptions extends WidgetOptions { - /** Specifies whether or not the widget automatically adjusts center and zoom option values when adding a new marker or route. */ - autoAdjust?: boolean; - bounds?: { - northEast?: { - lat?: number; - lng?: number; - }; - southWest?: { - lat?: number; - lng?: number; - }; - /** An object, a string, or an array specifying the location displayed at the center of the widget. */ - center?: { - /** The latitude location displayed in the center of the widget. */ - lat?: number; - /** The longitude location displayed in the center of the widget. */ - lng?: number; - }; - /** A handler for the click event. */ - onClick?: any; - clickAction?: any; - /** Specifies whether or not map widget controls are available. */ - controls?: boolean; - /** Specifies the height of the widget. */ - height?: number; - /** A key used to authenticate the application within the required map provider. */ - key?: { - /** A key used to authenticate the application within the "Bing" map provider. */ - bing?: string; - /** A key used to authenticate the application within the "Google" map provider. */ - google?: string; - /** A key used to authenticate the application within the "Google Static" map provider. */ - googleStatic?: string; - } - /** A handler for the markerAdded event. */ - onMarkerAdded?: Function; - markerAddedAction?: Function; - /** A URL pointing to the custom icon to be used for map markers. */ - markerIconSrc?: string; - /** A handler for the markerRemoved event. */ - onMarkerRemoved?: Function; - markerRemovedAction?: Function; - /** An array of markers displayed on a map. */ - markers?: Array; - /** The name of the current map data provider. */ - provider?: string; - /** A handler for the ready event. */ - onReady?: Function; - readyAction?: Function; - /** A handler for the routeAdded event. */ - onRouteAdded?: Function; - routeAddedAction?: Function; - /** A handler for the routeRemoved event. */ - onRouteRemoved?: Function; - routeRemovedAction?: Function; - /** An array of routes shown on the map. */ - routes?: Array; - /** The type of a map to display. */ - type?: string; - /** Specifies the width of the widget. */ - width?: number; - /** The zoom level of the map. */ - zoom?: number; - /** Adds a marker to the map. */ - addMarker(markerOptions: Object): JQueryPromise; - /** Adds a route to the map. */ - addRoute(options: Object): JQueryPromise; - /** Removes a marker from the map. */ - removeMarker(marker: Object): JQueryPromise; - /** Removes a route from the map. */ - removeRoute(route: any): JQueryPromise; - }; - } - /** An interactive map widget. */ - export class dxMap extends Widget { - constructor(element: JQuery, options?: dxMapOptions); - constructor(element: Element, options?: dxMapOptions); - } - export interface dxLookupOptions extends dxDropDownListOptions { - /** An object defining widget animation options. */ - animation?: fx.AnimationOptions; - /** The text displayed on the Cancel button. */ - cancelButtonText?: string; - /** The text displayed on the Clear button. */ - clearButtonText?: string; - /** Specifies whether or not the widget cleans the search box when the popup window is displayed. */ - cleanSearchOnOpening?: boolean; - /** A Boolean value specifying whether or not the widget is closed if a user clicks outside of the overlaying window. */ - closeOnOutsideClick?: any; - /** The text displayed on the Apply button. */ - applyButtonText?: string; - /** A Boolean value specifying whether or not to display the lookup in full-screen mode. */ - fullScreen?: boolean; - /** A Boolean value specifying whether or not to group widget items. */ - grouped?: boolean; - groupRender?: any; - /** The name of the template used to display a group header. */ - groupTemplate?: any; - /** The text displayed on the button used to load the next page from the data source. */ - nextButtonText?: string; - /** A handler for the pageLoading event. */ - onPageLoading?: Function; - /** Specifies whether the next page is loaded when a user scrolls the widget to the bottom or when the "next" button is clicked. */ - pageLoadMode?: string; - pageLoadingAction?: Function; - /** Specifies the text shown in the pullDown panel, which is displayed when the widget is scrolled to the bottom. */ - pageLoadingText?: string; - /** The text displayed by the widget when nothing is selected. */ - placeholder?: string; - /** The height of the widget popup element. */ - popupHeight?: any; - /** The width of the widget popup element. */ - popupWidth?: any; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** Specifies the text displayed in the pullDown panel when the widget is pulled below the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the pullRefresh event. */ - onPullRefresh?: Function; - pullRefreshAction?: Function; - /** A Boolean value specifying whether or not the widget supports the "pull down to refresh" gesture. */ - pullRefreshEnabled?: boolean; - /** Specifies the text displayed in the pullDown panel while the widget is being refreshed. */ - refreshingText?: string; - /** A handler for the scroll event. */ - onScroll?: Function; - scrollAction?: Function; - /** A Boolean value specifying whether or not the search bar is visible. */ - searchEnabled?: boolean; - /** The text that is provided as a hint in the lookup's search bar. */ - searchPlaceholder?: string; - /** A Boolean value specifying whether or not the main screen is inactive while the lookup is active. */ - shading?: boolean; - /** Specifies whether to display the Cancel button in the lookup window. */ - showCancelButton?: boolean; - /** - * A Boolean value specifying whether the widget loads the next page automatically when you reach the bottom of the list or when a button is clicked. - * @deprecated pageLoadMode.md - */ - showNextButton?: boolean; - /** The title of the lookup window. */ - title?: string; - /** A template to be used for rendering the widget title. */ - titleTemplate?: any; - /** Specifies whether or not the widget uses native scrolling. */ - useNativeScrolling?: boolean; - /** Specifies whether or not to show lookup contents in a dxPopover widget. */ - usePopover?: boolean; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - contentReadyAction?: Function; - titleRender?: any; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - /** A Boolean value specifying whether or not to display the title in the popup window. */ - showPopupTitle?: boolean; - } - /** A widget that allows a user to select predefined values from a lookup window. */ - export class dxLookup extends dxDropDownList { - constructor(element: JQuery, options?: dxLookupOptions); - constructor(element: Element, options?: dxLookupOptions); - /** This section lists the data source fields that are used in a default template for lookup drop-down items. */ - } - export interface dxLoadPanelOptions extends dxOverlayOptions { - /** An object defining the animation options of the widget. */ - animation?: fx.AnimationOptions; - /** The delay in milliseconds after which the load panel is displayed. */ - delay?: number; - /** The height of the widget. */ - height?: number; - /** A URL pointing to an image to be used as a load indicator. */ - indicatorSrc?: string; - /** The text displayed in the load panel. */ - message?: string; - /** A Boolean value specifying whether or not to show a load indicator. */ - showIndicator?: boolean; - /** A Boolean value specifying whether or not to show the pane behind the load indicator. */ - showPane?: boolean; - /** The width of the widget. */ - width?: number; - } - /** A widget used to indicate whether or not an element is loading. */ - export class dxLoadPanel extends dxOverlay { - constructor(element: JQuery, options?: dxLoadPanelOptions); - constructor(element: Element, options?: dxLoadPanelOptions); - } - export interface dxLoadIndicatorOptions extends WidgetOptions { - /** Specifies the path to an image used as the indicator. */ - indicatorSrc?: string; - } - /** The widget used to indicate the loading process. */ - export class dxLoadIndicator extends Widget { - constructor(element: JQuery, options?: dxLoadIndicatorOptions); - constructor(element: Element, options?: dxLoadIndicatorOptions); - } - export interface dxListOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not to display a grouped list. */ - grouped?: boolean; - groupRender?: any; - /** The template to be used for rendering item groups. */ - groupTemplate?: any; - onItemDeleting?: Function; - /** A handler for the itemDeleted event. */ - onItemDeleted?: Function; - /** A handler for the groupRendered event. */ - onGroupRendered?: Function; - itemDeleteAction?: Function; - /** A handler for the itemReordered event. */ - onItemReordered?: Function; - itemReorderAction?: Function; - /** A handler for the itemClick event. */ - onItemClick?: any; - /** A handler for the itemSwipe event. */ - onItemSwipe?: Function; - itemSwipeAction?: Function; - /** The text displayed on the button used to load the next page from the data source. */ - nextButtonText?: string; - /** A handler for the pageLoading event. */ - onPageLoading?: Function; - pageLoadingAction?: Function; - /** Specifies the text shown in the pullDown panel, which is displayed when the list is scrolled to the bottom. */ - pageLoadingText?: string; - /** Specifies the text displayed in the pullDown panel when the list is pulled below the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the pullRefresh event. */ - onPullRefresh?: Function; - pullRefreshAction?: Function; - /** A Boolean value specifying whether or not the widget supports the "pull down to refresh" gesture. */ - pullRefreshEnabled?: boolean; - /** Specifies the text displayed in the pullDown panel while the list is being refreshed. */ - refreshingText?: string; - /** A handler for the scroll event. */ - onScroll?: Function; - scrollAction?: Function; - /** A Boolean value specifying whether to enable or disable list scrolling. */ - scrollingEnabled?: boolean; - /** Specifies when the widget shows the scrollbar. */ - showScrollbar?: string; - /** Specifies whether or not the widget uses native scrolling. */ - useNativeScrolling?: boolean; - /** A Boolean value specifying whether to enable or disable the bounce-back effect. */ - bounceEnabled?: boolean; - /** A Boolean value specifying if the list is scrolled by content. */ - scrollByContent?: boolean; - /** A Boolean value specifying if the list is scrolled using the scrollbar. */ - scrollByThumb?: boolean; - itemUnselectAction?: Function; - onItemContextMenu?: Function; - onItemHold?: Function; - /** Specifies whether or not an end-user can collapse groups. */ - collapsibleGroups?: boolean; - /** Specifies whether the next page is loaded when a user scrolls the widget to the bottom or when the "next" button is clicked. */ - pageLoadMode?: string; - /** Specifies whether or not to display controls used to select list items. */ - showSelectionControls?: boolean; - /** Specifies whether the list supports single item selection or multi-selection. */ - selectionMode?: string; - selectAllText?: string; - /** Specifies the array of items for a context menu called for a list item. */ - menuItems?: Array; - /** Specifies whether an item context menu is shown when a user holds or swipes an item. */ - menuMode?: string; - /** Specifies whether or not an end user can delete list items. */ - allowItemDeleting?: boolean; - /** Specifies the way a user can delete items from the list. */ - itemDeleteMode?: string; - /** Specifies whether or not an end user can reorder list items. */ - allowItemReordering?: boolean; - /** Specifies whether or not to show the loading panel when the DataSource bound to the widget is loading data. */ - indicateLoading?: boolean; - } - /** A list widget. */ - export class dxList extends CollectionWidget { - constructor(element: JQuery, options?: dxListOptions); - constructor(element: Element, options?: dxListOptions); - /** Returns the height of the widget in pixels. */ - clientHeight(): number; - /** Removes the specified item from the list. */ - deleteItem(itemIndex: any): JQueryPromise; - /** Removes the specified item from the list. */ - deleteItem(itemElement: Element): JQueryPromise; - /** Returns a Boolean value that indicates whether or not the specified item is selected. */ - isItemSelected(itemIndex: any): boolean; - /** Returns a Boolean value that indicates whether or not the specified item is selected. */ - isItemSelected(itemElement: Element): boolean; - /** Reloads list data. */ - reload(): void; - /** Moves the specified item to the specified position in the list. */ - reorderItem(itemElement: Element, toItemElement: Element): JQueryPromise; - /** Moves the specified item to the specified position in the list. */ - reorderItem(itemIndex: any, toItemIndex: any): JQueryPromise; - /** Scrolls the list content by the specified number of pixels. */ - scrollBy(distance: number): void; - /** Returns the height of the list content in pixels. */ - scrollHeight(): number; - /** Scrolls list content to the specified position. */ - scrollTo(location: number): void; - /** Scrolls the list to the specified item. */ - scrollToItem(itemElement: Element): void; - /** Scrolls the list to the specified item. */ - scrollToItem(itemIndex: any): void; - /** Returns how far the list content is scrolled from the top. */ - scrollTop(): number; - /** Selects the specified item from the list. */ - selectItem(itemElement: Element): void; - /** Selects the specified item from the list. */ - selectItem(itemIndex: any): void; - /** Deselects the specified item from the list. */ - unselectItem(itemElement: Element): void; - /** Unselects the specified item from the list. */ - unselectItem(itemIndex: any): void; - /** Updates the widget scrollbar according to widget content size. */ - updateDimensions(): JQueryPromise; - /** Expands the specified group. */ - expandGroup(groupIndex: number): JQueryPromise; - /** Collapses the specified group. */ - collapseGroup(groupIndex: number): JQueryPromise; - } - export interface dxGalleryOptions extends CollectionWidgetOptions { - /** The time, in milliseconds, spent on slide animation. */ - animationDuration?: number; - /** Specifies whether or not to animate the displayed item change. */ - animationEnabled?: boolean; - /** A Boolean value specifying whether or not to allow users to switch between items by clicking an indicator. */ - indicatorEnabled?: boolean; - /** A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped. */ - loop?: boolean; - /** The index of the currently active gallery item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to display an indicator that points to the selected gallery item. */ - showIndicator?: boolean; - /** A Boolean value that specifies the availability of the "Forward" and "Back" navigation buttons. */ - showNavButtons?: boolean; - /** The time interval in milliseconds, after which the gallery switches to the next item. */ - slideshowDelay?: number; - /** A Boolean value specifying whether or not to allow users to switch between items by swiping. */ - swipeEnabled?: boolean; - /** Specifies whether or not to display parts of previous and next images along the sides of the current image. */ - wrapAround?: boolean; - /** Specifies if the widget stretches images to fit the total gallery width. */ - stretchImages?: boolean; - /** Specifies the width of an area used to display a single image. */ - initialItemWidth?: number; - } - /** An image gallery widget. */ - export class dxGallery extends CollectionWidget { - constructor(element: JQuery, options?: dxGalleryOptions); - constructor(element: Element, options?: dxGalleryOptions); - /** Shows the specified gallery item. */ - goToItem(itemIndex: number, animation: boolean): JQueryPromise; - /** Shows the next gallery item. */ - nextItem(animation: boolean): JQueryPromise; - /** Shows the previous gallery item. */ - prevItem(animation: boolean): JQueryPromise; - } - export interface dxDropDownEditorOptions extends dxTextBoxOptions { - /** Specifies the current value displayed by the widget. */ - value?: Object; - /** A handler for the closed event. */ - onClosed?: Function; - /** A handler for the opened event. */ - onOpened?: Function; - /** Specifies whether or not the drop-down editor is displayed. */ - opened?: boolean; - closeAction?: Function; - openAction?: Function; - shownAction?: Function; - hiddenAction?: Function; - /** Specifies whether or not the widget allows an end-user to enter a custom value. */ - fieldEditEnabled?: boolean; - editEnabled?: boolean; - /** Specifies the way an end-user applies the selected value. */ - applyValueMode?: string; - } - /** A drop-down editor widget. */ - export class dxDropDownEditor extends dxTextBox { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - /** Closes the drop-down editor. */ - close(): void; - /** Opens the drop-down editor. */ - open(): void; - /** Resets the widget's value to null. */ - reset(): void; - /** Returns an <input> element of the widget. */ - field(): JQuery; - /** Returns an HTML element of the popup window content. */ - content(): JQuery; - } - export interface dxDateBoxOptions extends dxTextEditorOptions { - /** A format used to display date/time information. */ - format?: string; - /** A Globalize format string specifying the date display format. */ - formatString?: string; - /** The last date that can be selected within the widget. */ - max?: Date; - /** The minimum date that can be selected within the widget. */ - min?: Date; - /** The text displayed by the widget when the widget value is not yet specified. This text is also used as a title of the date picker. */ - placeholder?: string; - /** - * Specifies whether or not a user can pick out a date using the drop-down calendar. - * @deprecated Use 'pickerType' option instead. - */ - useCalendar?: boolean; - /** A Date object specifying the date and time currently selected using the date box. */ - value?: Date; - /** - * Specifies whether or not the widget uses the native HTML input element. - * @deprecated Use 'pickerType' option instead. - */ - useNative?: boolean; - /** Specifies the interval between neighboring values in the popup list in minutes. */ - interval?: number; - /** Specifies the maximum zoom level of a calendar, which is used to pick the date. */ - maxZoomLevel?: string; - /** Specifies the minimal zoom level of a calendar, which is used to pick the date. */ - minZoomLevel?: string; - /** Specifies the type of date/time picker. */ - pickerType?: string; - } - /** A date box widget. */ - export class dxDateBox extends dxDropDownEditor { - constructor(element: JQuery, options?: dxDateBoxOptions); - constructor(element: Element, options?: dxDateBoxOptions); - } - export interface dxCheckBoxOptions extends EditorOptions { - /** Specifies the widget state. */ - value?: boolean; - /** Specifies the text displayed by the check box. */ - text?: string; - } - /** A check box widget. */ - export class dxCheckBox extends Editor { - constructor(element: JQuery, options?: dxCheckBoxOptions); - constructor(element: Element, options?: dxCheckBoxOptions); - } - export interface dxCalendarOptions extends EditorOptions { - /** Specifies a date displayed on the current calendar page. */ - currentDate?: Date; - /** Specifies the first day of a week. */ - firstDayOfWeek?: number; - /** The latest date the widget allows to select. */ - max?: Date; - /** The earliest date the widget allows to select. */ - min?: Date; - /** Specifies whether or not the widget displays a button that selects the current date. */ - showTodayButton?: boolean; - /** Specifies the current calendar zoom level. */ - zoomLevel?: string; - /** Specifies the maximum zoom level of the calendar. */ - maxZoomLevel?: string; - /** Specifies the minimum zoom level of the calendar. */ - minZoomLevel?: string; - /** The template to be used for rendering calendar cells. */ - cellTemplate?: any; - } - /** A calendar widget. */ - export class dxCalendar extends Editor { - constructor(element: JQuery, options?: dxCalendarOptions); - constructor(element: Element, options?: dxCalendarOptions); - } - export interface dxButtonOptions extends WidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A handler for the click event. */ - onClick?: any; - clickAction?: any; - /** The name of an icon to be displayed on the button. */ - icon?: string; - iconSrc?: string; - /** The text displayed on the button. */ - text?: string; - /** Specifies the button type. */ - type?: string; - /** Specifies the name of the validation group to be accessed in the click event handler. */ - validationGroup?: string; - } - /** A button widget. */ - export class dxButton extends Widget { - constructor(element: JQuery, options?: dxButtonOptions); - constructor(element: Element, options?: dxButtonOptions); - } - export interface dxBoxOptions extends CollectionWidget { - /** Specifies how widget items are aligned along the main direction. */ - align?: string; - /** Specifies the direction of item positioning in the widget. */ - direction?: string; - /** Specifies how widget items are aligned cross-wise. */ - crossAlign?: string; - } - /** A container widget used to arrange inner elements. */ - export class dxBox extends CollectionWidget { - constructor(element: JQuery, options?: dxBoxOptions); - constructor(element: Element, options?: dxBoxOptions); - } - export interface dxResponsiveBoxOptions extends CollectionWidgetOptions { - /** Specifies the collection of rows for the grid used to position layout elements. */ - rows?: Array; - /** Specifies the collection of columns for the grid used to position layout elements. */ - cols?: Array; - /** Specifies the function returning the screen factor depending on the screen width. */ - screenByWidth?: (width: number) => string; - /** Specifies the screen factor with which all elements are located in a single column. */ - singleColumnScreen?: string; - } - /** A widget used to build an adaptive markup that is dependent on screen resolution. */ - export class dxResponsiveBox extends CollectionWidget { - constructor(element: JQuery, options?: dxBoxOptions); - constructor(element: Element, options?: dxBoxOptions); - } - export interface dxAutocompleteOptions extends dxDropDownListOptions { - /** Specifies the current value displayed by the widget. */ - value?: string; - /** The minimum number of characters that must be entered into the text box to begin a search. */ - minSearchLength?: number; - /** Specifies the maximum count of items displayed by the widget. */ - maxItemCount?: number; - /** Specifies the currently selected item. */ - selectedItem?: Object; - } - /** A textbox widget that supports autocompletion. */ - export class dxAutocomplete extends dxDropDownList { - constructor(element: JQuery, options?: dxAutocompleteOptions); - constructor(element: Element, options?: dxAutocompleteOptions); - /** Opens the drop-down editor. */ - open(): void; - /** Closes the drop-down editor. */ - close(): void; - } - export interface dxAccordionOptions extends CollectionWidgetOptions { - /** A number specifying the time in milliseconds spent on the animation of the expanding or collapsing of a panel. */ - animationDuration?: number; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies whether all items can be collapsed or whether at least one item must always be expanded. */ - collapsible?: boolean; - /** Specifies whether the widget can expand several items or only a single item at once. */ - multiple?: boolean; - /** The template to be used for rendering dxAccordion items. */ - itemTemplate?: any; - /** A handler for the itemTitleClick event. */ - onItemTitleClick?: any; - /** A handler for the itemTitleHold event. */ - onItemTitleHold?: Function; - /** The template to be used for rendering an item title. */ - itemTitleTemplate?: any; - /** The index number of the currently selected item. */ - selectedIndex?: number; - } - /** A widget that displays data source items on collapsible panels. */ - export class dxAccordion extends CollectionWidget { - constructor(element: JQuery, options?: dxAccordionOptions); - constructor(element: Element, options?: dxAccordionOptions); - /** Collapses the specified item. */ - collapseItem(index: number): JQueryPromise; - /** Expands the specified item. */ - expandItem(index: number): JQueryPromise; - } - export interface dxFileUploaderOptions extends EditorOptions { - /** A read-only option that holds a File instance representing the selected file. */ - value?: File; - /** Holds the File instances representing files selected in the widget. */ - values?: Array; - buttonText?: string; - /** The text displayed on the button that opens the file browser. */ - selectButtonText?: string; - /** The text displayed on the button that starts uploading. */ - uploadButtonText?: string; - /** Specifies the text displayed on the area to which an end-user can drop a file. */ - labelText?: string; - /** Specifies the value passed to the name attribute of the underlying input element. */ - name?: string; - /** Specifies whether the widget enables an end-user to select a single file or multiple files. */ - multiple?: boolean; - /** Specifies a file type or several types accepted by the widget. */ - accept?: string; - /** Specifies a target Url for the upload request. */ - uploadUrl?: string; - /** Specifies if an end user can remove a file from the selection and interrupt uploading. */ - allowCanceling?: boolean; - /** Specifies whether or not the widget displays the list of selected files. */ - showFileList?: boolean; - /** Gets the current progress in percentages. */ - progress?: number; - /** The message displayed by the widget when it is ready to upload the specified files. */ - readyToUploadMessage?: string; - /** The message displayed by the widget when uploading is finished. */ - uploadedMessage?: string; - /** The message displayed by the widget on uploading failure. */ - uploadFailedMessage?: string; - /** Specifies how the widget uploads files. */ - uploadMode?: string; - } - /** A widget used to select and upload a file or multiple files. */ - export class dxFileUploader extends Editor { - constructor(element: JQuery, options?: dxFileUploaderOptions); - constructor(element: Element, options?: dxFileUploaderOptions); - } - export interface dxTrackBarOptions extends EditorOptions { - /** The minimum value the widget can accept. */ - min?: number; - /** The maximum value the widget can accept. */ - max?: number; - /** The current widget value. */ - value?: number; - } - /** A base class for track bar widgets. */ - export class dxTrackBar extends Editor { - constructor(element: JQuery, options?: dxTrackBarOptions); - constructor(element: Element, options?: dxTrackBarOptions); - } - export interface dxProgressBarOptions extends dxTrackBarOptions { - /** Specifies a format for the progress status. */ - statusFormat?: any; - /** Specifies whether or not the widget displays a progress status. */ - showStatus?: boolean; - /** A handler for the complete event. */ - onComplete?: Function; - } - /** A widget used to indicate progress. */ - export class dxProgressBar extends dxTrackBar { - constructor(element: JQuery, options?: dxProgressBarOptions); - constructor(element: Element, options?: dxProgressBarOptions); - } - export interface dxSliderOptions extends dxTrackBarOptions { - /** The slider step size. */ - step?: number; - /** The current slider value. */ - value?: number; - /** Specifies whether or not to highlight a range selected within the widget. */ - showRange?: boolean; - /** Specifies the size of a step by which a slider handle is moved when a user uses the Page up or Page down keyboard shortcuts. */ - keyStep?: number; - /** Specifies options for the slider tooltip. */ - tooltip?: { - /** Specifies whether or not the tooltip is enabled. */ - enabled?: boolean; - /** Specifies format for the tooltip. */ - format?: any; - /** Specifies whether the tooltip is located over or under the slider. */ - position?: string; - /** Specifies whether the widget always shows a tooltip or only when a pointer is over the slider. */ - showMode?: string; - }; - /** Specifies options for labels displayed at the min and max values. */ - label?: { - /** Specifies whether or not slider labels are visible. */ - visible?: boolean; - /** Specifies whether labels are located over or under the scale. */ - position?: string; - /** Specifies a format for labels. */ - format?: any; - }; - } - /** A widget that allows a user to select a numeric value within a given range. */ - export class dxSlider extends dxTrackBar { - constructor(element: JQuery, options?: dxSliderOptions); - constructor(element: Element, options?: dxSliderOptions); - } - export interface dxRangeSliderOptions extends dxSliderOptions { - /** The left edge of the interval currently selected using the range slider. */ - start?: number; - /** The right edge of the interval currently selected using the range slider. */ - end?: number; - } - /** A widget that enables a user to select a range of numeric values. */ - export class dxRangeSlider extends dxSlider { - constructor(element: JQuery, options?: dxRangeSliderOptions); - constructor(element: Element, options?: dxRangeSliderOptions); - } -} -interface JQuery { - dxProgressBar(): JQuery; - dxProgressBar(options: "instance"): DevExpress.ui.dxProgressBar; - dxProgressBar(options: string): any; - dxProgressBar(options: string, ...params: any[]): any; - dxProgressBar(options: DevExpress.ui.dxProgressBarOptions): JQuery; - dxSlider(): JQuery; - dxSlider(options: "instance"): DevExpress.ui.dxSlider; - dxSlider(options: string): any; - dxSlider(options: string, ...params: any[]): any; - dxSlider(options: DevExpress.ui.dxSliderOptions): JQuery; - dxRangeSlider(): JQuery; - dxRangeSlider(options: "instance"): DevExpress.ui.dxRangeSlider; - dxRangeSlider(options: string): any; - dxRangeSlider(options: string, ...params: any[]): any; - dxRangeSlider(options: DevExpress.ui.dxRangeSliderOptions): JQuery; - dxFileUploader(): JQuery; - dxFileUploader(options: "instance"): DevExpress.ui.dxFileUploader; - dxFileUploader(options: string): any; - dxFileUploader(options: string, ...params: any[]): any; - dxFileUploader(options: DevExpress.ui.dxFileUploaderOptions): JQuery; - dxValidator(): JQuery; - dxValidator(options: "instance"): DevExpress.ui.dxValidator; - dxValidator(options: string): any; - dxValidator(options: string, ...params: any[]): any; - dxValidationGroup(): JQuery; - dxValidationGroup(options: "instance"): DevExpress.ui.dxValidationGroup; - dxValidationGroup(options: string): any; - dxValidationGroup(options: string, ...params: any[]): any; - dxValidationSummary(): JQuery; - dxValidationSummary(options: "instance"): DevExpress.ui.dxValidationSummary; - dxValidationSummary(options: string): any; - dxValidationSummary(options: string, ...params: any[]): any; - dxTooltip(): JQuery; - dxTooltip(options: "instance"): DevExpress.ui.dxTooltip; - dxTooltip(options: string): any; - dxTooltip(options: string, ...params: any[]): any; - dxTooltip(options: DevExpress.ui.dxTooltipOptions): JQuery; - dxResizable(): JQuery; - dxResizable(options: "instance"): DevExpress.ui.dxResizable; - dxResizable(options: string): any; - dxResizable(options: string, ...params: any[]): any; - dxResizable(options: DevExpress.ui.dxResizableOptions): JQuery; - dxDropDownList(): JQuery; - dxDropDownList(options: "instance"): DevExpress.ui.dxDropDownList; - dxDropDownList(options: string): any; - dxDropDownList(options: string, ...params: any[]): any; - dxDropDownList(options: DevExpress.ui.dxDropDownListOptions): JQuery; - dxToolbar(): JQuery; - dxToolbar(options: "instance"): DevExpress.ui.dxToolbar; - dxToolbar(options: string): any; - dxToolbar(options: string, ...params: any[]): any; - dxToolbar(options: DevExpress.ui.dxToolbarOptions): JQuery; - dxToast(): JQuery; - dxToast(options: "instance"): DevExpress.ui.dxToast; - dxToast(options: string): any; - dxToast(options: string, ...params: any[]): any; - dxToast(options: DevExpress.ui.dxToastOptions): JQuery; - dxTextEditor(): JQuery; - dxTextEditor(options: "instance"): DevExpress.ui.dxTextEditor; - dxTextEditor(options: string): any; - dxTextEditor(options: string, ...params: any[]): any; - dxTextEditor(options: DevExpress.ui.dxTextEditorOptions): JQuery; - dxTextBox(): JQuery; - dxTextBox(options: "instance"): DevExpress.ui.dxTextBox; - dxTextBox(options: string): any; - dxTextBox(options: string, ...params: any[]): any; - dxTextBox(options: DevExpress.ui.dxTextBoxOptions): JQuery; - dxTextArea(): JQuery; - dxTextArea(options: "instance"): DevExpress.ui.dxTextArea; - dxTextArea(options: string): any; - dxTextArea(options: string, ...params: any[]): any; - dxTextArea(options: DevExpress.ui.dxTextAreaOptions): JQuery; - dxTabs(): JQuery; - dxTabs(options: "instance"): DevExpress.ui.dxTabs; - dxTabs(options: string): any; - dxTabs(options: string, ...params: any[]): any; - dxTabs(options: DevExpress.ui.dxTabsOptions): JQuery; - dxTabPanel(): JQuery; - dxTabPanel(options: "instance"): DevExpress.ui.dxTabPanel; - dxTabPanel(options: string): any; - dxTabPanel(options: string, ...params: any[]): any; - dxTabPanel(options: DevExpress.ui.dxTabPanelOptions): JQuery; - dxSelectBox(): JQuery; - dxSelectBox(options: "instance"): DevExpress.ui.dxSelectBox; - dxSelectBox(options: string): any; - dxSelectBox(options: string, ...params: any[]): any; - dxSelectBox(options: DevExpress.ui.dxSelectBoxOptions): JQuery; - dxScrollView(): JQuery; - dxScrollView(options: "instance"): DevExpress.ui.dxScrollView; - dxScrollView(options: string): any; - dxScrollView(options: string, ...params: any[]): any; - dxScrollView(options: DevExpress.ui.dxScrollViewOptions): JQuery; - dxScrollable(): JQuery; - dxScrollable(options: "instance"): DevExpress.ui.dxScrollable; - dxScrollable(options: string): any; - dxScrollable(options: string, ...params: any[]): any; - dxScrollable(options: DevExpress.ui.dxScrollableOptions): JQuery; - dxRadioGroup(): JQuery; - dxRadioGroup(options: "instance"): DevExpress.ui.dxRadioGroup; - dxRadioGroup(options: string): any; - dxRadioGroup(options: string, ...params: any[]): any; - dxRadioGroup(options: DevExpress.ui.dxRadioGroupOptions): JQuery; - dxPopup(): JQuery; - dxPopup(options: "instance"): DevExpress.ui.dxPopup; - dxPopup(options: string): any; - dxPopup(options: string, ...params: any[]): any; - dxPopup(options: DevExpress.ui.dxPopupOptions): JQuery; - dxPopover(): JQuery; - dxPopover(options: "instance"): DevExpress.ui.dxPopover; - dxPopover(options: string): any; - dxPopover(options: string, ...params: any[]): any; - dxPopover(options: DevExpress.ui.dxPopoverOptions): JQuery; - dxOverlay(): JQuery; - dxOverlay(options: "instance"): DevExpress.ui.dxOverlay; - dxOverlay(options: string): any; - dxOverlay(options: string, ...params: any[]): any; - dxOverlay(options: DevExpress.ui.dxOverlayOptions): JQuery; - dxNumberBox(): JQuery; - dxNumberBox(options: "instance"): DevExpress.ui.dxNumberBox; - dxNumberBox(options: string): any; - dxNumberBox(options: string, ...params: any[]): any; - dxNumberBox(options: DevExpress.ui.dxNumberBoxOptions): JQuery; - dxNavBar(): JQuery; - dxNavBar(options: "instance"): DevExpress.ui.dxNavBar; - dxNavBar(options: string): any; - dxNavBar(options: string, ...params: any[]): any; - dxNavBar(options: DevExpress.ui.dxNavBarOptions): JQuery; - dxMultiView(): JQuery; - dxMultiView(options: "instance"): DevExpress.ui.dxMultiView; - dxMultiView(options: string): any; - dxMultiView(options: string, ...params: any[]): any; - dxMultiView(options: DevExpress.ui.dxMultiViewOptions): JQuery; - dxMap(): JQuery; - dxMap(options: "instance"): DevExpress.ui.dxMap; - dxMap(options: string): any; - dxMap(options: string, ...params: any[]): any; - dxMap(options: DevExpress.ui.dxMapOptions): JQuery; - dxLookup(): JQuery; - dxLookup(options: "instance"): DevExpress.ui.dxLookup; - dxLookup(options: string): any; - dxLookup(options: string, ...params: any[]): any; - dxLookup(options: DevExpress.ui.dxLookupOptions): JQuery; - dxLoadPanel(): JQuery; - dxLoadPanel(options: "instance"): DevExpress.ui.dxLoadPanel; - dxLoadPanel(options: string): any; - dxLoadPanel(options: string, ...params: any[]): any; - dxLoadPanel(options: DevExpress.ui.dxLoadPanelOptions): JQuery; - dxLoadIndicator(): JQuery; - dxLoadIndicator(options: "instance"): DevExpress.ui.dxLoadIndicator; - dxLoadIndicator(options: string): any; - dxLoadIndicator(options: string, ...params: any[]): any; - dxLoadIndicator(options: DevExpress.ui.dxLoadIndicatorOptions): JQuery; - dxList(): JQuery; - dxList(options: "instance"): DevExpress.ui.dxList; - dxList(options: string): any; - dxList(options: string, ...params: any[]): any; - dxList(options: DevExpress.ui.dxListOptions): JQuery; - dxGallery(): JQuery; - dxGallery(options: "instance"): DevExpress.ui.dxGallery; - dxGallery(options: string): any; - dxGallery(options: string, ...params: any[]): any; - dxGallery(options: DevExpress.ui.dxGalleryOptions): JQuery; - dxDropDownEditor(): JQuery; - dxDropDownEditor(options: "instance"): DevExpress.ui.dxDropDownEditor; - dxDropDownEditor(options: string): any; - dxDropDownEditor(options: string, ...params: any[]): any; - dxDropDownEditor(options: DevExpress.ui.dxDropDownEditorOptions): JQuery; - dxDateBox(): JQuery; - dxDateBox(options: "instance"): DevExpress.ui.dxDateBox; - dxDateBox(options: string): any; - dxDateBox(options: string, ...params: any[]): any; - dxDateBox(options: DevExpress.ui.dxDateBoxOptions): JQuery; - dxCheckBox(): JQuery; - dxCheckBox(options: "instance"): DevExpress.ui.dxCheckBox; - dxCheckBox(options: string): any; - dxCheckBox(options: string, ...params: any[]): any; - dxCheckBox(options: DevExpress.ui.dxCheckBoxOptions): JQuery; - dxBox(): JQuery; - dxBox(options: "instance"): DevExpress.ui.dxBox; - dxBox(options: string): any; - dxBox(options: string, ...params: any[]): any; - dxBox(options: DevExpress.ui.dxBoxOptions): JQuery; - dxButton(): JQuery; - dxButton(options: "instance"): DevExpress.ui.dxButton; - dxButton(options: string): any; - dxButton(options: string, ...params: any[]): any; - dxButton(options: DevExpress.ui.dxButtonOptions): JQuery; - dxCalendar(): JQuery; - dxCalendar(options: "instance"): DevExpress.ui.dxCalendar; - dxCalendar(options: string): any; - dxCalendar(options: string, ...params: any[]): any; - dxCalendar(options: DevExpress.ui.dxCalendarOptions): JQuery; - dxAccordion(): JQuery; - dxAccordion(options: "instance"): DevExpress.ui.dxAccordion; - dxAccordion(options: string): any; - dxAccordion(options: string, ...params: any[]): any; - dxAccordion(options: DevExpress.ui.dxAccordionOptions): JQuery; - dxAutocomplete(): JQuery; - dxAutocomplete(options: "instance"): DevExpress.ui.dxAutocomplete; - dxAutocomplete(options: string): any; - dxAutocomplete(options: string, ...params: any[]): any; - dxAutocomplete(options: DevExpress.ui.dxAutocompleteOptions): JQuery; -} - -declare namespace DevExpress.ui { - export interface dxTileViewOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** Specifies the height of the base tile view item. */ - baseItemHeight?: number; - /** Specifies the width of the base tile view item. */ - baseItemWidth?: number; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies the distance in pixels between adjacent tiles. */ - itemMargin?: number; - /** A Boolean value specifying whether or not to display a scrollbar. */ - showScrollbar?: boolean; - } - /** A widget displaying several blocks of data as tiles. */ - export class dxTileView extends CollectionWidget { - constructor(element: JQuery, options?: dxTileViewOptions); - constructor(element: Element, options?: dxTileViewOptions); - /** Returns the current scroll position of the widget content. */ - scrollPosition(): number; - } - export interface dxSwitchOptions extends EditorOptions { - /** Text displayed when the widget is in a disabled state. */ - offText?: string; - /** Text displayed when the widget is in an enabled state. */ - onText?: string; - /** A Boolean value specifying whether the current switch state is "On" or "Off". */ - value?: boolean; - } - /** A switch widget. */ - export class dxSwitch extends Editor { - constructor(element: JQuery, options?: dxSwitchOptions); - constructor(element: Element, options?: dxSwitchOptions); - } - export interface dxSlideOutViewOptions extends WidgetOptions { - /** Specifies whether or not the menu panel is visible. */ - menuVisible?: boolean; - /** Specifies whether or not the menu is shown when a user swipes the widget content. */ - swipeEnabled?: boolean; - /** A template to be used for rendering menu panel content. */ - menuTemplate?: any; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - } - /** The widget that allows you to slide-out the current view to reveal a custom menu. */ - export class dxSlideOutView extends Widget { - constructor(element: JQuery, options?: dxSlideOutViewOptions); - constructor(element: Element, options?: dxSlideOutViewOptions); - /** Returns an HTML element of the widget menu block. */ - menuContent(): JQuery; - /** Returns an HTML element of the widget content block. */ - content(): JQuery; - /** Displays the widget's menu block. */ - showMenu(): JQueryPromise; - /** Hides the widget's menu block. */ - hideMenu(): JQueryPromise; - /** Toggles the visibility of the widget's menu block. */ - toggleMenuVisibility(): JQueryPromise; - } - export interface dxSlideOutOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A Boolean value specifying whether or not to display a grouped menu. */ - menuGrouped?: boolean; - menuGroupRender?: any; - /** The name of the template used to display a group header. */ - menuGroupTemplate?: any; - menuItemRender?: any; - /** The template used to render menu items. */ - menuItemTemplate?: any; - /** A handler for the menuGroupRendered event. */ - onMenuGroupRendered?: Function; - /** A handler for the menuItemRendered event. */ - onMenuItemRendered?: Function; - /** Specifies whether or not the slide-out menu is displayed. */ - menuVisible?: boolean; - /** Indicates whether the menu can be shown/hidden by swiping the widget's main panel. */ - swipeEnabled?: boolean; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - } - /** The widget that allows you to slide-out the current view to reveal an item list. */ - export class dxSlideOut extends CollectionWidget { - constructor(element: JQuery, options?: dxSlideOutOptions); - constructor(element: Element, options?: dxSlideOutOptions); - /** Hides the widget's slide-out menu. */ - hideMenu(): JQueryPromise; - /** Displays the widget's slide-out menu. */ - showMenu(): JQueryPromise; - /** Toggles the visibility of the widget's slide-out menu. */ - toggleMenuVisibility(showing: boolean): JQueryPromise; - } - export interface dxPivotOptions extends CollectionWidgetOptions { - /** The index of the currently active pivot item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to allow users to switch between items by swiping. */ - swipeEnabled?: boolean; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - } - /** A widget that is similar to a traditional tab control, but optimized for the phone with simplified end-user interaction. */ - export class dxPivot extends CollectionWidget { - constructor(element: JQuery, options?: dxPivotOptions); - constructor(element: Element, options?: dxPivotOptions); - } - export interface dxPanoramaOptions extends CollectionWidgetOptions { - /** An object exposing options for setting a background image for the panorama. */ - backgroundImage?: { - /** Specifies the height of the panorama's background image. */ - height?: number; - /** Specifies the URL of the image that is used as the panorama's background image. */ - url?: string; - /** Specifies the width of the panorama's background image. */ - width?: number; - }; - /** The index of the currently active panorama item. */ - selectedIndex?: number; - /** Specifies the widget content title. */ - title?: string; - } - /** A widget displaying the required content in a long horizontal canvas that extends beyond the frames of the screen. */ - export class dxPanorama extends CollectionWidget { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - } - export interface dxDropDownMenuOptions extends WidgetOptions { - /** A handler for the buttonClick event. */ - onButtonClick?: any; - buttonClickAction?: any; - /** The name of the icon to be displayed by the DropDownMenu button. */ - buttonIcon?: string; - buttonIconSrc?: string; - /** The text displayed in the DropDownMenu button. */ - buttonText?: string; - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** A handler for the itemClick event. */ - onItemClick?: any; - itemClickAction?: any; - itemRender?: any; - /** An array of items displayed by the widget. */ - items?: Array; - /** The template to be used for rendering items. */ - itemTemplate?: any; - /** Specifies whether or not to show the drop down menu within a dxPopover widget. */ - usePopover?: boolean; - /** The width of the menu popup in pixels. */ - popupWidth?: any; - /** The height of the menu popup in pixels. */ - popupHeight?: any; - /** Specifies whether or not the drop-down menu is displayed. */ - opened?: boolean; - /** A Boolean value specifying whether or not the widget changes its state when being hovered by an end user. */ - hoverStateEnabled?: boolean; - } - /** A drop-down menu widget. */ - export class dxDropDownMenu extends Widget { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - /** This section lists the data source fields that are used in a default template for drop-down menu items. */ - /** Opens the drop-down menu. */ - open(): void; - /** Closes the drop-down menu. */ - close(): void; - } - export interface dxActionSheetOptions extends CollectionWidgetOptions { - cancelClickAction?: any; - /** A handler for the cancelClick event. */ - onCancelClick?: any; - /** The text displayed in the button that closes the action sheet. */ - cancelText?: string; - /** Specifies whether or not to display the Cancel button in action sheet. */ - showCancelButton?: boolean; - /** A Boolean value specifying whether or not the title of the action sheet is visible. */ - showTitle?: boolean; - /** Specifies the element the action sheet popover points at. */ - target?: any; - /** The title of the action sheet. */ - title?: string; - /** Specifies whether or not to show the action sheet within a dxPopover widget. */ - usePopover?: boolean; - /** A Boolean value specifying whether or not the dxActionSheet widget is visible. */ - visible?: boolean; - } - /** A widget consisting of a set of choices related to a certain task. */ - export class dxActionSheet extends CollectionWidget { - constructor(element: JQuery, options?: dxActionSheetOptions); - constructor(element: Element, options?: dxActionSheetOptions); - /** Hides the widget. */ - hide(): JQueryPromise; - /** Shows the widget. */ - show(): JQueryPromise; - /** Shows or hides the widget depending on the Boolean value passed as the parameter. */ - toggle(showing: boolean): JQueryPromise; - } -} -interface JQuery { - dxTileView(): JQuery; - dxTileView(options: "instance"): DevExpress.ui.dxTileView; - dxTileView(options: string): any; - dxTileView(options: string, ...params: any[]): any; - dxTileView(options: DevExpress.ui.dxTileViewOptions): JQuery; - dxSwitch(): JQuery; - dxSwitch(options: "instance"): DevExpress.ui.dxSwitch; - dxSwitch(options: string): any; - dxSwitch(options: string, ...params: any[]): any; - dxSwitch(options: DevExpress.ui.dxSwitchOptions): JQuery; - dxSlideOut(): JQuery; - dxSlideOut(options: "instance"): DevExpress.ui.dxSlideOut; - dxSlideOut(options: string): any; - dxSlideOut(options: string, ...params: any[]): any; - dxSlideOut(options: DevExpress.ui.dxSlideOutOptions): JQuery; - dxPivot(): JQuery; - dxPivot(options: "instance"): DevExpress.ui.dxPivot; - dxPivot(options: string): any; - dxPivot(options: string, ...params: any[]): any; - dxPivot(options: DevExpress.ui.dxPivotOptions): JQuery; - dxPanorama(): JQuery; - dxPanorama(options: "instance"): DevExpress.ui.dxPanorama; - dxPanorama(options: string): any; - dxPanorama(options: string, ...params: any[]): any; - dxPanorama(options: DevExpress.ui.dxPanoramaOptions): JQuery; - dxActionSheet(): JQuery; - dxActionSheet(options: "instance"): DevExpress.ui.dxActionSheet; - dxActionSheet(options: string): any; - dxActionSheet(options: string, ...params: any[]): any; - dxActionSheet(options: DevExpress.ui.dxActionSheetOptions): JQuery; - dxDropDownMenu(): JQuery; - dxDropDownMenu(options: "instance"): DevExpress.ui.dxDropDownMenu; - dxDropDownMenu(options: string): any; - dxDropDownMenu(options: string, ...params: any[]): any; - dxDropDownMenu(options: DevExpress.ui.dxDropDownMenuOptions): JQuery; -} -declare namespace DevExpress.data { - export interface XmlaStoreOptions { - /** The HTTP address to an XMLA OLAP server. */ - url?: string; - /** The name of the database associated with the Store. */ - catalog?: string; - /** The cube name. */ - cube?: string; - beforeSend?: (request: Object) => void; - } - /** A Store that provides access to an OLAP cube using the XMLA standard. */ - export class XmlaStore { - constructor(options: XmlaStoreOptions); - } - export interface PivotGridField { - index?: number; - /** A boolean value specifying whether or not the field is visible in the pivot grid and the Field Chooser. */ - visible?: boolean; - /** Name of the data source field containing data for the pivot grid field. */ - dataField?: string; - /** A caption that will be displayed in the pivot grid's field chooser to identify the field. */ - caption?: string; - /** Specifies a type of field values. */ - dataType?: string; - /** Specifies how the values of the current field are combined into groups. Cannot be used for the XmlaStore store type. */ - groupInterval?: any; - /** Specifies how to aggregate field data. Cannot be used for th XmlaStore store type. */ - summaryType?: string; - /** Allows you to use a custom aggregate function to calculate the summary values. Cannot be used for the XmlaStore store type. */ - calculateCustomSummary?: (options: { - summaryProcess?: string; - value?: any; - totalValue?: any; - }) => void; - /** Specifies the function that determines how to split data from the data source into ranges for header items. Cannot be used for the XmlaStore store type. */ - selector?: (data: Object) => any; - /** Type of the area where the field is located. */ - area?: string; - /** Index among the other fields displayed within the same area. */ - areaIndex?: number; - /** The name of the folder in which the field is located. */ - displayFolder?: string; - /** The name of the group to which the field belongs. */ - groupName?: string; - /** The index of the field within a group. */ - groupIndex?: number; - /** Specifies the initial sort order of field values. */ - sortOrder?: string; - /** Specifies how field data should be sorted. Can be used for the XmlaStore store type only. */ - sortBy?: string; - /** Specifies the data field against which the header items of this field should be sorted. */ - sortBySummaryField?: string; - /** The array of field names that specify a path to column/row whose summary field is used for sorting of this field's header items. */ - sortBySummaryPath?: Array; - /** The filter values for the current field. */ - filterValues?: Array; - /** The filter type for the current field. */ - filterType?: string; - /** Indicates whether all header items of the field's header level are expanded. */ - expanded?: boolean; - /** Specifies whether the field should be treated as a Data Field. */ - isMeasure?: boolean; - /** Specifies a display format for field values. */ - format?: string; - /** Specifies a callback function that returns the text to be displayed in the cells of a field. */ - customizeText?: (cellInfo: { value: any; valueText: string }) => string; - /** Specifies a precision for formatted field values. */ - precision?: number; - /** Specifies how to sort the header items. */ - sortingMethod?: (a: Object, b: Object) => number; - /** Allows an end-user to change sorting options. */ - allowSorting?: boolean; - /** Allows an end-user to sort columns by summary values. */ - allowSortingBySummary?: boolean; - /** Allows an end-user to change filtering options. */ - allowFiltering?: boolean; - /** Allows an end-user to expand/collapse all header items within a header level. */ - allowExpandAll?: boolean; - /** Specifies the absolute width of the field in the pivot grid. */ - width?: number; - } - export interface PivotGridDataSourceOptions { - /** Specifies the underlying Store instance used to access data. */ - store?: any; - /** Indicates whether or not the automatic field generation from data in the Store is enabled. */ - retrieveFields?: boolean; - /** Specifies data filtering conditions. */ - filter?: Object; - /** An array of pivot grid fields. */ - fields?: Array; - /** Indicates whether or not the local sorting of the XMLA data should be performed. */ - localSorting?: boolean; - /** A handler for the changed event. */ - onChanged?: () => void; - /** A handler for the loadingChanged event. */ - onLoadingChanged?: (isLoading: boolean) => void; - /** A handler for the loadError event. */ - onLoadError?: (e?: Object) => void; - /** A handler for the fieldsPrepared event. */ - onFieldsPrepared?: (e?: Array) => void; - } - /** An object that provides access to data for the dxPivotGrid widget. */ - export class PivotGridDataSource implements EventsMixin { - constructor(options?: PivotGridDataSource); - /** Starts loading data. */ - load(): JQueryPromise; - /** Indicates whether or not the PivotGridDataSource is currently being loaded. */ - isLoading(): boolean; - /** Gets data displayed in a PivotGrid. */ - getData(): Object; - /** Gets all fields within a specified area. */ - getAreaFields(area: string, collectGroups: boolean): Array; - /** Gets all fields from the data source. */ - fields(): Array; - /** Sets the fields option. */ - fields(fields: Array): void; - /** Gets current options of a specified field. */ - field(id: number): PivotGridField; - /** Sets one or more options of a specified field. */ - field(id: number, field: PivotGridField): void; - /** Collapses a specified header item. */ - collapseHeaderItem(area: string, path: Array): void; - /** Expands a specified header item. */ - expandHeaderItem(area: string, path: Array): void; - /** Disposes of all resources associated with this PivotGridDataSource. */ - dispose(): void; - on(eventName: string, eventHandler: Function): PivotGridDataSource; - on(events: { [eventName: string]: Function; }): PivotGridDataSource; - off(eventName: string): PivotGridDataSource; - off(eventName: string, eventHandler: Function): PivotGridDataSource; - } -} -declare namespace DevExpress.ui { - export interface dxSchedulerOptions extends WidgetOptions { - /** Specifies a date displayed on the current scheduler view by default. */ - currentDate?: Date; - /** Specifies the view used in the scheduler by default. */ - currentView?: string; - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** Specifies the first day of a week. */ - firstDayOfWeek?: number; - /** The template to be used for rendering appointments. */ - appointmentTemplate?: any; - /** Lists the views to be available within the scheduler's View Selector. */ - views?: Array; - /** Specifies the resource kinds by which the scheduler's appointments are grouped in a timetable. */ - groups?: Array; - /** Specifies a start hour in the scheduler view's time interval. */ - startDayHour?: number; - /** Specifies an end hour in the scheduler view's time interval. */ - endDayHour?: number; - /** Specifies whether the scheduler data can be edited at runtime. */ - editing?: boolean; - /** Specifies an array of resources available in the scheduler. */ - resources?: Array<{ - /** Indicates whether or not several resources of this kind can be assigned to an appointment. */ - allowMultiple?: boolean; - /** Indicates whether or not resources of this kind have priority in the color identification of the appointments that have resources of different kinds assigned. */ - mainColor?: boolean; - /** A data source used to fetch resources to be available in the scheduler. */ - dataSource?: any; - /** Specifies the resource object field whose value is displayed by the Resource editor in the Appointment popup window. */ - displayExpr?: any; - /** Specifies the resource object field that is used as a value of the Resource editor in the Appointment popup window. */ - valueExpr?: any; - /** The name of the appointment object field that specifies a resource of this kind. */ - field?: string; - /** Specifies the label of the Appointment popup window field that allows end users to assign a resource of this kind. */ - label?: string; - }>; - /** A handler for the AppoinmentAdding event. */ - onAppointmentAdding?: Function; - /** A handler for the appointmentAdded event. */ - onAppointmentAdded?: Function; - /** A handler for the AppoinmentUpdating event. */ - onAppointmentUpdating?: Function; - /** A handler for the appointmentUpdated event. */ - onAppointmentUpdated?: Function; - /** A handler for the AppoinmentDeleting event. */ - onAppointmentDeleting?: Function; - /** A handler for the appointmentDeleted event. */ - onAppointmentDeleted?: Function; - /** A handler for the appointmentRendered event. */ - onAppointmentRendered?: Function; - } - /** A widget that displays scheduled data using different views and provides the capability to load, add and edit appointments. */ - export class dxScheduler extends Widget { - constructor(element: JQuery, options?: dxSchedulerOptions); - constructor(element: Element, options?: dxSchedulerOptions); - /** Add the appointment defined by the object passed as a parameter to the data associated with the widget. */ - addAppointment(appointment: Object): void; - /** Updates the appointment specified by the first method parameter by the appointment object specified by the second method parameter in the the data associated with the widget. */ - updateAppointment(target: Object, appointment: Object): void; - /** Deletes the appointment defined by the parameter from the the data associated with the widget. */ - deleteAppointment(appointment: Object): void; - } - export interface dxColorBoxOptions extends dxDropDownEditorOptions { - /** Specifies the text displayed on the button that applies changes and closes the drop-down editor. */ - applyButtonText?: string; - applyValueMode?: string; - /** Specifies the text displayed on the button that cancels changes and closes the drop-down editor. */ - cancelButtonText?: string; - /** Specifies whether or not the widget value includes the alpha channel component. */ - editAlphaChannel?: boolean; - /** Specifies the size of a step by which a handle is moved using a keyboard shortcut. */ - keyStep?: number; - } - /** A widget used to specify a color value. */ - export class dxColorBox extends dxDropDownEditor { - constructor(element: JQuery, options?: dxColorBoxOptions); - constructor(element: Element, options?: dxColorBoxOptions); - } - export interface dxColorPickerOptions extends dxColorBoxOptions { } - /** - * A widget used to specify a color value. - * @deprecated Use the dxColorBox widget instead - */ - export class dxColorPicker extends dxColorBox { - constructor(element: JQuery, options?: dxColorPickerOptions); - constructor(element: Element, options?: dxColorPickerOptions); - } - export interface dxTreeViewOptions extends CollectionWidgetOptions { - /** Specifies whether or not to animate item collapsing and expanding. */ - animationEnabled?: boolean; - /** Specifies whether a nested or plain array is used as a data source. */ - dataStructure?: string; - /** Specifies whether or not a user can expand all tree view items by the "*" hot key. */ - expandAllEnabled?: boolean; - /** - * An array of currently expanded item objects. - * @deprecated Use item.expanded field instead - */ - expandedItems?: Array; - /** Specifies whether or not a check box is displayed at each tree view item. */ - showCheckBoxes?: boolean; - /** Specifies whether or not to select nodes recursively. */ - selectNodesRecursive?: boolean; - /** Specifies whether the "Select All" check box is displayed over the tree view. */ - selectAllEnabled?: boolean; - /** Specifies the text displayed at the "Select All" check box. */ - selectAllText?: string; - /** Specifies the name of the data source item field used as a key. */ - keyExpr?: any; - /** Specifies the name of the data source item field whose value is displayed by the widget. */ - displayExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding node is selected. */ - selectedExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding node is expanded. */ - expandedExpr?: any; - /** Specifies the name of the data source item field that contains an array of nested items. */ - itemsExpr?: any; - /** Specifies the name of the data source item field that holds the key of the parent item. */ - parentIdExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding node is disabled. */ - disabledExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding node includes child nodes. */ - hasItemsExpr?: any; - /** Specifies if the virtual mode is enabled. */ - virtualModeEnabled?: boolean; - /** Specifies the parent ID value of the root item. */ - rootValue?: any; - /** A string value specifying available scrolling directions. */ - scrollDirection?: string; - /** A handler for the itemSelected event. */ - onItemSelected?: Function; - /** A handler for the itemExpanded event. */ - onItemExpanded?: Function; - /** A handler for the itemCollapsed event. */ - onItemCollapsed?: Function; - } - /** A widget displaying specified data items as a tree. */ - export class dxTreeView extends CollectionWidget { - constructor(element: JQuery, options?: dxTreeViewOptions); - constructor(element: Element, options?: dxTreeViewOptions); - /** Updates the tree view scrollbars according to the current size of the widget content. */ - updateDimensions(): JQueryPromise; - /** Selects the specified item. */ - selectItem(itemElement: any): void; - /** Unselects the specified item. */ - unselectItem(itemElement: any): void; - /** Expands the specified item. */ - expandItem(itemElement: any): void; - /** Collapses the specified item. */ - collapseItem(itemElement: any): void; - /** Returns all nodes of the tree view. */ - getNodes(): Array; - /** Selects all widget items. */ - selectAll(): void; - /** Unselects all widget items. */ - unselectAll(): void; - } - export interface dxMenuBaseOptions extends CollectionWidgetOptions { - /** An object that defines the animation options of the widget. */ - animation?: fx.AnimationOptions; - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** Specifies the name of the CSS class associated with the menu. */ - cssClass?: string; - /** Holds an array of menu items. */ - items?: Array; - /** Specifies whether or not an item becomes selected if an end-user clicks it. */ - selectionByClick?: boolean; - /** Specifies the selection mode supported by the menu. */ - selectionMode?: string; - /** Specifies options of submenu showing and hiding. */ - showSubmenuMode?: { - /** Specifies the mode name. */ - name?: string; - /** Specifies the delay of submenu show and hiding. */ - delay?: { - /** The time span after which the submenu is shown. */ - show?: number; - /** The time span after which the submenu is hidden. */ - hide?: number; - }; - }; - /** A Boolean value specifying whether or not the widget changes its state when being hovered by an end user. */ - hoverStateEnabled?: boolean; - } - export class dxMenuBase extends CollectionWidget { - constructor(element: JQuery, options?: dxMenuBaseOptions); - constructor(element: Element, options?: dxMenuBaseOptions); - /** Selects the specified item. */ - selectItem(itemElement: any): void; - /** Unselects the specified item. */ - unselectItem(itemElement: any): void; - } - export interface dxMenuOptions extends dxMenuBaseOptions { - /** Specifies whether or not the submenu is hidden when the mouse pointer leaves it. */ - hideSubmenuOnMouseLeave?: boolean; - /** Specifies whether the menu has horizontal or vertical orientation. */ - orientation?: string; - /** Specifies options for showing and hiding the first level submenu. */ - showFirstSubmenuMode?: { - /** Specifies the mode name. */ - name?: string; - /** Specifies the delay of submenu showing and hiding. */ - delay?: { - /** The time span after which the submenu is shown. */ - show?: number; - /** The time span after which the submenu is hidden. */ - hide?: number; - }; - }; - /** Specifies the direction at which the submenus are displayed. */ - submenuDirection?: string; - /** A handler for the submenuHidden event. */ - onSubmenuHidden?: Function; - submenuHiddenAction?: Function; - /** A handler for the submenuHiding event. */ - onSubmenuHiding?: Function; - submenuHidingAction?: Function; - /** A handler for the submenuShowing event. */ - onSubmenuShowing?: Function; - submenuShowingAction?: Function; - /** A handler for the submenuShown event. */ - onSubmenuShown?: Function; - submenuShownAction?: Function; - } - /** A menu widget. */ - export class dxMenu extends dxMenuBase { - constructor(element: JQuery, options?: dxMenuOptions); - constructor(element: Element, options?: dxMenuOptions); - } - export interface dxContextMenuOptions extends dxMenuBaseOptions { - /** Holds an object that specifies options of alternative menu invocation. */ - alternativeInvocationMode?: { - /** Specifies whether or not the standard context menu invocation (on a right mouse click or on a long tap) is disabled. */ - enabled?: Boolean; - /** Specifies the element used to invoke the context menu. */ - invokingElement?: any; - }; - /** A handler for the hidden event. */ - onHidden?: Function; - /** A handler for the hiding event. */ - onHiding?: Function; - /** A handler for the positioning event. */ - onPositioning?: Function; - /** A handler for the showing event. */ - onShowing?: Function; - /** A handler for the shown event. */ - onShown?: Function; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** Specifies the direction at which submenus are displayed. */ - submenuDirection?: string; - /** The target element associated with a popover. */ - target?: any; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - } - /** A context menu widget. */ - export class dxContextMenu extends dxMenuBase { - constructor(element: JQuery, options?: dxContextMenuOptions); - constructor(element: Element, options?: dxContextMenuOptions); - /** Toggles the visibility of the widget. */ - toggle(showing: boolean): JQueryPromise; - /** Shows the widget. */ - show(): JQueryPromise; - /** Hides the widget. */ - hide(): JQueryPromise; - } - export interface dxRemoteOperations { - /** Specifies whether or not filtering must be performed on the server side. */ - filtering?: boolean; - /** Specifies whether or not paging must be performed on the server side. */ - paging?: boolean; - /** Specifies whether or not sorting must be performed on the server side. */ - sorting?: boolean; - } - export interface dxDataGridColumn { - /** Specifies the content alignment within column cells. */ - alignment?: string; - /** Specifies whether the values in a column can be edited at runtime. Setting this option makes sense only when editing is enabled for a grid. */ - allowEditing?: boolean; - /** Specifies whether or not a column can be used for filtering grid records. Setting this option makes sense only when the filter row and column header filtering are visible. */ - allowFiltering?: boolean; - /** Specifies whether or not the column can be anchored to a grid edge by end users. Setting this option makes sense only when the columnFixing | enabled option is set to true. */ - allowFixing?: boolean; - /** Specifies if a column can be used for searching grid records. Setting this option makes sense only when the search panel is visible. */ - allowSearch?: boolean; - /** Specifies whether a column can be used for grouping grid records at runtime. Setting this option makes sense only when the group panel is visible. */ - allowGrouping?: boolean; - /** Specifies whether or not a column can be hidden by a user. Setting this option makes sense only when the column chooser is visible. */ - allowHiding?: boolean; - /** Specifies whether or not a particular column can be used in column reordering. Setting this option makes sense only when the allowColumnReordering option is set to true. */ - allowReordering?: boolean; - /** Specifies whether or not a particular column can be resized by a user. Setting this option makes sense only when the allowColumnResizing option is true. */ - allowResizing?: boolean; - /** Specifies whether grid records can be sorted by a specific column at runtime. Setting this option makes sense only when the sorting mode differs from none. */ - allowSorting?: boolean; - /** Specifies whether groups appear expanded or not when records are grouped by a specific column. Setting this option makes sense only when grouping is allowed for this column. */ - autoExpandGroup?: boolean; - /** Specifies a callback function that returns a value to be displayed in a column cell. */ - calculateCellValue?: (rowData: Object) => string; - /** Specifies a callback function that defines filters for customary calculated grid cells. */ - calculateFilterExpression?: (filterValue: any, selectedFilterOperation: string) => Array; - /** Specifies a caption for a column. */ - caption?: string; - /** Specifies a custom template for grid column cells. */ - cellTemplate?: any; - /** Specifies a CSS class to be applied to a column. */ - cssClass?: string; - /** Specifies a callback function that determines values for column cells to be used for grouping. */ - calculateGroupValue?: any; - /** Specifies a callback function that returns a value or the name of the field to be used for sorting column cells. */ - calculateSortValue?: any; - /** Specifies a callback function that returns the text to be displayed in the cells of a column. */ - customizeText?: (cellInfo: { value: any; valueText: string }) => string; - /** Specifies the field of a data source that provides data for a column. */ - dataField?: string; - /** Specifies the required type of column values. */ - dataType?: string; - /** Specifies a custom template for the cell of a grid column when it is in an editing state. */ - editCellTemplate?: any; - /** Specifies whether HTML tags are displayed as plain text or applied to the values of the column. */ - encodeHtml?: boolean; - /** In a boolean column, replaces all false items with a specified text. */ - falseText?: string; - /** Specifies the set of available filter operations. */ - filterOperations?: Array; - /** Specifies a filter value for a column. */ - filterValue?: any; - /** Specifies initial filter values for the column's header filter. */ - filterValues?: Array; - /** Specifies whether to include or exclude the records with the values selected in the column's header filter. */ - filterType?: string; - /** Indicates whether the column takes part in horizontal grid scrolling or is anchored to a grid edge. */ - fixed?: boolean; - /** Specifies the grid edge to which the column is anchored. */ - fixedPosition?: string; - /** Specifies a format for the values displayed in a column. */ - format?: string; - /** Specifies a custom template for the group cell of a grid column. */ - groupCellTemplate?: any; - /** Specifies the index of a column when grid records are grouped by the values of this column. */ - groupIndex?: number; - /** Specifies a custom template for the header of a grid column. */ - headerCellTemplate?: any; - /** Specifies options of a lookup column. */ - lookup?: { - /** Specifies whether or not a user can nullify values of a lookup column. */ - allowClearing?: boolean; - /** -Specifies the data source providing data for a lookup column. - */ - dataSource?: any; - /** Specifies the expression defining the data source field whose values must be displayed. */ - displayExpr?: any; - /** Specifies the expression defining the data source field whose values must be replaced. */ - valueExpr?: string; - }; - /** Specifies a precision for formatted values displayed in a column. */ - precision?: number; - /** Specifies a filter operation applied to a column. */ - selectedFilterOperation?: string; - /** Specifies whether or not the column displays its values by using editors. */ - showEditorAlways?: boolean; - /** Specifies whether or not to display the column when grid records are grouped by it. */ - showWhenGrouped?: boolean; - /** Specifies the index of a column when grid records are sorted by the values of this column. */ - sortIndex?: number; - /** Specifies the initial sort order of column values. */ - sortOrder?: string; - /** In a boolean column, replaces all true items with a specified text. */ - trueText?: string; - /** Specifies whether a column is visible or not. */ - visible?: boolean; - /** Specifies the sequence number of the column in the grid. */ - visibleIndex?: number; - /** Specifies a column width in pixels or percentages. */ - width?: any; - /** Specifies an array of validation rules to be checked when updating column cell values. */ - validationRules?: Array; - /** Specifies whether or not to display the header of a hidden column in the column chooser. */ - showInColumnChooser?: boolean; - /** Specifies the identifier of the column. */ - name?: string; - } - export interface dxDataGridOptions extends WidgetOptions { - /** Specifies whether the outer borders of the grid are visible or not. */ - showBorders?: boolean; - /** Indicates whether to show the error row for the grid. */ - errorRowEnabled?: boolean; - /** A handler for the rowValidating event. */ - onRowValidating?: (e: Object) => void; - /** A handler for the contextMenuPreparing event. */ - onContextMenuPreparing?: (e: Object) => void; - initNewRow?: (e: { data: Object }) => void; - /** A handler for the initNewRow event. */ - onInitNewRow?: (e: { data: Object }) => void; - rowInserted?: (e: { data: Object; key: any }) => void; - /** A handler for the rowInserted event. */ - onRowInserted?: (e: { data: Object; key: any }) => void; - rowInserting?: (e: { data: Object; cancel: boolean }) => void; - /** A handler for the rowInserting event. */ - onRowInserting?: (e: { data: Object; cancel: boolean }) => void; - rowRemoved?: (e: { data: Object; key: any }) => void; - /** A handler for the rowRemoved event. */ - onRowRemoved?: (e: { data: Object; key: any }) => void; - rowRemoving?: (e: { data: Object; key: any; cancel: boolean }) => void; - /** A handler for the rowRemoving event. */ - onRowRemoving?: (e: { data: Object; key: any; cancel: boolean }) => void; - rowUpdated?: (e: { data: Object; key: any }) => void; - /** A handler for the rowUpdated event. */ - onRowUpdated?: (e: { data: Object; key: any }) => void; - rowUpdating?: (e: { oldData: Object; newData: Object; key: any; cancel: boolean }) => void; - /** A handler for the rowUpdating event. */ - onRowUpdating?: (e: { oldData: Object; newData: Object; key: any; cancel: boolean }) => void; - /** Enables a hint that appears when a user hovers the mouse pointer over a cell with truncated content. */ - cellHintEnabled?: boolean; - /** Specifies whether or not grid columns can be reordered by a user. */ - allowColumnReordering?: boolean; - /** Specifies whether or not grid columns can be resized by a user. */ - allowColumnResizing?: boolean; - cellClick?: any; - /** A handler for the cellClick event. */ - onCellClick?: any; - cellHoverChanged?: (e: Object) => void; - /** A handler for the cellHoverChanged event. */ - onCellHoverChanged?: (e: Object) => void; - cellPrepared?: (e: Object) => void; - /** A handler for the cellPrepared event. */ - onCellPrepared?: (e: Object) => void; - /** Specifies whether or not the width of grid columns depends on column content. */ - columnAutoWidth?: boolean; - /** Specifies the options of a column chooser. */ - columnChooser?: { - /** Specifies text displayed by the column chooser panel when it does not contain any columns. */ - emptyPanelText?: string; - /** Specifies whether a user can invoke the column chooser or not. */ - enabled?: boolean; - /** Specifies the height of the column chooser panel. */ - height?: number; - /** Specifies text displayed in the title of the column chooser panel. */ - title?: string; - /** Specifies the width of the column chooser panel. */ - width?: number; - }; - /** Specifies options for column fixing. */ - columnFixing?: { - /** Indicates if column fixing is enabled. */ - enabled?: boolean; - /** Contains options that specify texts for column-fixing related commands in the column header's context menu. */ - texts?: { - /** Specifies text for a context menu item that fixes the column for which the context menu is invoked. */ - fix?: string; - /** Specifies text for a context menu item that unfixes the column for which the context menu is invoked. */ - unfix?: string; - /** Specifies text for a context menu subitem that fixes a column, for which the context menu is invoked, to the left grid edge. */ - leftPosition?: string; - /** Specifies text for a context menu subitem that fixes a column, for which the context menu is invoked, to the right grid edge. */ - rightPosition?: string; - }; - }; - /** Specifies options for filtering using a column header filter. */ - headerFilter?: { - /** Indicates whether or not the column header filter button is visible. */ - visible?: boolean; - /** Specifies the height of the dropdown menu invoked when using a column header filter. */ - height?: number; - /** Specifies the width of the dropdown menu invoked when using a column header filter. */ - width?: number; - /** Contains options that specify texts for the dropdown menu invoked when you use a column header filter. */ - texts?: { - /** Specifies text for the item specifying an empty value in the column header filter's dropdown menu. */ - emptyValue?: string; - /** Specifies text for a button that closes the column header filter's dropdown menu and applies specified filtering. */ - ok?: string; - /** Specifies text for a button that closes the column header filter's dropdown menu without applying performed selection. */ - cancel?: string; - } - }; - /** -An array of grid columns. - */ - columns?: Array; - onContentReady?: Function; - contentReadyAction?: Function; - /** Specifies a function that customizes grid columns after they are created. */ - customizeColumns?: (columns: Array) => void; - dataErrorOccurred?: (errorObject: Error) => void; - /** Specifies a data source for the grid. */ - dataSource?: any; - editingStart?: (e: { - data: Object; - key: any; - cancel: boolean; - column: dxDataGridColumn - }) => void; - /** A handler for the editingStart event. */ - onEditingStart?: (e: { - data: Object; - key: any; - cancel: boolean; - column: dxDataGridColumn - }) => void; - editorPrepared?: (e: Object) => void; - /** A handler for the editorPrepared event. */ - onEditorPrepared?: (e: Object) => void; - editorPreparing?: (e: Object) => void; - /** A handler for the editorPreparing event. */ - onEditorPreparing?: (e: Object) => void; - /** Contains options that specify how grid content can be changed. */ - editing?: { - /** Specifies whether or not grid records can be edited at runtime. */ - editEnabled?: boolean; - /** Specifies how grid values can be edited manually. */ - editMode?: string; - /** Specifies whether or not new records can be inserted into a grid. */ - insertEnabled?: boolean; - /** Specifies whether or not records can be deleted from a grid. */ - removeEnabled?: boolean; - /** Contains options that specify texts for editing-related grid controls. */ - texts?: { - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Save" button. Setting this option makes sense only when the editMode option is set to batch. */ - saveAllChanges?: string; - /** Specifies text for a cancel button displayed when a row is in the editing state. Setting this option makes sense only when the editEnabled option is set to true. */ - cancelRowChanges?: string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Revert" button. Setting this option makes sense only when the editMode option is set to batch. */ - cancelAllChanges?: string; - /** Specifies a message to be displayed by a confirmation window. Setting this option makes sense only when the edit mode is "row". */ - confirmDeleteMessage?: string; - /** Specifies text to be displayed in the title of a confirmation window. Setting this option makes sense only when the edit mode is "row". */ - confirmDeleteTitle?: string; - /** Specifies text for a button that deletes a row from a grid. Setting this option makes sense only when the removeEnabled option is set to true. */ - deleteRow?: string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Add" button. Setting this option makes sense only when the insertEnabled option is true. */ - addRow?: string; - /** Specifies text for a button that turns a row into the editing state. Setting this option makes sense only when the editEnabled option is set to true. */ - editRow?: string; - /** Specifies text for a save button displayed when a row is in the editing state. Setting this option makes sense only when the editEnabled option is set to true. */ - saveRowChanges?: string; - /** Specifies text for a button that recovers a deleted row. Setting this option makes sense only if the grid uses the batch edit mode and the removeEnabled option is set to true. */ - undeleteRow?: string; - }; - }; - /** Specifies filter row options. */ - filterRow?: { - /** Specifies when to apply a filter. */ - applyFilter?: string; - /** Specifies text for the hint that pops up when a user hovers the mouse pointer over the "Apply Filter" button. */ - applyFilterText?: string; - /** Specifies descriptions for filter operations. */ - operationDescriptions?: { - "=": string; - "<>": string; - "<": string; - "<=": string; - ">": string; - ">=": string; - "startswith": string; - "contains": string; - "notcontains": string; - "endswith": string; - }; - /** Specifies text for the reset operation in a filter list. */ - resetOperationText?: string; - /** Specifies text for the operation of clearing the applied filter when a select box is used. */ - showAllText?: string; - /** Specifies whether or not an icon that allows the user to choose a filter operation is visible. */ - showOperationChooser?: boolean; - /** Specifies whether the filter row is visible or not. */ - visible?: boolean; - }; - /** Specifies the behavior of grouped grid records. */ - grouping?: { - /** Specifies whether the user can collapse grouped records in a grid or not. */ - allowCollapsing?: boolean; - /** Specifies whether groups appear expanded or not. */ - autoExpandAll?: boolean; - /** Specifies the message displayed in a group row when the corresponding group is continued from the previous page. */ - groupContinuedMessage?: string; - /** -Specifies the message displayed in a group row when the corresponding group continues on the next page. - */ - groupContinuesMessage?: string; - }; - /** Specifies options that configure the group panel. */ - groupPanel?: { - /** Specifies whether columns can be dragged onto or from the group panel. */ - allowColumnDragging?: boolean; - /** Specifies text displayed by the group panel when it does not contain any columns. */ - emptyPanelText?: string; - /** Specifies whether the group panel is visible or not. */ - visible?: boolean; - }; - /** Specifies options configuring the load panel. */ - loadPanel?: { - /** Specifies whether to show the load panel or not. */ - enabled?: boolean; - /** Specifies the height of the load panel in pixels. */ - height?: number; - /** Specifies a URL pointing to an image to be used as a loading indicator. */ - indicatorSrc?: string; - /** Specifies whether or not a loading indicator must be displayed on the load panel. */ - showIndicator?: boolean; - /** Specifies whether or not the pane of the load panel must be displayed. */ - showPane?: boolean; - /** Specifies text displayed by the load panel. */ - text?: string; - /** Specifies the width of the load panel in pixels. */ - width?: number; - }; - /** Specifies text displayed when a grid does not contain any records. */ - noDataText?: string; - /** Specifies the options of a grid pager. */ - pager?: { - /** Specifies the page sizes that can be selected at runtime. */ - allowedPageSizes?: any; - /** Specifies whether to show the page size selector or not. */ - showPageSizeSelector?: boolean; - /** Specifies whether to show the pager or not. */ - visible?: any; - /** Specifies the text accompanying the page navigator. */ - infoText?: string; - /** Specifies whether or not to display the text accompanying the page navigator. This text is specified by the infoText option. */ - showInfo?: boolean; - /** Specifies whether or not to display buttons that switch the grid to the previous or next page. */ - showNavigationButtons?: boolean; - }; - /** Specifies paging options. */ - paging?: { - /** Specifies whether dxDataGrid loads data page by page or all at once. */ - enabled?: boolean; - /** Specifies the grid page that should be displayed by default. */ - pageIndex?: number; - /** Specifies the size of grid pages. */ - pageSize?: number; - }; - /** Specifies whether or not grid rows must be shaded in a different way. */ - rowAlternationEnabled?: boolean; - rowClick?: any; - /** A handler for the rowClick event. */ - onRowClick?: any; - rowPrepared?: (e: Object) => void; - /** A handler for the rowPrepared event. */ - onRowPrepared?: (e: Object) => void; - /** Specifies a custom template for grid rows. */ - rowTemplate?: any; - /** A configuration object specifying scrolling options. */ - scrolling?: { - /** Specifies the scrolling mode. */ - mode?: string; - /** Specifies whether or not a grid must preload pages adjacent to the current page when using virtual scrolling. */ - preloadEnabled?: boolean; - }; - /** Specifies options of the search panel. */ - searchPanel?: { - /** Specifies whether or not search strings in the located grid records should be highlighted. */ - highlightSearchText?: boolean; - /** Specifies text displayed by the search panel when no search string was typed. */ - placeholder?: string; - /** Specifies whether the search panel is visible or not. */ - visible?: boolean; - /** Specifies the width of the search panel in pixels. */ - width?: number; - /** Sets a search string for the search panel. */ - text?: string; - }; - /** Specifies the operations that must be performed on the server side. */ - remoteOperations?: any; - /** Allows you to sort groups according to the values of group summary items. */ - sortByGroupSummaryInfo?: Array<{ - /** Specifies the group summary item whose values must be used to sort groups. */ - summaryItem?: string; - /** Specifies the identifier of the column that must be used in grouping so that sorting by group summary item values be applied. */ - groupColumn?: string; - /** Specifies the sort order of group summary item values. */ - sortOrder?: string; - }>; - /** Allows you to build a master-detail interface in the grid. */ - masterDetail?: { - /** Enables an end-user to expand/collapse detail sections. */ - enabled?: boolean; - /** Specifies whether detail sections appear expanded or collapsed. */ - autoExpandAll?: boolean; - /** Specifies the template for detail sections. */ - template?: any; - }; - /** Specifies options for exporting grid data. */ - export?: { - /** Indicates if the export feature is enabled in the grid. */ - enabled?: boolean; - /** Specifies a default name for the file to which grid data is exported. */ - fileName?: string; - /** Specifies whether to enable Excel filtering for the exported data in the resulting XLSX file. */ - excelFilterEnabled?: boolean; - /** Specifies whether to enable word wrapping for the exported data in the resulting XLSX file. */ - excelWrapTextEnabled?: boolean; - /** Specifies the URL of the server-side proxy that streams the resulting file to the end user to enable export in IE8, IE9 and Safari browsers. */ - proxyUrl?: string; - /** Indicates whether to allow end users to export not only the data displayed in the grid, but the selected rows only. */ - allowExportSelectedData?: boolean; - /** Contains options that specify texts for the export-related commands and hints. */ - texts?: { - /** Specifies text for the Export button when this button invokes a dropdown menu so you can choose the required export format. */ - exportTo?: string; - /** Specifies text for the Export button when this button exports to the XSLX format. */ - exportToExcel?: string; - /** Specifies text for the item in the Export dropdown menu that exports grid data to Excel. */ - excelFormat?: string; - /** Specifies text for the option in the Export dropdown menu that allows you to choose whether to export all the grid data or the selected rows only. */ - selectedRows?: string; - } - }; - /** Specifies the keys of the records that must appear selected initially. */ - selectedRowKeys?: Array; - /** Specifies options of runtime selection. */ - selection?: { - /** Specifies whether the user can select all grid records at once. */ - allowSelectAll?: boolean; - /** Specifies the selection mode. */ - mode?: string; - }; - selectionChanged?: (e: { - currentSelectedRowKeys: Array; - currentDeselectedRowKeys: Array; - selectedRowKeys: Array; - selectedRowsData: Array; - }) => void; - /** A handler for the dataErrorOccured event. */ - onDataErrorOccurred?: (e: { error: Error }) => void; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: (e: { - currentSelectedRowKeys: Array; - currentDeselectedRowKeys: Array; - selectedRowKeys: Array; - selectedRowsData: Array; - }) => void; - /** A handler for the exporting event. */ - onExporting?: (e: { - fileName: string; - format: string; - cancel: boolean; - }) => void; - /** A handler for the exported event. */ - onExported?: (e: Object) => void; - /** A handler for the rowExpanding event. */ - onRowExpanding?: (e: Object) => void; - /** A handler for the rowExpanded event. */ - onRowExpanded?: (e: Object) => void; - /** A handler for the rowCollapsing event. */ - onRowCollapsing?: (e: Object) => void; - /** A handler for the rowCollapsed event. */ - onRowCollapsed?: (e: Object) => void; - /** Specifies whether column headers are visible or not. */ - showColumnHeaders?: boolean; - /** Specifies whether or not vertical lines separating one grid column from another are visible. */ - showColumnLines?: boolean; - /** Specifies whether or not horizontal lines separating one grid row from another are visible. */ - showRowLines?: boolean; - /** Specifies options of runtime sorting. */ - sorting?: { - /** Specifies text for the context menu item that sets an ascending sort order in a column. */ - ascendingText?: string; - /** Specifies text for the context menu item that resets sorting settings for a column. */ - clearText?: string; - /** Specifies text for the context menu item that sets a descending sort order in a column. */ - descendingText?: string; - /** Specifies the runtime sorting mode. */ - mode?: string; - }; - /** Specifies options of state storing. */ - stateStoring?: { - /** Specifies a callback function that performs specific actions on state loading. */ - customLoad?: () => JQueryPromise; - /** Specifies a callback function that performs specific actions on state saving. */ - customSave?: (gridState: Object) => void; - /** Specifies whether or not a grid saves its state. */ - enabled?: boolean; - /** Specifies the delay between the last change of a grid state and the operation of saving this state in milliseconds. */ - savingTimeout?: number; - /** Specifies a unique key to be used for storing the grid state. */ - storageKey?: string; - /** Specifies the type of storage to be used for state storing. */ - type?: string; - }; - /** Specifies the options of the grid summary. */ - summary?: { - /** Contains options that specify text patterns for summary items. */ - texts?: { - /** Specifies a pattern for the 'sum' summary items when they are displayed in the parent column. */ - sum?: string; - /** Specifies a pattern for the 'sum' summary items displayed in a group row or in any other column rather than the parent one. */ - sumOtherColumn?: string; - /** Specifies a pattern for the 'min' summary items when they are displayed in the parent column. */ - min?: string; - /** Specifies a pattern for the 'min' summary items displayed in a group row or in any other column rather than the parent one. */ - minOtherColumn?: string; - /** Specifies a pattern for the 'max' summary items when they are displayed in the parent column. */ - max?: string; - /** Specifies a pattern for the 'max' summary items displayed in a group row or in any other column rather than the parent one. */ - maxOtherColumn?: string; - /** Specifies a pattern for the 'avg' summary items when they are displayed in the parent column. */ - avg?: string; - /** Specifies a pattern for the 'avg' summary items displayed in a group row or in any other column rather than the parent one. */ - avgOtherColumn?: string; - /** Specifies a pattern for the 'count' summary items. */ - count?: string; - }; - /** Specifies items of the group summary. */ - groupItems?: Array<{ - /** Specifies the identifier of a summary item. */ - name?: string; - /** Specifies the column that provides data for a group summary item. */ - column?: string; - /** Customizes the text to be displayed in the summary item. */ - customizeText?: (itemInfo: { - value: any; - valueText: string; - }) => string; - /** Specifies a pattern for the summary item text. */ - displayFormat?: string; - /** Specifies a precision for the summary item value of a numeric format. */ - precision?: number; - /** Specifies whether or not a summary item must be displayed in the group footer. */ - showInGroupFooter?: boolean; - /** Indicates whether to display group summary items in brackets of the group row header or to align them by the corresponding columns within the group row. */ - alignByColumn?: boolean; - /** Specifies the column that must hold the summary item when this item is displayed in the group footer or aligned by a column in the group row. */ - showInColumn?: string; - /** Specifies how to aggregate data for a summary item. */ - summaryType?: string; - /** Specifies a format for the summary item value. */ - valueFormat?: string; - }>; - /** Specifies items of the total summary. */ - totalItems?: Array<{ - /** Specifies the identifier of a summary item. */ - name?: string; - /** Specifies the alignment of a summary item. */ - alignment?: string; - /** Specifies the column that provides data for a summary item. */ - column?: string; - /** Specifies a CSS class to be applied to a summary item. */ - cssClass?: string; - /** Customizes the text to be displayed in the summary item. */ - customizeText?: (itemInfo: { - value: any; - valueText: string; - }) => string; - /** Specifies a pattern for the summary item text. */ - displayFormat?: string; - /** Specifies a precision for the summary item value of a numeric format. */ - precision?: number; - /** Specifies the column that must hold the summary item. */ - showInColumn?: string; - /** Specifies how to aggregate data for a summary item. */ - summaryType?: string; - /** Specifies a format for the summary item value. */ - valueFormat?: string; - }>; - /** Allows you to use a custom aggregate function to calculate the value of a summary item. */ - calculateCustomSummary?: (options: { - component: dxDataGrid; - name?: string; - value: any; - totalValue: any; - summaryProcess: string - }) => void; - }; - /** Specifies whether text that does not fit into a column should be wrapped. */ - wordWrapEnabled?: boolean; - } - /** A data grid widget. */ - export class dxDataGrid extends Widget { - constructor(element: JQuery, options?: dxDataGridOptions); - constructor(element: Element, options?: dxDataGridOptions); - /** Ungroups grid records. */ - clearGrouping(): void; - /** Clears sorting settings of all grid columns at once. */ - clearSorting(): void; - /** Allows you to obtain a cell by its row index and the data field of its column. */ - getCellElement(rowIndex: number, dataField: string): any; - /** Allows you to obtain a cell by its row index and the visible index of its column. */ - getCellElement(rowIndex: number, visibleColumnIndex: number): any; - /** Returns the current state of the grid. */ - state(): Object; - /** Sets the grid state. */ - state(state: Object): void; - /** Allows you to obtain the row index by a data key. */ - getRowIndexByKey(key: any): number; - /** Allows you to obtain the data key by a row index. */ - getKeyByRowIndex(rowIndex: number): any; - /** Adds a new column to a grid. */ - addColumn(columnOptions: dxDataGridColumn): void; - /** Displays the load panel. */ - beginCustomLoading(messageText: string): void; - /** Discards changes made in a grid. */ - cancelEditData(): void; - /** Clears all the filters of a specific type applied to grid records. */ - clearFilter(): void; - /** Deselects all grid records. */ - clearSelection(): void; - /** Draws the cell being edited from the editing state. Use this method when the edit mode is batch. */ - closeEditCell(): void; - /** Collapses groups or master rows in a grid. */ - collapseAll(groupIndex?: number): void; - /** Returns the number of data columns in a grid. */ - columnCount(): number; - /** Returns the value of a specific column option. */ - columnOption(id: number, optionName: string): any; - /** Sets an option of a specific column. */ - columnOption(id: number, optionName: string, optionValue: any): void; - /** Returns the options of a column by an identifier. */ - columnOption(id: any): Object; - /** Sets several options of a column at once. */ - columnOption(id: any, options: Object): void; - /** Sets a specific cell into the editing state. */ - editCell(rowIndex: number, columnIndex: number): void; - /** Sets a specific row into the editing state. */ - editRow(rowIndex: number): void; - /** Hides the load panel. */ - endCustomLoading(): void; - /** Expands groups or master rows in a grid. */ - expandAll(groupIndex: number): void; - /** Allows you to find out whether a specific group or master row is expanded or collapsed. */ - isRowExpanded(key: any): boolean; - /** Allows you to expand a specific group or master row by its key. */ - expandRow(key: any): void; - /** Allows you to collapse a specific group or master row by its key. */ - collapseRow(key: any): void; - /** Applies a filter to the grid's data source. */ - filter(filterExpr?: any): void; - /** Returns a filter expression applied to the grid's data source using the filter(filterExpr) method. */ - filter(): any; - /** Returns a filter expression applied to the grid using all possible scenarious. */ - getCombinedFilter(): any; - /** Gets the keys of currently selected grid records. */ - getSelectedRowKeys(): Array; - /** Gets the data objects of currently selected grid records. */ - getSelectedRowsData(): Array; - /** Hides the column chooser panel. */ - hideColumnChooser(): void; - /** Adds a new data row to a grid. */ - insertRow(): void; - /** Returns the key corresponding to the passed data object. */ - keyOf(obj: Object): any; - /** Switches a grid to a specified page. */ - pageIndex(newIndex: number): void; - /** Gets the index of the current page. */ - pageIndex(): number; - /** Sets the page size. */ - pageSize(value: number): void; - /** Gets the current page size. */ - pageSize(): number; - /** Refreshes grid data. */ - refresh(): void; - /** Removes a specific row from a grid. */ - removeRow(rowIndex: number): void; - /** Saves changes made in a grid. */ - saveEditData(): void; - /** -Searches grid records by a search string. - */ - searchByText(text: string): void; - /** Selects all grid records. */ - selectAll(): void; - /** Deselects the rows that are currently selected within the applied filter. */ - deselectAll(): void; - /** Selects specific grid records. */ - selectRows(keys: Array, preserve: boolean): void; - /** Deselects specific grid records. */ - deselectRows(keys: Array): void; - /** Selects grid rows by indexes. */ - selectRowsByIndexes(indexes: Array): void; - /** Allows you to find out whether a row is selected or not. */ - isRowSelected(key: any): boolean; - /** Invokes the column chooser panel. */ - showColumnChooser(): void; - startSelectionWithCheckboxes(): boolean; - /** Returns the number of records currently held by a grid. */ - totalCount(): number; - /** Recovers a row deleted in the batch edit mode. */ - undeleteRow(rowIndex: number): void; - /** Allows you to obtain a data object by its key. */ - byKey(key: any): JQueryPromise; - /** Gets the value of a total summary item. */ - getTotalSummaryValue(summaryItemName: string): any; - /** Exports grid data to Excel. */ - exportToExcel(selectionOnly: boolean): void; - /** Updates the grid to the size of its content. */ - updateDimensions(): void; - /** Focuses the specified cell element in the grid. */ - focus(element?: JQuery): void; - } - export interface dxPivotGridOptions extends WidgetOptions { - /** Specifies a data source for the pivot grid. */ - dataSource?: any; - useNativeScrolling?: any; - /** Allows an end-user to change sorting options. */ - allowSorting?: boolean; - /** Allows an end-user to sort columns by summary values. */ - allowSortingBySummary?: boolean; - /** Allows an end-user to change filtering options. */ - allowFiltering?: boolean; - /** Allows an end-user to expand/collapse all header items within a header level. */ - allowExpandAll?: boolean; - /** Specifies whether to display the Total rows. */ - showRowTotals?: boolean; - /** Specifies whether to display the Grand Total row. */ - showRowGrandTotals?: boolean; - /** Specifies whether to display the Total columns. */ - showColumnTotals?: boolean; - /** Specifies whether to display the Grand Total column. */ - showColumnGrandTotals?: boolean; - /** The Field Chooser configuration options. */ - fieldChooser?: { - /** Enables or disables the field chooser. */ - enabled?: boolean; - /** Specifies the field chooser layout. */ - layout?: number; - /** Specifies the text to display as a title of the field chooser popup window. */ - title?: string; - /** Specifies the field chooser width. */ - width?: number; - /** Specifies the field chooser height. */ - height?: number; - /** Strings that can be changed or localized in the pivot grid's integrated Field Chooser. */ - texts?: { - /** The string to display instead of Row Fields. */ - rowFields?: string; - /** The string to display instead of Column Fields. */ - columnFields?: string; - /** The string to display instead of Data Fields. */ - dataFields?: string; - /** The string to display instead of Filter Fields. */ - filterFields?: string; - /** The string to display instead of All Fields. */ - allFields?: string; - }; - } - /** Strings that can be changed or localized in the dxPivotGrid widget. */ - texts?: { - /** The string to display as a header of the Grand Total row and column. */ - grandTotal?: string; - /** The string to display as a header of the Total row and column. */ - total?: string; - /** Specifies the text displayed when a pivot grid does not contain any fields. */ - noData?: string; - /** The string to display as a Show Field Chooser context menu item. */ - showFieldChooser?: string; - /** The string to display as an Expand All context menu item. */ - expandAll?: string; - /** The string to display as a Collapse All context menu item. */ - collapseAll?: string; - /** The string to display as a Sort Column by Summary Value context menu item. */ - sortColumnBySummary?: string; - /** The string to display as a Sort Row by Summary Value context menu item. */ - sortRowBySummary?: string; - /** The string to display as a Remove All Sorting context menu item. */ - removeAllSorting?: string; - }; - /** The Load panel configuration options. */ - loadPanel?: { - /** Enables or disables the load panel. */ - enabled?: boolean; - /** Specifies the height of the load panel. */ - height?: number; - /** Specifies the URL pointing to an image that will be used as a load indicator. */ - indicatorSrc?: string; - /** Specifies whether or not to show a load indicator. */ - showIndicator?: boolean; - /** Specifies whether or not to show load panel background. */ - showPane?: boolean; - /** Specifies the text to display inside a load panel. */ - text?: string; - /** Specifies the width of the load panel. */ - width?: number; - }; - /** A handler for the cellClick event. */ - onCellClick?: (e: any) => void; - /** A handler for the cellPrepared event. */ - onCellPrepared?: (e: any) => void; - } - /** A data summarization widget for multi-dimensional data analysis and data mining. */ - export class dxPivotGrid extends Widget { - constructor(element: JQuery, options?: dxPivotGridOptions); - constructor(element: Element, options?: dxPivotGridOptions); - /** Gets the PivotGridDataSource instance. */ - getDataSource(): DevExpress.data.PivotGridDataSource; - /** Updates the widget to the size of its content. */ - updateDimensions(): void; - } - export interface dxPivotGridFieldChooserOptions extends WidgetOptions { - /** Specifies the field chooser layout. */ - layout?: number; - /** The data source of a dxPivotGrid widget. */ - dataSource?: DevExpress.data.PivotGridDataSource; - onContentReady?: Function; - /** Strings that can be changed or localized in the dxPivotGridFieldChooser widget. */ - texts?: { - /** The string to display instead of Row Fields. */ - rowFields?: string; - /** The string to display instead of Column Fields. */ - columnFields?: string; - /** The string to display instead of Data Fields. */ - dataFields?: string; - /** The string to display instead of Filter Fields. */ - filterFields?: string; - /** The string to display instead of All Fields. */ - allFields?: string; - }; - } - /** A complementary widget for dxPivotGrid that allows you to manage data displayed in the dxPivotGrid. */ - export class dxPivotGridFieldChooser extends Widget { - constructor(element: JQuery, options?: dxPivotGridFieldChooserOptions); - constructor(element: Element, options?: dxPivotGridFieldChooserOptions); - /** Updates the widget to the size of its content. */ - updateDimensions(): void; - } -} -interface JQuery { - dxTreeView(): JQuery; - dxTreeView(options: "instance"): DevExpress.ui.dxTreeView; - dxTreeView(options: string): any; - dxTreeView(options: string, ...params: any[]): any; - dxTreeView(options: DevExpress.ui.dxTreeViewOptions): JQuery; - dxMenuBase(): JQuery; - dxMenuBase(options: "instance"): DevExpress.ui.dxMenuBase; - dxMenuBase(options: string): any; - dxMenuBase(options: string, ...params: any[]): any; - dxMenuBase(options: DevExpress.ui.dxMenuBaseOptions): JQuery; - dxMenu(): JQuery; - dxMenu(options: "instance"): DevExpress.ui.dxMenu; - dxMenu(options: string): any; - dxMenu(options: string, ...params: any[]): any; - dxMenu(options: DevExpress.ui.dxMenuOptions): JQuery; - dxContextMenu(): JQuery; - dxContextMenu(options: "instance"): DevExpress.ui.dxContextMenu; - dxContextMenu(options: string): any; - dxContextMenu(options: string, ...params: any[]): any; - dxContextMenu(options: DevExpress.ui.dxContextMenuOptions): JQuery; - dxColorBox(): JQuery; - dxColorBox(options: "instance"): DevExpress.ui.dxColorBox; - dxColorBox(options: string): any; - dxColorBox(options: string, ...params: any[]): any; - dxColorBox(options: DevExpress.ui.dxColorBoxOptions): JQuery; - dxDataGrid(): JQuery; - dxDataGrid(options: "instance"): DevExpress.ui.dxDataGrid; - dxDataGrid(options: string): any; - dxDataGrid(options: string, ...params: any[]): any; - dxDataGrid(options: DevExpress.ui.dxDataGridOptions): JQuery; - dxPivotGrid(): JQuery; - dxPivotGrid(options: "instance"): DevExpress.ui.dxPivotGrid; - dxPivotGrid(options: string): any; - dxPivotGrid(options: string, ...params: any[]): any; - dxPivotGrid(options: DevExpress.ui.dxPivotGridOptions): JQuery; - dxPivotGridFieldChooser(): JQuery; - dxPivotGridFieldChooser(options: "instance"): DevExpress.ui.dxPivotGridFieldChooser; - dxPivotGridFieldChooser(options: string): any; - dxPivotGridFieldChooser(options: string, ...params: any[]): any; - dxPivotGridFieldChooser(options: DevExpress.ui.dxPivotGridFieldChooserOptions): JQuery; - dxScheduler(): JQuery; - dxScheduler(options: "instance"): DevExpress.ui.dxScheduler; - dxScheduler(options: string): any; - dxScheduler(options: string, ...params: any[]): any; - dxScheduler(options: DevExpress.ui.dxSchedulerOptions): JQuery; -} -declare namespace DevExpress.framework { - /** An object used to store information on the views displayed in an application. */ - export class ViewCache { - viewRemoved: JQueryCallback; - /** Removes all the viewInfo objects from the cache. */ - clear(): void; - /** Obtains a viewInfo object from the cache by the specified key. */ - getView(key: string): Object; - /** Checks whether or not a viewInfo object is contained in the view cache under the specified key. */ - hasView(key: string): boolean; - /** Removes a viewInfo object from the cache by the specified key. */ - removeView(key: string): Object; - /** Adds the specified viewInfo object to the cache under the specified key. */ - setView(key: string, viewInfo: Object): void; - } - export interface dxCommandOptions extends DOMComponentOptions { - action?: any; - /** Specifies an action performed when the execute() method of the command is called. */ - onExecute?: any; - /** Indicates whether or not the widget that displays this command is disabled. */ - disabled?: boolean; - /** Specifies the name of the icon shown inside the widget associated with this command. */ - icon?: string; - iconSrc?: string; - /** The identifier of the command. */ - id?: string; - /** Specifies the title of the widget associated with this command. */ - title?: string; - /** Specifies the type of the button, if the command is rendered as a dxButton widget. */ - type?: string; - /** A Boolean value specifying whether or not the widget associated with this command is visible. */ - visible?: boolean; - } - /** A markup component used to define markup options for a command. */ - export class dxCommand extends DOMComponent { - constructor(element: JQuery, options: dxCommandOptions); - constructor(options: dxCommandOptions); - /** Executes the action associated with this command. */ - execute(): void; - } - /** An object responsible for routing. */ - export class Router { - /** Adds a routing rule to the list of registered rules. */ - register(pattern: string, defaults?: Object, constraints?: Object): void; - /** Decodes the specified URI to an object using the registered routing rules. */ - parse(uri: string): Object; - /** Formats an object to a URI. */ - format(obj: Object): string; - } - export interface StateManagerOptions { - /** A storage to which the state manager saves the application state. */ - storage?: Object; - } - /** An object used to store the current application state. */ - export class StateManager { - constructor(options?: StateManagerOptions); - /** Adds an object that implements an interface of a state source to the state manager's collection of state sources. */ - addStateSource(stateSource: Object): void; - /** Removes a specified state source from the state manager's collection of state sources. */ - removeStateSource(stateSource: Object): void; - /** Saves the current application state. */ - saveState(): void; - /** Restores the application state that has been saved by the saveState() method to the state storage. */ - restoreState(): void; - /** Removes the application state that has been saved by the saveState() method to the state storage. */ - clearState(): void; - } - export module html { - export var layoutSets: Array; - export var animationSets: { [animationSetName: string]: AnimationSet }; - export interface AnimationSet { - [animationName: string]: any - } - export interface HtmlApplicationOptions { - /** Specifies where the commands that are defined in the application's views must be displayed. */ - commandMapping?: Object; - /** Specifies whether or not view caching is disabled. */ - disableViewCache?: boolean; - /** An array of layout controllers that should be used to show application views in the current navigation context. */ - layoutSet?: any; - /** Specifies the animation presets that are used to animate different UI elements in the current application. */ - animationSet?: AnimationSet; - /** Specifies whether the current application must behave as a mobile or web application. */ - mode?: string; - /** Specifies the object that represents a root namespace of the application. */ - namespace?: Object; - /** Specifies application behavior when the user navigates to a root view. */ - navigateToRootViewMode?: string; - /** An array of dxCommand configuration objects used to define commands available from the application's global navigation. */ - navigation?: Array; - /** A state manager to be used in the application. */ - stateManager?: StateManager; - /** Specifies the storage to be used by the application's state manager to store the application state. */ - stateStorage?: Object; - /** Indicates whether on not to use the title of the previously displayed view as text on the Back button. */ - useViewTitleAsBackText?: boolean; - /** A custom view cache to be used in the application. */ - viewCache?: Object; - /** Specifies a limit for the views that can be cached. */ - viewCacheSize?: number; - /** Specifies options for the viewport meta tag of a mobile browser. */ - viewPort?: JQuery; - /** A custom router to be used in the application. */ - router?: Router; - } - /** An object used to manage views, as well as control the application life cycle. */ - export class HtmlApplication implements EventsMixin { - constructor(options: HtmlApplicationOptions); - afterViewSetup: JQueryCallback; - beforeViewSetup: JQueryCallback; - initialized: JQueryCallback; - navigating: JQueryCallback; - navigatingBack: JQueryCallback; - resolveLayoutController: JQueryCallback; - viewDisposed: JQueryCallback; - viewDisposing: JQueryCallback; - viewHidden: JQueryCallback; - viewRendered: JQueryCallback; - viewShowing: JQueryCallback; - viewShown: JQueryCallback; - /** Provides access to the ViewCache object. */ - viewCache: ViewCache; - /** An array of dxCommand components that are created based on the application's navigation option value. */ - navigation: Array; - /** Provides access to the StateManager object. */ - stateManager: StateManager; - /** Provides access to the Router object. */ - router: Router; - /** Navigates to the URI preceding the current one in the navigation history. */ - back(): void; - /** Returns a Boolean value indicating whether or not backwards navigation is currently possible. */ - canBack(): boolean; - /** Calls the clearState() method of the application's StateManager object. */ - clearState(): void; - /** Creates global navigation commands. */ - createNavigation(navigationConfig: Array): void; - /** Returns an HTML template of the specified view. */ - getViewTemplate(viewName: string): JQuery; - /** Returns a configuration object used to create a dxView component for a specified view. */ - getViewTemplateInfo(viewName: string): Object; - /** Adds a specified HTML template to a collection of view or layout templates. */ - loadTemplates(source: any): JQueryPromise; - /** Navigates to the specified URI. */ - navigate(uri?: any, options?: Object): void; - /** Renders navigation commands to the navigation command containers that are located in the layouts used in the application. */ - renderNavigation(): void; - /** Calls the restoreState() method of the application's StateManager object. */ - restoreState(): void; - /** Calls the saveState method of the application's StateManager object. */ - saveState(): void; - /** Provides access to the object that defines the current context to be considered when choosing an appropriate template for a view. */ - templateContext(): Object; - on(eventName: "initialized", eventHandler: () => void): HtmlApplication; - on(eventName: "afterViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "beforeViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "navigating", eventHandler: (e: { - currentUri: string; - uri: string; - cancel: boolean; - options: { - root: boolean; - target: string; - direction: string; - rootInDetailPane: boolean; - modal: boolean; - }; - }) => void): HtmlApplication; - on(eventName: "navigatingBack", eventHandler: (e: { - cancel: boolean; - isHardwareButton: boolean; - }) => void): HtmlApplication; - on(eventName: "resolveLayoutController", eventHandler: (e: { - viewInfo: Object; - layoutController: Object; - availableLayoutControllers: Array; - }) => void): HtmlApplication; - on(eventName: "viewDisposed", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewDisposing", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewHidden", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewRendered", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewShowing", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - on(eventName: "viewShown", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - on(eventName: string, eventHandler: Function): HtmlApplication; - on(events: { [eventName: string]: Function; }): HtmlApplication; - off(eventName: "initialized"): HtmlApplication; - off(eventName: "afterViewSetup"): HtmlApplication; - off(eventName: "beforeViewSetup"): HtmlApplication; - off(eventName: "navigating"): HtmlApplication; - off(eventName: "navigatingBack"): HtmlApplication; - off(eventName: "resolveLayoutController"): HtmlApplication; - off(eventName: "viewDisposed"): HtmlApplication; - off(eventName: "viewDisposing"): HtmlApplication; - off(eventName: "viewHidden"): HtmlApplication; - off(eventName: "viewRendered"): HtmlApplication; - off(eventName: "viewShowing"): HtmlApplication; - off(eventName: "viewShown"): HtmlApplication; - off(eventName: string): HtmlApplication; - off(eventName: "initialized", eventHandler: () => void): HtmlApplication; - off(eventName: "afterViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "beforeViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "navigating", eventHandler: (e: { - currentUri: string; - uri: string; - cancel: boolean; - options: { - root: boolean; - target: string; - direction: string; - rootInDetailPane: boolean; - modal: boolean; - }; - }) => void): HtmlApplication; - off(eventName: "navigatingBack", eventHandler: (e: { - cancel: boolean; - isHardwareButton: boolean; - }) => void): HtmlApplication; - off(eventName: "resolveLayoutController", eventHandler: (e: { - viewInfo: Object; - layoutController: Object; - availableLayoutControllers: Array; - }) => void): HtmlApplication; - off(eventName: "viewDisposed", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewDisposing", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewHidden", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewRendered", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewShowing", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - off(eventName: "viewShown", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - off(eventName: string, eventHandler: Function): HtmlApplication; - } - } -} -declare namespace DevExpress.viz.core { - export interface Border { - /** Sets a border color for a selected series. */ - color?: string; - /** Sets border visibility for a selected series. */ - visible?: boolean; - /** Sets a border width for a selected series. */ - width?: number; - } - export interface DashedBorder extends Border { - /** Specifies a dash style for the border of a selected series point. */ - dashStyle?: string; - } - export interface DashedBorderWithOpacity extends DashedBorder { - /** Specifies the opacity of the tooltip's border. */ - opacity?: number; - } - export interface Font { - /** Specifies the font color for a strip label. */ - color?: string; - /** Specifies the font family for a strip label. */ - family?: string; - /** Specifies the font opacity for a strip label. */ - opacity?: number; - /** Specifies the font size for a strip label. */ - size?: any; - /** Specifies the font weight for the text displayed in strips. */ - weight?: number; - } - export interface Hatching { - /** Specifies how to apply hatching to highlight a selected series. */ - direction?: string; - /** Specifies the opacity of hatching lines. */ - opacity?: number; - /** Specifies the distance between hatching lines in pixels. */ - step?: number; - /** Specifies the width of hatching lines in pixels. */ - width?: number; - } - export interface Margins { - /** Specifies the legend's bottom margin in pixels. */ - bottom?: number; - /** Specifies the legend's left margin in pixels. */ - left?: number; - /** Specifies the legend's right margin in pixels. */ - right?: number; - /** Specifies the legend's bottom margin in pixels. */ - top?: number; - } - export interface Size { - /** Specifies the width of the widget. */ - width?: number; - /** Specifies the height of the widget. */ - height?: number; - } - export interface Tooltip { - /** Specifies the length of the tooltip's arrow in pixels. */ - arrowLength?: number; - /** Specifies the appearance of the tooltip's border. */ - border?: viz.core.DashedBorderWithOpacity; - /** Specifies a color for the tooltip. */ - color?: string; - /** Specifies the z-index for tooltips. */ - zIndex?: number; - /** Specifies text and appearance of a set of tooltips. */ - customizeTooltip?: (arg: Object) => { color?: string; text?: string }; - /** Specifies whether or not the tooltip is enabled. */ - enabled?: boolean; - /** Specifies font options for the text displayed by the tooltip. */ - font?: Font; - /** Specifies a format for the text displayed by the tooltip. */ - format?: string; - /** Specifies the opacity of a tooltip. */ - opacity?: number; - /** Specifies a distance from the tooltip's left/right boundaries to the inner text in pixels. */ - paddingLeftRight?: number; - /** Specifies a distance from the tooltip's top/bottom boundaries to the inner text in pixels. */ - paddingTopBottom?: number; - /** Specifies a precision for formatted values displayed by the tooltip. */ - precision?: number; - /** Specifies options of the tooltip's shadow. */ - shadow?: { - /** Specifies the blur distance of the tooltip's shadow. */ - blur?: number; - /** Specifies the color of the tooltip's shadow. */ - color?: string; - /** Specifies the horizontal offset of the tooltip's shadow relative to the tooltip in pixels. */ - offsetX?: number; - /** Specifies the vertical offset of the tooltip's shadow relative to the tooltip in pixels. */ - offsetY?: number; - /** Specifies the opacity of the tooltip's shadow. */ - opacity?: number; - }; - } - export interface Animation { - /** Determines how long animation runs. */ - duration?: number; - /** Specifies the animation easing mode. */ - easing?: string; - /** Indicates whether or not animation is enabled. */ - enabled?: boolean; - } - export interface LoadingIndicator { - /** Specifies a color for the loading indicator background. */ - backgroundColor?: string; - /** Specifies font options for the loading indicator text. */ - font?: viz.core.Font; - /** Specifies whether to show the loading indicator or not. */ - show?: boolean; - /** Specifies a text to be displayed by the loading indicator. */ - text?: string; - } - export interface LegendBorder extends viz.core.DashedBorderWithOpacity { - /** Specifies a radius for the corners of the legend border. */ - cornerRadius?: number; - } - export interface BaseLegend { - /** Specifies the color of the legend's background. */ - backgroundColor?: string; - /** Specifies legend border settings. */ - border?: viz.core.LegendBorder; - /** Specifies how many columns must be taken to arrange legend items. */ - columnCount?: number; - /** Specifies the spacing between a pair of neighboring legend columns in pixels. */ - columnItemSpacing?: number; - /** Specifies font options for legend items. */ - font?: viz.core.Font; - /** Specifies the legend's position on the map. */ - horizontalAlignment?: string; - /** Specifies the alignment of legend items. */ - itemsAlignment?: string; - /** Specifies the position of text relative to the item marker. */ - itemTextPosition?: string; - /** Specifies the distance between the legend and the container borders in pixels. */ - margin?: viz.core.Margins; - /** Specifies the size of item markers in the legend in pixels. */ - markerSize?: number; - /** Specifies whether to arrange legend items horizontally or vertically. */ - orientation?: string; - /** Specifies the spacing between the legend left/right border and legend items in pixels. */ - paddingLeftRight?: number; - /** Specifies the spacing between the legend top/bottom border and legend items in pixels. */ - paddingTopBottom?: number; - /** Specifies how many rows must be taken to arrange legend items. */ - rowCount?: number; - /** Specifies the spacing between a pair of neighboring legend rows in pixels. */ - rowItemSpacing?: number; - /** Specifies the legend's position on the map. */ - verticalAlignment?: string; - /** Specifies whether or not the legend is visible on the map. */ - visible?: boolean; - } - export interface BaseWidgetOptions { - drawn?: (widget: Object) => void; - /** A handler for the drawn event. */ - onDrawn?: (e: { - component: BaseWidget; - element: Element; - }) => void; - incidentOccured?: (incidentInfo: { - id: string; - type: string; - args: any; - text: string; - widget: string; - version: string; - }) => void; - /** A handler for the incidentOccurred event. */ - onIncidentOccurred?: ( - component: BaseWidget, - element: Element, - target: { - id: string; - type: string; - args: any; - text: string; - widget: string; - version: string; - } - ) => void; - /** Notifies a widget that it is embedded into an HTML page that uses a path modifier. */ - pathModified?: boolean; - /** Specifies whether or not the widget supports right-to-left representation. */ - rtlEnabled?: boolean; - /** Sets the name of the theme to be used in the widget. */ - theme?: string; - } - /** This section describes options and methods that are common to all widgets. */ - export class BaseWidget extends DOMComponent { - /** Returns the widget's SVG markup. */ - svg(): string; - } -} -declare namespace DevExpress.viz.charts { - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface BaseSeries { - /** Provides information about the state of the series object. */ - fullState: number; - /** Returns the type of the series. */ - type: string; - /** Unselects all the selected points of the series. The points are displayed in an initial style. */ - clearSelection(): void; - /** Gets the color of a particular series. */ - getColor(): string; - /** - * Gets a point from the series point collection based on the specified argument. - * @deprecated getPointsByArg(pointArg).md - */ - getPointByArg(pointArg: any): Object; - /** Gets points from the series point collection based on the specified argument. */ - getPointsByArg(pointArg: any): Array; - /** Gets a point from the series point collection based on the specified point position. */ - getPointByPos(positionIndex: number): Object; - /** Selects the series. The series is displayed in a 'selected' style until another series is selected or the current series is deselected programmatically. */ - select(): void; - /** Selects the specified point. The point is displayed in a 'selected' style. */ - selectPoint(point: BasePoint): void; - /** Deselects the specified point. The point is displayed in an initial style. */ - deselectPoint(point: BasePoint): void; - /** Returns an array of all points in the series. */ - getAllPoints(): Array; - /** Returns visible series points. */ - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface BasePoint { - /** Provides information about the state of the point object. */ - fullState: number; - /** Returns the point's argument value that was set in the data source. */ - originalArgument: any; - /** Returns the point's value that was set in the data source. */ - originalValue: any; - /** Returns the tag of the point. */ - tag: string; - /** Deselects the point. */ - clearSelection(): void; - /** Gets the color of a particular point. */ - getColor(): string; - /** Hides the tooltip of the point. */ - hideTooltip(): void; - /** Provides information about the hover state of a point. */ - isHovered(): any; - /** Provides information about the selection state of a point. */ - isSelected(): any; - /** Selects the point. The point is displayed in a 'selected' style until another point is selected or the current point is deselected programmatically. */ - select(): void; - /** Shows the tooltip of the point. */ - showTooltip(): void; - /** Allows you to obtain the label of a series point. */ - getLabel(): any; - /** Returns the series object to which the point belongs. */ - series: BaseSeries; - } - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface ChartSeries extends BaseSeries { - /** Returns the name of the series pane. */ - pane: string; - /** Returns the name of the value axis of the series. */ - axis: string; - /** Returns the name of the series. */ - name: string; - /** Returns the tag of the series. */ - tag: string; - /** Hides a series. */ - hide(): void; - /** Provides information about the hover state of a series. */ - isHovered(): any; - /** Provides information about the selection state of a series. */ - isSelected(): any; - /** Provides information about the visibility state of a series. */ - isVisible(): boolean; - /** Makes a particular series visible. */ - show(): void; - selectPoint(point: ChartPoint): void; - deselectPoint(point: ChartPoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface ChartPoint extends BasePoint { - /** Contains the close value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalCloseValue: any; - /** Contains the high value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalHighValue: any; - /** Contains the low value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalLowValue: any; - /** Contains the first value of the point. This field is useful for points belonging to a series of the range area or range bar type only. */ - originalMinValue: any; - /** Contains the open value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalOpenValue: any; - /** Contains the size of the bubble as it was set in the data source. This field is useful for points belonging to a series of the bubble type only. */ - size: any; - /** Gets the parameters of the point's minimum bounding rectangle (MBR). */ - getBoundingRect(): { x: number; y: number; width: number; height: number; }; - series: ChartSeries; - } - /** This section describes the methods that can be used in code to manipulate the Label object. */ - export interface Label { - /** Gets the parameters of the label's minimum bounding rectangle (MBR). */ - getBoundingRect(): { x: number; y: number; width: number; height: number; }; - /** Hides the point label. */ - hide(): void; - /** Shows the point label. */ - show(): void; - } - export interface PieSeries extends BaseSeries { - selectPoint(point: PiePoint): void; - deselectPoint(point: PiePoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface PiePoint extends BasePoint { - /** Gets the percentage value of the specific point. */ - percent: any; - /** Provides information about the visibility state of a point. */ - isVisible(): boolean; - /** Makes a specific point visible. */ - show(): void; - /** Hides a specific point. */ - hide(): void; - series: PieSeries; - } - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface PolarSeries extends BaseSeries { - /** Returns the name of the value axis of the series. */ - axis: string; - /** Returns the name of the series. */ - name: string; - /** Returns the tag of the series. */ - tag: string; - /** Hides a series. */ - hide(): void; - /** Provides information about the hover state of a series. */ - isHovered(): any; - /** Provides information about the selection state of a series. */ - isSelected(): any; - /** Provides information about the visibility state of a series. */ - isVisible(): boolean; - /** Makes a particular series visible. */ - show(): void; - selectPoint(point: PolarPoint): void; - deselectPoint(point: PolarPoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface PolarPoint extends BasePoint { - series: PolarSeries; - } - export interface Strip { - /** Specifies a color for a strip. */ - color?: string; - /** An object that defines the label configuration options of a strip. */ - label?: { - /** Specifies the text displayed in a strip. */ - text?: string; - }; - /** Specifies a start value for a strip. */ - startValue?: any; - /** Specifies an end value for a strip. */ - endValue?: any; - } - export interface BaseSeriesConfigLabel { - /** Specifies a format for arguments displayed by point labels. */ - argumentFormat?: string; - /** Specifies a precision for formatted point arguments displayed in point labels. */ - argumentPrecision?: number; - /** Specifies a background color for point labels. */ - backgroundColor?: string; - /** Specifies border options for point labels. */ - border?: viz.core.DashedBorder; - /** Specifies connector options for series point labels. */ - connector?: { - /** Specifies the color of label connectors. */ - color?: string; - /** Indicates whether or not label connectors are visible. */ - visible?: boolean; - /** Specifies the width of label connectors. */ - width?: number; - }; - /** Specifies a callback function that returns the text to be displayed by point labels. */ - customizeText?: (pointInfo: Object) => string; - /** Specifies font options for the text displayed in point labels. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed by point labels. */ - format?: string; - position?: string; - /** Specifies a precision for formatted point values displayed in point labels. */ - precision?: number; - /** Specifies the angle used to rotate point labels from their initial position. */ - rotationAngle?: number; - /** Specifies the visibility of point labels. */ - visible?: boolean; - } - export interface SeriesConfigLabel extends BaseSeriesConfigLabel { - /** Specifies whether or not to show a label when the point has a zero value. */ - showForZeroValues?: boolean; - } - export interface ChartSeriesConfigLabel extends SeriesConfigLabel { - /** Specifies how to align point labels relative to the corresponding data points that they represent. */ - alignment?: string; - /** Specifies how to shift point labels horizontally from their initial positions. */ - horizontalOffset?: number; - /** Specifies how to shift point labels vertically from their initial positions. */ - verticalOffset?: number; - /** Specifies a precision for the percentage values displayed in the labels of a full-stacked-like series. */ - percentPrecision?: number; - } - export interface BaseCommonSeriesConfig { - /** Specifies the data source field that provides arguments for series points. */ - argumentField?: string; - axis?: string; - /** An object defining the label configuration options for a series in the dxChart widget. */ - label?: ChartSeriesConfigLabel; - /** Specifies border options for point labels. */ - border?: viz.core.DashedBorder; - /** Specifies a series color. */ - color?: string; - /** Specifies the dash style of the series' line. */ - dashStyle?: string; - hoverMode?: string; - /** An object defining configuration options for a hovered series. */ - hoverStyle?: { - /** An object defining the border options for a hovered series. */ - border?: viz.core.DashedBorder; - /**

Sets a color for a series when it is hovered over.

*/ - color?: string; - /** Specifies the dash style for the line in a hovered series. */ - dashStyle?: string; - /** Specifies the hatching options to be applied when a series is hovered over. */ - hatching?: viz.core.Hatching; - /** Specifies the width of a line in a hovered series. */ - width?: number; - }; - /** Specifies whether a chart ignores null data points or not. */ - ignoreEmptyPoints?: boolean; - /** Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed. */ - maxLabelCount?: number; - /** Specifies the minimal length of a displayed bar in pixels. */ - minBarSize?: number; - /** Specifies opacity for a series. */ - opacity?: number; - /** Specifies the series elements to highlight when the series is selected. */ - selectionMode?: string; - /** An object defining configuration options for a selected series. */ - selectionStyle?: { - /** An object defining the border options for a selected series. */ - border?: viz.core.DashedBorder; - /** Sets a color for a series when it is selected. */ - color?: string; - /** Specifies the dash style for the line in a selected series. */ - dashStyle?: string; - /** Specifies the hatching options to be applied when a series is selected. */ - hatching?: viz.core.Hatching; - /** Specifies the width of a line in a selected series. */ - width?: number; - }; - /** Specifies whether or not to show the series in the chart's legend. */ - showInLegend?: boolean; - /** Specifies the name of the stack where the values of the _stackedBar_ series must be located. */ - stack?: string; - /** Specifies the name of the data source field that provides data about a point. */ - tagField?: string; - /** Specifies the data source field that provides values for series points. */ - valueField?: string; - /** Specifies the visibility of a series. */ - visible?: boolean; - /** Specifies a line width. */ - width?: number; - /** Configures error bars. */ - valueErrorBar?: { - /** Specifies whether error bars must be displayed in full or partially. */ - displayMode?: string; - /** Specifies the data field that provides data for low error values. */ - lowValueField?: string; - /** Specifies the data field that provides data for high error values. */ - highValueField?: string; - /** Specifies how error bar values must be calculated. */ - type?: string; - /** Specifies the value to be used for generating error bars. */ - value?: number; - /** Specifies the color of error bars. */ - color?: string; - /** Specifies the opacity of error bars. */ - opacity?: number; - /** Specifies the length of the lines that indicate the error bar edges. */ - edgeLength?: number; - /** Specifies the width of the error bar line. */ - lineWidth?: number; - }; - } - export interface CommonPointOptions { - /** Specifies border options for points in the line and area series. */ - border?: viz.core.Border; - /** Specifies the points color. */ - color?: string; - /** Specifies what series points to highlight when a point is hovered over. */ - hoverMode?: string; - /** An object defining configuration options for a hovered point. */ - hoverStyle?: { - /** An object defining the border options for a hovered point. */ - border?: viz.core.Border; - /** Sets a color for a point when it is hovered over. */ - color?: string; - /** Specifies the diameter of a hovered point in the series that represents data points as symbols (not as bars for instance). */ - size?: number; - }; - /** Specifies what series points to highlight when a point is selected. */ - selectionMode?: string; - /** An object defining configuration options for a selected point. */ - selectionStyle?: { - /** An object defining the border options for a selected point. */ - border?: viz.core.Border; - /**

Sets a color for a point when it is selected.

*/ - color?: string; - /** Specifies the diameter of a selected point in the series that represents data points as symbols (not as bars for instance). */ - size?: number; - }; - /** Specifies the point diameter in pixels for those series that represent data points as symbols (not as bars for instance). */ - size?: number; - /** Specifies a symbol for presenting points of the line and area series. */ - symbol?: string; - visible?: boolean; - } - export interface ChartCommonPointOptions extends CommonPointOptions { - /** An object specifying the parameters of an image that is used as a point marker. */ - image?: { - /** Specifies the height of an image that is used as a point marker. */ - height?: any; - /** Specifies a URL leading to the image to be used as a point marker. */ - url?: any; - /** Specifies the width of an image that is used as a point marker. */ - width?: any; - }; - } - export interface PolarCommonPointOptions extends CommonPointOptions { - /** An object specifying the parameters of an image that is used as a point marker. */ - image?: { - /** Specifies the height of an image that is used as a point marker. */ - height?: number; - /** Specifies a URL leading to the image to be used as a point marker. */ - url?: string; - /** Specifies the width of an image that is used as a point marker. */ - width?: number; - }; - } - /** An object that defines configuration options for chart series. */ - export interface CommonSeriesConfig extends BaseCommonSeriesConfig { - /** Specifies the data source field that provides a 'close' value for a _candleStick_ or _stock_ series. */ - closeValueField?: string; - /** Specifies a radius for bar corners. */ - cornerRadius?: number; - /** Specifies the data source field that provides a 'high' value for a _candleStick_ or _stock_ series. */ - highValueField?: string; - /** Specifies the color for the body (rectangle) of a _candleStick_ series. */ - innerColor?: string; - /** Specifies the data source field that provides a 'low' value for a _candleStick_ or _stock_ series. */ - lowValueField?: string; - /** Specifies the data source field that provides an 'open' value for a _candleStick_ or _stock_ series. */ - openValueField?: string; - /** Specifies the pane that will be used to display a series. */ - pane?: string; - /** An object defining configuration options for points in line-, scatter- and area-like series. */ - point?: ChartCommonPointOptions; - /** Specifies the data source field that provides values for one end of a range series. To set the data source field for the other end of the range series, use the rangeValue2Field property. */ - rangeValue1Field?: string; - /** Specifies the data source field that provides values for the second end of a range series. To set the data source field for the other end of the range series, use the rangeValue1Field property. */ - rangeValue2Field?: string; - /** Specifies reduction options for the stock or candleStick series. */ - reduction?: { - /** Specifies a color for the points whose reduction level price is lower in comparison to the value in the previous point. */ - color?: string; - /** Specifies for which price level (open, high, low or close) to enable reduction options in the series. */ - level?: string; - }; - /** Specifies the data source field that defines the size of bubbles. */ - sizeField?: string; - } - export interface CommonSeriesSettings extends CommonSeriesConfig { - /**

An object that specifies configuration options for all series of the area type in the chart.

*/ - area?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _bar_ type in the chart. */ - bar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the bubble type in the chart. */ - bubble?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _candleStick_ type in the chart. */ - candlestick?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _fullStackedArea_ type in the chart. */ - fullstackedarea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Full-Stacked Spline Area type in the chart. */ - fullstackedsplinearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _fullStackedBar_ type in the chart. */ - fullstackedbar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _fullStackedLine_ type in the chart. */ - fullstackedline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Full-Stacked Spline type in the chart. */ - fullstackedspline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _line_ type in the chart. */ - line?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _rangeArea_ type in the chart. */ - rangearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _rangeBar_ type in the chart. */ - rangebar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _scatter_ type in the chart. */ - scatter?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _spline_ type in the chart. */ - spline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _splineArea_ type in the chart. */ - splinearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedArea_ type in the chart. */ - stackedarea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Stacked Spline Area type in the chart. */ - stackedsplinearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedBar_ type in the chart. */ - stackedbar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedLine_ type in the chart. */ - stackedline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Stacked Spline type in the chart. */ - stackedspline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stepArea_ type in the chart. */ - steparea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stepLine_ type in the chart. */ - stepline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stock_ type in the chart. */ - stock?: CommonSeriesConfig; - /** Sets a series type. */ - type?: string; - } - export interface SeriesConfig extends CommonSeriesConfig { - /** Specifies the name that identifies the series. */ - name?: string; - /** Specifies data about a series. */ - tag?: any; - /** Sets the series type. */ - type?: string; - } - /** An object that defines configuration options for polar chart series. */ - export interface CommonPolarSeriesConfig extends BaseCommonSeriesConfig { - /** Specifies whether or not to close the chart by joining the end point with the first point. */ - closed?: boolean; - label?: SeriesConfigLabel; - point?: PolarCommonPointOptions; - } - export interface CommonPolarSeriesSettings extends CommonPolarSeriesConfig { - /** An object that specifies configuration options for all series of the area type in the chart. */ - area?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _bar_ type in the chart. */ - bar?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _line_ type in the chart. */ - line?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _scatter_ type in the chart. */ - scatter?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedBar_ type in the chart. */ - stackedbar?: CommonPolarSeriesConfig; - /** Sets a series type. */ - type?: string; - } - export interface PolarSeriesConfig extends CommonPolarSeriesConfig { - /** Specifies the name that identifies the series. */ - name?: string; - /** Specifies data about a series. */ - tag?: any; - /** Sets the series type. */ - type?: string; - } - export interface PieSeriesConfigLabel extends BaseSeriesConfigLabel { - /** Specifies how to shift labels from their initial position in a radial direction in pixels. */ - radialOffset?: number; - /** Specifies a precision for the percentage values displayed in labels. */ - percentPrecision?: number; - } - /** An object that defines configuration options for chart series. */ - export interface CommonPieSeriesConfig { - /** Specifies the data source field that provides arguments for series points. */ - argumentField?: string; - /** Specifies the required type for series arguments. */ - argumentType?: string; - /** An object defining the series border configuration options. */ - border?: viz.core.DashedBorder; - /** Specifies a series color. */ - color?: string; - /** Specifies the chart elements to highlight when a series is hovered over. */ - hoverMode?: string; - /** An object defining configuration options for a hovered series. */ - hoverStyle?: { - /** An object defining the border options for a hovered series. */ - border?: viz.core.DashedBorder; - /** Sets a color for the series when it is hovered over. */ - color?: string; - /** Specifies the hatching options to be applied when a point is hovered over. */ - hatching?: viz.core.Hatching; - }; - /** Specifies the fraction of the inner radius relative to the total radius in the series of the 'doughnut' type. */ - innerRadius?: number; - /** An object defining the label configuration options. */ - label?: PieSeriesConfigLabel; - /** Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed. */ - maxLabelCount?: number; - /** Specifies a minimal size of a displayed pie segment. */ - minSegmentSize?: number; - /** Specifies the direction in which the dxPieChart's series points are located. */ - segmentsDirection?: string; - /**

Specifies the chart elements to highlight when the series is selected.

*/ - selectionMode?: string; - /** An object defining configuration options for the series when it is selected. */ - selectionStyle?: { - /** An object defining the border options for a selected series. */ - border?: viz.core.DashedBorder; - /** Sets a color for a series when it is selected. */ - color?: string; - /** Specifies the hatching options to be applied when a point is selected. */ - hatching?: viz.core.Hatching; - }; - /** Specifies chart segment grouping options. */ - smallValuesGrouping?: { - /** Specifies the name of the grouped chart segment. This name represents the segment in the chart legend. */ - groupName?: string; - /** Specifies the segment grouping mode. */ - mode?: string; - /** Specifies a threshold for segment values. */ - threshold?: number; - /** Specifies how many segments must not be grouped. */ - topCount?: number; - }; - /** Specifies a start angle for a pie chart in arc degrees. */ - startAngle?: number; - /**

Specifies the name of the data source field that provides data about a point.

*/ - tagField?: string; - /** Specifies the data source field that provides values for series points. */ - valueField?: string; - } - export interface PieSeriesConfig extends CommonPieSeriesConfig { - /** Sets the series type. */ - type?: string; - } - export interface SeriesTemplate { - /** Specifies a callback function that returns a series object with individual series settings. */ - customizeSeries?: (seriesName: string) => SeriesConfig; - /** Specifies a data source field that represents the series name. */ - nameField?: string; - } - export interface PolarSeriesTemplate { - /** Specifies a callback function that returns a series object with individual series settings. */ - customizeSeries?: (seriesName: string) => PolarSeriesConfig; - /** Specifies a data source field that represents the series name. */ - nameField?: string; - } - export interface ChartCommonConstantLineLabel { - /** Specifies font options for a constant line label. */ - font?: viz.core.Font; - /** Specifies the position of the constant line label relative to the chart plot. */ - position?: string; - /** Indicates whether or not to display labels for the axis constant lines. */ - visible?: boolean; - } - export interface PolarCommonConstantLineLabel { - /** Indicates whether or not to display labels for the axis constant lines. */ - visible?: boolean; - /** Specifies font options for a constant line label. */ - font?: viz.core.Font; - } - export interface ConstantLineStyle { - /** Specifies a color for a constant line. */ - color?: string; - /** Specifies a dash style for a constant line. */ - dashStyle?: string; - /** Specifies a constant line width in pixels. */ - width?: number; - } - export interface ChartCommonConstantLineStyle extends ConstantLineStyle { - /** An object defining constant line label options. */ - label?: ChartCommonConstantLineLabel; - /** Specifies the space between the constant line label and the left/right side of the constant line. */ - paddingLeftRight?: number; - /** Specifies the space between the constant line label and the top/bottom side of the constant line. */ - paddingTopBottom?: number; - } - export interface PolarCommonConstantLineStyle extends ConstantLineStyle { - /** An object defining constant line label options. */ - label?: PolarCommonConstantLineLabel; - } - export interface CommonAxisLabel { - /** Specifies font options for axis labels. */ - font?: viz.core.Font; - /** Specifies the spacing between an axis and its labels in pixels. */ - indentFromAxis?: number; - /** Indicates whether or not axis labels are visible. */ - visible?: boolean; - } - export interface ChartCommonAxisLabel extends CommonAxisLabel { - /** Specifies the label's position relative to the tick (grid line). */ - alignment?: string; - /** Specifies the overlap resolving algorithm to be applied to axis labels. */ - overlappingBehavior?: { - /** Specifies how to arrange axis labels. */ - mode?: string; - /** Specifies the angle used to rotate axis labels. */ - rotationAngle?: number; - /** Specifies the spacing that must be set between staggered rows when the 'stagger' algorithm is applied. */ - staggeringSpacing?: number; - }; - } - export interface PolarCommonAxisLabel extends CommonAxisLabel { - /** Specifies the overlap resolving algorithm to be applied to axis labels. */ - overlappingBehavior?: string; - } - export interface CommonAxisTitle { - /** Specifies font options for an axis title. */ - font?: viz.core.Font; - /** Specifies a margin for an axis title in pixels. */ - margin?: number; - } - export interface BaseCommonAxisSettings { - /** Specifies the color of the line that represents an axis. */ - color?: string; - /** Specifies whether ticks/grid lines of a discrete axis are located between labels or cross the labels. */ - discreteAxisDivisionMode?: string; - /** An object defining the configuration options for the grid lines of an axis in the dxPolarChart widget. */ - grid?: { - /** Specifies a color for grid lines. */ - color?: string; - /** Specifies an opacity for grid lines. */ - opacity?: number; - /** Indicates whether or not the grid lines of an axis are visible. */ - visible?: boolean; - /** Specifies the width of grid lines. */ - width?: number; - }; - /** Specifies the options of the minor grid. */ - minorGrid?: { - /** Specifies a color for the lines of the minor grid. */ - color?: string; - /** Specifies an opacity for the lines of the minor grid. */ - opacity?: number; - /** Indicates whether the minor grid is visible or not. */ - visible?: boolean; - /** Specifies a width for the lines of the minor grid. */ - width?: number; - }; - /** Indicates whether or not an axis is inverted. */ - inverted?: boolean; - /** Specifies the opacity of the line that represents an axis. */ - opacity?: number; - /** Indicates whether or not to set ticks/grid lines of a continuous axis of the 'date-time' type at the beginning of each date-time interval. */ - setTicksAtUnitBeginning?: boolean; - /** An object defining the configuration options for axis ticks. */ - tick?: { - /** Specifies ticks color. */ - color?: string; - /** Specifies tick opacity. */ - opacity?: number; - /** Indicates whether or not ticks are visible on an axis. */ - visible?: boolean; - }; - /** Specifies the options of the minor ticks. */ - minorTick?: { - /** Specifies a color for the minor ticks. */ - color?: string; - /** Specifies an opacity for the minor ticks. */ - opacity?: number; - /** Indicates whether or not the minor ticks are displayed on an axis. */ - visible?: boolean; - }; - /** Indicates whether or not the line that represents an axis in a chart is visible. */ - visible?: boolean; - /** Specifies the width of the line that represents an axis in the chart. */ - width?: number; - } - export interface ChartCommonAxisSettings extends BaseCommonAxisSettings { - /** Specifies the appearance of all the widget's constant lines. */ - constantLineStyle?: ChartCommonConstantLineStyle; - /** An object defining the label configuration options that are common for all axes in the dxChart widget. */ - label?: ChartCommonAxisLabel; - /** Specifies a coefficient that determines the spacing between the maximum series point and the axis. */ - maxValueMargin?: number; - /** Specifies a coefficient that determines the spacing between the minimum series point and the axis. */ - minValueMargin?: number; - /** Specifies, in pixels, the space reserved for an axis. */ - placeholderSize?: number; - /** An object defining configuration options for strip style. */ - stripStyle?: { - /** An object defining the configuration options for a strip label style. */ - label?: { - /** Specifies font options for a strip label. */ - font?: viz.core.Font; - /** Specifies the label's position on a strip. */ - horizontalAlignment?: string; - /** Specifies a label's position on a strip. */ - verticalAlignment?: string; - }; - /** Specifies the spacing, in pixels, between the left/right strip border and the strip label. */ - paddingLeftRight?: number; - /** Specifies the spacing, in pixels, between the top/bottom strip borders and the strip label. */ - paddingTopBottom?: number; - }; - /** An object defining the title configuration options that are common for all axes in the dxChart widget. */ - title?: CommonAxisTitle; - /** Indicates whether or not to display series with indents from axis boundaries. */ - valueMarginsEnabled?: boolean; - } - export interface PolarCommonAxisSettings extends BaseCommonAxisSettings { - /** Specifies the appearance of all the widget's constant lines. */ - constantLineStyle?: PolarCommonConstantLineStyle; - /** An object defining the label configuration options that are common for all axes in the dxPolarChart widget. */ - label?: PolarCommonAxisLabel; - /** An object defining configuration options for strip style. */ - stripStyle?: { - /** An object defining the configuration options for a strip label style. */ - label?: { - /** Specifies font options for a strip label. */ - font?: viz.core.Font; - }; - }; - } - export interface ChartConstantLineLabel extends ChartCommonConstantLineLabel { - /** Specifies the horizontal alignment of a constant line label. */ - horizontalAlignment?: string; - /** Specifies the vertical alignment of a constant line label. */ - verticalAlignment?: string; - /** Specifies the text to be displayed in a constant line label. */ - text?: string; - } - export interface PolarConstantLineLabel extends PolarCommonConstantLineLabel { - /** Specifies the text to be displayed in a constant line label. */ - text?: string; - } - export interface AxisLabel { - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a label on the value axis. */ - customizeHint?: (argument: { value: any; valueText: string }) => string; - /** Specifies a callback function that returns the text to be displayed in value axis labels. */ - customizeText?: (argument: { value: any; valueText: string }) => string; - /** Specifies a format for the text displayed by axis labels. */ - format?: string; - /** Specifies a precision for the formatted value displayed in the axis labels. */ - precision?: number; - } - export interface ChartAxisLabel extends ChartCommonAxisLabel, AxisLabel {} - export interface PolarAxisLabel extends PolarCommonAxisLabel, AxisLabel {} - export interface AxisTitle extends CommonAxisTitle { - /** Specifies the text for the value axis title. */ - text?: string; - } - export interface ChartConstantLineStyle extends ChartCommonConstantLineStyle { - /** An object defining constant line label options. */ - label?: ChartConstantLineLabel; - } - export interface ChartConstantLine extends ChartConstantLineStyle { - /** An object defining constant line label options. */ - label?: ChartConstantLineLabel; - /** Specifies a value to be displayed by a constant line. */ - value?: any; - } - export interface PolarConstantLine extends PolarCommonConstantLineStyle { - /** An object defining constant line label options. */ - label?: PolarConstantLineLabel; - /** Specifies a value to be displayed by a constant line. */ - value?: any; - } - export interface Axis { - /** Specifies a coefficient for dividing the value axis. */ - axisDivisionFactor?: number; - /** Specifies the order in which discrete values are arranged on the value axis. */ - categories?: Array; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic axis. */ - logarithmBase?: number; - /** Specifies an interval between axis ticks/grid lines. */ - tickInterval?: any; - /** Specifies the interval between minor ticks. */ - minorTickInterval?: any; - /** Specifies the number of minor ticks between two neighboring major ticks. */ - minorTickCount?: number; - /** Specifies the required type of the value axis. */ - type?: string; - /** Specifies the pane on which the current value axis will be displayed. */ - pane?: string; - /** Specifies options for value axis strips. */ - strips?: Array; - } - export interface ChartAxis extends ChartCommonAxisSettings, Axis { - /** Defines an array of the value axis constant lines. */ - constantLines?: Array; - /** Specifies the appearance options for the constant lines of the value axis. */ - constantLineStyle?: ChartCommonConstantLineStyle; - /** Specifies options for value axis labels. */ - label?: ChartAxisLabel; - /** Specifies the maximum value on the value axis. */ - max?: any; - /** Specifies the minimum value on the value axis. */ - min?: any; - /** Specifies the position of the value axis on a chart. */ - position?: string; - /** Specifies the title for a value axis. */ - title?: AxisTitle; - } - export interface PolarAxis extends PolarCommonAxisSettings, Axis { - /** Defines an array of the value axis constant lines. */ - constantLines?: Array; - /** Specifies options for value axis labels. */ - label?: PolarAxisLabel; - } - export interface ArgumentAxis { - /** Specifies the desired type of axis values. */ - argumentType?: string; - /** Specifies the elements that will be highlighted when the argument axis is hovered over. */ - hoverMode?: string; - } - export interface ChartArgumentAxis extends ChartAxis, ArgumentAxis {} - export interface PolarArgumentAxis extends PolarAxis, ArgumentAxis { - /** Specifies a start angle for the argument axis in degrees. */ - startAngle?: number; - /** Specifies whether or not to display the first point at the angle specified by the startAngle option. */ - firstPointOnStartAngle?: boolean; - /** Specifies the period of the argument values in the data source. */ - period?: number; - } - export interface ValueAxis { - /** Specifies the name of the value axis. */ - name?: string; - /** Specifies whether or not to indicate a zero value on the value axis. */ - showZero?: boolean; - /** Specifies the desired type of axis values. */ - valueType?: string; - } - export interface ChartValueAxis extends ChartAxis, ValueAxis { - /** Specifies the spacing, in pixels, between multiple value axes in a chart. */ - multipleAxesSpacing?: number; - /** Specifies the value by which the chart's value axes are synchronized. */ - synchronizedValue?: number; - } - export interface PolarValueAxis extends PolarAxis, ValueAxis { - /** Indicates whether to display series with indents from axis boundaries. */ - valueMarginsEnabled?: boolean; - /** Specifies a coefficient that determines the spacing between the maximum series point and the axis. */ - maxValueMargin?: number; - /** Specifies a coefficient that determines the spacing between the minimum series point and the axis. */ - minValueMargin?: number; - tick?: { - visible?: boolean; - } - } - export interface CommonPane { - /** Specifies a background color in a pane. */ - backgroundColor?: string; - /** Specifies the border options of a chart's pane. */ - border?: PaneBorder; - } - export interface Pane extends CommonPane { - /** Specifies the name of a pane. */ - name?: string; - } - export interface PaneBorder extends viz.core.DashedBorderWithOpacity { - /** Specifies the bottom border's visibility state in a pane. */ - bottom?: boolean; - /** Specifies the left border's visibility state in a pane. */ - left?: boolean; - /** Specifies the right border's visibility state in a pane. */ - right?: boolean; - /** Specifies the top border's visibility state in a pane. */ - top?: boolean; - } - export interface ChartAnimation extends viz.core.Animation { - /** Specifies the maximum series point count in the chart that the animation supports. */ - maxPointCountSupported?: number; - } - export interface BaseChartTooltip extends viz.core.Tooltip { - /** Specifies a format for arguments of the chart's series points. */ - argumentFormat?: string; - /** Specifies a precision for formatted arguments displayed in tooltips. */ - argumentPrecision?: number; - /** Specifies a precision for a percent value displayed in tooltips for stacked series and dxPieChart series. */ - percentPrecision?: number; - } - export interface BaseChartOptions extends viz.core.BaseWidgetOptions { - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - /** Specifies the width of the widget container that is small enough for the layout to begin adapting. */ - width?: number; - /** Specifies the height of the widget container that is small enough for the layout to begin adapting. */ - height?: number; - /** Specifies whether or not point labels can be hidden when the layout is adapting. */ - keepLabels?: boolean; - }; - /** Specifies animation options. */ - animation?: ChartAnimation; - /** Specifies a callback function that returns an object with options for a specific point label. */ - customizeLabel?: (labelInfo: Object) => Object; - /** Specifies a callback function that returns an object with options for a specific point. */ - customizePoint?: (pointInfo: Object) => Object; - /** Specifies a data source for the chart. */ - dataSource?: any; - done?: Function; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies options of a dxChart's (dxPieChart's) legend. */ - legend?: core.BaseLegend; - /** Specifies the blank space between the chart's extreme elements and the boundaries of the area provided for the widget (see size) in pixels. */ - margin?: viz.core.Margins; - /** Sets the name of the palette to be used in the chart. Alternatively, an array of colors can be set as a custom palette to be used within this chart. */ - palette?: any; - /** A handler for the done event. */ - onDone?: (e: { - component: BaseChart; - element: Element; - }) => void; - /** A handler for the pointClick event. */ - onPointClick?: any; - pointClick?: any; - /** A handler for the pointHoverChanged event. */ - onPointHoverChanged?: (e: { - component: BaseChart; - element: Element; - target: TPoint; - }) => void; - pointHoverChanged?: (point: TPoint) => void; - /** A handler for the pointSelectionChanged event. */ - onPointSelectionChanged?: (e: { - component: BaseChart; - element: Element; - target: TPoint; - }) => void; - pointSelectionChanged?: (point: TPoint) => void; - /** Specifies whether a single point or multiple points can be selected in the chart. */ - pointSelectionMode?: string; - /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */ - redrawOnResize?: boolean; - /** Specifies options for the dxChart and dxPieChart widget series. */ - series?: any; - /** Specifies the size of the widget in pixels. */ - size?: viz.core.Size; - /** Specifies a title for the chart. */ - title?: { - /** Specifies font options for the title. */ - font?: viz.core.Font; - /** Specifies the title's horizontal position in the chart. */ - horizontalAlignment?: string; - /** Specifies a title's position on the chart in the vertical direction. */ - verticalAlignment?: string; - /** Specifies the distance between the title and surrounding chart elements in pixels. */ - margin?: viz.core.Margins; - /** Specifies the height of the space reserved for the title. */ - placeholderSize?: number; - /** Specifies a text for the chart's title. */ - text?: string; - }; - /** Specifies tooltip options. */ - tooltip?: BaseChartTooltip; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: BaseChart; - element: Element; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: BaseChart; - element: Element; - }) => void; - tooltipHidden?: (point: TPoint) => void; - tooltipShown?: (point: TPoint) => void; - } - /** A base class for all chart widgets included in the ChartJS library. */ - export class BaseChart extends viz.core.BaseWidget { - /** Deselects the chart's selected series. The series is displayed in an initial style. */ - clearSelection(): void; - /** Gets the current size of the widget. */ - getSize(): { width: number; height: number }; - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Hides all widget tooltips. */ - hideTooltip(): void; - /** Redraws a widget. */ - render(renderOptions?: { - force?: boolean; - animate?: boolean; - asyncSeriesRendering?: boolean; - }): void; - } - export interface AdvancedLegend extends core.BaseLegend { - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item. */ - customizeHint?: (seriesInfo: { seriesName: string; seriesIndex: number; seriesColor: string; }) => string; - /**

Specifies a callback function that returns the text to be displayed by legend items.

*/ - customizeText?: (seriesInfo: { seriesName: string; seriesIndex: number; seriesColor: string; }) => string; - /** Specifies what series elements to highlight when a corresponding item in the legend is hovered over. */ - hoverMode?: string; - } - export interface AdvancedOptions extends BaseChartOptions { - /** A handler for the argumentAxisClick event. */ - onArgumentAxisClick?: any; - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** An object providing options for managing data from a data source. */ - dataPrepareSettings?: { - /** Specifies whether or not to validate the values from a data source. */ - checkTypeForAllData?: boolean; - /** Specifies whether or not to convert the values from a data source into the data type of an axis. */ - convertToAxisDataType?: boolean; - /** Specifies how to sort the series points. */ - sortingMethod?: any; - }; - /** A handler for the legendClick event. */ - onLegendClick?: any; - /** A handler for the seriesClick event. */ - onSeriesClick?: any; - /** A handler for the seriesHoverChanged event. */ - onSeriesHoverChanged?: (e: { - component: BaseChart; - element: Element; - target: TSeries; - }) => void; - /** A handler for the seriesSelectionChanged event. */ - onSeriesSelectionChanged?: (e: { - component: BaseChart; - element: Element; - target: TSeries; - }) => void; - /** Specifies whether a single series or multiple series can be selected in the chart. */ - seriesSelectionMode?: string; - /** Specifies how the chart must behave when series point labels overlap. */ - resolveLabelOverlapping?: string; - } - export interface Legend extends AdvancedLegend { - /** Specifies whether the legend is located outside or inside the chart's plot. */ - position?: string; - } - export interface ChartTooltip extends BaseChartTooltip { - /** Specifies whether the tooltip must be located in the center of a bar or on its edge. Applies only to the Bar series. */ - location?: string; - /** Specifies the kind of information to display in a tooltip. */ - shared?: boolean; - } - export interface dxChartOptions extends AdvancedOptions { - /** Specifies a value indicating whether all bars in a series must have the same width, or may have different widths if any points in other series are missing. */ - equalBarWidth?: any; - adaptiveLayout?: { - keepLabels?: boolean; - }; - /** Indicates whether or not to synchronize value axes when they are displayed on a single pane. */ - synchronizeMultiAxes?: boolean; - /** Specifies whether or not to filter the series points depending on their quantity. */ - useAggregation?: boolean; - /** Indicates whether or not to adjust a value axis to the current minimum and maximum values of a zoomed chart. */ - adjustOnZoom?: boolean; - /** Specifies argument axis options for the dxChart widget. */ - argumentAxis?: ChartArgumentAxis; - argumentAxisClick?: any; - /** An object defining the configuration options that are common for all axes of the dxChart widget. */ - commonAxisSettings?: ChartCommonAxisSettings; - /** An object defining the configuration options that are common for all panes in the dxChart widget. */ - commonPaneSettings?: CommonPane; - /** An object defining the configuration options that are common for all series of the dxChart widget. */ - commonSeriesSettings?: CommonSeriesSettings; - /** An object that specifies the appearance options of the chart crosshair. */ - crosshair?: { - /** Specifies a color for the crosshair lines. */ - color?: string; - /** Specifies a dash style for the crosshair lines. */ - dashStyle?: string; - /** Specifies whether to enable the crosshair or not. */ - enabled?: boolean; - /** Specifies the opacity of the crosshair lines. */ - opacity?: number; - /** Specifies the width of the crosshair lines. */ - width?: number; - /** Specifies the appearance of the horizontal crosshair line. */ - horizontalLine?: CrosshaierWithLabel; - /** Specifies the appearance of the vertical crosshair line. */ - verticalLine?: CrosshaierWithLabel; - /** Specifies the options of the crosshair labels. */ - label?: { - /** Specifies a color for the background of the crosshair labels. */ - backgroundColor?: string; - /** Specifies whether the crosshair labels are visible or not. */ - visible?: boolean; - /** Specifies font options for the text of the crosshair labels. */ - font?: viz.core.Font; - } - }; - /** Specifies a default pane for the chart's series. */ - defaultPane?: string; - /** Specifies a coefficient determining the diameter of the largest bubble. */ - maxBubbleSize?: number; - /** Specifies the diameter of the smallest bubble measured in pixels. */ - minBubbleSize?: number; - /** Defines the dxChart widget's pane(s). */ - panes?: Array; - /** Swaps the axes round so that the value axis becomes horizontal and the argument axes becomes vertical. */ - rotated?: boolean; - /** Specifies the options of a chart's legend. */ - legend?: Legend; - /** Specifies options for dxChart widget series. */ - series?: Array; - legendClick?: any; - seriesClick?: any; - seriesHoverChanged?: (series: ChartSeries) => void; - seriesSelectionChanged?: (series: ChartSeries) => void; - /** Defines options for the series template. */ - seriesTemplate?: SeriesTemplate; - /** Specifies tooltip options. */ - tooltip?: ChartTooltip; - /** Specifies value axis options for the dxChart widget. */ - valueAxis?: Array; - /** Enables scrolling in your chart. */ - scrollingMode?: string; - /** Enables zooming in your chart. */ - zoomingMode?: string; - /** Specifies the settings of the scroll bar. */ - scrollBar?: { - /** Specifies whether the scroll bar is visible or not. */ - visible?: boolean; - /** Specifies the spacing between the scroll bar and the chart's plot in pixels. */ - offset?: number; - /** Specifies the color of the scroll bar. */ - color?: string; - /** Specifies the width of the scroll bar in pixels. */ - width?: number; - /** Specifies the opacity of the scroll bar. */ - opacity?: number; - /** Specifies the position of the scroll bar in the chart. */ - position?: string; - }; - } - /** A widget used to embed charts into HTML JS applications. */ - export class dxChart extends BaseChart { - constructor(element: JQuery, options?: dxChartOptions); - constructor(element: Element, options?: dxChartOptions); - /** Returns an array of all series in the chart. */ - getAllSeries(): Array; - /** Gets a series within the chart's series collection by the specified name (see the name option). */ - getSeriesByName(seriesName: string): ChartSeries; - /** Gets a series within the chart's series collection by its position number. */ - getSeriesByPos(seriesIndex: number): ChartSeries; - /** Sets the specified start and end values for the chart's argument axis. */ - zoomArgument(startValue: any, endValue: any): void; - } - interface CrosshaierWithLabel extends viz.core.DashedBorderWithOpacity { - /** Configures the label that belongs to the horizontal crosshair line. */ - label?: { - /** Specifies a color for the background of the label that belongs to the horizontal crosshair line. */ - backgroundColor?: string; - /** Specifies whether the label of the horizontal crosshair line is visible or not. */ - visible?: boolean; - /** Specifies font options for the text of the label that belongs to the horizontal crosshair line. */ - font?: viz.core.Font; - } - } - export interface PolarChartTooltip extends BaseChartTooltip { - /** Specifies the kind of information to display in a tooltip. */ - shared?: boolean; - } - export interface dxPolarChartOptions extends AdvancedOptions { - /** Specifies a value indicating whether all bars in a series must have the same angle, or may have different angles if any points in other series are missing. */ - equalBarWidth?: boolean; - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - width?: number; - height?: number; - /** Specifies whether or not point labels can be hidden when the layout is adapting. */ - keepLabels?: boolean; - }; - /** Indicates whether or not to display a "spider web". */ - useSpiderWeb?: boolean; - /** Specifies argument axis options for the dxPolarChart widget. */ - argumentAxis?: PolarArgumentAxis; - /** An object defining the configuration options that are common for all axes of the dxPolarChart widget. */ - commonAxisSettings?: PolarCommonAxisSettings; - /** An object defining the configuration options that are common for all series of the dxPolarChart widget. */ - commonSeriesSettings?: CommonPolarSeriesSettings; - /** Specifies the options of a chart's legend. */ - legend?: AdvancedLegend; - /** Specifies options for dxPolarChart widget series. */ - series?: Array; - /** Defines options for the series template. */ - seriesTemplate?: PolarSeriesTemplate; - /** Specifies tooltip options. */ - tooltip?: PolarChartTooltip; - /** Specifies value axis options for the dxPolarChart widget. */ - valueAxis?: PolarValueAxis; - } - /** A chart widget displaying data in a polar coordinate system. */ - export class dxPolarChart extends BaseChart { - constructor(element: JQuery, options?: dxPolarChartOptions); - constructor(element: Element, options?: dxPolarChartOptions); - /** Returns an array of all series in the chart. */ - getAllSeries(): Array; - /** Gets a series within the chart's series collection by the specified name (see the name option). */ - getSeriesByName(seriesName: string): PolarSeries; - /** Gets a series within the chart's series collection by its position number. */ - getSeriesByPos(seriesIndex: number): PolarSeries; - } - export interface PieLegend extends core.BaseLegend { - /** Specifies what chart elements to highlight when a corresponding item in the legend is hovered over. */ - hoverMode?: string; - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item. */ - customizeHint?: (pointInfo: { pointName: string; pointIndex: number; pointColor: string; }) => string; - /** Specifies a callback function that returns the text to be displayed by a legend item. */ - customizeText?: (pointInfo: { pointName: string; pointIndex: number; pointColor: string; }) => string; - } - export interface dxPieChartOptions extends BaseChartOptions { - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - /** Specifies whether or not point labels can be hidden when the layout is adapting. */ - keepLabels?: boolean; - }; - /** Specifies dxPieChart legend options. */ - legend?: PieLegend; - /** Specifies options for the series of the dxPieChart widget. */ - series?: Array; - /** Specifies the diameter of the pie. */ - diameter?: number; - /** A handler for the legendClick event. */ - onLegendClick?: any; - legendClick?: any; - /** Specifies how the chart must behave when series point labels overlap. */ - resolveLabelOverlapping?: string; - } - /** A circular chart widget for HTML JS applications. */ - export class dxPieChart extends BaseChart { - constructor(element: JQuery, options?: dxPieChartOptions); - constructor(element: Element, options?: dxPieChartOptions); - /** Provides access to the dxPieChart series. */ - getSeries(): PieSeries; - } -} -interface JQuery { - dxChart(options?: DevExpress.viz.charts.dxChartOptions): JQuery; - dxChart(methodName: string, ...params: any[]): any; - dxChart(methodName: "instance"): DevExpress.viz.charts.dxChart; - dxPieChart(options?: DevExpress.viz.charts.dxPieChartOptions): JQuery; - dxPieChart(methodName: string, ...params: any[]): any; - dxPieChart(methodName: "instance"): DevExpress.viz.charts.dxPieChart; - dxPolarChart(options?: DevExpress.viz.charts.dxPolarChartOptions): JQuery; - dxPolarChart(methodName: string, ...params: any[]): any; - dxPolarChart(methodName: "instance"): DevExpress.viz.charts.dxPolarChart; -} -declare namespace DevExpress.viz.gauges { - export interface BaseRangeContainer { - /** Specifies a range container's background color. */ - backgroundColor?: string; - /** Specifies the offset of the range container from an invisible scale line in pixels. */ - offset?: number; - /** Sets the name of the palette or an array of colors to be used for coloring the gauge range container. */ - palette?: any; - /** An array of objects representing ranges contained in the range container. */ - ranges?: Array<{ startValue: number; endValue: number; color: string }>; - /** Specifies a color of a range. */ - color?: string; - /** Specifies an end value of a range. */ - endValue?: number; - /** Specifies a start value of a range. */ - startValue?: number; - } - export interface ScaleTick { - /** Specifies the color of the scale's minor ticks. */ - color?: string; - /** Specifies an array of custom minor ticks. */ - customTickValues?: Array; - /** Specifies the length of the scale's minor ticks. */ - length?: number; - /** Indicates whether automatically calculated minor ticks are visible or not. */ - showCalculatedTicks?: boolean; - /** Specifies an interval between minor ticks. */ - tickInterval?: number; - /** Indicates whether scale minor ticks are visible or not. */ - visible?: boolean; - /** Specifies the width of the scale's minor ticks. */ - width?: number; - } - export interface ScaleMajorTick extends ScaleTick { - /** Specifies whether or not to expand the current major tick interval if labels overlap each other. */ - useTicksAutoArrangement?: boolean; - } - export interface BaseScaleLabel { - /** Specifies whether or not scale labels should be colored similarly to their corresponding ranges in the range container. */ - useRangeColors?: boolean; - /** Specifies a callback function that returns the text to be displayed in scale labels. */ - customizeText?: (scaleValue: { value: number; valueText: string }) => string; - /** Specifies font options for the text displayed in the scale labels of the gauge. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in scale labels. */ - format?: string; - /** Specifies a precision for the formatted value displayed in the scale labels. */ - precision?: number; - /** Specifies whether or not scale labels are visible on the gauge. */ - visible?: boolean; - } - export interface BaseScale { - /** Specifies the end value for the scale of the gauge. */ - endValue?: number; - /** Specifies whether or not to hide the first scale label. */ - hideFirstLabel?: boolean; - /** Specifies whether or not to hide the first major tick on the scale. */ - hideFirstTick?: boolean; - /** Specifies whether or not to hide the last scale label. */ - hideLastLabel?: boolean; - /** Specifies whether or not to hide the last major tick on the scale. */ - hideLastTick?: boolean; - /** Specifies common options for scale labels. */ - label?: BaseScaleLabel; - /** Specifies options of the gauge's major ticks. */ - majorTick?: ScaleMajorTick; - /** Specifies options of the gauge's minor ticks. */ - minorTick?: ScaleTick; - /** Specifies the start value for the scale of the gauge. */ - startValue?: number; - } - export interface BaseValueIndicator { - /** Specifies the type of subvalue indicators. */ - type?: string; - /** Specifies the background color for the indicator of the rangeBar type. */ - backgroundColor?: string; - /** Specifies the base value for the indicator of the rangeBar type. */ - baseValue?: number; - /** Specifies a color of the indicator. */ - color?: string; - /** Specifies the range bar size for an indicator of the rangeBar type. */ - size?: number; - text?: { - /** Specifies a callback function that returns the text to be displayed in an indicator. */ - customizeText?: (indicatedValue: { value: number; valueText: string }) => string; - font?: viz.core.Font; - /** Specifies a format for the text displayed in an indicator. */ - format?: string; - /** Specifies the range bar's label indent in pixels. */ - indent?: number; - /** Specifies a precision for the formatted value displayed by an indicator. */ - precision?: number; - }; - offset?: number; - length?: number; - width?: number; - /** Specifies the length of an arrow for the indicator of the textCloud type in pixels. */ - arrowLength?: number; - /** Sets the array of colors to be used for coloring subvalue indicators. */ - palette?: Array; - /** Specifies the distance between the needle and the center of a gauge for the indicator of a needle-like type. */ - indentFromCenter?: number; - /** Specifies the second color for the indicator of the twoColorNeedle type. */ - secondColor?: string; - /** Specifies the length of a twoNeedleColor type indicator tip as a percentage. */ - secondFraction?: number; - /** Specifies the spindle's diameter in pixels for the indicator of a needle-like type. */ - spindleSize?: number; - /** Specifies the inner diameter in pixels, so that the spindle has the shape of a ring. */ - spindleGapSize?: number; - /** Specifies the orientation of the rangeBar indicator on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - /** Specifies the orientation of the rangeBar indicator on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - } - export interface SharedGaugeOptions { - /** Specifies animation options. */ - animation?: viz.core.Animation; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */ - redrawOnResize?: boolean; - /** Specifies the size of the widget in pixels. */ - size?: viz.core.Size; - /** Specifies a subtitle for a gauge. */ - subtitle?: { - /** Specifies font options for the subtitle. */ - font?: viz.core.Font; - /** Specifies a text for the subtitle. */ - text?: string; - }; - /** Specifies a title for a gauge. */ - title?: { - /** Specifies font options for the title. */ - font?: viz.core.Font; - /** Specifies a title's position on the gauge. */ - position?: string; - /** Specifies a text for the title. */ - text?: string; - }; - /** Specifies options for gauge tooltips. */ - tooltip?: viz.core.Tooltip; - } - export interface BaseGaugeOptions extends viz.core.BaseWidgetOptions, SharedGaugeOptions { - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** Specifies the blank space in pixels between the widget's extreme elements and the boundaries of the area provided for the widget (see the size option). */ - margin?: viz.core.Margins; - /** Specifies options of the gauge's range container. */ - rangeContainer?: BaseRangeContainer; - /** Specifies a gauge's scale options. */ - scale?: BaseScale; - /** Specifies the appearance options of subvalue indicators. */ - subvalueIndicator?: BaseValueIndicator; - /** Specifies a set of subvalues to be designated by the subvalue indicators. */ - subvalues?: Array; - /** Specifies the main value on a gauge. */ - value?: number; - /** Specifies the appearance options of the value indicator. */ - valueIndicator?: BaseValueIndicator; - } - /** A gauge widget. */ - export class dxBaseGauge extends viz.core.BaseWidget { - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(): void; - /** Returns the main gauge value. */ - value(): number; - /** Updates a gauge value. */ - value(value: number): void; - /** Returns an array of gauge subvalues. */ - subvalues(): Array; - /** Updates gauge subvalues. */ - subvalues(subvalues: Array): void; - } - export interface LinearRangeContainer extends BaseRangeContainer { - /** Specifies the orientation of the range container on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - /** Specifies the orientation of a range container on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - /** Specifies the width of the range container's start and end boundaries in the dxLinearGauge widget. */ - width?: any; - /** Specifies an end width of a range container. */ - end?: number; - /** Specifies a start width of a range container. */ - start?: number; - } - export interface LinearScaleLabel extends BaseScaleLabel { - /** Specifies the spacing between scale labels and ticks. */ - indentFromTick?: number; - } - export interface LinearScale extends BaseScale { - /** Specifies the orientation of scale ticks on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - label?: LinearScaleLabel; - /** Specifies the orientation of scale ticks on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - } - export interface dxLinearGaugeOptions extends BaseGaugeOptions { - /** Specifies the options required to set the geometry of the dxLinearGauge widget. */ - geometry?: { - /** Indicates whether to display the dxLinearGauge widget vertically or horizontally. */ - orientation?: string; - }; - /** Specifies gauge range container options. */ - rangeContainer?: LinearRangeContainer; - scale?: LinearScale; - } - /** A widget that represents a gauge with a linear scale. */ - export class dxLinearGauge extends dxBaseGauge { - constructor(element: JQuery, options?: dxLinearGaugeOptions); - constructor(element: Element, options?: dxLinearGaugeOptions); - } - export interface CircularRangeContainer extends BaseRangeContainer { - /** Specifies the orientation of the range container in the dxCircularGauge widget. */ - orientation?: string; - /** Specifies the range container's width in pixels. */ - width?: number; - } - export interface CircularScaleLabel extends BaseScaleLabel { - /** Specifies the spacing between scale labels and ticks. */ - indentFromTick?: number; - } - export interface CircularScale extends BaseScale { - label?: CircularScaleLabel; - /** Specifies the orientation of scale ticks. */ - orientation?: string; - } - export interface dxCircularGaugeOptions extends BaseGaugeOptions { - /** Specifies the options required to set the geometry of the dxCircularGauge widget. */ - geometry?: { - /** Specifies the end angle of the circular gauge's arc. */ - endAngle?: number; - /** Specifies the start angle of the circular gauge's arc. */ - startAngle?: number; - }; - /** Specifies gauge range container options. */ - rangeContainer?: CircularRangeContainer; - scale?: CircularScale; - } - /** A widget that represents a gauge with a circular scale. */ - export class dxCircularGauge extends dxBaseGauge { - constructor(element: JQuery, options?: dxCircularGaugeOptions); - constructor(element: Element, options?: dxCircularGaugeOptions); - } - export interface dxBarGaugeOptions extends viz.core.BaseWidgetOptions, SharedGaugeOptions { - /** Specifies a color for the remaining segment of the bar's track. */ - backgroundColor?: string; - /** Specifies a distance between bars in pixels. */ - barSpacing?: number; - /** Specifies a base value for bars. */ - baseValue?: number; - /** Specifies an end value for the gauge's invisible scale. */ - endValue?: number; - /** Defines the shape of the gauge's arc. */ - geometry?: { - /** Specifies the end angle of the bar gauge's arc. */ - endAngle?: number; - /** Specifies the start angle of the bar gauge's arc. */ - startAngle?: number; - }; - /** Specifies the options of the labels that accompany gauge bars. */ - label?: { - /** Specifies a color for the label connector text. */ - connectorColor?: string; - /** Specifies the width of the label connector in pixels. */ - connectorWidth?: number; - /** Specifies a callback function that returns a text for labels. */ - customizeText?: (barValue: { value: number; valueText: string }) => string; - /** Specifies font options for bar labels. */ - font?: viz.core.Font; - /** Specifies a format for bar labels. */ - format?: string; - /** Specifies the distance between the upper bar and bar labels in pixels. */ - indent?: number; - /** Specifies a precision for the formatted value displayed by labels. */ - precision?: number; - /** Specifies whether bar labels appear on a gauge or not. */ - visible?: boolean; - }; - /** Sets the name of the palette or an array of colors to be used for coloring the gauge range container. */ - palette?: string; - /** Defines the radius of the bar that is closest to the center relatively to the radius of the topmost bar. */ - relativeInnerRadius?: number; - /** Specifies a start value for the gauge's invisible scale. */ - startValue?: number; - /** Specifies the array of values to be indicated on a bar gauge. */ - values?: Array; - } - /** A circular bar widget. */ - export class dxBarGauge extends viz.core.BaseWidget { - constructor(element: JQuery, options?: dxBarGaugeOptions); - constructor(element: Element, options?: dxBarGaugeOptions); - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws the widget. */ - render(): void; - /** Returns an array of gauge values. */ - values(): Array; - /** Updates the values displayed by a gauge. */ - values(values: Array): void; - } -} -interface JQuery { - dxLinearGauge(options?: DevExpress.viz.gauges.dxLinearGaugeOptions): JQuery; - dxLinearGauge(methodName: string, ...params: any[]): any; - dxLinearGauge(methodName: "instance"): DevExpress.viz.gauges.dxLinearGauge; - dxCircularGauge(options?: DevExpress.viz.gauges.dxCircularGaugeOptions): JQuery; - dxCircularGauge(methodName: string, ...params: any[]): any; - dxCircularGauge(methodName: "instance"): DevExpress.viz.gauges.dxCircularGauge; - dxBarGauge(options?: DevExpress.viz.gauges.dxBarGaugeOptions): JQuery; - dxBarGauge(methodName: string, ...params: any[]): any; - dxBarGauge(methodName: "instance"): DevExpress.viz.gauges.dxBarGauge; -} -declare namespace DevExpress.viz.rangeSelector { - export interface dxRangeSelectorOptions extends viz.core.BaseWidgetOptions { - /** Specifies the options for the range selector's background. */ - background?: { - /** Specifies the background color for the dxRangeSelector. */ - color?: string; - /** Specifies image options. */ - image?: { - /** Specifies a location for the image in the background of a range selector. */ - location?: string; - /** Specifies the image's URL. */ - url?: string; - }; - /** Indicates whether or not the background (background color and/or image) is visible. */ - visible?: boolean; - }; - /** Specifies the dxRangeSelector's behavior options. */ - behavior?: { - /** Indicates whether or not you can swap sliders. */ - allowSlidersSwap?: boolean; - /** -Indicates whether or not animation is enabled. - */ - animationEnabled?: boolean; - /** Specifies when to call the onSelectedRangeChanged function. */ - callSelectedRangeChanged?: string; - /** Indicates whether or not an end user can specify the range using a mouse, without the use of sliders. */ - manualRangeSelectionEnabled?: boolean; - /** Indicates whether or not an end user can shift the selected range to the required location on a scale by clicking. */ - moveSelectedRangeByClick?: boolean; - /** Indicates whether to snap a slider to ticks. */ - snapToTicks?: boolean; - }; - /** Specifies the options required to display a chart as the range selector's background. */ - chart?: { - /** Specifies a coefficient for determining an indent from the bottom background boundary to the lowest chart point. */ - bottomIndent?: number; - /** An object defining the common configuration options for the chart’s series. */ - commonSeriesSettings?: viz.charts.CommonSeriesSettings; - /** An object providing options for managing data from a data source. */ - dataPrepareSettings?: { - /** Specifies whether or not to validate values from a data source. */ - checkTypeForAllData?: boolean; - /** Specifies whether or not to convert the values from a data source into the data type of an axis. */ - convertToAxisDataType?: boolean; - /** Specifies how to sort series points. */ - sortingMethod?: any; - }; - /** Specifies a value indicating whether all bars in a series must have the same width, or may have different widths if any points in other series are missing. */ - equalBarWidth?: any; - /** An object defining the chart’s series. */ - series?: Array; - /** Defines options for the series template. */ - seriesTemplate?: viz.charts.SeriesTemplate; - /** Specifies a coefficient for determining an indent from the background's top boundary to the topmost chart point. */ - topIndent?: number; - /** Specifies whether or not to filter the series points depending on their quantity. */ - useAggregation?: boolean; - /** Specifies options for the chart's value axis. */ - valueAxis?: { - /** Indicates whether or not the chart's value axis must be inverted. */ - inverted?: boolean; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic value axis. */ - logarithmBase?: number; - /** Specifies the maximum value of the chart's value axis. */ - max?: number; - /** Specifies the minimum value of the chart's value axis. */ - min?: number; - /** Specifies the type of the value axis. */ - type?: string; - /** Specifies the desired type of axis values. */ - valueType?: string; - }; - }; - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** Specifies a data source for the scale values and for the chart at the background. */ - dataSource?: any; - /** Specifies the data source field that provides data for the scale. */ - dataSourceField?: string; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies the blank space in pixels between the dxRangeSelector widget's extreme elements and the boundaries of the area provided for the widget (see size). */ - margin?: viz.core.Margins; - /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */ - redrawOnResize?: boolean; - /** Specifies options of the range selector's scale. */ - scale?: { - /** Specifies the scale's end value. */ - endValue?: any; - /** Specifies common options for scale labels. */ - label?: { - /** Specifies a callback function that returns the text to be displayed in scale labels. */ - customizeText?: (scaleValue: { value: any; valueText: string; }) => string; - /** Specifies font options for the text displayed in the range selector's scale labels. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in scale labels. */ - format?: string; - /** Specifies a precision for the formatted value displayed in the scale labels. */ - precision?: number; - /** Specifies a spacing between scale labels and the background bottom edge. */ - topIndent?: number; - /** Specifies whether or not the scale's labels are visible. */ - visible?: boolean; - }; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic scale. */ - logarithmBase?: number; - /** Specifies an interval between major ticks. */ - majorTickInterval?: any; - /** Specifies options for the date-time scale's markers. */ - marker?: { - /** Defines the options that can be set for the text that is displayed by the scale markers. */ - label?: { - /** Specifies a callback function that returns the text to be displayed in scale markers. */ - customizeText?: (markerValue: { value: any; valueText: string }) => string; - /** Specifies a format for the text displayed in scale markers. */ - format?: string; - }; - /** Specifies the height of the marker's separator. */ - separatorHeight?: number; - /** Specifies the space between the marker label and the marker separator. */ - textLeftIndent?: number; - /** Specifies the space between the marker's label and the top edge of the marker's separator. */ - textTopIndent?: number; - /** Specified the indent between the marker and the scale lables. */ - topIndent?: number; - /** Indicates whether scale markers are visible. */ - visible?: boolean; - }; - /** Specifies the maximum range that can be selected. */ - maxRange?: any; - /** Specifies the number of minor ticks between neighboring major ticks. */ - minorTickCount?: number; - /** -Specifies an interval between minor ticks. - */ - minorTickInterval?: any; - /** Specifies the minimum range that can be selected. */ - minRange?: any; - /** Specifies the height of the space reserved for the scale in pixels. */ - placeholderHeight?: number; - /** Indicates whether or not to set ticks of a date-time scale at the beginning of each date-time interval. */ - setTicksAtUnitBeginning?: boolean; - /** Specifies whether or not to show ticks for the boundary scale values, when neither major ticks nor minor ticks are created for these values. */ - showCustomBoundaryTicks?: boolean; - /** Indicates whether or not to show minor ticks on the scale. */ - showMinorTicks?: boolean; - /** Specifies the scale's start value. */ - startValue?: any; - /** Specifies options defining the appearance of scale ticks. */ - tick?: { - /** Specifies the color of scale ticks (both major and minor ticks). */ - color?: string; - /** Specifies the opacity of scale ticks (both major and minor ticks). */ - opacity?: number; - /** Specifies the width of the scale's ticks (both major and minor ticks). */ - width?: number; - }; - /** Specifies the type of the scale. */ - type?: string; - /** Specifies whether or not to expand the current tick interval if labels overlap each other. */ - useTicksAutoArrangement?: boolean; - /** Specifies the type of values on the scale. */ - valueType?: string; - /** Specifies the order of arguments on a discrete scale. */ - categories?: Array; - }; - /** Specifies the range to be selected when displaying the dxRangeSelector. */ - selectedRange?: { - /** Specifies the start value of the range to be selected when displaying the dxRangeSelector widget on a page. */ - startValue?: any; - /** Specifies the end value of the range to be selected when displaying the dxRangeSelector widget on a page. */ - endValue?: any; - }; - /** Specifies the color of the selected range. */ - selectedRangeColor?: string; - /** Range selector's indent options. */ - indent?: { - /** Specifies range selector's left indent. */ - left?: number; - /** Specifies range selector's right indent. */ - right?: number; - }; - selectedRangeChanged?: (selectedRange: { startValue: any; endValue: any; }) => void; - /** A handler for the selectedRangeChanged event. */ - onSelectedRangeChanged?: (e: { - startValue: any; - endValue: any; - component: dxRangeSelector; - element: Element; - }) => void; - /** Specifies range selector shutter options. */ - shutter?: { - /** Specifies shutter color. */ - color?: string; - /** Specifies the opacity of the color of shutters. */ - opacity?: number; - }; - /** Specifies in pixels the size of the dxRangeSelector widget. */ - size?: viz.core.Size; - /** Specifies the appearance of the range selector's slider handles. */ - sliderHandle?: { - /** Specifies the color of the slider handles. */ - color?: string; - /** Specifies the opacity of the slider handles. */ - opacity?: number; - /** Specifies the width of the slider handles. */ - width?: number; - }; - /** Defines the options of the range selector slider markers. */ - sliderMarker?: { - /** Specifies the color of the slider markers. */ - color?: string; - /** Specifies a callback function that returns the text to be displayed by slider markers. */ - customizeText?: (scaleValue: { value: any; valueText: any; }) => string; - /** Specifies font options for the text displayed by the range selector slider markers. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in slider markers. */ - format?: string; - /** Specifies the color used for the slider marker text when the currently selected range does not match the minRange and maxRange values. */ - invalidRangeColor?: string; - /** - * Specifies the empty space between the marker's border and the marker’s text. - * @deprecated Use the 'paddingTopBottom' and 'paddingLeftRight' options instead - */ - padding?: number; - /** Specifies the empty space between the marker's top and bottom borders and the marker's text. */ - paddingTopBottom?: number; - /** Specifies the empty space between the marker's left and right borders and the marker's text. */ - paddingLeftRight?: number; - /** Specifies the placeholder height of the slider marker. */ - placeholderHeight?: number; - /** - * Specifies in pixels the height and width of the space reserved for the range selector slider markers. - * @deprecated Use the 'placeholderHeight' and 'indent' options instead - */ - placeholderSize?: { - /** Specifies the height of the placeholder for the left and right slider markers. */ - height?: number; - /** Specifies the width of the placeholder for the left and right slider markers. */ - width?: { - /** Specifies the width of the left slider marker's placeholder. */ - left?: number; - /** Specifies the width of the right slider marker's placeholder. */ - right?: number; - }; - }; - /** Specifies a precision for the formatted value displayed in slider markers. */ - precision?: number; - /** Indicates whether or not the slider markers are visible. */ - visible?: boolean; - }; - } - /** A widget that allows end users to select a range of values on a scale. */ - export class dxRangeSelector extends viz.core.BaseWidget { - constructor(element: JQuery, options?: dxRangeSelectorOptions); - constructor(element: Element, options?: dxRangeSelectorOptions); - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(skipChartAnimation?: boolean): void; - /** Returns the currently selected range. */ - getSelectedRange(): { startValue: any; endValue: any; }; - /** Sets a specified range. */ - setSelectedRange(selectedRange: { startValue: any; endValue: any; }): void; - } -} -interface JQuery { - dxRangeSelector(options?: DevExpress.viz.rangeSelector.dxRangeSelectorOptions): JQuery; - dxRangeSelector(methodName: string, ...params: any[]): any; - dxRangeSelector(methodName: "instance"): DevExpress.viz.rangeSelector.dxRangeSelector; -} -declare namespace DevExpress.viz.map { - /** This section describes the fields and methods that can be used in code to manipulate the Area object. */ - export interface Area { - /** Contains the element type. */ - type: string; - /** Return the value of an attribute. */ - attribute(name: string): any; - /** Provides information about the selection state of an area. */ - selected(): boolean; - /** Sets a new selection state for an area. */ - selected(state: boolean): void; - /** Applies the area settings specified as a parameter and updates the area appearance. */ - applySettings(settings: any): void; - } - /** This section describes the fields and methods that can be used in code to manipulate the Markers object. */ - export interface Marker { - /** Contains the descriptive text accompanying the map marker. */ - text: string; - /** Contains the type of the element. */ - type: string; - /** Contains the URL of an image map marker. */ - url: string; - /** Contains the value of a bubble map marker. */ - value: number; - /** Contains the values of a pie map marker. */ - values: Array; - /** Returns the value of an attribute. */ - attribute(name: string): any; - /** Returns the coordinates of a specific marker. */ - coordinates(): Array; - /** Provides information about the selection state of a marker. */ - selected(): boolean; - /** Sets a new selection state for a marker. */ - selected(state: boolean): void; - /** Applies the marker settings specified as a parameter and updates the marker appearance. */ - applySettings(settings: any): void; - } - export interface AreaSettings { - /** Specifies the width of the area border in pixels. */ - borderWidth?: number; - /** Specifies a color for the area border. */ - borderColor?: string; - click?: any; - /** Specifies a color for an area. */ - color?: string; - /** Specifies the function that customizes each area individually. */ - customize?: (areaInfo: Area) => AreaSettings; - /** Specifies a color for the area border when the area is hovered over. */ - hoveredBorderColor?: string; - /** Specifies the pixel-measured width of the area border when the area is hovered over. */ - hoveredBorderWidth?: number; - /** Specifies a color for an area when this area is hovered over. */ - hoveredColor?: string; - /** Specifies whether or not to change the appearance of an area when it is hovered over. */ - hoverEnabled?: boolean; - /** Configures area labels. */ - label?: { - /** Specifies the data field that provides data for area labels. */ - dataField?: string; - /** Enables area labels. */ - enabled?: boolean; - /** Specifies font options for area labels. */ - font?: viz.core.Font; - }; - /** Specifies the name of the palette or a custom range of colors to be used for coloring a map. */ - palette?: any; - /** Specifies the number of colors in a palette. */ - paletteSize?: number; - /** Allows you to paint areas with similar attributes in the same color. */ - colorGroups?: Array; - /** Specifies the field that provides data to be used for coloring areas. */ - colorGroupingField?: string; - /** Specifies a color for the area border when the area is selected. */ - selectedBorderColor?: string; - /** Specifies a color for an area when this area is selected. */ - selectedColor?: string; - /** Specifies the pixel-measured width of the area border when the area is selected. */ - selectedBorderWidth?: number; - selectionChanged?: (area: Area) => void; - /** Specifies whether single or multiple areas can be selected on a vector map. */ - selectionMode?: string; - } - export interface MarkerSettings { - /** Specifies a color for the marker border. */ - borderColor?: string; - /** Specifies the width of the marker border in pixels. */ - borderWidth?: number; - click?: any; - /** Specifies a color for a marker of the dot or bubble type. */ - color?: string; - /** Specifies the function that customizes each marker individually. */ - customize?: (markerInfo: Marker) => MarkerSettings; - font?: Object; - /** Specifies the pixel-measured width of the marker border when the marker is hovered over. */ - hoveredBorderWidth?: number; - /** Specifies a color for the marker border when the marker is hovered over. */ - hoveredBorderColor?: string; - /** Specifies a color for a marker of the dot or bubble type when this marker is hovered over. */ - hoveredColor?: string; - /** Specifies whether or not to change the appearance of a marker when it is hovered over. */ - hoverEnabled?: boolean; - /** Specifies marker label options. */ - label?: { - /** Enables marker labels. */ - enabled?: boolean; - /** Specifies font options for marker labels. */ - font?: viz.core.Font; - }; - /** Specifies the pixel-measured diameter of the marker that represents the biggest value. Setting this option makes sense only if you use markers of the bubble type. */ - maxSize?: number; - /** Specifies the pixel-measured diameter of the marker that represents the smallest value. Setting this option makes sense only if you use markers of the bubble type. */ - minSize?: number; - /** Specifies the opacity of markers. Setting this option makes sense only if you use markers of the bubble type. */ - opacity?: number; - /** Specifies the pixel-measured width of the marker border when the marker is selected. */ - selectedBorderWidth?: number; - /** Specifies a color for the marker border when the marker is selected. */ - selectedBorderColor?: string; - /** Specifies a color for a marker of the dot or bubble type when this marker is selected. */ - selectedColor?: string; - selectionChanged?: (marker: Marker) => void; - /** Specifies whether a single or multiple markers can be selected on a vector map. */ - selectionMode?: string; - /** Specifies the size of markers. Setting this option makes sense for any type of marker except bubble. */ - size?: number; - /** Specifies the type of markers to be used on the map. */ - type?: string; - /** Specifies the name of a palette or a custom set of colors to be used for coloring markers of the pie type. */ - palette?: any; - /** Allows you to paint markers with similar attributes in the same color. */ - colorGroups?: Array; - /** Specifies the field that provides data to be used for coloring markers. */ - colorGroupingField?: string; - /** Allows you to display bubbles with similar attributes in the same size. */ - sizeGroups?: Array; - /** Specifies the field that provides data to be used for sizing bubble markers. */ - sizeGroupingField?: string; - } - export interface dxVectorMapOptions extends viz.core.BaseWidgetOptions { - /** An object specifying options for the map areas. */ - areaSettings?: AreaSettings; - /** Specifies the options for the map background. */ - background?: { - /** Specifies a color for the background border. */ - borderColor?: string; - /** Specifies a color for the background. */ - color?: string; - }; - /** Specifies the positioning of a map in geographical coordinates. */ - bounds?: Array; - /** Specifies the options of the control bar. */ - controlBar?: { - /** Specifies a color for the outline of the control bar elements. */ - borderColor?: string; - /** Specifies a color for the inner area of the control bar elements. */ - color?: string; - /** Specifies whether or not to display the control bar. */ - enabled?: boolean; - /** Specifies the margin of the control bar in pixels. */ - margin?: number; - /** Specifies the position of the control bar. */ - horizontalAlignment?: string; - /** Specifies the position of the control bar. */ - verticalAlignment?: string; - /** Specifies the opacity of the Control_Bar. */ - opacity?: number; - }; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies a data source for the map area. */ - mapData?: any; - /** Specifies a data source for the map markers. */ - markers?: any; - /** An object specifying options for the map markers. */ - markerSettings?: MarkerSettings; - /** Specifies the size of the dxVectorMap widget. */ - size?: viz.core.Size; - /** Specifies tooltip options. */ - tooltip?: viz.core.Tooltip; - /** Configures map legends. */ - legends?: Array; - /** Specifies whether or not the map should respond when a user rolls the mouse wheel. */ - wheelEnabled?: boolean; - /** Specifies whether the map should respond to touch gestures. */ - touchEnabled?: boolean; - /** Disables the zooming capability. */ - zoomingEnabled?: boolean; - /** Specifies the geographical coordinates of the center for a map. */ - center?: Array; - centerChanged?: (center: Array) => void; - /** A handler for the centerChanged event. */ - onCenterChanged?: (e: { - center: Array; - component: dxVectorMap; - element: Element; - }) => void; - /** Specifies a number that is used to zoom a map initially. */ - zoomFactor?: number; - /** Specifies a map's maximum zoom factor. */ - maxZoomFactor?: number; - zoomFactorChanged?: (zoomFactor: number) => void; - /** A handler for the zoomFactorChanged event. */ - onZoomFactorChanged?: (e: { - zoomFactor: number; - component: dxVectorMap; - element: Element; - }) => void; - click?: any; - /** A handler for the click event. */ - onClick?: any; - /** A handler for the areaClick event. */ - onAreaClick?: any; - /** A handler for the areaSelectionChanged event. */ - onAreaSelectionChanged?: (e: { - target: Area; - component: dxVectorMap; - element: Element; - }) => void; - /** A handler for the markerClick event. */ - onMarkerClick?: any; - /** A handler for the markerSelectionChanged event. */ - onMarkerSelectionChanged?: (e: { - target: Marker; - component: dxVectorMap; - element: Element; - }) => void; - /** Disables the panning capability. */ - panningEnabled?: boolean; - } - export interface Legend extends viz.core.BaseLegend { - /** Specifies text for legend items. */ - customizeText?: (itemInfo: { start: number; end: number; index: number; color: string; size: number; }) => string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the text of a legend item. */ - customizeHint?: (itemInfo: { start: number; end: number; index: number; color: string; size: number }) => string; - /** Specifies the source of data for the legend. */ - source?: string; - } - /** A vector map widget. */ - export class dxVectorMap extends viz.core.BaseWidget { - constructor(element: JQuery, options?: dxVectorMapOptions); - constructor(element: Element, options?: dxVectorMapOptions); - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(): void; - /** Gets the current coordinates of the map center. */ - center(): Array; - /** Sets the coordinates of the map center. */ - center(centerCoordinates: Array): void; - /** Deselects all the selected areas on a map. The areas are displayed in their initial style after. */ - clearAreaSelection(): void; - /** Deselects all the selected markers on a map. The markers are displayed in their initial style after. */ - clearMarkerSelection(): void; - /** Deselects all the selected area and markers on a map at once. The areas and markers are displayed in their initial style after. */ - clearSelection(): void; - /** Converts client area coordinates into map coordinates. */ - convertCoordinates(x: number, y: number): Array; - /** Returns an array with all the map areas. */ - getAreas(): Array; - /** Returns an array with all the map markers. */ - getMarkers(): Array; - /** Gets the current coordinates of the map viewport. */ - viewport(): Array; - /** Sets the coordinates of the map viewport. */ - viewport(viewportCoordinates: Array): void; - /** Gets the current value of the map zoom factor. */ - zoomFactor(): number; - /** Sets the value of the map zoom factor. */ - zoomFactor(zoomFactor: number): void; - } -} -interface JQuery { - dxVectorMap(options?: DevExpress.viz.map.dxVectorMapOptions): JQuery; - dxVectorMap(methodName: string, ...params: any[]): any; - dxVectorMap(methodName: "instance"): DevExpress.viz.map.dxVectorMap; -} -declare namespace DevExpress.viz.sparklines { - export interface SparklineTooltip extends viz.core.Tooltip { - /** - * Specifies how a tooltip is horizontally aligned relative to the graph. - * @deprecated Tooltip alignment is no more available. - */ - horizontalAlignment?: string; - /** - * Specifies how a tooltip is vertically aligned relative to the graph. - * @deprecated Tooltip alignment is no more available. - */ - verticalAlignment?: string; - } - export interface BaseSparklineOptions extends viz.core.BaseWidgetOptions { - /** Specifies the blank space between the widget's extreme elements and the boundaries of the area provided for the widget in pixels. */ - margin?: viz.core.Margins; - /** Specifies the size of the widget. */ - size?: viz.core.Size; - /** Specifies tooltip options. */ - tooltip?: SparklineTooltip; - } - /** Overridden by descriptions for particular widgets. */ - export class BaseSparkline extends viz.core.BaseWidget { - /** Redraws a widget. */ - render(): void; - } - export interface dxBulletOptions extends BaseSparkline { - /** Specifies a color for the bullet bar. */ - color?: string; - /** Specifies an end value for the invisible scale. */ - endScaleValue?: number; - /** Specifies whether or not to show the target line. */ - showTarget?: boolean; - /** Specifies whether or not to show the line indicating zero on the invisible scale. */ - showZeroLevel?: boolean; - /** Specifies a start value for the invisible scale. */ - startScaleValue?: number; - /** Specifies the value indicated by the target line. */ - target?: number; - /** Specifies a color for both the target and zero level lines. */ - targetColor?: string; - /** Specifies the width of the target line. */ - targetWidth?: number; - /** Specifies the primary value indicated by the bullet bar. */ - value?: number; - } - /** A bullet graph widget. */ - export class dxBullet extends BaseSparkline { - constructor(element: JQuery, options?: dxBulletOptions); - constructor(element: Element, options?: dxBulletOptions); - } - export interface dxSparklineOptions extends BaseSparklineOptions { - /** Specifies the data source field that provides arguments for a sparkline. */ - argumentField?: string; - /** Sets a color for the bars indicating negative values. Available for a sparkline of the bar type only. */ - barNegativeColor?: string; - /** Sets a color for the bars indicating positive values. Available for a sparkline of the bar type only. */ - barPositiveColor?: string; - /** Specifies a data source for the sparkline. */ - dataSource?: Array; - /** Sets a color for the boundary of both the first and last points on a sparkline. */ - firstLastColor?: string; - /** Specifies whether a sparkline ignores null data points or not. */ - ignoreEmptyPoints?: boolean; - /** Sets a color for a line on a sparkline. Available for the sparklines of the line- and area-like types. */ - lineColor?: string; - /** Specifies a width for a line on a sparkline. Available for the sparklines of the line- and area-like types. */ - lineWidth?: number; - /** Sets a color for the bars indicating the values that are less than the winloss threshold. Available for a sparkline of the winloss type only. */ - lossColor?: string; - /** Sets a color for the boundary of the maximum point on a sparkline. */ - maxColor?: string; - /** Sets a color for the boundary of the minimum point on a sparkline. */ - minColor?: string; - /** Sets a color for points on a sparkline. Available for the sparklines of the line- and area-like types. */ - pointColor?: string; - /** Specifies the diameter of sparkline points in pixels. Available for the sparklines of line- and area-like types. */ - pointSize?: number; - /** Specifies a symbol to use as a point marker on a sparkline. Available for the sparklines of the line- and area-like types. */ - pointSymbol?: string; - /** Specifies whether or not to indicate both the first and last values on a sparkline. */ - showFirstLast?: boolean; - /** Specifies whether or not to indicate both the minimum and maximum values on a sparkline. */ - showMinMax?: boolean; - /** Determines the type of a sparkline. */ - type?: string; - /** Specifies the data source field that provides values for a sparkline. */ - valueField?: string; - /** Sets a color for the bars indicating the values greater than a winloss threshold. Available for a sparkline of the winloss type only. */ - winColor?: string; - /** Specifies a value that serves as a threshold for the sparkline of the winloss type. */ - winlossThreshold?: number; - /** Specifies the minimum value of the sparkline value axis. */ - minValue?: number; - /** Specifies the maximum value of the sparkline's value axis. */ - maxValue?: number; - } - /** A sparkline widget. */ - export class dxSparkline extends BaseSparkline { - constructor(element: JQuery, options?: dxSparklineOptions); - constructor(element: Element, options?: dxSparklineOptions); - } -} -interface JQuery { - dxBullet(options?: DevExpress.viz.sparklines.dxBulletOptions): JQuery; - dxBullet(methodName: string, ...params: any[]): any; - dxBullet(methodName: "instance"): DevExpress.viz.sparklines.dxBullet; - dxSparkline(options?: DevExpress.viz.sparklines.dxSparklineOptions): JQuery; - dxSparkline(methodName: string, ...params: any[]): any; - dxSparkline(methodName: "instance"): DevExpress.viz.sparklines.dxSparkline; -} diff --git a/devextreme/devextreme-15.1.5.d.ts b/devextreme/devextreme-15.1.5.d.ts deleted file mode 100644 index 6e0fbdf7ae..0000000000 --- a/devextreme/devextreme-15.1.5.d.ts +++ /dev/null @@ -1,6497 +0,0 @@ -// Type definitions for DevExtreme 15.1.5 -// Project: http://js.devexpress.com/ -// Definitions by: DevExpress Inc. -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -/// - -declare namespace DevExpress { - /** A mixin that provides a capability to fire and subscribe to events. */ - export interface EventsMixin { - /** Subscribes to a specified event. */ - on(eventName: string, eventHandler: Function): T; - /** Subscribes to the specified events. */ - on(events: { [eventName: string]: Function; }): T; - /** Detaches all event handlers from the specified event. */ - off(eventName: string): Object; - /** Detaches a particular event handler from the specified event. */ - off(eventName: string, eventHandler: Function): T; - } - /** An object that serves as a namespace for the methods required to perform validation. */ - export module validationEngine { - export interface IValidator { - validate(): ValidatorValidationResult; - reset(): void; - } - export interface ValidatorValidationResult { - isValid: boolean; - name?: string; - value: any; - brokenRule: any; - validationRules: any[]; - } - export interface ValidationGroupValidationResult { - isValid: boolean; - brokenRules: any[]; - validators: IValidator[]; - } - export interface GroupConfig extends EventsMixin { - group: any; - validators: IValidator[]; - validate(): ValidationGroupValidationResult; - reset(): void; - } - /** Provides access to the object that represents the specified validation group. */ - export function getGroupConfig(group: any): GroupConfig - /** Provides access to the object that represents the default validation group. */ - export function getGroupConfig(): GroupConfig - /** Validates rules of the validators that belong to the specified validation group. */ - export function validateGroup(group: any): ValidationGroupValidationResult; - /** Validates rules of the validators that belong to the default validation group. */ - export function validateGroup(): ValidationGroupValidationResult; - /** Resets the values and validation result of the editors that belong to the specified validation group. */ - export function resetGroup(group: any): void; - /** Resets the values and validation result of the editors that belong to the default validation group. */ - export function resetGroup(): void; - /** Validates the rules that are defined within the dxValidator objects that are registered for the specified ViewModel. */ - export function validateModel(model: Object): ValidationGroupValidationResult; - /** Registers all the dxValidator objects by which the fields of the specified ViewModel are extended. */ - export function registerModelForValidation(model: Object) : void; - } - export var hardwareBackButton: JQueryCallback; - /** Processes the hardware back button click. */ - export function processHardwareBackButton(): void; - /** Specifies whether or not the entire application/site supports right-to-left representation. */ - export var rtlEnabled: boolean; - /** Registers a new component in the DevExpress.ui namespace, and a jQuery plugin and Knockout binding for the required component. */ - export function registerComponent(name: string, componentClass: Object): void; - /** Registers a new component in the specified namespace as a jQuery plugin, Angular directive and Knockout binding. */ - export function registerComponent(name: string, namespace: Object, componentClass: Object): void; - /** Requests that the browser call a specified function to update animation before the next repaint. */ - export function requestAnimationFrame(callback: Function): number; - /** Cancels an animation frame request scheduled with the requestAnimationFrame method. */ - export function cancelAnimationFrame(requestID: number): void; - /** Custom Knockout binding that links an HTML element with a specific action. */ - export class Action { } - /** Used to get URLs that vary in a locally running application and the application running on production. */ - export class EndpointSelector { - constructor(options: { - [key: string]: { - local?: string; - production?: string; - } - }); - /** Returns a local or a productional URL depending on how the application is currently running. */ - urlFor(key: string): string; - } - /** An object that serves as a namespace for the methods that are used to animate UI elements. */ - export module fx { - /** Defines animation options. */ - export interface AnimationOptions { - /** A function called after animation is completed. */ - complete?: (element: JQuery, config: AnimationOptions) => void; - /** A number specifying wait time before animation execution. */ - delay?: number; - /** A number specifying the time period to wait before the animation of the next stagger item starts. */ - staggerDelay?: number; - /** A number specifying the time in milliseconds spent on animation. */ - duration?: number; - /** A string specifying the type of an easing function used for animation. */ - easing?: string; - /** Specifies the initial animation state. */ - from?: any; - /** A function called before animation is started. */ - start?: (element: JQuery, config: AnimationOptions) => void; - /** Specifies a final animation state. */ - to?: any; - /** A string value specifying the animation type. */ - type?: string; - /** Specifies the animation direction for the "slideIn" and "slideOut" animation types. */ - direction?: string; - } - /** Animates the specified element. */ - export function animate(element: HTMLElement, config: AnimationOptions): Object; - /** Returns a value indicating whether the specified element is being animated. */ - export function isAnimating(element: HTMLElement): boolean; - /** Stops the animation. */ - export function stop(element: HTMLElement, jumpToEnd: boolean): void; - } - /** The manager that performs several specified animations at a time. */ - export class TransitionExecutor { - /** Deletes all the animations registered in the Transition Executor by using the enter(elements, animation) and leave(elements, animation) methods. */ - reset(): void; - /** Registers a set of elements that should be animated as "entering" using the specified animation configuration. */ - enter(elements: JQuery, animation: any): void; - /** Registers a set of elements that should be animated as "leaving" using the specified animation configuration. */ - leave(elements: JQuery, animation: any): void; - /** Starts all the animations registered using the enter(elements, animation) and leave(elements, animation) methods beforehand. */ - start(config: Object): JQueryPromise; - } - export class AnimationPresetCollection { - /** Resets all the changes made in the animation repository. */ - resetToDefaults(): void; - /** Deletes the specified animation or clears all the animation repository, if an animation name is not passed. */ - clear(name: string): void; - /** Adds the specified animation preset to the animation repository by the specified name. */ - registerPreset(name: string, config: any): void; - /** Applies the changes made in the animation repository. */ - applyChanges(): void; - /** Returns the configuration of the animation found in the animation repository by the specified name for the current device. */ - getPreset(name: string): void; - /** Registers predefined animations in the animation repository. */ - registerDefaultPresets(): void; - } - /** A repository of animations. */ - export var animationPresets: AnimationPresetCollection; - /** The device object defines the device on which the application is running. */ - export interface Device { - /** Indicates whether or not the device platform is Android. */ - android?: boolean; - /** Specifies the type of the device on which the application is running. */ - deviceType?: string; - /** Indicates whether or not the device platform is generic, which means that the application will look and behave according to a generic "light" or "dark" theme. */ - generic?: boolean; - /** Indicates whether or not the device platform is iOS. */ - ios?: boolean; - /** Indicates whether or not the device type is 'phone'. */ - phone?: boolean; - /** Specifies the platform of the device on which the application is running. */ - platform?: string; - /** Indicates whether or not the device type is 'tablet'. */ - tablet?: boolean; - /** Specifies an array with the major and minor versions of the device platform. */ - version?: Array; - /** Indicates whether or not the device platform is Windows8. */ - win8?: boolean; - /** Specifies a performance grade of the current device. */ - grade?: string; - } - export class Devices implements EventsMixin { - constructor(options: { window: Window }); - /** Overrides actual device information to force the application to operate as if it was running on the specified device. */ - current(deviceName: any): void; - /** Returns information about the current device. */ - current(): Device; - orientationChanged: JQueryCallback; - /** Returns the current device orientation. */ - orientation(): string; - /** Returns real information about the current device regardless of the value passed to the devices.current(deviceName) method. */ - real(): Device; - on(eventName: "orientationChanged", eventHandler: (e: { orientation: string }) => void): Devices; - on(eventName: string, eventHandler: Function): Devices; - on(events: { [eventName: string]: Function; }): Devices; - off(eventName: "orientationChanged"): Devices; - off(eventName: string): Devices; - off(eventName: "orientationChanged", eventHandler: (e: { orientation: string }) => void): Devices; - off(eventName: string, eventHandler: Function): Devices; - } - /** An object that serves as a namespace for the methods and events specifying information on the current device. */ - export var devices: Devices; - /** The position object specifies the widget positioning options. */ - export interface PositionOptions { - /** The target element position that the widget is positioned against. */ - at?: string; - /** The element within which the widget is positioned. */ - boundary?: Element; - /** A string value holding horizontal and vertical offset from the window's boundaries. */ - boundaryOffset?: string; - /** Specifies how to move the widget if it overflows the screen. */ - collision?: any; - /** The position of the widget to align against the target element. */ - my?: string; - /** The target element that the widget is positioned against. */ - of?: HTMLElement; - /** A string value holding horizontal and vertical offset in pixels, separated by a space (e.g., "5 -10"). */ - offset?: string; - } - export interface ComponentOptions { - /** A handler for the initialized event. */ - onInitialized?: Function; - /** A handler for the optionChanged event. */ - onOptionChanged?: Function; - /** A handler for the disposing event. */ - onDisposing?: Function; - } - /** A base class for all components and widgets. */ - export class Component { - constructor(options?: ComponentOptions) - /** Prevents the component from refreshing until the endUpdate method is called. */ - beginUpdate(): void; - /** Enables the component to refresh after the beginUpdate method call. */ - endUpdate(): void; - /** Returns an instance of this component class. */ - instance(): Component; - /** Sets one or more options of this component. */ - option(options: Object): void; - /** Returns the configuration options of this component. */ - option(): Object; - /** Gets the value of the specified configuration option of this component. */ - option(optionName: string): any; - /** Sets a value to the specified configuration option of this component. */ - option(optionName: string, optionValue: any): void; - } - export interface DOMComponentOptions extends ComponentOptions { - /** Specifies whether or not the current component supports a right-to-left representation. */ - rtlEnabled?: boolean; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies the width of the widget. */ - width?: any; - } - /** A base class for all components. */ - export class DOMComponent extends Component { - constructor(element: JQuery, options?: DOMComponentOptions); - constructor(element: HTMLElement, options?: DOMComponentOptions); - /** Returns the root HTML element of the widget. */ - element(): JQuery; - /** Specifies the device-dependent default configuration options for this component. */ - static defaultOptions(rule: { - device?: any; - options?: any; - }): void; - } - export module data { - export interface ODataError extends Error { - httpStatus?: number; - errorDetails?: any; - } - export interface StoreOptions { - inserted?: (values: Object, key: any) => void; - inserting?: (values: Object) => void; - loaded?: (result: Array) => void; - loading?: (loadOptions: LoadOptions) => void; - modified?: () => void; - modifying?: () => void; - removed?: (key: any) => void; - removing?: (key: any) => void; - updated?: (key: any, values: Object) => void; - updating?: (key: any, values: Object) => void; - /** A handler for the modified event. */ - onModified?: () => void; - /** A handler for the modifying event. */ - onModifying?: () => void; - /** A handler for the removed event. */ - onRemoved?: (key: any) => void; - /** A handler for the removing event. */ - onRemoving?: (key: any) => void; - /** A handler for the updated event. */ - onUpdated?: (key: any, values: Object) => void; - /** A handler for the updating event. */ - onUpdating?: (key: any, values: Object) => void; - /** A handler for the loaded event. */ - onLoaded?: (result: Array) => void; - /** A handler for the loading event. */ - onLoading?: (loadOptions: LoadOptions) => void; - /** A handler for the inserted event. */ - onInserted?: (values: Object, key: any) => void; - /** A handler for the inserting event. */ - onInserting?: (values: Object) => void; - /** Specifies the function called when the Store causes an error. */ - errorHandler?: (e: Error) => void; - /** Specifies the key properties within the data associated with the Store. */ - key?: any; - } - export interface LoadOptions { - filter?: Object; - sort?: Object; - select?: Object; - expand?: Object; - group?: Object; - skip?: number; - take?: number; - userData?: Object; - requireTotalCount?: boolean; - } - /** The base class for all Stores. */ - export class Store implements EventsMixin { - inserted: JQueryCallback; - inserting: JQueryCallback; - loaded: JQueryCallback; - loading: JQueryCallback; - modified: JQueryCallback; - modifying: JQueryCallback; - removed: JQueryCallback; - removing: JQueryCallback; - updated: JQueryCallback; - updating: JQueryCallback; - constructor(options?: StoreOptions); - /** Returns the data item specified by the key. */ - byKey(key: any): JQueryPromise; - /** Adds an item to the data associated with this Store. */ - insert(values: Object): JQueryPromise; - /** Returns the key expression specified via the key configuration option. */ - key(): any; - /** Returns the key of the Store item that matches the specified object. */ - keyOf(obj: Object): any; - /** Starts loading the data. */ - load(obj?: LoadOptions): JQueryPromise; - /** Removes the data item specified by the key. */ - remove(key: any): JQueryPromise; - /** Obtains the total count of items that will be returned by the load() function. */ - totalCount(obj?: { - filter?: Object; - select?: Object; - group?: Object; - sort?: Object; - }): JQueryPromise; - /** Updates the data item specified by the key. */ - update(key: any, values: Object): JQueryPromise; - on(eventName: "removing", eventHandler: (key: any) => void): Store; - on(eventName: "removed", eventHandler: (key: any) => void): Store; - on(eventName: "updating", eventHandler: (key: any, values: Object) => void): Store; - on(eventName: "updated", eventHandler: (key: any, values: Object) => void): Store; - on(eventName: "inserting", eventHandler: (values: Object) => void): Store; - on(eventName: "inserted", eventHandler: (values: Object, key: any) => void): Store; - on(eventName: "modifying", eventHandler: () => void): Store; - on(eventName: "modified", eventHandler: () => void): Store; - on(eventName: "loading", eventHandler: (loadOptions: LoadOptions) => void): Store; - on(eventName: "loaded", eventHandler: (result: Array) => void): Store; - on(eventName: string, eventHandler: Function): Store; - on(events: { [eventName: string]: Function; }): Store; - off(eventName: "removing"): Store; - off(eventName: "removed"): Store; - off(eventName: "updating"): Store; - off(eventName: "updated"): Store; - off(eventName: "inserting"): Store; - off(eventName: "inserted"): Store; - off(eventName: "modifying"): Store; - off(eventName: "modified"): Store; - off(eventName: "loading"): Store; - off(eventName: "loaded"): Store; - off(eventName: string): Store; - off(eventName: "removing", eventHandler: (key: any) => void): Store; - off(eventName: "removed", eventHandler: (key: any) => void): Store; - off(eventName: "updating", eventHandler: (key: any, values: Object) => void): Store; - off(eventName: "updated", eventHandler: (key: any, values: Object) => void): Store; - off(eventName: "inserting", eventHandler: (values: Object) => void): Store; - off(eventName: "inserted", eventHandler: (values: Object, key: any) => void): Store; - off(eventName: "modifying", eventHandler: () => void): Store; - off(eventName: "modified", eventHandler: () => void): Store; - off(eventName: "loading", eventHandler: (loadOptions: LoadOptions) => void): Store; - off(eventName: "loaded", eventHandler: (result: Array) => void): Store; - off(eventName: string, eventHandler: Function): Store; - } - export interface ArrayStoreOptions extends StoreOptions { - /** Specifies the array associated with this Store. */ - data?: Array; - } - /** A Store accessing an in-memory array. */ - export class ArrayStore extends Store { - constructor(options?: ArrayStoreOptions); - /** Clears all data associated with the current ArrayStore. */ - clear(): void; - /** Creates the Query object for the underlying array. */ - createQuery(): Query; - } - interface Promise { - then(doneFn?: Function, failFn?: Function, progressFn?: Function): Promise; - } - export interface CustomStoreOptions extends StoreOptions { - /** The user implementation of the byKey(key, extraOptions) method. */ - byKey?: (key: any) => Promise; - /** The user implementation of the insert(values) method. */ - insert?: (values: Object) => Promise; - /** The user implementation of the load(options) method. */ - load?: (options?: LoadOptions) => Promise; - /** The user implementation of the remove(key) method. */ - remove?: (key: any) => Promise; - /** The user implementation of the totalCount(options) method. */ - totalCount?: () => Promise; - /** The user implementation of the update(key, values) method. */ - update?: (key: any, values: Object) => Promise; - } - /** A Store object that enables you to implement your own data access logic. */ - export class CustomStore extends Store { - constructor(options: CustomStoreOptions); - } - export interface DataSourceOptions { - /** Specifies data filtering conditions. */ - filter?: Object; - /** Specifies data grouping conditions. */ - group?: Object; - /** The item mapping function. */ - map?: (record: any) => any; - /** Specifies the maximum number of items the page can contain. */ - pageSize?: number; - /** Specifies whether a DataSource loads data by pages, or all items at once. */ - paginate?: boolean; - /** The data post processing function. */ - postProcess?: (data: any[]) => any[]; - /** Specifies a value by which the required items are searched. */ - searchExpr?: Object; - /** Specifies the comparison operation used to search for the required items. */ - searchOperation?: string; - /** Specifies the value to which the search expression is compared. */ - searchValue?: Object; - /** Specifies the initial select option value. */ - select?: Object; - /** An array of the strings that represent the names of the navigation properties to be loaded simultaneously with the OData store's entity. */ - expand?: Object; - /** Specifies the initial sort option value. */ - sort?: Object; - /** Specifies the underlying Store instance used to access data. */ - store?: any; - /** A handler for the changed event. */ - onChanged?: () => void; - /** A handler for the loadingChanged event. */ - onLoadingChanged?: (isLoading: boolean) => void; - /** A handler for the loadError event. */ - onLoadError?: (e?: Error) => void; - } - /** An object that provides access to a data web service or local data storage for collection container widgets. */ - export class DataSource implements EventsMixin { - constructor(options?: DataSourceOptions); - changed: JQueryCallback; - loadError: JQueryCallback; - loadingChanged: JQueryCallback; - /** Disposes all resources associated with this DataSource. */ - dispose(): void; - /** Returns the current filter option value. */ - filter(): Object; - /** Sets the filter option value. */ - filter(filterExpr: Object): void; - /** Returns the current group option value. */ - group(): Object; - /** Sets the group option value. */ - group(groupExpr: Object): void; - /** Indicates whether or not the current page contains fewer items than the number of items specified by the pageSize configuration option. */ - isLastPage(): boolean; - /** Indicates whether or not at least one load() method execution has successfully finished. */ - isLoaded(): boolean; - /** Indicates whether or not the DataSource is currently being loaded. */ - isLoading(): boolean; - /** Returns the array of items currently operated by the DataSource. */ - items(): Array; - /** Returns the key expression. */ - key(): any; - /** Starts loading data. */ - load(): JQueryPromise>; - /** Returns an object that would be passed to the load() method of the underlying Store according to the current data shaping option values of the current DataSource instance. */ - loadOptions(): Object; - /** Returns the current pageSize option value. */ - pageSize(): number; - /** Sets the pageSize option value. */ - pageSize(value: number): void; - /** Specifies the index of the currently loaded page. */ - pageIndex(): number; - /** Specifies the index of the page to be loaded during the next load() method execution. */ - pageIndex(newIndex: number): void; - /** Returns the current paginate option value. */ - paginate(): boolean; - /** Sets the paginate option value. */ - paginate(value: boolean): void; - /** Returns the searchExpr option value. */ - searchExpr(): Object; - /** Sets the searchExpr option value. */ - searchExpr(expr: Object): void; - /** Returns the currently specified search operation. */ - searchOperation(): string; - /** Sets the current search operation. */ - searchOperation(op: string): void; - /** Returns the searchValue option value. */ - searchValue(): Object; - /** Sets the searchValue option value. */ - searchValue(value: Object): void; - /** Returns the current select option value. */ - select(): Object; - /** Sets the select option value. */ - select(expr: Object): void; - /** Returns the current sort option value. */ - sort(): Object; - /** Sets the sort option value. */ - sort(sortExpr: Object): void; - /** Returns the underlying Store instance. */ - store(): Store; - /** Returns the number of data items available in an underlying Store after the last load() operation without paging. */ - totalCount(): number; - on(eventName: "loadingChanged", eventHandler: (isLoading: boolean) => void): DataSource; - on(eventName: "loadError", eventHandler: (e?: Error) => void): DataSource; - on(eventName: "changed", eventHandler: () => void): DataSource; - on(eventName: string, eventHandler: Function): DataSource; - on(events: { [eventName: string]: Function; }): DataSource; - off(eventName: "loadingChanged"): DataSource; - off(eventName: "loadError"): DataSource; - off(eventName: "changed"): DataSource; - off(eventName: string): DataSource; - off(eventName: "loadingChanged", eventHandler: (isLoading: boolean) => void): DataSource; - off(eventName: "loadError", eventHandler: (e?: Error) => void): DataSource; - off(eventName: "changed", eventHandler: () => void): DataSource; - off(eventName: string, eventHandler: Function): DataSource; - } - /** An object used to work with primitive data types not supported by JavaScript when accessing an OData web service. */ - export class EdmLiteral { - /** Creates an EdmLiteral instance and assigns the specified value to it. */ - constructor(value: string); - /** Returns a string representation of the value associated with this EdmLiteral object. */ - valueOf(): string; - } - /** An object used to generate and hold the GUID. */ - export class Guid { - /** Creates a new Guid instance that holds the specified GUID. */ - constructor(value: string); - /** Creates a new Guid instance holding the generated GUID. */ - constructor(); - /** Returns a string representation of the Guid instance. */ - toString(): string; - /** Returns a string representation of the Guid instance. */ - valueOf(): string; - } - export interface LocalStoreOptions extends ArrayStoreOptions { - /** Specifies the time (in miliseconds) after the change operation, before the data is flushed. */ - flushInterval?: number; - /** Specifies whether the data is flushed immediatelly after each change operation, or after the delay specified via the flushInterval option. */ - immediate?: boolean; - /** The unique identifier used to distinguish the data within the HTML5 Web Storage. */ - name?: string; - } - /** A Store providing access to the HTML5 Web Storage. */ - export class LocalStore extends ArrayStore { - constructor(options?: LocalStoreOptions); - /** Removes all data associated with this Store. */ - clear(): void; - } - export interface ODataContextOptions extends ODataStoreOptions { - /** Specifies the list of entities to be accessed via the ODataContext. */ - entities?: Object; - /** Specifies the function called if the ODataContext causes an error. */ - errorHandler?: (e: Error) => void; - } - /** Provides access to the entire OData service. */ - export class ODataContext { - constructor(options?: ODataContextOptions); - /** Initiates the specified WebGet service operation that returns a value. For the information on service operations, refer to the OData documentation. */ - get(operationName: string, params: Object): JQueryPromise; - /** Initiates the specified WebGet service operation that returns nothing. For the information on service operations, refer to the OData documentation. */ - invoke(operationName: string, params: Object, httpMethod: Object): JQueryPromise; - /** Return a special proxy object to describe the entity link. */ - objectLink(entityAlias: string, key: any): Object; - } - export interface ODataStoreOptions extends StoreOptions { - /** A function used to customize a web request before it is sent. */ - beforeSend?: (request: { - url: string; - method: string; - timeout: number; - params: Object; - payload: Object; - headers: Object; - }) => void; - /** Specifies whether the ODataStore uses the JSONP approach to access non-CORS-compatible remote services. */ - jsonp?: boolean; - /** Specifies the type of the ODataStore key property. The following key types are supported out of the box: String, Int32, Int64, and Guid. */ - keyType?: any; - /** Specifies the URL of the data service being accessed via the current ODataContext. */ - url?: string; - /** Specifies the version of the OData protocol used to interact with the data service. */ - version?: number; - /** Specifies the value of the withCredentials field of the underlying jqXHR object. */ - withCredentials?: boolean; - } - /** A Store providing access to a separate OData web service entity. */ - export class ODataStore extends Store { - constructor(options?: ODataStoreOptions); - /** Creates the Query object for the OData endpoint. */ - createQuery(loadOptions: Object): Object; - /** Returns the data item specified by the key. */ - byKey(key: any, extraOptions?: { expand?: Object }): JQueryPromise; - } - /** An universal chainable data query interface object. */ - export interface Query { - /** Calculates a custom summary for the items in the current Query. */ - aggregate(step: (accumulator: any, value: any) => any): JQueryPromise; - /** Calculates a custom summary for the items in the current Query. */ - aggregate(seed: any, step: (accumulator: any, value: any) => any, finalize: (result: any) => any): JQueryPromise; - /** Calculates the average item value for the current Query. */ - avg(getter: Object): JQueryPromise; - /** Finds the item with the maximum getter value. */ - max(getter: Object): JQueryPromise; - /** Finds the item with the maximum value in the Query. */ - max(): JQueryPromise; - /** Finds the item with the minimum value in the Query. */ - min(): JQueryPromise; - /** Finds the item with the minimum getter value. */ - min(getter: Object): JQueryPromise; - /** Calculates the average item value for the current Query, if each Query item has a numeric type. */ - avg(): JQueryPromise; - /** Returns the total count of items in the current Query. */ - count(): JQueryPromise; - /** Executes the Query. */ - enumerate(): JQueryPromise; - /** Filters the current Query data. */ - filter(criteria: Array): Query; - /** Groups the current Query data. */ - groupBy(getter: Object): Query; - /** Applies the specified transformation to each item. */ - select(getter: Object): Query; - /** Limits the data item count. */ - slice(skip: number, take?: number): Query; - /** Sorts current Query data. */ - sortBy(getter: Object, desc: boolean): Query; - /** Sorts current Query data. */ - sortBy(getter: Object): Query; - /** Calculates the sum of item getter values in the current Query. */ - sum(getter: Object): JQueryPromise; - /** Calculates the sum of item values in the current Query. */ - sum(): JQueryPromise; - /** Adds one more sorting condition to the current Query. */ - thenBy(getter: Object): Query; - /** Adds one more sorting condition to the current Query. */ - thenBy(getter: Object, desc: boolean): Query; - /** Returns the array of current Query items. */ - toArray(): Array; - } - /** The global data layer error handler. */ - export var errorHandler: (e: Error) => void; - /** Encodes the specified string or array of bytes to base64 encoding. */ - export function base64_encode(input: any): string; - /** Creates a Query instance. */ - export function query(array: Array): Query; - /** Creates a Query instance for accessing the remote service specified by a URL. */ - export function query(url: string, queryOptions: Object): Query; - /** This section describes the utility objects provided by the DevExtreme data layer. */ - export var utils: { - /** Compiles a getter function from the getter expression. */ - compileGetter(expr: any): Function; - /** Compiles a setter function from the setter expression. */ - compileSetter(expr: any): Function; - odata: { - /** Holds key value converters for OData. */ - keyConverters: { - String(value: any): string; - Int32(value: any): number; - Int64(value: any): EdmLiteral; - Guid(value: any): Guid; - Boolean(value: any): boolean; - Single(value: any): EdmLiteral; - Decimal(value: any): EdmLiteral; - }; - } - } - } - /** An object that serves as a namespace for DevExtreme UI widgets as well as for methods implementing UI logic in DevExtreme sites/applications. */ - export module ui { - export interface WidgetOptions extends DOMComponentOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A Boolean value specifying whether or not the widget can respond to user interaction. */ - disabled?: boolean; - /** A Boolean value specifying whether or not the widget changes its state when being hovered by an end user. */ - hoverStateEnabled?: boolean; - /** Specifies whether or not the widget can be focused. */ - focusStateEnabled?: boolean; - /** Specifies a shortcut key that sets focus on the widget element. */ - accessKey?: string; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - /** Specifies the widget tab index. */ - tabIndex?: number; - /** Specifies the text of the hint displayed for the widget. */ - hint?: string; - } - /** The base class for widgets. */ - export class Widget extends DOMComponent { - constructor(options?: WidgetOptions); - /** Redraws the widget. */ - repaint(): void; - /** Sets focus on the widget. */ - focus(): void; - /** Registers a handler for pressing of the specified key. */ - registerKeyHandler(key: string, handler: Function): void; - } - export interface CollectionWidgetOptions extends WidgetOptions { - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - itemClickAction?: any; - itemHoldAction?: Function; - /** The time period in milliseconds before the onItemHold event is raised. */ - itemHoldTimeout?: number; - itemRender?: any; - itemRenderedAction?: Function; - /** An array of items displayed by the widget. */ - items?: Array; - /** - * A function performed when a widget item is selected. - * @deprecated onSelectionChanged.md - */ - itemSelectAction?: Function; - /** The template to be used for rendering items. */ - itemTemplate?: any; - loopItemFocus?: boolean; - /** The text or HTML markup displayed by the widget if the item collection is empty. */ - noDataText?: string; - onContentReady?: any; - contentReadyAction?: any; - /** A handler for the itemClick event. */ - onItemClick?: any; - /** A handler for the itemContextMenu event. */ - onItemContextMenu?: Function; - /** A handler for the itemHold event. */ - onItemHold?: Function; - /** A handler for the itemRendered event. */ - onItemRendered?: Function; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: Function; - /** The index of the currently selected widget item. */ - selectedIndex?: number; - /** The selected item object. */ - selectedItem?: Object; - /** An array of currently selected item objects. */ - selectedItems?: Array; - /** A handler for the itemDeleting event. */ - onItemDeleting?: Function; - /** A handler for the itemDeleted event. */ - onItemDeleted?: Function; - /** A handler for the itemReordered event. */ - onItemReordered?: Function; - } - /** The base class for widgets containing an item collection. */ - export class CollectionWidget extends Widget { - constructor(element: JQuery, options?: CollectionWidgetOptions); - constructor(element: HTMLElement, options?: CollectionWidgetOptions); - selectItem(itemElement: any): void; - unselectItem(itemElement: any): void; - deleteItem(itemElement: any): JQueryPromise; - isItemSelected(itemElement: any): boolean; - reorderItem(itemElement: any, toItemElement: any): JQueryPromise; - } - export interface DataExpressionMixinOptions { - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** Specifies the name of the data source item field whose value is displayed by the widget. */ - displayExpr?: any; - /** Specifies the name of a data source item field whose value is held in the value configuration option. */ - valueExpr?: any; - itemRender?: any; - /** An array of items displayed by the widget. */ - items?: Array; - /** The template to be used for rendering items. */ - itemTemplate?: any; - /** The currently selected value in the widget. */ - value?: Object; - } - export interface EditorOptions extends WidgetOptions { - /** The currently specified value. */ - value?: Object; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - valueChangeAction?: Function; - /** A Boolean value specifying whether or not the widget is read-only. */ - readOnly?: boolean; - /** Holds the object that defines the error that occurred during validation. */ - validationError?: Object; - /** Specifies whether the editor's value is valid. */ - isValid?: boolean; - /** Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed. */ - validationMessageMode?: string; - } - /** A base class for editors. */ - export class Editor extends Widget { - /** Resets the editor's value to undefined. */ - reset(): void; - } - /** An object that serves as a namespace for methods displaying a message in an application/site. */ - export var dialog: { - /** Creates an alert dialog message containing a single "OK" button. */ - alert(message: string, title: string): JQueryPromise; - /** Creates a confirm dialog that contains "Yes" and "No" buttons. */ - confirm(message: string, title: string): JQueryPromise; - /** Creates a custom dialog using the options specified by the passed configuration object. */ - custom(options: { title?: string; message?: string; buttons?: Array; }): { - show(): JQueryPromise; - hide(): void; - hide(value: any): void; - }; - }; - /** Creates a toast message. */ - export function notify(message: any, type: string, displayTime: number): void; - /** Creates a toast message. */ - export function notify(options: Object): void; - /** An object that serves as a namespace for the methods that work with DevExtreme CSS Themes. */ - export var themes: { - /** Returns the name of the currently applied theme. */ - current(): string; - /** Changes the current theme to the specified one. */ - current(themeName: string): void; - }; - /** Sets a specified template engine. */ - export function setTemplateEngine(name: string): void; - /** Sets a custom template engine defined via custom compile and render functions. */ - export function setTemplateEngine(options: Object): void; - /** An object that serves as a namespace for utility methods that can be helpful when working with the DevExtreme framework and UI widgets. */ - export var utils: { - /** Sets parameters for the viewport meta tag. */ - initMobileViewport(options: { allowZoom?: boolean; allowPan?: boolean; allowSelection?: boolean }): void; - }; - } -} -declare namespace DevExpress.ui { - export interface dxValidatorOptions extends DOMComponentOptions { - /** An array of validation rules to be checked for the editor with which the dxValidator object is associated. */ - validationRules?: Array; - /** Specifies the editor name to be used in the validation default messages. */ - name?: string; - /** An object that specifies what and when to validate and how to apply the validation result. */ - adapter?: Object; - /** Specifies the validation group the editor will be related to. */ - validationGroup?: string; - /** A handler for the validated event. */ - onValidated?: (params: validationEngine.ValidatorValidationResult) => void; - } - /** A widget that is used to validate the associated DevExtreme editors against the defined validation rules. */ - export class dxValidator extends DOMComponent implements validationEngine.IValidator { - constructor(element: JQuery, options?: dxValidatorOptions); - constructor(element: Element, options?: dxValidatorOptions); - /** Validates the value of the editor that is controlled by the current dxValidator object against the list of the specified validation rules. */ - validate(): validationEngine.ValidatorValidationResult; - /** Resets the value and validation result of the editor associated with the current dxValidator object. */ - reset(): void; - } - /** The widget that is used in the Knockout and Angular approaches to combine the editors to be validated. */ - export class dxValidationGroup extends DOMComponent { - constructor(element: JQuery); - constructor(element: Element); - /** Validates rules of the validators that belong to the current validation group. */ - validate(): validationEngine.ValidationGroupValidationResult; - /** Resets the value and validation result of the editors that are included to the current validation group. */ - reset(): void; - } - export interface dxValidationSummaryOptions extends CollectionWidgetOptions { - /** Specifies the validation group for which summary should be generated. */ - validationGroup?: string; - } - /** A widget for displaying the result of checking validation rules for editors. */ - export class dxValidationSummary extends CollectionWidget { - constructor(element: JQuery, options?: dxValidationSummaryOptions); - constructor(element: Element, options?: dxValidationSummaryOptions); - } - export interface dxResizableOptions extends DOMComponentOptions { - /** Specifies which borders of the widget element are used as a handle. */ - handles?: string; - /** Specifies the lower width boundary for resizing. */ - minWidth?: number; - /** Specifies the upper width boundary for resizing. */ - maxWidth?: number; - /** Specifies the lower height boundary for resizing. */ - minHeight?: number; - /** Specifies the upper height boundary for resizing. */ - maxHeight?: number; - /** A handler for the resizeStart event. */ - onResizeStart?: Function; - /** A handler for the resize event. */ - onResize?: Function; - /** A handler for the resizeEnd event. */ - onResizeEnd?: Function; - } - /** A widget that displays required content in a resizable element. */ - export class dxResizable extends DOMComponent { - constructor(element: JQuery, options?: dxResizableOptions); - constructor(element: Element, options?: dxResizableOptions); - } - export interface dxTooltipOptions extends dxPopoverOptions { - } - /** A tooltip widget. */ - export class dxTooltip extends dxPopover { - constructor(element: JQuery, options?: dxTooltipOptions); - constructor(element: Element, options?: dxTooltipOptions); - } - export interface dxDropDownListOptions extends dxDropDownEditorOptions { - /** Returns the value currently displayed by the widget. */ - displayValue?: string; - /** The minimum number of characters that must be entered into the text box to begin a search. */ - minSearchLength?: number; - /** Specifies the name of a data source item field or an expression whose value is compared to the search criterion. */ - searchExpr?: Object; - /** Specifies the binary operation used to filter data. */ - searchMode?: string; - /** Specifies the time delay, in milliseconds, after the last character has been typed in, before a search is executed. */ - searchTimeout?: number; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - /** Specifies DOM event names that update a widget's value. */ - valueChangeEvent?: string; - /** Specifies whether or not the widget supports searching. */ - searchEnabled?: boolean; - /** - * Specifies whether or not the widget displays items by pages. - * @deprecated dataSource.paginate.md - */ - pagingEnabled?: boolean; - /** The text or HTML markup displayed by the widget if the item collection is empty. */ - noDataText?: string; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: Function; - /** A handler for the itemClick event. */ - onItemClick?: Function; - onContentReady?: Function; - } - /** A base class for drop-down list widgets. */ - export class dxDropDownList extends dxDropDownEditor { - constructor(element: JQuery, options?: dxDropDownListOptions); - constructor(element: Element, options?: dxDropDownListOptions); - } - export interface dxToolbarOptions extends CollectionWidgetOptions { - menuItemRender?: any; - /** The template used to render menu items. */ - menuItemTemplate?: any; - /** Informs the widget about its location in a view HTML markup. */ - renderAs?: string; - } - /** A toolbar widget. */ - export class dxToolbar extends CollectionWidget { - constructor(element: JQuery, options?: dxToolbarOptions); - constructor(element: Element, options?: dxToolbarOptions); - } - export interface dxToastOptions extends dxOverlayOptions { - animation?: fx.AnimationOptions; - /** The time span in milliseconds during which the dxToast widget is visible. */ - displayTime?: number; - height?: any; - /** The dxToast message text. */ - message?: string; - position?: PositionOptions; - shading?: boolean; - /** Specifies the dxToast widget type. */ - type?: string; - width?: any; - closeOnBackButton?: boolean; - } - /** The toast message widget. */ - export class dxToast extends dxOverlay { - constructor(element: JQuery, options?: dxToastOptions); - constructor(element: Element, options?: dxToastOptions); - } - export interface dxTextEditorOptions extends EditorOptions { - /** A handler for the change event. */ - onChange?: Function; - changeAction?: Function; - /** A handler for the copy event. */ - onCopy?: Function; - copyAction?: Function; - /** A handler for the cut event. */ - onCut?: Function; - cutAction?: Function; - /** A handler for the enterKey event. */ - onEnterKey?: Function; - enterKeyAction?: Function; - /** A handler for the focusIn event. */ - onFocusIn?: Function; - focusInAction?: Function; - /** A handler for the focusOut event. */ - onFocusOut?: Function; - focusOutAction?: Function; - /** A handler for the input event. */ - onInput?: Function; - inputAction?: Function; - /** A handler for the keyDown event. */ - onKeyDown?: Function; - keyDownAction?: Function; - /** A handler for the keyPress event. */ - onKeyPress?: Function; - keyPressAction?: Function; - /** A handler for the keyUp event. */ - onKeyUp?: Function; - keyUpAction?: Function; - /** A handler for the paste event. */ - onPaste?: Function; - pasteAction?: Function; - /** The text displayed by the widget when the widget value is empty. */ - placeholder?: string; - /** Specifies whether to display the Clear button in the widget. */ - showClearButton?: boolean; - /** Specifies the current value displayed by the widget. */ - value?: any; - /** Specifies DOM event names that update a widget's value. */ - valueChangeEvent?: string; - /** Specifies whether or not the widget checks the inner text for spelling mistakes. */ - spellcheck?: boolean; - /** Specifies HTML attributes applied to the inner input element of the widget. */ - attr?: Object; - /** The read-only option that holds the text displayed by the widget input element. */ - text?: string; - /** Specifies whether or not the widget supports the focused state and keyboard navigation. */ - focusStateEnabled?: boolean; - /** A Boolean value specifying whether or not the widget changes its state when being hovered by an end user. */ - hoverStateEnabled?: boolean; - /** The editor mask, which specifies the format of the entered string. */ - mask?: string; - /** Specifies a mask placeholder character. */ - maskChar?: string; - /** Specifies custom mask rules. */ - maskRules?: Object; - /** A message displayed when the entered text does not match the specified pattern. */ - maskInvalidMessage?: string; - } - /** A base class for text editing widgets. */ - export class dxTextEditor extends Editor { - constructor(element: JQuery, options?: dxTextEditorOptions); - constructor(element: Element, options?: dxTextEditorOptions); - /** Removes focus from the input element. */ - blur(): void; - /** Sets focus to the input element representing the widget. */ - focus(): void; - } - export interface dxTextBoxOptions extends dxTextEditorOptions { - /** Specifies the maximum number of characters you can enter into the textbox. */ - maxLength?: any; - /** The "mode" attribute value of the actual HTML input element representing the text box. */ - mode?: string; - } - /** A single-line text box widget. */ - export class dxTextBox extends dxTextEditor { - constructor(element: JQuery, options?: dxTextBoxOptions); - constructor(element: Element, options?: dxTextBoxOptions); - } - export interface dxTextAreaOptions extends dxTextBoxOptions { - /** Specifies whether or not the widget checks the inner text for spelling mistakes. */ - spellcheck?: boolean; - } - /** A widget used to display and edit multi-line text. */ - export class dxTextArea extends dxTextBox { - constructor(element: JQuery, options?: dxTextAreaOptions); - constructor(element: Element, options?: dxTextAreaOptions); - } - export interface dxTabsOptions extends CollectionWidgetOptions { - /** Specifies whether the widget enables an end-user to select only a single item or multiple items. */ - selectionMode?: string; - /** Specifies whether or not an end-user can scroll tabs by swiping. */ - scrollByContent?: boolean; - /** Specifies whether or not an end-user can scroll tabs. */ - scrollingEnabled?: boolean; - /** A Boolean value that specifies the availability of navigation buttons. */ - showNavButtons?: boolean; - } - /** A tab strip used to switch between pages. */ - export class dxTabs extends CollectionWidget { - constructor(element: JQuery, options?: dxTabsOptions); - constructor(element: Element, options?: dxTabsOptions); - } - export interface dxTabPanelOptions extends dxMultiViewOptions { - /** A handler for the titleClick event. */ - onTitleClick?: any; - /** A handler for the titleHold event. */ - onTitleHold?: Function; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - titleTemplate?: any; - /** The template to be used for rendering an item title. */ - itemTitleTemplate?: any; - } - /** A widget used to display a view and to switch between several views by clicking the appropriate tabs. */ - export class dxTabPanel extends dxMultiView { - constructor(element: JQuery, options?: dxTabPanelOptions); - constructor(element: Element, options?: dxTabPanelOptions); - } - export interface dxSelectBoxOptions extends dxDropDownListOptions { - /** The template to be used for rendering the widget text field. */ - fieldTemplate?: any; - /** The text that is provided as a hint in the select box editor. */ - placeholder?: string; - /** Specifies whether or not the widget allows an end-user to enter a custom value. */ - fieldEditEnabled?: boolean; - } - /** A widget that allows you to select an item in a dropdown list. */ - export class dxSelectBox extends dxDropDownList { - constructor(element: JQuery, options?: dxSelectBoxOptions); - constructor(element: Element, options?: dxSelectBoxOptions); - } - export interface dxTagBoxOptions extends dxSelectBoxOptions { - /** Holds the list of selected values. */ - values?: Array; - } - /** A widget that allows you to select multiple items from a dropdown list. */ - export class dxTagBox extends dxSelectBox { - constructor(element: JQuery, options?: dxTagBoxOptions); - constructor(element: Element, options?: dxTagBoxOptions); - } - export interface dxScrollViewOptions extends dxScrollableOptions { - /** A handler for the pullDown event. */ - onPullDown?: Function; - pullDownAction?: Function; - /** Specifies the text shown in the pullDown panel when pulling the content down lowers the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while pulling the content down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the reachBottom event. */ - onReachBottom?: Function; - reachBottomAction?: Function; - /** Specifies the text shown in the pullDown panel displayed when content is scrolled to the bottom. */ - reachBottomText?: string; - /** Specifies the text shown in the pullDown panel displayed when the content is being refreshed. */ - refreshingText?: string; - /** Returns a value indicating if the scrollView content is larger then the widget container. */ - isFull(): boolean; - /** Locks the widget until the release(preventScrollBottom) method is called and executes the function passed to the onPullDown option and the handler assigned to the pullDown event. */ - refresh(): void; - /** Notifies the scroll view that data loading is finished. */ - release(preventScrollBottom: boolean): JQueryPromise; - /** Toggles the loading state of the widget. */ - toggleLoading(showOrHide: boolean): void; - } - /** A widget used to display scrollable content. */ - export class dxScrollView extends dxScrollable { - constructor(element: JQuery, options?: dxScrollViewOptions); - constructor(element: Element, options?: dxScrollViewOptions); - } - export interface dxScrollableLocation { - top?: number; - left?: number; - } - export interface dxScrollableOptions extends DOMComponentOptions { - /** A string value specifying the available scrolling directions. */ - direction?: string; - /** A Boolean value specifying whether or not the widget can respond to user interaction. */ - disabled?: boolean; - /** A handler for the scroll event. */ - onScroll?: Function; - scrollAction?: Function; - /** Specifies when the widget shows the scrollbar. */ - showScrollbar?: string; - /** A handler for the update event. */ - onUpdated?: Function; - updateAction?: Function; - /** Indicates whether to use native or simulated scrolling. */ - useNative?: boolean; - /** A Boolean value specifying whether to enable or disable the bounce-back effect. */ - bounceEnabled?: boolean; - /** A Boolean value specifying whether or not an end-user can scroll the widget content swiping it up or down. */ - scrollByContent?: boolean; - /** A Boolean value specifying whether or not an end-user can scroll the widget content using the scrollbar. */ - scrollByThumb?: boolean; - } - /** A widget used to display scrollable content. */ - export class dxScrollable extends DOMComponent { - constructor(element: JQuery, options?: dxScrollableOptions); - constructor(element: Element, options?: dxScrollableOptions); - /** Returns the height of the scrollable widget in pixels. */ - clientHeight(): number; - /** Returns the width of the scrollable widget in pixels. */ - clientWidth(): number; - /** Returns an HTML element of the widget. */ - content(): JQuery; - /** Scrolls the widget content by the specified number of pixels. */ - scrollBy(distance: number): void; - /** Scrolls widget content by the specified number of pixels in horizontal and vertical directions. */ - scrollBy(distanceObject: dxScrollableLocation): void; - /** Returns the height of the scrollable content in pixels. */ - scrollHeight(): number; - /** Returns the current scroll position against the leftmost position. */ - scrollLeft(): number; - /** Returns how far the scrollable content is scrolled from the top and from the left. */ - scrollOffset(): dxScrollableLocation; - /** Scrolls widget content to the specified position. */ - scrollTo(targetLocation: number): void; - /** Scrolls widget content to a specified position. */ - scrollTo(targetLocation: dxScrollableLocation): void; - /** Scrolls widget content to the specified element. */ - scrollToElement(element: Element): void; - /** Returns the current scroll position against the topmost position. */ - scrollTop(): number; - /** Returns the width of the scrollable content in pixels. */ - scrollWidth(): number; - /** Updates the dimensions of the scrollable contents. */ - update(): void; - } - export interface dxRadioGroupOptions extends CollectionWidgetOptions { - /** Specifies the radio group layout. */ - layout?: string; - } - /** A widget that enables a user to select one item within a list of items represented by radio buttons. */ - export class dxRadioGroup extends CollectionWidget { - constructor(element: JQuery, options?: dxRadioGroupOptions); - constructor(element: Element, options?: dxRadioGroupOptions); - } - export interface dxPopupOptions extends dxOverlayOptions { - animation?: fx.AnimationOptions; - /** Specifies whether or not to allow a user to drag the popup window. */ - dragEnabled?: boolean; - /** A Boolean value specifying whether or not to display the widget in full-screen mode. */ - fullScreen?: boolean; - position?: PositionOptions; - /** A Boolean value specifying whether or not to display the title in the popup window. */ - showTitle?: boolean; - /** The title in the overlay window. */ - title?: string; - /** A template to be used for rendering the widget title. */ - titleTemplate?: any; - width?: any; - /** Specifies items displayed on the top or bottom toolbar of the popup window. */ - buttons?: Array; - /** Specifies whether or not the widget displays the Close button. */ - showCloseButton?: boolean; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - } - /** A widget that displays required content in a popup window. */ - export class dxPopup extends dxOverlay { - constructor(element: JQuery, options?: dxPopupOptions); - constructor(element: Element, options?: dxPopupOptions); - } - export interface dxPopoverOptions extends dxPopupOptions { - /** An object defining animation options of the widget. */ - animation?: fx.AnimationOptions; - /** Specifies the height of the widget. */ - height?: any; - /** An object defining widget positioning options. */ - position?: PositionOptions; - shading?: boolean; - /** A Boolean value specifying whether or not to display the title in the overlay window. */ - showTitle?: boolean; - /** The target element associated with a popover. */ - target?: any; - /** Specifies the width of the widget. */ - width?: any; - } - /** A widget that displays the required content in a popup window. */ - export class dxPopover extends dxPopup { - constructor(element: JQuery, options?: dxPopoverOptions); - constructor(element: Element, options?: dxPopoverOptions); - /** Displays the widget for the specified target element. */ - show(target?: any): JQueryPromise; - } - export interface dxOverlayOptions extends WidgetOptions { - /** An object that defines the animation options of the widget. */ - animation?: fx.AnimationOptions; - /** A Boolean value specifying whether or not the widget is closed if a user presses the Back hardware button. */ - closeOnBackButton?: boolean; - /** A Boolean value specifying whether or not the widget is closed if a user clicks outside of the overlapping window. */ - closeOnOutsideClick?: any; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - /** Specifies whether or not an end-user can drag the widget. */ - dragEnabled?: boolean; - /** Specifies whether or not an end user can resize the widget. */ - resizeEnabled?: boolean; - /** The height of the widget in pixels. */ - height?: any; - /** A handler for the hidden event. */ - onHidden?: Function; - hiddenAction?: Function; - /** A handler for the hiding event. */ - onHiding?: Function; - hidingAction?: Function; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** A Boolean value specifying whether or not the main screen is inactive while the widget is active. */ - shading?: boolean; - /** Specifies the shading color. */ - shadingColor?: string; - /** A handler for the showing event. */ - onShowing?: Function; - showingAction?: Function; - /** A handler for the shown event. */ - onShown?: Function; - shownAction?: Function; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - /** The widget width in pixels. */ - width?: any; - } - /** A widget displaying the required content in an overlay window. */ - export class dxOverlay extends Widget { - constructor(element: JQuery, options?: dxOverlayOptions); - constructor(element: Element, options?: dxOverlayOptions); - /** An HTML element of the widget. */ - content(): JQuery; - /** Hides the widget. */ - hide(): JQueryPromise; - /** Recalculates the overlay's size and position. */ - repaint(): void; - /** Shows the widget. */ - show(): JQueryPromise; - /** Toggles the visibility of the widget. */ - toggle(showing: boolean): JQueryPromise; - /** A static method that specifies the base z-index for all overlay widgets. */ - static baseZIndex(zIndex: number): void; - } - export interface dxNumberBoxOptions extends dxTextEditorOptions { - /** The maximum value accepted by the number box. */ - max?: number; - /** The minimum value accepted by the number box. */ - min?: number; - /** Specifies whether or not to show spin buttons. */ - showSpinButtons?: boolean; - useTouchSpinButtons?: boolean; - /** Specifies by which value the widget value changes when a spin button is clicked. */ - step?: number; - /** The current number box value. */ - value?: number; - } - /** A textbox widget that enables a user to enter numeric values. */ - export class dxNumberBox extends dxTextEditor { - constructor(element: JQuery, options?: dxNumberBoxOptions); - constructor(element: Element, options?: dxNumberBoxOptions); - } - export interface dxNavBarOptions extends dxTabsOptions { - scrollingEnabled?: boolean; - } - /** A widget that contains items used to navigate through application views. */ - export class dxNavBar extends dxTabs { - constructor(element: JQuery, options?: dxNavBarOptions); - constructor(element: Element, options?: dxNavBarOptions); - } - export interface dxMultiViewOptions extends CollectionWidgetOptions { - /** Specifies whether or not to animate the displayed item change. */ - animationEnabled?: boolean; - /** A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped. */ - loop?: boolean; - /** The index of the currently displayed item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to allow users to change the selected index by swiping. */ - swipeEnabled?: boolean; - } - /** A widget used to display a view and to switch between several views. */ - export class dxMultiView extends CollectionWidget { - constructor(element: JQuery, options?: dxMultiViewOptions); - constructor(element: Element, options?: dxMultiViewOptions); - } - export interface dxMapOptions extends WidgetOptions { - /** Specifies whether or not the widget automatically adjusts center and zoom option values when adding a new marker or route. */ - autoAdjust?: boolean; - bounds?: { - northEast?: { - lat?: number; - lng?: number; - }; - southWest?: { - lat?: number; - lng?: number; - }; - /** An object, a string, or an array specifying the location displayed at the center of the widget. */ - center?: { - /** The latitude location displayed in the center of the widget. */ - lat?: number; - /** The longitude location displayed in the center of the widget. */ - lng?: number; - }; - /** A handler for the click event. */ - onClick?: any; - clickAction?: any; - /** Specifies whether or not map widget controls are available. */ - controls?: boolean; - /** Specifies the height of the widget. */ - height?: number; - /** A key used to authenticate the application within the required map provider. */ - key?: { - /** A key used to authenticate the application within the "Bing" map provider. */ - bing?: string; - /** A key used to authenticate the application within the "Google" map provider. */ - google?: string; - /** A key used to authenticate the application within the "Google Static" map provider. */ - googleStatic?: string; - } - /** A handler for the markerAdded event. */ - onMarkerAdded?: Function; - markerAddedAction?: Function; - /** A URL pointing to the custom icon to be used for map markers. */ - markerIconSrc?: string; - /** A handler for the markerRemoved event. */ - onMarkerRemoved?: Function; - markerRemovedAction?: Function; - /** An array of markers displayed on a map. */ - markers?: Array; - /** The name of the current map data provider. */ - provider?: string; - /** A handler for the ready event. */ - onReady?: Function; - readyAction?: Function; - /** A handler for the routeAdded event. */ - onRouteAdded?: Function; - routeAddedAction?: Function; - /** A handler for the routeRemoved event. */ - onRouteRemoved?: Function; - routeRemovedAction?: Function; - /** An array of routes shown on the map. */ - routes?: Array; - /** The type of a map to display. */ - type?: string; - /** Specifies the width of the widget. */ - width?: number; - /** The zoom level of the map. */ - zoom?: number; - /** Adds a marker to the map. */ - addMarker(markerOptions: Object): JQueryPromise; - /** Adds a route to the map. */ - addRoute(options: Object): JQueryPromise; - /** Removes a marker from the map. */ - removeMarker(marker: Object): JQueryPromise; - /** Removes a route from the map. */ - removeRoute(route: any): JQueryPromise; - }; - } - /** An interactive map widget. */ - export class dxMap extends Widget { - constructor(element: JQuery, options?: dxMapOptions); - constructor(element: Element, options?: dxMapOptions); - } - export interface dxLookupOptions extends dxDropDownListOptions { - /** An object defining widget animation options. */ - animation?: fx.AnimationOptions; - /** The text displayed on the Cancel button. */ - cancelButtonText?: string; - /** The text displayed on the Clear button. */ - clearButtonText?: string; - /** Specifies whether or not the widget cleans the search box when the popup window is displayed. */ - cleanSearchOnOpening?: boolean; - /** A Boolean value specifying whether or not the widget is closed if a user clicks outside of the overlaying window. */ - closeOnOutsideClick?: any; - /** The text displayed on the Apply button. */ - applyButtonText?: string; - /** A Boolean value specifying whether or not to display the lookup in full-screen mode. */ - fullScreen?: boolean; - focusStateEnabled?: boolean; - /** A Boolean value specifying whether or not to group widget items. */ - grouped?: boolean; - groupRender?: any; - /** The name of the template used to display a group header. */ - groupTemplate?: any; - /** The text displayed on the button used to load the next page from the data source. */ - nextButtonText?: string; - /** A handler for the pageLoading event. */ - onPageLoading?: Function; - /** Specifies whether the next page is loaded when a user scrolls the widget to the bottom or when the "next" button is clicked. */ - pageLoadMode?: string; - pageLoadingAction?: Function; - /** Specifies the text shown in the pullDown panel, which is displayed when the widget is scrolled to the bottom. */ - pageLoadingText?: string; - /** The text displayed by the widget when nothing is selected. */ - placeholder?: string; - /** The height of the widget popup element. */ - popupHeight?: any; - /** The width of the widget popup element. */ - popupWidth?: any; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** Specifies the text displayed in the pullDown panel when the widget is pulled below the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the pullRefresh event. */ - onPullRefresh?: Function; - pullRefreshAction?: Function; - /** A Boolean value specifying whether or not the widget supports the "pull down to refresh" gesture. */ - pullRefreshEnabled?: boolean; - /** Specifies the text displayed in the pullDown panel while the widget is being refreshed. */ - refreshingText?: string; - /** A handler for the scroll event. */ - onScroll?: Function; - scrollAction?: Function; - /** A Boolean value specifying whether or not the search bar is visible. */ - searchEnabled?: boolean; - /** The text that is provided as a hint in the lookup's search bar. */ - searchPlaceholder?: string; - /** A Boolean value specifying whether or not the main screen is inactive while the lookup is active. */ - shading?: boolean; - /** Specifies whether to display the Cancel button in the lookup window. */ - showCancelButton?: boolean; - /** - * A Boolean value specifying whether the widget loads the next page automatically when you reach the bottom of the list or when a button is clicked. - * @deprecated pageLoadMode.md - */ - showNextButton?: boolean; - /** The title of the lookup window. */ - title?: string; - /** A template to be used for rendering the widget title. */ - titleTemplate?: any; - /** Specifies whether or not the widget uses native scrolling. */ - useNativeScrolling?: boolean; - /** Specifies whether or not to show lookup contents in a dxPopover widget. */ - usePopover?: boolean; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - contentReadyAction?: Function; - titleRender?: any; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - /** A Boolean value specifying whether or not to display the title in the popup window. */ - showPopupTitle?: boolean; - } - /** A widget that allows a user to select predefined values from a lookup window. */ - export class dxLookup extends dxDropDownList { - constructor(element: JQuery, options?: dxLookupOptions); - constructor(element: Element, options?: dxLookupOptions); - /** This section lists the data source fields that are used in a default template for lookup drop-down items. */ - } - export interface dxLoadPanelOptions extends dxOverlayOptions { - /** An object defining the animation options of the widget. */ - animation?: fx.AnimationOptions; - /** The delay in milliseconds after which the load panel is displayed. */ - delay?: number; - /** The height of the widget. */ - height?: number; - /** A URL pointing to an image to be used as a load indicator. */ - indicatorSrc?: string; - /** The text displayed in the load panel. */ - message?: string; - /** A Boolean value specifying whether or not to show a load indicator. */ - showIndicator?: boolean; - /** A Boolean value specifying whether or not to show the pane behind the load indicator. */ - showPane?: boolean; - /** The width of the widget. */ - width?: number; - } - /** A widget used to indicate whether or not an element is loading. */ - export class dxLoadPanel extends dxOverlay { - constructor(element: JQuery, options?: dxLoadPanelOptions); - constructor(element: Element, options?: dxLoadPanelOptions); - } - export interface dxLoadIndicatorOptions extends WidgetOptions { - /** Specifies the path to an image used as the indicator. */ - indicatorSrc?: string; - } - /** The widget used to indicate the loading process. */ - export class dxLoadIndicator extends Widget { - constructor(element: JQuery, options?: dxLoadIndicatorOptions); - constructor(element: Element, options?: dxLoadIndicatorOptions); - } - export interface dxListOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not to display a grouped list. */ - grouped?: boolean; - groupRender?: any; - /** The template to be used for rendering item groups. */ - groupTemplate?: any; - onItemDeleting?: Function; - /** A handler for the itemDeleted event. */ - onItemDeleted?: Function; - /** A handler for the groupRendered event. */ - onGroupRendered?: Function; - itemDeleteAction?: Function; - /** A handler for the itemReordered event. */ - onItemReordered?: Function; - itemReorderAction?: Function; - /** A handler for the itemClick event. */ - onItemClick?: any; - /** A handler for the itemSwipe event. */ - onItemSwipe?: Function; - itemSwipeAction?: Function; - /** The text displayed on the button used to load the next page from the data source. */ - nextButtonText?: string; - /** A handler for the pageLoading event. */ - onPageLoading?: Function; - pageLoadingAction?: Function; - /** Specifies the text shown in the pullDown panel, which is displayed when the list is scrolled to the bottom. */ - pageLoadingText?: string; - /** Specifies the text displayed in the pullDown panel when the list is pulled below the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the pullRefresh event. */ - onPullRefresh?: Function; - pullRefreshAction?: Function; - /** A Boolean value specifying whether or not the widget supports the "pull down to refresh" gesture. */ - pullRefreshEnabled?: boolean; - /** Specifies the text displayed in the pullDown panel while the list is being refreshed. */ - refreshingText?: string; - /** A handler for the scroll event. */ - onScroll?: Function; - scrollAction?: Function; - /** A Boolean value specifying whether to enable or disable list scrolling. */ - scrollingEnabled?: boolean; - /** Specifies when the widget shows the scrollbar. */ - showScrollbar?: string; - /** Specifies whether or not the widget uses native scrolling. */ - useNativeScrolling?: boolean; - /** A Boolean value specifying whether to enable or disable the bounce-back effect. */ - bounceEnabled?: boolean; - /** A Boolean value specifying if the list is scrolled by content. */ - scrollByContent?: boolean; - /** A Boolean value specifying if the list is scrolled using the scrollbar. */ - scrollByThumb?: boolean; - itemUnselectAction?: Function; - onItemContextMenu?: Function; - onItemHold?: Function; - /** Specifies whether or not an end-user can collapse groups. */ - collapsibleGroups?: boolean; - /** Specifies whether the next page is loaded when a user scrolls the widget to the bottom or when the "next" button is clicked. */ - pageLoadMode?: string; - /** Specifies whether or not to display controls used to select list items. */ - showSelectionControls?: boolean; - /** Specifies whether the list supports single item selection or multi-selection. */ - selectionMode?: string; - selectAllText?: string; - /** Specifies the array of items for a context menu called for a list item. */ - menuItems?: Array; - /** Specifies whether an item context menu is shown when a user holds or swipes an item. */ - menuMode?: string; - /** Specifies whether or not an end user can delete list items. */ - allowItemDeleting?: boolean; - /** Specifies the way a user can delete items from the list. */ - itemDeleteMode?: string; - /** Specifies whether or not an end user can reorder list items. */ - allowItemReordering?: boolean; - /** Specifies whether or not to show the loading panel when the DataSource bound to the widget is loading data. */ - indicateLoading?: boolean; - } - /** A list widget. */ - export class dxList extends CollectionWidget { - constructor(element: JQuery, options?: dxListOptions); - constructor(element: Element, options?: dxListOptions); - /** Returns the height of the widget in pixels. */ - clientHeight(): number; - /** Removes the specified item from the list. */ - deleteItem(itemIndex: any): JQueryPromise; - /** Removes the specified item from the list. */ - deleteItem(itemElement: Element): JQueryPromise; - /** Returns a Boolean value that indicates whether or not the specified item is selected. */ - isItemSelected(itemIndex: any): boolean; - /** Returns a Boolean value that indicates whether or not the specified item is selected. */ - isItemSelected(itemElement: Element): boolean; - /** Reloads list data. */ - reload(): void; - /** Moves the specified item to the specified position in the list. */ - reorderItem(itemElement: Element, toItemElement: Element): JQueryPromise; - /** Moves the specified item to the specified position in the list. */ - reorderItem(itemIndex: any, toItemIndex: any): JQueryPromise; - /** Scrolls the list content by the specified number of pixels. */ - scrollBy(distance: number): void; - /** Returns the height of the list content in pixels. */ - scrollHeight(): number; - /** Scrolls list content to the specified position. */ - scrollTo(location: number): void; - /** Scrolls the list to the specified item. */ - scrollToItem(itemElement: Element): void; - /** Scrolls the list to the specified item. */ - scrollToItem(itemIndex: any): void; - /** Returns how far the list content is scrolled from the top. */ - scrollTop(): number; - /** Selects the specified item from the list. */ - selectItem(itemElement: Element): void; - /** Selects the specified item from the list. */ - selectItem(itemIndex: any): void; - /** Deselects the specified item from the list. */ - unselectItem(itemElement: Element): void; - /** Unselects the specified item from the list. */ - unselectItem(itemIndex: any): void; - /** Updates the widget scrollbar according to widget content size. */ - updateDimensions(): JQueryPromise; - /** Expands the specified group. */ - expandGroup(groupIndex: number): JQueryPromise; - /** Collapses the specified group. */ - collapseGroup(groupIndex: number): JQueryPromise; - } - export interface dxGalleryOptions extends CollectionWidgetOptions { - /** The time, in milliseconds, spent on slide animation. */ - animationDuration?: number; - /** Specifies whether or not to animate the displayed item change. */ - animationEnabled?: boolean; - /** A Boolean value specifying whether or not to allow users to switch between items by clicking an indicator. */ - indicatorEnabled?: boolean; - /** A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped. */ - loop?: boolean; - /** The index of the currently active gallery item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to display an indicator that points to the selected gallery item. */ - showIndicator?: boolean; - /** A Boolean value that specifies the availability of the "Forward" and "Back" navigation buttons. */ - showNavButtons?: boolean; - /** The time interval in milliseconds, after which the gallery switches to the next item. */ - slideshowDelay?: number; - /** A Boolean value specifying whether or not to allow users to switch between items by swiping. */ - swipeEnabled?: boolean; - /** Specifies whether or not to display parts of previous and next images along the sides of the current image. */ - wrapAround?: boolean; - /** Specifies if the widget stretches images to fit the total gallery width. */ - stretchImages?: boolean; - /** Specifies the width of an area used to display a single image. */ - initialItemWidth?: number; - } - /** An image gallery widget. */ - export class dxGallery extends CollectionWidget { - constructor(element: JQuery, options?: dxGalleryOptions); - constructor(element: Element, options?: dxGalleryOptions); - /** Shows the specified gallery item. */ - goToItem(itemIndex: number, animation: boolean): JQueryPromise; - /** Shows the next gallery item. */ - nextItem(animation: boolean): JQueryPromise; - /** Shows the previous gallery item. */ - prevItem(animation: boolean): JQueryPromise; - } - export interface dxDropDownEditorOptions extends dxTextBoxOptions { - /** Specifies the current value displayed by the widget. */ - value?: Object; - /** A handler for the closed event. */ - onClosed?: Function; - /** A handler for the opened event. */ - onOpened?: Function; - /** Specifies whether or not the drop-down editor is displayed. */ - opened?: boolean; - closeAction?: Function; - openAction?: Function; - shownAction?: Function; - hiddenAction?: Function; - /** Specifies whether or not the widget allows an end-user to enter a custom value. */ - fieldEditEnabled?: boolean; - editEnabled?: boolean; - /** Specifies the way an end-user applies the selected value. */ - applyValueMode?: string; - } - /** A drop-down editor widget. */ - export class dxDropDownEditor extends dxTextBox { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - /** Closes the drop-down editor. */ - close(): void; - /** Opens the drop-down editor. */ - open(): void; - /** Resets the widget's value to null. */ - reset(): void; - /** Returns an <input> element of the widget. */ - field(): JQuery; - /** Returns an HTML element of the popup window content. */ - content(): JQuery; - } - export interface dxDateBoxOptions extends dxTextEditorOptions { - /** A format used to display date/time information. */ - format?: string; - /** A Globalize format string specifying the date display format. */ - formatString?: string; - /** The last date that can be selected within the widget. */ - max?: Date; - /** The minimum date that can be selected within the widget. */ - min?: Date; - /** The text displayed by the widget when the widget value is not yet specified. This text is also used as a title of the date picker. */ - placeholder?: string; - /** - * Specifies whether or not a user can pick out a date using the drop-down calendar. - * @deprecated Use 'pickerType' option instead. - */ - useCalendar?: boolean; - /** A Date object specifying the date and time currently selected using the date box. */ - value?: Date; - /** - * Specifies whether or not the widget uses the native HTML input element. - * @deprecated Use 'pickerType' option instead. - */ - useNative?: boolean; - /** Specifies the interval between neighboring values in the popup list in minutes. */ - interval?: number; - /** Specifies the maximum zoom level of a calendar, which is used to pick the date. */ - maxZoomLevel?: string; - /** Specifies the minimal zoom level of a calendar, which is used to pick the date. */ - minZoomLevel?: string; - /** Specifies the type of date/time picker. */ - pickerType?: string; - } - /** A date box widget. */ - export class dxDateBox extends dxDropDownEditor { - constructor(element: JQuery, options?: dxDateBoxOptions); - constructor(element: Element, options?: dxDateBoxOptions); - } - export interface dxCheckBoxOptions extends EditorOptions { - /** Specifies the widget state. */ - value?: boolean; - /** Specifies the text displayed by the check box. */ - text?: string; - } - /** A check box widget. */ - export class dxCheckBox extends Editor { - constructor(element: JQuery, options?: dxCheckBoxOptions); - constructor(element: Element, options?: dxCheckBoxOptions); - } - export interface dxCalendarOptions extends EditorOptions { - /** Specifies a date displayed on the current calendar page. */ - currentDate?: Date; - /** Specifies the first day of a week. */ - firstDayOfWeek?: number; - /** The latest date the widget allows to select. */ - max?: Date; - /** The earliest date the widget allows to select. */ - min?: Date; - /** Specifies whether or not the widget displays a button that selects the current date. */ - showTodayButton?: boolean; - /** Specifies the current calendar zoom level. */ - zoomLevel?: string; - /** Specifies the maximum zoom level of the calendar. */ - maxZoomLevel?: string; - /** Specifies the minimum zoom level of the calendar. */ - minZoomLevel?: string; - /** The template to be used for rendering calendar cells. */ - cellTemplate?: any; - } - /** A calendar widget. */ - export class dxCalendar extends Editor { - constructor(element: JQuery, options?: dxCalendarOptions); - constructor(element: Element, options?: dxCalendarOptions); - } - export interface dxButtonOptions extends WidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A handler for the click event. */ - onClick?: any; - clickAction?: any; - /** Specifies the icon to be displayed on the button. */ - icon?: string; - iconSrc?: string; - /** A template to be used for rendering the dxButton widget. */ - template?: any; - /** The text displayed on the button. */ - text?: string; - /** Specifies the button type. */ - type?: string; - /** Specifies the name of the validation group to be accessed in the click event handler. */ - validationGroup?: string; - } - /** A button widget. */ - export class dxButton extends Widget { - constructor(element: JQuery, options?: dxButtonOptions); - constructor(element: Element, options?: dxButtonOptions); - } - export interface dxBoxOptions extends CollectionWidget { - /** Specifies how widget items are aligned along the main direction. */ - align?: string; - /** Specifies the direction of item positioning in the widget. */ - direction?: string; - /** Specifies how widget items are aligned cross-wise. */ - crossAlign?: string; - } - /** A container widget used to arrange inner elements. */ - export class dxBox extends CollectionWidget { - constructor(element: JQuery, options?: dxBoxOptions); - constructor(element: Element, options?: dxBoxOptions); - } - export interface dxResponsiveBoxOptions extends CollectionWidgetOptions { - /** Specifies the collection of rows for the grid used to position layout elements. */ - rows?: Array; - /** Specifies the collection of columns for the grid used to position layout elements. */ - cols?: Array; - /** Specifies the function returning the screen factor depending on the screen width. */ - screenByWidth?: (width: number) => string; - /** Specifies the screen factor with which all elements are located in a single column. */ - singleColumnScreen?: string; - } - /** A widget used to build an adaptive markup that is dependent on screen resolution. */ - export class dxResponsiveBox extends CollectionWidget { - constructor(element: JQuery, options?: dxBoxOptions); - constructor(element: Element, options?: dxBoxOptions); - } - export interface dxAutocompleteOptions extends dxDropDownListOptions { - /** Specifies the current value displayed by the widget. */ - value?: string; - /** The minimum number of characters that must be entered into the text box to begin a search. */ - minSearchLength?: number; - /** Specifies the maximum count of items displayed by the widget. */ - maxItemCount?: number; - /** Gets the currently selected item. */ - selectedItem?: Object; - } - /** A textbox widget that supports autocompletion. */ - export class dxAutocomplete extends dxDropDownList { - constructor(element: JQuery, options?: dxAutocompleteOptions); - constructor(element: Element, options?: dxAutocompleteOptions); - /** Opens the drop-down editor. */ - open(): void; - /** Closes the drop-down editor. */ - close(): void; - } - export interface dxAccordionOptions extends CollectionWidgetOptions { - /** A number specifying the time in milliseconds spent on the animation of the expanding or collapsing of a panel. */ - animationDuration?: number; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies whether all items can be collapsed or whether at least one item must always be expanded. */ - collapsible?: boolean; - /** Specifies whether the widget can expand several items or only a single item at once. */ - multiple?: boolean; - /** The template to be used for rendering dxAccordion items. */ - itemTemplate?: any; - /** A handler for the itemTitleClick event. */ - onItemTitleClick?: any; - /** A handler for the itemTitleHold event. */ - onItemTitleHold?: Function; - /** The template to be used for rendering an item title. */ - itemTitleTemplate?: any; - /** The index number of the currently selected item. */ - selectedIndex?: number; - } - /** A widget that displays data source items on collapsible panels. */ - export class dxAccordion extends CollectionWidget { - constructor(element: JQuery, options?: dxAccordionOptions); - constructor(element: Element, options?: dxAccordionOptions); - /** Collapses the specified item. */ - collapseItem(index: number): JQueryPromise; - /** Expands the specified item. */ - expandItem(index: number): JQueryPromise; - } - export interface dxFileUploaderOptions extends EditorOptions { - /** A read-only option that holds a File instance representing the selected file. */ - value?: File; - /** Holds the File instances representing files selected in the widget. */ - values?: Array; - buttonText?: string; - /** The text displayed on the button that opens the file browser. */ - selectButtonText?: string; - /** The text displayed on the button that starts uploading. */ - uploadButtonText?: string; - /** Specifies the text displayed on the area to which an end-user can drop a file. */ - labelText?: string; - /** Specifies the value passed to the name attribute of the underlying input element. */ - name?: string; - /** Specifies whether the widget enables an end-user to select a single file or multiple files. */ - multiple?: boolean; - /** Specifies a file type or several types accepted by the widget. */ - accept?: string; - /** Specifies a target Url for the upload request. */ - uploadUrl?: string; - /** Specifies if an end user can remove a file from the selection and interrupt uploading. */ - allowCanceling?: boolean; - /** Specifies whether or not the widget displays the list of selected files. */ - showFileList?: boolean; - /** Gets the current progress in percentages. */ - progress?: number; - /** The message displayed by the widget when it is ready to upload the specified files. */ - readyToUploadMessage?: string; - /** The message displayed by the widget when uploading is finished. */ - uploadedMessage?: string; - /** The message displayed by the widget on uploading failure. */ - uploadFailedMessage?: string; - /** Specifies how the widget uploads files. */ - uploadMode?: string; - } - /** A widget used to select and upload a file or multiple files. */ - export class dxFileUploader extends Editor { - constructor(element: JQuery, options?: dxFileUploaderOptions); - constructor(element: Element, options?: dxFileUploaderOptions); - } - export interface dxTrackBarOptions extends EditorOptions { - /** The minimum value the widget can accept. */ - min?: number; - /** The maximum value the widget can accept. */ - max?: number; - /** The current widget value. */ - value?: number; - } - /** A base class for track bar widgets. */ - export class dxTrackBar extends Editor { - constructor(element: JQuery, options?: dxTrackBarOptions); - constructor(element: Element, options?: dxTrackBarOptions); - } - export interface dxProgressBarOptions extends dxTrackBarOptions { - /** Specifies a format for the progress status. */ - statusFormat?: any; - /** Specifies whether or not the widget displays a progress status. */ - showStatus?: boolean; - /** A handler for the complete event. */ - onComplete?: Function; - } - /** A widget used to indicate progress. */ - export class dxProgressBar extends dxTrackBar { - constructor(element: JQuery, options?: dxProgressBarOptions); - constructor(element: Element, options?: dxProgressBarOptions); - } - export interface dxSliderOptions extends dxTrackBarOptions { - /** The slider step size. */ - step?: number; - /** The current slider value. */ - value?: number; - /** Specifies whether or not to highlight a range selected within the widget. */ - showRange?: boolean; - /** Specifies the size of a step by which a slider handle is moved when a user uses the Page up or Page down keyboard shortcuts. */ - keyStep?: number; - /** Specifies options for the slider tooltip. */ - tooltip?: { - /** Specifies whether or not the tooltip is enabled. */ - enabled?: boolean; - /** Specifies format for the tooltip. */ - format?: any; - /** Specifies whether the tooltip is located over or under the slider. */ - position?: string; - /** Specifies whether the widget always shows a tooltip or only when a pointer is over the slider. */ - showMode?: string; - }; - /** Specifies options for labels displayed at the min and max values. */ - label?: { - /** Specifies whether or not slider labels are visible. */ - visible?: boolean; - /** Specifies whether labels are located over or under the scale. */ - position?: string; - /** Specifies a format for labels. */ - format?: any; - }; - } - /** A widget that allows a user to select a numeric value within a given range. */ - export class dxSlider extends dxTrackBar { - constructor(element: JQuery, options?: dxSliderOptions); - constructor(element: Element, options?: dxSliderOptions); - } - export interface dxRangeSliderOptions extends dxSliderOptions { - /** The left edge of the interval currently selected using the range slider. */ - start?: number; - /** The right edge of the interval currently selected using the range slider. */ - end?: number; - } - /** A widget that enables a user to select a range of numeric values. */ - export class dxRangeSlider extends dxSlider { - constructor(element: JQuery, options?: dxRangeSliderOptions); - constructor(element: Element, options?: dxRangeSliderOptions); - } -} -interface JQuery { - dxProgressBar(): JQuery; - dxProgressBar(options: "instance"): DevExpress.ui.dxProgressBar; - dxProgressBar(options: string): any; - dxProgressBar(options: string, ...params: any[]): any; - dxProgressBar(options: DevExpress.ui.dxProgressBarOptions): JQuery; - dxSlider(): JQuery; - dxSlider(options: "instance"): DevExpress.ui.dxSlider; - dxSlider(options: string): any; - dxSlider(options: string, ...params: any[]): any; - dxSlider(options: DevExpress.ui.dxSliderOptions): JQuery; - dxRangeSlider(): JQuery; - dxRangeSlider(options: "instance"): DevExpress.ui.dxRangeSlider; - dxRangeSlider(options: string): any; - dxRangeSlider(options: string, ...params: any[]): any; - dxRangeSlider(options: DevExpress.ui.dxRangeSliderOptions): JQuery; - dxFileUploader(): JQuery; - dxFileUploader(options: "instance"): DevExpress.ui.dxFileUploader; - dxFileUploader(options: string): any; - dxFileUploader(options: string, ...params: any[]): any; - dxFileUploader(options: DevExpress.ui.dxFileUploaderOptions): JQuery; - dxValidator(): JQuery; - dxValidator(options: "instance"): DevExpress.ui.dxValidator; - dxValidator(options: string): any; - dxValidator(options: string, ...params: any[]): any; - dxValidationGroup(): JQuery; - dxValidationGroup(options: "instance"): DevExpress.ui.dxValidationGroup; - dxValidationGroup(options: string): any; - dxValidationGroup(options: string, ...params: any[]): any; - dxValidationSummary(): JQuery; - dxValidationSummary(options: "instance"): DevExpress.ui.dxValidationSummary; - dxValidationSummary(options: string): any; - dxValidationSummary(options: string, ...params: any[]): any; - dxTooltip(): JQuery; - dxTooltip(options: "instance"): DevExpress.ui.dxTooltip; - dxTooltip(options: string): any; - dxTooltip(options: string, ...params: any[]): any; - dxTooltip(options: DevExpress.ui.dxTooltipOptions): JQuery; - dxResizable(): JQuery; - dxResizable(options: "instance"): DevExpress.ui.dxResizable; - dxResizable(options: string): any; - dxResizable(options: string, ...params: any[]): any; - dxResizable(options: DevExpress.ui.dxResizableOptions): JQuery; - dxDropDownList(): JQuery; - dxDropDownList(options: "instance"): DevExpress.ui.dxDropDownList; - dxDropDownList(options: string): any; - dxDropDownList(options: string, ...params: any[]): any; - dxDropDownList(options: DevExpress.ui.dxDropDownListOptions): JQuery; - dxToolbar(): JQuery; - dxToolbar(options: "instance"): DevExpress.ui.dxToolbar; - dxToolbar(options: string): any; - dxToolbar(options: string, ...params: any[]): any; - dxToolbar(options: DevExpress.ui.dxToolbarOptions): JQuery; - dxToast(): JQuery; - dxToast(options: "instance"): DevExpress.ui.dxToast; - dxToast(options: string): any; - dxToast(options: string, ...params: any[]): any; - dxToast(options: DevExpress.ui.dxToastOptions): JQuery; - dxTextEditor(): JQuery; - dxTextEditor(options: "instance"): DevExpress.ui.dxTextEditor; - dxTextEditor(options: string): any; - dxTextEditor(options: string, ...params: any[]): any; - dxTextEditor(options: DevExpress.ui.dxTextEditorOptions): JQuery; - dxTextBox(): JQuery; - dxTextBox(options: "instance"): DevExpress.ui.dxTextBox; - dxTextBox(options: string): any; - dxTextBox(options: string, ...params: any[]): any; - dxTextBox(options: DevExpress.ui.dxTextBoxOptions): JQuery; - dxTextArea(): JQuery; - dxTextArea(options: "instance"): DevExpress.ui.dxTextArea; - dxTextArea(options: string): any; - dxTextArea(options: string, ...params: any[]): any; - dxTextArea(options: DevExpress.ui.dxTextAreaOptions): JQuery; - dxTabs(): JQuery; - dxTabs(options: "instance"): DevExpress.ui.dxTabs; - dxTabs(options: string): any; - dxTabs(options: string, ...params: any[]): any; - dxTabs(options: DevExpress.ui.dxTabsOptions): JQuery; - dxTabPanel(): JQuery; - dxTabPanel(options: "instance"): DevExpress.ui.dxTabPanel; - dxTabPanel(options: string): any; - dxTabPanel(options: string, ...params: any[]): any; - dxTabPanel(options: DevExpress.ui.dxTabPanelOptions): JQuery; - dxSelectBox(): JQuery; - dxSelectBox(options: "instance"): DevExpress.ui.dxSelectBox; - dxSelectBox(options: string): any; - dxSelectBox(options: string, ...params: any[]): any; - dxSelectBox(options: DevExpress.ui.dxSelectBoxOptions): JQuery; - dxScrollView(): JQuery; - dxScrollView(options: "instance"): DevExpress.ui.dxScrollView; - dxScrollView(options: string): any; - dxScrollView(options: string, ...params: any[]): any; - dxScrollView(options: DevExpress.ui.dxScrollViewOptions): JQuery; - dxScrollable(): JQuery; - dxScrollable(options: "instance"): DevExpress.ui.dxScrollable; - dxScrollable(options: string): any; - dxScrollable(options: string, ...params: any[]): any; - dxScrollable(options: DevExpress.ui.dxScrollableOptions): JQuery; - dxRadioGroup(): JQuery; - dxRadioGroup(options: "instance"): DevExpress.ui.dxRadioGroup; - dxRadioGroup(options: string): any; - dxRadioGroup(options: string, ...params: any[]): any; - dxRadioGroup(options: DevExpress.ui.dxRadioGroupOptions): JQuery; - dxPopup(): JQuery; - dxPopup(options: "instance"): DevExpress.ui.dxPopup; - dxPopup(options: string): any; - dxPopup(options: string, ...params: any[]): any; - dxPopup(options: DevExpress.ui.dxPopupOptions): JQuery; - dxPopover(): JQuery; - dxPopover(options: "instance"): DevExpress.ui.dxPopover; - dxPopover(options: string): any; - dxPopover(options: string, ...params: any[]): any; - dxPopover(options: DevExpress.ui.dxPopoverOptions): JQuery; - dxOverlay(): JQuery; - dxOverlay(options: "instance"): DevExpress.ui.dxOverlay; - dxOverlay(options: string): any; - dxOverlay(options: string, ...params: any[]): any; - dxOverlay(options: DevExpress.ui.dxOverlayOptions): JQuery; - dxNumberBox(): JQuery; - dxNumberBox(options: "instance"): DevExpress.ui.dxNumberBox; - dxNumberBox(options: string): any; - dxNumberBox(options: string, ...params: any[]): any; - dxNumberBox(options: DevExpress.ui.dxNumberBoxOptions): JQuery; - dxNavBar(): JQuery; - dxNavBar(options: "instance"): DevExpress.ui.dxNavBar; - dxNavBar(options: string): any; - dxNavBar(options: string, ...params: any[]): any; - dxNavBar(options: DevExpress.ui.dxNavBarOptions): JQuery; - dxMultiView(): JQuery; - dxMultiView(options: "instance"): DevExpress.ui.dxMultiView; - dxMultiView(options: string): any; - dxMultiView(options: string, ...params: any[]): any; - dxMultiView(options: DevExpress.ui.dxMultiViewOptions): JQuery; - dxMap(): JQuery; - dxMap(options: "instance"): DevExpress.ui.dxMap; - dxMap(options: string): any; - dxMap(options: string, ...params: any[]): any; - dxMap(options: DevExpress.ui.dxMapOptions): JQuery; - dxLookup(): JQuery; - dxLookup(options: "instance"): DevExpress.ui.dxLookup; - dxLookup(options: string): any; - dxLookup(options: string, ...params: any[]): any; - dxLookup(options: DevExpress.ui.dxLookupOptions): JQuery; - dxLoadPanel(): JQuery; - dxLoadPanel(options: "instance"): DevExpress.ui.dxLoadPanel; - dxLoadPanel(options: string): any; - dxLoadPanel(options: string, ...params: any[]): any; - dxLoadPanel(options: DevExpress.ui.dxLoadPanelOptions): JQuery; - dxLoadIndicator(): JQuery; - dxLoadIndicator(options: "instance"): DevExpress.ui.dxLoadIndicator; - dxLoadIndicator(options: string): any; - dxLoadIndicator(options: string, ...params: any[]): any; - dxLoadIndicator(options: DevExpress.ui.dxLoadIndicatorOptions): JQuery; - dxList(): JQuery; - dxList(options: "instance"): DevExpress.ui.dxList; - dxList(options: string): any; - dxList(options: string, ...params: any[]): any; - dxList(options: DevExpress.ui.dxListOptions): JQuery; - dxGallery(): JQuery; - dxGallery(options: "instance"): DevExpress.ui.dxGallery; - dxGallery(options: string): any; - dxGallery(options: string, ...params: any[]): any; - dxGallery(options: DevExpress.ui.dxGalleryOptions): JQuery; - dxDropDownEditor(): JQuery; - dxDropDownEditor(options: "instance"): DevExpress.ui.dxDropDownEditor; - dxDropDownEditor(options: string): any; - dxDropDownEditor(options: string, ...params: any[]): any; - dxDropDownEditor(options: DevExpress.ui.dxDropDownEditorOptions): JQuery; - dxDateBox(): JQuery; - dxDateBox(options: "instance"): DevExpress.ui.dxDateBox; - dxDateBox(options: string): any; - dxDateBox(options: string, ...params: any[]): any; - dxDateBox(options: DevExpress.ui.dxDateBoxOptions): JQuery; - dxCheckBox(): JQuery; - dxCheckBox(options: "instance"): DevExpress.ui.dxCheckBox; - dxCheckBox(options: string): any; - dxCheckBox(options: string, ...params: any[]): any; - dxCheckBox(options: DevExpress.ui.dxCheckBoxOptions): JQuery; - dxBox(): JQuery; - dxBox(options: "instance"): DevExpress.ui.dxBox; - dxBox(options: string): any; - dxBox(options: string, ...params: any[]): any; - dxBox(options: DevExpress.ui.dxBoxOptions): JQuery; - dxButton(): JQuery; - dxButton(options: "instance"): DevExpress.ui.dxButton; - dxButton(options: string): any; - dxButton(options: string, ...params: any[]): any; - dxButton(options: DevExpress.ui.dxButtonOptions): JQuery; - dxCalendar(): JQuery; - dxCalendar(options: "instance"): DevExpress.ui.dxCalendar; - dxCalendar(options: string): any; - dxCalendar(options: string, ...params: any[]): any; - dxCalendar(options: DevExpress.ui.dxCalendarOptions): JQuery; - dxAccordion(): JQuery; - dxAccordion(options: "instance"): DevExpress.ui.dxAccordion; - dxAccordion(options: string): any; - dxAccordion(options: string, ...params: any[]): any; - dxAccordion(options: DevExpress.ui.dxAccordionOptions): JQuery; - dxAutocomplete(): JQuery; - dxAutocomplete(options: "instance"): DevExpress.ui.dxAutocomplete; - dxAutocomplete(options: string): any; - dxAutocomplete(options: string, ...params: any[]): any; - dxAutocomplete(options: DevExpress.ui.dxAutocompleteOptions): JQuery; -} - -declare namespace DevExpress.ui { - export interface dxTileViewOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** Specifies the height of the base tile view item. */ - baseItemHeight?: number; - /** Specifies the width of the base tile view item. */ - baseItemWidth?: number; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies the distance in pixels between adjacent tiles. */ - itemMargin?: number; - /** A Boolean value specifying whether or not to display a scrollbar. */ - showScrollbar?: boolean; - } - /** A widget displaying several blocks of data as tiles. */ - export class dxTileView extends CollectionWidget { - constructor(element: JQuery, options?: dxTileViewOptions); - constructor(element: Element, options?: dxTileViewOptions); - /** Returns the current scroll position of the widget content. */ - scrollPosition(): number; - } - export interface dxSwitchOptions extends EditorOptions { - /** Text displayed when the widget is in a disabled state. */ - offText?: string; - /** Text displayed when the widget is in an enabled state. */ - onText?: string; - /** A Boolean value specifying whether the current switch state is "On" or "Off". */ - value?: boolean; - } - /** A switch widget. */ - export class dxSwitch extends Editor { - constructor(element: JQuery, options?: dxSwitchOptions); - constructor(element: Element, options?: dxSwitchOptions); - } - export interface dxSlideOutViewOptions extends WidgetOptions { - /** Specifies whether or not the menu panel is visible. */ - menuVisible?: boolean; - /** Specifies whether or not the menu is shown when a user swipes the widget content. */ - swipeEnabled?: boolean; - /** A template to be used for rendering menu panel content. */ - menuTemplate?: any; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - } - /** The widget that allows you to slide-out the current view to reveal a custom menu. */ - export class dxSlideOutView extends Widget { - constructor(element: JQuery, options?: dxSlideOutViewOptions); - constructor(element: Element, options?: dxSlideOutViewOptions); - /** Returns an HTML element of the widget menu block. */ - menuContent(): JQuery; - /** Returns an HTML element of the widget content block. */ - content(): JQuery; - /** Displays the widget's menu block. */ - showMenu(): JQueryPromise; - /** Hides the widget's menu block. */ - hideMenu(): JQueryPromise; - /** Toggles the visibility of the widget's menu block. */ - toggleMenuVisibility(): JQueryPromise; - } - export interface dxSlideOutOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A Boolean value specifying whether or not to display a grouped menu. */ - menuGrouped?: boolean; - menuGroupRender?: any; - /** The name of the template used to display a group header. */ - menuGroupTemplate?: any; - menuItemRender?: any; - /** The template used to render menu items. */ - menuItemTemplate?: any; - /** A handler for the menuGroupRendered event. */ - onMenuGroupRendered?: Function; - /** A handler for the menuItemRendered event. */ - onMenuItemRendered?: Function; - /** Specifies whether or not the slide-out menu is displayed. */ - menuVisible?: boolean; - /** Indicates whether the menu can be shown/hidden by swiping the widget's main panel. */ - swipeEnabled?: boolean; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - } - /** The widget that allows you to slide-out the current view to reveal an item list. */ - export class dxSlideOut extends CollectionWidget { - constructor(element: JQuery, options?: dxSlideOutOptions); - constructor(element: Element, options?: dxSlideOutOptions); - /** Hides the widget's slide-out menu. */ - hideMenu(): JQueryPromise; - /** Displays the widget's slide-out menu. */ - showMenu(): JQueryPromise; - /** Toggles the visibility of the widget's slide-out menu. */ - toggleMenuVisibility(showing: boolean): JQueryPromise; - } - export interface dxPivotOptions extends CollectionWidgetOptions { - /** The index of the currently active pivot item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to allow users to switch between items by swiping. */ - swipeEnabled?: boolean; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - } - /** A widget that is similar to a traditional tab control, but optimized for the phone with simplified end-user interaction. */ - export class dxPivot extends CollectionWidget { - constructor(element: JQuery, options?: dxPivotOptions); - constructor(element: Element, options?: dxPivotOptions); - } - export interface dxPanoramaOptions extends CollectionWidgetOptions { - /** An object exposing options for setting a background image for the panorama. */ - backgroundImage?: { - /** Specifies the height of the panorama's background image. */ - height?: number; - /** Specifies the URL of the image that is used as the panorama's background image. */ - url?: string; - /** Specifies the width of the panorama's background image. */ - width?: number; - }; - /** The index of the currently active panorama item. */ - selectedIndex?: number; - /** Specifies the widget content title. */ - title?: string; - } - /** A widget displaying the required content in a long horizontal canvas that extends beyond the frames of the screen. */ - export class dxPanorama extends CollectionWidget { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - } - export interface dxDropDownMenuOptions extends WidgetOptions { - /** A handler for the buttonClick event. */ - onButtonClick?: any; - buttonClickAction?: any; - /** The name of the icon to be displayed by the DropDownMenu button. */ - buttonIcon?: string; - buttonIconSrc?: string; - /** The text displayed in the DropDownMenu button. */ - buttonText?: string; - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** A handler for the itemClick event. */ - onItemClick?: any; - itemClickAction?: any; - itemRender?: any; - /** An array of items displayed by the widget. */ - items?: Array; - /** The template to be used for rendering items. */ - itemTemplate?: any; - /** Specifies whether or not to show the drop down menu within a dxPopover widget. */ - usePopover?: boolean; - /** The width of the menu popup in pixels. */ - popupWidth?: any; - /** The height of the menu popup in pixels. */ - popupHeight?: any; - /** Specifies whether or not the drop-down menu is displayed. */ - opened?: boolean; - /** A Boolean value specifying whether or not the widget changes its state when being hovered by an end user. */ - hoverStateEnabled?: boolean; - } - /** A drop-down menu widget. */ - export class dxDropDownMenu extends Widget { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - /** This section lists the data source fields that are used in a default template for drop-down menu items. */ - /** Opens the drop-down menu. */ - open(): void; - /** Closes the drop-down menu. */ - close(): void; - } - export interface dxActionSheetOptions extends CollectionWidgetOptions { - cancelClickAction?: any; - /** A handler for the cancelClick event. */ - onCancelClick?: any; - /** The text displayed in the button that closes the action sheet. */ - cancelText?: string; - /** Specifies whether or not to display the Cancel button in action sheet. */ - showCancelButton?: boolean; - /** A Boolean value specifying whether or not the title of the action sheet is visible. */ - showTitle?: boolean; - /** Specifies the element the action sheet popover points at. */ - target?: any; - /** The title of the action sheet. */ - title?: string; - /** Specifies whether or not to show the action sheet within a dxPopover widget. */ - usePopover?: boolean; - /** A Boolean value specifying whether or not the dxActionSheet widget is visible. */ - visible?: boolean; - } - /** A widget consisting of a set of choices related to a certain task. */ - export class dxActionSheet extends CollectionWidget { - constructor(element: JQuery, options?: dxActionSheetOptions); - constructor(element: Element, options?: dxActionSheetOptions); - /** Hides the widget. */ - hide(): JQueryPromise; - /** Shows the widget. */ - show(): JQueryPromise; - /** Shows or hides the widget depending on the Boolean value passed as the parameter. */ - toggle(showing: boolean): JQueryPromise; - } -} -interface JQuery { - dxTileView(): JQuery; - dxTileView(options: "instance"): DevExpress.ui.dxTileView; - dxTileView(options: string): any; - dxTileView(options: string, ...params: any[]): any; - dxTileView(options: DevExpress.ui.dxTileViewOptions): JQuery; - dxSwitch(): JQuery; - dxSwitch(options: "instance"): DevExpress.ui.dxSwitch; - dxSwitch(options: string): any; - dxSwitch(options: string, ...params: any[]): any; - dxSwitch(options: DevExpress.ui.dxSwitchOptions): JQuery; - dxSlideOut(): JQuery; - dxSlideOut(options: "instance"): DevExpress.ui.dxSlideOut; - dxSlideOut(options: string): any; - dxSlideOut(options: string, ...params: any[]): any; - dxSlideOut(options: DevExpress.ui.dxSlideOutOptions): JQuery; - dxPivot(): JQuery; - dxPivot(options: "instance"): DevExpress.ui.dxPivot; - dxPivot(options: string): any; - dxPivot(options: string, ...params: any[]): any; - dxPivot(options: DevExpress.ui.dxPivotOptions): JQuery; - dxPanorama(): JQuery; - dxPanorama(options: "instance"): DevExpress.ui.dxPanorama; - dxPanorama(options: string): any; - dxPanorama(options: string, ...params: any[]): any; - dxPanorama(options: DevExpress.ui.dxPanoramaOptions): JQuery; - dxActionSheet(): JQuery; - dxActionSheet(options: "instance"): DevExpress.ui.dxActionSheet; - dxActionSheet(options: string): any; - dxActionSheet(options: string, ...params: any[]): any; - dxActionSheet(options: DevExpress.ui.dxActionSheetOptions): JQuery; - dxDropDownMenu(): JQuery; - dxDropDownMenu(options: "instance"): DevExpress.ui.dxDropDownMenu; - dxDropDownMenu(options: string): any; - dxDropDownMenu(options: string, ...params: any[]): any; - dxDropDownMenu(options: DevExpress.ui.dxDropDownMenuOptions): JQuery; -} -declare namespace DevExpress.data { - export interface XmlaStoreOptions { - /** The HTTP address to an XMLA OLAP server. */ - url?: string; - /** The name of the database associated with the Store. */ - catalog?: string; - /** The cube name. */ - cube?: string; - beforeSend?: (request: Object) => void; - } - /** A Store that provides access to an OLAP cube using the XMLA standard. */ - export class XmlaStore { - constructor(options: XmlaStoreOptions); - } - export interface PivotGridField { - index?: number; - /** A boolean value specifying whether or not the field is visible in the pivot grid and the Field Chooser. */ - visible?: boolean; - /** Name of the data source field containing data for the pivot grid field. */ - dataField?: string; - /** A caption that will be displayed in the pivot grid's field chooser to identify the field. */ - caption?: string; - /** Specifies a type of field values. */ - dataType?: string; - /** Specifies how the values of the current field are combined into groups. Cannot be used for the XmlaStore store type. */ - groupInterval?: any; - /** Specifies how to aggregate field data. Cannot be used for th XmlaStore store type. */ - summaryType?: string; - /** Allows you to use a custom aggregate function to calculate the summary values. Cannot be used for the XmlaStore store type. */ - calculateCustomSummary?: (options: { - summaryProcess?: string; - value?: any; - totalValue?: any; - }) => void; - /** Specifies the function that determines how to split data from the data source into ranges for header items. Cannot be used for the XmlaStore store type. */ - selector?: (data: Object) => any; - /** Type of the area where the field is located. */ - area?: string; - /** Index among the other fields displayed within the same area. */ - areaIndex?: number; - /** The name of the folder in which the field is located. */ - displayFolder?: string; - /** The name of the group to which the field belongs. */ - groupName?: string; - /** The index of the field within a group. */ - groupIndex?: number; - /** Specifies the initial sort order of field values. */ - sortOrder?: string; - /** Specifies how field data should be sorted. Can be used for the XmlaStore store type only. */ - sortBy?: string; - /** Specifies the data field against which the header items of this field should be sorted. */ - sortBySummaryField?: string; - /** The array of field names that specify a path to column/row whose summary field is used for sorting of this field's header items. */ - sortBySummaryPath?: Array; - /** The filter values for the current field. */ - filterValues?: Array; - /** The filter type for the current field. */ - filterType?: string; - /** Indicates whether all header items of the field's header level are expanded. */ - expanded?: boolean; - /** Specifies whether the field should be treated as a Data Field. */ - isMeasure?: boolean; - /** Specifies a display format for field values. */ - format?: string; - /** Specifies a callback function that returns the text to be displayed in the cells of a field. */ - customizeText?: (cellInfo: { value: any; valueText: string }) => string; - /** Specifies a precision for formatted field values. */ - precision?: number; - /** Specifies how to sort the header items. */ - sortingMethod?: (a: Object, b: Object) => number; - /** Allows an end-user to change sorting options. */ - allowSorting?: boolean; - /** Allows an end-user to sort columns by summary values. */ - allowSortingBySummary?: boolean; - /** Allows an end-user to change filtering options. */ - allowFiltering?: boolean; - /** Allows an end-user to expand/collapse all header items within a header level. */ - allowExpandAll?: boolean; - /** Specifies the absolute width of the field in the pivot grid. */ - width?: number; - } - export interface PivotGridDataSourceOptions { - /** Specifies the underlying Store instance used to access data. */ - store?: any; - /** Indicates whether or not the automatic field generation from data in the Store is enabled. */ - retrieveFields?: boolean; - /** Specifies data filtering conditions. */ - filter?: Object; - /** An array of pivot grid fields. */ - fields?: Array; - /** Indicates whether or not the local sorting of the XMLA data should be performed. */ - localSorting?: boolean; - /** A handler for the changed event. */ - onChanged?: () => void; - /** A handler for the loadingChanged event. */ - onLoadingChanged?: (isLoading: boolean) => void; - /** A handler for the loadError event. */ - onLoadError?: (e?: Object) => void; - /** A handler for the fieldsPrepared event. */ - onFieldsPrepared?: (e?: Array) => void; - } - /** An object that provides access to data for the dxPivotGrid widget. */ - export class PivotGridDataSource implements EventsMixin { - constructor(options?: PivotGridDataSource); - /** Starts loading data. */ - load(): JQueryPromise; - /** Indicates whether or not the PivotGridDataSource is currently being loaded. */ - isLoading(): boolean; - /** Gets data displayed in a PivotGrid. */ - getData(): Object; - /** Gets all fields within a specified area. */ - getAreaFields(area: string, collectGroups: boolean): Array; - /** Gets all fields from the data source. */ - fields(): Array; - /** Sets the fields option. */ - fields(fields: Array): void; - /** Gets current options of a specified field. */ - field(id: number): PivotGridField; - /** Sets one or more options of a specified field. */ - field(id: number, field: PivotGridField): void; - /** Collapses a specified header item. */ - collapseHeaderItem(area: string, path: Array): void; - /** Expands a specified header item. */ - expandHeaderItem(area: string, path: Array): void; - /** Disposes of all resources associated with this PivotGridDataSource. */ - dispose(): void; - on(eventName: string, eventHandler: Function): PivotGridDataSource; - on(events: { [eventName: string]: Function; }): PivotGridDataSource; - off(eventName: string): PivotGridDataSource; - off(eventName: string, eventHandler: Function): PivotGridDataSource; - } -} -declare namespace DevExpress.ui { - export interface dxSchedulerOptions extends WidgetOptions { - /** Specifies a date displayed on the current scheduler view by default. */ - currentDate?: Date; - /** Specifies the view used in the scheduler by default. */ - currentView?: string; - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** Specifies the first day of a week. */ - firstDayOfWeek?: number; - /** The template to be used for rendering appointments. */ - appointmentTemplate?: any; - /** Lists the views to be available within the scheduler's View Selector. */ - views?: Array; - /** Specifies the resource kinds by which the scheduler's appointments are grouped in a timetable. */ - groups?: Array; - /** Specifies a start hour in the scheduler view's time interval. */ - startDayHour?: number; - /** Specifies an end hour in the scheduler view's time interval. */ - endDayHour?: number; - /** Specifies whether the scheduler data can be edited at runtime. */ - editing?: boolean; - /** Specifies an array of resources available in the scheduler. */ - resources?: Array<{ - /** Indicates whether or not several resources of this kind can be assigned to an appointment. */ - allowMultiple?: boolean; - /** Indicates whether or not resources of this kind have priority in the color identification of the appointments that have resources of different kinds assigned. */ - mainColor?: boolean; - /** A data source used to fetch resources to be available in the scheduler. */ - dataSource?: any; - /** Specifies the resource object field whose value is displayed by the Resource editor in the Appointment popup window. */ - displayExpr?: any; - /** Specifies the resource object field that is used as a value of the Resource editor in the Appointment popup window. */ - valueExpr?: any; - /** The name of the appointment object field that specifies a resource of this kind. */ - field?: string; - /** Specifies the label of the Appointment popup window field that allows end users to assign a resource of this kind. */ - label?: string; - }>; - /** A handler for the AppoinmentAdding event. */ - onAppointmentAdding?: Function; - /** A handler for the appointmentAdded event. */ - onAppointmentAdded?: Function; - /** A handler for the AppoinmentUpdating event. */ - onAppointmentUpdating?: Function; - /** A handler for the appointmentUpdated event. */ - onAppointmentUpdated?: Function; - /** A handler for the AppoinmentDeleting event. */ - onAppointmentDeleting?: Function; - /** A handler for the appointmentDeleted event. */ - onAppointmentDeleted?: Function; - /** A handler for the appointmentRendered event. */ - onAppointmentRendered?: Function; - } - /** A widget that displays scheduled data using different views and provides the capability to load, add and edit appointments. */ - export class dxScheduler extends Widget { - constructor(element: JQuery, options?: dxSchedulerOptions); - constructor(element: Element, options?: dxSchedulerOptions); - /** Add the appointment defined by the object passed as a parameter to the data associated with the widget. */ - addAppointment(appointment: Object): void; - /** Updates the appointment specified by the first method parameter by the appointment object specified by the second method parameter in the the data associated with the widget. */ - updateAppointment(target: Object, appointment: Object): void; - /** Deletes the appointment defined by the parameter from the the data associated with the widget. */ - deleteAppointment(appointment: Object): void; - } - export interface dxColorBoxOptions extends dxDropDownEditorOptions { - /** Specifies the text displayed on the button that applies changes and closes the drop-down editor. */ - applyButtonText?: string; - applyValueMode?: string; - /** Specifies the text displayed on the button that cancels changes and closes the drop-down editor. */ - cancelButtonText?: string; - /** Specifies whether or not the widget value includes the alpha channel component. */ - editAlphaChannel?: boolean; - /** Specifies the size of a step by which a handle is moved using a keyboard shortcut. */ - keyStep?: number; - } - /** A widget used to specify a color value. */ - export class dxColorBox extends dxDropDownEditor { - constructor(element: JQuery, options?: dxColorBoxOptions); - constructor(element: Element, options?: dxColorBoxOptions); - } - export interface dxColorPickerOptions extends dxColorBoxOptions { } - /** - * A widget used to specify a color value. - * @deprecated Use the dxColorBox widget instead - */ - export class dxColorPicker extends dxColorBox { - constructor(element: JQuery, options?: dxColorPickerOptions); - constructor(element: Element, options?: dxColorPickerOptions); - } - export interface dxTreeViewOptions extends CollectionWidgetOptions { - /** Specifies whether or not to animate item collapsing and expanding. */ - animationEnabled?: boolean; - /** Specifies whether a nested or plain array is used as a data source. */ - dataStructure?: string; - /** Specifies whether or not a user can expand all tree view items by the "*" hot key. */ - expandAllEnabled?: boolean; - /** - * An array of currently expanded item objects. - * @deprecated Use item.expanded field instead - */ - expandedItems?: Array; - /** Specifies whether or not a check box is displayed at each tree view item. */ - showCheckBoxes?: boolean; - /** Specifies whether or not to select nodes recursively. */ - selectNodesRecursive?: boolean; - /** Specifies whether the "Select All" check box is displayed over the tree view. */ - selectAllEnabled?: boolean; - /** Specifies the text displayed at the "Select All" check box. */ - selectAllText?: string; - /** Specifies the name of the data source item field used as a key. */ - keyExpr?: any; - /** Specifies the name of the data source item field whose value is displayed by the widget. */ - displayExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding node is selected. */ - selectedExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding node is expanded. */ - expandedExpr?: any; - /** Specifies the name of the data source item field that contains an array of nested items. */ - itemsExpr?: any; - /** Specifies the name of the data source item field that holds the key of the parent item. */ - parentIdExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding node is disabled. */ - disabledExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding node includes child nodes. */ - hasItemsExpr?: any; - /** Specifies if the virtual mode is enabled. */ - virtualModeEnabled?: boolean; - /** Specifies the parent ID value of the root item. */ - rootValue?: any; - /** A string value specifying available scrolling directions. */ - scrollDirection?: string; - /** A handler for the itemSelected event. */ - onItemSelected?: Function; - /** A handler for the itemExpanded event. */ - onItemExpanded?: Function; - /** A handler for the itemCollapsed event. */ - onItemCollapsed?: Function; - hoverStateEnabled?: boolean; - focusStateEnabled?: boolean; - } - /** A widget displaying specified data items as a tree. */ - export class dxTreeView extends CollectionWidget { - constructor(element: JQuery, options?: dxTreeViewOptions); - constructor(element: Element, options?: dxTreeViewOptions); - /** Updates the tree view scrollbars according to the current size of the widget content. */ - updateDimensions(): JQueryPromise; - /** Selects the specified item. */ - selectItem(itemElement: any): void; - /** Unselects the specified item. */ - unselectItem(itemElement: any): void; - /** Expands the specified item. */ - expandItem(itemElement: any): void; - /** Collapses the specified item. */ - collapseItem(itemElement: any): void; - /** Returns all nodes of the tree view. */ - getNodes(): Array; - /** Selects all widget items. */ - selectAll(): void; - /** Unselects all widget items. */ - unselectAll(): void; - } - export interface dxMenuBaseOptions extends CollectionWidgetOptions { - /** An object that defines the animation options of the widget. */ - animation?: fx.AnimationOptions; - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** Specifies the name of the CSS class associated with the menu. */ - cssClass?: string; - /** Holds an array of menu items. */ - items?: Array; - /** Specifies whether or not an item becomes selected if an end-user clicks it. */ - selectionByClick?: boolean; - /** Specifies the selection mode supported by the menu. */ - selectionMode?: string; - /** Specifies options of submenu showing and hiding. */ - showSubmenuMode?: { - /** Specifies the mode name. */ - name?: string; - /** Specifies the delay of submenu show and hiding. */ - delay?: { - /** The time span after which the submenu is shown. */ - show?: number; - /** The time span after which the submenu is hidden. */ - hide?: number; - }; - }; - /** A Boolean value specifying whether or not the widget changes its state when being hovered by an end user. */ - hoverStateEnabled?: boolean; - } - export class dxMenuBase extends CollectionWidget { - constructor(element: JQuery, options?: dxMenuBaseOptions); - constructor(element: Element, options?: dxMenuBaseOptions); - /** Selects the specified item. */ - selectItem(itemElement: any): void; - /** Unselects the specified item. */ - unselectItem(itemElement: any): void; - } - export interface dxMenuOptions extends dxMenuBaseOptions { - /** Specifies whether or not the submenu is hidden when the mouse pointer leaves it. */ - hideSubmenuOnMouseLeave?: boolean; - /** Specifies whether the menu has horizontal or vertical orientation. */ - orientation?: string; - /** Specifies options for showing and hiding the first level submenu. */ - showFirstSubmenuMode?: { - /** Specifies the mode name. */ - name?: string; - /** Specifies the delay of submenu showing and hiding. */ - delay?: { - /** The time span after which the submenu is shown. */ - show?: number; - /** The time span after which the submenu is hidden. */ - hide?: number; - }; - }; - /** Specifies the direction at which the submenus are displayed. */ - submenuDirection?: string; - /** A handler for the submenuHidden event. */ - onSubmenuHidden?: Function; - submenuHiddenAction?: Function; - /** A handler for the submenuHiding event. */ - onSubmenuHiding?: Function; - submenuHidingAction?: Function; - /** A handler for the submenuShowing event. */ - onSubmenuShowing?: Function; - submenuShowingAction?: Function; - /** A handler for the submenuShown event. */ - onSubmenuShown?: Function; - submenuShownAction?: Function; - } - /** A menu widget. */ - export class dxMenu extends dxMenuBase { - constructor(element: JQuery, options?: dxMenuOptions); - constructor(element: Element, options?: dxMenuOptions); - } - export interface dxContextMenuOptions extends dxMenuBaseOptions { - /** Holds an object that specifies options of alternative menu invocation. */ - alternativeInvocationMode?: { - /** Specifies whether or not the standard context menu invocation (on a right mouse click or on a long tap) is disabled. */ - enabled?: Boolean; - /** Specifies the element used to invoke the context menu. */ - invokingElement?: any; - }; - /** A handler for the hidden event. */ - onHidden?: Function; - /** A handler for the hiding event. */ - onHiding?: Function; - /** A handler for the positioning event. */ - onPositioning?: Function; - /** A handler for the showing event. */ - onShowing?: Function; - /** A handler for the shown event. */ - onShown?: Function; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** Specifies the direction at which submenus are displayed. */ - submenuDirection?: string; - /** The target element associated with a popover. */ - target?: any; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - } - /** A context menu widget. */ - export class dxContextMenu extends dxMenuBase { - constructor(element: JQuery, options?: dxContextMenuOptions); - constructor(element: Element, options?: dxContextMenuOptions); - /** Toggles the visibility of the widget. */ - toggle(showing: boolean): JQueryPromise; - /** Shows the widget. */ - show(): JQueryPromise; - /** Hides the widget. */ - hide(): JQueryPromise; - } - export interface dxRemoteOperations { - /** Specifies whether or not filtering must be performed on the server side. */ - filtering?: boolean; - /** Specifies whether or not paging must be performed on the server side. */ - paging?: boolean; - /** Specifies whether or not sorting must be performed on the server side. */ - sorting?: boolean; - } - export interface dxDataGridColumn { - /** Specifies the content alignment within column cells. */ - alignment?: string; - /** Specifies whether the values in a column can be edited at runtime. Setting this option makes sense only when editing is enabled for a grid. */ - allowEditing?: boolean; - /** Specifies whether or not a column can be used for filtering grid records. Setting this option makes sense only when the filter row and column header filtering are visible. */ - allowFiltering?: boolean; - /** Specifies whether or not the column can be anchored to a grid edge by end users. Setting this option makes sense only when the columnFixing | enabled option is set to true. */ - allowFixing?: boolean; - /** Specifies if a column can be used for searching grid records. Setting this option makes sense only when the search panel is visible. */ - allowSearch?: boolean; - /** Specifies whether a column can be used for grouping grid records at runtime. Setting this option makes sense only when the group panel is visible. */ - allowGrouping?: boolean; - /** Specifies whether or not a column can be hidden by a user. Setting this option makes sense only when the column chooser is visible. */ - allowHiding?: boolean; - /** Specifies whether or not a particular column can be used in column reordering. Setting this option makes sense only when the allowColumnReordering option is set to true. */ - allowReordering?: boolean; - /** Specifies whether or not a particular column can be resized by a user. Setting this option makes sense only when the allowColumnResizing option is true. */ - allowResizing?: boolean; - /** Specifies whether grid records can be sorted by a specific column at runtime. Setting this option makes sense only when the sorting mode differs from none. */ - allowSorting?: boolean; - /** Specifies whether groups appear expanded or not when records are grouped by a specific column. Setting this option makes sense only when grouping is allowed for this column. */ - autoExpandGroup?: boolean; - /** Specifies a callback function that returns a value to be displayed in a column cell. */ - calculateCellValue?: (rowData: Object) => string; - /** Specifies a callback function that defines filters for customary calculated grid cells. */ - calculateFilterExpression?: (filterValue: any, selectedFilterOperation: string) => Array; - /** Specifies a caption for a column. */ - caption?: string; - /** Specifies a custom template for grid column cells. */ - cellTemplate?: any; - /** Specifies a CSS class to be applied to a column. */ - cssClass?: string; - /** Specifies a callback function that determines values for column cells to be used for grouping. */ - calculateGroupValue?: any; - /** Specifies a callback function that returns a value or the name of the field to be used for sorting column cells. */ - calculateSortValue?: any; - /** Specifies a callback function that returns the text to be displayed in the cells of a column. */ - customizeText?: (cellInfo: { value: any; valueText: string }) => string; - /** Specifies the field of a data source that provides data for a column. */ - dataField?: string; - /** Specifies the required type of column values. */ - dataType?: string; - /** Specifies a custom template for the cell of a grid column when it is in an editing state. */ - editCellTemplate?: any; - /** Specifies whether HTML tags are displayed as plain text or applied to the values of the column. */ - encodeHtml?: boolean; - /** In a boolean column, replaces all false items with a specified text. */ - falseText?: string; - /** Specifies the set of available filter operations. */ - filterOperations?: Array; - /** Specifies a filter value for a column. */ - filterValue?: any; - /** Specifies initial filter values for the column's header filter. */ - filterValues?: Array; - /** Specifies whether to include or exclude the records with the values selected in the column's header filter. */ - filterType?: string; - /** Indicates whether the column takes part in horizontal grid scrolling or is anchored to a grid edge. */ - fixed?: boolean; - /** Specifies the grid edge to which the column is anchored. */ - fixedPosition?: string; - /** Specifies a format for the values displayed in a column. */ - format?: string; - /** Specifies a custom template for the group cell of a grid column. */ - groupCellTemplate?: any; - /** Specifies the index of a column when grid records are grouped by the values of this column. */ - groupIndex?: number; - /** Specifies a custom template for the header of a grid column. */ - headerCellTemplate?: any; - /** Specifies options of a lookup column. */ - lookup?: { - /** Specifies whether or not a user can nullify values of a lookup column. */ - allowClearing?: boolean; - /** -Specifies the data source providing data for a lookup column. - */ - dataSource?: any; - /** Specifies the expression defining the data source field whose values must be displayed. */ - displayExpr?: any; - /** Specifies the expression defining the data source field whose values must be replaced. */ - valueExpr?: string; - }; - /** Specifies a precision for formatted values displayed in a column. */ - precision?: number; - /** Specifies a filter operation applied to a column. */ - selectedFilterOperation?: string; - /** Specifies whether or not the column displays its values by using editors. */ - showEditorAlways?: boolean; - /** Specifies whether or not to display the column when grid records are grouped by it. */ - showWhenGrouped?: boolean; - /** Specifies the index of a column when grid records are sorted by the values of this column. */ - sortIndex?: number; - /** Specifies the initial sort order of column values. */ - sortOrder?: string; - /** In a boolean column, replaces all true items with a specified text. */ - trueText?: string; - /** Specifies whether a column is visible or not. */ - visible?: boolean; - /** Specifies the sequence number of the column in the grid. */ - visibleIndex?: number; - /** Specifies a column width in pixels or percentages. */ - width?: any; - /** Specifies an array of validation rules to be checked when updating column cell values. */ - validationRules?: Array; - /** Specifies whether or not to display the header of a hidden column in the column chooser. */ - showInColumnChooser?: boolean; - /** Specifies the identifier of the column. */ - name?: string; - } - export interface dxDataGridOptions extends WidgetOptions { - /** Specifies whether the outer borders of the grid are visible or not. */ - showBorders?: boolean; - /** Indicates whether to show the error row for the grid. */ - errorRowEnabled?: boolean; - /** A handler for the rowValidating event. */ - onRowValidating?: (e: Object) => void; - /** A handler for the contextMenuPreparing event. */ - onContextMenuPreparing?: (e: Object) => void; - initNewRow?: (e: { data: Object }) => void; - /** A handler for the initNewRow event. */ - onInitNewRow?: (e: { data: Object }) => void; - rowInserted?: (e: { data: Object; key: any }) => void; - /** A handler for the rowInserted event. */ - onRowInserted?: (e: { data: Object; key: any }) => void; - rowInserting?: (e: { data: Object; cancel: boolean }) => void; - /** A handler for the rowInserting event. */ - onRowInserting?: (e: { data: Object; cancel: boolean }) => void; - rowRemoved?: (e: { data: Object; key: any }) => void; - /** A handler for the rowRemoved event. */ - onRowRemoved?: (e: { data: Object; key: any }) => void; - rowRemoving?: (e: { data: Object; key: any; cancel: boolean }) => void; - /** A handler for the rowRemoving event. */ - onRowRemoving?: (e: { data: Object; key: any; cancel: boolean }) => void; - rowUpdated?: (e: { data: Object; key: any }) => void; - /** A handler for the rowUpdated event. */ - onRowUpdated?: (e: { data: Object; key: any }) => void; - rowUpdating?: (e: { oldData: Object; newData: Object; key: any; cancel: boolean }) => void; - /** A handler for the rowUpdating event. */ - onRowUpdating?: (e: { oldData: Object; newData: Object; key: any; cancel: boolean }) => void; - /** Enables a hint that appears when a user hovers the mouse pointer over a cell with truncated content. */ - cellHintEnabled?: boolean; - /** Specifies whether or not grid columns can be reordered by a user. */ - allowColumnReordering?: boolean; - /** Specifies whether or not grid columns can be resized by a user. */ - allowColumnResizing?: boolean; - cellClick?: any; - /** A handler for the cellClick event. */ - onCellClick?: any; - cellHoverChanged?: (e: Object) => void; - /** A handler for the cellHoverChanged event. */ - onCellHoverChanged?: (e: Object) => void; - cellPrepared?: (e: Object) => void; - /** A handler for the cellPrepared event. */ - onCellPrepared?: (e: Object) => void; - /** Specifies whether or not the width of grid columns depends on column content. */ - columnAutoWidth?: boolean; - /** Specifies the options of a column chooser. */ - columnChooser?: { - /** Specifies text displayed by the column chooser panel when it does not contain any columns. */ - emptyPanelText?: string; - /** Specifies whether a user can invoke the column chooser or not. */ - enabled?: boolean; - /** Specifies the height of the column chooser panel. */ - height?: number; - /** Specifies text displayed in the title of the column chooser panel. */ - title?: string; - /** Specifies the width of the column chooser panel. */ - width?: number; - }; - /** Specifies options for column fixing. */ - columnFixing?: { - /** Indicates if column fixing is enabled. */ - enabled?: boolean; - /** Contains options that specify texts for column-fixing related commands in the column header's context menu. */ - texts?: { - /** Specifies text for a context menu item that fixes the column for which the context menu is invoked. */ - fix?: string; - /** Specifies text for a context menu item that unfixes the column for which the context menu is invoked. */ - unfix?: string; - /** Specifies text for a context menu subitem that fixes a column, for which the context menu is invoked, to the left grid edge. */ - leftPosition?: string; - /** Specifies text for a context menu subitem that fixes a column, for which the context menu is invoked, to the right grid edge. */ - rightPosition?: string; - }; - }; - /** Specifies options for filtering using a column header filter. */ - headerFilter?: { - /** Indicates whether or not the column header filter button is visible. */ - visible?: boolean; - /** Specifies the height of the dropdown menu invoked when using a column header filter. */ - height?: number; - /** Specifies the width of the dropdown menu invoked when using a column header filter. */ - width?: number; - /** Contains options that specify texts for the dropdown menu invoked when you use a column header filter. */ - texts?: { - /** Specifies text for the item specifying an empty value in the column header filter's dropdown menu. */ - emptyValue?: string; - /** Specifies text for a button that closes the column header filter's dropdown menu and applies specified filtering. */ - ok?: string; - /** Specifies text for a button that closes the column header filter's dropdown menu without applying performed selection. */ - cancel?: string; - } - }; - /** -An array of grid columns. - */ - columns?: Array; - onContentReady?: Function; - contentReadyAction?: Function; - /** Specifies a function that customizes grid columns after they are created. */ - customizeColumns?: (columns: Array) => void; - dataErrorOccurred?: (errorObject: Error) => void; - /** Specifies a data source for the grid. */ - dataSource?: any; - editingStart?: (e: { - data: Object; - key: any; - cancel: boolean; - column: dxDataGridColumn - }) => void; - /** A handler for the editingStart event. */ - onEditingStart?: (e: { - data: Object; - key: any; - cancel: boolean; - column: dxDataGridColumn - }) => void; - editorPrepared?: (e: Object) => void; - /** A handler for the editorPrepared event. */ - onEditorPrepared?: (e: Object) => void; - editorPreparing?: (e: Object) => void; - /** A handler for the editorPreparing event. */ - onEditorPreparing?: (e: Object) => void; - /** Contains options that specify how grid content can be changed. */ - editing?: { - /** Specifies whether or not grid records can be edited at runtime. */ - editEnabled?: boolean; - /** Specifies how grid values can be edited manually. */ - editMode?: string; - /** Specifies whether or not new records can be inserted into a grid. */ - insertEnabled?: boolean; - /** Specifies whether or not records can be deleted from a grid. */ - removeEnabled?: boolean; - /** Contains options that specify texts for editing-related grid controls. */ - texts?: { - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Save" button. Setting this option makes sense only when the editMode option is set to batch. */ - saveAllChanges?: string; - /** Specifies text for a cancel button displayed when a row is in the editing state. Setting this option makes sense only when the editEnabled option is set to true. */ - cancelRowChanges?: string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Revert" button. Setting this option makes sense only when the editMode option is set to batch. */ - cancelAllChanges?: string; - /** Specifies a message to be displayed by a confirmation window. Setting this option makes sense only when the edit mode is "row". */ - confirmDeleteMessage?: string; - /** Specifies text to be displayed in the title of a confirmation window. Setting this option makes sense only when the edit mode is "row". */ - confirmDeleteTitle?: string; - /** Specifies text for a button that deletes a row from a grid. Setting this option makes sense only when the removeEnabled option is set to true. */ - deleteRow?: string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Add" button. Setting this option makes sense only when the insertEnabled option is true. */ - addRow?: string; - /** Specifies text for a button that turns a row into the editing state. Setting this option makes sense only when the editEnabled option is set to true. */ - editRow?: string; - /** Specifies text for a save button displayed when a row is in the editing state. Setting this option makes sense only when the editEnabled option is set to true. */ - saveRowChanges?: string; - /** Specifies text for a button that recovers a deleted row. Setting this option makes sense only if the grid uses the batch edit mode and the removeEnabled option is set to true. */ - undeleteRow?: string; - }; - }; - /** Specifies filter row options. */ - filterRow?: { - /** Specifies when to apply a filter. */ - applyFilter?: string; - /** Specifies text for the hint that pops up when a user hovers the mouse pointer over the "Apply Filter" button. */ - applyFilterText?: string; - /** Specifies descriptions for filter operations. */ - operationDescriptions?: { - "=": string; - "<>": string; - "<": string; - "<=": string; - ">": string; - ">=": string; - "startswith": string; - "contains": string; - "notcontains": string; - "endswith": string; - }; - /** Specifies text for the reset operation in a filter list. */ - resetOperationText?: string; - /** Specifies text for the operation of clearing the applied filter when a select box is used. */ - showAllText?: string; - /** Specifies whether or not an icon that allows the user to choose a filter operation is visible. */ - showOperationChooser?: boolean; - /** Specifies whether the filter row is visible or not. */ - visible?: boolean; - }; - /** Specifies the behavior of grouped grid records. */ - grouping?: { - /** Specifies whether the user can collapse grouped records in a grid or not. */ - allowCollapsing?: boolean; - /** Specifies whether groups appear expanded or not. */ - autoExpandAll?: boolean; - /** Specifies the message displayed in a group row when the corresponding group is continued from the previous page. */ - groupContinuedMessage?: string; - /** -Specifies the message displayed in a group row when the corresponding group continues on the next page. - */ - groupContinuesMessage?: string; - }; - /** Specifies options that configure the group panel. */ - groupPanel?: { - /** Specifies whether columns can be dragged onto or from the group panel. */ - allowColumnDragging?: boolean; - /** Specifies text displayed by the group panel when it does not contain any columns. */ - emptyPanelText?: string; - /** Specifies whether the group panel is visible or not. */ - visible?: boolean; - }; - /** Specifies options configuring the load panel. */ - loadPanel?: { - /** Specifies whether to show the load panel or not. */ - enabled?: boolean; - /** Specifies the height of the load panel in pixels. */ - height?: number; - /** Specifies a URL pointing to an image to be used as a loading indicator. */ - indicatorSrc?: string; - /** Specifies whether or not a loading indicator must be displayed on the load panel. */ - showIndicator?: boolean; - /** Specifies whether or not the pane of the load panel must be displayed. */ - showPane?: boolean; - /** Specifies text displayed by the load panel. */ - text?: string; - /** Specifies the width of the load panel in pixels. */ - width?: number; - }; - /** Specifies text displayed when a grid does not contain any records. */ - noDataText?: string; - /** Specifies the options of a grid pager. */ - pager?: { - /** Specifies the page sizes that can be selected at runtime. */ - allowedPageSizes?: any; - /** Specifies whether to show the page size selector or not. */ - showPageSizeSelector?: boolean; - /** Specifies whether to show the pager or not. */ - visible?: any; - /** Specifies the text accompanying the page navigator. */ - infoText?: string; - /** Specifies whether or not to display the text accompanying the page navigator. This text is specified by the infoText option. */ - showInfo?: boolean; - /** Specifies whether or not to display buttons that switch the grid to the previous or next page. */ - showNavigationButtons?: boolean; - }; - /** Specifies paging options. */ - paging?: { - /** Specifies whether dxDataGrid loads data page by page or all at once. */ - enabled?: boolean; - /** Specifies the grid page that should be displayed by default. */ - pageIndex?: number; - /** Specifies the size of grid pages. */ - pageSize?: number; - }; - /** Specifies whether or not grid rows must be shaded in a different way. */ - rowAlternationEnabled?: boolean; - rowClick?: any; - /** A handler for the rowClick event. */ - onRowClick?: any; - rowPrepared?: (e: Object) => void; - /** A handler for the rowPrepared event. */ - onRowPrepared?: (e: Object) => void; - /** Specifies a custom template for grid rows. */ - rowTemplate?: any; - /** A configuration object specifying scrolling options. */ - scrolling?: { - /** Specifies the scrolling mode. */ - mode?: string; - /** Specifies whether or not a grid must preload pages adjacent to the current page when using virtual scrolling. */ - preloadEnabled?: boolean; - }; - /** Specifies options of the search panel. */ - searchPanel?: { - /** Specifies whether or not search strings in the located grid records should be highlighted. */ - highlightSearchText?: boolean; - /** Specifies text displayed by the search panel when no search string was typed. */ - placeholder?: string; - /** Specifies whether the search panel is visible or not. */ - visible?: boolean; - /** Specifies the width of the search panel in pixels. */ - width?: number; - /** Sets a search string for the search panel. */ - text?: string; - }; - /** Specifies the operations that must be performed on the server side. */ - remoteOperations?: any; - /** Allows you to sort groups according to the values of group summary items. */ - sortByGroupSummaryInfo?: Array<{ - /** Specifies the group summary item whose values must be used to sort groups. */ - summaryItem?: string; - /** Specifies the identifier of the column that must be used in grouping so that sorting by group summary item values be applied. */ - groupColumn?: string; - /** Specifies the sort order of group summary item values. */ - sortOrder?: string; - }>; - /** Allows you to build a master-detail interface in the grid. */ - masterDetail?: { - /** Enables an end-user to expand/collapse detail sections. */ - enabled?: boolean; - /** Specifies whether detail sections appear expanded or collapsed. */ - autoExpandAll?: boolean; - /** Specifies the template for detail sections. */ - template?: any; - }; - /** Specifies options for exporting grid data. */ - export?: { - /** Indicates if the export feature is enabled in the grid. */ - enabled?: boolean; - /** Specifies a default name for the file to which grid data is exported. */ - fileName?: string; - /** Specifies whether to enable Excel filtering for the exported data in the resulting XLSX file. */ - excelFilterEnabled?: boolean; - /** Specifies whether to enable word wrapping for the exported data in the resulting XLSX file. */ - excelWrapTextEnabled?: boolean; - /** Specifies the URL of the server-side proxy that streams the resulting file to the end user to enable export in IE8, IE9 and Safari browsers. */ - proxyUrl?: string; - /** Indicates whether to allow end users to export not only the data displayed in the grid, but the selected rows only. */ - allowExportSelectedData?: boolean; - /** Contains options that specify texts for the export-related commands and hints. */ - texts?: { - /** Specifies text for the Export button when this button invokes a dropdown menu so you can choose the required export format. */ - exportTo?: string; - /** Specifies text for the Export button when this button exports to the XSLX format. */ - exportToExcel?: string; - /** Specifies text for the item in the Export dropdown menu that exports grid data to Excel. */ - excelFormat?: string; - /** Specifies text for the option in the Export dropdown menu that allows you to choose whether to export all the grid data or the selected rows only. */ - selectedRows?: string; - } - }; - /** Specifies the keys of the records that must appear selected initially. */ - selectedRowKeys?: Array; - /** Specifies options of runtime selection. */ - selection?: { - /** Specifies whether the user can select all grid records at once. */ - allowSelectAll?: boolean; - /** Specifies the selection mode. */ - mode?: string; - }; - selectionChanged?: (e: { - currentSelectedRowKeys: Array; - currentDeselectedRowKeys: Array; - selectedRowKeys: Array; - selectedRowsData: Array; - }) => void; - /** A handler for the dataErrorOccured event. */ - onDataErrorOccurred?: (e: { error: Error }) => void; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: (e: { - currentSelectedRowKeys: Array; - currentDeselectedRowKeys: Array; - selectedRowKeys: Array; - selectedRowsData: Array; - }) => void; - /** A handler for the exporting event. */ - onExporting?: (e: { - fileName: string; - format: string; - cancel: boolean; - }) => void; - /** A handler for the exported event. */ - onExported?: (e: Object) => void; - /** A handler for the keyDown event. */ - onKeyDown?: (e: Object) => void; - /** A handler for the rowExpanding event. */ - onRowExpanding?: (e: Object) => void; - /** A handler for the rowExpanded event. */ - onRowExpanded?: (e: Object) => void; - /** A handler for the rowCollapsing event. */ - onRowCollapsing?: (e: Object) => void; - /** A handler for the rowCollapsed event. */ - onRowCollapsed?: (e: Object) => void; - /** Specifies whether column headers are visible or not. */ - showColumnHeaders?: boolean; - /** Specifies whether or not vertical lines separating one grid column from another are visible. */ - showColumnLines?: boolean; - /** Specifies whether or not horizontal lines separating one grid row from another are visible. */ - showRowLines?: boolean; - /** Specifies options of runtime sorting. */ - sorting?: { - /** Specifies text for the context menu item that sets an ascending sort order in a column. */ - ascendingText?: string; - /** Specifies text for the context menu item that resets sorting settings for a column. */ - clearText?: string; - /** Specifies text for the context menu item that sets a descending sort order in a column. */ - descendingText?: string; - /** Specifies the runtime sorting mode. */ - mode?: string; - }; - /** Specifies options of state storing. */ - stateStoring?: { - /** Specifies a callback function that performs specific actions on state loading. */ - customLoad?: () => JQueryPromise; - /** Specifies a callback function that performs specific actions on state saving. */ - customSave?: (gridState: Object) => void; - /** Specifies whether or not a grid saves its state. */ - enabled?: boolean; - /** Specifies the delay between the last change of a grid state and the operation of saving this state in milliseconds. */ - savingTimeout?: number; - /** Specifies a unique key to be used for storing the grid state. */ - storageKey?: string; - /** Specifies the type of storage to be used for state storing. */ - type?: string; - }; - /** Specifies the options of the grid summary. */ - summary?: { - /** Contains options that specify text patterns for summary items. */ - texts?: { - /** Specifies a pattern for the 'sum' summary items when they are displayed in the parent column. */ - sum?: string; - /** Specifies a pattern for the 'sum' summary items displayed in a group row or in any other column rather than the parent one. */ - sumOtherColumn?: string; - /** Specifies a pattern for the 'min' summary items when they are displayed in the parent column. */ - min?: string; - /** Specifies a pattern for the 'min' summary items displayed in a group row or in any other column rather than the parent one. */ - minOtherColumn?: string; - /** Specifies a pattern for the 'max' summary items when they are displayed in the parent column. */ - max?: string; - /** Specifies a pattern for the 'max' summary items displayed in a group row or in any other column rather than the parent one. */ - maxOtherColumn?: string; - /** Specifies a pattern for the 'avg' summary items when they are displayed in the parent column. */ - avg?: string; - /** Specifies a pattern for the 'avg' summary items displayed in a group row or in any other column rather than the parent one. */ - avgOtherColumn?: string; - /** Specifies a pattern for the 'count' summary items. */ - count?: string; - }; - /** Specifies items of the group summary. */ - groupItems?: Array<{ - /** Specifies the identifier of a summary item. */ - name?: string; - /** Specifies the column that provides data for a group summary item. */ - column?: string; - /** Customizes the text to be displayed in the summary item. */ - customizeText?: (itemInfo: { - value: any; - valueText: string; - }) => string; - /** Specifies a pattern for the summary item text. */ - displayFormat?: string; - /** Specifies a precision for the summary item value of a numeric format. */ - precision?: number; - /** Specifies whether or not a summary item must be displayed in the group footer. */ - showInGroupFooter?: boolean; - /** Indicates whether to display group summary items in brackets of the group row header or to align them by the corresponding columns within the group row. */ - alignByColumn?: boolean; - /** Specifies the column that must hold the summary item when this item is displayed in the group footer or aligned by a column in the group row. */ - showInColumn?: string; - /** Specifies how to aggregate data for a summary item. */ - summaryType?: string; - /** Specifies a format for the summary item value. */ - valueFormat?: string; - }>; - /** Specifies items of the total summary. */ - totalItems?: Array<{ - /** Specifies the identifier of a summary item. */ - name?: string; - /** Specifies the alignment of a summary item. */ - alignment?: string; - /** Specifies the column that provides data for a summary item. */ - column?: string; - /** Specifies a CSS class to be applied to a summary item. */ - cssClass?: string; - /** Customizes the text to be displayed in the summary item. */ - customizeText?: (itemInfo: { - value: any; - valueText: string; - }) => string; - /** Specifies a pattern for the summary item text. */ - displayFormat?: string; - /** Specifies a precision for the summary item value of a numeric format. */ - precision?: number; - /** Specifies the column that must hold the summary item. */ - showInColumn?: string; - /** Specifies how to aggregate data for a summary item. */ - summaryType?: string; - /** Specifies a format for the summary item value. */ - valueFormat?: string; - }>; - /** Allows you to use a custom aggregate function to calculate the value of a summary item. */ - calculateCustomSummary?: (options: { - component: dxDataGrid; - name?: string; - value: any; - totalValue: any; - summaryProcess: string - }) => void; - }; - /** Specifies whether text that does not fit into a column should be wrapped. */ - wordWrapEnabled?: boolean; - } - /** A data grid widget. */ - export class dxDataGrid extends Widget { - constructor(element: JQuery, options?: dxDataGridOptions); - constructor(element: Element, options?: dxDataGridOptions); - /** Ungroups grid records. */ - clearGrouping(): void; - /** Clears sorting settings of all grid columns at once. */ - clearSorting(): void; - /** Allows you to obtain a cell by its row index and the data field of its column. */ - getCellElement(rowIndex: number, dataField: string): any; - /** Allows you to obtain a cell by its row index and the visible index of its column. */ - getCellElement(rowIndex: number, visibleColumnIndex: number): any; - /** Returns the current state of the grid. */ - state(): Object; - /** Sets the grid state. */ - state(state: Object): void; - /** Allows you to obtain the row index by a data key. */ - getRowIndexByKey(key: any): number; - /** Allows you to obtain the data key by a row index. */ - getKeyByRowIndex(rowIndex: number): any; - /** Adds a new column to a grid. */ - addColumn(columnOptions: dxDataGridColumn): void; - /** Displays the load panel. */ - beginCustomLoading(messageText: string): void; - /** Discards changes made in a grid. */ - cancelEditData(): void; - /** Clears all the filters of a specific type applied to grid records. */ - clearFilter(): void; - /** Deselects all grid records. */ - clearSelection(): void; - /** Draws the cell being edited from the editing state. Use this method when the edit mode is batch. */ - closeEditCell(): void; - /** Collapses groups or master rows in a grid. */ - collapseAll(groupIndex?: number): void; - /** Returns the number of data columns in a grid. */ - columnCount(): number; - /** Returns the value of a specific column option. */ - columnOption(id: number, optionName: string): any; - /** Sets an option of a specific column. */ - columnOption(id: number, optionName: string, optionValue: any): void; - /** Returns the options of a column by an identifier. */ - columnOption(id: any): Object; - /** Sets several options of a column at once. */ - columnOption(id: any, options: Object): void; - /** Sets a specific cell into the editing state. */ - editCell(rowIndex: number, columnIndex: number): void; - /** Sets a specific row into the editing state. */ - editRow(rowIndex: number): void; - /** Hides the load panel. */ - endCustomLoading(): void; - /** Expands groups or master rows in a grid. */ - expandAll(groupIndex: number): void; - /** Allows you to find out whether a specific group or master row is expanded or collapsed. */ - isRowExpanded(key: any): boolean; - /** Allows you to expand a specific group or master row by its key. */ - expandRow(key: any): void; - /** Allows you to collapse a specific group or master row by its key. */ - collapseRow(key: any): void; - /** Applies a filter to the grid's data source. */ - filter(filterExpr?: any): void; - /** Returns a filter expression applied to the grid's data source using the filter(filterExpr) method. */ - filter(): any; - /** Returns a filter expression applied to the grid using all possible scenarious. */ - getCombinedFilter(): any; - /** Gets the keys of currently selected grid records. */ - getSelectedRowKeys(): Array; - /** Gets the data objects of currently selected grid records. */ - getSelectedRowsData(): Array; - /** Hides the column chooser panel. */ - hideColumnChooser(): void; - /** Adds a new data row to a grid. */ - insertRow(): void; - /** Returns the key corresponding to the passed data object. */ - keyOf(obj: Object): any; - /** Switches a grid to a specified page. */ - pageIndex(newIndex: number): void; - /** Gets the index of the current page. */ - pageIndex(): number; - /** Sets the page size. */ - pageSize(value: number): void; - /** Gets the current page size. */ - pageSize(): number; - /** Refreshes grid data. */ - refresh(): void; - /** Removes a specific row from a grid. */ - removeRow(rowIndex: number): void; - /** Saves changes made in a grid. */ - saveEditData(): void; - /** -Searches grid records by a search string. - */ - searchByText(text: string): void; - /** Selects all grid records. */ - selectAll(): void; - /** Deselects the rows that are currently selected within the applied filter. */ - deselectAll(): void; - /** Selects specific grid records. */ - selectRows(keys: Array, preserve: boolean): void; - /** Deselects specific grid records. */ - deselectRows(keys: Array): void; - /** Selects grid rows by indexes. */ - selectRowsByIndexes(indexes: Array): void; - /** Allows you to find out whether a row is selected or not. */ - isRowSelected(key: any): boolean; - /** Invokes the column chooser panel. */ - showColumnChooser(): void; - startSelectionWithCheckboxes(): boolean; - /** Returns the number of records currently held by a grid. */ - totalCount(): number; - /** Recovers a row deleted in the batch edit mode. */ - undeleteRow(rowIndex: number): void; - /** Allows you to obtain a data object by its key. */ - byKey(key: any): JQueryPromise; - /** Gets the value of a total summary item. */ - getTotalSummaryValue(summaryItemName: string): any; - /** Exports grid data to Excel. */ - exportToExcel(selectionOnly: boolean): void; - /** Updates the grid to the size of its content. */ - updateDimensions(): void; - /** Focuses the specified cell element in the grid. */ - focus(element?: JQuery): void; - } - export interface dxPivotGridOptions extends WidgetOptions { - onContentReady?: Function; - /** Specifies a data source for the pivot grid. */ - dataSource?: any; - /** Specifies whether or not the widget uses native scrolling. */ - useNativeScrolling?: any; - /** Allows an end-user to change sorting options. */ - allowSorting?: boolean; - /** Allows an end-user to sort columns by summary values. */ - allowSortingBySummary?: boolean; - /** Allows an end-user to change filtering options. */ - allowFiltering?: boolean; - /** Allows an end-user to expand/collapse all header items within a header level. */ - allowExpandAll?: boolean; - /** Specifies whether to display the Total rows. */ - showRowTotals?: boolean; - /** Specifies whether to display the Grand Total row. */ - showRowGrandTotals?: boolean; - /** Specifies whether to display the Total columns. */ - showColumnTotals?: boolean; - /** Specifies whether to display the Grand Total column. */ - showColumnGrandTotals?: boolean; - /** The Field Chooser configuration options. */ - fieldChooser?: { - /** Enables or disables the field chooser. */ - enabled?: boolean; - /** Specifies the field chooser layout. */ - layout?: number; - /** Specifies the text to display as a title of the field chooser popup window. */ - title?: string; - /** Specifies the field chooser width. */ - width?: number; - /** Specifies the field chooser height. */ - height?: number; - /** Strings that can be changed or localized in the pivot grid's integrated Field Chooser. */ - texts?: { - /** The string to display instead of Row Fields. */ - rowFields?: string; - /** The string to display instead of Column Fields. */ - columnFields?: string; - /** The string to display instead of Data Fields. */ - dataFields?: string; - /** The string to display instead of Filter Fields. */ - filterFields?: string; - /** The string to display instead of All Fields. */ - allFields?: string; - }; - } - /** Strings that can be changed or localized in the dxPivotGrid widget. */ - texts?: { - /** The string to display as a header of the Grand Total row and column. */ - grandTotal?: string; - /** The string to display as a header of the Total row and column. */ - total?: string; - /** Specifies the text displayed when a pivot grid does not contain any fields. */ - noData?: string; - /** The string to display as a Show Field Chooser context menu item. */ - showFieldChooser?: string; - /** The string to display as an Expand All context menu item. */ - expandAll?: string; - /** The string to display as a Collapse All context menu item. */ - collapseAll?: string; - /** The string to display as a Sort Column by Summary Value context menu item. */ - sortColumnBySummary?: string; - /** The string to display as a Sort Row by Summary Value context menu item. */ - sortRowBySummary?: string; - /** The string to display as a Remove All Sorting context menu item. */ - removeAllSorting?: string; - }; - /** The Load panel configuration options. */ - loadPanel?: { - /** Enables or disables the load panel. */ - enabled?: boolean; - /** Specifies the height of the load panel. */ - height?: number; - /** Specifies the URL pointing to an image that will be used as a load indicator. */ - indicatorSrc?: string; - /** Specifies whether or not to show a load indicator. */ - showIndicator?: boolean; - /** Specifies whether or not to show load panel background. */ - showPane?: boolean; - /** Specifies the text to display inside a load panel. */ - text?: string; - /** Specifies the width of the load panel. */ - width?: number; - }; - /** A handler for the cellClick event. */ - onCellClick?: (e: any) => void; - /** A handler for the cellPrepared event. */ - onCellPrepared?: (e: any) => void; - /** A handler for the contextMenuPreparing event. */ - onContextMenuPreparing?: (e: Object) => void; - } - /** A data summarization widget for multi-dimensional data analysis and data mining. */ - export class dxPivotGrid extends Widget { - constructor(element: JQuery, options?: dxPivotGridOptions); - constructor(element: Element, options?: dxPivotGridOptions); - /** Gets the PivotGridDataSource instance. */ - getDataSource(): DevExpress.data.PivotGridDataSource; - /** Updates the widget to the size of its content. */ - updateDimensions(): void; - } - export interface dxPivotGridFieldChooserOptions extends WidgetOptions { - /** Specifies the field chooser layout. */ - layout?: number; - /** The data source of a dxPivotGrid widget. */ - dataSource?: DevExpress.data.PivotGridDataSource; - onContentReady?: Function; - /** Strings that can be changed or localized in the dxPivotGridFieldChooser widget. */ - texts?: { - /** The string to display instead of Row Fields. */ - rowFields?: string; - /** The string to display instead of Column Fields. */ - columnFields?: string; - /** The string to display instead of Data Fields. */ - dataFields?: string; - /** The string to display instead of Filter Fields. */ - filterFields?: string; - /** The string to display instead of All Fields. */ - allFields?: string; - }; - } - /** A complementary widget for dxPivotGrid that allows you to manage data displayed in the dxPivotGrid. */ - export class dxPivotGridFieldChooser extends Widget { - constructor(element: JQuery, options?: dxPivotGridFieldChooserOptions); - constructor(element: Element, options?: dxPivotGridFieldChooserOptions); - /** Updates the widget to the size of its content. */ - updateDimensions(): void; - } -} -interface JQuery { - dxTreeView(): JQuery; - dxTreeView(options: "instance"): DevExpress.ui.dxTreeView; - dxTreeView(options: string): any; - dxTreeView(options: string, ...params: any[]): any; - dxTreeView(options: DevExpress.ui.dxTreeViewOptions): JQuery; - dxMenuBase(): JQuery; - dxMenuBase(options: "instance"): DevExpress.ui.dxMenuBase; - dxMenuBase(options: string): any; - dxMenuBase(options: string, ...params: any[]): any; - dxMenuBase(options: DevExpress.ui.dxMenuBaseOptions): JQuery; - dxMenu(): JQuery; - dxMenu(options: "instance"): DevExpress.ui.dxMenu; - dxMenu(options: string): any; - dxMenu(options: string, ...params: any[]): any; - dxMenu(options: DevExpress.ui.dxMenuOptions): JQuery; - dxContextMenu(): JQuery; - dxContextMenu(options: "instance"): DevExpress.ui.dxContextMenu; - dxContextMenu(options: string): any; - dxContextMenu(options: string, ...params: any[]): any; - dxContextMenu(options: DevExpress.ui.dxContextMenuOptions): JQuery; - dxColorBox(): JQuery; - dxColorBox(options: "instance"): DevExpress.ui.dxColorBox; - dxColorBox(options: string): any; - dxColorBox(options: string, ...params: any[]): any; - dxColorBox(options: DevExpress.ui.dxColorBoxOptions): JQuery; - dxDataGrid(): JQuery; - dxDataGrid(options: "instance"): DevExpress.ui.dxDataGrid; - dxDataGrid(options: string): any; - dxDataGrid(options: string, ...params: any[]): any; - dxDataGrid(options: DevExpress.ui.dxDataGridOptions): JQuery; - dxPivotGrid(): JQuery; - dxPivotGrid(options: "instance"): DevExpress.ui.dxPivotGrid; - dxPivotGrid(options: string): any; - dxPivotGrid(options: string, ...params: any[]): any; - dxPivotGrid(options: DevExpress.ui.dxPivotGridOptions): JQuery; - dxPivotGridFieldChooser(): JQuery; - dxPivotGridFieldChooser(options: "instance"): DevExpress.ui.dxPivotGridFieldChooser; - dxPivotGridFieldChooser(options: string): any; - dxPivotGridFieldChooser(options: string, ...params: any[]): any; - dxPivotGridFieldChooser(options: DevExpress.ui.dxPivotGridFieldChooserOptions): JQuery; - dxScheduler(): JQuery; - dxScheduler(options: "instance"): DevExpress.ui.dxScheduler; - dxScheduler(options: string): any; - dxScheduler(options: string, ...params: any[]): any; - dxScheduler(options: DevExpress.ui.dxSchedulerOptions): JQuery; -} -declare namespace DevExpress.framework { - /** An object used to store information on the views displayed in an application. */ - export class ViewCache { - viewRemoved: JQueryCallback; - /** Removes all the viewInfo objects from the cache. */ - clear(): void; - /** Obtains a viewInfo object from the cache by the specified key. */ - getView(key: string): Object; - /** Checks whether or not a viewInfo object is contained in the view cache under the specified key. */ - hasView(key: string): boolean; - /** Removes a viewInfo object from the cache by the specified key. */ - removeView(key: string): Object; - /** Adds the specified viewInfo object to the cache under the specified key. */ - setView(key: string, viewInfo: Object): void; - } - export interface dxCommandOptions extends DOMComponentOptions { - action?: any; - /** Specifies an action performed when the execute() method of the command is called. */ - onExecute?: any; - /** Indicates whether or not the widget that displays this command is disabled. */ - disabled?: boolean; - /** Specifies the name of the icon shown inside the widget associated with this command. */ - icon?: string; - iconSrc?: string; - /** The identifier of the command. */ - id?: string; - /** Specifies the title of the widget associated with this command. */ - title?: string; - /** Specifies the type of the button, if the command is rendered as a dxButton widget. */ - type?: string; - /** A Boolean value specifying whether or not the widget associated with this command is visible. */ - visible?: boolean; - } - /** A markup component used to define markup options for a command. */ - export class dxCommand extends DOMComponent { - constructor(element: JQuery, options: dxCommandOptions); - constructor(options: dxCommandOptions); - /** Executes the action associated with this command. */ - execute(): void; - } - /** An object responsible for routing. */ - export class Router { - /** Adds a routing rule to the list of registered rules. */ - register(pattern: string, defaults?: Object, constraints?: Object): void; - /** Decodes the specified URI to an object using the registered routing rules. */ - parse(uri: string): Object; - /** Formats an object to a URI. */ - format(obj: Object): string; - } - export interface StateManagerOptions { - /** A storage to which the state manager saves the application state. */ - storage?: Object; - } - /** An object used to store the current application state. */ - export class StateManager { - constructor(options?: StateManagerOptions); - /** Adds an object that implements an interface of a state source to the state manager's collection of state sources. */ - addStateSource(stateSource: Object): void; - /** Removes a specified state source from the state manager's collection of state sources. */ - removeStateSource(stateSource: Object): void; - /** Saves the current application state. */ - saveState(): void; - /** Restores the application state that has been saved by the saveState() method to the state storage. */ - restoreState(): void; - /** Removes the application state that has been saved by the saveState() method to the state storage. */ - clearState(): void; - } - export module html { - export var layoutSets: Array; - export var animationSets: { [animationSetName: string]: AnimationSet }; - export interface AnimationSet { - [animationName: string]: any - } - export interface HtmlApplicationOptions { - /** Specifies where the commands that are defined in the application's views must be displayed. */ - commandMapping?: Object; - /** Specifies whether or not view caching is disabled. */ - disableViewCache?: boolean; - /** An array of layout controllers that should be used to show application views in the current navigation context. */ - layoutSet?: any; - /** Specifies the animation presets that are used to animate different UI elements in the current application. */ - animationSet?: AnimationSet; - /** Specifies whether the current application must behave as a mobile or web application. */ - mode?: string; - /** Specifies the object that represents a root namespace of the application. */ - namespace?: Object; - /** Specifies application behavior when the user navigates to a root view. */ - navigateToRootViewMode?: string; - /** An array of dxCommand configuration objects used to define commands available from the application's global navigation. */ - navigation?: Array; - /** A state manager to be used in the application. */ - stateManager?: StateManager; - /** Specifies the storage to be used by the application's state manager to store the application state. */ - stateStorage?: Object; - /** Indicates whether on not to use the title of the previously displayed view as text on the Back button. */ - useViewTitleAsBackText?: boolean; - /** A custom view cache to be used in the application. */ - viewCache?: Object; - /** Specifies a limit for the views that can be cached. */ - viewCacheSize?: number; - /** Specifies options for the viewport meta tag of a mobile browser. */ - viewPort?: JQuery; - /** A custom router to be used in the application. */ - router?: Router; - } - /** An object used to manage views, as well as control the application life cycle. */ - export class HtmlApplication implements EventsMixin { - constructor(options: HtmlApplicationOptions); - afterViewSetup: JQueryCallback; - beforeViewSetup: JQueryCallback; - initialized: JQueryCallback; - navigating: JQueryCallback; - navigatingBack: JQueryCallback; - resolveLayoutController: JQueryCallback; - viewDisposed: JQueryCallback; - viewDisposing: JQueryCallback; - viewHidden: JQueryCallback; - viewRendered: JQueryCallback; - viewShowing: JQueryCallback; - viewShown: JQueryCallback; - /** Provides access to the ViewCache object. */ - viewCache: ViewCache; - /** An array of dxCommand components that are created based on the application's navigation option value. */ - navigation: Array; - /** Provides access to the StateManager object. */ - stateManager: StateManager; - /** Provides access to the Router object. */ - router: Router; - /** Navigates to the URI preceding the current one in the navigation history. */ - back(): void; - /** Returns a Boolean value indicating whether or not backwards navigation is currently possible. */ - canBack(): boolean; - /** Calls the clearState() method of the application's StateManager object. */ - clearState(): void; - /** Creates global navigation commands. */ - createNavigation(navigationConfig: Array): void; - /** Returns an HTML template of the specified view. */ - getViewTemplate(viewName: string): JQuery; - /** Returns a configuration object used to create a dxView component for a specified view. */ - getViewTemplateInfo(viewName: string): Object; - /** Adds a specified HTML template to a collection of view or layout templates. */ - loadTemplates(source: any): JQueryPromise; - /** Navigates to the specified URI. */ - navigate(uri?: any, options?: Object): void; - /** Renders navigation commands to the navigation command containers that are located in the layouts used in the application. */ - renderNavigation(): void; - /** Calls the restoreState() method of the application's StateManager object. */ - restoreState(): void; - /** Calls the saveState method of the application's StateManager object. */ - saveState(): void; - /** Provides access to the object that defines the current context to be considered when choosing an appropriate template for a view. */ - templateContext(): Object; - on(eventName: "initialized", eventHandler: () => void): HtmlApplication; - on(eventName: "afterViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "beforeViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "navigating", eventHandler: (e: { - currentUri: string; - uri: string; - cancel: boolean; - options: { - root: boolean; - target: string; - direction: string; - rootInDetailPane: boolean; - modal: boolean; - }; - }) => void): HtmlApplication; - on(eventName: "navigatingBack", eventHandler: (e: { - cancel: boolean; - isHardwareButton: boolean; - }) => void): HtmlApplication; - on(eventName: "resolveLayoutController", eventHandler: (e: { - viewInfo: Object; - layoutController: Object; - availableLayoutControllers: Array; - }) => void): HtmlApplication; - on(eventName: "viewDisposed", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewDisposing", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewHidden", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewRendered", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewShowing", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - on(eventName: "viewShown", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - on(eventName: string, eventHandler: Function): HtmlApplication; - on(events: { [eventName: string]: Function; }): HtmlApplication; - off(eventName: "initialized"): HtmlApplication; - off(eventName: "afterViewSetup"): HtmlApplication; - off(eventName: "beforeViewSetup"): HtmlApplication; - off(eventName: "navigating"): HtmlApplication; - off(eventName: "navigatingBack"): HtmlApplication; - off(eventName: "resolveLayoutController"): HtmlApplication; - off(eventName: "viewDisposed"): HtmlApplication; - off(eventName: "viewDisposing"): HtmlApplication; - off(eventName: "viewHidden"): HtmlApplication; - off(eventName: "viewRendered"): HtmlApplication; - off(eventName: "viewShowing"): HtmlApplication; - off(eventName: "viewShown"): HtmlApplication; - off(eventName: string): HtmlApplication; - off(eventName: "initialized", eventHandler: () => void): HtmlApplication; - off(eventName: "afterViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "beforeViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "navigating", eventHandler: (e: { - currentUri: string; - uri: string; - cancel: boolean; - options: { - root: boolean; - target: string; - direction: string; - rootInDetailPane: boolean; - modal: boolean; - }; - }) => void): HtmlApplication; - off(eventName: "navigatingBack", eventHandler: (e: { - cancel: boolean; - isHardwareButton: boolean; - }) => void): HtmlApplication; - off(eventName: "resolveLayoutController", eventHandler: (e: { - viewInfo: Object; - layoutController: Object; - availableLayoutControllers: Array; - }) => void): HtmlApplication; - off(eventName: "viewDisposed", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewDisposing", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewHidden", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewRendered", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewShowing", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - off(eventName: "viewShown", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - off(eventName: string, eventHandler: Function): HtmlApplication; - } - } -} -declare namespace DevExpress.viz.core { - export interface Border { - /** Sets a border color for a selected series. */ - color?: string; - /** Sets border visibility for a selected series. */ - visible?: boolean; - /** Sets a border width for a selected series. */ - width?: number; - } - export interface DashedBorder extends Border { - /** Specifies a dash style for the border of a selected series point. */ - dashStyle?: string; - } - export interface DashedBorderWithOpacity extends DashedBorder { - /** Specifies the opacity of the tooltip's border. */ - opacity?: number; - } - export interface Font { - /** Specifies the font color for a strip label. */ - color?: string; - /** Specifies the font family for a strip label. */ - family?: string; - /** Specifies the font opacity for a strip label. */ - opacity?: number; - /** Specifies the font size for a strip label. */ - size?: any; - /** Specifies the font weight for the text displayed in strips. */ - weight?: number; - } - export interface Hatching { - /** Specifies how to apply hatching to highlight a selected series. */ - direction?: string; - /** Specifies the opacity of hatching lines. */ - opacity?: number; - /** Specifies the distance between hatching lines in pixels. */ - step?: number; - /** Specifies the width of hatching lines in pixels. */ - width?: number; - } - export interface Margins { - /** Specifies the legend's bottom margin in pixels. */ - bottom?: number; - /** Specifies the legend's left margin in pixels. */ - left?: number; - /** Specifies the legend's right margin in pixels. */ - right?: number; - /** Specifies the legend's bottom margin in pixels. */ - top?: number; - } - export interface Size { - /** Specifies the width of the widget. */ - width?: number; - /** Specifies the height of the widget. */ - height?: number; - } - export interface Tooltip { - /** Specifies the length of the tooltip's arrow in pixels. */ - arrowLength?: number; - /** Specifies the appearance of the tooltip's border. */ - border?: viz.core.DashedBorderWithOpacity; - /** Specifies a color for the tooltip. */ - color?: string; - /** Specifies the z-index for tooltips. */ - zIndex?: number; - /** Specifies text and appearance of a set of tooltips. */ - customizeTooltip?: (arg: Object) => { color?: string; text?: string }; - /** Specifies whether or not the tooltip is enabled. */ - enabled?: boolean; - /** Specifies font options for the text displayed by the tooltip. */ - font?: Font; - /** Specifies a format for the text displayed by the tooltip. */ - format?: string; - /** Specifies the opacity of a tooltip. */ - opacity?: number; - /** Specifies a distance from the tooltip's left/right boundaries to the inner text in pixels. */ - paddingLeftRight?: number; - /** Specifies a distance from the tooltip's top/bottom boundaries to the inner text in pixels. */ - paddingTopBottom?: number; - /** Specifies a precision for formatted values displayed by the tooltip. */ - precision?: number; - /** Specifies options of the tooltip's shadow. */ - shadow?: { - /** Specifies the blur distance of the tooltip's shadow. */ - blur?: number; - /** Specifies the color of the tooltip's shadow. */ - color?: string; - /** Specifies the horizontal offset of the tooltip's shadow relative to the tooltip in pixels. */ - offsetX?: number; - /** Specifies the vertical offset of the tooltip's shadow relative to the tooltip in pixels. */ - offsetY?: number; - /** Specifies the opacity of the tooltip's shadow. */ - opacity?: number; - }; - } - export interface Animation { - /** Determines how long animation runs. */ - duration?: number; - /** Specifies the animation easing mode. */ - easing?: string; - /** Indicates whether or not animation is enabled. */ - enabled?: boolean; - } - export interface LoadingIndicator { - /** Specifies a color for the loading indicator background. */ - backgroundColor?: string; - /** Specifies font options for the loading indicator text. */ - font?: viz.core.Font; - /** Specifies whether to show the loading indicator or not. */ - show?: boolean; - /** Specifies a text to be displayed by the loading indicator. */ - text?: string; - } - export interface LegendBorder extends viz.core.DashedBorderWithOpacity { - /** Specifies a radius for the corners of the legend border. */ - cornerRadius?: number; - } - export interface BaseLegend { - /** Specifies the color of the legend's background. */ - backgroundColor?: string; - /** Specifies legend border settings. */ - border?: viz.core.LegendBorder; - /** Specifies how many columns must be taken to arrange legend items. */ - columnCount?: number; - /** Specifies the spacing between a pair of neighboring legend columns in pixels. */ - columnItemSpacing?: number; - /** Specifies font options for legend items. */ - font?: viz.core.Font; - /** Specifies the legend's position on the map. */ - horizontalAlignment?: string; - /** Specifies the alignment of legend items. */ - itemsAlignment?: string; - /** Specifies the position of text relative to the item marker. */ - itemTextPosition?: string; - /** Specifies the distance between the legend and the container borders in pixels. */ - margin?: viz.core.Margins; - /** Specifies the size of item markers in the legend in pixels. */ - markerSize?: number; - /** Specifies whether to arrange legend items horizontally or vertically. */ - orientation?: string; - /** Specifies the spacing between the legend left/right border and legend items in pixels. */ - paddingLeftRight?: number; - /** Specifies the spacing between the legend top/bottom border and legend items in pixels. */ - paddingTopBottom?: number; - /** Specifies how many rows must be taken to arrange legend items. */ - rowCount?: number; - /** Specifies the spacing between a pair of neighboring legend rows in pixels. */ - rowItemSpacing?: number; - /** Specifies the legend's position on the map. */ - verticalAlignment?: string; - /** Specifies whether or not the legend is visible on the map. */ - visible?: boolean; - } - export interface BaseWidgetOptions { - drawn?: (widget: Object) => void; - /** A handler for the drawn event. */ - onDrawn?: (e: { - component: BaseWidget; - element: Element; - }) => void; - incidentOccured?: (incidentInfo: { - id: string; - type: string; - args: any; - text: string; - widget: string; - version: string; - }) => void; - /** A handler for the incidentOccurred event. */ - onIncidentOccurred?: ( - component: BaseWidget, - element: Element, - target: { - id: string; - type: string; - args: any; - text: string; - widget: string; - version: string; - } - ) => void; - /** Notifies a widget that it is embedded into an HTML page that uses a path modifier. */ - pathModified?: boolean; - /** Specifies whether or not the widget supports right-to-left representation. */ - rtlEnabled?: boolean; - /** Sets the name of the theme to be used in the widget. */ - theme?: string; - } - /** This section describes options and methods that are common to all widgets. */ - export class BaseWidget extends DOMComponent { - /** Returns the widget's SVG markup. */ - svg(): string; - } -} -declare namespace DevExpress.viz.charts { - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface BaseSeries { - /** Provides information about the state of the series object. */ - fullState: number; - /** Returns the type of the series. */ - type: string; - /** Unselects all the selected points of the series. The points are displayed in an initial style. */ - clearSelection(): void; - /** Gets the color of a particular series. */ - getColor(): string; - /** - * Gets a point from the series point collection based on the specified argument. - * @deprecated getPointsByArg(pointArg).md - */ - getPointByArg(pointArg: any): Object; - /** Gets points from the series point collection based on the specified argument. */ - getPointsByArg(pointArg: any): Array; - /** Gets a point from the series point collection based on the specified point position. */ - getPointByPos(positionIndex: number): Object; - /** Selects the series. The series is displayed in a 'selected' style until another series is selected or the current series is deselected programmatically. */ - select(): void; - /** Selects the specified point. The point is displayed in a 'selected' style. */ - selectPoint(point: BasePoint): void; - /** Deselects the specified point. The point is displayed in an initial style. */ - deselectPoint(point: BasePoint): void; - /** Returns an array of all points in the series. */ - getAllPoints(): Array; - /** Returns visible series points. */ - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface BasePoint { - /** Provides information about the state of the point object. */ - fullState: number; - /** Returns the point's argument value that was set in the data source. */ - originalArgument: any; - /** Returns the point's value that was set in the data source. */ - originalValue: any; - /** Returns the tag of the point. */ - tag: string; - /** Deselects the point. */ - clearSelection(): void; - /** Gets the color of a particular point. */ - getColor(): string; - /** Hides the tooltip of the point. */ - hideTooltip(): void; - /** Provides information about the hover state of a point. */ - isHovered(): any; - /** Provides information about the selection state of a point. */ - isSelected(): any; - /** Selects the point. The point is displayed in a 'selected' style until another point is selected or the current point is deselected programmatically. */ - select(): void; - /** Shows the tooltip of the point. */ - showTooltip(): void; - /** Allows you to obtain the label of a series point. */ - getLabel(): any; - /** Returns the series object to which the point belongs. */ - series: BaseSeries; - } - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface ChartSeries extends BaseSeries { - /** Returns the name of the series pane. */ - pane: string; - /** Returns the name of the value axis of the series. */ - axis: string; - /** Returns the name of the series. */ - name: string; - /** Returns the tag of the series. */ - tag: string; - /** Hides a series. */ - hide(): void; - /** Provides information about the hover state of a series. */ - isHovered(): any; - /** Provides information about the selection state of a series. */ - isSelected(): any; - /** Provides information about the visibility state of a series. */ - isVisible(): boolean; - /** Makes a particular series visible. */ - show(): void; - selectPoint(point: ChartPoint): void; - deselectPoint(point: ChartPoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface ChartPoint extends BasePoint { - /** Contains the close value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalCloseValue: any; - /** Contains the high value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalHighValue: any; - /** Contains the low value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalLowValue: any; - /** Contains the first value of the point. This field is useful for points belonging to a series of the range area or range bar type only. */ - originalMinValue: any; - /** Contains the open value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalOpenValue: any; - /** Contains the size of the bubble as it was set in the data source. This field is useful for points belonging to a series of the bubble type only. */ - size: any; - /** Gets the parameters of the point's minimum bounding rectangle (MBR). */ - getBoundingRect(): { x: number; y: number; width: number; height: number; }; - series: ChartSeries; - } - /** This section describes the methods that can be used in code to manipulate the Label object. */ - export interface Label { - /** Gets the parameters of the label's minimum bounding rectangle (MBR). */ - getBoundingRect(): { x: number; y: number; width: number; height: number; }; - /** Hides the point label. */ - hide(): void; - /** Shows the point label. */ - show(): void; - } - export interface PieSeries extends BaseSeries { - selectPoint(point: PiePoint): void; - deselectPoint(point: PiePoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface PiePoint extends BasePoint { - /** Gets the percentage value of the specific point. */ - percent: any; - /** Provides information about the visibility state of a point. */ - isVisible(): boolean; - /** Makes a specific point visible. */ - show(): void; - /** Hides a specific point. */ - hide(): void; - series: PieSeries; - } - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface PolarSeries extends BaseSeries { - /** Returns the name of the value axis of the series. */ - axis: string; - /** Returns the name of the series. */ - name: string; - /** Returns the tag of the series. */ - tag: string; - /** Hides a series. */ - hide(): void; - /** Provides information about the hover state of a series. */ - isHovered(): any; - /** Provides information about the selection state of a series. */ - isSelected(): any; - /** Provides information about the visibility state of a series. */ - isVisible(): boolean; - /** Makes a particular series visible. */ - show(): void; - selectPoint(point: PolarPoint): void; - deselectPoint(point: PolarPoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface PolarPoint extends BasePoint { - series: PolarSeries; - } - export interface Strip { - /** Specifies a color for a strip. */ - color?: string; - /** An object that defines the label configuration options of a strip. */ - label?: { - /** Specifies the text displayed in a strip. */ - text?: string; - }; - /** Specifies a start value for a strip. */ - startValue?: any; - /** Specifies an end value for a strip. */ - endValue?: any; - } - export interface BaseSeriesConfigLabel { - /** Specifies a format for arguments displayed by point labels. */ - argumentFormat?: string; - /** Specifies a precision for formatted point arguments displayed in point labels. */ - argumentPrecision?: number; - /** Specifies a background color for point labels. */ - backgroundColor?: string; - /** Specifies border options for point labels. */ - border?: viz.core.DashedBorder; - /** Specifies connector options for series point labels. */ - connector?: { - /** Specifies the color of label connectors. */ - color?: string; - /** Indicates whether or not label connectors are visible. */ - visible?: boolean; - /** Specifies the width of label connectors. */ - width?: number; - }; - /** Specifies a callback function that returns the text to be displayed by point labels. */ - customizeText?: (pointInfo: Object) => string; - /** Specifies font options for the text displayed in point labels. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed by point labels. */ - format?: string; - position?: string; - /** Specifies a precision for formatted point values displayed in point labels. */ - precision?: number; - /** Specifies the angle used to rotate point labels from their initial position. */ - rotationAngle?: number; - /** Specifies the visibility of point labels. */ - visible?: boolean; - } - export interface SeriesConfigLabel extends BaseSeriesConfigLabel { - /** Specifies whether or not to show a label when the point has a zero value. */ - showForZeroValues?: boolean; - } - export interface ChartSeriesConfigLabel extends SeriesConfigLabel { - /** Specifies how to align point labels relative to the corresponding data points that they represent. */ - alignment?: string; - /** Specifies how to shift point labels horizontally from their initial positions. */ - horizontalOffset?: number; - /** Specifies how to shift point labels vertically from their initial positions. */ - verticalOffset?: number; - /** Specifies a precision for the percentage values displayed in the labels of a full-stacked-like series. */ - percentPrecision?: number; - } - export interface BaseCommonSeriesConfig { - /** Specifies the data source field that provides arguments for series points. */ - argumentField?: string; - axis?: string; - /** An object defining the label configuration options for a series in the dxChart widget. */ - label?: ChartSeriesConfigLabel; - /** Specifies border options for point labels. */ - border?: viz.core.DashedBorder; - /** Specifies a series color. */ - color?: string; - /** Specifies the dash style of the series' line. */ - dashStyle?: string; - hoverMode?: string; - /** An object defining configuration options for a hovered series. */ - hoverStyle?: { - /** An object defining the border options for a hovered series. */ - border?: viz.core.DashedBorder; - /**

Sets a color for a series when it is hovered over.

*/ - color?: string; - /** Specifies the dash style for the line in a hovered series. */ - dashStyle?: string; - /** Specifies the hatching options to be applied when a series is hovered over. */ - hatching?: viz.core.Hatching; - /** Specifies the width of a line in a hovered series. */ - width?: number; - }; - /** Specifies whether a chart ignores null data points or not. */ - ignoreEmptyPoints?: boolean; - /** Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed. */ - maxLabelCount?: number; - /** Specifies the minimal length of a displayed bar in pixels. */ - minBarSize?: number; - /** Specifies opacity for a series. */ - opacity?: number; - /** Specifies the series elements to highlight when the series is selected. */ - selectionMode?: string; - /** An object defining configuration options for a selected series. */ - selectionStyle?: { - /** An object defining the border options for a selected series. */ - border?: viz.core.DashedBorder; - /** Sets a color for a series when it is selected. */ - color?: string; - /** Specifies the dash style for the line in a selected series. */ - dashStyle?: string; - /** Specifies the hatching options to be applied when a series is selected. */ - hatching?: viz.core.Hatching; - /** Specifies the width of a line in a selected series. */ - width?: number; - }; - /** Specifies whether or not to show the series in the chart's legend. */ - showInLegend?: boolean; - /** Specifies the name of the stack where the values of the _stackedBar_ series must be located. */ - stack?: string; - /** Specifies the name of the data source field that provides data about a point. */ - tagField?: string; - /** Specifies the data source field that provides values for series points. */ - valueField?: string; - /** Specifies the visibility of a series. */ - visible?: boolean; - /** Specifies a line width. */ - width?: number; - /** Configures error bars. */ - valueErrorBar?: { - /** Specifies whether error bars must be displayed in full or partially. */ - displayMode?: string; - /** Specifies the data field that provides data for low error values. */ - lowValueField?: string; - /** Specifies the data field that provides data for high error values. */ - highValueField?: string; - /** Specifies how error bar values must be calculated. */ - type?: string; - /** Specifies the value to be used for generating error bars. */ - value?: number; - /** Specifies the color of error bars. */ - color?: string; - /** Specifies the opacity of error bars. */ - opacity?: number; - /** Specifies the length of the lines that indicate the error bar edges. */ - edgeLength?: number; - /** Specifies the width of the error bar line. */ - lineWidth?: number; - }; - } - export interface CommonPointOptions { - /** Specifies border options for points in the line and area series. */ - border?: viz.core.Border; - /** Specifies the points color. */ - color?: string; - /** Specifies what series points to highlight when a point is hovered over. */ - hoverMode?: string; - /** An object defining configuration options for a hovered point. */ - hoverStyle?: { - /** An object defining the border options for a hovered point. */ - border?: viz.core.Border; - /** Sets a color for a point when it is hovered over. */ - color?: string; - /** Specifies the diameter of a hovered point in the series that represents data points as symbols (not as bars for instance). */ - size?: number; - }; - /** Specifies what series points to highlight when a point is selected. */ - selectionMode?: string; - /** An object defining configuration options for a selected point. */ - selectionStyle?: { - /** An object defining the border options for a selected point. */ - border?: viz.core.Border; - /**

Sets a color for a point when it is selected.

*/ - color?: string; - /** Specifies the diameter of a selected point in the series that represents data points as symbols (not as bars for instance). */ - size?: number; - }; - /** Specifies the point diameter in pixels for those series that represent data points as symbols (not as bars for instance). */ - size?: number; - /** Specifies a symbol for presenting points of the line and area series. */ - symbol?: string; - visible?: boolean; - } - export interface ChartCommonPointOptions extends CommonPointOptions { - /** An object specifying the parameters of an image that is used as a point marker. */ - image?: { - /** Specifies the height of an image that is used as a point marker. */ - height?: any; - /** Specifies a URL leading to the image to be used as a point marker. */ - url?: any; - /** Specifies the width of an image that is used as a point marker. */ - width?: any; - }; - } - export interface PolarCommonPointOptions extends CommonPointOptions { - /** An object specifying the parameters of an image that is used as a point marker. */ - image?: { - /** Specifies the height of an image that is used as a point marker. */ - height?: number; - /** Specifies a URL leading to the image to be used as a point marker. */ - url?: string; - /** Specifies the width of an image that is used as a point marker. */ - width?: number; - }; - } - /** An object that defines configuration options for chart series. */ - export interface CommonSeriesConfig extends BaseCommonSeriesConfig { - /** Specifies the data source field that provides a 'close' value for a _candleStick_ or _stock_ series. */ - closeValueField?: string; - /** Specifies a radius for bar corners. */ - cornerRadius?: number; - /** Specifies the data source field that provides a 'high' value for a _candleStick_ or _stock_ series. */ - highValueField?: string; - /** Specifies the color for the body (rectangle) of a _candleStick_ series. */ - innerColor?: string; - /** Specifies the data source field that provides a 'low' value for a _candleStick_ or _stock_ series. */ - lowValueField?: string; - /** Specifies the data source field that provides an 'open' value for a _candleStick_ or _stock_ series. */ - openValueField?: string; - /** Specifies the pane that will be used to display a series. */ - pane?: string; - /** An object defining configuration options for points in line-, scatter- and area-like series. */ - point?: ChartCommonPointOptions; - /** Specifies the data source field that provides values for one end of a range series. To set the data source field for the other end of the range series, use the rangeValue2Field property. */ - rangeValue1Field?: string; - /** Specifies the data source field that provides values for the second end of a range series. To set the data source field for the other end of the range series, use the rangeValue1Field property. */ - rangeValue2Field?: string; - /** Specifies reduction options for the stock or candleStick series. */ - reduction?: { - /** Specifies a color for the points whose reduction level price is lower in comparison to the value in the previous point. */ - color?: string; - /** Specifies for which price level (open, high, low or close) to enable reduction options in the series. */ - level?: string; - }; - /** Specifies the data source field that defines the size of bubbles. */ - sizeField?: string; - } - export interface CommonSeriesSettings extends CommonSeriesConfig { - /**

An object that specifies configuration options for all series of the area type in the chart.

*/ - area?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _bar_ type in the chart. */ - bar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the bubble type in the chart. */ - bubble?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _candleStick_ type in the chart. */ - candlestick?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _fullStackedArea_ type in the chart. */ - fullstackedarea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Full-Stacked Spline Area type in the chart. */ - fullstackedsplinearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _fullStackedBar_ type in the chart. */ - fullstackedbar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _fullStackedLine_ type in the chart. */ - fullstackedline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Full-Stacked Spline type in the chart. */ - fullstackedspline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _line_ type in the chart. */ - line?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _rangeArea_ type in the chart. */ - rangearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _rangeBar_ type in the chart. */ - rangebar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _scatter_ type in the chart. */ - scatter?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _spline_ type in the chart. */ - spline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _splineArea_ type in the chart. */ - splinearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedArea_ type in the chart. */ - stackedarea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Stacked Spline Area type in the chart. */ - stackedsplinearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedBar_ type in the chart. */ - stackedbar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedLine_ type in the chart. */ - stackedline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Stacked Spline type in the chart. */ - stackedspline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stepArea_ type in the chart. */ - steparea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stepLine_ type in the chart. */ - stepline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stock_ type in the chart. */ - stock?: CommonSeriesConfig; - /** Sets a series type. */ - type?: string; - } - export interface SeriesConfig extends CommonSeriesConfig { - /** Specifies the name that identifies the series. */ - name?: string; - /** Specifies data about a series. */ - tag?: any; - /** Sets the series type. */ - type?: string; - } - /** An object that defines configuration options for polar chart series. */ - export interface CommonPolarSeriesConfig extends BaseCommonSeriesConfig { - /** Specifies whether or not to close the chart by joining the end point with the first point. */ - closed?: boolean; - label?: SeriesConfigLabel; - point?: PolarCommonPointOptions; - } - export interface CommonPolarSeriesSettings extends CommonPolarSeriesConfig { - /** An object that specifies configuration options for all series of the area type in the chart. */ - area?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _bar_ type in the chart. */ - bar?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _line_ type in the chart. */ - line?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _scatter_ type in the chart. */ - scatter?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedBar_ type in the chart. */ - stackedbar?: CommonPolarSeriesConfig; - /** Sets a series type. */ - type?: string; - } - export interface PolarSeriesConfig extends CommonPolarSeriesConfig { - /** Specifies the name that identifies the series. */ - name?: string; - /** Specifies data about a series. */ - tag?: any; - /** Sets the series type. */ - type?: string; - } - export interface PieSeriesConfigLabel extends BaseSeriesConfigLabel { - /** Specifies how to shift labels from their initial position in a radial direction in pixels. */ - radialOffset?: number; - /** Specifies a precision for the percentage values displayed in labels. */ - percentPrecision?: number; - } - /** An object that defines configuration options for chart series. */ - export interface CommonPieSeriesConfig { - /** Specifies the data source field that provides arguments for series points. */ - argumentField?: string; - /** Specifies the required type for series arguments. */ - argumentType?: string; - /** An object defining the series border configuration options. */ - border?: viz.core.DashedBorder; - /** Specifies a series color. */ - color?: string; - /** Specifies the chart elements to highlight when a series is hovered over. */ - hoverMode?: string; - /** An object defining configuration options for a hovered series. */ - hoverStyle?: { - /** An object defining the border options for a hovered series. */ - border?: viz.core.DashedBorder; - /** Sets a color for the series when it is hovered over. */ - color?: string; - /** Specifies the hatching options to be applied when a point is hovered over. */ - hatching?: viz.core.Hatching; - }; - /** Specifies the fraction of the inner radius relative to the total radius in the series of the 'doughnut' type. */ - innerRadius?: number; - /** An object defining the label configuration options. */ - label?: PieSeriesConfigLabel; - /** Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed. */ - maxLabelCount?: number; - /** Specifies a minimal size of a displayed pie segment. */ - minSegmentSize?: number; - /** Specifies the direction in which the dxPieChart's series points are located. */ - segmentsDirection?: string; - /**

Specifies the chart elements to highlight when the series is selected.

*/ - selectionMode?: string; - /** An object defining configuration options for the series when it is selected. */ - selectionStyle?: { - /** An object defining the border options for a selected series. */ - border?: viz.core.DashedBorder; - /** Sets a color for a series when it is selected. */ - color?: string; - /** Specifies the hatching options to be applied when a point is selected. */ - hatching?: viz.core.Hatching; - }; - /** Specifies chart segment grouping options. */ - smallValuesGrouping?: { - /** Specifies the name of the grouped chart segment. This name represents the segment in the chart legend. */ - groupName?: string; - /** Specifies the segment grouping mode. */ - mode?: string; - /** Specifies a threshold for segment values. */ - threshold?: number; - /** Specifies how many segments must not be grouped. */ - topCount?: number; - }; - /** Specifies a start angle for a pie chart in arc degrees. */ - startAngle?: number; - /**

Specifies the name of the data source field that provides data about a point.

*/ - tagField?: string; - /** Specifies the data source field that provides values for series points. */ - valueField?: string; - } - export interface PieSeriesConfig extends CommonPieSeriesConfig { - /** Sets the series type. */ - type?: string; - } - export interface SeriesTemplate { - /** Specifies a callback function that returns a series object with individual series settings. */ - customizeSeries?: (seriesName: string) => SeriesConfig; - /** Specifies a data source field that represents the series name. */ - nameField?: string; - } - export interface PolarSeriesTemplate { - /** Specifies a callback function that returns a series object with individual series settings. */ - customizeSeries?: (seriesName: string) => PolarSeriesConfig; - /** Specifies a data source field that represents the series name. */ - nameField?: string; - } - export interface ChartCommonConstantLineLabel { - /** Specifies font options for a constant line label. */ - font?: viz.core.Font; - /** Specifies the position of the constant line label relative to the chart plot. */ - position?: string; - /** Indicates whether or not to display labels for the axis constant lines. */ - visible?: boolean; - } - export interface PolarCommonConstantLineLabel { - /** Indicates whether or not to display labels for the axis constant lines. */ - visible?: boolean; - /** Specifies font options for a constant line label. */ - font?: viz.core.Font; - } - export interface ConstantLineStyle { - /** Specifies a color for a constant line. */ - color?: string; - /** Specifies a dash style for a constant line. */ - dashStyle?: string; - /** Specifies a constant line width in pixels. */ - width?: number; - } - export interface ChartCommonConstantLineStyle extends ConstantLineStyle { - /** An object defining constant line label options. */ - label?: ChartCommonConstantLineLabel; - /** Specifies the space between the constant line label and the left/right side of the constant line. */ - paddingLeftRight?: number; - /** Specifies the space between the constant line label and the top/bottom side of the constant line. */ - paddingTopBottom?: number; - } - export interface PolarCommonConstantLineStyle extends ConstantLineStyle { - /** An object defining constant line label options. */ - label?: PolarCommonConstantLineLabel; - } - export interface CommonAxisLabel { - /** Specifies font options for axis labels. */ - font?: viz.core.Font; - /** Specifies the spacing between an axis and its labels in pixels. */ - indentFromAxis?: number; - /** Indicates whether or not axis labels are visible. */ - visible?: boolean; - } - export interface ChartCommonAxisLabel extends CommonAxisLabel { - /** Specifies the label's position relative to the tick (grid line). */ - alignment?: string; - /** Specifies the overlap resolving algorithm to be applied to axis labels. */ - overlappingBehavior?: { - /** Specifies how to arrange axis labels. */ - mode?: string; - /** Specifies the angle used to rotate axis labels. */ - rotationAngle?: number; - /** Specifies the spacing that must be set between staggered rows when the 'stagger' algorithm is applied. */ - staggeringSpacing?: number; - }; - } - export interface PolarCommonAxisLabel extends CommonAxisLabel { - /** Specifies the overlap resolving algorithm to be applied to axis labels. */ - overlappingBehavior?: string; - } - export interface CommonAxisTitle { - /** Specifies font options for an axis title. */ - font?: viz.core.Font; - /** Specifies a margin for an axis title in pixels. */ - margin?: number; - } - export interface BaseCommonAxisSettings { - /** Specifies the color of the line that represents an axis. */ - color?: string; - /** Specifies whether ticks/grid lines of a discrete axis are located between labels or cross the labels. */ - discreteAxisDivisionMode?: string; - /** An object defining the configuration options for the grid lines of an axis in the dxPolarChart widget. */ - grid?: { - /** Specifies a color for grid lines. */ - color?: string; - /** Specifies an opacity for grid lines. */ - opacity?: number; - /** Indicates whether or not the grid lines of an axis are visible. */ - visible?: boolean; - /** Specifies the width of grid lines. */ - width?: number; - }; - /** Specifies the options of the minor grid. */ - minorGrid?: { - /** Specifies a color for the lines of the minor grid. */ - color?: string; - /** Specifies an opacity for the lines of the minor grid. */ - opacity?: number; - /** Indicates whether the minor grid is visible or not. */ - visible?: boolean; - /** Specifies a width for the lines of the minor grid. */ - width?: number; - }; - /** Indicates whether or not an axis is inverted. */ - inverted?: boolean; - /** Specifies the opacity of the line that represents an axis. */ - opacity?: number; - /** Indicates whether or not to set ticks/grid lines of a continuous axis of the 'date-time' type at the beginning of each date-time interval. */ - setTicksAtUnitBeginning?: boolean; - /** An object defining the configuration options for axis ticks. */ - tick?: { - /** Specifies ticks color. */ - color?: string; - /** Specifies tick opacity. */ - opacity?: number; - /** Indicates whether or not ticks are visible on an axis. */ - visible?: boolean; - }; - /** Specifies the options of the minor ticks. */ - minorTick?: { - /** Specifies a color for the minor ticks. */ - color?: string; - /** Specifies an opacity for the minor ticks. */ - opacity?: number; - /** Indicates whether or not the minor ticks are displayed on an axis. */ - visible?: boolean; - }; - /** Indicates whether or not the line that represents an axis in a chart is visible. */ - visible?: boolean; - /** Specifies the width of the line that represents an axis in the chart. */ - width?: number; - } - export interface ChartCommonAxisSettings extends BaseCommonAxisSettings { - /** Specifies the appearance of all the widget's constant lines. */ - constantLineStyle?: ChartCommonConstantLineStyle; - /** An object defining the label configuration options that are common for all axes in the dxChart widget. */ - label?: ChartCommonAxisLabel; - /** Specifies a coefficient that determines the spacing between the maximum series point and the axis. */ - maxValueMargin?: number; - /** Specifies a coefficient that determines the spacing between the minimum series point and the axis. */ - minValueMargin?: number; - /** Specifies, in pixels, the space reserved for an axis. */ - placeholderSize?: number; - /** An object defining configuration options for strip style. */ - stripStyle?: { - /** An object defining the configuration options for a strip label style. */ - label?: { - /** Specifies font options for a strip label. */ - font?: viz.core.Font; - /** Specifies the label's position on a strip. */ - horizontalAlignment?: string; - /** Specifies a label's position on a strip. */ - verticalAlignment?: string; - }; - /** Specifies the spacing, in pixels, between the left/right strip border and the strip label. */ - paddingLeftRight?: number; - /** Specifies the spacing, in pixels, between the top/bottom strip borders and the strip label. */ - paddingTopBottom?: number; - }; - /** An object defining the title configuration options that are common for all axes in the dxChart widget. */ - title?: CommonAxisTitle; - /** Indicates whether or not to display series with indents from axis boundaries. */ - valueMarginsEnabled?: boolean; - } - export interface PolarCommonAxisSettings extends BaseCommonAxisSettings { - /** Specifies the appearance of all the widget's constant lines. */ - constantLineStyle?: PolarCommonConstantLineStyle; - /** An object defining the label configuration options that are common for all axes in the dxPolarChart widget. */ - label?: PolarCommonAxisLabel; - /** An object defining configuration options for strip style. */ - stripStyle?: { - /** An object defining the configuration options for a strip label style. */ - label?: { - /** Specifies font options for a strip label. */ - font?: viz.core.Font; - }; - }; - } - export interface ChartConstantLineLabel extends ChartCommonConstantLineLabel { - /** Specifies the horizontal alignment of a constant line label. */ - horizontalAlignment?: string; - /** Specifies the vertical alignment of a constant line label. */ - verticalAlignment?: string; - /** Specifies the text to be displayed in a constant line label. */ - text?: string; - } - export interface PolarConstantLineLabel extends PolarCommonConstantLineLabel { - /** Specifies the text to be displayed in a constant line label. */ - text?: string; - } - export interface AxisLabel { - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a label on the value axis. */ - customizeHint?: (argument: { value: any; valueText: string }) => string; - /** Specifies a callback function that returns the text to be displayed in value axis labels. */ - customizeText?: (argument: { value: any; valueText: string }) => string; - /** Specifies a format for the text displayed by axis labels. */ - format?: string; - /** Specifies a precision for the formatted value displayed in the axis labels. */ - precision?: number; - } - export interface ChartAxisLabel extends ChartCommonAxisLabel, AxisLabel {} - export interface PolarAxisLabel extends PolarCommonAxisLabel, AxisLabel {} - export interface AxisTitle extends CommonAxisTitle { - /** Specifies the text for the value axis title. */ - text?: string; - } - export interface ChartConstantLineStyle extends ChartCommonConstantLineStyle { - /** An object defining constant line label options. */ - label?: ChartConstantLineLabel; - } - export interface ChartConstantLine extends ChartConstantLineStyle { - /** An object defining constant line label options. */ - label?: ChartConstantLineLabel; - /** Specifies a value to be displayed by a constant line. */ - value?: any; - } - export interface PolarConstantLine extends PolarCommonConstantLineStyle { - /** An object defining constant line label options. */ - label?: PolarConstantLineLabel; - /** Specifies a value to be displayed by a constant line. */ - value?: any; - } - export interface Axis { - /** Specifies a coefficient for dividing the value axis. */ - axisDivisionFactor?: number; - /** Specifies the order in which discrete values are arranged on the value axis. */ - categories?: Array; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic axis. */ - logarithmBase?: number; - /** Specifies an interval between axis ticks/grid lines. */ - tickInterval?: any; - /** Specifies the interval between minor ticks. */ - minorTickInterval?: any; - /** Specifies the number of minor ticks between two neighboring major ticks. */ - minorTickCount?: number; - /** Specifies the required type of the value axis. */ - type?: string; - /** Specifies the pane on which the current value axis will be displayed. */ - pane?: string; - /** Specifies options for value axis strips. */ - strips?: Array; - } - export interface ChartAxis extends ChartCommonAxisSettings, Axis { - /** Defines an array of the value axis constant lines. */ - constantLines?: Array; - /** Specifies the appearance options for the constant lines of the value axis. */ - constantLineStyle?: ChartCommonConstantLineStyle; - /** Specifies options for value axis labels. */ - label?: ChartAxisLabel; - /** Specifies the maximum value on the value axis. */ - max?: any; - /** Specifies the minimum value on the value axis. */ - min?: any; - /** Specifies the position of the value axis on a chart. */ - position?: string; - /** Specifies the title for a value axis. */ - title?: AxisTitle; - } - export interface PolarAxis extends PolarCommonAxisSettings, Axis { - /** Defines an array of the value axis constant lines. */ - constantLines?: Array; - /** Specifies options for value axis labels. */ - label?: PolarAxisLabel; - } - export interface ArgumentAxis { - /** Specifies the desired type of axis values. */ - argumentType?: string; - /** Specifies the elements that will be highlighted when the argument axis is hovered over. */ - hoverMode?: string; - } - export interface ChartArgumentAxis extends ChartAxis, ArgumentAxis {} - export interface PolarArgumentAxis extends PolarAxis, ArgumentAxis { - /** Specifies a start angle for the argument axis in degrees. */ - startAngle?: number; - /** Specifies whether or not to display the first point at the angle specified by the startAngle option. */ - firstPointOnStartAngle?: boolean; - /** Specifies the period of the argument values in the data source. */ - period?: number; - } - export interface ValueAxis { - /** Specifies the name of the value axis. */ - name?: string; - /** Specifies whether or not to indicate a zero value on the value axis. */ - showZero?: boolean; - /** Specifies the desired type of axis values. */ - valueType?: string; - } - export interface ChartValueAxis extends ChartAxis, ValueAxis { - /** Specifies the spacing, in pixels, between multiple value axes in a chart. */ - multipleAxesSpacing?: number; - /** Specifies the value by which the chart's value axes are synchronized. */ - synchronizedValue?: number; - } - export interface PolarValueAxis extends PolarAxis, ValueAxis { - /** Indicates whether to display series with indents from axis boundaries. */ - valueMarginsEnabled?: boolean; - /** Specifies a coefficient that determines the spacing between the maximum series point and the axis. */ - maxValueMargin?: number; - /** Specifies a coefficient that determines the spacing between the minimum series point and the axis. */ - minValueMargin?: number; - tick?: { - visible?: boolean; - } - } - export interface CommonPane { - /** Specifies a background color in a pane. */ - backgroundColor?: string; - /** Specifies the border options of a chart's pane. */ - border?: PaneBorder; - } - export interface Pane extends CommonPane { - /** Specifies the name of a pane. */ - name?: string; - } - export interface PaneBorder extends viz.core.DashedBorderWithOpacity { - /** Specifies the bottom border's visibility state in a pane. */ - bottom?: boolean; - /** Specifies the left border's visibility state in a pane. */ - left?: boolean; - /** Specifies the right border's visibility state in a pane. */ - right?: boolean; - /** Specifies the top border's visibility state in a pane. */ - top?: boolean; - } - export interface ChartAnimation extends viz.core.Animation { - /** Specifies the maximum series point count in the chart that the animation supports. */ - maxPointCountSupported?: number; - } - export interface BaseChartTooltip extends viz.core.Tooltip { - /** Specifies a format for arguments of the chart's series points. */ - argumentFormat?: string; - /** Specifies a precision for formatted arguments displayed in tooltips. */ - argumentPrecision?: number; - /** Specifies a precision for a percent value displayed in tooltips for stacked series and dxPieChart series. */ - percentPrecision?: number; - } - export interface BaseChartOptions extends viz.core.BaseWidgetOptions { - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - /** Specifies the width of the widget container that is small enough for the layout to begin adapting. */ - width?: number; - /** Specifies the height of the widget container that is small enough for the layout to begin adapting. */ - height?: number; - /** Specifies whether or not point labels can be hidden when the layout is adapting. */ - keepLabels?: boolean; - }; - /** Specifies animation options. */ - animation?: ChartAnimation; - /** Specifies a callback function that returns an object with options for a specific point label. */ - customizeLabel?: (labelInfo: Object) => Object; - /** Specifies a callback function that returns an object with options for a specific point. */ - customizePoint?: (pointInfo: Object) => Object; - /** Specifies a data source for the chart. */ - dataSource?: any; - done?: Function; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies options of a dxChart's (dxPieChart's) legend. */ - legend?: core.BaseLegend; - /** Specifies the blank space between the chart's extreme elements and the boundaries of the area provided for the widget (see size) in pixels. */ - margin?: viz.core.Margins; - /** Sets the name of the palette to be used in the chart. Alternatively, an array of colors can be set as a custom palette to be used within this chart. */ - palette?: any; - /** A handler for the done event. */ - onDone?: (e: { - component: BaseChart; - element: Element; - }) => void; - /** A handler for the pointClick event. */ - onPointClick?: any; - pointClick?: any; - /** A handler for the pointHoverChanged event. */ - onPointHoverChanged?: (e: { - component: BaseChart; - element: Element; - target: TPoint; - }) => void; - pointHoverChanged?: (point: TPoint) => void; - /** A handler for the pointSelectionChanged event. */ - onPointSelectionChanged?: (e: { - component: BaseChart; - element: Element; - target: TPoint; - }) => void; - pointSelectionChanged?: (point: TPoint) => void; - /** Specifies whether a single point or multiple points can be selected in the chart. */ - pointSelectionMode?: string; - /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */ - redrawOnResize?: boolean; - /** Specifies options for the dxChart and dxPieChart widget series. */ - series?: any; - /** Specifies the size of the widget in pixels. */ - size?: viz.core.Size; - /** Specifies a title for the chart. */ - title?: { - /** Specifies font options for the title. */ - font?: viz.core.Font; - /** Specifies the title's horizontal position in the chart. */ - horizontalAlignment?: string; - /** Specifies a title's position on the chart in the vertical direction. */ - verticalAlignment?: string; - /** Specifies the distance between the title and surrounding chart elements in pixels. */ - margin?: viz.core.Margins; - /** Specifies the height of the space reserved for the title. */ - placeholderSize?: number; - /** Specifies a text for the chart's title. */ - text?: string; - }; - /** Specifies tooltip options. */ - tooltip?: BaseChartTooltip; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: BaseChart; - element: Element; - target: BasePoint; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: BaseChart; - element: Element; - target: BasePoint; - }) => void; - tooltipHidden?: (point: TPoint) => void; - tooltipShown?: (point: TPoint) => void; - } - /** A base class for all chart widgets included in the ChartJS library. */ - export class BaseChart extends viz.core.BaseWidget { - /** Deselects the chart's selected series. The series is displayed in an initial style. */ - clearSelection(): void; - /** Gets the current size of the widget. */ - getSize(): { width: number; height: number }; - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Hides all widget tooltips. */ - hideTooltip(): void; - /** Redraws a widget. */ - render(renderOptions?: { - force?: boolean; - animate?: boolean; - asyncSeriesRendering?: boolean; - }): void; - } - export interface AdvancedLegend extends core.BaseLegend { - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item. */ - customizeHint?: (seriesInfo: { seriesName: string; seriesIndex: number; seriesColor: string; }) => string; - /**

Specifies a callback function that returns the text to be displayed by legend items.

*/ - customizeText?: (seriesInfo: { seriesName: string; seriesIndex: number; seriesColor: string; }) => string; - /** Specifies what series elements to highlight when a corresponding item in the legend is hovered over. */ - hoverMode?: string; - } - export interface AdvancedOptions extends BaseChartOptions { - /** A handler for the argumentAxisClick event. */ - onArgumentAxisClick?: any; - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** An object providing options for managing data from a data source. */ - dataPrepareSettings?: { - /** Specifies whether or not to validate the values from a data source. */ - checkTypeForAllData?: boolean; - /** Specifies whether or not to convert the values from a data source into the data type of an axis. */ - convertToAxisDataType?: boolean; - /** Specifies how to sort the series points. */ - sortingMethod?: any; - }; - /** A handler for the legendClick event. */ - onLegendClick?: any; - /** A handler for the seriesClick event. */ - onSeriesClick?: any; - /** A handler for the seriesHoverChanged event. */ - onSeriesHoverChanged?: (e: { - component: BaseChart; - element: Element; - target: TSeries; - }) => void; - /** A handler for the seriesSelectionChanged event. */ - onSeriesSelectionChanged?: (e: { - component: BaseChart; - element: Element; - target: TSeries; - }) => void; - /** Specifies whether a single series or multiple series can be selected in the chart. */ - seriesSelectionMode?: string; - /** Specifies how the chart must behave when series point labels overlap. */ - resolveLabelOverlapping?: string; - } - export interface Legend extends AdvancedLegend { - /** Specifies whether the legend is located outside or inside the chart's plot. */ - position?: string; - } - export interface ChartTooltip extends BaseChartTooltip { - /** Specifies whether the tooltip must be located in the center of a bar or on its edge. Applies only to the Bar series. */ - location?: string; - /** Specifies the kind of information to display in a tooltip. */ - shared?: boolean; - } - export interface dxChartOptions extends AdvancedOptions { - /** Specifies a value indicating whether all bars in a series must have the same width, or may have different widths if any points in other series are missing. */ - equalBarWidth?: any; - adaptiveLayout?: { - keepLabels?: boolean; - }; - /** Indicates whether or not to synchronize value axes when they are displayed on a single pane. */ - synchronizeMultiAxes?: boolean; - /** Specifies whether or not to filter the series points depending on their quantity. */ - useAggregation?: boolean; - /** Indicates whether or not to adjust a value axis to the current minimum and maximum values of a zoomed chart. */ - adjustOnZoom?: boolean; - /** Specifies argument axis options for the dxChart widget. */ - argumentAxis?: ChartArgumentAxis; - argumentAxisClick?: any; - /** An object defining the configuration options that are common for all axes of the dxChart widget. */ - commonAxisSettings?: ChartCommonAxisSettings; - /** An object defining the configuration options that are common for all panes in the dxChart widget. */ - commonPaneSettings?: CommonPane; - /** An object defining the configuration options that are common for all series of the dxChart widget. */ - commonSeriesSettings?: CommonSeriesSettings; - /** An object that specifies the appearance options of the chart crosshair. */ - crosshair?: { - /** Specifies a color for the crosshair lines. */ - color?: string; - /** Specifies a dash style for the crosshair lines. */ - dashStyle?: string; - /** Specifies whether to enable the crosshair or not. */ - enabled?: boolean; - /** Specifies the opacity of the crosshair lines. */ - opacity?: number; - /** Specifies the width of the crosshair lines. */ - width?: number; - /** Specifies the appearance of the horizontal crosshair line. */ - horizontalLine?: CrosshaierWithLabel; - /** Specifies the appearance of the vertical crosshair line. */ - verticalLine?: CrosshaierWithLabel; - /** Specifies the options of the crosshair labels. */ - label?: { - /** Specifies a color for the background of the crosshair labels. */ - backgroundColor?: string; - /** Specifies whether the crosshair labels are visible or not. */ - visible?: boolean; - /** Specifies font options for the text of the crosshair labels. */ - font?: viz.core.Font; - } - }; - /** Specifies a default pane for the chart's series. */ - defaultPane?: string; - /** Specifies a coefficient determining the diameter of the largest bubble. */ - maxBubbleSize?: number; - /** Specifies the diameter of the smallest bubble measured in pixels. */ - minBubbleSize?: number; - /** Defines the dxChart widget's pane(s). */ - panes?: Array; - /** Swaps the axes round so that the value axis becomes horizontal and the argument axes becomes vertical. */ - rotated?: boolean; - /** Specifies the options of a chart's legend. */ - legend?: Legend; - /** Specifies options for dxChart widget series. */ - series?: Array; - legendClick?: any; - seriesClick?: any; - seriesHoverChanged?: (series: ChartSeries) => void; - seriesSelectionChanged?: (series: ChartSeries) => void; - /** Defines options for the series template. */ - seriesTemplate?: SeriesTemplate; - /** Specifies tooltip options. */ - tooltip?: ChartTooltip; - /** Specifies value axis options for the dxChart widget. */ - valueAxis?: Array; - /** Enables scrolling in your chart. */ - scrollingMode?: string; - /** Enables zooming in your chart. */ - zoomingMode?: string; - /** Specifies the settings of the scroll bar. */ - scrollBar?: { - /** Specifies whether the scroll bar is visible or not. */ - visible?: boolean; - /** Specifies the spacing between the scroll bar and the chart's plot in pixels. */ - offset?: number; - /** Specifies the color of the scroll bar. */ - color?: string; - /** Specifies the width of the scroll bar in pixels. */ - width?: number; - /** Specifies the opacity of the scroll bar. */ - opacity?: number; - /** Specifies the position of the scroll bar in the chart. */ - position?: string; - }; - } - /** A widget used to embed charts into HTML JS applications. */ - export class dxChart extends BaseChart { - constructor(element: JQuery, options?: dxChartOptions); - constructor(element: Element, options?: dxChartOptions); - /** Returns an array of all series in the chart. */ - getAllSeries(): Array; - /** Gets a series within the chart's series collection by the specified name (see the name option). */ - getSeriesByName(seriesName: string): ChartSeries; - /** Gets a series within the chart's series collection by its position number. */ - getSeriesByPos(seriesIndex: number): ChartSeries; - /** Sets the specified start and end values for the chart's argument axis. */ - zoomArgument(startValue: any, endValue: any): void; - } - interface CrosshaierWithLabel extends viz.core.DashedBorderWithOpacity { - /** Configures the label that belongs to the horizontal crosshair line. */ - label?: { - /** Specifies a color for the background of the label that belongs to the horizontal crosshair line. */ - backgroundColor?: string; - /** Specifies whether the label of the horizontal crosshair line is visible or not. */ - visible?: boolean; - /** Specifies font options for the text of the label that belongs to the horizontal crosshair line. */ - font?: viz.core.Font; - } - } - export interface PolarChartTooltip extends BaseChartTooltip { - /** Specifies the kind of information to display in a tooltip. */ - shared?: boolean; - } - export interface dxPolarChartOptions extends AdvancedOptions { - /** Specifies a value indicating whether all bars in a series must have the same angle, or may have different angles if any points in other series are missing. */ - equalBarWidth?: boolean; - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - width?: number; - height?: number; - /** Specifies whether or not point labels can be hidden when the layout is adapting. */ - keepLabels?: boolean; - }; - /** Indicates whether or not to display a "spider web". */ - useSpiderWeb?: boolean; - /** Specifies argument axis options for the dxPolarChart widget. */ - argumentAxis?: PolarArgumentAxis; - /** An object defining the configuration options that are common for all axes of the dxPolarChart widget. */ - commonAxisSettings?: PolarCommonAxisSettings; - /** An object defining the configuration options that are common for all series of the dxPolarChart widget. */ - commonSeriesSettings?: CommonPolarSeriesSettings; - /** Specifies the options of a chart's legend. */ - legend?: AdvancedLegend; - /** Specifies options for dxPolarChart widget series. */ - series?: Array; - /** Defines options for the series template. */ - seriesTemplate?: PolarSeriesTemplate; - /** Specifies tooltip options. */ - tooltip?: PolarChartTooltip; - /** Specifies value axis options for the dxPolarChart widget. */ - valueAxis?: PolarValueAxis; - } - /** A chart widget displaying data in a polar coordinate system. */ - export class dxPolarChart extends BaseChart { - constructor(element: JQuery, options?: dxPolarChartOptions); - constructor(element: Element, options?: dxPolarChartOptions); - /** Returns an array of all series in the chart. */ - getAllSeries(): Array; - /** Gets a series within the chart's series collection by the specified name (see the name option). */ - getSeriesByName(seriesName: string): PolarSeries; - /** Gets a series within the chart's series collection by its position number. */ - getSeriesByPos(seriesIndex: number): PolarSeries; - } - export interface PieLegend extends core.BaseLegend { - /** Specifies what chart elements to highlight when a corresponding item in the legend is hovered over. */ - hoverMode?: string; - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item. */ - customizeHint?: (pointInfo: { pointName: string; pointIndex: number; pointColor: string; }) => string; - /** Specifies a callback function that returns the text to be displayed by a legend item. */ - customizeText?: (pointInfo: { pointName: string; pointIndex: number; pointColor: string; }) => string; - } - export interface dxPieChartOptions extends BaseChartOptions { - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - /** Specifies whether or not point labels can be hidden when the layout is adapting. */ - keepLabels?: boolean; - }; - /** Specifies dxPieChart legend options. */ - legend?: PieLegend; - /** Specifies options for the series of the dxPieChart widget. */ - series?: Array; - /** Specifies the diameter of the pie. */ - diameter?: number; - /** A handler for the legendClick event. */ - onLegendClick?: any; - legendClick?: any; - /** Specifies how the chart must behave when series point labels overlap. */ - resolveLabelOverlapping?: string; - } - /** A circular chart widget for HTML JS applications. */ - export class dxPieChart extends BaseChart { - constructor(element: JQuery, options?: dxPieChartOptions); - constructor(element: Element, options?: dxPieChartOptions); - /** Provides access to the dxPieChart series. */ - getSeries(): PieSeries; - } -} -interface JQuery { - dxChart(options?: DevExpress.viz.charts.dxChartOptions): JQuery; - dxChart(methodName: string, ...params: any[]): any; - dxChart(methodName: "instance"): DevExpress.viz.charts.dxChart; - dxPieChart(options?: DevExpress.viz.charts.dxPieChartOptions): JQuery; - dxPieChart(methodName: string, ...params: any[]): any; - dxPieChart(methodName: "instance"): DevExpress.viz.charts.dxPieChart; - dxPolarChart(options?: DevExpress.viz.charts.dxPolarChartOptions): JQuery; - dxPolarChart(methodName: string, ...params: any[]): any; - dxPolarChart(methodName: "instance"): DevExpress.viz.charts.dxPolarChart; -} -declare namespace DevExpress.viz.gauges { - export interface BaseRangeContainer { - /** Specifies a range container's background color. */ - backgroundColor?: string; - /** Specifies the offset of the range container from an invisible scale line in pixels. */ - offset?: number; - /** Sets the name of the palette or an array of colors to be used for coloring the gauge range container. */ - palette?: any; - /** An array of objects representing ranges contained in the range container. */ - ranges?: Array<{ startValue: number; endValue: number; color: string }>; - /** Specifies a color of a range. */ - color?: string; - /** Specifies an end value of a range. */ - endValue?: number; - /** Specifies a start value of a range. */ - startValue?: number; - } - export interface ScaleTick { - /** Specifies the color of the scale's minor ticks. */ - color?: string; - /** Specifies an array of custom minor ticks. */ - customTickValues?: Array; - /** Specifies the length of the scale's minor ticks. */ - length?: number; - /** Indicates whether automatically calculated minor ticks are visible or not. */ - showCalculatedTicks?: boolean; - /** Specifies an interval between minor ticks. */ - tickInterval?: number; - /** Indicates whether scale minor ticks are visible or not. */ - visible?: boolean; - /** Specifies the width of the scale's minor ticks. */ - width?: number; - } - export interface ScaleMajorTick extends ScaleTick { - /** Specifies whether or not to expand the current major tick interval if labels overlap each other. */ - useTicksAutoArrangement?: boolean; - } - export interface BaseScaleLabel { - /** Specifies whether or not scale labels should be colored similarly to their corresponding ranges in the range container. */ - useRangeColors?: boolean; - /** Specifies a callback function that returns the text to be displayed in scale labels. */ - customizeText?: (scaleValue: { value: number; valueText: string }) => string; - /** Specifies font options for the text displayed in the scale labels of the gauge. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in scale labels. */ - format?: string; - /** Specifies a precision for the formatted value displayed in the scale labels. */ - precision?: number; - /** Specifies whether or not scale labels are visible on the gauge. */ - visible?: boolean; - } - export interface BaseScale { - /** Specifies the end value for the scale of the gauge. */ - endValue?: number; - /** Specifies whether or not to hide the first scale label. */ - hideFirstLabel?: boolean; - /** Specifies whether or not to hide the first major tick on the scale. */ - hideFirstTick?: boolean; - /** Specifies whether or not to hide the last scale label. */ - hideLastLabel?: boolean; - /** Specifies whether or not to hide the last major tick on the scale. */ - hideLastTick?: boolean; - /** Specifies common options for scale labels. */ - label?: BaseScaleLabel; - /** Specifies options of the gauge's major ticks. */ - majorTick?: ScaleMajorTick; - /** Specifies options of the gauge's minor ticks. */ - minorTick?: ScaleTick; - /** Specifies the start value for the scale of the gauge. */ - startValue?: number; - } - export interface BaseValueIndicator { - /** Specifies the type of subvalue indicators. */ - type?: string; - /** Specifies the background color for the indicator of the rangeBar type. */ - backgroundColor?: string; - /** Specifies the base value for the indicator of the rangeBar type. */ - baseValue?: number; - /** Specifies a color of the indicator. */ - color?: string; - /** Specifies the range bar size for an indicator of the rangeBar type. */ - size?: number; - text?: { - /** Specifies a callback function that returns the text to be displayed in an indicator. */ - customizeText?: (indicatedValue: { value: number; valueText: string }) => string; - font?: viz.core.Font; - /** Specifies a format for the text displayed in an indicator. */ - format?: string; - /** Specifies the range bar's label indent in pixels. */ - indent?: number; - /** Specifies a precision for the formatted value displayed by an indicator. */ - precision?: number; - }; - offset?: number; - length?: number; - width?: number; - /** Specifies the length of an arrow for the indicator of the textCloud type in pixels. */ - arrowLength?: number; - /** Sets the array of colors to be used for coloring subvalue indicators. */ - palette?: Array; - /** Specifies the distance between the needle and the center of a gauge for the indicator of a needle-like type. */ - indentFromCenter?: number; - /** Specifies the second color for the indicator of the twoColorNeedle type. */ - secondColor?: string; - /** Specifies the length of a twoNeedleColor type indicator tip as a percentage. */ - secondFraction?: number; - /** Specifies the spindle's diameter in pixels for the indicator of a needle-like type. */ - spindleSize?: number; - /** Specifies the inner diameter in pixels, so that the spindle has the shape of a ring. */ - spindleGapSize?: number; - /** Specifies the orientation of the rangeBar indicator on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - /** Specifies the orientation of the rangeBar indicator on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - } - export interface SharedGaugeOptions { - /** Specifies animation options. */ - animation?: viz.core.Animation; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */ - redrawOnResize?: boolean; - /** Specifies the size of the widget in pixels. */ - size?: viz.core.Size; - /** Specifies a subtitle for a gauge. */ - subtitle?: { - /** Specifies font options for the subtitle. */ - font?: viz.core.Font; - /** Specifies a text for the subtitle. */ - text?: string; - }; - /** Specifies a title for a gauge. */ - title?: { - /** Specifies font options for the title. */ - font?: viz.core.Font; - /** Specifies a title's position on the gauge. */ - position?: string; - /** Specifies a text for the title. */ - text?: string; - }; - /** Specifies options for gauge tooltips. */ - tooltip?: viz.core.Tooltip; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: dxBaseGauge; - element: Element; - target: {}; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: dxBaseGauge; - element: Element; - target: {}; - }) => void; - } - export interface BaseGaugeOptions extends viz.core.BaseWidgetOptions, SharedGaugeOptions { - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** Specifies the blank space in pixels between the widget's extreme elements and the boundaries of the area provided for the widget (see the size option). */ - margin?: viz.core.Margins; - /** Specifies options of the gauge's range container. */ - rangeContainer?: BaseRangeContainer; - /** Specifies a gauge's scale options. */ - scale?: BaseScale; - /** Specifies the appearance options of subvalue indicators. */ - subvalueIndicator?: BaseValueIndicator; - /** Specifies a set of subvalues to be designated by the subvalue indicators. */ - subvalues?: Array; - /** Specifies the main value on a gauge. */ - value?: number; - /** Specifies the appearance options of the value indicator. */ - valueIndicator?: BaseValueIndicator; - } - /** A gauge widget. */ - export class dxBaseGauge extends viz.core.BaseWidget { - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(): void; - /** Returns the main gauge value. */ - value(): number; - /** Updates a gauge value. */ - value(value: number): void; - /** Returns an array of gauge subvalues. */ - subvalues(): Array; - /** Updates gauge subvalues. */ - subvalues(subvalues: Array): void; - } - export interface LinearRangeContainer extends BaseRangeContainer { - /** Specifies the orientation of the range container on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - /** Specifies the orientation of a range container on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - /** Specifies the width of the range container's start and end boundaries in the dxLinearGauge widget. */ - width?: any; - /** Specifies an end width of a range container. */ - end?: number; - /** Specifies a start width of a range container. */ - start?: number; - } - export interface LinearScaleLabel extends BaseScaleLabel { - /** Specifies the spacing between scale labels and ticks. */ - indentFromTick?: number; - } - export interface LinearScale extends BaseScale { - /** Specifies the orientation of scale ticks on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - label?: LinearScaleLabel; - /** Specifies the orientation of scale ticks on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - } - export interface dxLinearGaugeOptions extends BaseGaugeOptions { - /** Specifies the options required to set the geometry of the dxLinearGauge widget. */ - geometry?: { - /** Indicates whether to display the dxLinearGauge widget vertically or horizontally. */ - orientation?: string; - }; - /** Specifies gauge range container options. */ - rangeContainer?: LinearRangeContainer; - scale?: LinearScale; - } - /** A widget that represents a gauge with a linear scale. */ - export class dxLinearGauge extends dxBaseGauge { - constructor(element: JQuery, options?: dxLinearGaugeOptions); - constructor(element: Element, options?: dxLinearGaugeOptions); - } - export interface CircularRangeContainer extends BaseRangeContainer { - /** Specifies the orientation of the range container in the dxCircularGauge widget. */ - orientation?: string; - /** Specifies the range container's width in pixels. */ - width?: number; - } - export interface CircularScaleLabel extends BaseScaleLabel { - /** Specifies the spacing between scale labels and ticks. */ - indentFromTick?: number; - } - export interface CircularScale extends BaseScale { - label?: CircularScaleLabel; - /** Specifies the orientation of scale ticks. */ - orientation?: string; - } - export interface dxCircularGaugeOptions extends BaseGaugeOptions { - /** Specifies the options required to set the geometry of the dxCircularGauge widget. */ - geometry?: { - /** Specifies the end angle of the circular gauge's arc. */ - endAngle?: number; - /** Specifies the start angle of the circular gauge's arc. */ - startAngle?: number; - }; - /** Specifies gauge range container options. */ - rangeContainer?: CircularRangeContainer; - scale?: CircularScale; - } - /** A widget that represents a gauge with a circular scale. */ - export class dxCircularGauge extends dxBaseGauge { - constructor(element: JQuery, options?: dxCircularGaugeOptions); - constructor(element: Element, options?: dxCircularGaugeOptions); - } - export interface dxBarGaugeOptions extends viz.core.BaseWidgetOptions, SharedGaugeOptions { - /** Specifies a color for the remaining segment of the bar's track. */ - backgroundColor?: string; - /** Specifies a distance between bars in pixels. */ - barSpacing?: number; - /** Specifies a base value for bars. */ - baseValue?: number; - /** Specifies an end value for the gauge's invisible scale. */ - endValue?: number; - /** Defines the shape of the gauge's arc. */ - geometry?: { - /** Specifies the end angle of the bar gauge's arc. */ - endAngle?: number; - /** Specifies the start angle of the bar gauge's arc. */ - startAngle?: number; - }; - /** Specifies the options of the labels that accompany gauge bars. */ - label?: { - /** Specifies a color for the label connector text. */ - connectorColor?: string; - /** Specifies the width of the label connector in pixels. */ - connectorWidth?: number; - /** Specifies a callback function that returns a text for labels. */ - customizeText?: (barValue: { value: number; valueText: string }) => string; - /** Specifies font options for bar labels. */ - font?: viz.core.Font; - /** Specifies a format for bar labels. */ - format?: string; - /** Specifies the distance between the upper bar and bar labels in pixels. */ - indent?: number; - /** Specifies a precision for the formatted value displayed by labels. */ - precision?: number; - /** Specifies whether bar labels appear on a gauge or not. */ - visible?: boolean; - }; - /** Sets the name of the palette or an array of colors to be used for coloring the gauge range container. */ - palette?: string; - /** Defines the radius of the bar that is closest to the center relatively to the radius of the topmost bar. */ - relativeInnerRadius?: number; - /** Specifies a start value for the gauge's invisible scale. */ - startValue?: number; - /** Specifies the array of values to be indicated on a bar gauge. */ - values?: Array; - } - /** A circular bar widget. */ - export class dxBarGauge extends viz.core.BaseWidget { - constructor(element: JQuery, options?: dxBarGaugeOptions); - constructor(element: Element, options?: dxBarGaugeOptions); - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws the widget. */ - render(): void; - /** Returns an array of gauge values. */ - values(): Array; - /** Updates the values displayed by a gauge. */ - values(values: Array): void; - } -} -interface JQuery { - dxLinearGauge(options?: DevExpress.viz.gauges.dxLinearGaugeOptions): JQuery; - dxLinearGauge(methodName: string, ...params: any[]): any; - dxLinearGauge(methodName: "instance"): DevExpress.viz.gauges.dxLinearGauge; - dxCircularGauge(options?: DevExpress.viz.gauges.dxCircularGaugeOptions): JQuery; - dxCircularGauge(methodName: string, ...params: any[]): any; - dxCircularGauge(methodName: "instance"): DevExpress.viz.gauges.dxCircularGauge; - dxBarGauge(options?: DevExpress.viz.gauges.dxBarGaugeOptions): JQuery; - dxBarGauge(methodName: string, ...params: any[]): any; - dxBarGauge(methodName: "instance"): DevExpress.viz.gauges.dxBarGauge; -} -declare namespace DevExpress.viz.rangeSelector { - export interface dxRangeSelectorOptions extends viz.core.BaseWidgetOptions { - /** Specifies the options for the range selector's background. */ - background?: { - /** Specifies the background color for the dxRangeSelector. */ - color?: string; - /** Specifies image options. */ - image?: { - /** Specifies a location for the image in the background of a range selector. */ - location?: string; - /** Specifies the image's URL. */ - url?: string; - }; - /** Indicates whether or not the background (background color and/or image) is visible. */ - visible?: boolean; - }; - /** Specifies the dxRangeSelector's behavior options. */ - behavior?: { - /** Indicates whether or not you can swap sliders. */ - allowSlidersSwap?: boolean; - /** -Indicates whether or not animation is enabled. - */ - animationEnabled?: boolean; - /** Specifies when to call the onSelectedRangeChanged function. */ - callSelectedRangeChanged?: string; - /** Indicates whether or not an end user can specify the range using a mouse, without the use of sliders. */ - manualRangeSelectionEnabled?: boolean; - /** Indicates whether or not an end user can shift the selected range to the required location on a scale by clicking. */ - moveSelectedRangeByClick?: boolean; - /** Indicates whether to snap a slider to ticks. */ - snapToTicks?: boolean; - }; - /** Specifies the options required to display a chart as the range selector's background. */ - chart?: { - /** Specifies a coefficient for determining an indent from the bottom background boundary to the lowest chart point. */ - bottomIndent?: number; - /** An object defining the common configuration options for the chart’s series. */ - commonSeriesSettings?: viz.charts.CommonSeriesSettings; - /** An object providing options for managing data from a data source. */ - dataPrepareSettings?: { - /** Specifies whether or not to validate values from a data source. */ - checkTypeForAllData?: boolean; - /** Specifies whether or not to convert the values from a data source into the data type of an axis. */ - convertToAxisDataType?: boolean; - /** Specifies how to sort series points. */ - sortingMethod?: any; - }; - /** Specifies a value indicating whether all bars in a series must have the same width, or may have different widths if any points in other series are missing. */ - equalBarWidth?: any; - /** An object defining the chart’s series. */ - series?: Array; - /** Defines options for the series template. */ - seriesTemplate?: viz.charts.SeriesTemplate; - /** Specifies a coefficient for determining an indent from the background's top boundary to the topmost chart point. */ - topIndent?: number; - /** Specifies whether or not to filter the series points depending on their quantity. */ - useAggregation?: boolean; - /** Specifies options for the chart's value axis. */ - valueAxis?: { - /** Indicates whether or not the chart's value axis must be inverted. */ - inverted?: boolean; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic value axis. */ - logarithmBase?: number; - /** Specifies the maximum value of the chart's value axis. */ - max?: number; - /** Specifies the minimum value of the chart's value axis. */ - min?: number; - /** Specifies the type of the value axis. */ - type?: string; - /** Specifies the desired type of axis values. */ - valueType?: string; - }; - }; - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** Specifies a data source for the scale values and for the chart at the background. */ - dataSource?: any; - /** Specifies the data source field that provides data for the scale. */ - dataSourceField?: string; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies the blank space in pixels between the dxRangeSelector widget's extreme elements and the boundaries of the area provided for the widget (see size). */ - margin?: viz.core.Margins; - /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */ - redrawOnResize?: boolean; - /** Specifies options of the range selector's scale. */ - scale?: { - /** Specifies the scale's end value. */ - endValue?: any; - /** Specifies common options for scale labels. */ - label?: { - /** Specifies a callback function that returns the text to be displayed in scale labels. */ - customizeText?: (scaleValue: { value: any; valueText: string; }) => string; - /** Specifies font options for the text displayed in the range selector's scale labels. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in scale labels. */ - format?: string; - /** Specifies a precision for the formatted value displayed in the scale labels. */ - precision?: number; - /** Specifies a spacing between scale labels and the background bottom edge. */ - topIndent?: number; - /** Specifies whether or not the scale's labels are visible. */ - visible?: boolean; - }; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic scale. */ - logarithmBase?: number; - /** Specifies an interval between major ticks. */ - majorTickInterval?: any; - /** Specifies options for the date-time scale's markers. */ - marker?: { - /** Defines the options that can be set for the text that is displayed by the scale markers. */ - label?: { - /** Specifies a callback function that returns the text to be displayed in scale markers. */ - customizeText?: (markerValue: { value: any; valueText: string }) => string; - /** Specifies a format for the text displayed in scale markers. */ - format?: string; - }; - /** Specifies the height of the marker's separator. */ - separatorHeight?: number; - /** Specifies the space between the marker label and the marker separator. */ - textLeftIndent?: number; - /** Specifies the space between the marker's label and the top edge of the marker's separator. */ - textTopIndent?: number; - /** Specified the indent between the marker and the scale lables. */ - topIndent?: number; - /** Indicates whether scale markers are visible. */ - visible?: boolean; - }; - /** Specifies the maximum range that can be selected. */ - maxRange?: any; - /** Specifies the number of minor ticks between neighboring major ticks. */ - minorTickCount?: number; - /** -Specifies an interval between minor ticks. - */ - minorTickInterval?: any; - /** Specifies the minimum range that can be selected. */ - minRange?: any; - /** Specifies the height of the space reserved for the scale in pixels. */ - placeholderHeight?: number; - /** Indicates whether or not to set ticks of a date-time scale at the beginning of each date-time interval. */ - setTicksAtUnitBeginning?: boolean; - /** Specifies whether or not to show ticks for the boundary scale values, when neither major ticks nor minor ticks are created for these values. */ - showCustomBoundaryTicks?: boolean; - /** Indicates whether or not to show minor ticks on the scale. */ - showMinorTicks?: boolean; - /** Specifies the scale's start value. */ - startValue?: any; - /** Specifies options defining the appearance of scale ticks. */ - tick?: { - /** Specifies the color of scale ticks (both major and minor ticks). */ - color?: string; - /** Specifies the opacity of scale ticks (both major and minor ticks). */ - opacity?: number; - /** Specifies the width of the scale's ticks (both major and minor ticks). */ - width?: number; - }; - /** Specifies the type of the scale. */ - type?: string; - /** Specifies whether or not to expand the current tick interval if labels overlap each other. */ - useTicksAutoArrangement?: boolean; - /** Specifies the type of values on the scale. */ - valueType?: string; - /** Specifies the order of arguments on a discrete scale. */ - categories?: Array; - }; - /** Specifies the range to be selected when displaying the dxRangeSelector. */ - selectedRange?: { - /** Specifies the start value of the range to be selected when displaying the dxRangeSelector widget on a page. */ - startValue?: any; - /** Specifies the end value of the range to be selected when displaying the dxRangeSelector widget on a page. */ - endValue?: any; - }; - /** Specifies the color of the selected range. */ - selectedRangeColor?: string; - /** Range selector's indent options. */ - indent?: { - /** Specifies range selector's left indent. */ - left?: number; - /** Specifies range selector's right indent. */ - right?: number; - }; - selectedRangeChanged?: (selectedRange: { startValue: any; endValue: any; }) => void; - /** A handler for the selectedRangeChanged event. */ - onSelectedRangeChanged?: (e: { - startValue: any; - endValue: any; - component: dxRangeSelector; - element: Element; - }) => void; - /** Specifies range selector shutter options. */ - shutter?: { - /** Specifies shutter color. */ - color?: string; - /** Specifies the opacity of the color of shutters. */ - opacity?: number; - }; - /** Specifies in pixels the size of the dxRangeSelector widget. */ - size?: viz.core.Size; - /** Specifies the appearance of the range selector's slider handles. */ - sliderHandle?: { - /** Specifies the color of the slider handles. */ - color?: string; - /** Specifies the opacity of the slider handles. */ - opacity?: number; - /** Specifies the width of the slider handles. */ - width?: number; - }; - /** Defines the options of the range selector slider markers. */ - sliderMarker?: { - /** Specifies the color of the slider markers. */ - color?: string; - /** Specifies a callback function that returns the text to be displayed by slider markers. */ - customizeText?: (scaleValue: { value: any; valueText: any; }) => string; - /** Specifies font options for the text displayed by the range selector slider markers. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in slider markers. */ - format?: string; - /** Specifies the color used for the slider marker text when the currently selected range does not match the minRange and maxRange values. */ - invalidRangeColor?: string; - /** - * Specifies the empty space between the marker's border and the marker’s text. - * @deprecated Use the 'paddingTopBottom' and 'paddingLeftRight' options instead - */ - padding?: number; - /** Specifies the empty space between the marker's top and bottom borders and the marker's text. */ - paddingTopBottom?: number; - /** Specifies the empty space between the marker's left and right borders and the marker's text. */ - paddingLeftRight?: number; - /** Specifies the placeholder height of the slider marker. */ - placeholderHeight?: number; - /** - * Specifies in pixels the height and width of the space reserved for the range selector slider markers. - * @deprecated Use the 'placeholderHeight' and 'indent' options instead - */ - placeholderSize?: { - /** Specifies the height of the placeholder for the left and right slider markers. */ - height?: number; - /** Specifies the width of the placeholder for the left and right slider markers. */ - width?: { - /** Specifies the width of the left slider marker's placeholder. */ - left?: number; - /** Specifies the width of the right slider marker's placeholder. */ - right?: number; - }; - }; - /** Specifies a precision for the formatted value displayed in slider markers. */ - precision?: number; - /** Indicates whether or not the slider markers are visible. */ - visible?: boolean; - }; - } - /** A widget that allows end users to select a range of values on a scale. */ - export class dxRangeSelector extends viz.core.BaseWidget { - constructor(element: JQuery, options?: dxRangeSelectorOptions); - constructor(element: Element, options?: dxRangeSelectorOptions); - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(skipChartAnimation?: boolean): void; - /** Returns the currently selected range. */ - getSelectedRange(): { startValue: any; endValue: any; }; - /** Sets a specified range. */ - setSelectedRange(selectedRange: { startValue: any; endValue: any; }): void; - } -} -interface JQuery { - dxRangeSelector(options?: DevExpress.viz.rangeSelector.dxRangeSelectorOptions): JQuery; - dxRangeSelector(methodName: string, ...params: any[]): any; - dxRangeSelector(methodName: "instance"): DevExpress.viz.rangeSelector.dxRangeSelector; -} -declare namespace DevExpress.viz.map { - /** This section describes the fields and methods that can be used in code to manipulate the Area object. */ - export interface Area { - /** Contains the element type. */ - type: string; - /** Return the value of an attribute. */ - attribute(name: string): any; - /** Provides information about the selection state of an area. */ - selected(): boolean; - /** Sets a new selection state for an area. */ - selected(state: boolean): void; - /** Applies the area settings specified as a parameter and updates the area appearance. */ - applySettings(settings: any): void; - } - /** This section describes the fields and methods that can be used in code to manipulate the Markers object. */ - export interface Marker { - /** Contains the descriptive text accompanying the map marker. */ - text: string; - /** Contains the type of the element. */ - type: string; - /** Contains the URL of an image map marker. */ - url: string; - /** Contains the value of a bubble map marker. */ - value: number; - /** Contains the values of a pie map marker. */ - values: Array; - /** Returns the value of an attribute. */ - attribute(name: string): any; - /** Returns the coordinates of a specific marker. */ - coordinates(): Array; - /** Provides information about the selection state of a marker. */ - selected(): boolean; - /** Sets a new selection state for a marker. */ - selected(state: boolean): void; - /** Applies the marker settings specified as a parameter and updates the marker appearance. */ - applySettings(settings: any): void; - } - export interface AreaSettings { - /** Specifies the width of the area border in pixels. */ - borderWidth?: number; - /** Specifies a color for the area border. */ - borderColor?: string; - click?: any; - /** Specifies a color for an area. */ - color?: string; - /** Specifies the function that customizes each area individually. */ - customize?: (areaInfo: Area) => AreaSettings; - /** Specifies a color for the area border when the area is hovered over. */ - hoveredBorderColor?: string; - /** Specifies the pixel-measured width of the area border when the area is hovered over. */ - hoveredBorderWidth?: number; - /** Specifies a color for an area when this area is hovered over. */ - hoveredColor?: string; - /** Specifies whether or not to change the appearance of an area when it is hovered over. */ - hoverEnabled?: boolean; - /** Configures area labels. */ - label?: { - /** Specifies the data field that provides data for area labels. */ - dataField?: string; - /** Enables area labels. */ - enabled?: boolean; - /** Specifies font options for area labels. */ - font?: viz.core.Font; - }; - /** Specifies the name of the palette or a custom range of colors to be used for coloring a map. */ - palette?: any; - /** Specifies the number of colors in a palette. */ - paletteSize?: number; - /** Allows you to paint areas with similar attributes in the same color. */ - colorGroups?: Array; - /** Specifies the field that provides data to be used for coloring areas. */ - colorGroupingField?: string; - /** Specifies a color for the area border when the area is selected. */ - selectedBorderColor?: string; - /** Specifies a color for an area when this area is selected. */ - selectedColor?: string; - /** Specifies the pixel-measured width of the area border when the area is selected. */ - selectedBorderWidth?: number; - selectionChanged?: (area: Area) => void; - /** Specifies whether single or multiple areas can be selected on a vector map. */ - selectionMode?: string; - } - export interface MarkerSettings { - /** Specifies a color for the marker border. */ - borderColor?: string; - /** Specifies the width of the marker border in pixels. */ - borderWidth?: number; - click?: any; - /** Specifies a color for a marker of the dot or bubble type. */ - color?: string; - /** Specifies the function that customizes each marker individually. */ - customize?: (markerInfo: Marker) => MarkerSettings; - font?: Object; - /** Specifies the pixel-measured width of the marker border when the marker is hovered over. */ - hoveredBorderWidth?: number; - /** Specifies a color for the marker border when the marker is hovered over. */ - hoveredBorderColor?: string; - /** Specifies a color for a marker of the dot or bubble type when this marker is hovered over. */ - hoveredColor?: string; - /** Specifies whether or not to change the appearance of a marker when it is hovered over. */ - hoverEnabled?: boolean; - /** Specifies marker label options. */ - label?: { - /** Enables marker labels. */ - enabled?: boolean; - /** Specifies font options for marker labels. */ - font?: viz.core.Font; - }; - /** Specifies the pixel-measured diameter of the marker that represents the biggest value. Setting this option makes sense only if you use markers of the bubble type. */ - maxSize?: number; - /** Specifies the pixel-measured diameter of the marker that represents the smallest value. Setting this option makes sense only if you use markers of the bubble type. */ - minSize?: number; - /** Specifies the opacity of markers. Setting this option makes sense only if you use markers of the bubble type. */ - opacity?: number; - /** Specifies the pixel-measured width of the marker border when the marker is selected. */ - selectedBorderWidth?: number; - /** Specifies a color for the marker border when the marker is selected. */ - selectedBorderColor?: string; - /** Specifies a color for a marker of the dot or bubble type when this marker is selected. */ - selectedColor?: string; - selectionChanged?: (marker: Marker) => void; - /** Specifies whether a single or multiple markers can be selected on a vector map. */ - selectionMode?: string; - /** Specifies the size of markers. Setting this option makes sense for any type of marker except bubble. */ - size?: number; - /** Specifies the type of markers to be used on the map. */ - type?: string; - /** Specifies the name of a palette or a custom set of colors to be used for coloring markers of the pie type. */ - palette?: any; - /** Allows you to paint markers with similar attributes in the same color. */ - colorGroups?: Array; - /** Specifies the field that provides data to be used for coloring markers. */ - colorGroupingField?: string; - /** Allows you to display bubbles with similar attributes in the same size. */ - sizeGroups?: Array; - /** Specifies the field that provides data to be used for sizing bubble markers. */ - sizeGroupingField?: string; - } - export interface dxVectorMapOptions extends viz.core.BaseWidgetOptions { - /** An object specifying options for the map areas. */ - areaSettings?: AreaSettings; - /** Specifies the options for the map background. */ - background?: { - /** Specifies a color for the background border. */ - borderColor?: string; - /** Specifies a color for the background. */ - color?: string; - }; - /** Specifies the positioning of a map in geographical coordinates. */ - bounds?: Array; - /** Specifies the options of the control bar. */ - controlBar?: { - /** Specifies a color for the outline of the control bar elements. */ - borderColor?: string; - /** Specifies a color for the inner area of the control bar elements. */ - color?: string; - /** Specifies whether or not to display the control bar. */ - enabled?: boolean; - /** Specifies the margin of the control bar in pixels. */ - margin?: number; - /** Specifies the position of the control bar. */ - horizontalAlignment?: string; - /** Specifies the position of the control bar. */ - verticalAlignment?: string; - /** Specifies the opacity of the Control_Bar. */ - opacity?: number; - }; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies a data source for the map area. */ - mapData?: any; - /** Specifies a data source for the map markers. */ - markers?: any; - /** An object specifying options for the map markers. */ - markerSettings?: MarkerSettings; - /** Specifies the size of the dxVectorMap widget. */ - size?: viz.core.Size; - /** Specifies tooltip options. */ - tooltip?: viz.core.Tooltip; - /** Configures map legends. */ - legends?: Array; - /** Specifies whether or not the map should respond when a user rolls the mouse wheel. */ - wheelEnabled?: boolean; - /** Specifies whether the map should respond to touch gestures. */ - touchEnabled?: boolean; - /** Disables the zooming capability. */ - zoomingEnabled?: boolean; - /** Specifies the geographical coordinates of the center for a map. */ - center?: Array; - centerChanged?: (center: Array) => void; - /** A handler for the centerChanged event. */ - onCenterChanged?: (e: { - center: Array; - component: dxVectorMap; - element: Element; - }) => void; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: dxVectorMap; - element: Element; - target: {}; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: dxVectorMap; - element: Element; - target: {}; - }) => void; - /** Specifies a number that is used to zoom a map initially. */ - zoomFactor?: number; - /** Specifies a map's maximum zoom factor. */ - maxZoomFactor?: number; - zoomFactorChanged?: (zoomFactor: number) => void; - /** A handler for the zoomFactorChanged event. */ - onZoomFactorChanged?: (e: { - zoomFactor: number; - component: dxVectorMap; - element: Element; - }) => void; - click?: any; - /** A handler for the click event. */ - onClick?: any; - /** A handler for the areaClick event. */ - onAreaClick?: any; - /** A handler for the areaSelectionChanged event. */ - onAreaSelectionChanged?: (e: { - target: Area; - component: dxVectorMap; - element: Element; - }) => void; - /** A handler for the markerClick event. */ - onMarkerClick?: any; - /** A handler for the markerSelectionChanged event. */ - onMarkerSelectionChanged?: (e: { - target: Marker; - component: dxVectorMap; - element: Element; - }) => void; - /** Disables the panning capability. */ - panningEnabled?: boolean; - } - export interface Legend extends viz.core.BaseLegend { - /** Specifies text for legend items. */ - customizeText?: (itemInfo: { start: number; end: number; index: number; color: string; size: number; }) => string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the text of a legend item. */ - customizeHint?: (itemInfo: { start: number; end: number; index: number; color: string; size: number }) => string; - /** Specifies the source of data for the legend. */ - source?: string; - } - /** A vector map widget. */ - export class dxVectorMap extends viz.core.BaseWidget { - constructor(element: JQuery, options?: dxVectorMapOptions); - constructor(element: Element, options?: dxVectorMapOptions); - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(): void; - /** Gets the current coordinates of the map center. */ - center(): Array; - /** Sets the coordinates of the map center. */ - center(centerCoordinates: Array): void; - /** Deselects all the selected areas on a map. The areas are displayed in their initial style after. */ - clearAreaSelection(): void; - /** Deselects all the selected markers on a map. The markers are displayed in their initial style after. */ - clearMarkerSelection(): void; - /** Deselects all the selected area and markers on a map at once. The areas and markers are displayed in their initial style after. */ - clearSelection(): void; - /** Converts client area coordinates into map coordinates. */ - convertCoordinates(x: number, y: number): Array; - /** Returns an array with all the map areas. */ - getAreas(): Array; - /** Returns an array with all the map markers. */ - getMarkers(): Array; - /** Gets the current coordinates of the map viewport. */ - viewport(): Array; - /** Sets the coordinates of the map viewport. */ - viewport(viewportCoordinates: Array): void; - /** Gets the current value of the map zoom factor. */ - zoomFactor(): number; - /** Sets the value of the map zoom factor. */ - zoomFactor(zoomFactor: number): void; - } -} -interface JQuery { - dxVectorMap(options?: DevExpress.viz.map.dxVectorMapOptions): JQuery; - dxVectorMap(methodName: string, ...params: any[]): any; - dxVectorMap(methodName: "instance"): DevExpress.viz.map.dxVectorMap; -} -declare namespace DevExpress.viz.sparklines { - export interface SparklineTooltip extends viz.core.Tooltip { - /** - * Specifies how a tooltip is horizontally aligned relative to the graph. - * @deprecated Tooltip alignment is no more available. - */ - horizontalAlignment?: string; - /** - * Specifies how a tooltip is vertically aligned relative to the graph. - * @deprecated Tooltip alignment is no more available. - */ - verticalAlignment?: string; - } - export interface BaseSparklineOptions extends viz.core.BaseWidgetOptions { - /** Specifies the blank space between the widget's extreme elements and the boundaries of the area provided for the widget in pixels. */ - margin?: viz.core.Margins; - /** Specifies the size of the widget. */ - size?: viz.core.Size; - /** Specifies tooltip options. */ - tooltip?: SparklineTooltip; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: BaseSparkline; - element: Element; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: BaseSparkline; - element: Element; - }) => void; - } - /** Overridden by descriptions for particular widgets. */ - export class BaseSparkline extends viz.core.BaseWidget { - /** Redraws a widget. */ - render(): void; - } - export interface dxBulletOptions extends BaseSparkline { - /** Specifies a color for the bullet bar. */ - color?: string; - /** Specifies an end value for the invisible scale. */ - endScaleValue?: number; - /** Specifies whether or not to show the target line. */ - showTarget?: boolean; - /** Specifies whether or not to show the line indicating zero on the invisible scale. */ - showZeroLevel?: boolean; - /** Specifies a start value for the invisible scale. */ - startScaleValue?: number; - /** Specifies the value indicated by the target line. */ - target?: number; - /** Specifies a color for both the target and zero level lines. */ - targetColor?: string; - /** Specifies the width of the target line. */ - targetWidth?: number; - /** Specifies the primary value indicated by the bullet bar. */ - value?: number; - } - /** A bullet graph widget. */ - export class dxBullet extends BaseSparkline { - constructor(element: JQuery, options?: dxBulletOptions); - constructor(element: Element, options?: dxBulletOptions); - } - export interface dxSparklineOptions extends BaseSparklineOptions { - /** Specifies the data source field that provides arguments for a sparkline. */ - argumentField?: string; - /** Sets a color for the bars indicating negative values. Available for a sparkline of the bar type only. */ - barNegativeColor?: string; - /** Sets a color for the bars indicating positive values. Available for a sparkline of the bar type only. */ - barPositiveColor?: string; - /** Specifies a data source for the sparkline. */ - dataSource?: Array; - /** Sets a color for the boundary of both the first and last points on a sparkline. */ - firstLastColor?: string; - /** Specifies whether a sparkline ignores null data points or not. */ - ignoreEmptyPoints?: boolean; - /** Sets a color for a line on a sparkline. Available for the sparklines of the line- and area-like types. */ - lineColor?: string; - /** Specifies a width for a line on a sparkline. Available for the sparklines of the line- and area-like types. */ - lineWidth?: number; - /** Sets a color for the bars indicating the values that are less than the winloss threshold. Available for a sparkline of the winloss type only. */ - lossColor?: string; - /** Sets a color for the boundary of the maximum point on a sparkline. */ - maxColor?: string; - /** Sets a color for the boundary of the minimum point on a sparkline. */ - minColor?: string; - /** Sets a color for points on a sparkline. Available for the sparklines of the line- and area-like types. */ - pointColor?: string; - /** Specifies the diameter of sparkline points in pixels. Available for the sparklines of line- and area-like types. */ - pointSize?: number; - /** Specifies a symbol to use as a point marker on a sparkline. Available for the sparklines of the line- and area-like types. */ - pointSymbol?: string; - /** Specifies whether or not to indicate both the first and last values on a sparkline. */ - showFirstLast?: boolean; - /** Specifies whether or not to indicate both the minimum and maximum values on a sparkline. */ - showMinMax?: boolean; - /** Determines the type of a sparkline. */ - type?: string; - /** Specifies the data source field that provides values for a sparkline. */ - valueField?: string; - /** Sets a color for the bars indicating the values greater than a winloss threshold. Available for a sparkline of the winloss type only. */ - winColor?: string; - /** Specifies a value that serves as a threshold for the sparkline of the winloss type. */ - winlossThreshold?: number; - /** Specifies the minimum value of the sparkline value axis. */ - minValue?: number; - /** Specifies the maximum value of the sparkline's value axis. */ - maxValue?: number; - } - /** A sparkline widget. */ - export class dxSparkline extends BaseSparkline { - constructor(element: JQuery, options?: dxSparklineOptions); - constructor(element: Element, options?: dxSparklineOptions); - } -} -interface JQuery { - dxBullet(options?: DevExpress.viz.sparklines.dxBulletOptions): JQuery; - dxBullet(methodName: string, ...params: any[]): any; - dxBullet(methodName: "instance"): DevExpress.viz.sparklines.dxBullet; - dxSparkline(options?: DevExpress.viz.sparklines.dxSparklineOptions): JQuery; - dxSparkline(methodName: string, ...params: any[]): any; - dxSparkline(methodName: "instance"): DevExpress.viz.sparklines.dxSparkline; -} diff --git a/devextreme/devextreme-15.1.6.d.ts b/devextreme/devextreme-15.1.6.d.ts deleted file mode 100644 index 056ba14ee7..0000000000 --- a/devextreme/devextreme-15.1.6.d.ts +++ /dev/null @@ -1,6621 +0,0 @@ -// Type definitions for DevExtreme 15.1.6 -// Project: http://js.devexpress.com/ -// Definitions by: DevExpress Inc. -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -/// - -declare namespace DevExpress { - /** A mixin that provides a capability to fire and subscribe to events. */ - export interface EventsMixin { - /** Subscribes to a specified event. */ - on(eventName: string, eventHandler: Function): T; - /** Subscribes to the specified events. */ - on(events: { [eventName: string]: Function; }): T; - /** Detaches all event handlers from the specified event. */ - off(eventName: string): Object; - /** Detaches a particular event handler from the specified event. */ - off(eventName: string, eventHandler: Function): T; - } - /** An object that serves as a namespace for the methods required to perform validation. */ - export module validationEngine { - export interface IValidator { - validate(): ValidatorValidationResult; - reset(): void; - } - export interface ValidatorValidationResult { - isValid: boolean; - name?: string; - value: any; - brokenRule: any; - validationRules: any[]; - } - export interface ValidationGroupValidationResult { - isValid: boolean; - brokenRules: any[]; - validators: IValidator[]; - } - export interface GroupConfig extends EventsMixin { - group: any; - validators: IValidator[]; - validate(): ValidationGroupValidationResult; - reset(): void; - } - /** Provides access to the object that represents the specified validation group. */ - export function getGroupConfig(group: any): GroupConfig - /** Provides access to the object that represents the default validation group. */ - export function getGroupConfig(): GroupConfig - /** Validates rules of the validators that belong to the specified validation group. */ - export function validateGroup(group: any): ValidationGroupValidationResult; - /** Validates rules of the validators that belong to the default validation group. */ - export function validateGroup(): ValidationGroupValidationResult; - /** Resets the values and validation result of the editors that belong to the specified validation group. */ - export function resetGroup(group: any): void; - /** Resets the values and validation result of the editors that belong to the default validation group. */ - export function resetGroup(): void; - /** Validates the rules that are defined within the dxValidator objects that are registered for the specified ViewModel. */ - export function validateModel(model: Object): ValidationGroupValidationResult; - /** Registers all the dxValidator objects by which the fields of the specified ViewModel are extended. */ - export function registerModelForValidation(model: Object): void; - } - export var hardwareBackButton: JQueryCallback; - /** Processes the hardware back button click. */ - export function processHardwareBackButton(): void; - /** Specifies whether or not the entire application/site supports right-to-left representation. */ - export var rtlEnabled: boolean; - /** Registers a new component in the DevExpress.ui namespace as a jQuery plugin, Angular directive and Knockout binding. */ - export function registerComponent(name: string, componentClass: Object): void; - /** Registers a new component in the specified namespace as a jQuery plugin, Angular directive and Knockout binding. */ - export function registerComponent(name: string, namespace: Object, componentClass: Object): void; - /** Requests that the browser call a specified function to update animation before the next repaint. */ - export function requestAnimationFrame(callback: Function): number; - /** Cancels an animation frame request scheduled with the requestAnimationFrame method. */ - export function cancelAnimationFrame(requestID: number): void; - /** Custom Knockout binding that links an HTML element with a specific action. */ - export class Action { } - /** Used to get URLs that vary in a locally running application and the application running on production. */ - export class EndpointSelector { - constructor(options: { - [key: string]: { - local?: string; - production?: string; - } - }); - /** Returns a local or a productional URL depending on how the application is currently running. */ - urlFor(key: string): string; - } - /** An object that serves as a namespace for the methods that are used to animate UI elements. */ - export module fx { - /** Defines animation options. */ - export interface AnimationOptions { - /** A function called after animation is completed. */ - complete?: (element: JQuery, config: AnimationOptions) => void; - /** A number specifying wait time before animation execution. */ - delay?: number; - /** A number specifying the time period to wait before the animation of the next stagger item starts. */ - staggerDelay?: number; - /** A number specifying the time in milliseconds spent on animation. */ - duration?: number; - /** A string specifying the type of an easing function used for animation. */ - easing?: string; - /** Specifies the initial animation state. */ - from?: any; - /** A function called before animation is started. */ - start?: (element: JQuery, config: AnimationOptions) => void; - /** Specifies a final animation state. */ - to?: any; - /** A string value specifying the animation type. */ - type?: string; - /** Specifies the animation direction for the "slideIn" and "slideOut" animation types. */ - direction?: string; - } - /** Animates the specified element. */ - export function animate(element: HTMLElement, config: AnimationOptions): Object; - /** Returns a value indicating whether the specified element is being animated. */ - export function isAnimating(element: HTMLElement): boolean; - /** Stops the animation. */ - export function stop(element: HTMLElement, jumpToEnd: boolean): void; - } - /** The manager that performs several specified animations at a time. */ - export class TransitionExecutor { - /** Deletes all the animations registered in the Transition Executor by using the enter(elements, animation) and leave(elements, animation) methods. */ - reset(): void; - /** Registers a set of elements that should be animated as "entering" using the specified animation configuration. */ - enter(elements: JQuery, animation: any): void; - /** Registers a set of elements that should be animated as "leaving" using the specified animation configuration. */ - leave(elements: JQuery, animation: any): void; - /** Starts all the animations registered using the enter(elements, animation) and leave(elements, animation) methods beforehand. */ - start(config: Object): JQueryPromise; - } - export class AnimationPresetCollection { - /** Resets all the changes made in the animation repository. */ - resetToDefaults(): void; - /** Deletes the specified animation or clears all the animation repository, if an animation name is not passed. */ - clear(name: string): void; - /** Adds the specified animation preset to the animation repository by the specified name. */ - registerPreset(name: string, config: any): void; - /** Applies the changes made in the animation repository. */ - applyChanges(): void; - /** Returns the configuration of the animation found in the animation repository by the specified name for the current device. */ - getPreset(name: string): void; - /** Registers predefined animations in the animation repository. */ - registerDefaultPresets(): void; - } - /** A repository of animations. */ - export var animationPresets: AnimationPresetCollection; - /** The device object defines the device on which the application is running. */ - export interface Device { - /** Indicates whether or not the device platform is Android. */ - android?: boolean; - /** Specifies the type of the device on which the application is running. */ - deviceType?: string; - /** Indicates whether or not the device platform is generic, which means that the application will look and behave according to a generic "light" or "dark" theme. */ - generic?: boolean; - /** Indicates whether or not the device platform is iOS. */ - ios?: boolean; - /** Indicates whether or not the device type is 'phone'. */ - phone?: boolean; - /** Specifies the platform of the device on which the application is running. */ - platform?: string; - /** Indicates whether or not the device type is 'tablet'. */ - tablet?: boolean; - /** Specifies an array with the major and minor versions of the device platform. */ - version?: Array; - /** Indicates whether or not the device platform is Windows8. */ - win8?: boolean; - /** Specifies a performance grade of the current device. */ - grade?: string; - } - export class Devices implements EventsMixin { - constructor(options: { window: Window }); - /** Overrides actual device information to force the application to operate as if it was running on the specified device. */ - current(deviceName: any): void; - /** Returns information about the current device. */ - current(): Device; - orientationChanged: JQueryCallback; - /** Returns the current device orientation. */ - orientation(): string; - /** Returns real information about the current device regardless of the value passed to the devices.current(deviceName) method. */ - real(): Device; - on(eventName: "orientationChanged", eventHandler: (e: { orientation: string }) => void): Devices; - on(eventName: string, eventHandler: Function): Devices; - on(events: { [eventName: string]: Function; }): Devices; - off(eventName: "orientationChanged"): Devices; - off(eventName: string): Devices; - off(eventName: "orientationChanged", eventHandler: (e: { orientation: string }) => void): Devices; - off(eventName: string, eventHandler: Function): Devices; - } - /** An object that serves as a namespace for the methods and events specifying information on the current device. */ - export var devices: Devices; - /** The position object specifies the widget positioning options. */ - export interface PositionOptions { - /** The target element position that the widget is positioned against. */ - at?: string; - /** The element within which the widget is positioned. */ - boundary?: Element; - /** A string value holding horizontal and vertical offset from the window's boundaries. */ - boundaryOffset?: string; - /** Specifies how to move the widget if it overflows the screen. */ - collision?: any; - /** The position of the widget to align against the target element. */ - my?: string; - /** The target element that the widget is positioned against. */ - of?: HTMLElement; - /** A string value holding horizontal and vertical offset in pixels, separated by a space (e.g., "5 -10"). */ - offset?: string; - } - export interface ComponentOptions { - /** A handler for the initialized event. */ - onInitialized?: Function; - /** A handler for the optionChanged event. */ - onOptionChanged?: Function; - /** A handler for the disposing event. */ - onDisposing?: Function; - } - /** A base class for all components and widgets. */ - export class Component { - constructor(options?: ComponentOptions) - /** Prevents the component from refreshing until the endUpdate method is called. */ - beginUpdate(): void; - /** Enables the component to refresh after the beginUpdate method call. */ - endUpdate(): void; - /** Returns an instance of this component class. */ - instance(): Component; - /** Sets one or more options of this component. */ - option(options: Object): void; - /** Returns the configuration options of this component. */ - option(): Object; - /** Gets the value of the specified configuration option of this component. */ - option(optionName: string): any; - /** Sets a value to the specified configuration option of this component. */ - option(optionName: string, optionValue: any): void; - } - export interface DOMComponentOptions extends ComponentOptions { - /** Specifies whether or not the current component supports a right-to-left representation. */ - rtlEnabled?: boolean; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies the width of the widget. */ - width?: any; - } - /** A base class for all components. */ - export class DOMComponent extends Component { - constructor(element: JQuery, options?: DOMComponentOptions); - constructor(element: HTMLElement, options?: DOMComponentOptions); - /** Returns the root HTML element of the widget. */ - element(): JQuery; - /** Specifies the device-dependent default configuration options for this component. */ - static defaultOptions(rule: { - device?: any; - options?: any; - }): void; - } - export module data { - export interface ODataError extends Error { - httpStatus?: number; - errorDetails?: any; - } - export interface StoreOptions { - inserted?: (values: Object, key: any) => void; - inserting?: (values: Object) => void; - loaded?: (result: Array) => void; - loading?: (loadOptions: LoadOptions) => void; - modified?: () => void; - modifying?: () => void; - removed?: (key: any) => void; - removing?: (key: any) => void; - updated?: (key: any, values: Object) => void; - updating?: (key: any, values: Object) => void; - /** A handler for the modified event. */ - onModified?: () => void; - /** A handler for the modifying event. */ - onModifying?: () => void; - /** A handler for the removed event. */ - onRemoved?: (key: any) => void; - /** A handler for the removing event. */ - onRemoving?: (key: any) => void; - /** A handler for the updated event. */ - onUpdated?: (key: any, values: Object) => void; - /** A handler for the updating event. */ - onUpdating?: (key: any, values: Object) => void; - /** A handler for the loaded event. */ - onLoaded?: (result: Array) => void; - /** A handler for the loading event. */ - onLoading?: (loadOptions: LoadOptions) => void; - /** A handler for the inserted event. */ - onInserted?: (values: Object, key: any) => void; - /** A handler for the inserting event. */ - onInserting?: (values: Object) => void; - /** Specifies the function called when the Store causes an error. */ - errorHandler?: (e: Error) => void; - /** Specifies the key properties within the data associated with the Store. */ - key?: any; - } - export interface LoadOptions { - filter?: Object; - sort?: Object; - select?: Object; - expand?: Object; - group?: Object; - skip?: number; - take?: number; - userData?: Object; - requireTotalCount?: boolean; - } - /** The base class for all Stores. */ - export class Store implements EventsMixin { - inserted: JQueryCallback; - inserting: JQueryCallback; - loaded: JQueryCallback; - loading: JQueryCallback; - modified: JQueryCallback; - modifying: JQueryCallback; - removed: JQueryCallback; - removing: JQueryCallback; - updated: JQueryCallback; - updating: JQueryCallback; - constructor(options?: StoreOptions); - /** Returns the data item specified by the key. */ - byKey(key: any): JQueryPromise; - /** Adds an item to the data associated with this Store. */ - insert(values: Object): JQueryPromise; - /** Returns the key expression specified via the key configuration option. */ - key(): any; - /** Returns the key of the Store item that matches the specified object. */ - keyOf(obj: Object): any; - /** Starts loading data. */ - load(obj?: LoadOptions): JQueryPromise; - /** Removes the data item specified by the key. */ - remove(key: any): JQueryPromise; - /** Obtains the total count of items that will be returned by the load() function. */ - totalCount(obj?: { - filter?: Object; - select?: Object; - group?: Object; - sort?: Object; - }): JQueryPromise; - /** Updates the data item specified by the key. */ - update(key: any, values: Object): JQueryPromise; - on(eventName: "removing", eventHandler: (key: any) => void): Store; - on(eventName: "removed", eventHandler: (key: any) => void): Store; - on(eventName: "updating", eventHandler: (key: any, values: Object) => void): Store; - on(eventName: "updated", eventHandler: (key: any, values: Object) => void): Store; - on(eventName: "inserting", eventHandler: (values: Object) => void): Store; - on(eventName: "inserted", eventHandler: (values: Object, key: any) => void): Store; - on(eventName: "modifying", eventHandler: () => void): Store; - on(eventName: "modified", eventHandler: () => void): Store; - on(eventName: "loading", eventHandler: (loadOptions: LoadOptions) => void): Store; - on(eventName: "loaded", eventHandler: (result: Array) => void): Store; - on(eventName: string, eventHandler: Function): Store; - on(events: { [eventName: string]: Function; }): Store; - off(eventName: "removing"): Store; - off(eventName: "removed"): Store; - off(eventName: "updating"): Store; - off(eventName: "updated"): Store; - off(eventName: "inserting"): Store; - off(eventName: "inserted"): Store; - off(eventName: "modifying"): Store; - off(eventName: "modified"): Store; - off(eventName: "loading"): Store; - off(eventName: "loaded"): Store; - off(eventName: string): Store; - off(eventName: "removing", eventHandler: (key: any) => void): Store; - off(eventName: "removed", eventHandler: (key: any) => void): Store; - off(eventName: "updating", eventHandler: (key: any, values: Object) => void): Store; - off(eventName: "updated", eventHandler: (key: any, values: Object) => void): Store; - off(eventName: "inserting", eventHandler: (values: Object) => void): Store; - off(eventName: "inserted", eventHandler: (values: Object, key: any) => void): Store; - off(eventName: "modifying", eventHandler: () => void): Store; - off(eventName: "modified", eventHandler: () => void): Store; - off(eventName: "loading", eventHandler: (loadOptions: LoadOptions) => void): Store; - off(eventName: "loaded", eventHandler: (result: Array) => void): Store; - off(eventName: string, eventHandler: Function): Store; - } - export interface ArrayStoreOptions extends StoreOptions { - /** Specifies the array associated with this Store. */ - data?: Array; - } - /** A Store accessing an in-memory array. */ - export class ArrayStore extends Store { - constructor(options?: ArrayStoreOptions); - /** Clears all data associated with the current ArrayStore. */ - clear(): void; - /** Creates the Query object for the underlying array. */ - createQuery(): Query; - } - interface Promise { - then(doneFn?: Function, failFn?: Function, progressFn?: Function): Promise; - } - export interface CustomStoreOptions extends StoreOptions { - /** The user implementation of the byKey(key, extraOptions) method. */ - byKey?: (key: any) => Promise; - /** The user implementation of the insert(values) method. */ - insert?: (values: Object) => Promise; - /** The user implementation of the load(options) method. */ - load?: (options?: LoadOptions) => Promise; - /** The user implementation of the remove(key) method. */ - remove?: (key: any) => Promise; - /** The user implementation of the totalCount(options) method. */ - totalCount?: () => Promise; - /** The user implementation of the update(key, values) method. */ - update?: (key: any, values: Object) => Promise; - } - /** A Store object that enables you to implement your own data access logic. */ - export class CustomStore extends Store { - constructor(options: CustomStoreOptions); - } - export interface DataSourceOptions { - /** Specifies data filtering conditions. */ - filter?: Object; - /** Specifies data grouping conditions. */ - group?: Object; - /** The item mapping function. */ - map?: (record: any) => any; - /** Specifies the maximum number of items the page can contain. */ - pageSize?: number; - /** Specifies whether a DataSource loads data by pages, or all items at once. */ - paginate?: boolean; - /** The data post processing function. */ - postProcess?: (data: any[]) => any[]; - /** Specifies a value by which the required items are searched. */ - searchExpr?: Object; - /** Specifies the comparison operation used to search for the required items. */ - searchOperation?: string; - /** Specifies the value to which the search expression is compared. */ - searchValue?: Object; - /** Specifies the initial select option value. */ - select?: Object; - /** An array of the strings that represent the names of the navigation properties to be loaded simultaneously with the OData store's entity. */ - expand?: Object; - /** Specifies whether or not the DataSource instance requests the total count of items available in the storage. */ - requireTotalCount?: boolean; - /** Specifies the initial sort option value. */ - sort?: Object; - /** Specifies the underlying Store instance used to access data. */ - store?: any; - /** A handler for the changed event. */ - onChanged?: () => void; - /** A handler for the loadingChanged event. */ - onLoadingChanged?: (isLoading: boolean) => void; - /** A handler for the loadError event. */ - onLoadError?: (e?: Error) => void; - } - /** An object that provides access to a data web service or local data storage for collection container widgets. */ - export class DataSource implements EventsMixin { - constructor(options?: DataSourceOptions); - changed: JQueryCallback; - loadError: JQueryCallback; - loadingChanged: JQueryCallback; - /** Disposes all resources associated with this DataSource. */ - dispose(): void; - /** Returns the current filter option value. */ - filter(): Object; - /** Sets the filter option value. */ - filter(filterExpr: Object): void; - /** Returns the current group option value. */ - group(): Object; - /** Sets the group option value. */ - group(groupExpr: Object): void; - /** Indicates whether or not the current page contains fewer items than the number of items specified by the pageSize configuration option. */ - isLastPage(): boolean; - /** Indicates whether or not at least one load() method execution has successfully finished. */ - isLoaded(): boolean; - /** Indicates whether or not the DataSource is currently being loaded. */ - isLoading(): boolean; - /** Returns the array of items currently operated by the DataSource. */ - items(): Array; - /** Returns the key expression. */ - key(): any; - /** Starts loading data. */ - load(): JQueryPromise>; - /** Returns an object that would be passed to the load() method of the underlying Store according to the current data shaping option values of the current DataSource instance. */ - loadOptions(): Object; - /** Returns the current pageSize option value. */ - pageSize(): number; - /** Sets the pageSize option value. */ - pageSize(value: number): void; - /** Specifies the index of the currently loaded page. */ - pageIndex(): number; - /** Specifies the index of the page to be loaded during the next load() method execution. */ - pageIndex(newIndex: number): void; - /** Returns the current paginate option value. */ - paginate(): boolean; - /** Sets the paginate option value. */ - paginate(value: boolean): void; - /** Returns the searchExpr option value. */ - searchExpr(): Object; - /** Sets the searchExpr option value. */ - searchExpr(expr: Object): void; - /** Returns the currently specified search operation. */ - searchOperation(): string; - /** Sets the current search operation. */ - searchOperation(op: string): void; - /** Returns the searchValue option value. */ - searchValue(): Object; - /** Sets the searchValue option value. */ - searchValue(value: Object): void; - /** Returns the current select option value. */ - select(): Object; - /** Sets the select option value. */ - select(expr: Object): void; - /** Returns the current requireTotalCount option value. */ - requireTotalCount(): boolean; - /** Sets the requireTotalCount option value. */ - requireTotalCount(value: boolean): void; - /** Returns the current sort option value. */ - sort(): Object; - /** Sets the sort option value. */ - sort(sortExpr: Object): void; - /** Returns the underlying Store instance. */ - store(): Store; - /** Returns the number of data items available in an underlying Store after the last load() operation without paging. */ - totalCount(): number; - on(eventName: "loadingChanged", eventHandler: (isLoading: boolean) => void): DataSource; - on(eventName: "loadError", eventHandler: (e?: Error) => void): DataSource; - on(eventName: "changed", eventHandler: () => void): DataSource; - on(eventName: string, eventHandler: Function): DataSource; - on(events: { [eventName: string]: Function; }): DataSource; - off(eventName: "loadingChanged"): DataSource; - off(eventName: "loadError"): DataSource; - off(eventName: "changed"): DataSource; - off(eventName: string): DataSource; - off(eventName: "loadingChanged", eventHandler: (isLoading: boolean) => void): DataSource; - off(eventName: "loadError", eventHandler: (e?: Error) => void): DataSource; - off(eventName: "changed", eventHandler: () => void): DataSource; - off(eventName: string, eventHandler: Function): DataSource; - } - /** An object used to work with primitive data types not supported by JavaScript when accessing an OData web service. */ - export class EdmLiteral { - /** Creates an EdmLiteral instance and assigns the specified value to it. */ - constructor(value: string); - /** Returns a string representation of the value associated with this EdmLiteral object. */ - valueOf(): string; - } - /** An object used to generate and hold the GUID. */ - export class Guid { - /** Creates a new Guid instance that holds the specified GUID. */ - constructor(value: string); - /** Creates a new Guid instance holding the generated GUID. */ - constructor(); - /** Returns a string representation of the Guid instance. */ - toString(): string; - /** Returns a string representation of the Guid instance. */ - valueOf(): string; - } - export interface LocalStoreOptions extends ArrayStoreOptions { - /** Specifies the time (in miliseconds) after the change operation, before the data is flushed. */ - flushInterval?: number; - /** Specifies whether the data is flushed immediatelly after each change operation, or after the delay specified via the flushInterval option. */ - immediate?: boolean; - /** The unique identifier used to distinguish the data within the HTML5 Web Storage. */ - name?: string; - } - /** A Store providing access to the HTML5 Web Storage. */ - export class LocalStore extends ArrayStore { - constructor(options?: LocalStoreOptions); - /** Removes all data associated with this Store. */ - clear(): void; - } - export interface ODataContextOptions extends ODataStoreOptions { - /** Specifies the list of entities to be accessed via the ODataContext. */ - entities?: Object; - /** Specifies the function called if the ODataContext causes an error. */ - errorHandler?: (e: Error) => void; - } - /** Provides access to the entire OData service. */ - export class ODataContext { - constructor(options?: ODataContextOptions); - /** Initiates the specified WebGet service operation that returns a value. For the information on service operations, refer to the OData documentation. */ - get(operationName: string, params: Object): JQueryPromise; - /** Initiates the specified WebGet service operation that returns nothing. For the information on service operations, refer to the OData documentation. */ - invoke(operationName: string, params: Object, httpMethod: Object): JQueryPromise; - /** Return a special proxy object to describe the entity link. */ - objectLink(entityAlias: string, key: any): Object; - } - export interface ODataStoreOptions extends StoreOptions { - /** A function used to customize a web request before it is sent. */ - beforeSend?: (request: { - url: string; - method: string; - timeout: number; - params: Object; - payload: Object; - headers: Object; - }) => void; - /** Specifies whether the ODataStore uses the JSONP approach to access non-CORS-compatible remote services. */ - jsonp?: boolean; - /** Specifies the type of the ODataStore key property. The following key types are supported out of the box: String, Int32, Int64, and Guid. */ - keyType?: any; - /** Specifies the URL of the data service being accessed via the current ODataContext. */ - url?: string; - /** Specifies the version of the OData protocol used to interact with the data service. */ - version?: number; - /** Specifies the value of the withCredentials field of the underlying jqXHR object. */ - withCredentials?: boolean; - } - /** A Store providing access to a separate OData web service entity. */ - export class ODataStore extends Store { - constructor(options?: ODataStoreOptions); - /** Creates the Query object for the OData endpoint. */ - createQuery(loadOptions: Object): Object; - /** Returns the data item specified by the key. */ - byKey(key: any, extraOptions?: { expand?: Object }): JQueryPromise; - } - /** An universal chainable data query interface object. */ - export interface Query { - /** Calculates a custom summary for the items in the current Query. */ - aggregate(step: (accumulator: any, value: any) => any): JQueryPromise; - /** Calculates a custom summary for the items in the current Query. */ - aggregate(seed: any, step: (accumulator: any, value: any) => any, finalize: (result: any) => any): JQueryPromise; - /** Calculates the average item value for the current Query. */ - avg(getter: Object): JQueryPromise; - /** Finds the item with the maximum getter value. */ - max(getter: Object): JQueryPromise; - /** Finds the item with the maximum value in the Query. */ - max(): JQueryPromise; - /** Finds the item with the minimum value in the Query. */ - min(): JQueryPromise; - /** Finds the item with the minimum getter value. */ - min(getter: Object): JQueryPromise; - /** Calculates the average item value for the current Query, if each Query item has a numeric type. */ - avg(): JQueryPromise; - /** Returns the total count of items in the current Query. */ - count(): JQueryPromise; - /** Executes the Query. */ - enumerate(): JQueryPromise; - /** Filters the current Query data. */ - filter(criteria: Array): Query; - /** Groups the current Query data. */ - groupBy(getter: Object): Query; - /** Applies the specified transformation to each item. */ - select(getter: Object): Query; - /** Limits the data item count. */ - slice(skip: number, take?: number): Query; - /** Sorts current Query data. */ - sortBy(getter: Object, desc: boolean): Query; - /** Sorts current Query data. */ - sortBy(getter: Object): Query; - /** Calculates the sum of item getter values in the current Query. */ - sum(getter: Object): JQueryPromise; - /** Calculates the sum of item values in the current Query. */ - sum(): JQueryPromise; - /** Adds one more sorting condition to the current Query. */ - thenBy(getter: Object): Query; - /** Adds one more sorting condition to the current Query. */ - thenBy(getter: Object, desc: boolean): Query; - /** Returns the array of current Query items. */ - toArray(): Array; - } - /** The global data layer error handler. */ - export var errorHandler: (e: Error) => void; - /** Encodes the specified string or array of bytes to base64 encoding. */ - export function base64_encode(input: any): string; - /** Creates a Query instance. */ - export function query(array: Array): Query; - /** Creates a Query instance for accessing the remote service specified by a URL. */ - export function query(url: string, queryOptions: Object): Query; - /** This section describes the utility objects provided by the DevExtreme data layer. */ - export var utils: { - /** Compiles a getter function from the getter expression. */ - compileGetter(expr: any): Function; - /** Compiles a setter function from the setter expression. */ - compileSetter(expr: any): Function; - odata: { - /** Holds key value converters for OData. */ - keyConverters: { - String(value: any): string; - Int32(value: any): number; - Int64(value: any): EdmLiteral; - Guid(value: any): Guid; - Boolean(value: any): boolean; - Single(value: any): EdmLiteral; - Decimal(value: any): EdmLiteral; - }; - } - } - } - /** An object that serves as a namespace for DevExtreme UI widgets as well as for methods implementing UI logic in DevExtreme sites/applications. */ - export module ui { - export interface WidgetOptions extends DOMComponentOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A Boolean value specifying whether or not the widget can respond to user interaction. */ - disabled?: boolean; - /** A Boolean value specifying whether or not the widget changes its state when being hovered by an end user. */ - hoverStateEnabled?: boolean; - /** Specifies whether or not the widget can be focused. */ - focusStateEnabled?: boolean; - /** Specifies a shortcut key that sets focus on the widget element. */ - accessKey?: string; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - /** Specifies the widget tab index. */ - tabIndex?: number; - /** Specifies the text of the hint displayed for the widget. */ - hint?: string; - } - /** The base class for widgets. */ - export class Widget extends DOMComponent { - constructor(options?: WidgetOptions); - /** Redraws the widget. */ - repaint(): void; - /** Sets focus on the widget. */ - focus(): void; - /** Registers a handler for pressing of the specified key. */ - registerKeyHandler(key: string, handler: Function): void; - } - export interface CollectionWidgetOptions extends WidgetOptions { - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - itemClickAction?: any; - itemHoldAction?: Function; - /** The time period in milliseconds before the onItemHold event is raised. */ - itemHoldTimeout?: number; - itemRender?: any; - itemRenderedAction?: Function; - /** An array of items displayed by the widget. */ - items?: Array; - /** - * A function performed when a widget item is selected. - * @deprecated onSelectionChanged.md - */ - itemSelectAction?: Function; - /** The template to be used for rendering items. */ - itemTemplate?: any; - loopItemFocus?: boolean; - /** The text or HTML markup displayed by the widget if the item collection is empty. */ - noDataText?: string; - onContentReady?: any; - contentReadyAction?: any; - /** A handler for the itemClick event. */ - onItemClick?: any; - /** A handler for the itemContextMenu event. */ - onItemContextMenu?: Function; - /** A handler for the itemHold event. */ - onItemHold?: Function; - /** A handler for the itemRendered event. */ - onItemRendered?: Function; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: Function; - /** The index of the currently selected widget item. */ - selectedIndex?: number; - /** The selected item object. */ - selectedItem?: Object; - /** An array of currently selected item objects. */ - selectedItems?: Array; - /** A handler for the itemDeleting event. */ - onItemDeleting?: Function; - /** A handler for the itemDeleted event. */ - onItemDeleted?: Function; - /** A handler for the itemReordered event. */ - onItemReordered?: Function; - } - /** The base class for widgets containing an item collection. */ - export class CollectionWidget extends Widget { - constructor(element: JQuery, options?: CollectionWidgetOptions); - constructor(element: HTMLElement, options?: CollectionWidgetOptions); - selectItem(itemElement: any): void; - unselectItem(itemElement: any): void; - deleteItem(itemElement: any): JQueryPromise; - isItemSelected(itemElement: any): boolean; - reorderItem(itemElement: any, toItemElement: any): JQueryPromise; - } - export interface DataExpressionMixinOptions { - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** Specifies the name of the data source item field whose value is displayed by the widget. */ - displayExpr?: any; - /** Specifies the name of a data source item field whose value is held in the value configuration option. */ - valueExpr?: any; - itemRender?: any; - /** An array of items displayed by the widget. */ - items?: Array; - /** The template to be used for rendering items. */ - itemTemplate?: any; - /** The currently selected value in the widget. */ - value?: Object; - } - export interface EditorOptions extends WidgetOptions { - /** The currently specified value. */ - value?: Object; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - valueChangeAction?: Function; - /** A Boolean value specifying whether or not the widget is read-only. */ - readOnly?: boolean; - /** Holds the object that defines the error that occurred during validation. */ - validationError?: Object; - /** Specifies whether the editor's value is valid. */ - isValid?: boolean; - /** Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed. */ - validationMessageMode?: string; - } - /** A base class for editors. */ - export class Editor extends Widget { - /** Resets the editor's value to undefined. */ - reset(): void; - } - /** An object that serves as a namespace for methods displaying a message in an application/site. */ - export var dialog: { - /** Creates an alert dialog message containing a single "OK" button. */ - alert(message: string, title: string): JQueryPromise; - /** Creates a confirm dialog that contains "Yes" and "No" buttons. */ - confirm(message: string, title: string): JQueryPromise; - /** Creates a custom dialog using the options specified by the passed configuration object. */ - custom(options: { title?: string; message?: string; buttons?: Array; }): { - show(): JQueryPromise; - hide(): void; - hide(value: any): void; - }; - }; - /** Creates a toast message. */ - export function notify(message: any, type: string, displayTime: number): void; - /** Creates a toast message. */ - export function notify(options: Object): void; - /** An object that serves as a namespace for the methods that work with DevExtreme CSS Themes. */ - export var themes: { - /** Returns the name of the currently applied theme. */ - current(): string; - /** Changes the current theme to the specified one. */ - current(themeName: string): void; - }; - /** Sets a specified template engine. */ - export function setTemplateEngine(name: string): void; - /** Sets a custom template engine defined via custom compile and render functions. */ - export function setTemplateEngine(options: Object): void; - } - /** An object that serves as a namespace for utility methods that can be helpful when working with the DevExtreme framework and UI widgets. */ - export var utils: { - /** Sets parameters for the viewport meta tag. */ - initMobileViewport(options: { allowZoom?: boolean; allowPan?: boolean; allowSelection?: boolean }): void; - }; - /** An object that serves as a namespace for DevExtreme Data Visualization Widgets. */ - export module viz { - /** Applies a theme for the entire page with several DevExtreme visualization widgets. */ - export function currentTheme(theme: string): void; - /** Applies a new theme (with the color scheme defined separately) for the entire page with several DevExtreme visualization widgets. */ - export function currentTheme(platform: string, colorScheme: string): void; - /** Registers a new theme based on the existing one. */ - export function registerTheme(customTheme: Object, baseTheme: string): void; - /** Applies a predefined or registered custom palette to all visualization widgets at once. */ - export function currentPalette(paletteName: string): void; - /** Obtains the color sets of a predefined or registered palette. */ - export function getPalette(paletteName: string): Object; - /** Registers a new palette. */ - export function registerPalette(paletteName: string, palette: Object): void; - } -} -declare namespace DevExpress.ui { - export interface dxValidatorOptions extends DOMComponentOptions { - /** An array of validation rules to be checked for the editor with which the dxValidator object is associated. */ - validationRules?: Array; - /** Specifies the editor name to be used in the validation default messages. */ - name?: string; - /** An object that specifies what and when to validate and how to apply the validation result. */ - adapter?: Object; - /** Specifies the validation group the editor will be related to. */ - validationGroup?: string; - /** A handler for the validated event. */ - onValidated?: (params: validationEngine.ValidatorValidationResult) => void; - } - /** A widget that is used to validate the associated DevExtreme editors against the defined validation rules. */ - export class dxValidator extends DOMComponent implements validationEngine.IValidator { - constructor(element: JQuery, options?: dxValidatorOptions); - constructor(element: Element, options?: dxValidatorOptions); - /** Validates the value of the editor that is controlled by the current dxValidator object against the list of the specified validation rules. */ - validate(): validationEngine.ValidatorValidationResult; - /** Resets the value and validation result of the editor associated with the current dxValidator object. */ - reset(): void; - } - /** The widget that is used in the Knockout and Angular approaches to combine the editors to be validated. */ - export class dxValidationGroup extends DOMComponent { - constructor(element: JQuery); - constructor(element: Element); - /** Validates rules of the validators that belong to the current validation group. */ - validate(): validationEngine.ValidationGroupValidationResult; - /** Resets the value and validation result of the editors that are included to the current validation group. */ - reset(): void; - } - export interface dxValidationSummaryOptions extends CollectionWidgetOptions { - /** Specifies the validation group for which summary should be generated. */ - validationGroup?: string; - } - /** A widget for displaying the result of checking validation rules for editors. */ - export class dxValidationSummary extends CollectionWidget { - constructor(element: JQuery, options?: dxValidationSummaryOptions); - constructor(element: Element, options?: dxValidationSummaryOptions); - } - export interface dxResizableOptions extends DOMComponentOptions { - /** Specifies which borders of the widget element are used as a handle. */ - handles?: string; - /** Specifies the lower width boundary for resizing. */ - minWidth?: number; - /** Specifies the upper width boundary for resizing. */ - maxWidth?: number; - /** Specifies the lower height boundary for resizing. */ - minHeight?: number; - /** Specifies the upper height boundary for resizing. */ - maxHeight?: number; - /** A handler for the resizeStart event. */ - onResizeStart?: Function; - /** A handler for the resize event. */ - onResize?: Function; - /** A handler for the resizeEnd event. */ - onResizeEnd?: Function; - } - /** A widget that displays required content in a resizable element. */ - export class dxResizable extends DOMComponent { - constructor(element: JQuery, options?: dxResizableOptions); - constructor(element: Element, options?: dxResizableOptions); - } - export interface dxTooltipOptions extends dxPopoverOptions { - } - /** A tooltip widget. */ - export class dxTooltip extends dxPopover { - constructor(element: JQuery, options?: dxTooltipOptions); - constructor(element: Element, options?: dxTooltipOptions); - } - export interface dxDropDownListOptions extends dxDropDownEditorOptions, DataExpressionMixinOptions { - /** Returns the value currently displayed by the widget. */ - displayValue?: string; - /** The minimum number of characters that must be entered into the text box to begin a search. */ - minSearchLength?: number; - /** Specifies the name of a data source item field or an expression whose value is compared to the search criterion. */ - searchExpr?: Object; - /** Specifies the binary operation used to filter data. */ - searchMode?: string; - /** Specifies the time delay, in milliseconds, after the last character has been typed in, before a search is executed. */ - searchTimeout?: number; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - /** Specifies DOM event names that update a widget's value. */ - valueChangeEvent?: string; - /** Specifies whether or not the widget supports searching. */ - searchEnabled?: boolean; - /** - * Specifies whether or not the widget displays items by pages. - * @deprecated dataSource.paginate.md - */ - pagingEnabled?: boolean; - /** The text or HTML markup displayed by the widget if the item collection is empty. */ - noDataText?: string; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: Function; - /** A handler for the itemClick event. */ - onItemClick?: Function; - onContentReady?: Function; - } - /** A base class for drop-down list widgets. */ - export class dxDropDownList extends dxDropDownEditor { - constructor(element: JQuery, options?: dxDropDownListOptions); - constructor(element: Element, options?: dxDropDownListOptions); - } - export interface dxToolbarOptions extends CollectionWidgetOptions { - menuItemRender?: any; - /** The template used to render menu items. */ - menuItemTemplate?: any; - /** Informs the widget about its location in a view HTML markup. */ - renderAs?: string; - } - /** A toolbar widget. */ - export class dxToolbar extends CollectionWidget { - constructor(element: JQuery, options?: dxToolbarOptions); - constructor(element: Element, options?: dxToolbarOptions); - } - export interface dxToastOptions extends dxOverlayOptions { - animation?: fx.AnimationOptions; - /** The time span in milliseconds during which the dxToast widget is visible. */ - displayTime?: number; - height?: any; - /** The dxToast message text. */ - message?: string; - position?: PositionOptions; - shading?: boolean; - /** Specifies the dxToast widget type. */ - type?: string; - width?: any; - closeOnBackButton?: boolean; - } - /** The toast message widget. */ - export class dxToast extends dxOverlay { - constructor(element: JQuery, options?: dxToastOptions); - constructor(element: Element, options?: dxToastOptions); - } - export interface dxTextEditorOptions extends EditorOptions { - /** A handler for the change event. */ - onChange?: Function; - changeAction?: Function; - /** A handler for the copy event. */ - onCopy?: Function; - copyAction?: Function; - /** A handler for the cut event. */ - onCut?: Function; - cutAction?: Function; - /** A handler for the enterKey event. */ - onEnterKey?: Function; - enterKeyAction?: Function; - /** A handler for the focusIn event. */ - onFocusIn?: Function; - focusInAction?: Function; - /** A handler for the focusOut event. */ - onFocusOut?: Function; - focusOutAction?: Function; - /** A handler for the input event. */ - onInput?: Function; - inputAction?: Function; - /** A handler for the keyDown event. */ - onKeyDown?: Function; - keyDownAction?: Function; - /** A handler for the keyPress event. */ - onKeyPress?: Function; - keyPressAction?: Function; - /** A handler for the keyUp event. */ - onKeyUp?: Function; - keyUpAction?: Function; - /** A handler for the paste event. */ - onPaste?: Function; - pasteAction?: Function; - /** The text displayed by the widget when the widget value is empty. */ - placeholder?: string; - /** Specifies whether to display the Clear button in the widget. */ - showClearButton?: boolean; - /** Specifies the current value displayed by the widget. */ - value?: any; - /** Specifies DOM event names that update a widget's value. */ - valueChangeEvent?: string; - /** Specifies whether or not the widget checks the inner text for spelling mistakes. */ - spellcheck?: boolean; - /** Specifies HTML attributes applied to the inner input element of the widget. */ - attr?: Object; - /** The read-only option that holds the text displayed by the widget input element. */ - text?: string; - /** Specifies whether or not the widget supports the focused state and keyboard navigation. */ - focusStateEnabled?: boolean; - /** A Boolean value specifying whether or not the widget changes its state when being hovered by an end user. */ - hoverStateEnabled?: boolean; - /** The editor mask, which specifies the format of the entered string. */ - mask?: string; - /** Specifies a mask placeholder character. */ - maskChar?: string; - /** Specifies custom mask rules. */ - maskRules?: Object; - /** A message displayed when the entered text does not match the specified pattern. */ - maskInvalidMessage?: string; - } - /** A base class for text editing widgets. */ - export class dxTextEditor extends Editor { - constructor(element: JQuery, options?: dxTextEditorOptions); - constructor(element: Element, options?: dxTextEditorOptions); - /** Removes focus from the input element. */ - blur(): void; - /** Sets focus to the input element representing the widget. */ - focus(): void; - } - export interface dxTextBoxOptions extends dxTextEditorOptions { - /** Specifies the maximum number of characters you can enter into the textbox. */ - maxLength?: any; - /** The "mode" attribute value of the actual HTML input element representing the text box. */ - mode?: string; - } - /** A single-line text box widget. */ - export class dxTextBox extends dxTextEditor { - constructor(element: JQuery, options?: dxTextBoxOptions); - constructor(element: Element, options?: dxTextBoxOptions); - } - export interface dxTextAreaOptions extends dxTextBoxOptions { - /** Specifies whether or not the widget checks the inner text for spelling mistakes. */ - spellcheck?: boolean; - } - /** A widget used to display and edit multi-line text. */ - export class dxTextArea extends dxTextBox { - constructor(element: JQuery, options?: dxTextAreaOptions); - constructor(element: Element, options?: dxTextAreaOptions); - } - export interface dxTabsOptions extends CollectionWidgetOptions { - /** Specifies whether the widget enables an end-user to select only a single item or multiple items. */ - selectionMode?: string; - /** Specifies whether or not an end-user can scroll tabs by swiping. */ - scrollByContent?: boolean; - /** Specifies whether or not an end-user can scroll tabs. */ - scrollingEnabled?: boolean; - /** A Boolean value that specifies the availability of navigation buttons. */ - showNavButtons?: boolean; - } - /** A tab strip used to switch between pages. */ - export class dxTabs extends CollectionWidget { - constructor(element: JQuery, options?: dxTabsOptions); - constructor(element: Element, options?: dxTabsOptions); - } - export interface dxTabPanelOptions extends dxMultiViewOptions { - /** A handler for the titleClick event. */ - onTitleClick?: any; - /** A handler for the titleHold event. */ - onTitleHold?: Function; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - titleTemplate?: any; - /** The template to be used for rendering an item title. */ - itemTitleTemplate?: any; - } - /** A widget used to display a view and to switch between several views by clicking the appropriate tabs. */ - export class dxTabPanel extends dxMultiView { - constructor(element: JQuery, options?: dxTabPanelOptions); - constructor(element: Element, options?: dxTabPanelOptions); - } - export interface dxSelectBoxOptions extends dxDropDownListOptions { - /** The template to be used for rendering the widget text field. */ - fieldTemplate?: any; - /** The text that is provided as a hint in the select box editor. */ - placeholder?: string; - /** Specifies whether or not the widget allows an end-user to enter a custom value. */ - fieldEditEnabled?: boolean; - } - /** A widget that allows you to select an item in a dropdown list. */ - export class dxSelectBox extends dxDropDownList { - constructor(element: JQuery, options?: dxSelectBoxOptions); - constructor(element: Element, options?: dxSelectBoxOptions); - } - export interface dxTagBoxOptions extends dxSelectBoxOptions { - /** Holds the list of selected values. */ - values?: Array; - } - /** A widget that allows you to select multiple items from a dropdown list. */ - export class dxTagBox extends dxSelectBox { - constructor(element: JQuery, options?: dxTagBoxOptions); - constructor(element: Element, options?: dxTagBoxOptions); - } - export interface dxScrollViewOptions extends dxScrollableOptions { - /** A handler for the pullDown event. */ - onPullDown?: Function; - pullDownAction?: Function; - /** Specifies the text shown in the pullDown panel when pulling the content down lowers the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while pulling the content down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the reachBottom event. */ - onReachBottom?: Function; - reachBottomAction?: Function; - /** Specifies the text shown in the pullDown panel displayed when content is scrolled to the bottom. */ - reachBottomText?: string; - /** Specifies the text shown in the pullDown panel displayed when the content is being refreshed. */ - refreshingText?: string; - /** Returns a value indicating if the scrollView content is larger then the widget container. */ - isFull(): boolean; - /** Locks the widget until the release(preventScrollBottom) method is called and executes the function passed to the onPullDown option and the handler assigned to the pullDown event. */ - refresh(): void; - /** Notifies the scroll view that data loading is finished. */ - release(preventScrollBottom: boolean): JQueryPromise; - /** Toggles the loading state of the widget. */ - toggleLoading(showOrHide: boolean): void; - } - /** A widget used to display scrollable content. */ - export class dxScrollView extends dxScrollable { - constructor(element: JQuery, options?: dxScrollViewOptions); - constructor(element: Element, options?: dxScrollViewOptions); - } - export interface dxScrollableLocation { - top?: number; - left?: number; - } - export interface dxScrollableOptions extends DOMComponentOptions { - /** A string value specifying the available scrolling directions. */ - direction?: string; - /** A Boolean value specifying whether or not the widget can respond to user interaction. */ - disabled?: boolean; - /** A handler for the scroll event. */ - onScroll?: Function; - scrollAction?: Function; - /** Specifies when the widget shows the scrollbar. */ - showScrollbar?: string; - /** A handler for the update event. */ - onUpdated?: Function; - updateAction?: Function; - /** Indicates whether to use native or simulated scrolling. */ - useNative?: boolean; - /** A Boolean value specifying whether to enable or disable the bounce-back effect. */ - bounceEnabled?: boolean; - /** A Boolean value specifying whether or not an end-user can scroll the widget content swiping it up or down. */ - scrollByContent?: boolean; - /** A Boolean value specifying whether or not an end-user can scroll the widget content using the scrollbar. */ - scrollByThumb?: boolean; - } - /** A widget used to display scrollable content. */ - export class dxScrollable extends DOMComponent { - constructor(element: JQuery, options?: dxScrollableOptions); - constructor(element: Element, options?: dxScrollableOptions); - /** Returns the height of the scrollable widget in pixels. */ - clientHeight(): number; - /** Returns the width of the scrollable widget in pixels. */ - clientWidth(): number; - /** Returns an HTML element of the widget. */ - content(): JQuery; - /** Scrolls the widget content by the specified number of pixels. */ - scrollBy(distance: number): void; - /** Scrolls widget content by the specified number of pixels in horizontal and vertical directions. */ - scrollBy(distanceObject: dxScrollableLocation): void; - /** Returns the height of the scrollable content in pixels. */ - scrollHeight(): number; - /** Returns the current scroll position against the leftmost position. */ - scrollLeft(): number; - /** Returns how far the scrollable content is scrolled from the top and from the left. */ - scrollOffset(): dxScrollableLocation; - /** Scrolls widget content to the specified position. */ - scrollTo(targetLocation: number): void; - /** Scrolls widget content to a specified position. */ - scrollTo(targetLocation: dxScrollableLocation): void; - /** Scrolls widget content to the specified element. */ - scrollToElement(element: Element): void; - /** Returns the current scroll position against the topmost position. */ - scrollTop(): number; - /** Returns the width of the scrollable content in pixels. */ - scrollWidth(): number; - /** Updates the dimensions of the scrollable contents. */ - update(): void; - } - export interface dxRadioGroupOptions extends CollectionWidgetOptions, DataExpressionMixinOptions { - /** Specifies the radio group layout. */ - layout?: string; - } - /** A widget that enables a user to select one item within a list of items represented by radio buttons. */ - export class dxRadioGroup extends CollectionWidget { - constructor(element: JQuery, options?: dxRadioGroupOptions); - constructor(element: Element, options?: dxRadioGroupOptions); - } - export interface dxPopupOptions extends dxOverlayOptions { - animation?: fx.AnimationOptions; - /** Specifies whether or not to allow a user to drag the popup window. */ - dragEnabled?: boolean; - /** A Boolean value specifying whether or not to display the widget in full-screen mode. */ - fullScreen?: boolean; - position?: PositionOptions; - /** A Boolean value specifying whether or not to display the title in the popup window. */ - showTitle?: boolean; - /** The title in the overlay window. */ - title?: string; - /** A template to be used for rendering the widget title. */ - titleTemplate?: any; - width?: any; - /** Specifies items displayed on the top or bottom toolbar of the popup window. */ - buttons?: Array; - /** Specifies whether or not the widget displays the Close button. */ - showCloseButton?: boolean; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - } - /** A widget that displays required content in a popup window. */ - export class dxPopup extends dxOverlay { - constructor(element: JQuery, options?: dxPopupOptions); - constructor(element: Element, options?: dxPopupOptions); - } - export interface dxPopoverOptions extends dxPopupOptions { - /** An object defining animation options of the widget. */ - animation?: fx.AnimationOptions; - /** Specifies the height of the widget. */ - height?: any; - /** An object defining widget positioning options. */ - position?: PositionOptions; - shading?: boolean; - /** A Boolean value specifying whether or not to display the title in the overlay window. */ - showTitle?: boolean; - /** The target element associated with a popover. */ - target?: any; - /** Specifies the width of the widget. */ - width?: any; - } - /** A widget that displays the required content in a popup window. */ - export class dxPopover extends dxPopup { - constructor(element: JQuery, options?: dxPopoverOptions); - constructor(element: Element, options?: dxPopoverOptions); - /** Displays the widget for the specified target element. */ - show(target?: any): JQueryPromise; - } - export interface dxOverlayOptions extends WidgetOptions { - /** An object that defines the animation options of the widget. */ - animation?: fx.AnimationOptions; - /** A Boolean value specifying whether or not the widget is closed if a user presses the Back hardware button. */ - closeOnBackButton?: boolean; - /** A Boolean value specifying whether or not the widget is closed if a user clicks outside of the overlapping window. */ - closeOnOutsideClick?: any; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - /** Specifies whether or not an end-user can drag the widget. */ - dragEnabled?: boolean; - /** Specifies whether or not an end user can resize the widget. */ - resizeEnabled?: boolean; - /** The height of the widget in pixels. */ - height?: any; - /** A handler for the hidden event. */ - onHidden?: Function; - hiddenAction?: Function; - /** A handler for the hiding event. */ - onHiding?: Function; - hidingAction?: Function; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** A Boolean value specifying whether or not the main screen is inactive while the widget is active. */ - shading?: boolean; - /** Specifies the shading color. */ - shadingColor?: string; - /** A handler for the showing event. */ - onShowing?: Function; - showingAction?: Function; - /** A handler for the shown event. */ - onShown?: Function; - shownAction?: Function; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - /** The widget width in pixels. */ - width?: any; - } - /** A widget displaying the required content in an overlay window. */ - export class dxOverlay extends Widget { - constructor(element: JQuery, options?: dxOverlayOptions); - constructor(element: Element, options?: dxOverlayOptions); - /** An HTML element of the widget. */ - content(): JQuery; - /** Hides the widget. */ - hide(): JQueryPromise; - /** Recalculates the overlay's size and position. */ - repaint(): void; - /** Shows the widget. */ - show(): JQueryPromise; - /** Toggles the visibility of the widget. */ - toggle(showing: boolean): JQueryPromise; - /** A static method that specifies the base z-index for all overlay widgets. */ - static baseZIndex(zIndex: number): void; - } - export interface dxNumberBoxOptions extends dxTextEditorOptions { - /** The maximum value accepted by the number box. */ - max?: number; - /** The minimum value accepted by the number box. */ - min?: number; - /** Specifies whether or not to show spin buttons. */ - showSpinButtons?: boolean; - useTouchSpinButtons?: boolean; - /** Specifies by which value the widget value changes when a spin button is clicked. */ - step?: number; - /** The current number box value. */ - value?: number; - } - /** A textbox widget that enables a user to enter numeric values. */ - export class dxNumberBox extends dxTextEditor { - constructor(element: JQuery, options?: dxNumberBoxOptions); - constructor(element: Element, options?: dxNumberBoxOptions); - } - export interface dxNavBarOptions extends dxTabsOptions { - scrollingEnabled?: boolean; - } - /** A widget that contains items used to navigate through application views. */ - export class dxNavBar extends dxTabs { - constructor(element: JQuery, options?: dxNavBarOptions); - constructor(element: Element, options?: dxNavBarOptions); - } - export interface dxMultiViewOptions extends CollectionWidgetOptions { - /** Specifies whether or not to animate the displayed item change. */ - animationEnabled?: boolean; - /** A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped. */ - loop?: boolean; - /** The index of the currently displayed item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to allow users to change the selected index by swiping. */ - swipeEnabled?: boolean; - } - /** A widget used to display a view and to switch between several views. */ - export class dxMultiView extends CollectionWidget { - constructor(element: JQuery, options?: dxMultiViewOptions); - constructor(element: Element, options?: dxMultiViewOptions); - } - export interface dxMapOptions extends WidgetOptions { - /** Specifies whether or not the widget automatically adjusts center and zoom option values when adding a new marker or route. */ - autoAdjust?: boolean; - bounds?: { - northEast?: { - lat?: number; - lng?: number; - }; - southWest?: { - lat?: number; - lng?: number; - }; - /** An object, a string, or an array specifying the location displayed at the center of the widget. */ - center?: { - /** The latitude location displayed in the center of the widget. */ - lat?: number; - /** The longitude location displayed in the center of the widget. */ - lng?: number; - }; - /** A handler for the click event. */ - onClick?: any; - clickAction?: any; - /** Specifies whether or not map widget controls are available. */ - controls?: boolean; - /** Specifies the height of the widget. */ - height?: number; - /** A key used to authenticate the application within the required map provider. */ - key?: { - /** A key used to authenticate the application within the "Bing" map provider. */ - bing?: string; - /** A key used to authenticate the application within the "Google" map provider. */ - google?: string; - /** A key used to authenticate the application within the "Google Static" map provider. */ - googleStatic?: string; - } - /** A handler for the markerAdded event. */ - onMarkerAdded?: Function; - markerAddedAction?: Function; - /** A URL pointing to the custom icon to be used for map markers. */ - markerIconSrc?: string; - /** A handler for the markerRemoved event. */ - onMarkerRemoved?: Function; - markerRemovedAction?: Function; - /** An array of markers displayed on a map. */ - markers?: Array; - /** The name of the current map data provider. */ - provider?: string; - /** A handler for the ready event. */ - onReady?: Function; - readyAction?: Function; - /** A handler for the routeAdded event. */ - onRouteAdded?: Function; - routeAddedAction?: Function; - /** A handler for the routeRemoved event. */ - onRouteRemoved?: Function; - routeRemovedAction?: Function; - /** An array of routes shown on the map. */ - routes?: Array; - /** The type of a map to display. */ - type?: string; - /** Specifies the width of the widget. */ - width?: number; - /** The zoom level of the map. */ - zoom?: number; - /** Adds a marker to the map. */ - addMarker(markerOptions: Object): JQueryPromise; - /** Adds a route to the map. */ - addRoute(options: Object): JQueryPromise; - /** Removes a marker from the map. */ - removeMarker(marker: Object): JQueryPromise; - /** Removes a route from the map. */ - removeRoute(route: any): JQueryPromise; - }; - } - /** An interactive map widget. */ - export class dxMap extends Widget { - constructor(element: JQuery, options?: dxMapOptions); - constructor(element: Element, options?: dxMapOptions); - } - export interface dxLookupOptions extends dxDropDownListOptions { - /** An object defining widget animation options. */ - animation?: fx.AnimationOptions; - /** The text displayed on the Cancel button. */ - cancelButtonText?: string; - /** The text displayed on the Clear button. */ - clearButtonText?: string; - /** Specifies whether or not the widget cleans the search box when the popup window is displayed. */ - cleanSearchOnOpening?: boolean; - /** A Boolean value specifying whether or not the widget is closed if a user clicks outside of the overlaying window. */ - closeOnOutsideClick?: any; - /** The text displayed on the Apply button. */ - applyButtonText?: string; - /** A Boolean value specifying whether or not to display the lookup in full-screen mode. */ - fullScreen?: boolean; - focusStateEnabled?: boolean; - /** A Boolean value specifying whether or not to group widget items. */ - grouped?: boolean; - groupRender?: any; - /** The name of the template used to display a group header. */ - groupTemplate?: any; - /** The text displayed on the button used to load the next page from the data source. */ - nextButtonText?: string; - /** A handler for the pageLoading event. */ - onPageLoading?: Function; - /** Specifies whether the next page is loaded when a user scrolls the widget to the bottom or when the "next" button is clicked. */ - pageLoadMode?: string; - pageLoadingAction?: Function; - /** Specifies the text shown in the pullDown panel, which is displayed when the widget is scrolled to the bottom. */ - pageLoadingText?: string; - /** The text displayed by the widget when nothing is selected. */ - placeholder?: string; - /** The height of the widget popup element. */ - popupHeight?: any; - /** The width of the widget popup element. */ - popupWidth?: any; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** Specifies the text displayed in the pullDown panel when the widget is pulled below the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the pullRefresh event. */ - onPullRefresh?: Function; - pullRefreshAction?: Function; - /** A Boolean value specifying whether or not the widget supports the "pull down to refresh" gesture. */ - pullRefreshEnabled?: boolean; - /** Specifies the text displayed in the pullDown panel while the widget is being refreshed. */ - refreshingText?: string; - /** A handler for the scroll event. */ - onScroll?: Function; - scrollAction?: Function; - /** A Boolean value specifying whether or not the search bar is visible. */ - searchEnabled?: boolean; - /** The text that is provided as a hint in the lookup's search bar. */ - searchPlaceholder?: string; - /** A Boolean value specifying whether or not the main screen is inactive while the lookup is active. */ - shading?: boolean; - /** Specifies whether to display the Cancel button in the lookup window. */ - showCancelButton?: boolean; - /** - * A Boolean value specifying whether the widget loads the next page automatically when you reach the bottom of the list or when a button is clicked. - * @deprecated pageLoadMode.md - */ - showNextButton?: boolean; - /** The title of the lookup window. */ - title?: string; - /** A template to be used for rendering the widget title. */ - titleTemplate?: any; - /** Specifies whether or not the widget uses native scrolling. */ - useNativeScrolling?: boolean; - /** Specifies whether or not to show lookup contents in a dxPopover widget. */ - usePopover?: boolean; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - contentReadyAction?: Function; - titleRender?: any; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - /** A Boolean value specifying whether or not to display the title in the popup window. */ - showPopupTitle?: boolean; - } - /** A widget that allows a user to select predefined values from a lookup window. */ - export class dxLookup extends dxDropDownList { - constructor(element: JQuery, options?: dxLookupOptions); - constructor(element: Element, options?: dxLookupOptions); - /** This section lists the data source fields that are used in a default template for lookup drop-down items. */ - } - export interface dxLoadPanelOptions extends dxOverlayOptions { - /** An object defining the animation options of the widget. */ - animation?: fx.AnimationOptions; - /** The delay in milliseconds after which the load panel is displayed. */ - delay?: number; - /** The height of the widget. */ - height?: number; - /** A URL pointing to an image to be used as a load indicator. */ - indicatorSrc?: string; - /** The text displayed in the load panel. */ - message?: string; - /** A Boolean value specifying whether or not to show a load indicator. */ - showIndicator?: boolean; - /** A Boolean value specifying whether or not to show the pane behind the load indicator. */ - showPane?: boolean; - /** The width of the widget. */ - width?: number; - } - /** A widget used to indicate whether or not an element is loading. */ - export class dxLoadPanel extends dxOverlay { - constructor(element: JQuery, options?: dxLoadPanelOptions); - constructor(element: Element, options?: dxLoadPanelOptions); - } - export interface dxLoadIndicatorOptions extends WidgetOptions { - /** Specifies the path to an image used as the indicator. */ - indicatorSrc?: string; - } - /** The widget used to indicate the loading process. */ - export class dxLoadIndicator extends Widget { - constructor(element: JQuery, options?: dxLoadIndicatorOptions); - constructor(element: Element, options?: dxLoadIndicatorOptions); - } - export interface dxListOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not to display a grouped list. */ - grouped?: boolean; - groupRender?: any; - /** The template to be used for rendering item groups. */ - groupTemplate?: any; - onItemDeleting?: Function; - /** A handler for the itemDeleted event. */ - onItemDeleted?: Function; - /** A handler for the groupRendered event. */ - onGroupRendered?: Function; - itemDeleteAction?: Function; - /** A handler for the itemReordered event. */ - onItemReordered?: Function; - itemReorderAction?: Function; - /** A handler for the itemClick event. */ - onItemClick?: any; - /** A handler for the itemSwipe event. */ - onItemSwipe?: Function; - itemSwipeAction?: Function; - /** The text displayed on the button used to load the next page from the data source. */ - nextButtonText?: string; - /** A handler for the pageLoading event. */ - onPageLoading?: Function; - pageLoadingAction?: Function; - /** Specifies the text shown in the pullDown panel, which is displayed when the list is scrolled to the bottom. */ - pageLoadingText?: string; - /** Specifies the text displayed in the pullDown panel when the list is pulled below the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the pullRefresh event. */ - onPullRefresh?: Function; - pullRefreshAction?: Function; - /** A Boolean value specifying whether or not the widget supports the "pull down to refresh" gesture. */ - pullRefreshEnabled?: boolean; - /** Specifies the text displayed in the pullDown panel while the list is being refreshed. */ - refreshingText?: string; - /** A handler for the scroll event. */ - onScroll?: Function; - scrollAction?: Function; - /** A Boolean value specifying whether to enable or disable list scrolling. */ - scrollingEnabled?: boolean; - /** Specifies when the widget shows the scrollbar. */ - showScrollbar?: string; - /** Specifies whether or not the widget uses native scrolling. */ - useNativeScrolling?: boolean; - /** A Boolean value specifying whether to enable or disable the bounce-back effect. */ - bounceEnabled?: boolean; - /** A Boolean value specifying if the list is scrolled by content. */ - scrollByContent?: boolean; - /** A Boolean value specifying if the list is scrolled using the scrollbar. */ - scrollByThumb?: boolean; - itemUnselectAction?: Function; - onItemContextMenu?: Function; - onItemHold?: Function; - /** Specifies whether or not an end-user can collapse groups. */ - collapsibleGroups?: boolean; - /** Specifies whether the next page is loaded when a user scrolls the widget to the bottom or when the "next" button is clicked. */ - pageLoadMode?: string; - /** Specifies whether or not to display controls used to select list items. */ - showSelectionControls?: boolean; - /** Specifies whether the list supports single item selection or multi-selection. */ - selectionMode?: string; - selectAllText?: string; - /** Specifies the array of items for a context menu called for a list item. */ - menuItems?: Array; - /** Specifies whether an item context menu is shown when a user holds or swipes an item. */ - menuMode?: string; - /** Specifies whether or not an end user can delete list items. */ - allowItemDeleting?: boolean; - /** Specifies the way a user can delete items from the list. */ - itemDeleteMode?: string; - /** Specifies whether or not an end user can reorder list items. */ - allowItemReordering?: boolean; - /** Specifies whether or not to show the loading panel when the DataSource bound to the widget is loading data. */ - indicateLoading?: boolean; - } - /** A list widget. */ - export class dxList extends CollectionWidget { - constructor(element: JQuery, options?: dxListOptions); - constructor(element: Element, options?: dxListOptions); - /** Returns the height of the widget in pixels. */ - clientHeight(): number; - /** Removes the specified item from the list. */ - deleteItem(itemIndex: any): JQueryPromise; - /** Removes the specified item from the list. */ - deleteItem(itemElement: Element): JQueryPromise; - /** Returns a Boolean value that indicates whether or not the specified item is selected. */ - isItemSelected(itemIndex: any): boolean; - /** Returns a Boolean value that indicates whether or not the specified item is selected. */ - isItemSelected(itemElement: Element): boolean; - /** Reloads list data. */ - reload(): void; - /** Moves the specified item to the specified position in the list. */ - reorderItem(itemElement: Element, toItemElement: Element): JQueryPromise; - /** Moves the specified item to the specified position in the list. */ - reorderItem(itemIndex: any, toItemIndex: any): JQueryPromise; - /** Scrolls the list content by the specified number of pixels. */ - scrollBy(distance: number): void; - /** Returns the height of the list content in pixels. */ - scrollHeight(): number; - /** Scrolls list content to the specified position. */ - scrollTo(location: number): void; - /** Scrolls the list to the specified item. */ - scrollToItem(itemElement: Element): void; - /** Scrolls the list to the specified item. */ - scrollToItem(itemIndex: any): void; - /** Returns how far the list content is scrolled from the top. */ - scrollTop(): number; - /** Selects the specified item from the list. */ - selectItem(itemElement: Element): void; - /** Selects the specified item from the list. */ - selectItem(itemIndex: any): void; - /** Deselects the specified item from the list. */ - unselectItem(itemElement: Element): void; - /** Unselects the specified item from the list. */ - unselectItem(itemIndex: any): void; - /** Updates the widget scrollbar according to widget content size. */ - updateDimensions(): JQueryPromise; - /** Expands the specified group. */ - expandGroup(groupIndex: number): JQueryPromise; - /** Collapses the specified group. */ - collapseGroup(groupIndex: number): JQueryPromise; - } - export interface dxGalleryOptions extends CollectionWidgetOptions { - /** The time, in milliseconds, spent on slide animation. */ - animationDuration?: number; - /** Specifies whether or not to animate the displayed item change. */ - animationEnabled?: boolean; - /** A Boolean value specifying whether or not to allow users to switch between items by clicking an indicator. */ - indicatorEnabled?: boolean; - /** A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped. */ - loop?: boolean; - /** The index of the currently active gallery item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to display an indicator that points to the selected gallery item. */ - showIndicator?: boolean; - /** A Boolean value that specifies the availability of the "Forward" and "Back" navigation buttons. */ - showNavButtons?: boolean; - /** The time interval in milliseconds, after which the gallery switches to the next item. */ - slideshowDelay?: number; - /** A Boolean value specifying whether or not to allow users to switch between items by swiping. */ - swipeEnabled?: boolean; - /** Specifies whether or not to display parts of previous and next images along the sides of the current image. */ - wrapAround?: boolean; - /** Specifies if the widget stretches images to fit the total gallery width. */ - stretchImages?: boolean; - /** Specifies the width of an area used to display a single image. */ - initialItemWidth?: number; - } - /** An image gallery widget. */ - export class dxGallery extends CollectionWidget { - constructor(element: JQuery, options?: dxGalleryOptions); - constructor(element: Element, options?: dxGalleryOptions); - /** Shows the specified gallery item. */ - goToItem(itemIndex: number, animation: boolean): JQueryPromise; - /** Shows the next gallery item. */ - nextItem(animation: boolean): JQueryPromise; - /** Shows the previous gallery item. */ - prevItem(animation: boolean): JQueryPromise; - } - export interface dxDropDownEditorOptions extends dxTextBoxOptions { - /** Specifies the current value displayed by the widget. */ - value?: Object; - /** A handler for the closed event. */ - onClosed?: Function; - /** A handler for the opened event. */ - onOpened?: Function; - /** Specifies whether or not the drop-down editor is displayed. */ - opened?: boolean; - closeAction?: Function; - openAction?: Function; - shownAction?: Function; - hiddenAction?: Function; - /** Specifies whether or not the widget allows an end-user to enter a custom value. */ - fieldEditEnabled?: boolean; - editEnabled?: boolean; - /** Specifies the way an end-user applies the selected value. */ - applyValueMode?: string; - } - /** A drop-down editor widget. */ - export class dxDropDownEditor extends dxTextBox { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - /** Closes the drop-down editor. */ - close(): void; - /** Opens the drop-down editor. */ - open(): void; - /** Resets the widget's value to null. */ - reset(): void; - /** Returns an <input> element of the widget. */ - field(): JQuery; - /** Returns an HTML element of the popup window content. */ - content(): JQuery; - } - export interface dxDateBoxOptions extends dxTextEditorOptions { - /** A format used to display date/time information. */ - format?: string; - /** A Globalize format string specifying the date display format. */ - formatString?: string; - /** The last date that can be selected within the widget. */ - max?: any; - /** The minimum date that can be selected within the widget. */ - min?: any; - /** The text displayed by the widget when the widget value is not yet specified. This text is also used as a title of the date picker. */ - placeholder?: string; - /** - * Specifies whether or not a user can pick out a date using the drop-down calendar. - * @deprecated Use 'pickerType' option instead. - */ - useCalendar?: boolean; - /** An object or a value, specifying the date and time currently selected using the date box. */ - value?: any; - /** - * Specifies whether or not the widget uses the native HTML input element. - * @deprecated Use 'pickerType' option instead. - */ - useNative?: boolean; - /** Specifies the interval between neighboring values in the popup list in minutes. */ - interval?: number; - /** Specifies the maximum zoom level of a calendar, which is used to pick the date. */ - maxZoomLevel?: string; - /** Specifies the minimal zoom level of a calendar, which is used to pick the date. */ - minZoomLevel?: string; - /** Specifies the type of date/time picker. */ - pickerType?: string; - } - /** A date box widget. */ - export class dxDateBox extends dxDropDownEditor { - constructor(element: JQuery, options?: dxDateBoxOptions); - constructor(element: Element, options?: dxDateBoxOptions); - } - export interface dxCheckBoxOptions extends EditorOptions { - /** Specifies the widget state. */ - value?: boolean; - /** Specifies the text displayed by the check box. */ - text?: string; - } - /** A check box widget. */ - export class dxCheckBox extends Editor { - constructor(element: JQuery, options?: dxCheckBoxOptions); - constructor(element: Element, options?: dxCheckBoxOptions); - } - export interface dxCalendarOptions extends EditorOptions { - /** Specifies a date displayed on the current calendar page. */ - currentDate?: Date; - /** Specifies the first day of a week. */ - firstDayOfWeek?: number; - /** The latest date the widget allows to select. */ - max?: Date; - /** The earliest date the widget allows to select. */ - min?: Date; - /** Specifies whether or not the widget displays a button that selects the current date. */ - showTodayButton?: boolean; - /** Specifies the current calendar zoom level. */ - zoomLevel?: string; - /** Specifies the maximum zoom level of the calendar. */ - maxZoomLevel?: string; - /** Specifies the minimum zoom level of the calendar. */ - minZoomLevel?: string; - /** The template to be used for rendering calendar cells. */ - cellTemplate?: any; - } - /** A calendar widget. */ - export class dxCalendar extends Editor { - constructor(element: JQuery, options?: dxCalendarOptions); - constructor(element: Element, options?: dxCalendarOptions); - } - export interface dxButtonOptions extends WidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A handler for the click event. */ - onClick?: any; - clickAction?: any; - /** Specifies the icon to be displayed on the button. */ - icon?: string; - iconSrc?: string; - /** A template to be used for rendering the dxButton widget. */ - template?: any; - /** The text displayed on the button. */ - text?: string; - /** Specifies the button type. */ - type?: string; - /** Specifies the name of the validation group to be accessed in the click event handler. */ - validationGroup?: string; - } - /** A button widget. */ - export class dxButton extends Widget { - constructor(element: JQuery, options?: dxButtonOptions); - constructor(element: Element, options?: dxButtonOptions); - } - export interface dxBoxOptions extends CollectionWidget { - /** Specifies how widget items are aligned along the main direction. */ - align?: string; - /** Specifies the direction of item positioning in the widget. */ - direction?: string; - /** Specifies how widget items are aligned cross-wise. */ - crossAlign?: string; - } - /** A container widget used to arrange inner elements. */ - export class dxBox extends CollectionWidget { - constructor(element: JQuery, options?: dxBoxOptions); - constructor(element: Element, options?: dxBoxOptions); - } - export interface dxResponsiveBoxOptions extends CollectionWidgetOptions { - /** Specifies the collection of rows for the grid used to position layout elements. */ - rows?: Array; - /** Specifies the collection of columns for the grid used to position layout elements. */ - cols?: Array; - /** Specifies the function returning the screen factor depending on the screen width. */ - screenByWidth?: (width: number) => string; - /** Specifies the screen factor with which all elements are located in a single column. */ - singleColumnScreen?: string; - } - /** A widget used to build an adaptive markup that is dependent on screen resolution. */ - export class dxResponsiveBox extends CollectionWidget { - constructor(element: JQuery, options?: dxBoxOptions); - constructor(element: Element, options?: dxBoxOptions); - } - export interface dxAutocompleteOptions extends dxDropDownListOptions { - accessKey?: string; - activeStateEnabled?: boolean; - attr?: any; - dataSource?: any; - disabled?: boolean; - displayValue?: string; - fieldEditEnabled?: boolean; - focusStateEnabled?: boolean; - height?: string | number | (() => string | number); - hint?: string; - hoverStateEnabled?: boolean; - isValid?: boolean; - items?: any[]; - /** - * The template to be used for rendering items. - * Defaults Value: "item" - */ - itemTemplate?: string | Node | JQuery | (() => string | Node | JQuery); - /** Specifies the maximum count of items displayed by the widget. */ - maxItemCount?: number; - - maxLength?: string | number; - /** The minimum number of characters that must be entered into the text box to begin a search. */ - minSearchLength?: number; - - - mode?: string; // "text" | "email" | "search" | "tel" | "url" | "password" - onChange?: (e: { component: any; element: JQuery; model: any; event: JQueryEventObject }) => void; - onClosed?: (e: { component: any; element: JQuery; model: any }) => void; - onContentReady?: (e: { component: any; element: JQuery; model: any }) => void; - onCopy?: (e: { component: any; element: JQuery; model: any; event: JQueryEventObject }) => void; - onCut?: (e: { component: any; element: JQuery; model: any; event: JQueryEventObject }) => void; - onDisposing?: (e: { component: any; element: JQuery; model: any }) => void; - onEnterKey?: (e: { component: any; element: JQuery; model: any; event: JQueryEventObject }) => void; - onFocusIn?: (e: { component: any; element: JQuery; model: any; event: JQueryEventObject }) => void; - onFocusOut?: (e: { component: any; element: JQuery; model: any; event: JQueryEventObject }) => void; - onInitialized?: (e: { component: any; element: JQuery }) => void; - onInput?: (e: { component: any; element: JQuery; model: any; event: JQueryEventObject }) => void; - onItemClick?: (e: { component: any; element: JQuery; model: any; itemElement: HTMLElement }) => void; - onKeyDown?: (e: { component: any; element: JQuery; model: any; event: JQueryEventObject }) => void; - onKeyPress?: (e: { component: any; element: JQuery; model: any; event: JQueryEventObject }) => void; - onKeyUp?: (e: { component: any; element: JQuery; model: any; event: JQueryEventObject }) => void; - onOpened?: (e: { component: any; element: JQuery; model: any }) => void; - onOptionChanged?: (e: { component: any; element: JQuery; model: any; value: any }) => void; - onPaste?: (e: { component: any; element: JQuery; model: any; event: JQueryEventObject }) => void; - onSelectionChanged?: (e: { component: any; element: JQuery; model: any; selectedItem: any }) => void; - onValueChanged?: (e: { component: any; element: JQuery; model: any; value: any; previousValue: any; itemData: any; jQueryEvent: JQueryEventObject }) => void; - opened?: boolean; - placeholder?: string; - readOnly?: boolean; - rtlEnabled?: boolean; - searchExpr?: string; - searchMode?: string; // "contains" | "startswith" - searchTimeout?: number; - /** Gets the currently selected item. */ - selectedItem?: any; - showClearButton?: boolean; - spellcheck?: boolean; - tabIndex?: number; - text?: string; - validationError?: any; - validationMessageMode?: string; // "auto" | "always" - /** Specifies the current value displayed by the widget. */ - value?: string; - /** - * CAn be any DOM event names separated by spaces. - */ - valueChangeEvent?: string; - valueExpr?: string | Function; - visible?: boolean; - width?: string | number | (() => string | number); - } - /** A textbox widget that supports autocompletion. */ - export class dxAutocomplete extends dxDropDownList { - constructor(element: JQuery, options?: dxAutocompleteOptions); - constructor(element: Element, options?: dxAutocompleteOptions); - /** Opens the drop-down editor. */ - open(): void; - /** Closes the drop-down editor. */ - close(): void; - } - export interface dxAccordionOptions extends CollectionWidgetOptions { - /** A number specifying the time in milliseconds spent on the animation of the expanding or collapsing of a panel. */ - animationDuration?: number; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies whether all items can be collapsed or whether at least one item must always be expanded. */ - collapsible?: boolean; - /** Specifies whether the widget can expand several items or only a single item at once. */ - multiple?: boolean; - /** The template to be used for rendering dxAccordion items. */ - itemTemplate?: any; - /** A handler for the itemTitleClick event. */ - onItemTitleClick?: any; - /** A handler for the itemTitleHold event. */ - onItemTitleHold?: Function; - /** The template to be used for rendering an item title. */ - itemTitleTemplate?: any; - /** The index number of the currently selected item. */ - selectedIndex?: number; - } - /** A widget that displays data source items on collapsible panels. */ - export class dxAccordion extends CollectionWidget { - constructor(element: JQuery, options?: dxAccordionOptions); - constructor(element: Element, options?: dxAccordionOptions); - /** Collapses the specified item. */ - collapseItem(index: number): JQueryPromise; - /** Expands the specified item. */ - expandItem(index: number): JQueryPromise; - } - export interface dxFileUploaderOptions extends EditorOptions { - /** A read-only option that holds a File instance representing the selected file. */ - value?: File; - /** Holds the File instances representing files selected in the widget. */ - values?: Array; - buttonText?: string; - /** The text displayed on the button that opens the file browser. */ - selectButtonText?: string; - /** The text displayed on the button that starts uploading. */ - uploadButtonText?: string; - /** Specifies the text displayed on the area to which an end-user can drop a file. */ - labelText?: string; - /** Specifies the value passed to the name attribute of the underlying input element. */ - name?: string; - /** Specifies whether the widget enables an end-user to select a single file or multiple files. */ - multiple?: boolean; - /** Specifies a file type or several types accepted by the widget. */ - accept?: string; - /** Specifies a target Url for the upload request. */ - uploadUrl?: string; - /** Specifies if an end user can remove a file from the selection and interrupt uploading. */ - allowCanceling?: boolean; - /** Specifies whether or not the widget displays the list of selected files. */ - showFileList?: boolean; - /** Gets the current progress in percentages. */ - progress?: number; - /** The message displayed by the widget when it is ready to upload the specified files. */ - readyToUploadMessage?: string; - /** The message displayed by the widget when uploading is finished. */ - uploadedMessage?: string; - /** The message displayed by the widget on uploading failure. */ - uploadFailedMessage?: string; - /** Specifies how the widget uploads files. */ - uploadMode?: string; - } - /** A widget used to select and upload a file or multiple files. */ - export class dxFileUploader extends Editor { - constructor(element: JQuery, options?: dxFileUploaderOptions); - constructor(element: Element, options?: dxFileUploaderOptions); - } - export interface dxTrackBarOptions extends EditorOptions { - /** The minimum value the widget can accept. */ - min?: number; - /** The maximum value the widget can accept. */ - max?: number; - /** The current widget value. */ - value?: number; - } - /** A base class for track bar widgets. */ - export class dxTrackBar extends Editor { - constructor(element: JQuery, options?: dxTrackBarOptions); - constructor(element: Element, options?: dxTrackBarOptions); - } - export interface dxProgressBarOptions extends dxTrackBarOptions { - /** Specifies a format for the progress status. */ - statusFormat?: any; - /** Specifies whether or not the widget displays a progress status. */ - showStatus?: boolean; - /** A handler for the complete event. */ - onComplete?: Function; - } - /** A widget used to indicate progress. */ - export class dxProgressBar extends dxTrackBar { - constructor(element: JQuery, options?: dxProgressBarOptions); - constructor(element: Element, options?: dxProgressBarOptions); - } - export interface dxSliderOptions extends dxTrackBarOptions { - /** The slider step size. */ - step?: number; - /** The current slider value. */ - value?: number; - /** Specifies whether or not to highlight a range selected within the widget. */ - showRange?: boolean; - /** Specifies the size of a step by which a slider handle is moved when a user uses the Page up or Page down keyboard shortcuts. */ - keyStep?: number; - /** Specifies options for the slider tooltip. */ - tooltip?: { - /** Specifies whether or not the tooltip is enabled. */ - enabled?: boolean; - /** Specifies format for the tooltip. */ - format?: any; - /** Specifies whether the tooltip is located over or under the slider. */ - position?: string; - /** Specifies whether the widget always shows a tooltip or only when a pointer is over the slider. */ - showMode?: string; - }; - /** Specifies options for labels displayed at the min and max values. */ - label?: { - /** Specifies whether or not slider labels are visible. */ - visible?: boolean; - /** Specifies whether labels are located over or under the scale. */ - position?: string; - /** Specifies a format for labels. */ - format?: any; - }; - } - /** A widget that allows a user to select a numeric value within a given range. */ - export class dxSlider extends dxTrackBar { - constructor(element: JQuery, options?: dxSliderOptions); - constructor(element: Element, options?: dxSliderOptions); - } - export interface dxRangeSliderOptions extends dxSliderOptions { - /** The left edge of the interval currently selected using the range slider. */ - start?: number; - /** The right edge of the interval currently selected using the range slider. */ - end?: number; - } - /** A widget that enables a user to select a range of numeric values. */ - export class dxRangeSlider extends dxSlider { - constructor(element: JQuery, options?: dxRangeSliderOptions); - constructor(element: Element, options?: dxRangeSliderOptions); - } -} -interface JQuery { - dxProgressBar(): JQuery; - dxProgressBar(options: "instance"): DevExpress.ui.dxProgressBar; - dxProgressBar(options: string): any; - dxProgressBar(options: string, ...params: any[]): any; - dxProgressBar(options: DevExpress.ui.dxProgressBarOptions): JQuery; - dxSlider(): JQuery; - dxSlider(options: "instance"): DevExpress.ui.dxSlider; - dxSlider(options: string): any; - dxSlider(options: string, ...params: any[]): any; - dxSlider(options: DevExpress.ui.dxSliderOptions): JQuery; - dxRangeSlider(): JQuery; - dxRangeSlider(options: "instance"): DevExpress.ui.dxRangeSlider; - dxRangeSlider(options: string): any; - dxRangeSlider(options: string, ...params: any[]): any; - dxRangeSlider(options: DevExpress.ui.dxRangeSliderOptions): JQuery; - dxFileUploader(): JQuery; - dxFileUploader(options: "instance"): DevExpress.ui.dxFileUploader; - dxFileUploader(options: string): any; - dxFileUploader(options: string, ...params: any[]): any; - dxFileUploader(options: DevExpress.ui.dxFileUploaderOptions): JQuery; - dxValidator(): JQuery; - dxValidator(options: "instance"): DevExpress.ui.dxValidator; - dxValidator(options: string): any; - dxValidator(options: string, ...params: any[]): any; - dxValidationGroup(): JQuery; - dxValidationGroup(options: "instance"): DevExpress.ui.dxValidationGroup; - dxValidationGroup(options: string): any; - dxValidationGroup(options: string, ...params: any[]): any; - dxValidationSummary(): JQuery; - dxValidationSummary(options: "instance"): DevExpress.ui.dxValidationSummary; - dxValidationSummary(options: string): any; - dxValidationSummary(options: string, ...params: any[]): any; - dxTooltip(): JQuery; - dxTooltip(options: "instance"): DevExpress.ui.dxTooltip; - dxTooltip(options: string): any; - dxTooltip(options: string, ...params: any[]): any; - dxTooltip(options: DevExpress.ui.dxTooltipOptions): JQuery; - dxResizable(): JQuery; - dxResizable(options: "instance"): DevExpress.ui.dxResizable; - dxResizable(options: string): any; - dxResizable(options: string, ...params: any[]): any; - dxResizable(options: DevExpress.ui.dxResizableOptions): JQuery; - dxDropDownList(): JQuery; - dxDropDownList(options: "instance"): DevExpress.ui.dxDropDownList; - dxDropDownList(options: string): any; - dxDropDownList(options: string, ...params: any[]): any; - dxDropDownList(options: DevExpress.ui.dxDropDownListOptions): JQuery; - dxToolbar(): JQuery; - dxToolbar(options: "instance"): DevExpress.ui.dxToolbar; - dxToolbar(options: string): any; - dxToolbar(options: string, ...params: any[]): any; - dxToolbar(options: DevExpress.ui.dxToolbarOptions): JQuery; - dxToast(): JQuery; - dxToast(options: "instance"): DevExpress.ui.dxToast; - dxToast(options: string): any; - dxToast(options: string, ...params: any[]): any; - dxToast(options: DevExpress.ui.dxToastOptions): JQuery; - dxTextEditor(): JQuery; - dxTextEditor(options: "instance"): DevExpress.ui.dxTextEditor; - dxTextEditor(options: string): any; - dxTextEditor(options: string, ...params: any[]): any; - dxTextEditor(options: DevExpress.ui.dxTextEditorOptions): JQuery; - dxTextBox(): JQuery; - dxTextBox(options: "instance"): DevExpress.ui.dxTextBox; - dxTextBox(options: string): any; - dxTextBox(options: string, ...params: any[]): any; - dxTextBox(options: DevExpress.ui.dxTextBoxOptions): JQuery; - dxTextArea(): JQuery; - dxTextArea(options: "instance"): DevExpress.ui.dxTextArea; - dxTextArea(options: string): any; - dxTextArea(options: string, ...params: any[]): any; - dxTextArea(options: DevExpress.ui.dxTextAreaOptions): JQuery; - dxTabs(): JQuery; - dxTabs(options: "instance"): DevExpress.ui.dxTabs; - dxTabs(options: string): any; - dxTabs(options: string, ...params: any[]): any; - dxTabs(options: DevExpress.ui.dxTabsOptions): JQuery; - dxTabPanel(): JQuery; - dxTabPanel(options: "instance"): DevExpress.ui.dxTabPanel; - dxTabPanel(options: string): any; - dxTabPanel(options: string, ...params: any[]): any; - dxTabPanel(options: DevExpress.ui.dxTabPanelOptions): JQuery; - dxSelectBox(): JQuery; - dxSelectBox(options: "instance"): DevExpress.ui.dxSelectBox; - dxSelectBox(options: string): any; - dxSelectBox(options: string, ...params: any[]): any; - dxSelectBox(options: DevExpress.ui.dxSelectBoxOptions): JQuery; - dxScrollView(): JQuery; - dxScrollView(options: "instance"): DevExpress.ui.dxScrollView; - dxScrollView(options: string): any; - dxScrollView(options: string, ...params: any[]): any; - dxScrollView(options: DevExpress.ui.dxScrollViewOptions): JQuery; - dxScrollable(): JQuery; - dxScrollable(options: "instance"): DevExpress.ui.dxScrollable; - dxScrollable(options: string): any; - dxScrollable(options: string, ...params: any[]): any; - dxScrollable(options: DevExpress.ui.dxScrollableOptions): JQuery; - dxRadioGroup(): JQuery; - dxRadioGroup(options: "instance"): DevExpress.ui.dxRadioGroup; - dxRadioGroup(options: string): any; - dxRadioGroup(options: string, ...params: any[]): any; - dxRadioGroup(options: DevExpress.ui.dxRadioGroupOptions): JQuery; - dxPopup(): JQuery; - dxPopup(options: "instance"): DevExpress.ui.dxPopup; - dxPopup(options: string): any; - dxPopup(options: string, ...params: any[]): any; - dxPopup(options: DevExpress.ui.dxPopupOptions): JQuery; - dxPopover(): JQuery; - dxPopover(options: "instance"): DevExpress.ui.dxPopover; - dxPopover(options: string): any; - dxPopover(options: string, ...params: any[]): any; - dxPopover(options: DevExpress.ui.dxPopoverOptions): JQuery; - dxOverlay(): JQuery; - dxOverlay(options: "instance"): DevExpress.ui.dxOverlay; - dxOverlay(options: string): any; - dxOverlay(options: string, ...params: any[]): any; - dxOverlay(options: DevExpress.ui.dxOverlayOptions): JQuery; - dxNumberBox(): JQuery; - dxNumberBox(options: "instance"): DevExpress.ui.dxNumberBox; - dxNumberBox(options: string): any; - dxNumberBox(options: string, ...params: any[]): any; - dxNumberBox(options: DevExpress.ui.dxNumberBoxOptions): JQuery; - dxNavBar(): JQuery; - dxNavBar(options: "instance"): DevExpress.ui.dxNavBar; - dxNavBar(options: string): any; - dxNavBar(options: string, ...params: any[]): any; - dxNavBar(options: DevExpress.ui.dxNavBarOptions): JQuery; - dxMultiView(): JQuery; - dxMultiView(options: "instance"): DevExpress.ui.dxMultiView; - dxMultiView(options: string): any; - dxMultiView(options: string, ...params: any[]): any; - dxMultiView(options: DevExpress.ui.dxMultiViewOptions): JQuery; - dxMap(): JQuery; - dxMap(options: "instance"): DevExpress.ui.dxMap; - dxMap(options: string): any; - dxMap(options: string, ...params: any[]): any; - dxMap(options: DevExpress.ui.dxMapOptions): JQuery; - dxLookup(): JQuery; - dxLookup(options: "instance"): DevExpress.ui.dxLookup; - dxLookup(options: string): any; - dxLookup(options: string, ...params: any[]): any; - dxLookup(options: DevExpress.ui.dxLookupOptions): JQuery; - dxLoadPanel(): JQuery; - dxLoadPanel(options: "instance"): DevExpress.ui.dxLoadPanel; - dxLoadPanel(options: string): any; - dxLoadPanel(options: string, ...params: any[]): any; - dxLoadPanel(options: DevExpress.ui.dxLoadPanelOptions): JQuery; - dxLoadIndicator(): JQuery; - dxLoadIndicator(options: "instance"): DevExpress.ui.dxLoadIndicator; - dxLoadIndicator(options: string): any; - dxLoadIndicator(options: string, ...params: any[]): any; - dxLoadIndicator(options: DevExpress.ui.dxLoadIndicatorOptions): JQuery; - dxList(): JQuery; - dxList(options: "instance"): DevExpress.ui.dxList; - dxList(options: string): any; - dxList(options: string, ...params: any[]): any; - dxList(options: DevExpress.ui.dxListOptions): JQuery; - dxGallery(): JQuery; - dxGallery(options: "instance"): DevExpress.ui.dxGallery; - dxGallery(options: string): any; - dxGallery(options: string, ...params: any[]): any; - dxGallery(options: DevExpress.ui.dxGalleryOptions): JQuery; - dxDropDownEditor(): JQuery; - dxDropDownEditor(options: "instance"): DevExpress.ui.dxDropDownEditor; - dxDropDownEditor(options: string): any; - dxDropDownEditor(options: string, ...params: any[]): any; - dxDropDownEditor(options: DevExpress.ui.dxDropDownEditorOptions): JQuery; - dxDateBox(): JQuery; - dxDateBox(options: "instance"): DevExpress.ui.dxDateBox; - dxDateBox(options: string): any; - dxDateBox(options: string, ...params: any[]): any; - dxDateBox(options: DevExpress.ui.dxDateBoxOptions): JQuery; - dxCheckBox(): JQuery; - dxCheckBox(options: "instance"): DevExpress.ui.dxCheckBox; - dxCheckBox(options: string): any; - dxCheckBox(options: string, ...params: any[]): any; - dxCheckBox(options: DevExpress.ui.dxCheckBoxOptions): JQuery; - dxBox(): JQuery; - dxBox(options: "instance"): DevExpress.ui.dxBox; - dxBox(options: string): any; - dxBox(options: string, ...params: any[]): any; - dxBox(options: DevExpress.ui.dxBoxOptions): JQuery; - dxButton(): JQuery; - dxButton(options: "instance"): DevExpress.ui.dxButton; - dxButton(options: string): any; - dxButton(options: string, ...params: any[]): any; - dxButton(options: DevExpress.ui.dxButtonOptions): JQuery; - dxCalendar(): JQuery; - dxCalendar(options: "instance"): DevExpress.ui.dxCalendar; - dxCalendar(options: string): any; - dxCalendar(options: string, ...params: any[]): any; - dxCalendar(options: DevExpress.ui.dxCalendarOptions): JQuery; - dxAccordion(): JQuery; - dxAccordion(options: "instance"): DevExpress.ui.dxAccordion; - dxAccordion(options: string): any; - dxAccordion(options: string, ...params: any[]): any; - dxAccordion(options: DevExpress.ui.dxAccordionOptions): JQuery; - dxAutocomplete(): JQuery; - dxAutocomplete(options: "instance"): DevExpress.ui.dxAutocomplete; - dxAutocomplete(options: string): any; - dxAutocomplete(options: string, ...params: any[]): any; - dxAutocomplete(options: DevExpress.ui.dxAutocompleteOptions): JQuery; -} - -declare namespace DevExpress.ui { - export interface dxTileViewOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** Specifies the height of the base tile view item. */ - baseItemHeight?: number; - /** Specifies the width of the base tile view item. */ - baseItemWidth?: number; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies the distance in pixels between adjacent tiles. */ - itemMargin?: number; - /** A Boolean value specifying whether or not to display a scrollbar. */ - showScrollbar?: boolean; - } - /** A widget displaying several blocks of data as tiles. */ - export class dxTileView extends CollectionWidget { - constructor(element: JQuery, options?: dxTileViewOptions); - constructor(element: Element, options?: dxTileViewOptions); - /** Returns the current scroll position of the widget content. */ - scrollPosition(): number; - } - export interface dxSwitchOptions extends EditorOptions { - /** Text displayed when the widget is in a disabled state. */ - offText?: string; - /** Text displayed when the widget is in an enabled state. */ - onText?: string; - /** A Boolean value specifying whether the current switch state is "On" or "Off". */ - value?: boolean; - } - /** A switch widget. */ - export class dxSwitch extends Editor { - constructor(element: JQuery, options?: dxSwitchOptions); - constructor(element: Element, options?: dxSwitchOptions); - } - export interface dxSlideOutViewOptions extends WidgetOptions { - /** Specifies whether or not the menu panel is visible. */ - menuVisible?: boolean; - /** Specifies whether or not the menu is shown when a user swipes the widget content. */ - swipeEnabled?: boolean; - /** A template to be used for rendering menu panel content. */ - menuTemplate?: any; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - } - /** The widget that allows you to slide-out the current view to reveal a custom menu. */ - export class dxSlideOutView extends Widget { - constructor(element: JQuery, options?: dxSlideOutViewOptions); - constructor(element: Element, options?: dxSlideOutViewOptions); - /** Returns an HTML element of the widget menu block. */ - menuContent(): JQuery; - /** Returns an HTML element of the widget content block. */ - content(): JQuery; - /** Displays the widget's menu block. */ - showMenu(): JQueryPromise; - /** Hides the widget's menu block. */ - hideMenu(): JQueryPromise; - /** Toggles the visibility of the widget's menu block. */ - toggleMenuVisibility(): JQueryPromise; - } - export interface dxSlideOutOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A Boolean value specifying whether or not to display a grouped menu. */ - menuGrouped?: boolean; - menuGroupRender?: any; - /** The name of the template used to display a group header. */ - menuGroupTemplate?: any; - menuItemRender?: any; - /** The template used to render menu items. */ - menuItemTemplate?: any; - /** A handler for the menuGroupRendered event. */ - onMenuGroupRendered?: Function; - /** A handler for the menuItemRendered event. */ - onMenuItemRendered?: Function; - /** Specifies whether or not the slide-out menu is displayed. */ - menuVisible?: boolean; - /** Indicates whether the menu can be shown/hidden by swiping the widget's main panel. */ - swipeEnabled?: boolean; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - } - /** The widget that allows you to slide-out the current view to reveal an item list. */ - export class dxSlideOut extends CollectionWidget { - constructor(element: JQuery, options?: dxSlideOutOptions); - constructor(element: Element, options?: dxSlideOutOptions); - /** Hides the widget's slide-out menu. */ - hideMenu(): JQueryPromise; - /** Displays the widget's slide-out menu. */ - showMenu(): JQueryPromise; - /** Toggles the visibility of the widget's slide-out menu. */ - toggleMenuVisibility(showing: boolean): JQueryPromise; - } - export interface dxPivotOptions extends CollectionWidgetOptions { - /** The index of the currently active pivot item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to allow users to switch between items by swiping. */ - swipeEnabled?: boolean; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - } - /** A widget that is similar to a traditional tab control, but optimized for the phone with simplified end-user interaction. */ - export class dxPivot extends CollectionWidget { - constructor(element: JQuery, options?: dxPivotOptions); - constructor(element: Element, options?: dxPivotOptions); - } - export interface dxPanoramaOptions extends CollectionWidgetOptions { - /** An object exposing options for setting a background image for the panorama. */ - backgroundImage?: { - /** Specifies the height of the panorama's background image. */ - height?: number; - /** Specifies the URL of the image that is used as the panorama's background image. */ - url?: string; - /** Specifies the width of the panorama's background image. */ - width?: number; - }; - /** The index of the currently active panorama item. */ - selectedIndex?: number; - /** Specifies the widget content title. */ - title?: string; - } - /** A widget displaying the required content in a long horizontal canvas that extends beyond the frames of the screen. */ - export class dxPanorama extends CollectionWidget { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - } - export interface dxDropDownMenuOptions extends WidgetOptions { - /** A handler for the buttonClick event. */ - onButtonClick?: any; - buttonClickAction?: any; - /** The name of the icon to be displayed by the DropDownMenu button. */ - buttonIcon?: string; - buttonIconSrc?: string; - /** The text displayed in the DropDownMenu button. */ - buttonText?: string; - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** A handler for the itemClick event. */ - onItemClick?: any; - itemClickAction?: any; - itemRender?: any; - /** An array of items displayed by the widget. */ - items?: Array; - /** The template to be used for rendering items. */ - itemTemplate?: any; - /** Specifies whether or not to show the drop down menu within a dxPopover widget. */ - usePopover?: boolean; - /** The width of the menu popup in pixels. */ - popupWidth?: any; - /** The height of the menu popup in pixels. */ - popupHeight?: any; - /** Specifies whether or not the drop-down menu is displayed. */ - opened?: boolean; - /** A Boolean value specifying whether or not the widget changes its state when being hovered by an end user. */ - hoverStateEnabled?: boolean; - } - /** A drop-down menu widget. */ - export class dxDropDownMenu extends Widget { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - /** This section lists the data source fields that are used in a default template for drop-down menu items. */ - /** Opens the drop-down menu. */ - open(): void; - /** Closes the drop-down menu. */ - close(): void; - } - export interface dxActionSheetOptions extends CollectionWidgetOptions { - cancelClickAction?: any; - /** A handler for the cancelClick event. */ - onCancelClick?: any; - /** The text displayed in the button that closes the action sheet. */ - cancelText?: string; - /** Specifies whether or not to display the Cancel button in action sheet. */ - showCancelButton?: boolean; - /** A Boolean value specifying whether or not the title of the action sheet is visible. */ - showTitle?: boolean; - /** Specifies the element the action sheet popover points at. */ - target?: any; - /** The title of the action sheet. */ - title?: string; - /** Specifies whether or not to show the action sheet within a dxPopover widget. */ - usePopover?: boolean; - /** A Boolean value specifying whether or not the dxActionSheet widget is visible. */ - visible?: boolean; - } - /** A widget consisting of a set of choices related to a certain task. */ - export class dxActionSheet extends CollectionWidget { - constructor(element: JQuery, options?: dxActionSheetOptions); - constructor(element: Element, options?: dxActionSheetOptions); - /** Hides the widget. */ - hide(): JQueryPromise; - /** Shows the widget. */ - show(): JQueryPromise; - /** Shows or hides the widget depending on the Boolean value passed as the parameter. */ - toggle(showing: boolean): JQueryPromise; - } -} -interface JQuery { - dxTileView(): JQuery; - dxTileView(options: "instance"): DevExpress.ui.dxTileView; - dxTileView(options: string): any; - dxTileView(options: string, ...params: any[]): any; - dxTileView(options: DevExpress.ui.dxTileViewOptions): JQuery; - dxSwitch(): JQuery; - dxSwitch(options: "instance"): DevExpress.ui.dxSwitch; - dxSwitch(options: string): any; - dxSwitch(options: string, ...params: any[]): any; - dxSwitch(options: DevExpress.ui.dxSwitchOptions): JQuery; - dxSlideOut(): JQuery; - dxSlideOut(options: "instance"): DevExpress.ui.dxSlideOut; - dxSlideOut(options: string): any; - dxSlideOut(options: string, ...params: any[]): any; - dxSlideOut(options: DevExpress.ui.dxSlideOutOptions): JQuery; - dxPivot(): JQuery; - dxPivot(options: "instance"): DevExpress.ui.dxPivot; - dxPivot(options: string): any; - dxPivot(options: string, ...params: any[]): any; - dxPivot(options: DevExpress.ui.dxPivotOptions): JQuery; - dxPanorama(): JQuery; - dxPanorama(options: "instance"): DevExpress.ui.dxPanorama; - dxPanorama(options: string): any; - dxPanorama(options: string, ...params: any[]): any; - dxPanorama(options: DevExpress.ui.dxPanoramaOptions): JQuery; - dxActionSheet(): JQuery; - dxActionSheet(options: "instance"): DevExpress.ui.dxActionSheet; - dxActionSheet(options: string): any; - dxActionSheet(options: string, ...params: any[]): any; - dxActionSheet(options: DevExpress.ui.dxActionSheetOptions): JQuery; - dxDropDownMenu(): JQuery; - dxDropDownMenu(options: "instance"): DevExpress.ui.dxDropDownMenu; - dxDropDownMenu(options: string): any; - dxDropDownMenu(options: string, ...params: any[]): any; - dxDropDownMenu(options: DevExpress.ui.dxDropDownMenuOptions): JQuery; -} -declare namespace DevExpress.data { - export interface XmlaStoreOptions { - /** The HTTP address to an XMLA OLAP server. */ - url?: string; - /** The name of the database associated with the Store. */ - catalog?: string; - /** The cube name. */ - cube?: string; - beforeSend?: (request: Object) => void; - } - /** A Store that provides access to an OLAP cube using the XMLA standard. */ - export class XmlaStore { - constructor(options: XmlaStoreOptions); - } - export interface PivotGridField { - index?: number; - /** A boolean value specifying whether or not the field is visible in the pivot grid and the Field Chooser. */ - visible?: boolean; - /** Name of the data source field containing data for the pivot grid field. */ - dataField?: string; - /** A caption that will be displayed in the pivot grid's field chooser to identify the field. */ - caption?: string; - /** Specifies a type of field values. */ - dataType?: string; - /** Specifies how the values of the current field are combined into groups. Cannot be used for the XmlaStore store type. */ - groupInterval?: any; - /** Specifies how to aggregate field data. Cannot be used for th XmlaStore store type. */ - summaryType?: string; - /** Allows you to use a custom aggregate function to calculate the summary values. Cannot be used for the XmlaStore store type. */ - calculateCustomSummary?: (options: { - summaryProcess?: string; - value?: any; - totalValue?: any; - }) => void; - /** Specifies the function that determines how to split data from the data source into ranges for header items. Cannot be used for the XmlaStore store type. */ - selector?: (data: Object) => any; - /** Type of the area where the field is located. */ - area?: string; - /** Index among the other fields displayed within the same area. */ - areaIndex?: number; - /** The name of the folder in which the field is located. */ - displayFolder?: string; - /** The name of the group to which the field belongs. */ - groupName?: string; - /** The index of the field within a group. */ - groupIndex?: number; - /** Specifies the initial sort order of field values. */ - sortOrder?: string; - /** Specifies how field data should be sorted. Can be used for the XmlaStore store type only. */ - sortBy?: string; - /** Specifies the data field against which the header items of this field should be sorted. */ - sortBySummaryField?: string; - /** The array of field names that specify a path to column/row whose summary field is used for sorting of this field's header items. */ - sortBySummaryPath?: Array; - /** The filter values for the current field. */ - filterValues?: Array; - /** The filter type for the current field. */ - filterType?: string; - /** Indicates whether all header items of the field's header level are expanded. */ - expanded?: boolean; - /** Specifies whether the field should be treated as a Data Field. */ - isMeasure?: boolean; - /** Specifies a display format for field values. */ - format?: string; - /** Specifies a callback function that returns the text to be displayed in the cells of a field. */ - customizeText?: (cellInfo: { value: any; valueText: string }) => string; - /** Specifies a precision for formatted field values. */ - precision?: number; - /** Specifies how to sort the header items. */ - sortingMethod?: (a: Object, b: Object) => number; - /** Allows an end-user to change sorting options. */ - allowSorting?: boolean; - /** Allows an end-user to sort columns by summary values. */ - allowSortingBySummary?: boolean; - /** Allows an end-user to change filtering options. */ - allowFiltering?: boolean; - /** Allows an end-user to expand/collapse all header items within a header level. */ - allowExpandAll?: boolean; - /** Specifies the absolute width of the field in the pivot grid. */ - width?: number; - } - export interface PivotGridDataSourceOptions { - /** Specifies the underlying Store instance used to access data. */ - store?: any; - /** Indicates whether or not the automatic field generation from data in the Store is enabled. */ - retrieveFields?: boolean; - /** Specifies data filtering conditions. */ - filter?: Object; - /** An array of pivot grid fields. */ - fields?: Array; - /** Indicates whether or not the local sorting of the XMLA data should be performed. */ - localSorting?: boolean; - /** A handler for the changed event. */ - onChanged?: () => void; - /** A handler for the loadingChanged event. */ - onLoadingChanged?: (isLoading: boolean) => void; - /** A handler for the loadError event. */ - onLoadError?: (e?: Object) => void; - /** A handler for the fieldsPrepared event. */ - onFieldsPrepared?: (e?: Array) => void; - } - /** An object that provides access to data for the dxPivotGrid widget. */ - export class PivotGridDataSource implements EventsMixin { - constructor(options?: PivotGridDataSource); - /** Starts loading data. */ - load(): JQueryPromise; - /** Indicates whether or not the PivotGridDataSource is currently being loaded. */ - isLoading(): boolean; - /** Gets data displayed in a PivotGrid. */ - getData(): Object; - /** Gets all fields within a specified area. */ - getAreaFields(area: string, collectGroups: boolean): Array; - /** Gets all fields from the data source. */ - fields(): Array; - /** Sets the fields option. */ - fields(fields: Array): void; - /** Gets current options of a specified field. */ - field(id: number): PivotGridField; - /** Sets one or more options of a specified field. */ - field(id: number, field: PivotGridField): void; - /** Collapses a specified header item. */ - collapseHeaderItem(area: string, path: Array): void; - /** Expands a specified header item. */ - expandHeaderItem(area: string, path: Array): void; - /** Disposes of all resources associated with this PivotGridDataSource. */ - dispose(): void; - on(eventName: string, eventHandler: Function): PivotGridDataSource; - on(events: { [eventName: string]: Function; }): PivotGridDataSource; - off(eventName: string): PivotGridDataSource; - off(eventName: string, eventHandler: Function): PivotGridDataSource; - } -} -declare namespace DevExpress.ui { - export interface dxSchedulerOptions extends WidgetOptions { - /** Specifies a date displayed on the current scheduler view by default. */ - currentDate?: Date; - /** Specifies the view used in the scheduler by default. */ - currentView?: string; - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** Specifies the first day of a week. */ - firstDayOfWeek?: number; - /** The template to be used for rendering appointments. */ - appointmentTemplate?: any; - /** Lists the views to be available within the scheduler's View Selector. */ - views?: Array; - /** Specifies the resource kinds by which the scheduler's appointments are grouped in a timetable. */ - groups?: Array; - /** Specifies a start hour in the scheduler view's time interval. */ - startDayHour?: number; - /** Specifies an end hour in the scheduler view's time interval. */ - endDayHour?: number; - /** Specifies whether the scheduler data can be edited at runtime. */ - editing?: boolean; - /** Specifies an array of resources available in the scheduler. */ - resources?: Array<{ - /** Indicates whether or not several resources of this kind can be assigned to an appointment. */ - allowMultiple?: boolean; - /** Indicates whether or not resources of this kind have priority in the color identification of the appointments that have resources of different kinds assigned. */ - mainColor?: boolean; - /** A data source used to fetch resources to be available in the scheduler. */ - dataSource?: any; - /** Specifies the resource object field whose value is displayed by the Resource editor in the Appointment popup window. */ - displayExpr?: any; - /** Specifies the resource object field that is used as a value of the Resource editor in the Appointment popup window. */ - valueExpr?: any; - /** The name of the appointment object field that specifies a resource of this kind. */ - field?: string; - /** Specifies the label of the Appointment popup window field that allows end users to assign a resource of this kind. */ - label?: string; - }>; - /** A handler for the AppoinmentAdding event. */ - onAppointmentAdding?: Function; - /** A handler for the appointmentAdded event. */ - onAppointmentAdded?: Function; - /** A handler for the AppoinmentUpdating event. */ - onAppointmentUpdating?: Function; - /** A handler for the appointmentUpdated event. */ - onAppointmentUpdated?: Function; - /** A handler for the AppoinmentDeleting event. */ - onAppointmentDeleting?: Function; - /** A handler for the appointmentDeleted event. */ - onAppointmentDeleted?: Function; - /** A handler for the appointmentRendered event. */ - onAppointmentRendered?: Function; - } - /** A widget that displays scheduled data using different views and provides the capability to load, add and edit appointments. */ - export class dxScheduler extends Widget { - constructor(element: JQuery, options?: dxSchedulerOptions); - constructor(element: Element, options?: dxSchedulerOptions); - /** Add the appointment defined by the object passed as a parameter to the data associated with the widget. */ - addAppointment(appointment: Object): void; - /** Updates the appointment specified by the first method parameter by the appointment object specified by the second method parameter in the the data associated with the widget. */ - updateAppointment(target: Object, appointment: Object): void; - /** Deletes the appointment defined by the parameter from the the data associated with the widget. */ - deleteAppointment(appointment: Object): void; - /** Scrolls the scheduler work space to the specified time. */ - scrollToTime(hours: number, minutes: number): void; - } - export interface dxColorBoxOptions extends dxDropDownEditorOptions { - /** Specifies the text displayed on the button that applies changes and closes the drop-down editor. */ - applyButtonText?: string; - applyValueMode?: string; - /** Specifies the text displayed on the button that cancels changes and closes the drop-down editor. */ - cancelButtonText?: string; - /** Specifies whether or not the widget value includes the alpha channel component. */ - editAlphaChannel?: boolean; - /** Specifies the size of a step by which a handle is moved using a keyboard shortcut. */ - keyStep?: number; - } - /** A widget used to specify a color value. */ - export class dxColorBox extends dxDropDownEditor { - constructor(element: JQuery, options?: dxColorBoxOptions); - constructor(element: Element, options?: dxColorBoxOptions); - } - export interface dxColorPickerOptions extends dxColorBoxOptions { } - /** - * A widget used to specify a color value. - * @deprecated Use the dxColorBox widget instead - */ - export class dxColorPicker extends dxColorBox { - constructor(element: JQuery, options?: dxColorPickerOptions); - constructor(element: Element, options?: dxColorPickerOptions); - } - export interface dxTreeViewOptions extends CollectionWidgetOptions { - /** Specifies whether or not to animate item collapsing and expanding. */ - animationEnabled?: boolean; - /** Specifies whether a nested or plain array is used as a data source. */ - dataStructure?: string; - /** Specifies whether or not a user can expand all tree view items by the "*" hot key. */ - expandAllEnabled?: boolean; - /** - * An array of currently expanded item objects. - * @deprecated Use item.expanded field instead - */ - expandedItems?: Array; - /** Specifies whether or not a check box is displayed at each tree view item. */ - showCheckBoxes?: boolean; - /** Specifies whether or not to select nodes recursively. */ - selectNodesRecursive?: boolean; - /** Specifies whether the "Select All" check box is displayed over the tree view. */ - selectAllEnabled?: boolean; - /** Specifies the text displayed at the "Select All" check box. */ - selectAllText?: string; - /** Specifies the name of the data source item field used as a key. */ - keyExpr?: any; - /** Specifies the name of the data source item field whose value is displayed by the widget. */ - displayExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding node is selected. */ - selectedExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding node is expanded. */ - expandedExpr?: any; - /** Specifies the name of the data source item field that contains an array of nested items. */ - itemsExpr?: any; - /** Specifies the name of the data source item field that holds the key of the parent item. */ - parentIdExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding node is disabled. */ - disabledExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding node includes child nodes. */ - hasItemsExpr?: any; - /** Specifies if the virtual mode is enabled. */ - virtualModeEnabled?: boolean; - /** Specifies the parent ID value of the root item. */ - rootValue?: any; - /** A string value specifying available scrolling directions. */ - scrollDirection?: string; - /** A handler for the itemSelected event. */ - onItemSelected?: Function; - /** A handler for the itemExpanded event. */ - onItemExpanded?: Function; - /** A handler for the itemCollapsed event. */ - onItemCollapsed?: Function; - onItemClick?: Function; - onItemContextMenu?: Function; - onItemRendered?: Function; - onItemHold?: Function; - hoverStateEnabled?: boolean; - focusStateEnabled?: boolean; - } - /** A widget displaying specified data items as a tree. */ - export class dxTreeView extends CollectionWidget { - constructor(element: JQuery, options?: dxTreeViewOptions); - constructor(element: Element, options?: dxTreeViewOptions); - /** Updates the tree view scrollbars according to the current size of the widget content. */ - updateDimensions(): JQueryPromise; - /** Selects the specified item. */ - selectItem(itemElement: any): void; - /** Unselects the specified item. */ - unselectItem(itemElement: any): void; - /** Expands the specified item. */ - expandItem(itemElement: any): void; - /** Collapses the specified item. */ - collapseItem(itemElement: any): void; - /** Returns all nodes of the tree view. */ - getNodes(): Array; - /** Selects all widget items. */ - selectAll(): void; - /** Unselects all widget items. */ - unselectAll(): void; - } - export interface dxMenuBaseOptions extends CollectionWidgetOptions { - /** An object that defines the animation options of the widget. */ - animation?: fx.AnimationOptions; - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** Specifies the name of the CSS class associated with the menu. */ - cssClass?: string; - /** Holds an array of menu items. */ - items?: Array; - /** Specifies whether or not an item becomes selected if an end-user clicks it. */ - selectionByClick?: boolean; - /** Specifies the selection mode supported by the menu. */ - selectionMode?: string; - /** Specifies options of submenu showing and hiding. */ - showSubmenuMode?: { - /** Specifies the mode name. */ - name?: string; - /** Specifies the delay of submenu show and hiding. */ - delay?: { - /** The time span after which the submenu is shown. */ - show?: number; - /** The time span after which the submenu is hidden. */ - hide?: number; - }; - }; - /** A Boolean value specifying whether or not the widget changes its state when being hovered by an end user. */ - hoverStateEnabled?: boolean; - } - export class dxMenuBase extends CollectionWidget { - constructor(element: JQuery, options?: dxMenuBaseOptions); - constructor(element: Element, options?: dxMenuBaseOptions); - /** Selects the specified item. */ - selectItem(itemElement: any): void; - /** Unselects the specified item. */ - unselectItem(itemElement: any): void; - } - export interface dxMenuOptions extends dxMenuBaseOptions { - /** Specifies whether or not the submenu is hidden when the mouse pointer leaves it. */ - hideSubmenuOnMouseLeave?: boolean; - /** Specifies whether the menu has horizontal or vertical orientation. */ - orientation?: string; - /** Specifies options for showing and hiding the first level submenu. */ - showFirstSubmenuMode?: { - /** Specifies the mode name. */ - name?: string; - /** Specifies the delay of submenu showing and hiding. */ - delay?: { - /** The time span after which the submenu is shown. */ - show?: number; - /** The time span after which the submenu is hidden. */ - hide?: number; - }; - }; - /** Specifies the direction at which the submenus are displayed. */ - submenuDirection?: string; - /** A handler for the submenuHidden event. */ - onSubmenuHidden?: Function; - submenuHiddenAction?: Function; - /** A handler for the submenuHiding event. */ - onSubmenuHiding?: Function; - submenuHidingAction?: Function; - /** A handler for the submenuShowing event. */ - onSubmenuShowing?: Function; - submenuShowingAction?: Function; - /** A handler for the submenuShown event. */ - onSubmenuShown?: Function; - submenuShownAction?: Function; - } - /** A menu widget. */ - export class dxMenu extends dxMenuBase { - constructor(element: JQuery, options?: dxMenuOptions); - constructor(element: Element, options?: dxMenuOptions); - } - export interface dxContextMenuOptions extends dxMenuBaseOptions { - /** Holds an object that specifies options of alternative menu invocation. */ - alternativeInvocationMode?: { - /** Specifies whether or not the standard context menu invocation (on a right mouse click or on a long tap) is disabled. */ - enabled?: Boolean; - /** Specifies the element used to invoke the context menu. */ - invokingElement?: any; - }; - /** A handler for the hidden event. */ - onHidden?: Function; - /** A handler for the hiding event. */ - onHiding?: Function; - /** A handler for the positioning event. */ - onPositioning?: Function; - /** A handler for the showing event. */ - onShowing?: Function; - /** A handler for the shown event. */ - onShown?: Function; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** Specifies the direction at which submenus are displayed. */ - submenuDirection?: string; - /** The target element associated with a popover. */ - target?: any; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - } - /** A context menu widget. */ - export class dxContextMenu extends dxMenuBase { - constructor(element: JQuery, options?: dxContextMenuOptions); - constructor(element: Element, options?: dxContextMenuOptions); - /** Toggles the visibility of the widget. */ - toggle(showing: boolean): JQueryPromise; - /** Shows the widget. */ - show(): JQueryPromise; - /** Hides the widget. */ - hide(): JQueryPromise; - } - export interface dxRemoteOperations { - /** Specifies whether or not filtering must be performed on the server side. */ - filtering?: boolean; - /** Specifies whether or not paging must be performed on the server side. */ - paging?: boolean; - /** Specifies whether or not sorting must be performed on the server side. */ - sorting?: boolean; - } - export interface dxDataGridColumn { - /** Specifies the content alignment within column cells. */ - alignment?: string; - /** Specifies whether the values in a column can be edited at runtime. Setting this option makes sense only when editing is enabled for a grid. */ - allowEditing?: boolean; - /** Specifies whether or not a column can be used for filtering grid records. Setting this option makes sense only when the filter row and column header filtering are visible. */ - allowFiltering?: boolean; - /** Specifies whether or not the column can be anchored to a grid edge by end users. Setting this option makes sense only when the columnFixing | enabled option is set to true. */ - allowFixing?: boolean; - /** Specifies if a column can be used for searching grid records. Setting this option makes sense only when the search panel is visible. */ - allowSearch?: boolean; - /** Specifies whether a column can be used for grouping grid records at runtime. Setting this option makes sense only when the group panel is visible. */ - allowGrouping?: boolean; - /** Specifies whether or not a column can be hidden by a user. Setting this option makes sense only when the column chooser is visible. */ - allowHiding?: boolean; - /** Specifies whether or not a particular column can be used in column reordering. Setting this option makes sense only when the allowColumnReordering option is set to true. */ - allowReordering?: boolean; - /** Specifies whether or not a particular column can be resized by a user. Setting this option makes sense only when the allowColumnResizing option is true. */ - allowResizing?: boolean; - /** Specifies whether grid records can be sorted by a specific column at runtime. Setting this option makes sense only when the sorting mode differs from none. */ - allowSorting?: boolean; - /** Specifies whether groups appear expanded or not when records are grouped by a specific column. Setting this option makes sense only when grouping is allowed for this column. */ - autoExpandGroup?: boolean; - /** Specifies a callback function that returns a value to be displayed in a column cell. */ - calculateCellValue?: (rowData: Object) => string; - /** Specifies a callback function that defines filters for customary calculated grid cells. */ - calculateFilterExpression?: (filterValue: any, selectedFilterOperation: string) => Array; - /** Specifies a caption for a column. */ - caption?: string; - /** Specifies a custom template for grid column cells. */ - cellTemplate?: any; - /** Specifies a CSS class to be applied to a column. */ - cssClass?: string; - /** Specifies a callback function that determines values for column cells to be used for grouping. */ - calculateGroupValue?: any; - /** Specifies a callback function that returns a value or the name of the field to be used for sorting column cells. */ - calculateSortValue?: any; - /** Specifies a callback function that returns the text to be displayed in the cells of a column. */ - customizeText?: (cellInfo: { value: any; valueText: string }) => string; - /** Specifies the field of a data source that provides data for a column. */ - dataField?: string; - /** Specifies the required type of column values. */ - dataType?: string; - /** Specifies a custom template for the cell of a grid column when it is in an editing state. */ - editCellTemplate?: any; - /** Specifies whether HTML tags are displayed as plain text or applied to the values of the column. */ - encodeHtml?: boolean; - /** In a boolean column, replaces all false items with a specified text. */ - falseText?: string; - /** Specifies the set of available filter operations. */ - filterOperations?: Array; - /** Specifies a filter value for a column. */ - filterValue?: any; - /** Specifies initial filter values for the column's header filter. */ - filterValues?: Array; - /** Specifies whether to include or exclude the records with the values selected in the column's header filter. */ - filterType?: string; - /** Indicates whether the column takes part in horizontal grid scrolling or is anchored to a grid edge. */ - fixed?: boolean; - /** Specifies the grid edge to which the column is anchored. */ - fixedPosition?: string; - /** Specifies a format for the values displayed in a column. */ - format?: string; - /** Specifies a custom template for the group cell of a grid column. */ - groupCellTemplate?: any; - /** Specifies the index of a column when grid records are grouped by the values of this column. */ - groupIndex?: number; - /** Specifies a custom template for the header of a grid column. */ - headerCellTemplate?: any; - /** Specifies options of a lookup column. */ - lookup?: { - /** Specifies whether or not a user can nullify values of a lookup column. */ - allowClearing?: boolean; - /** - * Specifies the data source providing data for a lookup column. - */ - dataSource?: any; - /** Specifies the expression defining the data source field whose values must be displayed. */ - displayExpr?: any; - /** Specifies the expression defining the data source field whose values must be replaced. */ - valueExpr?: string; - }; - /** Specifies a precision for formatted values displayed in a column. */ - precision?: number; - /** Specifies a filter operation applied to a column. */ - selectedFilterOperation?: string; - /** Specifies whether or not the column displays its values by using editors. */ - showEditorAlways?: boolean; - /** Specifies whether or not to display the column when grid records are grouped by it. */ - showWhenGrouped?: boolean; - /** Specifies the index of a column when grid records are sorted by the values of this column. */ - sortIndex?: number; - /** Specifies the initial sort order of column values. */ - sortOrder?: string; - /** In a boolean column, replaces all true items with a specified text. */ - trueText?: string; - /** Specifies whether a column is visible or not. */ - visible?: boolean; - /** Specifies the sequence number of the column in the grid. */ - visibleIndex?: number; - /** Specifies a column width in pixels or percentages. */ - width?: any; - /** Specifies an array of validation rules to be checked when updating column cell values. */ - validationRules?: Array; - /** Specifies whether or not to display the header of a hidden column in the column chooser. */ - showInColumnChooser?: boolean; - /** Specifies the identifier of the column. */ - name?: string; - } - export interface dxDataGridOptions extends WidgetOptions { - /** Specifies whether the outer borders of the grid are visible or not. */ - showBorders?: boolean; - /** Indicates whether to show the error row for the grid. */ - errorRowEnabled?: boolean; - /** A handler for the rowValidating event. */ - onRowValidating?: (e: Object) => void; - /** A handler for the contextMenuPreparing event. */ - onContextMenuPreparing?: (e: Object) => void; - initNewRow?: (e: { data: Object }) => void; - /** A handler for the initNewRow event. */ - onInitNewRow?: (e: { data: Object }) => void; - rowInserted?: (e: { data: Object; key: any }) => void; - /** A handler for the rowInserted event. */ - onRowInserted?: (e: { data: Object; key: any }) => void; - rowInserting?: (e: { data: Object; cancel: boolean }) => void; - /** A handler for the rowInserting event. */ - onRowInserting?: (e: { data: Object; cancel: boolean }) => void; - rowRemoved?: (e: { data: Object; key: any }) => void; - /** A handler for the rowRemoved event. */ - onRowRemoved?: (e: { data: Object; key: any }) => void; - rowRemoving?: (e: { data: Object; key: any; cancel: boolean }) => void; - /** A handler for the rowRemoving event. */ - onRowRemoving?: (e: { data: Object; key: any; cancel: boolean }) => void; - rowUpdated?: (e: { data: Object; key: any }) => void; - /** A handler for the rowUpdated event. */ - onRowUpdated?: (e: { data: Object; key: any }) => void; - rowUpdating?: (e: { oldData: Object; newData: Object; key: any; cancel: boolean }) => void; - /** A handler for the rowUpdating event. */ - onRowUpdating?: (e: { oldData: Object; newData: Object; key: any; cancel: boolean }) => void; - /** Enables a hint that appears when a user hovers the mouse pointer over a cell with truncated content. */ - cellHintEnabled?: boolean; - /** Specifies whether or not grid columns can be reordered by a user. */ - allowColumnReordering?: boolean; - /** Specifies whether or not grid columns can be resized by a user. */ - allowColumnResizing?: boolean; - cellClick?: any; - /** A handler for the cellClick event. */ - onCellClick?: any; - cellHoverChanged?: (e: Object) => void; - /** A handler for the cellHoverChanged event. */ - onCellHoverChanged?: (e: Object) => void; - cellPrepared?: (e: Object) => void; - /** A handler for the cellPrepared event. */ - onCellPrepared?: (e: Object) => void; - /** Specifies whether or not the width of grid columns depends on column content. */ - columnAutoWidth?: boolean; - /** Specifies the options of a column chooser. */ - columnChooser?: { - /** Specifies text displayed by the column chooser panel when it does not contain any columns. */ - emptyPanelText?: string; - /** Specifies whether a user can invoke the column chooser or not. */ - enabled?: boolean; - /** Specifies the height of the column chooser panel. */ - height?: number; - /** Specifies text displayed in the title of the column chooser panel. */ - title?: string; - /** Specifies the width of the column chooser panel. */ - width?: number; - }; - /** Specifies options for column fixing. */ - columnFixing?: { - /** Indicates if column fixing is enabled. */ - enabled?: boolean; - /** Contains options that specify texts for column-fixing related commands in the column header's context menu. */ - texts?: { - /** Specifies text for a context menu item that fixes the column for which the context menu is invoked. */ - fix?: string; - /** Specifies text for a context menu item that unfixes the column for which the context menu is invoked. */ - unfix?: string; - /** Specifies text for a context menu subitem that fixes a column, for which the context menu is invoked, to the left grid edge. */ - leftPosition?: string; - /** Specifies text for a context menu subitem that fixes a column, for which the context menu is invoked, to the right grid edge. */ - rightPosition?: string; - }; - }; - /** Specifies options for filtering using a column header filter. */ - headerFilter?: { - /** Indicates whether or not the column header filter button is visible. */ - visible?: boolean; - /** Specifies the height of the dropdown menu invoked when using a column header filter. */ - height?: number; - /** Specifies the width of the dropdown menu invoked when using a column header filter. */ - width?: number; - /** Contains options that specify texts for the dropdown menu invoked when you use a column header filter. */ - texts?: { - /** Specifies text for the item specifying an empty value in the column header filter's dropdown menu. */ - emptyValue?: string; - /** Specifies text for a button that closes the column header filter's dropdown menu and applies specified filtering. */ - ok?: string; - /** Specifies text for a button that closes the column header filter's dropdown menu without applying performed selection. */ - cancel?: string; - } - }; - /** - * An array of grid columns. - */ - columns?: dxDataGridColumn[]; - onContentReady?: Function; - contentReadyAction?: Function; - /** Specifies a function that customizes grid columns after they are created. */ - customizeColumns?: (columns: Array) => void; - dataErrorOccurred?: (errorObject: Error) => void; - /** Specifies a data source for the grid. */ - dataSource?: any; - editingStart?: (e: { - data: Object; - key: any; - cancel: boolean; - column: dxDataGridColumn - }) => void; - /** A handler for the editingStart event. */ - onEditingStart?: (e: { - data: Object; - key: any; - cancel: boolean; - column: dxDataGridColumn - }) => void; - editorPrepared?: (e: Object) => void; - /** A handler for the editorPrepared event. */ - onEditorPrepared?: (e: Object) => void; - editorPreparing?: (e: Object) => void; - /** A handler for the editorPreparing event. */ - onEditorPreparing?: (e: Object) => void; - /** Contains options that specify how grid content can be changed. */ - editing?: { - /** Specifies whether or not grid records can be edited at runtime. */ - editEnabled?: boolean; - /** Specifies how grid values can be edited manually. */ - editMode?: string; - /** Specifies whether or not new records can be inserted into a grid. */ - insertEnabled?: boolean; - /** Specifies whether or not records can be deleted from a grid. */ - removeEnabled?: boolean; - /** Contains options that specify texts for editing-related grid controls. */ - texts?: { - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Save" button. Setting this option makes sense only when the editMode option is set to batch. */ - saveAllChanges?: string; - /** Specifies text for a cancel button displayed when a row is in the editing state. Setting this option makes sense only when the editEnabled option is set to true. */ - cancelRowChanges?: string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Revert" button. Setting this option makes sense only when the editMode option is set to batch. */ - cancelAllChanges?: string; - /** Specifies a message to be displayed by a confirmation window. Setting this option makes sense only when the edit mode is "row". */ - confirmDeleteMessage?: string; - /** Specifies text to be displayed in the title of a confirmation window. Setting this option makes sense only when the edit mode is "row". */ - confirmDeleteTitle?: string; - /** Specifies text for a button that deletes a row from a grid. Setting this option makes sense only when the removeEnabled option is set to true. */ - deleteRow?: string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Add" button. Setting this option makes sense only when the insertEnabled option is true. */ - addRow?: string; - /** Specifies text for a button that turns a row into the editing state. Setting this option makes sense only when the editEnabled option is set to true. */ - editRow?: string; - /** Specifies text for a save button displayed when a row is in the editing state. Setting this option makes sense only when the editEnabled option is set to true. */ - saveRowChanges?: string; - /** Specifies text for a button that recovers a deleted row. Setting this option makes sense only if the grid uses the batch edit mode and the removeEnabled option is set to true. */ - undeleteRow?: string; - }; - }; - /** Specifies filter row options. */ - filterRow?: { - /** Specifies when to apply a filter. */ - applyFilter?: string; - /** Specifies text for the hint that pops up when a user hovers the mouse pointer over the "Apply Filter" button. */ - applyFilterText?: string; - /** Specifies descriptions for filter operations. */ - operationDescriptions?: { - "=": string; - "<>": string; - "<": string; - "<=": string; - ">": string; - ">=": string; - "startswith": string; - "contains": string; - "notcontains": string; - "endswith": string; - }; - /** Specifies text for the reset operation in a filter list. */ - resetOperationText?: string; - /** Specifies text for the operation of clearing the applied filter when a select box is used. */ - showAllText?: string; - /** Specifies whether or not an icon that allows the user to choose a filter operation is visible. */ - showOperationChooser?: boolean; - /** Specifies whether the filter row is visible or not. */ - visible?: boolean; - }; - /** Specifies the behavior of grouped grid records. */ - grouping?: { - /** Specifies whether the user can collapse grouped records in a grid or not. */ - allowCollapsing?: boolean; - /** Specifies whether groups appear expanded or not. */ - autoExpandAll?: boolean; - /** Specifies the message displayed in a group row when the corresponding group is continued from the previous page. */ - groupContinuedMessage?: string; - /** - * Specifies the message displayed in a group row when the corresponding group continues on the next page. - */ - groupContinuesMessage?: string; - }; - /** Specifies options that configure the group panel. */ - groupPanel?: { - /** Specifies whether columns can be dragged onto or from the group panel. */ - allowColumnDragging?: boolean; - /** Specifies text displayed by the group panel when it does not contain any columns. */ - emptyPanelText?: string; - /** Specifies whether the group panel is visible or not. */ - visible?: boolean; - }; - /** Specifies options configuring the load panel. */ - loadPanel?: { - /** Specifies whether to show the load panel or not. */ - enabled?: boolean; - /** Specifies the height of the load panel in pixels. */ - height?: number; - /** Specifies a URL pointing to an image to be used as a loading indicator. */ - indicatorSrc?: string; - /** Specifies whether or not a loading indicator must be displayed on the load panel. */ - showIndicator?: boolean; - /** Specifies whether or not the pane of the load panel must be displayed. */ - showPane?: boolean; - /** Specifies text displayed by the load panel. */ - text?: string; - /** Specifies the width of the load panel in pixels. */ - width?: number; - }; - /** Specifies text displayed when a grid does not contain any records. */ - noDataText?: string; - /** Specifies the options of a grid pager. */ - pager?: { - /** Specifies the page sizes that can be selected at runtime. */ - allowedPageSizes?: any; - /** Specifies whether to show the page size selector or not. */ - showPageSizeSelector?: boolean; - /** Specifies whether to show the pager or not. */ - visible?: any; - /** Specifies the text accompanying the page navigator. */ - infoText?: string; - /** Specifies whether or not to display the text accompanying the page navigator. This text is specified by the infoText option. */ - showInfo?: boolean; - /** Specifies whether or not to display buttons that switch the grid to the previous or next page. */ - showNavigationButtons?: boolean; - }; - /** Specifies paging options. */ - paging?: { - /** Specifies whether dxDataGrid loads data page by page or all at once. */ - enabled?: boolean; - /** Specifies the grid page that should be displayed by default. */ - pageIndex?: number; - /** Specifies the size of grid pages. */ - pageSize?: number; - }; - /** Specifies whether or not grid rows must be shaded in a different way. */ - rowAlternationEnabled?: boolean; - rowClick?: any; - /** A handler for the rowClick event. */ - onRowClick?: any; - rowPrepared?: (e: Object) => void; - /** A handler for the rowPrepared event. */ - onRowPrepared?: (e: Object) => void; - /** Specifies a custom template for grid rows. */ - rowTemplate?: any; - /** A configuration object specifying scrolling options. */ - scrolling?: { - /** Specifies the scrolling mode. */ - mode?: string; - /** Specifies whether or not a grid must preload pages adjacent to the current page when using virtual scrolling. */ - preloadEnabled?: boolean; - }; - /** Specifies options of the search panel. */ - searchPanel?: { - /** Specifies whether or not search strings in the located grid records should be highlighted. */ - highlightSearchText?: boolean; - /** Specifies text displayed by the search panel when no search string was typed. */ - placeholder?: string; - /** Specifies whether the search panel is visible or not. */ - visible?: boolean; - /** Specifies the width of the search panel in pixels. */ - width?: number; - /** Sets a search string for the search panel. */ - text?: string; - }; - /** Specifies the operations that must be performed on the server side. */ - remoteOperations?: any; - /** Allows you to sort groups according to the values of group summary items. */ - sortByGroupSummaryInfo?: Array<{ - /** Specifies the group summary item whose values must be used to sort groups. */ - summaryItem?: string; - /** Specifies the identifier of the column that must be used in grouping so that sorting by group summary item values be applied. */ - groupColumn?: string; - /** Specifies the sort order of group summary item values. */ - sortOrder?: string; - }>; - /** Allows you to build a master-detail interface in the grid. */ - masterDetail?: { - /** Enables an end-user to expand/collapse detail sections. */ - enabled?: boolean; - /** Specifies whether detail sections appear expanded or collapsed. */ - autoExpandAll?: boolean; - /** Specifies the template for detail sections. */ - template?: any; - }; - /** Specifies options for exporting grid data. */ - export?: { - /** Indicates if the export feature is enabled in the grid. */ - enabled?: boolean; - /** Specifies a default name for the file to which grid data is exported. */ - fileName?: string; - /** Specifies whether to enable Excel filtering for the exported data in the resulting XLSX file. */ - excelFilterEnabled?: boolean; - /** Specifies whether to enable word wrapping for the exported data in the resulting XLSX file. */ - excelWrapTextEnabled?: boolean; - /** Specifies the URL of the server-side proxy that streams the resulting file to the end user to enable export in IE8, IE9 and Safari browsers. */ - proxyUrl?: string; - /** Indicates whether to allow end users to export not only the data displayed in the grid, but the selected rows only. */ - allowExportSelectedData?: boolean; - /** Contains options that specify texts for the export-related commands and hints. */ - texts?: { - /** Specifies text for the Export button when this button invokes a dropdown menu so you can choose the required export format. */ - exportTo?: string; - /** Specifies text for the Export button when this button exports to the XSLX format. */ - exportToExcel?: string; - /** Specifies text for the item in the Export dropdown menu that exports grid data to Excel. */ - excelFormat?: string; - /** Specifies text for the option in the Export dropdown menu that allows you to choose whether to export all the grid data or the selected rows only. */ - selectedRows?: string; - } - }; - /** Specifies the keys of the records that must appear selected initially. */ - selectedRowKeys?: Array; - /** Specifies options of runtime selection. */ - selection?: { - /** Specifies whether the user can select all grid records at once. */ - allowSelectAll?: boolean; - /** Specifies the selection mode. */ - mode?: string; - }; - selectionChanged?: (e: { - currentSelectedRowKeys: Array; - currentDeselectedRowKeys: Array; - selectedRowKeys: Array; - selectedRowsData: Array; - }) => void; - /** A handler for the dataErrorOccured event. */ - onDataErrorOccurred?: (e: { error: Error }) => void; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: (e: { - currentSelectedRowKeys: Array; - currentDeselectedRowKeys: Array; - selectedRowKeys: Array; - selectedRowsData: Array; - }) => void; - /** A handler for the exporting event. */ - onExporting?: (e: { - fileName: string; - format: string; - cancel: boolean; - }) => void; - /** A handler for the exported event. */ - onExported?: (e: Object) => void; - /** A handler for the keyDown event. */ - onKeyDown?: (e: Object) => void; - /** A handler for the rowExpanding event. */ - onRowExpanding?: (e: Object) => void; - /** A handler for the rowExpanded event. */ - onRowExpanded?: (e: Object) => void; - /** A handler for the rowCollapsing event. */ - onRowCollapsing?: (e: Object) => void; - /** A handler for the rowCollapsed event. */ - onRowCollapsed?: (e: Object) => void; - /** Specifies whether column headers are visible or not. */ - showColumnHeaders?: boolean; - /** Specifies whether or not vertical lines separating one grid column from another are visible. */ - showColumnLines?: boolean; - /** Specifies whether or not horizontal lines separating one grid row from another are visible. */ - showRowLines?: boolean; - /** Specifies options of runtime sorting. */ - sorting?: { - /** Specifies text for the context menu item that sets an ascending sort order in a column. */ - ascendingText?: string; - /** Specifies text for the context menu item that resets sorting settings for a column. */ - clearText?: string; - /** Specifies text for the context menu item that sets a descending sort order in a column. */ - descendingText?: string; - /** Specifies the runtime sorting mode. */ - mode?: string; - }; - /** Specifies options of state storing. */ - stateStoring?: { - /** Specifies a callback function that performs specific actions on state loading. */ - customLoad?: () => JQueryPromise; - /** Specifies a callback function that performs specific actions on state saving. */ - customSave?: (gridState: Object) => void; - /** Specifies whether or not a grid saves its state. */ - enabled?: boolean; - /** Specifies the delay between the last change of a grid state and the operation of saving this state in milliseconds. */ - savingTimeout?: number; - /** Specifies a unique key to be used for storing the grid state. */ - storageKey?: string; - /** Specifies the type of storage to be used for state storing. */ - type?: string; - }; - /** Specifies the options of the grid summary. */ - summary?: { - /** Contains options that specify text patterns for summary items. */ - texts?: { - /** Specifies a pattern for the 'sum' summary items when they are displayed in the parent column. */ - sum?: string; - /** Specifies a pattern for the 'sum' summary items displayed in a group row or in any other column rather than the parent one. */ - sumOtherColumn?: string; - /** Specifies a pattern for the 'min' summary items when they are displayed in the parent column. */ - min?: string; - /** Specifies a pattern for the 'min' summary items displayed in a group row or in any other column rather than the parent one. */ - minOtherColumn?: string; - /** Specifies a pattern for the 'max' summary items when they are displayed in the parent column. */ - max?: string; - /** Specifies a pattern for the 'max' summary items displayed in a group row or in any other column rather than the parent one. */ - maxOtherColumn?: string; - /** Specifies a pattern for the 'avg' summary items when they are displayed in the parent column. */ - avg?: string; - /** Specifies a pattern for the 'avg' summary items displayed in a group row or in any other column rather than the parent one. */ - avgOtherColumn?: string; - /** Specifies a pattern for the 'count' summary items. */ - count?: string; - }; - /** Specifies items of the group summary. */ - groupItems?: Array<{ - /** Specifies the identifier of a summary item. */ - name?: string; - /** Specifies the column that provides data for a group summary item. */ - column?: string; - /** Customizes the text to be displayed in the summary item. */ - customizeText?: (itemInfo: { - value: any; - valueText: string; - }) => string; - /** Specifies a pattern for the summary item text. */ - displayFormat?: string; - /** Specifies a precision for the summary item value of a numeric format. */ - precision?: number; - /** Specifies whether or not a summary item must be displayed in the group footer. */ - showInGroupFooter?: boolean; - /** Indicates whether to display group summary items in brackets of the group row header or to align them by the corresponding columns within the group row. */ - alignByColumn?: boolean; - /** Specifies the column that must hold the summary item when this item is displayed in the group footer or aligned by a column in the group row. */ - showInColumn?: string; - /** Specifies how to aggregate data for a summary item. */ - summaryType?: string; - /** Specifies a format for the summary item value. */ - valueFormat?: string; - }>; - /** Specifies items of the total summary. */ - totalItems?: Array<{ - /** Specifies the identifier of a summary item. */ - name?: string; - /** Specifies the alignment of a summary item. */ - alignment?: string; - /** Specifies the column that provides data for a summary item. */ - column?: string; - /** Specifies a CSS class to be applied to a summary item. */ - cssClass?: string; - /** Customizes the text to be displayed in the summary item. */ - customizeText?: (itemInfo: { - value: any; - valueText: string; - }) => string; - /** Specifies a pattern for the summary item text. */ - displayFormat?: string; - /** Specifies a precision for the summary item value of a numeric format. */ - precision?: number; - /** Specifies the column that must hold the summary item. */ - showInColumn?: string; - /** Specifies how to aggregate data for a summary item. */ - summaryType?: string; - /** Specifies a format for the summary item value. */ - valueFormat?: string; - }>; - /** Allows you to use a custom aggregate function to calculate the value of a summary item. */ - calculateCustomSummary?: (options: { - component: dxDataGrid; - name?: string; - value: any; - totalValue: any; - summaryProcess: string - }) => void; - }; - /** Specifies whether text that does not fit into a column should be wrapped. */ - wordWrapEnabled?: boolean; - } - /** A data grid widget. */ - export class dxDataGrid extends Widget { - constructor(element: JQuery, options?: dxDataGridOptions); - constructor(element: Element, options?: dxDataGridOptions); - /** Ungroups grid records. */ - clearGrouping(): void; - /** Clears sorting settings of all grid columns at once. */ - clearSorting(): void; - /** Allows you to obtain a cell by its row index and the data field of its column. */ - getCellElement(rowIndex: number, dataField: string): any; - /** Allows you to obtain a cell by its row index and the visible index of its column. */ - getCellElement(rowIndex: number, visibleColumnIndex: number): any; - /** Returns the current state of the grid. */ - state(): Object; - /** Sets the grid state. */ - state(state: Object): void; - /** Allows you to obtain the row index by a data key. */ - getRowIndexByKey(key: any): number; - /** Allows you to obtain the data key by a row index. */ - getKeyByRowIndex(rowIndex: number): any; - /** Adds a new column to a grid. */ - addColumn(columnOptions: dxDataGridColumn): void; - /** Displays the load panel. */ - beginCustomLoading(messageText: string): void; - /** Discards changes made in a grid. */ - cancelEditData(): void; - /** Clears all the filters of a specific type applied to grid records. */ - clearFilter(): void; - /** Deselects all grid records. */ - clearSelection(): void; - /** Draws the cell being edited from the editing state. Use this method when the edit mode is batch. */ - closeEditCell(): void; - /** Collapses groups or master rows in a grid. */ - collapseAll(groupIndex?: number): void; - /** Returns the number of data columns in a grid. */ - columnCount(): number; - /** Returns the value of a specific column option. */ - columnOption(id: number, optionName: string): any; - /** Sets an option of a specific column. */ - columnOption(id: number, optionName: string, optionValue: any): void; - /** Returns the options of a column by an identifier. */ - columnOption(id: any): Object; - /** Sets several options of a column at once. */ - columnOption(id: any, options: Object): void; - /** Sets a specific cell into the editing state. */ - editCell(rowIndex: number, columnIndex: number): void; - /** Sets a specific row into the editing state. */ - editRow(rowIndex: number): void; - /** Hides the load panel. */ - endCustomLoading(): void; - /** Expands groups or master rows in a grid. */ - expandAll(groupIndex: number): void; - /** Allows you to find out whether a specific group or master row is expanded or collapsed. */ - isRowExpanded(key: any): boolean; - /** Allows you to expand a specific group or master row by its key. */ - expandRow(key: any): void; - /** Allows you to collapse a specific group or master row by its key. */ - collapseRow(key: any): void; - /** Applies a filter to the grid's data source. */ - filter(filterExpr?: any): void; - /** Returns a filter expression applied to the grid's data source using the filter(filterExpr) method. */ - filter(): any; - /** Returns a filter expression applied to the grid using all possible scenarious. */ - getCombinedFilter(): any; - /** Gets the keys of currently selected grid records. */ - getSelectedRowKeys(): Array; - /** Gets the data objects of currently selected grid records. */ - getSelectedRowsData(): Array; - /** Hides the column chooser panel. */ - hideColumnChooser(): void; - /** Adds a new data row to a grid. */ - insertRow(): void; - /** Returns the key corresponding to the passed data object. */ - keyOf(obj: Object): any; - /** Switches a grid to a specified page. */ - pageIndex(newIndex: number): void; - /** Gets the index of the current page. */ - pageIndex(): number; - /** Sets the page size. */ - pageSize(value: number): void; - /** Gets the current page size. */ - pageSize(): number; - /** Refreshes grid data. */ - refresh(): void; - /** Removes a specific row from a grid. */ - removeRow(rowIndex: number): void; - /** Saves changes made in a grid. */ - saveEditData(): void; - /** - * Searches grid records by a search string. - */ - searchByText(text: string): void; - /** Selects all grid records. */ - selectAll(): void; - /** Deselects the rows that are currently selected within the applied filter. */ - deselectAll(): void; - /** Selects specific grid records. */ - selectRows(keys: Array, preserve: boolean): void; - /** Deselects specific grid records. */ - deselectRows(keys: Array): void; - /** Selects grid rows by indexes. */ - selectRowsByIndexes(indexes: Array): void; - /** Allows you to find out whether a row is selected or not. */ - isRowSelected(key: any): boolean; - /** Invokes the column chooser panel. */ - showColumnChooser(): void; - startSelectionWithCheckboxes(): boolean; - /** Returns the number of records currently held by a grid. */ - totalCount(): number; - /** Recovers a row deleted in the batch edit mode. */ - undeleteRow(rowIndex: number): void; - /** Allows you to obtain a data object by its key. */ - byKey(key: any): JQueryPromise; - /** Gets the value of a total summary item. */ - getTotalSummaryValue(summaryItemName: string): any; - /** Exports grid data to Excel. */ - exportToExcel(selectionOnly: boolean): void; - /** Updates the grid to the size of its content. */ - updateDimensions(): void; - /** Focuses the specified cell element in the grid. */ - focus(element?: JQuery): void; - } - export interface dxPivotGridOptions extends WidgetOptions { - onContentReady?: Function; - /** Specifies a data source for the pivot grid. */ - dataSource?: any; - /** Specifies whether or not the widget uses native scrolling. */ - useNativeScrolling?: any; - /** Allows an end-user to change sorting options. */ - allowSorting?: boolean; - /** Allows an end-user to sort columns by summary values. */ - allowSortingBySummary?: boolean; - /** Allows an end-user to change filtering options. */ - allowFiltering?: boolean; - /** Allows an end-user to expand/collapse all header items within a header level. */ - allowExpandAll?: boolean; - /** Specifies whether to display the Total rows. */ - showRowTotals?: boolean; - /** Specifies whether to display the Grand Total row. */ - showRowGrandTotals?: boolean; - /** Specifies whether to display the Total columns. */ - showColumnTotals?: boolean; - /** Specifies whether to display the Grand Total column. */ - showColumnGrandTotals?: boolean; - /** The Field Chooser configuration options. */ - fieldChooser?: { - /** Enables or disables the field chooser. */ - enabled?: boolean; - /** Specifies the field chooser layout. */ - layout?: number; - /** Specifies the text to display as a title of the field chooser popup window. */ - title?: string; - /** Specifies the field chooser width. */ - width?: number; - /** Specifies the field chooser height. */ - height?: number; - /** Strings that can be changed or localized in the pivot grid's integrated Field Chooser. */ - texts?: { - /** The string to display instead of Row Fields. */ - rowFields?: string; - /** The string to display instead of Column Fields. */ - columnFields?: string; - /** The string to display instead of Data Fields. */ - dataFields?: string; - /** The string to display instead of Filter Fields. */ - filterFields?: string; - /** The string to display instead of All Fields. */ - allFields?: string; - }; - } - /** Strings that can be changed or localized in the dxPivotGrid widget. */ - texts?: { - /** The string to display as a header of the Grand Total row and column. */ - grandTotal?: string; - /** The string to display as a header of the Total row and column. */ - total?: string; - /** Specifies the text displayed when a pivot grid does not contain any fields. */ - noData?: string; - /** The string to display as a Show Field Chooser context menu item. */ - showFieldChooser?: string; - /** The string to display as an Expand All context menu item. */ - expandAll?: string; - /** The string to display as a Collapse All context menu item. */ - collapseAll?: string; - /** The string to display as a Sort Column by Summary Value context menu item. */ - sortColumnBySummary?: string; - /** The string to display as a Sort Row by Summary Value context menu item. */ - sortRowBySummary?: string; - /** The string to display as a Remove All Sorting context menu item. */ - removeAllSorting?: string; - }; - /** The Load panel configuration options. */ - loadPanel?: { - /** Enables or disables the load panel. */ - enabled?: boolean; - /** Specifies the height of the load panel. */ - height?: number; - /** Specifies the URL pointing to an image that will be used as a load indicator. */ - indicatorSrc?: string; - /** Specifies whether or not to show a load indicator. */ - showIndicator?: boolean; - /** Specifies whether or not to show load panel background. */ - showPane?: boolean; - /** Specifies the text to display inside a load panel. */ - text?: string; - /** Specifies the width of the load panel. */ - width?: number; - }; - /** A handler for the cellClick event. */ - onCellClick?: (e: any) => void; - /** A handler for the cellPrepared event. */ - onCellPrepared?: (e: any) => void; - /** A handler for the contextMenuPreparing event. */ - onContextMenuPreparing?: (e: Object) => void; - } - /** A data summarization widget for multi-dimensional data analysis and data mining. */ - export class dxPivotGrid extends Widget { - constructor(element: JQuery, options?: dxPivotGridOptions); - constructor(element: Element, options?: dxPivotGridOptions); - /** Gets the PivotGridDataSource instance. */ - getDataSource(): DevExpress.data.PivotGridDataSource; - /** Updates the widget to the size of its content. */ - updateDimensions(): void; - } - export interface dxPivotGridFieldChooserOptions extends WidgetOptions { - /** Specifies the field chooser layout. */ - layout?: number; - /** The data source of a dxPivotGrid widget. */ - dataSource?: DevExpress.data.PivotGridDataSource; - onContentReady?: Function; - /** Strings that can be changed or localized in the dxPivotGridFieldChooser widget. */ - texts?: { - /** The string to display instead of Row Fields. */ - rowFields?: string; - /** The string to display instead of Column Fields. */ - columnFields?: string; - /** The string to display instead of Data Fields. */ - dataFields?: string; - /** The string to display instead of Filter Fields. */ - filterFields?: string; - /** The string to display instead of All Fields. */ - allFields?: string; - }; - } - /** A complementary widget for dxPivotGrid that allows you to manage data displayed in the dxPivotGrid. */ - export class dxPivotGridFieldChooser extends Widget { - constructor(element: JQuery, options?: dxPivotGridFieldChooserOptions); - constructor(element: Element, options?: dxPivotGridFieldChooserOptions); - /** Updates the widget to the size of its content. */ - updateDimensions(): void; - } -} -interface JQuery { - dxTreeView(): JQuery; - dxTreeView(options: "instance"): DevExpress.ui.dxTreeView; - dxTreeView(options: string): any; - dxTreeView(options: string, ...params: any[]): any; - dxTreeView(options: DevExpress.ui.dxTreeViewOptions): JQuery; - dxMenuBase(): JQuery; - dxMenuBase(options: "instance"): DevExpress.ui.dxMenuBase; - dxMenuBase(options: string): any; - dxMenuBase(options: string, ...params: any[]): any; - dxMenuBase(options: DevExpress.ui.dxMenuBaseOptions): JQuery; - dxMenu(): JQuery; - dxMenu(options: "instance"): DevExpress.ui.dxMenu; - dxMenu(options: string): any; - dxMenu(options: string, ...params: any[]): any; - dxMenu(options: DevExpress.ui.dxMenuOptions): JQuery; - dxContextMenu(): JQuery; - dxContextMenu(options: "instance"): DevExpress.ui.dxContextMenu; - dxContextMenu(options: string): any; - dxContextMenu(options: string, ...params: any[]): any; - dxContextMenu(options: DevExpress.ui.dxContextMenuOptions): JQuery; - dxColorBox(): JQuery; - dxColorBox(options: "instance"): DevExpress.ui.dxColorBox; - dxColorBox(options: string): any; - dxColorBox(options: string, ...params: any[]): any; - dxColorBox(options: DevExpress.ui.dxColorBoxOptions): JQuery; - dxDataGrid(): JQuery; - dxDataGrid(options: "instance"): DevExpress.ui.dxDataGrid; - dxDataGrid(options: string): any; - dxDataGrid(options: string, ...params: any[]): any; - dxDataGrid(options: DevExpress.ui.dxDataGridOptions): JQuery; - dxPivotGrid(): JQuery; - dxPivotGrid(options: "instance"): DevExpress.ui.dxPivotGrid; - dxPivotGrid(options: string): any; - dxPivotGrid(options: string, ...params: any[]): any; - dxPivotGrid(options: DevExpress.ui.dxPivotGridOptions): JQuery; - dxPivotGridFieldChooser(): JQuery; - dxPivotGridFieldChooser(options: "instance"): DevExpress.ui.dxPivotGridFieldChooser; - dxPivotGridFieldChooser(options: string): any; - dxPivotGridFieldChooser(options: string, ...params: any[]): any; - dxPivotGridFieldChooser(options: DevExpress.ui.dxPivotGridFieldChooserOptions): JQuery; - dxScheduler(): JQuery; - dxScheduler(options: "instance"): DevExpress.ui.dxScheduler; - dxScheduler(options: string): any; - dxScheduler(options: string, ...params: any[]): any; - dxScheduler(options: DevExpress.ui.dxSchedulerOptions): JQuery; -} -declare namespace DevExpress.framework { - /** An object used to store information on the views displayed in an application. */ - export class ViewCache { - viewRemoved: JQueryCallback; - /** Removes all the viewInfo objects from the cache. */ - clear(): void; - /** Obtains a viewInfo object from the cache by the specified key. */ - getView(key: string): Object; - /** Checks whether or not a viewInfo object is contained in the view cache under the specified key. */ - hasView(key: string): boolean; - /** Removes a viewInfo object from the cache by the specified key. */ - removeView(key: string): Object; - /** Adds the specified viewInfo object to the cache under the specified key. */ - setView(key: string, viewInfo: Object): void; - } - export interface dxCommandOptions extends DOMComponentOptions { - action?: any; - /** Specifies an action performed when the execute() method of the command is called. */ - onExecute?: any; - /** Indicates whether or not the widget that displays this command is disabled. */ - disabled?: boolean; - /** Specifies whether the current command should is rendered when a view is being rendered, or after a view has been shown. */ - renderStage?: string; - /** Specifies the name of the icon shown inside the widget associated with this command. */ - icon?: string; - iconSrc?: string; - /** The identifier of the command. */ - id?: string; - /** Specifies the title of the widget associated with this command. */ - title?: string; - /** Specifies the type of the button, if the command is rendered as a dxButton widget. */ - type?: string; - /** A Boolean value specifying whether or not the widget associated with this command is visible. */ - visible?: boolean; - } - /** A markup component used to define markup options for a command. */ - export class dxCommand extends DOMComponent { - constructor(element: JQuery, options: dxCommandOptions); - constructor(options: dxCommandOptions); - /** Executes the action associated with this command. */ - execute(): void; - } - /** An object responsible for routing. */ - export class Router { - /** Adds a routing rule to the list of registered rules. */ - register(pattern: string, defaults?: Object, constraints?: Object): void; - /** Decodes the specified URI to an object using the registered routing rules. */ - parse(uri: string): Object; - /** Formats an object to a URI. */ - format(obj: Object): string; - } - export interface StateManagerOptions { - /** A storage to which the state manager saves the application state. */ - storage?: Object; - } - /** An object used to store the current application state. */ - export class StateManager { - constructor(options?: StateManagerOptions); - /** Adds an object that implements an interface of a state source to the state manager's collection of state sources. */ - addStateSource(stateSource: Object): void; - /** Removes a specified state source from the state manager's collection of state sources. */ - removeStateSource(stateSource: Object): void; - /** Saves the current application state. */ - saveState(): void; - /** Restores the application state that has been saved by the saveState() method to the state storage. */ - restoreState(): void; - /** Removes the application state that has been saved by the saveState() method to the state storage. */ - clearState(): void; - } - export module html { - export var layoutSets: Array; - export var animationSets: { [animationSetName: string]: AnimationSet }; - export interface AnimationSet { - [animationName: string]: any - } - export interface HtmlApplicationOptions { - /** Specifies where the commands that are defined in the application's views must be displayed. */ - commandMapping?: Object; - /** Specifies whether or not view caching is disabled. */ - disableViewCache?: boolean; - /** An array of layout controllers that should be used to show application views in the current navigation context. */ - layoutSet?: any; - /** Specifies the animation presets that are used to animate different UI elements in the current application. */ - animationSet?: AnimationSet; - /** Specifies whether the current application must behave as a mobile or web application. */ - mode?: string; - /** Specifies the object that represents a root namespace of the application. */ - namespace?: Object; - /** Specifies application behavior when the user navigates to a root view. */ - navigateToRootViewMode?: string; - /** An array of dxCommand configuration objects used to define commands available from the application's global navigation. */ - navigation?: Array; - /** A state manager to be used in the application. */ - stateManager?: StateManager; - /** Specifies the storage to be used by the application's state manager to store the application state. */ - stateStorage?: Object; - /** Indicates whether on not to use the title of the previously displayed view as text on the Back button. */ - useViewTitleAsBackText?: boolean; - /** A custom view cache to be used in the application. */ - viewCache?: Object; - /** Specifies a limit for the views that can be cached. */ - viewCacheSize?: number; - /** Specifies options for the viewport meta tag of a mobile browser. */ - viewPort?: JQuery; - /** A custom router to be used in the application. */ - router?: Router; - } - /** An object used to manage views, as well as control the application life cycle. */ - export class HtmlApplication implements EventsMixin { - constructor(options: HtmlApplicationOptions); - afterViewSetup: JQueryCallback; - beforeViewSetup: JQueryCallback; - initialized: JQueryCallback; - navigating: JQueryCallback; - navigatingBack: JQueryCallback; - resolveLayoutController: JQueryCallback; - viewDisposed: JQueryCallback; - viewDisposing: JQueryCallback; - viewHidden: JQueryCallback; - viewRendered: JQueryCallback; - viewShowing: JQueryCallback; - viewShown: JQueryCallback; - /** Provides access to the ViewCache object. */ - viewCache: ViewCache; - /** An array of dxCommand components that are created based on the application's navigation option value. */ - navigation: Array; - /** Provides access to the StateManager object. */ - stateManager: StateManager; - /** Provides access to the Router object. */ - router: Router; - /** Navigates to the URI preceding the current one in the navigation history. */ - back(): void; - /** Returns a Boolean value indicating whether or not backwards navigation is currently possible. */ - canBack(): boolean; - /** Calls the clearState() method of the application's StateManager object. */ - clearState(): void; - /** Creates global navigation commands. */ - createNavigation(navigationConfig: Array): void; - /** Returns an HTML template of the specified view. */ - getViewTemplate(viewName: string): JQuery; - /** Returns a configuration object used to create a dxView component for a specified view. */ - getViewTemplateInfo(viewName: string): Object; - /** Adds a specified HTML template to a collection of view or layout templates. */ - loadTemplates(source: any): JQueryPromise; - /** Navigates to the specified URI. */ - navigate(uri?: any, options?: Object): void; - /** Renders navigation commands to the navigation command containers that are located in the layouts used in the application. */ - renderNavigation(): void; - /** Calls the restoreState() method of the application's StateManager object. */ - restoreState(): void; - /** Calls the saveState method of the application's StateManager object. */ - saveState(): void; - /** Provides access to the object that defines the current context to be considered when choosing an appropriate template for a view. */ - templateContext(): Object; - on(eventName: "initialized", eventHandler: () => void): HtmlApplication; - on(eventName: "afterViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "beforeViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "navigating", eventHandler: (e: { - currentUri: string; - uri: string; - cancel: boolean; - options: { - root: boolean; - target: string; - direction: string; - rootInDetailPane: boolean; - modal: boolean; - }; - }) => void): HtmlApplication; - on(eventName: "navigatingBack", eventHandler: (e: { - cancel: boolean; - isHardwareButton: boolean; - }) => void): HtmlApplication; - on(eventName: "resolveLayoutController", eventHandler: (e: { - viewInfo: Object; - layoutController: Object; - availableLayoutControllers: Array; - }) => void): HtmlApplication; - on(eventName: "viewDisposed", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewDisposing", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewHidden", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewRendered", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewShowing", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - on(eventName: "viewShown", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - on(eventName: string, eventHandler: Function): HtmlApplication; - on(events: { [eventName: string]: Function; }): HtmlApplication; - off(eventName: "initialized"): HtmlApplication; - off(eventName: "afterViewSetup"): HtmlApplication; - off(eventName: "beforeViewSetup"): HtmlApplication; - off(eventName: "navigating"): HtmlApplication; - off(eventName: "navigatingBack"): HtmlApplication; - off(eventName: "resolveLayoutController"): HtmlApplication; - off(eventName: "viewDisposed"): HtmlApplication; - off(eventName: "viewDisposing"): HtmlApplication; - off(eventName: "viewHidden"): HtmlApplication; - off(eventName: "viewRendered"): HtmlApplication; - off(eventName: "viewShowing"): HtmlApplication; - off(eventName: "viewShown"): HtmlApplication; - off(eventName: string): HtmlApplication; - off(eventName: "initialized", eventHandler: () => void): HtmlApplication; - off(eventName: "afterViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "beforeViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "navigating", eventHandler: (e: { - currentUri: string; - uri: string; - cancel: boolean; - options: { - root: boolean; - target: string; - direction: string; - rootInDetailPane: boolean; - modal: boolean; - }; - }) => void): HtmlApplication; - off(eventName: "navigatingBack", eventHandler: (e: { - cancel: boolean; - isHardwareButton: boolean; - }) => void): HtmlApplication; - off(eventName: "resolveLayoutController", eventHandler: (e: { - viewInfo: Object; - layoutController: Object; - availableLayoutControllers: Array; - }) => void): HtmlApplication; - off(eventName: "viewDisposed", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewDisposing", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewHidden", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewRendered", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewShowing", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - off(eventName: "viewShown", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - off(eventName: string, eventHandler: Function): HtmlApplication; - } - } -} -declare namespace DevExpress.viz.core { - /** - * Applies a theme for the entire page with several DevExtreme visualization widgets. - * @deprecated Use the DevExpress.viz.currentTheme(theme) method instead. - */ - export function currentTheme(theme: string): void; - /** - * Applies a new theme (with the color scheme defined separately) for the entire page with several DevExtreme visualization widgets. - * @deprecated Use the DevExpress.viz.currentTheme(platform, colorScheme) method instead. - */ - export function currentTheme(platform: string, colorScheme: string): void; - /** - * Registers a new theme based on the existing one. - * @deprecated Use the DevExpress.viz.registerTheme(customTheme, baseTheme) method instead. - */ - export function registerTheme(customTheme: Object, baseTheme: string): void; - /** - * Applies a predefined or registered custom palette to all visualization widgets at once. - * @deprecated Use the DevExpress.viz.currentPalette(paletteName) method instead. - */ - export function currentPalette(paletteName: string): void; - /** - * Obtains the color sets of a predefined or registered palette. - * @deprecated Use the DevExpress.viz.getPalette(paletteName) method instead. - */ - export function getPalette(paletteName: string): Object; - /** - * Registers a new palette. - * @deprecated Use the DevExpress.viz.registerPalette(paletteName, palette) method instead. - */ - export function registerPalette(paletteName: string, palette: Object): void; - export interface Border { - /** Sets a border color for a selected series. */ - color?: string; - /** Sets border visibility for a selected series. */ - visible?: boolean; - /** Sets a border width for a selected series. */ - width?: number; - } - export interface DashedBorder extends Border { - /** Specifies a dash style for the border of a selected series point. */ - dashStyle?: string; - } - export interface DashedBorderWithOpacity extends DashedBorder { - /** Specifies the opacity of the tooltip's border. */ - opacity?: number; - } - export interface Font { - /** Specifies the font color for a strip label. */ - color?: string; - /** Specifies the font family for a strip label. */ - family?: string; - /** Specifies the font opacity for a strip label. */ - opacity?: number; - /** Specifies the font size for a strip label. */ - size?: any; - /** Specifies the font weight for the text displayed in strips. */ - weight?: number; - } - export interface Hatching { - /** Specifies how to apply hatching to highlight a selected series. */ - direction?: string; - /** Specifies the opacity of hatching lines. */ - opacity?: number; - /** Specifies the distance between hatching lines in pixels. */ - step?: number; - /** Specifies the width of hatching lines in pixels. */ - width?: number; - } - export interface Margins { - /** Specifies the legend's bottom margin in pixels. */ - bottom?: number; - /** Specifies the legend's left margin in pixels. */ - left?: number; - /** Specifies the legend's right margin in pixels. */ - right?: number; - /** Specifies the legend's bottom margin in pixels. */ - top?: number; - } - export interface Size { - /** Specifies the width of the widget. */ - width?: number; - /** Specifies the height of the widget. */ - height?: number; - } - export interface Tooltip { - /** Specifies the length of the tooltip's arrow in pixels. */ - arrowLength?: number; - /** Specifies the appearance of the tooltip's border. */ - border?: viz.core.DashedBorderWithOpacity; - /** Specifies a color for the tooltip. */ - color?: string; - /** Specifies the z-index for tooltips. */ - zIndex?: number; - /** Specifies text and appearance of a set of tooltips. */ - customizeTooltip?: (arg: Object) => { color?: string; text?: string }; - /** Specifies whether or not the tooltip is enabled. */ - enabled?: boolean; - /** Specifies font options for the text displayed by the tooltip. */ - font?: Font; - /** Specifies a format for the text displayed by the tooltip. */ - format?: string; - /** Specifies the opacity of a tooltip. */ - opacity?: number; - /** Specifies a distance from the tooltip's left/right boundaries to the inner text in pixels. */ - paddingLeftRight?: number; - /** Specifies a distance from the tooltip's top/bottom boundaries to the inner text in pixels. */ - paddingTopBottom?: number; - /** Specifies a precision for formatted values displayed by the tooltip. */ - precision?: number; - /** Specifies options of the tooltip's shadow. */ - shadow?: { - /** Specifies the blur distance of the tooltip's shadow. */ - blur?: number; - /** Specifies the color of the tooltip's shadow. */ - color?: string; - /** Specifies the horizontal offset of the tooltip's shadow relative to the tooltip in pixels. */ - offsetX?: number; - /** Specifies the vertical offset of the tooltip's shadow relative to the tooltip in pixels. */ - offsetY?: number; - /** Specifies the opacity of the tooltip's shadow. */ - opacity?: number; - }; - } - export interface Animation { - /** Determines how long animation runs. */ - duration?: number; - /** Specifies the animation easing mode. */ - easing?: string; - /** Indicates whether or not animation is enabled. */ - enabled?: boolean; - } - export interface LoadingIndicator { - /** Specifies a color for the loading indicator background. */ - backgroundColor?: string; - /** Specifies font options for the loading indicator text. */ - font?: viz.core.Font; - /** Specifies whether to show the loading indicator or not. */ - show?: boolean; - /** Specifies a text to be displayed by the loading indicator. */ - text?: string; - } - export interface LegendBorder extends viz.core.DashedBorderWithOpacity { - /** Specifies a radius for the corners of the legend border. */ - cornerRadius?: number; - } - export interface BaseLegend { - /** Specifies the color of the legend's background. */ - backgroundColor?: string; - /** Specifies legend border settings. */ - border?: viz.core.LegendBorder; - /** Specifies how many columns must be taken to arrange legend items. */ - columnCount?: number; - /** Specifies the spacing between a pair of neighboring legend columns in pixels. */ - columnItemSpacing?: number; - /** Specifies font options for legend items. */ - font?: viz.core.Font; - /** Specifies the legend's position on the map. */ - horizontalAlignment?: string; - /** Specifies the alignment of legend items. */ - itemsAlignment?: string; - /** Specifies the position of text relative to the item marker. */ - itemTextPosition?: string; - /** Specifies the distance between the legend and the container borders in pixels. */ - margin?: viz.core.Margins; - /** Specifies the size of item markers in the legend in pixels. */ - markerSize?: number; - /** Specifies whether to arrange legend items horizontally or vertically. */ - orientation?: string; - /** Specifies the spacing between the legend left/right border and legend items in pixels. */ - paddingLeftRight?: number; - /** Specifies the spacing between the legend top/bottom border and legend items in pixels. */ - paddingTopBottom?: number; - /** Specifies how many rows must be taken to arrange legend items. */ - rowCount?: number; - /** Specifies the spacing between a pair of neighboring legend rows in pixels. */ - rowItemSpacing?: number; - /** Specifies the legend's position on the map. */ - verticalAlignment?: string; - /** Specifies whether or not the legend is visible on the map. */ - visible?: boolean; - } - export interface BaseWidgetOptions { - drawn?: (widget: Object) => void; - /** A handler for the drawn event. */ - onDrawn?: (e: { - component: BaseWidget; - element: Element; - }) => void; - incidentOccured?: (incidentInfo: { - id: string; - type: string; - args: any; - text: string; - widget: string; - version: string; - }) => void; - /** A handler for the incidentOccurred event. */ - onIncidentOccurred?: ( - component: BaseWidget, - element: Element, - target: { - id: string; - type: string; - args: any; - text: string; - widget: string; - version: string; - } - ) => void; - /** Notifies a widget that it is embedded into an HTML page that uses a path modifier. */ - pathModified?: boolean; - /** Specifies whether or not the widget supports right-to-left representation. */ - rtlEnabled?: boolean; - /** Sets the name of the theme to be used in the widget. */ - theme?: string; - } - /** This section describes options and methods that are common to all widgets. */ - export class BaseWidget extends DOMComponent { - /** Returns the widget's SVG markup. */ - svg(): string; - } -} -declare namespace DevExpress.viz.charts { - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface BaseSeries { - /** Provides information about the state of the series object. */ - fullState: number; - /** Returns the type of the series. */ - type: string; - /** Unselects all the selected points of the series. The points are displayed in an initial style. */ - clearSelection(): void; - /** Gets the color of a particular series. */ - getColor(): string; - /** - * Gets a point from the series point collection based on the specified argument. - * @deprecated getPointsByArg(pointArg).md - */ - getPointByArg(pointArg: any): Object; - /** Gets points from the series point collection based on the specified argument. */ - getPointsByArg(pointArg: any): Array; - /** Gets a point from the series point collection based on the specified point position. */ - getPointByPos(positionIndex: number): Object; - /** Selects the series. The series is displayed in a 'selected' style until another series is selected or the current series is deselected programmatically. */ - select(): void; - /** Selects the specified point. The point is displayed in a 'selected' style. */ - selectPoint(point: BasePoint): void; - /** Deselects the specified point. The point is displayed in an initial style. */ - deselectPoint(point: BasePoint): void; - /** Returns an array of all points in the series. */ - getAllPoints(): Array; - /** Returns visible series points. */ - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface BasePoint { - /** Provides information about the state of the point object. */ - fullState: number; - /** Returns the point's argument value that was set in the data source. */ - originalArgument: any; - /** Returns the point's value that was set in the data source. */ - originalValue: any; - /** Returns the tag of the point. */ - tag: string; - /** Deselects the point. */ - clearSelection(): void; - /** Gets the color of a particular point. */ - getColor(): string; - /** Hides the tooltip of the point. */ - hideTooltip(): void; - /** Provides information about the hover state of a point. */ - isHovered(): any; - /** Provides information about the selection state of a point. */ - isSelected(): any; - /** Selects the point. The point is displayed in a 'selected' style until another point is selected or the current point is deselected programmatically. */ - select(): void; - /** Shows the tooltip of the point. */ - showTooltip(): void; - /** Allows you to obtain the label of a series point. */ - getLabel(): any; - /** Returns the series object to which the point belongs. */ - series: BaseSeries; - } - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface ChartSeries extends BaseSeries { - /** Returns the name of the series pane. */ - pane: string; - /** Returns the name of the value axis of the series. */ - axis: string; - /** Returns the name of the series. */ - name: string; - /** Returns the tag of the series. */ - tag: string; - /** Hides a series. */ - hide(): void; - /** Provides information about the hover state of a series. */ - isHovered(): any; - /** Provides information about the selection state of a series. */ - isSelected(): any; - /** Provides information about the visibility state of a series. */ - isVisible(): boolean; - /** Makes a particular series visible. */ - show(): void; - selectPoint(point: ChartPoint): void; - deselectPoint(point: ChartPoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface ChartPoint extends BasePoint { - /** Contains the close value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalCloseValue: any; - /** Contains the high value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalHighValue: any; - /** Contains the low value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalLowValue: any; - /** Contains the first value of the point. This field is useful for points belonging to a series of the range area or range bar type only. */ - originalMinValue: any; - /** Contains the open value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalOpenValue: any; - /** Contains the size of the bubble as it was set in the data source. This field is useful for points belonging to a series of the bubble type only. */ - size: any; - /** Gets the parameters of the point's minimum bounding rectangle (MBR). */ - getBoundingRect(): { x: number; y: number; width: number; height: number; }; - series: ChartSeries; - } - /** This section describes the methods that can be used in code to manipulate the Label object. */ - export interface Label { - /** Gets the parameters of the label's minimum bounding rectangle (MBR). */ - getBoundingRect(): { x: number; y: number; width: number; height: number; }; - /** Hides the point label. */ - hide(): void; - /** Shows the point label. */ - show(): void; - } - export interface PieSeries extends BaseSeries { - selectPoint(point: PiePoint): void; - deselectPoint(point: PiePoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface PiePoint extends BasePoint { - /** Gets the percentage value of the specific point. */ - percent: any; - /** Provides information about the visibility state of a point. */ - isVisible(): boolean; - /** Makes a specific point visible. */ - show(): void; - /** Hides a specific point. */ - hide(): void; - series: PieSeries; - } - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface PolarSeries extends BaseSeries { - /** Returns the name of the value axis of the series. */ - axis: string; - /** Returns the name of the series. */ - name: string; - /** Returns the tag of the series. */ - tag: string; - /** Hides a series. */ - hide(): void; - /** Provides information about the hover state of a series. */ - isHovered(): any; - /** Provides information about the selection state of a series. */ - isSelected(): any; - /** Provides information about the visibility state of a series. */ - isVisible(): boolean; - /** Makes a particular series visible. */ - show(): void; - selectPoint(point: PolarPoint): void; - deselectPoint(point: PolarPoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface PolarPoint extends BasePoint { - series: PolarSeries; - } - export interface Strip { - /** Specifies a color for a strip. */ - color?: string; - /** An object that defines the label configuration options of a strip. */ - label?: { - /** Specifies the text displayed in a strip. */ - text?: string; - }; - /** Specifies a start value for a strip. */ - startValue?: any; - /** Specifies an end value for a strip. */ - endValue?: any; - } - export interface BaseSeriesConfigLabel { - /** Specifies a format for arguments displayed by point labels. */ - argumentFormat?: string; - /** Specifies a precision for formatted point arguments displayed in point labels. */ - argumentPrecision?: number; - /** Specifies a background color for point labels. */ - backgroundColor?: string; - /** Specifies border options for point labels. */ - border?: viz.core.DashedBorder; - /** Specifies connector options for series point labels. */ - connector?: { - /** Specifies the color of label connectors. */ - color?: string; - /** Indicates whether or not label connectors are visible. */ - visible?: boolean; - /** Specifies the width of label connectors. */ - width?: number; - }; - /** Specifies a callback function that returns the text to be displayed by point labels. */ - customizeText?: (pointInfo: Object) => string; - /** Specifies font options for the text displayed in point labels. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed by point labels. */ - format?: string; - position?: string; - /** Specifies a precision for formatted point values displayed in point labels. */ - precision?: number; - /** Specifies the angle used to rotate point labels from their initial position. */ - rotationAngle?: number; - /** Specifies the visibility of point labels. */ - visible?: boolean; - } - export interface SeriesConfigLabel extends BaseSeriesConfigLabel { - /** Specifies whether or not to show a label when the point has a zero value. */ - showForZeroValues?: boolean; - } - export interface ChartSeriesConfigLabel extends SeriesConfigLabel { - /** Specifies how to align point labels relative to the corresponding data points that they represent. */ - alignment?: string; - /** Specifies how to shift point labels horizontally from their initial positions. */ - horizontalOffset?: number; - /** Specifies how to shift point labels vertically from their initial positions. */ - verticalOffset?: number; - /** Specifies a precision for the percentage values displayed in the labels of a full-stacked-like series. */ - percentPrecision?: number; - } - export interface BaseCommonSeriesConfig { - /** Specifies the data source field that provides arguments for series points. */ - argumentField?: string; - axis?: string; - /** An object defining the label configuration options for a series in the dxChart widget. */ - label?: ChartSeriesConfigLabel; - /** Specifies border options for point labels. */ - border?: viz.core.DashedBorder; - /** Specifies a series color. */ - color?: string; - /** Specifies the dash style of the series' line. */ - dashStyle?: string; - hoverMode?: string; - /** An object defining configuration options for a hovered series. */ - hoverStyle?: { - /** An object defining the border options for a hovered series. */ - border?: viz.core.DashedBorder; - /**

Sets a color for a series when it is hovered over.

*/ - color?: string; - /** Specifies the dash style for the line in a hovered series. */ - dashStyle?: string; - /** Specifies the hatching options to be applied when a series is hovered over. */ - hatching?: viz.core.Hatching; - /** Specifies the width of a line in a hovered series. */ - width?: number; - }; - /** Specifies whether a chart ignores null data points or not. */ - ignoreEmptyPoints?: boolean; - /** Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed. */ - maxLabelCount?: number; - /** Specifies the minimal length of a displayed bar in pixels. */ - minBarSize?: number; - /** Specifies opacity for a series. */ - opacity?: number; - /** Specifies the series elements to highlight when the series is selected. */ - selectionMode?: string; - /** An object defining configuration options for a selected series. */ - selectionStyle?: { - /** An object defining the border options for a selected series. */ - border?: viz.core.DashedBorder; - /** Sets a color for a series when it is selected. */ - color?: string; - /** Specifies the dash style for the line in a selected series. */ - dashStyle?: string; - /** Specifies the hatching options to be applied when a series is selected. */ - hatching?: viz.core.Hatching; - /** Specifies the width of a line in a selected series. */ - width?: number; - }; - /** Specifies whether or not to show the series in the chart's legend. */ - showInLegend?: boolean; - /** Specifies the name of the stack where the values of the _stackedBar_ series must be located. */ - stack?: string; - /** Specifies the name of the data source field that provides data about a point. */ - tagField?: string; - /** Specifies the data source field that provides values for series points. */ - valueField?: string; - /** Specifies the visibility of a series. */ - visible?: boolean; - /** Specifies a line width. */ - width?: number; - /** Configures error bars. */ - valueErrorBar?: { - /** Specifies whether error bars must be displayed in full or partially. */ - displayMode?: string; - /** Specifies the data field that provides data for low error values. */ - lowValueField?: string; - /** Specifies the data field that provides data for high error values. */ - highValueField?: string; - /** Specifies how error bar values must be calculated. */ - type?: string; - /** Specifies the value to be used for generating error bars. */ - value?: number; - /** Specifies the color of error bars. */ - color?: string; - /** Specifies the opacity of error bars. */ - opacity?: number; - /** Specifies the length of the lines that indicate the error bar edges. */ - edgeLength?: number; - /** Specifies the width of the error bar line. */ - lineWidth?: number; - }; - } - export interface CommonPointOptions { - /** Specifies border options for points in the line and area series. */ - border?: viz.core.Border; - /** Specifies the points color. */ - color?: string; - /** Specifies what series points to highlight when a point is hovered over. */ - hoverMode?: string; - /** An object defining configuration options for a hovered point. */ - hoverStyle?: { - /** An object defining the border options for a hovered point. */ - border?: viz.core.Border; - /** Sets a color for a point when it is hovered over. */ - color?: string; - /** Specifies the diameter of a hovered point in the series that represents data points as symbols (not as bars for instance). */ - size?: number; - }; - /** Specifies what series points to highlight when a point is selected. */ - selectionMode?: string; - /** An object defining configuration options for a selected point. */ - selectionStyle?: { - /** An object defining the border options for a selected point. */ - border?: viz.core.Border; - /**

Sets a color for a point when it is selected.

*/ - color?: string; - /** Specifies the diameter of a selected point in the series that represents data points as symbols (not as bars for instance). */ - size?: number; - }; - /** Specifies the point diameter in pixels for those series that represent data points as symbols (not as bars for instance). */ - size?: number; - /** Specifies a symbol for presenting points of the line and area series. */ - symbol?: string; - visible?: boolean; - } - export interface ChartCommonPointOptions extends CommonPointOptions { - /** An object specifying the parameters of an image that is used as a point marker. */ - image?: { - /** Specifies the height of an image that is used as a point marker. */ - height?: any; - /** Specifies a URL leading to the image to be used as a point marker. */ - url?: any; - /** Specifies the width of an image that is used as a point marker. */ - width?: any; - }; - } - export interface PolarCommonPointOptions extends CommonPointOptions { - /** An object specifying the parameters of an image that is used as a point marker. */ - image?: { - /** Specifies the height of an image that is used as a point marker. */ - height?: number; - /** Specifies a URL leading to the image to be used as a point marker. */ - url?: string; - /** Specifies the width of an image that is used as a point marker. */ - width?: number; - }; - } - /** An object that defines configuration options for chart series. */ - export interface CommonSeriesConfig extends BaseCommonSeriesConfig { - /** Specifies the data source field that provides a 'close' value for a _candleStick_ or _stock_ series. */ - closeValueField?: string; - /** Specifies a radius for bar corners. */ - cornerRadius?: number; - /** Specifies the data source field that provides a 'high' value for a _candleStick_ or _stock_ series. */ - highValueField?: string; - /** Specifies the color for the body (rectangle) of a _candleStick_ series. */ - innerColor?: string; - /** Specifies the data source field that provides a 'low' value for a _candleStick_ or _stock_ series. */ - lowValueField?: string; - /** Specifies the data source field that provides an 'open' value for a _candleStick_ or _stock_ series. */ - openValueField?: string; - /** Specifies the pane that will be used to display a series. */ - pane?: string; - /** An object defining configuration options for points in line-, scatter- and area-like series. */ - point?: ChartCommonPointOptions; - /** Specifies the data source field that provides values for one end of a range series. To set the data source field for the other end of the range series, use the rangeValue2Field property. */ - rangeValue1Field?: string; - /** Specifies the data source field that provides values for the second end of a range series. To set the data source field for the other end of the range series, use the rangeValue1Field property. */ - rangeValue2Field?: string; - /** Specifies reduction options for the stock or candleStick series. */ - reduction?: { - /** Specifies a color for the points whose reduction level price is lower in comparison to the value in the previous point. */ - color?: string; - /** Specifies for which price level (open, high, low or close) to enable reduction options in the series. */ - level?: string; - }; - /** Specifies the data source field that defines the size of bubbles. */ - sizeField?: string; - } - export interface CommonSeriesSettings extends CommonSeriesConfig { - /**

An object that specifies configuration options for all series of the area type in the chart.

*/ - area?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _bar_ type in the chart. */ - bar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the bubble type in the chart. */ - bubble?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _candleStick_ type in the chart. */ - candlestick?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _fullStackedArea_ type in the chart. */ - fullstackedarea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Full-Stacked Spline Area type in the chart. */ - fullstackedsplinearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _fullStackedBar_ type in the chart. */ - fullstackedbar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _fullStackedLine_ type in the chart. */ - fullstackedline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Full-Stacked Spline type in the chart. */ - fullstackedspline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _line_ type in the chart. */ - line?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _rangeArea_ type in the chart. */ - rangearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _rangeBar_ type in the chart. */ - rangebar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _scatter_ type in the chart. */ - scatter?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _spline_ type in the chart. */ - spline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _splineArea_ type in the chart. */ - splinearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedArea_ type in the chart. */ - stackedarea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Stacked Spline Area type in the chart. */ - stackedsplinearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedBar_ type in the chart. */ - stackedbar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedLine_ type in the chart. */ - stackedline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Stacked Spline type in the chart. */ - stackedspline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stepArea_ type in the chart. */ - steparea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stepLine_ type in the chart. */ - stepline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stock_ type in the chart. */ - stock?: CommonSeriesConfig; - /** Sets a series type. */ - type?: string; - } - export interface SeriesConfig extends CommonSeriesConfig { - /** Specifies the name that identifies the series. */ - name?: string; - /** Specifies data about a series. */ - tag?: any; - /** Sets the series type. */ - type?: string; - } - /** An object that defines configuration options for polar chart series. */ - export interface CommonPolarSeriesConfig extends BaseCommonSeriesConfig { - /** Specifies whether or not to close the chart by joining the end point with the first point. */ - closed?: boolean; - label?: SeriesConfigLabel; - point?: PolarCommonPointOptions; - } - export interface CommonPolarSeriesSettings extends CommonPolarSeriesConfig { - /** An object that specifies configuration options for all series of the area type in the chart. */ - area?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _bar_ type in the chart. */ - bar?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _line_ type in the chart. */ - line?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _scatter_ type in the chart. */ - scatter?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedBar_ type in the chart. */ - stackedbar?: CommonPolarSeriesConfig; - /** Sets a series type. */ - type?: string; - } - export interface PolarSeriesConfig extends CommonPolarSeriesConfig { - /** Specifies the name that identifies the series. */ - name?: string; - /** Specifies data about a series. */ - tag?: any; - /** Sets the series type. */ - type?: string; - } - export interface PieSeriesConfigLabel extends BaseSeriesConfigLabel { - /** Specifies how to shift labels from their initial position in a radial direction in pixels. */ - radialOffset?: number; - /** Specifies a precision for the percentage values displayed in labels. */ - percentPrecision?: number; - } - /** An object that defines configuration options for chart series. */ - export interface CommonPieSeriesConfig { - /** Specifies the data source field that provides arguments for series points. */ - argumentField?: string; - /** Specifies the required type for series arguments. */ - argumentType?: string; - /** An object defining the series border configuration options. */ - border?: viz.core.DashedBorder; - /** Specifies a series color. */ - color?: string; - /** Specifies the chart elements to highlight when a series is hovered over. */ - hoverMode?: string; - /** An object defining configuration options for a hovered series. */ - hoverStyle?: { - /** An object defining the border options for a hovered series. */ - border?: viz.core.DashedBorder; - /** Sets a color for the series when it is hovered over. */ - color?: string; - /** Specifies the hatching options to be applied when a point is hovered over. */ - hatching?: viz.core.Hatching; - }; - /** Specifies the fraction of the inner radius relative to the total radius in the series of the 'doughnut' type. */ - innerRadius?: number; - /** An object defining the label configuration options. */ - label?: PieSeriesConfigLabel; - /** Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed. */ - maxLabelCount?: number; - /** Specifies a minimal size of a displayed pie segment. */ - minSegmentSize?: number; - /** Specifies the direction in which the dxPieChart's series points are located. */ - segmentsDirection?: string; - /**

Specifies the chart elements to highlight when the series is selected.

*/ - selectionMode?: string; - /** An object defining configuration options for the series when it is selected. */ - selectionStyle?: { - /** An object defining the border options for a selected series. */ - border?: viz.core.DashedBorder; - /** Sets a color for a series when it is selected. */ - color?: string; - /** Specifies the hatching options to be applied when a point is selected. */ - hatching?: viz.core.Hatching; - }; - /** Specifies chart segment grouping options. */ - smallValuesGrouping?: { - /** Specifies the name of the grouped chart segment. This name represents the segment in the chart legend. */ - groupName?: string; - /** Specifies the segment grouping mode. */ - mode?: string; - /** Specifies a threshold for segment values. */ - threshold?: number; - /** Specifies how many segments must not be grouped. */ - topCount?: number; - }; - /** Specifies a start angle for a pie chart in arc degrees. */ - startAngle?: number; - /**

Specifies the name of the data source field that provides data about a point.

*/ - tagField?: string; - /** Specifies the data source field that provides values for series points. */ - valueField?: string; - } - export interface PieSeriesConfig extends CommonPieSeriesConfig { - /** Sets the series type. */ - type?: string; - } - export interface SeriesTemplate { - /** Specifies a callback function that returns a series object with individual series settings. */ - customizeSeries?: (seriesName: string) => SeriesConfig; - /** Specifies a data source field that represents the series name. */ - nameField?: string; - } - export interface PolarSeriesTemplate { - /** Specifies a callback function that returns a series object with individual series settings. */ - customizeSeries?: (seriesName: string) => PolarSeriesConfig; - /** Specifies a data source field that represents the series name. */ - nameField?: string; - } - export interface ChartCommonConstantLineLabel { - /** Specifies font options for a constant line label. */ - font?: viz.core.Font; - /** Specifies the position of the constant line label relative to the chart plot. */ - position?: string; - /** Indicates whether or not to display labels for the axis constant lines. */ - visible?: boolean; - } - export interface PolarCommonConstantLineLabel { - /** Indicates whether or not to display labels for the axis constant lines. */ - visible?: boolean; - /** Specifies font options for a constant line label. */ - font?: viz.core.Font; - } - export interface ConstantLineStyle { - /** Specifies a color for a constant line. */ - color?: string; - /** Specifies a dash style for a constant line. */ - dashStyle?: string; - /** Specifies a constant line width in pixels. */ - width?: number; - } - export interface ChartCommonConstantLineStyle extends ConstantLineStyle { - /** An object defining constant line label options. */ - label?: ChartCommonConstantLineLabel; - /** Specifies the space between the constant line label and the left/right side of the constant line. */ - paddingLeftRight?: number; - /** Specifies the space between the constant line label and the top/bottom side of the constant line. */ - paddingTopBottom?: number; - } - export interface PolarCommonConstantLineStyle extends ConstantLineStyle { - /** An object defining constant line label options. */ - label?: PolarCommonConstantLineLabel; - } - export interface CommonAxisLabel { - /** Specifies font options for axis labels. */ - font?: viz.core.Font; - /** Specifies the spacing between an axis and its labels in pixels. */ - indentFromAxis?: number; - /** Indicates whether or not axis labels are visible. */ - visible?: boolean; - } - export interface ChartCommonAxisLabel extends CommonAxisLabel { - /** Specifies the label's position relative to the tick (grid line). */ - alignment?: string; - /** Specifies the overlap resolving algorithm to be applied to axis labels. */ - overlappingBehavior?: { - /** Specifies how to arrange axis labels. */ - mode?: string; - /** Specifies the angle used to rotate axis labels. */ - rotationAngle?: number; - /** Specifies the spacing that must be set between staggered rows when the 'stagger' algorithm is applied. */ - staggeringSpacing?: number; - }; - } - export interface PolarCommonAxisLabel extends CommonAxisLabel { - /** Specifies the overlap resolving algorithm to be applied to axis labels. */ - overlappingBehavior?: string; - } - export interface CommonAxisTitle { - /** Specifies font options for an axis title. */ - font?: viz.core.Font; - /** Specifies a margin for an axis title in pixels. */ - margin?: number; - } - export interface BaseCommonAxisSettings { - /** Specifies the color of the line that represents an axis. */ - color?: string; - /** Specifies whether ticks/grid lines of a discrete axis are located between labels or cross the labels. */ - discreteAxisDivisionMode?: string; - /** An object defining the configuration options for the grid lines of an axis in the dxPolarChart widget. */ - grid?: { - /** Specifies a color for grid lines. */ - color?: string; - /** Specifies an opacity for grid lines. */ - opacity?: number; - /** Indicates whether or not the grid lines of an axis are visible. */ - visible?: boolean; - /** Specifies the width of grid lines. */ - width?: number; - }; - /** Specifies the options of the minor grid. */ - minorGrid?: { - /** Specifies a color for the lines of the minor grid. */ - color?: string; - /** Specifies an opacity for the lines of the minor grid. */ - opacity?: number; - /** Indicates whether the minor grid is visible or not. */ - visible?: boolean; - /** Specifies a width for the lines of the minor grid. */ - width?: number; - }; - /** Indicates whether or not an axis is inverted. */ - inverted?: boolean; - /** Specifies the opacity of the line that represents an axis. */ - opacity?: number; - /** Indicates whether or not to set ticks/grid lines of a continuous axis of the 'date-time' type at the beginning of each date-time interval. */ - setTicksAtUnitBeginning?: boolean; - /** An object defining the configuration options for axis ticks. */ - tick?: { - /** Specifies ticks color. */ - color?: string; - /** Specifies tick opacity. */ - opacity?: number; - /** Indicates whether or not ticks are visible on an axis. */ - visible?: boolean; - }; - /** Specifies the options of the minor ticks. */ - minorTick?: { - /** Specifies a color for the minor ticks. */ - color?: string; - /** Specifies an opacity for the minor ticks. */ - opacity?: number; - /** Indicates whether or not the minor ticks are displayed on an axis. */ - visible?: boolean; - }; - /** Indicates whether or not the line that represents an axis in a chart is visible. */ - visible?: boolean; - /** Specifies the width of the line that represents an axis in the chart. */ - width?: number; - } - export interface ChartCommonAxisSettings extends BaseCommonAxisSettings { - /** Specifies the appearance of all the widget's constant lines. */ - constantLineStyle?: ChartCommonConstantLineStyle; - /** An object defining the label configuration options that are common for all axes in the dxChart widget. */ - label?: ChartCommonAxisLabel; - /** Specifies a coefficient that determines the spacing between the maximum series point and the axis. */ - maxValueMargin?: number; - /** Specifies a coefficient that determines the spacing between the minimum series point and the axis. */ - minValueMargin?: number; - /** Specifies, in pixels, the space reserved for an axis. */ - placeholderSize?: number; - /** An object defining configuration options for strip style. */ - stripStyle?: { - /** An object defining the configuration options for a strip label style. */ - label?: { - /** Specifies font options for a strip label. */ - font?: viz.core.Font; - /** Specifies the label's position on a strip. */ - horizontalAlignment?: string; - /** Specifies a label's position on a strip. */ - verticalAlignment?: string; - }; - /** Specifies the spacing, in pixels, between the left/right strip border and the strip label. */ - paddingLeftRight?: number; - /** Specifies the spacing, in pixels, between the top/bottom strip borders and the strip label. */ - paddingTopBottom?: number; - }; - /** An object defining the title configuration options that are common for all axes in the dxChart widget. */ - title?: CommonAxisTitle; - /** Indicates whether or not to display series with indents from axis boundaries. */ - valueMarginsEnabled?: boolean; - } - export interface PolarCommonAxisSettings extends BaseCommonAxisSettings { - /** Specifies the appearance of all the widget's constant lines. */ - constantLineStyle?: PolarCommonConstantLineStyle; - /** An object defining the label configuration options that are common for all axes in the dxPolarChart widget. */ - label?: PolarCommonAxisLabel; - /** An object defining configuration options for strip style. */ - stripStyle?: { - /** An object defining the configuration options for a strip label style. */ - label?: { - /** Specifies font options for a strip label. */ - font?: viz.core.Font; - }; - }; - } - export interface ChartConstantLineLabel extends ChartCommonConstantLineLabel { - /** Specifies the horizontal alignment of a constant line label. */ - horizontalAlignment?: string; - /** Specifies the vertical alignment of a constant line label. */ - verticalAlignment?: string; - /** Specifies the text to be displayed in a constant line label. */ - text?: string; - } - export interface PolarConstantLineLabel extends PolarCommonConstantLineLabel { - /** Specifies the text to be displayed in a constant line label. */ - text?: string; - } - export interface AxisLabel { - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a label on the value axis. */ - customizeHint?: (argument: { value: any; valueText: string }) => string; - /** Specifies a callback function that returns the text to be displayed in value axis labels. */ - customizeText?: (argument: { value: any; valueText: string }) => string; - /** Specifies a format for the text displayed by axis labels. */ - format?: string; - /** Specifies a precision for the formatted value displayed in the axis labels. */ - precision?: number; - } - export interface ChartAxisLabel extends ChartCommonAxisLabel, AxisLabel { } - export interface PolarAxisLabel extends PolarCommonAxisLabel, AxisLabel { } - export interface AxisTitle extends CommonAxisTitle { - /** Specifies the text for the value axis title. */ - text?: string; - } - export interface ChartConstantLineStyle extends ChartCommonConstantLineStyle { - /** An object defining constant line label options. */ - label?: ChartConstantLineLabel; - } - export interface ChartConstantLine extends ChartConstantLineStyle { - /** An object defining constant line label options. */ - label?: ChartConstantLineLabel; - /** Specifies a value to be displayed by a constant line. */ - value?: any; - } - export interface PolarConstantLine extends PolarCommonConstantLineStyle { - /** An object defining constant line label options. */ - label?: PolarConstantLineLabel; - /** Specifies a value to be displayed by a constant line. */ - value?: any; - } - export interface Axis { - /** Specifies a coefficient for dividing the value axis. */ - axisDivisionFactor?: number; - /** Specifies the order in which discrete values are arranged on the value axis. */ - categories?: Array; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic axis. */ - logarithmBase?: number; - /** Specifies an interval between axis ticks/grid lines. */ - tickInterval?: any; - /** Specifies the interval between minor ticks. */ - minorTickInterval?: any; - /** Specifies the number of minor ticks between two neighboring major ticks. */ - minorTickCount?: number; - /** Specifies the required type of the value axis. */ - type?: string; - /** Specifies the pane on which the current value axis will be displayed. */ - pane?: string; - /** Specifies options for value axis strips. */ - strips?: Array; - } - export interface ChartAxis extends ChartCommonAxisSettings, Axis { - /** Defines an array of the value axis constant lines. */ - constantLines?: Array; - /** Specifies the appearance options for the constant lines of the value axis. */ - constantLineStyle?: ChartCommonConstantLineStyle; - /** Specifies options for value axis labels. */ - label?: ChartAxisLabel; - /** Specifies the maximum value on the value axis. */ - max?: any; - /** Specifies the minimum value on the value axis. */ - min?: any; - /** Specifies the position of the value axis on a chart. */ - position?: string; - /** Specifies the title for a value axis. */ - title?: AxisTitle; - } - export interface PolarAxis extends PolarCommonAxisSettings, Axis { - /** Defines an array of the value axis constant lines. */ - constantLines?: Array; - /** Specifies options for value axis labels. */ - label?: PolarAxisLabel; - } - export interface ArgumentAxis { - /** Specifies the desired type of axis values. */ - argumentType?: string; - /** Specifies the elements that will be highlighted when the argument axis is hovered over. */ - hoverMode?: string; - } - export interface ChartArgumentAxis extends ChartAxis, ArgumentAxis { } - export interface PolarArgumentAxis extends PolarAxis, ArgumentAxis { - /** Specifies a start angle for the argument axis in degrees. */ - startAngle?: number; - /** Specifies whether or not to display the first point at the angle specified by the startAngle option. */ - firstPointOnStartAngle?: boolean; - /** Specifies the period of the argument values in the data source. */ - period?: number; - } - export interface ValueAxis { - /** Specifies the name of the value axis. */ - name?: string; - /** Specifies whether or not to indicate a zero value on the value axis. */ - showZero?: boolean; - /** Specifies the desired type of axis values. */ - valueType?: string; - } - export interface ChartValueAxis extends ChartAxis, ValueAxis { - /** Specifies the spacing, in pixels, between multiple value axes in a chart. */ - multipleAxesSpacing?: number; - /** Specifies the value by which the chart's value axes are synchronized. */ - synchronizedValue?: number; - } - export interface PolarValueAxis extends PolarAxis, ValueAxis { - /** Indicates whether to display series with indents from axis boundaries. */ - valueMarginsEnabled?: boolean; - /** Specifies a coefficient that determines the spacing between the maximum series point and the axis. */ - maxValueMargin?: number; - /** Specifies a coefficient that determines the spacing between the minimum series point and the axis. */ - minValueMargin?: number; - tick?: { - visible?: boolean; - } - } - export interface CommonPane { - /** Specifies a background color in a pane. */ - backgroundColor?: string; - /** Specifies the border options of a chart's pane. */ - border?: PaneBorder; - } - export interface Pane extends CommonPane { - /** Specifies the name of a pane. */ - name?: string; - } - export interface PaneBorder extends viz.core.DashedBorderWithOpacity { - /** Specifies the bottom border's visibility state in a pane. */ - bottom?: boolean; - /** Specifies the left border's visibility state in a pane. */ - left?: boolean; - /** Specifies the right border's visibility state in a pane. */ - right?: boolean; - /** Specifies the top border's visibility state in a pane. */ - top?: boolean; - } - export interface ChartAnimation extends viz.core.Animation { - /** Specifies the maximum series point count in the chart that the animation supports. */ - maxPointCountSupported?: number; - } - export interface BaseChartTooltip extends viz.core.Tooltip { - /** Specifies a format for arguments of the chart's series points. */ - argumentFormat?: string; - /** Specifies a precision for formatted arguments displayed in tooltips. */ - argumentPrecision?: number; - /** Specifies a precision for a percent value displayed in tooltips for stacked series and dxPieChart series. */ - percentPrecision?: number; - } - export interface BaseChartOptions extends viz.core.BaseWidgetOptions { - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - /** Specifies the width of the widget container that is small enough for the layout to begin adapting. */ - width?: number; - /** Specifies the height of the widget container that is small enough for the layout to begin adapting. */ - height?: number; - /** Specifies whether or not point labels can be hidden when the layout is adapting. */ - keepLabels?: boolean; - }; - /** Specifies animation options. */ - animation?: ChartAnimation; - /** Specifies a callback function that returns an object with options for a specific point label. */ - customizeLabel?: (labelInfo: Object) => Object; - /** Specifies a callback function that returns an object with options for a specific point. */ - customizePoint?: (pointInfo: Object) => Object; - /** Specifies a data source for the chart. */ - dataSource?: any; - done?: Function; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies options of a dxChart's (dxPieChart's) legend. */ - legend?: core.BaseLegend; - /** Specifies the blank space between the chart's extreme elements and the boundaries of the area provided for the widget (see size) in pixels. */ - margin?: viz.core.Margins; - /** Sets the name of the palette to be used in the chart. Alternatively, an array of colors can be set as a custom palette to be used within this chart. */ - palette?: any; - /** A handler for the done event. */ - onDone?: (e: { - component: BaseChart; - element: Element; - }) => void; - /** A handler for the pointClick event. */ - onPointClick?: any; - pointClick?: any; - /** A handler for the pointHoverChanged event. */ - onPointHoverChanged?: (e: { - component: BaseChart; - element: Element; - target: TPoint; - }) => void; - pointHoverChanged?: (point: TPoint) => void; - /** A handler for the pointSelectionChanged event. */ - onPointSelectionChanged?: (e: { - component: BaseChart; - element: Element; - target: TPoint; - }) => void; - pointSelectionChanged?: (point: TPoint) => void; - /** Specifies whether a single point or multiple points can be selected in the chart. */ - pointSelectionMode?: string; - /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */ - redrawOnResize?: boolean; - /** Specifies options for the dxChart and dxPieChart widget series. */ - series?: any; - /** Specifies the size of the widget in pixels. */ - size?: viz.core.Size; - /** Specifies a title for the chart. */ - title?: { - /** Specifies font options for the title. */ - font?: viz.core.Font; - /** Specifies the title's horizontal position in the chart. */ - horizontalAlignment?: string; - /** Specifies a title's position on the chart in the vertical direction. */ - verticalAlignment?: string; - /** Specifies the distance between the title and surrounding chart elements in pixels. */ - margin?: viz.core.Margins; - /** Specifies the height of the space reserved for the title. */ - placeholderSize?: number; - /** Specifies a text for the chart's title. */ - text?: string; - }; - /** Specifies tooltip options. */ - tooltip?: BaseChartTooltip; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: BaseChart; - element: Element; - target: BasePoint; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: BaseChart; - element: Element; - target: BasePoint; - }) => void; - tooltipHidden?: (point: TPoint) => void; - tooltipShown?: (point: TPoint) => void; - } - /** A base class for all chart widgets included in the ChartJS library. */ - export class BaseChart extends viz.core.BaseWidget { - /** Deselects the chart's selected series. The series is displayed in an initial style. */ - clearSelection(): void; - /** Gets the current size of the widget. */ - getSize(): { width: number; height: number }; - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Hides all widget tooltips. */ - hideTooltip(): void; - /** Redraws a widget. */ - render(renderOptions?: { - force?: boolean; - animate?: boolean; - asyncSeriesRendering?: boolean; - }): void; - } - export interface AdvancedLegend extends core.BaseLegend { - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item. */ - customizeHint?: (seriesInfo: { seriesName: string; seriesIndex: number; seriesColor: string; }) => string; - /**

Specifies a callback function that returns the text to be displayed by legend items.

*/ - customizeText?: (seriesInfo: { seriesName: string; seriesIndex: number; seriesColor: string; }) => string; - /** Specifies what series elements to highlight when a corresponding item in the legend is hovered over. */ - hoverMode?: string; - } - export interface AdvancedOptions extends BaseChartOptions { - /** A handler for the argumentAxisClick event. */ - onArgumentAxisClick?: any; - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** An object providing options for managing data from a data source. */ - dataPrepareSettings?: { - /** Specifies whether or not to validate the values from a data source. */ - checkTypeForAllData?: boolean; - /** Specifies whether or not to convert the values from a data source into the data type of an axis. */ - convertToAxisDataType?: boolean; - /** Specifies how to sort the series points. */ - sortingMethod?: any; - }; - /** A handler for the legendClick event. */ - onLegendClick?: any; - /** A handler for the seriesClick event. */ - onSeriesClick?: any; - /** A handler for the seriesHoverChanged event. */ - onSeriesHoverChanged?: (e: { - component: BaseChart; - element: Element; - target: TSeries; - }) => void; - /** A handler for the seriesSelectionChanged event. */ - onSeriesSelectionChanged?: (e: { - component: BaseChart; - element: Element; - target: TSeries; - }) => void; - /** Specifies whether a single series or multiple series can be selected in the chart. */ - seriesSelectionMode?: string; - /** Specifies how the chart must behave when series point labels overlap. */ - resolveLabelOverlapping?: string; - } - export interface Legend extends AdvancedLegend { - /** Specifies whether the legend is located outside or inside the chart's plot. */ - position?: string; - } - export interface ChartTooltip extends BaseChartTooltip { - /** Specifies whether the tooltip must be located in the center of a bar or on its edge. Applies to the Bar and Bubble series. */ - location?: string; - /** Specifies the kind of information to display in a tooltip. */ - shared?: boolean; - } - export interface dxChartOptions extends AdvancedOptions { - /** Specifies a value indicating whether all bars in a series must have the same width, or may have different widths if any points in other series are missing. */ - equalBarWidth?: any; - adaptiveLayout?: { - keepLabels?: boolean; - }; - /** Indicates whether or not to synchronize value axes when they are displayed on a single pane. */ - synchronizeMultiAxes?: boolean; - /** Specifies whether or not to filter the series points depending on their quantity. */ - useAggregation?: boolean; - /** Indicates whether or not to adjust a value axis to the current minimum and maximum values of a zoomed chart. */ - adjustOnZoom?: boolean; - /** Specifies argument axis options for the dxChart widget. */ - argumentAxis?: ChartArgumentAxis; - argumentAxisClick?: any; - /** An object defining the configuration options that are common for all axes of the dxChart widget. */ - commonAxisSettings?: ChartCommonAxisSettings; - /** An object defining the configuration options that are common for all panes in the dxChart widget. */ - commonPaneSettings?: CommonPane; - /** An object defining the configuration options that are common for all series of the dxChart widget. */ - commonSeriesSettings?: CommonSeriesSettings; - /** An object that specifies the appearance options of the chart crosshair. */ - crosshair?: { - /** Specifies a color for the crosshair lines. */ - color?: string; - /** Specifies a dash style for the crosshair lines. */ - dashStyle?: string; - /** Specifies whether to enable the crosshair or not. */ - enabled?: boolean; - /** Specifies the opacity of the crosshair lines. */ - opacity?: number; - /** Specifies the width of the crosshair lines. */ - width?: number; - /** Specifies the appearance of the horizontal crosshair line. */ - horizontalLine?: CrosshaierWithLabel; - /** Specifies the appearance of the vertical crosshair line. */ - verticalLine?: CrosshaierWithLabel; - /** Specifies the options of the crosshair labels. */ - label?: { - /** Specifies a color for the background of the crosshair labels. */ - backgroundColor?: string; - /** Specifies whether the crosshair labels are visible or not. */ - visible?: boolean; - /** Specifies font options for the text of the crosshair labels. */ - font?: viz.core.Font; - } - }; - /** Specifies a default pane for the chart's series. */ - defaultPane?: string; - /** Specifies a coefficient determining the diameter of the largest bubble. */ - maxBubbleSize?: number; - /** Specifies the diameter of the smallest bubble measured in pixels. */ - minBubbleSize?: number; - /** Defines the dxChart widget's pane(s). */ - panes?: Array; - /** Swaps the axes round so that the value axis becomes horizontal and the argument axes becomes vertical. */ - rotated?: boolean; - /** Specifies the options of a chart's legend. */ - legend?: Legend; - /** Specifies options for dxChart widget series. */ - series?: Array; - legendClick?: any; - seriesClick?: any; - seriesHoverChanged?: (series: ChartSeries) => void; - seriesSelectionChanged?: (series: ChartSeries) => void; - /** Defines options for the series template. */ - seriesTemplate?: SeriesTemplate; - /** Specifies tooltip options. */ - tooltip?: ChartTooltip; - /** Specifies value axis options for the dxChart widget. */ - valueAxis?: Array; - /** Enables scrolling in your chart. */ - scrollingMode?: string; - /** Enables zooming in your chart. */ - zoomingMode?: string; - /** Specifies the settings of the scroll bar. */ - scrollBar?: { - /** Specifies whether the scroll bar is visible or not. */ - visible?: boolean; - /** Specifies the spacing between the scroll bar and the chart's plot in pixels. */ - offset?: number; - /** Specifies the color of the scroll bar. */ - color?: string; - /** Specifies the width of the scroll bar in pixels. */ - width?: number; - /** Specifies the opacity of the scroll bar. */ - opacity?: number; - /** Specifies the position of the scroll bar in the chart. */ - position?: string; - }; - } - /** A widget used to embed charts into HTML JS applications. */ - export class dxChart extends BaseChart { - constructor(element: JQuery, options?: dxChartOptions); - constructor(element: Element, options?: dxChartOptions); - /** Returns an array of all series in the chart. */ - getAllSeries(): Array; - /** Gets a series within the chart's series collection by the specified name (see the name option). */ - getSeriesByName(seriesName: string): ChartSeries; - /** Gets a series within the chart's series collection by its position number. */ - getSeriesByPos(seriesIndex: number): ChartSeries; - /** Sets the specified start and end values for the chart's argument axis. */ - zoomArgument(startValue: any, endValue: any): void; - } - interface CrosshaierWithLabel extends viz.core.DashedBorderWithOpacity { - /** Configures the label that belongs to the horizontal crosshair line. */ - label?: { - /** Specifies a color for the background of the label that belongs to the horizontal crosshair line. */ - backgroundColor?: string; - /** Specifies whether the label of the horizontal crosshair line is visible or not. */ - visible?: boolean; - /** Specifies font options for the text of the label that belongs to the horizontal crosshair line. */ - font?: viz.core.Font; - } - } - export interface PolarChartTooltip extends BaseChartTooltip { - /** Specifies the kind of information to display in a tooltip. */ - shared?: boolean; - } - export interface dxPolarChartOptions extends AdvancedOptions { - /** Specifies a value indicating whether all bars in a series must have the same angle, or may have different angles if any points in other series are missing. */ - equalBarWidth?: boolean; - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - width?: number; - height?: number; - /** Specifies whether or not point labels can be hidden when the layout is adapting. */ - keepLabels?: boolean; - }; - /** Indicates whether or not to display a "spider web". */ - useSpiderWeb?: boolean; - /** Specifies argument axis options for the dxPolarChart widget. */ - argumentAxis?: PolarArgumentAxis; - /** An object defining the configuration options that are common for all axes of the dxPolarChart widget. */ - commonAxisSettings?: PolarCommonAxisSettings; - /** An object defining the configuration options that are common for all series of the dxPolarChart widget. */ - commonSeriesSettings?: CommonPolarSeriesSettings; - /** Specifies the options of a chart's legend. */ - legend?: AdvancedLegend; - /** Specifies options for dxPolarChart widget series. */ - series?: Array; - /** Defines options for the series template. */ - seriesTemplate?: PolarSeriesTemplate; - /** Specifies tooltip options. */ - tooltip?: PolarChartTooltip; - /** Specifies value axis options for the dxPolarChart widget. */ - valueAxis?: PolarValueAxis; - } - /** A chart widget displaying data in a polar coordinate system. */ - export class dxPolarChart extends BaseChart { - constructor(element: JQuery, options?: dxPolarChartOptions); - constructor(element: Element, options?: dxPolarChartOptions); - /** Returns an array of all series in the chart. */ - getAllSeries(): Array; - /** Gets a series within the chart's series collection by the specified name (see the name option). */ - getSeriesByName(seriesName: string): PolarSeries; - /** Gets a series within the chart's series collection by its position number. */ - getSeriesByPos(seriesIndex: number): PolarSeries; - } - export interface PieLegend extends core.BaseLegend { - /** Specifies what chart elements to highlight when a corresponding item in the legend is hovered over. */ - hoverMode?: string; - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item. */ - customizeHint?: (pointInfo: { pointName: string; pointIndex: number; pointColor: string; }) => string; - /** Specifies a callback function that returns the text to be displayed by a legend item. */ - customizeText?: (pointInfo: { pointName: string; pointIndex: number; pointColor: string; }) => string; - } - export interface dxPieChartOptions extends BaseChartOptions { - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - /** Specifies whether or not point labels can be hidden when the layout is adapting. */ - keepLabels?: boolean; - }; - /** Specifies dxPieChart legend options. */ - legend?: PieLegend; - /** Specifies options for the series of the dxPieChart widget. */ - series?: Array; - /** Specifies the diameter of the pie. */ - diameter?: number; - /** A handler for the legendClick event. */ - onLegendClick?: any; - legendClick?: any; - /** Specifies how the chart must behave when series point labels overlap. */ - resolveLabelOverlapping?: string; - } - /** A circular chart widget for HTML JS applications. */ - export class dxPieChart extends BaseChart { - constructor(element: JQuery, options?: dxPieChartOptions); - constructor(element: Element, options?: dxPieChartOptions); - /** Provides access to the dxPieChart series. */ - getSeries(): PieSeries; - } -} -interface JQuery { - dxChart(options?: DevExpress.viz.charts.dxChartOptions): JQuery; - dxChart(methodName: string, ...params: any[]): any; - dxChart(methodName: "instance"): DevExpress.viz.charts.dxChart; - dxPieChart(options?: DevExpress.viz.charts.dxPieChartOptions): JQuery; - dxPieChart(methodName: string, ...params: any[]): any; - dxPieChart(methodName: "instance"): DevExpress.viz.charts.dxPieChart; - dxPolarChart(options?: DevExpress.viz.charts.dxPolarChartOptions): JQuery; - dxPolarChart(methodName: string, ...params: any[]): any; - dxPolarChart(methodName: "instance"): DevExpress.viz.charts.dxPolarChart; -} -declare namespace DevExpress.viz.gauges { - export interface BaseRangeContainer { - /** Specifies a range container's background color. */ - backgroundColor?: string; - /** Specifies the offset of the range container from an invisible scale line in pixels. */ - offset?: number; - /** Sets the name of the palette or an array of colors to be used for coloring the gauge range container. */ - palette?: any; - /** An array of objects representing ranges contained in the range container. */ - ranges?: Array<{ startValue: number; endValue: number; color: string }>; - /** Specifies a color of a range. */ - color?: string; - /** Specifies an end value of a range. */ - endValue?: number; - /** Specifies a start value of a range. */ - startValue?: number; - } - export interface ScaleTick { - /** Specifies the color of the scale's minor ticks. */ - color?: string; - /** Specifies an array of custom minor ticks. */ - customTickValues?: Array; - /** Specifies the length of the scale's minor ticks. */ - length?: number; - /** Indicates whether automatically calculated minor ticks are visible or not. */ - showCalculatedTicks?: boolean; - /** Specifies an interval between minor ticks. */ - tickInterval?: number; - /** Indicates whether scale minor ticks are visible or not. */ - visible?: boolean; - /** Specifies the width of the scale's minor ticks. */ - width?: number; - } - export interface ScaleMajorTick extends ScaleTick { - /** Specifies whether or not to expand the current major tick interval if labels overlap each other. */ - useTicksAutoArrangement?: boolean; - } - export interface BaseScaleLabel { - /** Specifies whether or not scale labels should be colored similarly to their corresponding ranges in the range container. */ - useRangeColors?: boolean; - /** Specifies a callback function that returns the text to be displayed in scale labels. */ - customizeText?: (scaleValue: { value: number; valueText: string }) => string; - /** Specifies font options for the text displayed in the scale labels of the gauge. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in scale labels. */ - format?: string; - /** Specifies a precision for the formatted value displayed in the scale labels. */ - precision?: number; - /** Specifies whether or not scale labels are visible on the gauge. */ - visible?: boolean; - } - export interface BaseScale { - /** Specifies the end value for the scale of the gauge. */ - endValue?: number; - /** Specifies whether or not to hide the first scale label. */ - hideFirstLabel?: boolean; - /** Specifies whether or not to hide the first major tick on the scale. */ - hideFirstTick?: boolean; - /** Specifies whether or not to hide the last scale label. */ - hideLastLabel?: boolean; - /** Specifies whether or not to hide the last major tick on the scale. */ - hideLastTick?: boolean; - /** Specifies common options for scale labels. */ - label?: BaseScaleLabel; - /** Specifies options of the gauge's major ticks. */ - majorTick?: ScaleMajorTick; - /** Specifies options of the gauge's minor ticks. */ - minorTick?: ScaleTick; - /** Specifies the start value for the scale of the gauge. */ - startValue?: number; - } - export interface BaseValueIndicator { - /** Specifies the type of subvalue indicators. */ - type?: string; - /** Specifies the background color for the indicator of the rangeBar type. */ - backgroundColor?: string; - /** Specifies the base value for the indicator of the rangeBar type. */ - baseValue?: number; - /** Specifies a color of the indicator. */ - color?: string; - /** Specifies the range bar size for an indicator of the rangeBar type. */ - size?: number; - text?: { - /** Specifies a callback function that returns the text to be displayed in an indicator. */ - customizeText?: (indicatedValue: { value: number; valueText: string }) => string; - font?: viz.core.Font; - /** Specifies a format for the text displayed in an indicator. */ - format?: string; - /** Specifies the range bar's label indent in pixels. */ - indent?: number; - /** Specifies a precision for the formatted value displayed by an indicator. */ - precision?: number; - }; - offset?: number; - length?: number; - width?: number; - /** Specifies the length of an arrow for the indicator of the textCloud type in pixels. */ - arrowLength?: number; - /** Sets the array of colors to be used for coloring subvalue indicators. */ - palette?: Array; - /** Specifies the distance between the needle and the center of a gauge for the indicator of a needle-like type. */ - indentFromCenter?: number; - /** Specifies the second color for the indicator of the twoColorNeedle type. */ - secondColor?: string; - /** Specifies the length of a twoNeedleColor type indicator tip as a percentage. */ - secondFraction?: number; - /** Specifies the spindle's diameter in pixels for the indicator of a needle-like type. */ - spindleSize?: number; - /** Specifies the inner diameter in pixels, so that the spindle has the shape of a ring. */ - spindleGapSize?: number; - /** Specifies the orientation of the rangeBar indicator on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - /** Specifies the orientation of the rangeBar indicator on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - } - export interface SharedGaugeOptions { - /** Specifies animation options. */ - animation?: viz.core.Animation; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */ - redrawOnResize?: boolean; - /** Specifies the size of the widget in pixels. */ - size?: viz.core.Size; - /** Specifies a subtitle for a gauge. */ - subtitle?: { - /** Specifies font options for the subtitle. */ - font?: viz.core.Font; - /** Specifies a text for the subtitle. */ - text?: string; - }; - /** Specifies a title for a gauge. */ - title?: { - /** Specifies font options for the title. */ - font?: viz.core.Font; - /** Specifies a title's position on the gauge. */ - position?: string; - /** Specifies a text for the title. */ - text?: string; - }; - /** Specifies options for gauge tooltips. */ - tooltip?: viz.core.Tooltip; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: dxBaseGauge; - element: Element; - target: {}; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: dxBaseGauge; - element: Element; - target: {}; - }) => void; - } - export interface BaseGaugeOptions extends viz.core.BaseWidgetOptions, SharedGaugeOptions { - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** Specifies the blank space in pixels between the widget's extreme elements and the boundaries of the area provided for the widget (see the size option). */ - margin?: viz.core.Margins; - /** Specifies options of the gauge's range container. */ - rangeContainer?: BaseRangeContainer; - /** Specifies a gauge's scale options. */ - scale?: BaseScale; - /** Specifies the appearance options of subvalue indicators. */ - subvalueIndicator?: BaseValueIndicator; - /** Specifies a set of subvalues to be designated by the subvalue indicators. */ - subvalues?: Array; - /** Specifies the main value on a gauge. */ - value?: number; - /** Specifies the appearance options of the value indicator. */ - valueIndicator?: BaseValueIndicator; - } - /** A gauge widget. */ - export class dxBaseGauge extends viz.core.BaseWidget { - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(): void; - /** Returns the main gauge value. */ - value(): number; - /** Updates a gauge value. */ - value(value: number): void; - /** Returns an array of gauge subvalues. */ - subvalues(): Array; - /** Updates gauge subvalues. */ - subvalues(subvalues: Array): void; - } - export interface LinearRangeContainer extends BaseRangeContainer { - /** Specifies the orientation of the range container on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - /** Specifies the orientation of a range container on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - /** Specifies the width of the range container's start and end boundaries in the dxLinearGauge widget. */ - width?: any; - /** Specifies an end width of a range container. */ - end?: number; - /** Specifies a start width of a range container. */ - start?: number; - } - export interface LinearScaleLabel extends BaseScaleLabel { - /** Specifies the spacing between scale labels and ticks. */ - indentFromTick?: number; - } - export interface LinearScale extends BaseScale { - /** Specifies the orientation of scale ticks on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - label?: LinearScaleLabel; - /** Specifies the orientation of scale ticks on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - } - export interface dxLinearGaugeOptions extends BaseGaugeOptions { - /** Specifies the options required to set the geometry of the dxLinearGauge widget. */ - geometry?: { - /** Indicates whether to display the dxLinearGauge widget vertically or horizontally. */ - orientation?: string; - }; - /** Specifies gauge range container options. */ - rangeContainer?: LinearRangeContainer; - scale?: LinearScale; - } - /** A widget that represents a gauge with a linear scale. */ - export class dxLinearGauge extends dxBaseGauge { - constructor(element: JQuery, options?: dxLinearGaugeOptions); - constructor(element: Element, options?: dxLinearGaugeOptions); - } - export interface CircularRangeContainer extends BaseRangeContainer { - /** Specifies the orientation of the range container in the dxCircularGauge widget. */ - orientation?: string; - /** Specifies the range container's width in pixels. */ - width?: number; - } - export interface CircularScaleLabel extends BaseScaleLabel { - /** Specifies the spacing between scale labels and ticks. */ - indentFromTick?: number; - } - export interface CircularScale extends BaseScale { - label?: CircularScaleLabel; - /** Specifies the orientation of scale ticks. */ - orientation?: string; - } - export interface dxCircularGaugeOptions extends BaseGaugeOptions { - /** Specifies the options required to set the geometry of the dxCircularGauge widget. */ - geometry?: { - /** Specifies the end angle of the circular gauge's arc. */ - endAngle?: number; - /** Specifies the start angle of the circular gauge's arc. */ - startAngle?: number; - }; - /** Specifies gauge range container options. */ - rangeContainer?: CircularRangeContainer; - scale?: CircularScale; - } - /** A widget that represents a gauge with a circular scale. */ - export class dxCircularGauge extends dxBaseGauge { - constructor(element: JQuery, options?: dxCircularGaugeOptions); - constructor(element: Element, options?: dxCircularGaugeOptions); - } - export interface dxBarGaugeOptions extends viz.core.BaseWidgetOptions, SharedGaugeOptions { - /** Specifies a color for the remaining segment of the bar's track. */ - backgroundColor?: string; - /** Specifies a distance between bars in pixels. */ - barSpacing?: number; - /** Specifies a base value for bars. */ - baseValue?: number; - /** Specifies an end value for the gauge's invisible scale. */ - endValue?: number; - /** Defines the shape of the gauge's arc. */ - geometry?: { - /** Specifies the end angle of the bar gauge's arc. */ - endAngle?: number; - /** Specifies the start angle of the bar gauge's arc. */ - startAngle?: number; - }; - /** Specifies the options of the labels that accompany gauge bars. */ - label?: { - /** Specifies a color for the label connector text. */ - connectorColor?: string; - /** Specifies the width of the label connector in pixels. */ - connectorWidth?: number; - /** Specifies a callback function that returns a text for labels. */ - customizeText?: (barValue: { value: number; valueText: string }) => string; - /** Specifies font options for bar labels. */ - font?: viz.core.Font; - /** Specifies a format for bar labels. */ - format?: string; - /** Specifies the distance between the upper bar and bar labels in pixels. */ - indent?: number; - /** Specifies a precision for the formatted value displayed by labels. */ - precision?: number; - /** Specifies whether bar labels appear on a gauge or not. */ - visible?: boolean; - }; - /** Sets the name of the palette or an array of colors to be used for coloring the gauge range container. */ - palette?: string; - /** Defines the radius of the bar that is closest to the center relatively to the radius of the topmost bar. */ - relativeInnerRadius?: number; - /** Specifies a start value for the gauge's invisible scale. */ - startValue?: number; - /** Specifies the array of values to be indicated on a bar gauge. */ - values?: Array; - } - /** A circular bar widget. */ - export class dxBarGauge extends viz.core.BaseWidget { - constructor(element: JQuery, options?: dxBarGaugeOptions); - constructor(element: Element, options?: dxBarGaugeOptions); - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws the widget. */ - render(): void; - /** Returns an array of gauge values. */ - values(): Array; - /** Updates the values displayed by a gauge. */ - values(values: Array): void; - } -} -interface JQuery { - dxLinearGauge(options?: DevExpress.viz.gauges.dxLinearGaugeOptions): JQuery; - dxLinearGauge(methodName: string, ...params: any[]): any; - dxLinearGauge(methodName: "instance"): DevExpress.viz.gauges.dxLinearGauge; - dxCircularGauge(options?: DevExpress.viz.gauges.dxCircularGaugeOptions): JQuery; - dxCircularGauge(methodName: string, ...params: any[]): any; - dxCircularGauge(methodName: "instance"): DevExpress.viz.gauges.dxCircularGauge; - dxBarGauge(options?: DevExpress.viz.gauges.dxBarGaugeOptions): JQuery; - dxBarGauge(methodName: string, ...params: any[]): any; - dxBarGauge(methodName: "instance"): DevExpress.viz.gauges.dxBarGauge; -} -declare namespace DevExpress.viz.rangeSelector { - export interface dxRangeSelectorOptions extends viz.core.BaseWidgetOptions { - /** Specifies the options for the range selector's background. */ - background?: { - /** Specifies the background color for the dxRangeSelector. */ - color?: string; - /** Specifies image options. */ - image?: { - /** Specifies a location for the image in the background of a range selector. */ - location?: string; - /** Specifies the image's URL. */ - url?: string; - }; - /** Indicates whether or not the background (background color and/or image) is visible. */ - visible?: boolean; - }; - /** Specifies the dxRangeSelector's behavior options. */ - behavior?: { - /** Indicates whether or not you can swap sliders. */ - allowSlidersSwap?: boolean; - /** -Indicates whether or not animation is enabled. - */ - animationEnabled?: boolean; - /** Specifies when to call the onSelectedRangeChanged function. */ - callSelectedRangeChanged?: string; - /** Indicates whether or not an end user can specify the range using a mouse, without the use of sliders. */ - manualRangeSelectionEnabled?: boolean; - /** Indicates whether or not an end user can shift the selected range to the required location on a scale by clicking. */ - moveSelectedRangeByClick?: boolean; - /** Indicates whether to snap a slider to ticks. */ - snapToTicks?: boolean; - }; - /** Specifies the options required to display a chart as the range selector's background. */ - chart?: { - /** Specifies a coefficient for determining an indent from the bottom background boundary to the lowest chart point. */ - bottomIndent?: number; - /** An object defining the common configuration options for the chart’s series. */ - commonSeriesSettings?: viz.charts.CommonSeriesSettings; - /** An object providing options for managing data from a data source. */ - dataPrepareSettings?: { - /** Specifies whether or not to validate values from a data source. */ - checkTypeForAllData?: boolean; - /** Specifies whether or not to convert the values from a data source into the data type of an axis. */ - convertToAxisDataType?: boolean; - /** Specifies how to sort series points. */ - sortingMethod?: any; - }; - /** Specifies a value indicating whether all bars in a series must have the same width, or may have different widths if any points in other series are missing. */ - equalBarWidth?: any; - /** Sets the name of the palette to be used in the range selector's chart. Alternatively, an array of colors can be set as a custom palette to be used within this chart. */ - palette?: any; - /** An object defining the chart’s series. */ - series?: Array; - /** Defines options for the series template. */ - seriesTemplate?: viz.charts.SeriesTemplate; - /** Specifies a coefficient for determining an indent from the background's top boundary to the topmost chart point. */ - topIndent?: number; - /** Specifies whether or not to filter the series points depending on their quantity. */ - useAggregation?: boolean; - /** Specifies options for the chart's value axis. */ - valueAxis?: { - /** Indicates whether or not the chart's value axis must be inverted. */ - inverted?: boolean; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic value axis. */ - logarithmBase?: number; - /** Specifies the maximum value of the chart's value axis. */ - max?: number; - /** Specifies the minimum value of the chart's value axis. */ - min?: number; - /** Specifies the type of the value axis. */ - type?: string; - /** Specifies the desired type of axis values. */ - valueType?: string; - }; - }; - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** Specifies a data source for the scale values and for the chart at the background. */ - dataSource?: any; - /** Specifies the data source field that provides data for the scale. */ - dataSourceField?: string; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies the blank space in pixels between the dxRangeSelector widget's extreme elements and the boundaries of the area provided for the widget (see size). */ - margin?: viz.core.Margins; - /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */ - redrawOnResize?: boolean; - /** Specifies options of the range selector's scale. */ - scale?: { - /** Specifies the scale's end value. */ - endValue?: any; - /** Specifies common options for scale labels. */ - label?: { - /** Specifies a callback function that returns the text to be displayed in scale labels. */ - customizeText?: (scaleValue: { value: any; valueText: string; }) => string; - /** Specifies font options for the text displayed in the range selector's scale labels. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in scale labels. */ - format?: string; - /** Specifies a precision for the formatted value displayed in the scale labels. */ - precision?: number; - /** Specifies a spacing between scale labels and the background bottom edge. */ - topIndent?: number; - /** Specifies whether or not the scale's labels are visible. */ - visible?: boolean; - }; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic scale. */ - logarithmBase?: number; - /** Specifies an interval between major ticks. */ - majorTickInterval?: any; - /** Specifies options for the date-time scale's markers. */ - marker?: { - /** Defines the options that can be set for the text that is displayed by the scale markers. */ - label?: { - /** Specifies a callback function that returns the text to be displayed in scale markers. */ - customizeText?: (markerValue: { value: any; valueText: string }) => string; - /** Specifies a format for the text displayed in scale markers. */ - format?: string; - }; - /** Specifies the height of the marker's separator. */ - separatorHeight?: number; - /** Specifies the space between the marker label and the marker separator. */ - textLeftIndent?: number; - /** Specifies the space between the marker's label and the top edge of the marker's separator. */ - textTopIndent?: number; - /** Specified the indent between the marker and the scale lables. */ - topIndent?: number; - /** Indicates whether scale markers are visible. */ - visible?: boolean; - }; - /** Specifies the maximum range that can be selected. */ - maxRange?: any; - /** Specifies the number of minor ticks between neighboring major ticks. */ - minorTickCount?: number; - /** -Specifies an interval between minor ticks. - */ - minorTickInterval?: any; - /** Specifies the minimum range that can be selected. */ - minRange?: any; - /** Specifies the height of the space reserved for the scale in pixels. */ - placeholderHeight?: number; - /** Indicates whether or not to set ticks of a date-time scale at the beginning of each date-time interval. */ - setTicksAtUnitBeginning?: boolean; - /** Specifies whether or not to show ticks for the boundary scale values, when neither major ticks nor minor ticks are created for these values. */ - showCustomBoundaryTicks?: boolean; - /** Indicates whether or not to show minor ticks on the scale. */ - showMinorTicks?: boolean; - /** Specifies the scale's start value. */ - startValue?: any; - /** Specifies options defining the appearance of scale ticks. */ - tick?: { - /** Specifies the color of scale ticks (both major and minor ticks). */ - color?: string; - /** Specifies the opacity of scale ticks (both major and minor ticks). */ - opacity?: number; - /** Specifies the width of the scale's ticks (both major and minor ticks). */ - width?: number; - }; - /** Specifies the type of the scale. */ - type?: string; - /** Specifies whether or not to expand the current tick interval if labels overlap each other. */ - useTicksAutoArrangement?: boolean; - /** Specifies the type of values on the scale. */ - valueType?: string; - /** Specifies the order of arguments on a discrete scale. */ - categories?: Array; - }; - /** Specifies the range to be selected when displaying the dxRangeSelector. */ - selectedRange?: { - /** Specifies the start value of the range to be selected when displaying the dxRangeSelector widget on a page. */ - startValue?: any; - /** Specifies the end value of the range to be selected when displaying the dxRangeSelector widget on a page. */ - endValue?: any; - }; - /** Specifies the color of the selected range. */ - selectedRangeColor?: string; - /** Range selector's indent options. */ - indent?: { - /** Specifies range selector's left indent. */ - left?: number; - /** Specifies range selector's right indent. */ - right?: number; - }; - selectedRangeChanged?: (selectedRange: { startValue: any; endValue: any; }) => void; - /** A handler for the selectedRangeChanged event. */ - onSelectedRangeChanged?: (e: { - startValue: any; - endValue: any; - component: dxRangeSelector; - element: Element; - }) => void; - /** Specifies range selector shutter options. */ - shutter?: { - /** Specifies shutter color. */ - color?: string; - /** Specifies the opacity of the color of shutters. */ - opacity?: number; - }; - /** Specifies in pixels the size of the dxRangeSelector widget. */ - size?: viz.core.Size; - /** Specifies the appearance of the range selector's slider handles. */ - sliderHandle?: { - /** Specifies the color of the slider handles. */ - color?: string; - /** Specifies the opacity of the slider handles. */ - opacity?: number; - /** Specifies the width of the slider handles. */ - width?: number; - }; - /** Defines the options of the range selector slider markers. */ - sliderMarker?: { - /** Specifies the color of the slider markers. */ - color?: string; - /** Specifies a callback function that returns the text to be displayed by slider markers. */ - customizeText?: (scaleValue: { value: any; valueText: any; }) => string; - /** Specifies font options for the text displayed by the range selector slider markers. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in slider markers. */ - format?: string; - /** Specifies the color used for the slider marker text when the currently selected range does not match the minRange and maxRange values. */ - invalidRangeColor?: string; - /** - * Specifies the empty space between the marker's border and the marker’s text. - * @deprecated Use the 'paddingTopBottom' and 'paddingLeftRight' options instead - */ - padding?: number; - /** Specifies the empty space between the marker's top and bottom borders and the marker's text. */ - paddingTopBottom?: number; - /** Specifies the empty space between the marker's left and right borders and the marker's text. */ - paddingLeftRight?: number; - /** Specifies the placeholder height of the slider marker. */ - placeholderHeight?: number; - /** - * Specifies in pixels the height and width of the space reserved for the range selector slider markers. - * @deprecated Use the 'placeholderHeight' and 'indent' options instead - */ - placeholderSize?: { - /** Specifies the height of the placeholder for the left and right slider markers. */ - height?: number; - /** Specifies the width of the placeholder for the left and right slider markers. */ - width?: { - /** Specifies the width of the left slider marker's placeholder. */ - left?: number; - /** Specifies the width of the right slider marker's placeholder. */ - right?: number; - }; - }; - /** Specifies a precision for the formatted value displayed in slider markers. */ - precision?: number; - /** Indicates whether or not the slider markers are visible. */ - visible?: boolean; - }; - } - /** A widget that allows end users to select a range of values on a scale. */ - export class dxRangeSelector extends viz.core.BaseWidget { - constructor(element: JQuery, options?: dxRangeSelectorOptions); - constructor(element: Element, options?: dxRangeSelectorOptions); - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(skipChartAnimation?: boolean): void; - /** Returns the currently selected range. */ - getSelectedRange(): { startValue: any; endValue: any; }; - /** Sets a specified range. */ - setSelectedRange(selectedRange: { startValue: any; endValue: any; }): void; - } -} -interface JQuery { - dxRangeSelector(options?: DevExpress.viz.rangeSelector.dxRangeSelectorOptions): JQuery; - dxRangeSelector(methodName: string, ...params: any[]): any; - dxRangeSelector(methodName: "instance"): DevExpress.viz.rangeSelector.dxRangeSelector; -} -declare namespace DevExpress.viz.map { - /** This section describes the fields and methods that can be used in code to manipulate the Area object. */ - export interface Area { - /** Contains the element type. */ - type: string; - /** Return the value of an attribute. */ - attribute(name: string): any; - /** Provides information about the selection state of an area. */ - selected(): boolean; - /** Sets a new selection state for an area. */ - selected(state: boolean): void; - /** Applies the area settings specified as a parameter and updates the area appearance. */ - applySettings(settings: any): void; - } - /** This section describes the fields and methods that can be used in code to manipulate the Markers object. */ - export interface Marker { - /** Contains the descriptive text accompanying the map marker. */ - text: string; - /** Contains the type of the element. */ - type: string; - /** Contains the URL of an image map marker. */ - url: string; - /** Contains the value of a bubble map marker. */ - value: number; - /** Contains the values of a pie map marker. */ - values: Array; - /** Returns the value of an attribute. */ - attribute(name: string): any; - /** Returns the coordinates of a specific marker. */ - coordinates(): Array; - /** Provides information about the selection state of a marker. */ - selected(): boolean; - /** Sets a new selection state for a marker. */ - selected(state: boolean): void; - /** Applies the marker settings specified as a parameter and updates the marker appearance. */ - applySettings(settings: any): void; - } - export interface AreaSettings { - /** Specifies the width of the area border in pixels. */ - borderWidth?: number; - /** Specifies a color for the area border. */ - borderColor?: string; - click?: any; - /** Specifies a color for an area. */ - color?: string; - /** Specifies the function that customizes each area individually. */ - customize?: (areaInfo: Area) => AreaSettings; - /** Specifies a color for the area border when the area is hovered over. */ - hoveredBorderColor?: string; - /** Specifies the pixel-measured width of the area border when the area is hovered over. */ - hoveredBorderWidth?: number; - /** Specifies a color for an area when this area is hovered over. */ - hoveredColor?: string; - /** Specifies whether or not to change the appearance of an area when it is hovered over. */ - hoverEnabled?: boolean; - /** Configures area labels. */ - label?: { - /** Specifies the data field that provides data for area labels. */ - dataField?: string; - /** Enables area labels. */ - enabled?: boolean; - /** Specifies font options for area labels. */ - font?: viz.core.Font; - }; - /** Specifies the name of the palette or a custom range of colors to be used for coloring a map. */ - palette?: any; - /** Specifies the number of colors in a palette. */ - paletteSize?: number; - /** Allows you to paint areas with similar attributes in the same color. */ - colorGroups?: Array; - /** Specifies the field that provides data to be used for coloring areas. */ - colorGroupingField?: string; - /** Specifies a color for the area border when the area is selected. */ - selectedBorderColor?: string; - /** Specifies a color for an area when this area is selected. */ - selectedColor?: string; - /** Specifies the pixel-measured width of the area border when the area is selected. */ - selectedBorderWidth?: number; - selectionChanged?: (area: Area) => void; - /** Specifies whether single or multiple areas can be selected on a vector map. */ - selectionMode?: string; - } - export interface MarkerSettings { - /** Specifies a color for the marker border. */ - borderColor?: string; - /** Specifies the width of the marker border in pixels. */ - borderWidth?: number; - click?: any; - /** Specifies a color for a marker of the dot or bubble type. */ - color?: string; - /** Specifies the function that customizes each marker individually. */ - customize?: (markerInfo: Marker) => MarkerSettings; - font?: Object; - /** Specifies the pixel-measured width of the marker border when the marker is hovered over. */ - hoveredBorderWidth?: number; - /** Specifies a color for the marker border when the marker is hovered over. */ - hoveredBorderColor?: string; - /** Specifies a color for a marker of the dot or bubble type when this marker is hovered over. */ - hoveredColor?: string; - /** Specifies whether or not to change the appearance of a marker when it is hovered over. */ - hoverEnabled?: boolean; - /** Specifies marker label options. */ - label?: { - /** Enables marker labels. */ - enabled?: boolean; - /** Specifies font options for marker labels. */ - font?: viz.core.Font; - }; - /** Specifies the pixel-measured diameter of the marker that represents the biggest value. Setting this option makes sense only if you use markers of the bubble type. */ - maxSize?: number; - /** Specifies the pixel-measured diameter of the marker that represents the smallest value. Setting this option makes sense only if you use markers of the bubble type. */ - minSize?: number; - /** Specifies the opacity of markers. Setting this option makes sense only if you use markers of the bubble type. */ - opacity?: number; - /** Specifies the pixel-measured width of the marker border when the marker is selected. */ - selectedBorderWidth?: number; - /** Specifies a color for the marker border when the marker is selected. */ - selectedBorderColor?: string; - /** Specifies a color for a marker of the dot or bubble type when this marker is selected. */ - selectedColor?: string; - selectionChanged?: (marker: Marker) => void; - /** Specifies whether a single or multiple markers can be selected on a vector map. */ - selectionMode?: string; - /** Specifies the size of markers. Setting this option makes sense for any type of marker except bubble. */ - size?: number; - /** Specifies the type of markers to be used on the map. */ - type?: string; - /** Specifies the name of a palette or a custom set of colors to be used for coloring markers of the pie type. */ - palette?: any; - /** Allows you to paint markers with similar attributes in the same color. */ - colorGroups?: Array; - /** Specifies the field that provides data to be used for coloring markers. */ - colorGroupingField?: string; - /** Allows you to display bubbles with similar attributes in the same size. */ - sizeGroups?: Array; - /** Specifies the field that provides data to be used for sizing bubble markers. */ - sizeGroupingField?: string; - } - export interface dxVectorMapOptions extends viz.core.BaseWidgetOptions { - /** An object specifying options for the map areas. */ - areaSettings?: AreaSettings; - /** Specifies the options for the map background. */ - background?: { - /** Specifies a color for the background border. */ - borderColor?: string; - /** Specifies a color for the background. */ - color?: string; - }; - /** Specifies the positioning of a map in geographical coordinates. */ - bounds?: Array; - /** Specifies the options of the control bar. */ - controlBar?: { - /** Specifies a color for the outline of the control bar elements. */ - borderColor?: string; - /** Specifies a color for the inner area of the control bar elements. */ - color?: string; - /** Specifies whether or not to display the control bar. */ - enabled?: boolean; - /** Specifies the margin of the control bar in pixels. */ - margin?: number; - /** Specifies the position of the control bar. */ - horizontalAlignment?: string; - /** Specifies the position of the control bar. */ - verticalAlignment?: string; - /** Specifies the opacity of the Control_Bar. */ - opacity?: number; - }; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies a data source for the map area. */ - mapData?: any; - /** Specifies a data source for the map markers. */ - markers?: any; - /** An object specifying options for the map markers. */ - markerSettings?: MarkerSettings; - /** Specifies the size of the dxVectorMap widget. */ - size?: viz.core.Size; - /** Specifies tooltip options. */ - tooltip?: viz.core.Tooltip; - /** Configures map legends. */ - legends?: Array; - /** Specifies whether or not the map should respond when a user rolls the mouse wheel. */ - wheelEnabled?: boolean; - /** Specifies whether the map should respond to touch gestures. */ - touchEnabled?: boolean; - /** Disables the zooming capability. */ - zoomingEnabled?: boolean; - /** Specifies the geographical coordinates of the center for a map. */ - center?: Array; - centerChanged?: (center: Array) => void; - /** A handler for the centerChanged event. */ - onCenterChanged?: (e: { - center: Array; - component: dxVectorMap; - element: Element; - }) => void; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: dxVectorMap; - element: Element; - target: {}; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: dxVectorMap; - element: Element; - target: {}; - }) => void; - /** Specifies a number that is used to zoom a map initially. */ - zoomFactor?: number; - /** Specifies a map's maximum zoom factor. */ - maxZoomFactor?: number; - zoomFactorChanged?: (zoomFactor: number) => void; - /** A handler for the zoomFactorChanged event. */ - onZoomFactorChanged?: (e: { - zoomFactor: number; - component: dxVectorMap; - element: Element; - }) => void; - click?: any; - /** A handler for the click event. */ - onClick?: any; - /** A handler for the areaClick event. */ - onAreaClick?: any; - /** A handler for the areaSelectionChanged event. */ - onAreaSelectionChanged?: (e: { - target: Area; - component: dxVectorMap; - element: Element; - }) => void; - /** A handler for the markerClick event. */ - onMarkerClick?: any; - /** A handler for the markerSelectionChanged event. */ - onMarkerSelectionChanged?: (e: { - target: Marker; - component: dxVectorMap; - element: Element; - }) => void; - /** Disables the panning capability. */ - panningEnabled?: boolean; - } - export interface Legend extends viz.core.BaseLegend { - /** Specifies text for legend items. */ - customizeText?: (itemInfo: { start: number; end: number; index: number; color: string; size: number; }) => string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the text of a legend item. */ - customizeHint?: (itemInfo: { start: number; end: number; index: number; color: string; size: number }) => string; - /** Specifies the source of data for the legend. */ - source?: string; - } - /** A vector map widget. */ - export class dxVectorMap extends viz.core.BaseWidget { - constructor(element: JQuery, options?: dxVectorMapOptions); - constructor(element: Element, options?: dxVectorMapOptions); - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(): void; - /** Gets the current coordinates of the map center. */ - center(): Array; - /** Sets the coordinates of the map center. */ - center(centerCoordinates: Array): void; - /** Deselects all the selected areas on a map. The areas are displayed in their initial style after. */ - clearAreaSelection(): void; - /** Deselects all the selected markers on a map. The markers are displayed in their initial style after. */ - clearMarkerSelection(): void; - /** Deselects all the selected area and markers on a map at once. The areas and markers are displayed in their initial style after. */ - clearSelection(): void; - /** Converts client area coordinates into map coordinates. */ - convertCoordinates(x: number, y: number): Array; - /** Returns an array with all the map areas. */ - getAreas(): Array; - /** Returns an array with all the map markers. */ - getMarkers(): Array; - /** Gets the current coordinates of the map viewport. */ - viewport(): Array; - /** Sets the coordinates of the map viewport. */ - viewport(viewportCoordinates: Array): void; - /** Gets the current value of the map zoom factor. */ - zoomFactor(): number; - /** Sets the value of the map zoom factor. */ - zoomFactor(zoomFactor: number): void; - } -} -interface JQuery { - dxVectorMap(options?: DevExpress.viz.map.dxVectorMapOptions): JQuery; - dxVectorMap(methodName: string, ...params: any[]): any; - dxVectorMap(methodName: "instance"): DevExpress.viz.map.dxVectorMap; -} -declare namespace DevExpress.viz.sparklines { - export interface SparklineTooltip extends viz.core.Tooltip { - /** - * Specifies how a tooltip is horizontally aligned relative to the graph. - * @deprecated Tooltip alignment is no more available. - */ - horizontalAlignment?: string; - /** - * Specifies how a tooltip is vertically aligned relative to the graph. - * @deprecated Tooltip alignment is no more available. - */ - verticalAlignment?: string; - } - export interface BaseSparklineOptions extends viz.core.BaseWidgetOptions { - /** Specifies the blank space between the widget's extreme elements and the boundaries of the area provided for the widget in pixels. */ - margin?: viz.core.Margins; - /** Specifies the size of the widget. */ - size?: viz.core.Size; - /** Specifies tooltip options. */ - tooltip?: SparklineTooltip; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: BaseSparkline; - element: Element; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: BaseSparkline; - element: Element; - }) => void; - } - /** Overridden by descriptions for particular widgets. */ - export class BaseSparkline extends viz.core.BaseWidget { - /** Redraws a widget. */ - render(): void; - } - export interface dxBulletOptions extends BaseSparkline { - /** Specifies a color for the bullet bar. */ - color?: string; - /** Specifies an end value for the invisible scale. */ - endScaleValue?: number; - /** Specifies whether or not to show the target line. */ - showTarget?: boolean; - /** Specifies whether or not to show the line indicating zero on the invisible scale. */ - showZeroLevel?: boolean; - /** Specifies a start value for the invisible scale. */ - startScaleValue?: number; - /** Specifies the value indicated by the target line. */ - target?: number; - /** Specifies a color for both the target and zero level lines. */ - targetColor?: string; - /** Specifies the width of the target line. */ - targetWidth?: number; - /** Specifies the primary value indicated by the bullet bar. */ - value?: number; - } - /** A bullet graph widget. */ - export class dxBullet extends BaseSparkline { - constructor(element: JQuery, options?: dxBulletOptions); - constructor(element: Element, options?: dxBulletOptions); - } - export interface dxSparklineOptions extends BaseSparklineOptions { - /** Specifies the data source field that provides arguments for a sparkline. */ - argumentField?: string; - /** Sets a color for the bars indicating negative values. Available for a sparkline of the bar type only. */ - barNegativeColor?: string; - /** Sets a color for the bars indicating positive values. Available for a sparkline of the bar type only. */ - barPositiveColor?: string; - /** Specifies a data source for the sparkline. */ - dataSource?: Array; - /** Sets a color for the boundary of both the first and last points on a sparkline. */ - firstLastColor?: string; - /** Specifies whether a sparkline ignores null data points or not. */ - ignoreEmptyPoints?: boolean; - /** Sets a color for a line on a sparkline. Available for the sparklines of the line- and area-like types. */ - lineColor?: string; - /** Specifies a width for a line on a sparkline. Available for the sparklines of the line- and area-like types. */ - lineWidth?: number; - /** Sets a color for the bars indicating the values that are less than the winloss threshold. Available for a sparkline of the winloss type only. */ - lossColor?: string; - /** Sets a color for the boundary of the maximum point on a sparkline. */ - maxColor?: string; - /** Sets a color for the boundary of the minimum point on a sparkline. */ - minColor?: string; - /** Sets a color for points on a sparkline. Available for the sparklines of the line- and area-like types. */ - pointColor?: string; - /** Specifies the diameter of sparkline points in pixels. Available for the sparklines of line- and area-like types. */ - pointSize?: number; - /** Specifies a symbol to use as a point marker on a sparkline. Available for the sparklines of the line- and area-like types. */ - pointSymbol?: string; - /** Specifies whether or not to indicate both the first and last values on a sparkline. */ - showFirstLast?: boolean; - /** Specifies whether or not to indicate both the minimum and maximum values on a sparkline. */ - showMinMax?: boolean; - /** Determines the type of a sparkline. */ - type?: string; - /** Specifies the data source field that provides values for a sparkline. */ - valueField?: string; - /** Sets a color for the bars indicating the values greater than a winloss threshold. Available for a sparkline of the winloss type only. */ - winColor?: string; - /** Specifies a value that serves as a threshold for the sparkline of the winloss type. */ - winlossThreshold?: number; - /** Specifies the minimum value of the sparkline value axis. */ - minValue?: number; - /** Specifies the maximum value of the sparkline's value axis. */ - maxValue?: number; - } - /** A sparkline widget. */ - export class dxSparkline extends BaseSparkline { - constructor(element: JQuery, options?: dxSparklineOptions); - constructor(element: Element, options?: dxSparklineOptions); - } -} -interface JQuery { - dxBullet(options?: DevExpress.viz.sparklines.dxBulletOptions): JQuery; - dxBullet(methodName: string, ...params: any[]): any; - dxBullet(methodName: "instance"): DevExpress.viz.sparklines.dxBullet; - dxSparkline(options?: DevExpress.viz.sparklines.dxSparklineOptions): JQuery; - dxSparkline(methodName: string, ...params: any[]): any; - dxSparkline(methodName: "instance"): DevExpress.viz.sparklines.dxSparkline; -} diff --git a/devextreme/devextreme-15.1.7.d.ts b/devextreme/devextreme-15.1.7.d.ts deleted file mode 100644 index 53f058c593..0000000000 --- a/devextreme/devextreme-15.1.7.d.ts +++ /dev/null @@ -1,6572 +0,0 @@ -// Type definitions for DevExtreme 15.1.7 -// Project: http://js.devexpress.com/ -// Definitions by: DevExpress Inc. -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -/// - -declare namespace DevExpress { - /** A mixin that provides a capability to fire and subscribe to events. */ - export interface EventsMixin { - /** Subscribes to a specified event. */ - on(eventName: string, eventHandler: Function): T; - /** Subscribes to the specified events. */ - on(events: { [eventName: string]: Function; }): T; - /** Detaches all event handlers from the specified event. */ - off(eventName: string): Object; - /** Detaches a particular event handler from the specified event. */ - off(eventName: string, eventHandler: Function): T; - } - /** An object that serves as a namespace for the methods required to perform validation. */ - export module validationEngine { - export interface IValidator { - validate(): ValidatorValidationResult; - reset(): void; - } - export interface ValidatorValidationResult { - isValid: boolean; - name?: string; - value: any; - brokenRule: any; - validationRules: any[]; - } - export interface ValidationGroupValidationResult { - isValid: boolean; - brokenRules: any[]; - validators: IValidator[]; - } - export interface GroupConfig extends EventsMixin { - group: any; - validators: IValidator[]; - validate(): ValidationGroupValidationResult; - reset(): void; - } - /** Provides access to the object that represents the specified validation group. */ - export function getGroupConfig(group: any): GroupConfig - /** Provides access to the object that represents the default validation group. */ - export function getGroupConfig(): GroupConfig - /** Validates rules of the validators that belong to the specified validation group. */ - export function validateGroup(group: any): ValidationGroupValidationResult; - /** Validates rules of the validators that belong to the default validation group. */ - export function validateGroup(): ValidationGroupValidationResult; - /** Resets the values and validation result of the editors that belong to the specified validation group. */ - export function resetGroup(group: any): void; - /** Resets the values and validation result of the editors that belong to the default validation group. */ - export function resetGroup(): void; - /** Validates the rules that are defined within the dxValidator objects that are registered for the specified ViewModel. */ - export function validateModel(model: Object): ValidationGroupValidationResult; - /** Registers all the dxValidator objects by which the fields of the specified ViewModel are extended. */ - export function registerModelForValidation(model: Object): void; - } - export var hardwareBackButton: JQueryCallback; - /** Processes the hardware back button click. */ - export function processHardwareBackButton(): void; - /** Hides the last displayed overlay widget. */ - export function hideTopOverlay(): boolean; - /** Specifies whether or not the entire application/site supports right-to-left representation. */ - export var rtlEnabled: boolean; - /** Registers a new component in the DevExpress.ui namespace as a jQuery plugin, Angular directive and Knockout binding. */ - export function registerComponent(name: string, componentClass: Object): void; - /** Registers a new component in the specified namespace as a jQuery plugin, Angular directive and Knockout binding. */ - export function registerComponent(name: string, namespace: Object, componentClass: Object): void; - /** Requests that the browser call a specified function to update animation before the next repaint. */ - export function requestAnimationFrame(callback: Function): number; - /** Cancels an animation frame request scheduled with the requestAnimationFrame method. */ - export function cancelAnimationFrame(requestID: number): void; - /** Custom Knockout binding that links an HTML element with a specific action. */ - export class Action { } - /** Used to get URLs that vary in a locally running application and the application running on production. */ - export class EndpointSelector { - constructor(options: { - [key: string]: { - local?: string; - production?: string; - } - }); - /** Returns a local or a productional URL depending on how the application is currently running. */ - urlFor(key: string): string; - } - /** An object that serves as a namespace for the methods that are used to animate UI elements. */ - export module fx { - /** Defines animation options. */ - export interface AnimationOptions { - /** A function called after animation is completed. */ - complete?: (element: JQuery, config: AnimationOptions) => void; - /** A number specifying wait time before animation execution. */ - delay?: number; - /** A number specifying the time period to wait before the animation of the next stagger item starts. */ - staggerDelay?: number; - /** A number specifying the time in milliseconds spent on animation. */ - duration?: number; - /** A string specifying the type of an easing function used for animation. */ - easing?: string; - /** Specifies the initial animation state. */ - from?: any; - /** A function called before animation is started. */ - start?: (element: JQuery, config: AnimationOptions) => void; - /** Specifies a final animation state. */ - to?: any; - /** A string value specifying the animation type. */ - type?: string; - /** Specifies the animation direction for the "slideIn" and "slideOut" animation types. */ - direction?: string; - } - /** Animates the specified element. */ - export function animate(element: HTMLElement, config: AnimationOptions): Object; - /** Returns a value indicating whether the specified element is being animated. */ - export function isAnimating(element: HTMLElement): boolean; - /** Stops the animation. */ - export function stop(element: HTMLElement, jumpToEnd: boolean): void; - } - /** The manager that performs several specified animations at a time. */ - export class TransitionExecutor { - /** Deletes all the animations registered in the Transition Executor by using the enter(elements, animation) and leave(elements, animation) methods. */ - reset(): void; - /** Registers a set of elements that should be animated as "entering" using the specified animation configuration. */ - enter(elements: JQuery, animation: any): void; - /** Registers a set of elements that should be animated as "leaving" using the specified animation configuration. */ - leave(elements: JQuery, animation: any): void; - /** Starts all the animations registered using the enter(elements, animation) and leave(elements, animation) methods beforehand. */ - start(config: Object): JQueryPromise; - } - export class AnimationPresetCollection { - /** Resets all the changes made in the animation repository. */ - resetToDefaults(): void; - /** Deletes the specified animation or clears all the animation repository, if an animation name is not passed. */ - clear(name: string): void; - /** Adds the specified animation preset to the animation repository by the specified name. */ - registerPreset(name: string, config: any): void; - /** Applies the changes made in the animation repository. */ - applyChanges(): void; - /** Returns the configuration of the animation found in the animation repository by the specified name for the current device. */ - getPreset(name: string): void; - /** Registers predefined animations in the animation repository. */ - registerDefaultPresets(): void; - } - /** A repository of animations. */ - export var animationPresets: AnimationPresetCollection; - /** The device object defines the device on which the application is running. */ - export interface Device { - /** Indicates whether or not the device platform is Android. */ - android?: boolean; - /** Specifies the type of the device on which the application is running. */ - deviceType?: string; - /** Indicates whether or not the device platform is generic, which means that the application will look and behave according to a generic "light" or "dark" theme. */ - generic?: boolean; - /** Indicates whether or not the device platform is iOS. */ - ios?: boolean; - /** Indicates whether or not the device type is 'phone'. */ - phone?: boolean; - /** Specifies the platform of the device on which the application is running. */ - platform?: string; - /** Indicates whether or not the device type is 'tablet'. */ - tablet?: boolean; - /** Specifies an array with the major and minor versions of the device platform. */ - version?: Array; - /** Indicates whether or not the device platform is Windows8. */ - win8?: boolean; - /** Specifies a performance grade of the current device. */ - grade?: string; - } - export class Devices implements EventsMixin { - constructor(options: { window: Window }); - /** Overrides actual device information to force the application to operate as if it was running on the specified device. */ - current(deviceName: any): void; - /** Returns information about the current device. */ - current(): Device; - orientationChanged: JQueryCallback; - /** Returns the current device orientation. */ - orientation(): string; - /** Returns real information about the current device regardless of the value passed to the devices.current(deviceName) method. */ - real(): Device; - on(eventName: "orientationChanged", eventHandler: (e: { orientation: string }) => void): Devices; - on(eventName: string, eventHandler: Function): Devices; - on(events: { [eventName: string]: Function; }): Devices; - off(eventName: "orientationChanged"): Devices; - off(eventName: string): Devices; - off(eventName: "orientationChanged", eventHandler: (e: { orientation: string }) => void): Devices; - off(eventName: string, eventHandler: Function): Devices; - } - /** An object that serves as a namespace for the methods and events specifying information on the current device. */ - export var devices: Devices; - /** The position object specifies the widget positioning options. */ - export interface PositionOptions { - /** The target element position that the widget is positioned against. */ - at?: string; - /** The element within which the widget is positioned. */ - boundary?: Element; - /** A string value holding horizontal and vertical offset from the window's boundaries. */ - boundaryOffset?: string; - /** Specifies how to move the widget if it overflows the screen. */ - collision?: any; - /** The position of the widget to align against the target element. */ - my?: string; - /** The target element that the widget is positioned against. */ - of?: HTMLElement; - /** A string value holding horizontal and vertical offset in pixels, separated by a space (e.g., "5 -10"). */ - offset?: string; - } - export interface ComponentOptions { - /** A handler for the initialized event. */ - onInitialized?: Function; - /** A handler for the optionChanged event. */ - onOptionChanged?: Function; - /** A handler for the disposing event. */ - onDisposing?: Function; - } - /** A base class for all components and widgets. */ - export class Component { - constructor(options?: ComponentOptions) - /** Prevents the component from refreshing until the endUpdate method is called. */ - beginUpdate(): void; - /** Enables the component to refresh after the beginUpdate method call. */ - endUpdate(): void; - /** Returns an instance of this component class. */ - instance(): Component; - /** Sets one or more options of this component. */ - option(options: Object): void; - /** Returns the configuration options of this component. */ - option(): Object; - /** Gets the value of the specified configuration option of this component. */ - option(optionName: string): any; - /** Sets a value to the specified configuration option of this component. */ - option(optionName: string, optionValue: any): void; - } - export interface DOMComponentOptions extends ComponentOptions { - /** Specifies whether or not the current component supports a right-to-left representation. */ - rtlEnabled?: boolean; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies the width of the widget. */ - width?: any; - } - /** A base class for all components. */ - export class DOMComponent extends Component { - constructor(element: JQuery, options?: DOMComponentOptions); - constructor(element: HTMLElement, options?: DOMComponentOptions); - /** Returns the root HTML element of the widget. */ - element(): JQuery; - /** Specifies the device-dependent default configuration options for this component. */ - static defaultOptions(rule: { - device?: any; - options?: any; - }): void; - } - export module data { - export interface ODataError extends Error { - httpStatus?: number; - errorDetails?: any; - } - export interface StoreOptions { - inserted?: (values: Object, key: any) => void; - inserting?: (values: Object) => void; - loaded?: (result: Array) => void; - loading?: (loadOptions: LoadOptions) => void; - modified?: () => void; - modifying?: () => void; - removed?: (key: any) => void; - removing?: (key: any) => void; - updated?: (key: any, values: Object) => void; - updating?: (key: any, values: Object) => void; - /** A handler for the modified event. */ - onModified?: () => void; - /** A handler for the modifying event. */ - onModifying?: () => void; - /** A handler for the removed event. */ - onRemoved?: (key: any) => void; - /** A handler for the removing event. */ - onRemoving?: (key: any) => void; - /** A handler for the updated event. */ - onUpdated?: (key: any, values: Object) => void; - /** A handler for the updating event. */ - onUpdating?: (key: any, values: Object) => void; - /** A handler for the loaded event. */ - onLoaded?: (result: Array) => void; - /** A handler for the loading event. */ - onLoading?: (loadOptions: LoadOptions) => void; - /** A handler for the inserted event. */ - onInserted?: (values: Object, key: any) => void; - /** A handler for the inserting event. */ - onInserting?: (values: Object) => void; - /** Specifies the function called when the Store causes an error. */ - errorHandler?: (e: Error) => void; - /** Specifies the key properties within the data associated with the Store. */ - key?: any; - } - export interface LoadOptions { - filter?: Object; - sort?: Object; - select?: Object; - expand?: Object; - group?: Object; - skip?: number; - take?: number; - userData?: Object; - requireTotalCount?: boolean; - } - /** The base class for all Stores. */ - export class Store implements EventsMixin { - inserted: JQueryCallback; - inserting: JQueryCallback; - loaded: JQueryCallback; - loading: JQueryCallback; - modified: JQueryCallback; - modifying: JQueryCallback; - removed: JQueryCallback; - removing: JQueryCallback; - updated: JQueryCallback; - updating: JQueryCallback; - constructor(options?: StoreOptions); - /** Returns the data item specified by the key. */ - byKey(key: any): JQueryPromise; - /** Adds an item to the data associated with this Store. */ - insert(values: Object): JQueryPromise; - /** Returns the key expression specified via the key configuration option. */ - key(): any; - /** Returns the key of the Store item that matches the specified object. */ - keyOf(obj: Object): any; - /** Starts loading data. */ - load(obj?: LoadOptions): JQueryPromise; - /** Removes the data item specified by the key. */ - remove(key: any): JQueryPromise; - /** Obtains the total count of items that will be returned by the load() function. */ - totalCount(options?: { - filter?: Object; - group?: Object; - }): JQueryPromise; - /** Updates the data item specified by the key. */ - update(key: any, values: Object): JQueryPromise; - on(eventName: "removing", eventHandler: (key: any) => void): Store; - on(eventName: "removed", eventHandler: (key: any) => void): Store; - on(eventName: "updating", eventHandler: (key: any, values: Object) => void): Store; - on(eventName: "updated", eventHandler: (key: any, values: Object) => void): Store; - on(eventName: "inserting", eventHandler: (values: Object) => void): Store; - on(eventName: "inserted", eventHandler: (values: Object, key: any) => void): Store; - on(eventName: "modifying", eventHandler: () => void): Store; - on(eventName: "modified", eventHandler: () => void): Store; - on(eventName: "loading", eventHandler: (loadOptions: LoadOptions) => void): Store; - on(eventName: "loaded", eventHandler: (result: Array) => void): Store; - on(eventName: string, eventHandler: Function): Store; - on(events: { [eventName: string]: Function; }): Store; - off(eventName: "removing"): Store; - off(eventName: "removed"): Store; - off(eventName: "updating"): Store; - off(eventName: "updated"): Store; - off(eventName: "inserting"): Store; - off(eventName: "inserted"): Store; - off(eventName: "modifying"): Store; - off(eventName: "modified"): Store; - off(eventName: "loading"): Store; - off(eventName: "loaded"): Store; - off(eventName: string): Store; - off(eventName: "removing", eventHandler: (key: any) => void): Store; - off(eventName: "removed", eventHandler: (key: any) => void): Store; - off(eventName: "updating", eventHandler: (key: any, values: Object) => void): Store; - off(eventName: "updated", eventHandler: (key: any, values: Object) => void): Store; - off(eventName: "inserting", eventHandler: (values: Object) => void): Store; - off(eventName: "inserted", eventHandler: (values: Object, key: any) => void): Store; - off(eventName: "modifying", eventHandler: () => void): Store; - off(eventName: "modified", eventHandler: () => void): Store; - off(eventName: "loading", eventHandler: (loadOptions: LoadOptions) => void): Store; - off(eventName: "loaded", eventHandler: (result: Array) => void): Store; - off(eventName: string, eventHandler: Function): Store; - } - export interface ArrayStoreOptions extends StoreOptions { - /** Specifies the array associated with this Store. */ - data?: Array; - } - /** A Store accessing an in-memory array. */ - export class ArrayStore extends Store { - constructor(options?: ArrayStoreOptions); - /** Clears all data associated with the current ArrayStore. */ - clear(): void; - /** Creates the Query object for the underlying array. */ - createQuery(): Query; - } - interface Promise { - then(doneFn?: Function, failFn?: Function, progressFn?: Function): Promise; - } - export interface CustomStoreOptions extends StoreOptions { - /** The user implementation of the byKey(key, extraOptions) method. */ - byKey?: (key: any) => Promise; - /** The user implementation of the insert(values) method. */ - insert?: (values: Object) => Promise; - /** The user implementation of the load(options) method. */ - load?: (options?: LoadOptions) => Promise; - /** The user implementation of the remove(key) method. */ - remove?: (key: any) => Promise; - /** The user implementation of the totalCount(options) method. */ - totalCount?: (options?: { - filter?: Object; - group?: Object; - }) => Promise; - /** The user implementation of the update(key, values) method. */ - update?: (key: any, values: Object) => Promise; - } - /** A Store object that enables you to implement your own data access logic. */ - export class CustomStore extends Store { - constructor(options: CustomStoreOptions); - } - export interface DataSourceOptions { - /** Specifies data filtering conditions. */ - filter?: Object; - /** Specifies data grouping conditions. */ - group?: Object; - /** The item mapping function. */ - map?: (record: any) => any; - /** Specifies the maximum number of items the page can contain. */ - pageSize?: number; - /** Specifies whether a DataSource loads data by pages, or all items at once. */ - paginate?: boolean; - /** The data post processing function. */ - postProcess?: (data: any[]) => any[]; - /** Specifies a value by which the required items are searched. */ - searchExpr?: Object; - /** Specifies the comparison operation used to search for the required items. */ - searchOperation?: string; - /** Specifies the value to which the search expression is compared. */ - searchValue?: Object; - /** Specifies the initial select option value. */ - select?: Object; - /** An array of the strings that represent the names of the navigation properties to be loaded simultaneously with the OData store's entity. */ - expand?: Object; - /** Specifies whether or not the DataSource instance requests the total count of items available in the storage. */ - requireTotalCount?: boolean; - /** Specifies the initial sort option value. */ - sort?: Object; - /** Specifies the underlying Store instance used to access data. */ - store?: any; - /** A handler for the changed event. */ - onChanged?: () => void; - /** A handler for the loadingChanged event. */ - onLoadingChanged?: (isLoading: boolean) => void; - /** A handler for the loadError event. */ - onLoadError?: (e?: Error) => void; - } - /** An object that provides access to a data web service or local data storage for collection container widgets. */ - export class DataSource implements EventsMixin { - constructor(options?: DataSourceOptions); - changed: JQueryCallback; - loadError: JQueryCallback; - loadingChanged: JQueryCallback; - /** Disposes all resources associated with this DataSource. */ - dispose(): void; - /** Returns the current filter option value. */ - filter(): Object; - /** Sets the filter option value. */ - filter(filterExpr: Object): void; - /** Returns the current group option value. */ - group(): Object; - /** Sets the group option value. */ - group(groupExpr: Object): void; - /** Indicates whether or not the current page contains fewer items than the number of items specified by the pageSize configuration option. */ - isLastPage(): boolean; - /** Indicates whether or not at least one load() method execution has successfully finished. */ - isLoaded(): boolean; - /** Indicates whether or not the DataSource is currently being loaded. */ - isLoading(): boolean; - /** Returns the array of items currently operated by the DataSource. */ - items(): Array; - /** Returns the key expression. */ - key(): any; - /** Starts loading data. */ - load(): JQueryPromise>; - /** Returns an object that would be passed to the load() method of the underlying Store according to the current data shaping option values of the current DataSource instance. */ - loadOptions(): Object; - /** Returns the current pageSize option value. */ - pageSize(): number; - /** Sets the pageSize option value. */ - pageSize(value: number): void; - /** Specifies the index of the currently loaded page. */ - pageIndex(): number; - /** Specifies the index of the page to be loaded during the next load() method execution. */ - pageIndex(newIndex: number): void; - /** Returns the current paginate option value. */ - paginate(): boolean; - /** Sets the paginate option value. */ - paginate(value: boolean): void; - /** Returns the searchExpr option value. */ - searchExpr(): Object; - /** Sets the searchExpr option value. */ - searchExpr(expr: Object): void; - /** Returns the currently specified search operation. */ - searchOperation(): string; - /** Sets the current search operation. */ - searchOperation(op: string): void; - /** Returns the searchValue option value. */ - searchValue(): Object; - /** Sets the searchValue option value. */ - searchValue(value: Object): void; - /** Returns the current select option value. */ - select(): Object; - /** Sets the select option value. */ - select(expr: Object): void; - /** Returns the current requireTotalCount option value. */ - requireTotalCount(): boolean; - /** Sets the requireTotalCount option value. */ - requireTotalCount(value: boolean): void; - /** Returns the current sort option value. */ - sort(): Object; - /** Sets the sort option value. */ - sort(sortExpr: Object): void; - /** Returns the underlying Store instance. */ - store(): Store; - /** Returns the number of data items available in an underlying Store after the last load() operation without paging. */ - totalCount(): number; - on(eventName: "loadingChanged", eventHandler: (isLoading: boolean) => void): DataSource; - on(eventName: "loadError", eventHandler: (e?: Error) => void): DataSource; - on(eventName: "changed", eventHandler: () => void): DataSource; - on(eventName: string, eventHandler: Function): DataSource; - on(events: { [eventName: string]: Function; }): DataSource; - off(eventName: "loadingChanged"): DataSource; - off(eventName: "loadError"): DataSource; - off(eventName: "changed"): DataSource; - off(eventName: string): DataSource; - off(eventName: "loadingChanged", eventHandler: (isLoading: boolean) => void): DataSource; - off(eventName: "loadError", eventHandler: (e?: Error) => void): DataSource; - off(eventName: "changed", eventHandler: () => void): DataSource; - off(eventName: string, eventHandler: Function): DataSource; - } - /** An object used to work with primitive data types not supported by JavaScript when accessing an OData web service. */ - export class EdmLiteral { - /** Creates an EdmLiteral instance and assigns the specified value to it. */ - constructor(value: string); - /** Returns a string representation of the value associated with this EdmLiteral object. */ - valueOf(): string; - } - /** An object used to generate and hold the GUID. */ - export class Guid { - /** Creates a new Guid instance that holds the specified GUID. */ - constructor(value: string); - /** Creates a new Guid instance holding the generated GUID. */ - constructor(); - /** Returns a string representation of the Guid instance. */ - toString(): string; - /** Returns a string representation of the Guid instance. */ - valueOf(): string; - } - export interface LocalStoreOptions extends ArrayStoreOptions { - /** Specifies the time (in miliseconds) after the change operation, before the data is flushed. */ - flushInterval?: number; - /** Specifies whether the data is flushed immediatelly after each change operation, or after the delay specified via the flushInterval option. */ - immediate?: boolean; - /** The unique identifier used to distinguish the data within the HTML5 Web Storage. */ - name?: string; - } - /** A Store providing access to the HTML5 Web Storage. */ - export class LocalStore extends ArrayStore { - constructor(options?: LocalStoreOptions); - /** Removes all data associated with this Store. */ - clear(): void; - } - export interface ODataContextOptions extends ODataStoreOptions { - /** Specifies the list of entities to be accessed via the ODataContext. */ - entities?: Object; - /** Specifies the function called if the ODataContext causes an error. */ - errorHandler?: (e: Error) => void; - } - /** Provides access to the entire OData service. */ - export class ODataContext { - constructor(options?: ODataContextOptions); - /** Initiates the specified WebGet service operation that returns a value. For the information on service operations, refer to the OData documentation. */ - get(operationName: string, params: Object): JQueryPromise; - /** Initiates the specified WebGet service operation that returns nothing. For the information on service operations, refer to the OData documentation. */ - invoke(operationName: string, params: Object, httpMethod: Object): JQueryPromise; - /** Return a special proxy object to describe the entity link. */ - objectLink(entityAlias: string, key: any): Object; - } - export interface ODataStoreOptions extends StoreOptions { - /** A function used to customize a web request before it is sent. */ - beforeSend?: (request: { - url: string; - method: string; - timeout: number; - params: Object; - payload: Object; - headers: Object; - }) => void; - /** Specifies whether the ODataStore uses the JSONP approach to access non-CORS-compatible remote services. */ - jsonp?: boolean; - /** Specifies the type of the ODataStore key property. The following key types are supported out of the box: String, Int32, Int64, and Guid. */ - keyType?: any; - /** Specifies the URL of the data service being accessed via the current ODataContext. */ - url?: string; - /** Specifies the version of the OData protocol used to interact with the data service. */ - version?: number; - /** Specifies the value of the withCredentials field of the underlying jqXHR object. */ - withCredentials?: boolean; - } - /** A Store providing access to a separate OData web service entity. */ - export class ODataStore extends Store { - constructor(options?: ODataStoreOptions); - /** Creates the Query object for the OData endpoint. */ - createQuery(loadOptions: Object): Object; - /** Returns the data item specified by the key. */ - byKey(key: any, extraOptions?: { expand?: Object }): JQueryPromise; - } - /** An universal chainable data query interface object. */ - export interface Query { - /** Calculates a custom summary for the items in the current Query. */ - aggregate(step: (accumulator: any, value: any) => any): JQueryPromise; - /** Calculates a custom summary for the items in the current Query. */ - aggregate(seed: any, step: (accumulator: any, value: any) => any, finalize: (result: any) => any): JQueryPromise; - /** Calculates the average item value for the current Query. */ - avg(getter: Object): JQueryPromise; - /** Finds the item with the maximum getter value. */ - max(getter: Object): JQueryPromise; - /** Finds the item with the maximum value in the Query. */ - max(): JQueryPromise; - /** Finds the item with the minimum value in the Query. */ - min(): JQueryPromise; - /** Finds the item with the minimum getter value. */ - min(getter: Object): JQueryPromise; - /** Calculates the average item value for the current Query, if each Query item has a numeric type. */ - avg(): JQueryPromise; - /** Returns the total count of items in the current Query. */ - count(): JQueryPromise; - /** Executes the Query. */ - enumerate(): JQueryPromise; - /** Filters the current Query data. */ - filter(criteria: Array): Query; - /** Groups the current Query data. */ - groupBy(getter: Object): Query; - /** Applies the specified transformation to each item. */ - select(getter: Object): Query; - /** Limits the data item count. */ - slice(skip: number, take?: number): Query; - /** Sorts current Query data. */ - sortBy(getter: Object, desc: boolean): Query; - /** Sorts current Query data. */ - sortBy(getter: Object): Query; - /** Calculates the sum of item getter values in the current Query. */ - sum(getter: Object): JQueryPromise; - /** Calculates the sum of item values in the current Query. */ - sum(): JQueryPromise; - /** Adds one more sorting condition to the current Query. */ - thenBy(getter: Object): Query; - /** Adds one more sorting condition to the current Query. */ - thenBy(getter: Object, desc: boolean): Query; - /** Returns the array of current Query items. */ - toArray(): Array; - } - /** The global data layer error handler. */ - export var errorHandler: (e: Error) => void; - /** Encodes the specified string or array of bytes to base64 encoding. */ - export function base64_encode(input: any): string; - /** Creates a Query instance. */ - export function query(array: Array): Query; - /** Creates a Query instance for accessing the remote service specified by a URL. */ - export function query(url: string, queryOptions: Object): Query; - /** This section describes the utility objects provided by the DevExtreme data layer. */ - export var utils: { - /** Compiles a getter function from the getter expression. */ - compileGetter(expr: any): Function; - /** Compiles a setter function from the setter expression. */ - compileSetter(expr: any): Function; - odata: { - /** Holds key value converters for OData. */ - keyConverters: { - String(value: any): string; - Int32(value: any): number; - Int64(value: any): EdmLiteral; - Guid(value: any): Guid; - Boolean(value: any): boolean; - Single(value: any): EdmLiteral; - Decimal(value: any): EdmLiteral; - }; - } - } - } - /** An object that serves as a namespace for DevExtreme UI widgets as well as for methods implementing UI logic in DevExtreme sites/applications. */ - export module ui { - export interface WidgetOptions extends DOMComponentOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A Boolean value specifying whether or not the widget can respond to user interaction. */ - disabled?: boolean; - /** A Boolean value specifying whether or not the widget changes its state when being hovered by an end user. */ - hoverStateEnabled?: boolean; - /** Specifies whether or not the widget can be focused. */ - focusStateEnabled?: boolean; - /** Specifies a shortcut key that sets focus on the widget element. */ - accessKey?: string; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - /** Specifies the widget tab index. */ - tabIndex?: number; - /** Specifies the text of the hint displayed for the widget. */ - hint?: string; - } - /** The base class for widgets. */ - export class Widget extends DOMComponent { - constructor(options?: WidgetOptions); - /** Redraws the widget. */ - repaint(): void; - /** Sets focus on the widget. */ - focus(): void; - /** Registers a handler when a specified key is pressed. */ - registerKeyHandler(key: string, handler: Function): void; - } - export interface CollectionWidgetOptions extends WidgetOptions { - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - itemClickAction?: any; - itemHoldAction?: Function; - /** The time period in milliseconds before the onItemHold event is raised. */ - itemHoldTimeout?: number; - itemRender?: any; - itemRenderedAction?: Function; - /** An array of items displayed by the widget. */ - items?: Array; - /** - * A function performed when a widget item is selected. - * @deprecated onSelectionChanged.md - */ - itemSelectAction?: Function; - /** The template to be used for rendering items. */ - itemTemplate?: any; - loopItemFocus?: boolean; - /** The text or HTML markup displayed by the widget if the item collection is empty. */ - noDataText?: string; - onContentReady?: any; - contentReadyAction?: any; - /** A handler for the itemClick event. */ - onItemClick?: any; - /** A handler for the itemContextMenu event. */ - onItemContextMenu?: Function; - /** A handler for the itemHold event. */ - onItemHold?: Function; - /** A handler for the itemRendered event. */ - onItemRendered?: Function; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: Function; - /** The index of the currently selected widget item. */ - selectedIndex?: number; - /** The selected item object. */ - selectedItem?: Object; - /** An array of currently selected item objects. */ - selectedItems?: Array; - /** A handler for the itemDeleting event. */ - onItemDeleting?: Function; - /** A handler for the itemDeleted event. */ - onItemDeleted?: Function; - /** A handler for the itemReordered event. */ - onItemReordered?: Function; - } - /** The base class for widgets containing an item collection. */ - export class CollectionWidget extends Widget { - constructor(element: JQuery, options?: CollectionWidgetOptions); - constructor(element: HTMLElement, options?: CollectionWidgetOptions); - selectItem(itemElement: any): void; - unselectItem(itemElement: any): void; - deleteItem(itemElement: any): JQueryPromise; - isItemSelected(itemElement: any): boolean; - reorderItem(itemElement: any, toItemElement: any): JQueryPromise; - } - export interface DataExpressionMixinOptions { - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** Specifies the name of the data source item field whose value is displayed by the widget. */ - displayExpr?: any; - /** Specifies the name of a data source item field whose value is held in the value configuration option. */ - valueExpr?: any; - itemRender?: any; - /** An array of items displayed by the widget. */ - items?: Array; - /** The template to be used for rendering items. */ - itemTemplate?: any; - /** The currently selected value in the widget. */ - value?: Object; - } - export interface EditorOptions extends WidgetOptions { - /** The currently specified value. */ - value?: Object; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - valueChangeAction?: Function; - /** A Boolean value specifying whether or not the widget is read-only. */ - readOnly?: boolean; - /** Holds the object that defines the error that occurred during validation. */ - validationError?: Object; - /** Specifies whether the editor's value is valid. */ - isValid?: boolean; - /** Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed. */ - validationMessageMode?: string; - } - /** A base class for editors. */ - export class Editor extends Widget { - /** Resets the editor's value to undefined. */ - reset(): void; - } - /** An object that serves as a namespace for methods displaying a message in an application/site. */ - export var dialog: { - /** Creates an alert dialog message containing a single "OK" button. */ - alert(message: string, title: string): JQueryPromise; - /** Creates a confirm dialog that contains "Yes" and "No" buttons. */ - confirm(message: string, title: string): JQueryPromise; - /** Creates a custom dialog using the options specified by the passed configuration object. */ - custom(options: { title?: string; message?: string; buttons?: Array; }): { - show(): JQueryPromise; - hide(): void; - hide(value: any): void; - }; - }; - /** Creates a toast message. */ - export function notify(message: any, type: string, displayTime: number): void; - /** Creates a toast message. */ - export function notify(options: Object): void; - /** An object that serves as a namespace for the methods that work with DevExtreme CSS Themes. */ - export var themes: { - /** Returns the name of the currently applied theme. */ - current(): string; - /** Changes the current theme to the specified one. */ - current(themeName: string): void; - }; - /** Sets a specified template engine. */ - export function setTemplateEngine(name: string): void; - /** Sets a custom template engine defined via custom compile and render functions. */ - export function setTemplateEngine(options: Object): void; - } - /** An object that serves as a namespace for utility methods that can be helpful when working with the DevExtreme framework and UI widgets. */ - export var utils: { - /** Sets parameters for the viewport meta tag. */ - initMobileViewport(options: { allowZoom?: boolean; allowPan?: boolean; allowSelection?: boolean }): void; - }; - /** An object that serves as a namespace for DevExtreme Data Visualization Widgets. */ - export module viz { - /** Applies a theme for the entire page with several DevExtreme visualization widgets. */ - export function currentTheme(theme: string): void; - /** Applies a new theme (with the color scheme defined separately) for the entire page with several DevExtreme visualization widgets. */ - export function currentTheme(platform: string, colorScheme: string): void; - /** Registers a new theme based on the existing one. */ - export function registerTheme(customTheme: Object, baseTheme: string): void; - /** Applies a predefined or registered custom palette to all visualization widgets at once. */ - export function currentPalette(paletteName: string): void; - /** Obtains the color sets of a predefined or registered palette. */ - export function getPalette(paletteName: string): Object; - /** Registers a new palette. */ - export function registerPalette(paletteName: string, palette: Object): void; - } -} -declare namespace DevExpress.ui { - export interface dxValidatorOptions extends DOMComponentOptions { - /** An array of validation rules to be checked for the editor with which the dxValidator object is associated. */ - validationRules?: Array; - /** Specifies the editor name to be used in the validation default messages. */ - name?: string; - /** An object that specifies what and when to validate and how to apply the validation result. */ - adapter?: Object; - /** Specifies the validation group the editor will be related to. */ - validationGroup?: string; - /** A handler for the validated event. */ - onValidated?: (params: validationEngine.ValidatorValidationResult) => void; - } - /** A widget that is used to validate the associated DevExtreme editors against the defined validation rules. */ - export class dxValidator extends DOMComponent implements validationEngine.IValidator { - constructor(element: JQuery, options?: dxValidatorOptions); - constructor(element: Element, options?: dxValidatorOptions); - /** Validates the value of the editor that is controlled by the current dxValidator object against the list of the specified validation rules. */ - validate(): validationEngine.ValidatorValidationResult; - /** Resets the value and validation result of the editor associated with the current dxValidator object. */ - reset(): void; - } - /** The widget that is used in the Knockout and Angular approaches to combine the editors to be validated. */ - export class dxValidationGroup extends DOMComponent { - constructor(element: JQuery); - constructor(element: Element); - /** Validates rules of the validators that belong to the current validation group. */ - validate(): validationEngine.ValidationGroupValidationResult; - /** Resets the value and validation result of the editors that are included to the current validation group. */ - reset(): void; - } - export interface dxValidationSummaryOptions extends CollectionWidgetOptions { - /** Specifies the validation group for which summary should be generated. */ - validationGroup?: string; - } - /** A widget for displaying the result of checking validation rules for editors. */ - export class dxValidationSummary extends CollectionWidget { - constructor(element: JQuery, options?: dxValidationSummaryOptions); - constructor(element: Element, options?: dxValidationSummaryOptions); - } - export interface dxResizableOptions extends DOMComponentOptions { - /** Specifies which borders of the widget element are used as a handle. */ - handles?: string; - /** Specifies the lower width boundary for resizing. */ - minWidth?: number; - /** Specifies the upper width boundary for resizing. */ - maxWidth?: number; - /** Specifies the lower height boundary for resizing. */ - minHeight?: number; - /** Specifies the upper height boundary for resizing. */ - maxHeight?: number; - /** A handler for the resizeStart event. */ - onResizeStart?: Function; - /** A handler for the resize event. */ - onResize?: Function; - /** A handler for the resizeEnd event. */ - onResizeEnd?: Function; - } - /** A widget that displays required content in a resizable element. */ - export class dxResizable extends DOMComponent { - constructor(element: JQuery, options?: dxResizableOptions); - constructor(element: Element, options?: dxResizableOptions); - } - export interface dxTooltipOptions extends dxPopoverOptions { - } - /** A tooltip widget. */ - export class dxTooltip extends dxPopover { - constructor(element: JQuery, options?: dxTooltipOptions); - constructor(element: Element, options?: dxTooltipOptions); - } - export interface dxDropDownListOptions extends dxDropDownEditorOptions, DataExpressionMixinOptions { - /** Returns the value currently displayed by the widget. */ - displayValue?: string; - /** The minimum number of characters that must be entered into the text box to begin a search. */ - minSearchLength?: number; - /** Specifies the name of a data source item field or an expression whose value is compared to the search criterion. */ - searchExpr?: Object; - /** Specifies the binary operation used to filter data. */ - searchMode?: string; - /** Specifies the time delay, in milliseconds, after the last character has been typed in, before a search is executed. */ - searchTimeout?: number; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - /** Specifies DOM event names that update a widget's value. */ - valueChangeEvent?: string; - /** Specifies whether or not the widget supports searching. */ - searchEnabled?: boolean; - /** - * Specifies whether or not the widget displays items by pages. - * @deprecated dataSource.paginate.md - */ - pagingEnabled?: boolean; - /** The text or HTML markup displayed by the widget if the item collection is empty. */ - noDataText?: string; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: Function; - /** A handler for the itemClick event. */ - onItemClick?: Function; - onContentReady?: Function; - } - /** A base class for drop-down list widgets. */ - export class dxDropDownList extends dxDropDownEditor { - constructor(element: JQuery, options?: dxDropDownListOptions); - constructor(element: Element, options?: dxDropDownListOptions); - } - export interface dxToolbarOptions extends CollectionWidgetOptions { - menuItemRender?: any; - /** The template used to render menu items. */ - menuItemTemplate?: any; - /** Informs the widget about its location in a view HTML markup. */ - renderAs?: string; - } - /** A toolbar widget. */ - export class dxToolbar extends CollectionWidget { - constructor(element: JQuery, options?: dxToolbarOptions); - constructor(element: Element, options?: dxToolbarOptions); - } - export interface dxToastOptions extends dxOverlayOptions { - animation?: fx.AnimationOptions; - /** The time span in milliseconds during which the dxToast widget is visible. */ - displayTime?: number; - height?: any; - /** The dxToast message text. */ - message?: string; - position?: PositionOptions; - shading?: boolean; - /** Specifies the dxToast widget type. */ - type?: string; - width?: any; - closeOnBackButton?: boolean; - } - /** The toast message widget. */ - export class dxToast extends dxOverlay { - constructor(element: JQuery, options?: dxToastOptions); - constructor(element: Element, options?: dxToastOptions); - } - export interface dxTextEditorOptions extends EditorOptions { - /** A handler for the change event. */ - onChange?: Function; - changeAction?: Function; - /** A handler for the copy event. */ - onCopy?: Function; - copyAction?: Function; - /** A handler for the cut event. */ - onCut?: Function; - cutAction?: Function; - /** A handler for the enterKey event. */ - onEnterKey?: Function; - enterKeyAction?: Function; - /** A handler for the focusIn event. */ - onFocusIn?: Function; - focusInAction?: Function; - /** A handler for the focusOut event. */ - onFocusOut?: Function; - focusOutAction?: Function; - /** A handler for the input event. */ - onInput?: Function; - inputAction?: Function; - /** A handler for the keyDown event. */ - onKeyDown?: Function; - keyDownAction?: Function; - /** A handler for the keyPress event. */ - onKeyPress?: Function; - keyPressAction?: Function; - /** A handler for the keyUp event. */ - onKeyUp?: Function; - keyUpAction?: Function; - /** A handler for the paste event. */ - onPaste?: Function; - pasteAction?: Function; - /** The text displayed by the widget when the widget value is empty. */ - placeholder?: string; - /** Specifies whether to display the Clear button in the widget. */ - showClearButton?: boolean; - /** Specifies the current value displayed by the widget. */ - value?: any; - /** Specifies DOM event names that update a widget's value. */ - valueChangeEvent?: string; - /** Specifies whether or not the widget checks the inner text for spelling mistakes. */ - spellcheck?: boolean; - /** Specifies HTML attributes applied to the inner input element of the widget. */ - attr?: Object; - /** The read-only option that holds the text displayed by the widget input element. */ - text?: string; - /** Specifies whether or not the widget supports the focused state and keyboard navigation. */ - focusStateEnabled?: boolean; - /** A Boolean value specifying whether or not the widget changes its state when being hovered by an end user. */ - hoverStateEnabled?: boolean; - /** The editor mask that specifies the format of the entered string. */ - mask?: string; - /** Specifies a mask placeholder character. */ - maskChar?: string; - /** Specifies custom mask rules. */ - maskRules?: Object; - /** A message displayed when the entered text does not match the specified pattern. */ - maskInvalidMessage?: string; - } - /** A base class for text editing widgets. */ - export class dxTextEditor extends Editor { - constructor(element: JQuery, options?: dxTextEditorOptions); - constructor(element: Element, options?: dxTextEditorOptions); - /** Removes focus from the input element. */ - blur(): void; - /** Sets focus to the input element representing the widget. */ - focus(): void; - } - export interface dxTextBoxOptions extends dxTextEditorOptions { - /** Specifies the maximum number of characters you can enter into the textbox. */ - maxLength?: any; - /** The "mode" attribute value of the actual HTML input element representing the text box. */ - mode?: string; - } - /** A single-line text box widget. */ - export class dxTextBox extends dxTextEditor { - constructor(element: JQuery, options?: dxTextBoxOptions); - constructor(element: Element, options?: dxTextBoxOptions); - } - export interface dxTextAreaOptions extends dxTextBoxOptions { - /** Specifies whether or not the widget checks the inner text for spelling mistakes. */ - spellcheck?: boolean; - } - /** A widget used to display and edit multi-line text. */ - export class dxTextArea extends dxTextBox { - constructor(element: JQuery, options?: dxTextAreaOptions); - constructor(element: Element, options?: dxTextAreaOptions); - } - export interface dxTabsOptions extends CollectionWidgetOptions { - /** Specifies whether the widget enables an end-user to select only a single item or multiple items. */ - selectionMode?: string; - /** Specifies whether or not an end-user can scroll tabs by swiping. */ - scrollByContent?: boolean; - /** Specifies whether or not an end-user can scroll tabs. */ - scrollingEnabled?: boolean; - /** A Boolean value that specifies the availability of navigation buttons. */ - showNavButtons?: boolean; - } - /** A tab strip used to switch between pages. */ - export class dxTabs extends CollectionWidget { - constructor(element: JQuery, options?: dxTabsOptions); - constructor(element: Element, options?: dxTabsOptions); - } - export interface dxTabPanelOptions extends dxMultiViewOptions { - /** A handler for the titleClick event. */ - onTitleClick?: any; - /** A handler for the titleHold event. */ - onTitleHold?: Function; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - titleTemplate?: any; - /** The template to be used for rendering an item title. */ - itemTitleTemplate?: any; - } - /** A widget used to display a view and to switch between several views by clicking the appropriate tabs. */ - export class dxTabPanel extends dxMultiView { - constructor(element: JQuery, options?: dxTabPanelOptions); - constructor(element: Element, options?: dxTabPanelOptions); - } - export interface dxSelectBoxOptions extends dxDropDownListOptions { - /** The template to be used for rendering the widget text field. */ - fieldTemplate?: any; - /** The text that is provided as a hint in the select box editor. */ - placeholder?: string; - /** Specifies whether or not the widget allows an end-user to enter a custom value. */ - fieldEditEnabled?: boolean; - } - /** A widget that allows you to select an item in a dropdown list. */ - export class dxSelectBox extends dxDropDownList { - constructor(element: JQuery, options?: dxSelectBoxOptions); - constructor(element: Element, options?: dxSelectBoxOptions); - } - export interface dxTagBoxOptions extends dxSelectBoxOptions { - /** Holds the list of selected values. */ - values?: Array; - } - /** A widget that allows you to select multiple items from a dropdown list. */ - export class dxTagBox extends dxSelectBox { - constructor(element: JQuery, options?: dxTagBoxOptions); - constructor(element: Element, options?: dxTagBoxOptions); - } - export interface dxScrollViewOptions extends dxScrollableOptions { - /** A handler for the pullDown event. */ - onPullDown?: Function; - pullDownAction?: Function; - /** Specifies the text shown in the pullDown panel when pulling the content down lowers the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while pulling the content down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the reachBottom event. */ - onReachBottom?: Function; - reachBottomAction?: Function; - /** Specifies the text shown in the pullDown panel displayed when content is scrolled to the bottom. */ - reachBottomText?: string; - /** Specifies the text shown in the pullDown panel displayed when the content is being refreshed. */ - refreshingText?: string; - /** Returns a value indicating if the scrollView content is larger then the widget container. */ - isFull(): boolean; - /** Locks the widget until the release(preventScrollBottom) method is called and executes the function passed to the onPullDown option and the handler assigned to the pullDown event. */ - refresh(): void; - /** Notifies the scroll view that data loading is finished. */ - release(preventScrollBottom: boolean): JQueryPromise; - /** Toggles the loading state of the widget. */ - toggleLoading(showOrHide: boolean): void; - } - /** A widget used to display scrollable content. */ - export class dxScrollView extends dxScrollable { - constructor(element: JQuery, options?: dxScrollViewOptions); - constructor(element: Element, options?: dxScrollViewOptions); - } - export interface dxScrollableLocation { - top?: number; - left?: number; - } - export interface dxScrollableOptions extends DOMComponentOptions { - /** A string value specifying the available scrolling directions. */ - direction?: string; - /** A Boolean value specifying whether or not the widget can respond to user interaction. */ - disabled?: boolean; - /** A handler for the scroll event. */ - onScroll?: Function; - scrollAction?: Function; - /** Specifies when the widget shows the scrollbar. */ - showScrollbar?: string; - /** A handler for the update event. */ - onUpdated?: Function; - updateAction?: Function; - /** Indicates whether to use native or simulated scrolling. */ - useNative?: boolean; - /** A Boolean value specifying whether to enable or disable the bounce-back effect. */ - bounceEnabled?: boolean; - /** A Boolean value specifying whether or not an end-user can scroll the widget content swiping it up or down. */ - scrollByContent?: boolean; - /** A Boolean value specifying whether or not an end-user can scroll the widget content using the scrollbar. */ - scrollByThumb?: boolean; - } - /** A widget used to display scrollable content. */ - export class dxScrollable extends DOMComponent { - constructor(element: JQuery, options?: dxScrollableOptions); - constructor(element: Element, options?: dxScrollableOptions); - /** Returns the height of the scrollable widget in pixels. */ - clientHeight(): number; - /** Returns the width of the scrollable widget in pixels. */ - clientWidth(): number; - /** Returns an HTML element of the widget. */ - content(): JQuery; - /** Scrolls the widget content by the specified number of pixels. */ - scrollBy(distance: number): void; - /** Scrolls widget content by the specified number of pixels in horizontal and vertical directions. */ - scrollBy(distanceObject: dxScrollableLocation): void; - /** Returns the height of the scrollable content in pixels. */ - scrollHeight(): number; - /** Returns the current scroll position against the leftmost position. */ - scrollLeft(): number; - /** Returns how far the scrollable content is scrolled from the top and from the left. */ - scrollOffset(): dxScrollableLocation; - /** Scrolls widget content to the specified position. */ - scrollTo(targetLocation: number): void; - /** Scrolls widget content to a specified position. */ - scrollTo(targetLocation: dxScrollableLocation): void; - /** Scrolls widget content to the specified element. */ - scrollToElement(element: Element): void; - /** Returns the current scroll position against the topmost position. */ - scrollTop(): number; - /** Returns the width of the scrollable content in pixels. */ - scrollWidth(): number; - /** Updates the dimensions of the scrollable contents. */ - update(): void; - } - export interface dxRadioGroupOptions extends CollectionWidgetOptions, DataExpressionMixinOptions { - /** Specifies the radio group layout. */ - layout?: string; - } - /** A widget that enables a user to select one item within a list of items represented by radio buttons. */ - export class dxRadioGroup extends CollectionWidget { - constructor(element: JQuery, options?: dxRadioGroupOptions); - constructor(element: Element, options?: dxRadioGroupOptions); - } - export interface dxPopupOptions extends dxOverlayOptions { - animation?: fx.AnimationOptions; - /** Specifies whether or not to allow a user to drag the popup window. */ - dragEnabled?: boolean; - /** A Boolean value specifying whether or not to display the widget in full-screen mode. */ - fullScreen?: boolean; - position?: PositionOptions; - /** A Boolean value specifying whether or not to display the title in the popup window. */ - showTitle?: boolean; - /** The title in the overlay window. */ - title?: string; - /** A template to be used for rendering the widget title. */ - titleTemplate?: any; - width?: any; - /** Specifies items displayed on the top or bottom toolbar of the popup window. */ - buttons?: Array; - /** Specifies whether or not the widget displays the Close button. */ - showCloseButton?: boolean; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - } - /** A widget that displays required content in a popup window. */ - export class dxPopup extends dxOverlay { - constructor(element: JQuery, options?: dxPopupOptions); - constructor(element: Element, options?: dxPopupOptions); - } - export interface dxPopoverOptions extends dxPopupOptions { - /** An object defining animation options of the widget. */ - animation?: fx.AnimationOptions; - /** Specifies the height of the widget. */ - height?: any; - /** An object defining widget positioning options. */ - position?: PositionOptions; - shading?: boolean; - /** A Boolean value specifying whether or not to display the title in the overlay window. */ - showTitle?: boolean; - /** The target element associated with a popover. */ - target?: any; - /** Specifies the width of the widget. */ - width?: any; - } - /** A widget that displays the required content in a popup window. */ - export class dxPopover extends dxPopup { - constructor(element: JQuery, options?: dxPopoverOptions); - constructor(element: Element, options?: dxPopoverOptions); - /** Displays the widget for the specified target element. */ - show(target?: any): JQueryPromise; - } - export interface dxOverlayOptions extends WidgetOptions { - /** An object that defines the animation options of the widget. */ - animation?: fx.AnimationOptions; - /** A Boolean value specifying whether or not the widget is closed if a user presses the Back hardware button. */ - closeOnBackButton?: boolean; - /** A Boolean value specifying whether or not the widget is closed if a user clicks outside of the overlapping window. */ - closeOnOutsideClick?: any; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - /** Specifies whether or not an end-user can drag the widget. */ - dragEnabled?: boolean; - /** Specifies whether or not an end user can resize the widget. */ - resizeEnabled?: boolean; - /** The height of the widget in pixels. */ - height?: any; - /** A handler for the hidden event. */ - onHidden?: Function; - hiddenAction?: Function; - /** A handler for the hiding event. */ - onHiding?: Function; - hidingAction?: Function; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** A Boolean value specifying whether or not the main screen is inactive while the widget is active. */ - shading?: boolean; - /** Specifies the shading color. */ - shadingColor?: string; - /** A handler for the showing event. */ - onShowing?: Function; - showingAction?: Function; - /** A handler for the shown event. */ - onShown?: Function; - shownAction?: Function; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - /** The widget width in pixels. */ - width?: any; - } - /** A widget displaying the required content in an overlay window. */ - export class dxOverlay extends Widget { - constructor(element: JQuery, options?: dxOverlayOptions); - constructor(element: Element, options?: dxOverlayOptions); - /** An HTML element of the widget. */ - content(): JQuery; - /** Hides the widget. */ - hide(): JQueryPromise; - /** Recalculates the overlay's size and position. */ - repaint(): void; - /** Shows the widget. */ - show(): JQueryPromise; - /** Toggles the visibility of the widget. */ - toggle(showing: boolean): JQueryPromise; - /** A static method that specifies the base z-index for all overlay widgets. */ - static baseZIndex(zIndex: number): void; - } - export interface dxNumberBoxOptions extends dxTextEditorOptions { - /** The maximum value accepted by the number box. */ - max?: number; - /** The minimum value accepted by the number box. */ - min?: number; - /** Specifies whether or not to show spin buttons. */ - showSpinButtons?: boolean; - useTouchSpinButtons?: boolean; - /** Specifies by which value the widget value changes when a spin button is clicked. */ - step?: number; - /** The current number box value. */ - value?: number; - } - /** A textbox widget that enables a user to enter numeric values. */ - export class dxNumberBox extends dxTextEditor { - constructor(element: JQuery, options?: dxNumberBoxOptions); - constructor(element: Element, options?: dxNumberBoxOptions); - } - export interface dxNavBarOptions extends dxTabsOptions { - scrollingEnabled?: boolean; - } - /** A widget that contains items used to navigate through application views. */ - export class dxNavBar extends dxTabs { - constructor(element: JQuery, options?: dxNavBarOptions); - constructor(element: Element, options?: dxNavBarOptions); - } - export interface dxMultiViewOptions extends CollectionWidgetOptions { - /** Specifies whether or not to animate the displayed item change. */ - animationEnabled?: boolean; - /** A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped. */ - loop?: boolean; - /** The index of the currently displayed item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to allow users to change the selected index by swiping. */ - swipeEnabled?: boolean; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - } - /** A widget used to display a view and to switch between several views. */ - export class dxMultiView extends CollectionWidget { - constructor(element: JQuery, options?: dxMultiViewOptions); - constructor(element: Element, options?: dxMultiViewOptions); - } - export interface dxMapOptions extends WidgetOptions { - /** Specifies whether or not the widget automatically adjusts center and zoom option values when adding a new marker or route. */ - autoAdjust?: boolean; - /** An object, a string, or an array specifying the location displayed at the center of the widget. */ - center?: { - /** The latitude location displayed in the center of the widget. */ - lat?: number; - /** The longitude location displayed in the center of the widget. */ - lng?: number; - }; - /** A handler for the click event. */ - onClick?: any; - clickAction?: any; - /** Specifies whether or not map widget controls are available. */ - controls?: boolean; - /** Specifies the height of the widget. */ - height?: number; - /** A key used to authenticate the application within the required map provider. */ - key?: { - /** A key used to authenticate the application within the "Bing" map provider. */ - bing?: string; - /** A key used to authenticate the application within the "Google" map provider. */ - google?: string; - /** A key used to authenticate the application within the "Google Static" map provider. */ - googleStatic?: string; - } - /** A handler for the markerAdded event. */ - onMarkerAdded?: Function; - markerAddedAction?: Function; - /** A URL pointing to the custom icon to be used for map markers. */ - markerIconSrc?: string; - /** A handler for the markerRemoved event. */ - onMarkerRemoved?: Function; - markerRemovedAction?: Function; - /** An array of markers displayed on a map. */ - markers?: Array; - /** The name of the current map data provider. */ - provider?: string; - /** A handler for the ready event. */ - onReady?: Function; - readyAction?: Function; - /** A handler for the routeAdded event. */ - onRouteAdded?: Function; - routeAddedAction?: Function; - /** A handler for the routeRemoved event. */ - onRouteRemoved?: Function; - routeRemovedAction?: Function; - /** An array of routes shown on the map. */ - routes?: Array; - /** The type of a map to display. */ - type?: string; - /** Specifies the width of the widget. */ - width?: number; - /** The zoom level of the map. */ - zoom?: number; - } - /** An interactive map widget. */ - export class dxMap extends Widget { - constructor(element: JQuery, options?: dxMapOptions); - constructor(element: Element, options?: dxMapOptions); - /** Adds a marker to the map. */ - addMarker(markerOptions: Object): JQueryPromise; - /** Adds a route to the map. */ - addRoute(options: Object): JQueryPromise; - /** Removes a marker from the map. */ - removeMarker(marker: Object): JQueryPromise; - /** Removes a route from the map. */ - removeRoute(route: any): JQueryPromise; - } - export interface dxLookupOptions extends dxDropDownListOptions { - /** An object defining widget animation options. */ - animation?: fx.AnimationOptions; - /** The text displayed on the Cancel button. */ - cancelButtonText?: string; - /** The text displayed on the Clear button. */ - clearButtonText?: string; - /** Specifies whether or not the widget cleans the search box when the popup window is displayed. */ - cleanSearchOnOpening?: boolean; - /** A Boolean value specifying whether or not the widget is closed if a user clicks outside of the overlaying window. */ - closeOnOutsideClick?: any; - /** The text displayed on the Apply button. */ - applyButtonText?: string; - /** A Boolean value specifying whether or not to display the lookup in full-screen mode. */ - fullScreen?: boolean; - focusStateEnabled?: boolean; - /** A Boolean value specifying whether or not to group widget items. */ - grouped?: boolean; - groupRender?: any; - /** The name of the template used to display a group header. */ - groupTemplate?: any; - /** The text displayed on the button used to load the next page from the data source. */ - nextButtonText?: string; - /** A handler for the pageLoading event. */ - onPageLoading?: Function; - /** Specifies whether the next page is loaded when a user scrolls the widget to the bottom or when the "next" button is clicked. */ - pageLoadMode?: string; - pageLoadingAction?: Function; - /** Specifies the text shown in the pullDown panel, which is displayed when the widget is scrolled to the bottom. */ - pageLoadingText?: string; - /** The text displayed by the widget when nothing is selected. */ - placeholder?: string; - /** The height of the widget popup element. */ - popupHeight?: any; - /** The width of the widget popup element. */ - popupWidth?: any; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** Specifies the text displayed in the pullDown panel when the widget is pulled below the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the pullRefresh event. */ - onPullRefresh?: Function; - pullRefreshAction?: Function; - /** A Boolean value specifying whether or not the widget supports the "pull down to refresh" gesture. */ - pullRefreshEnabled?: boolean; - /** Specifies the text displayed in the pullDown panel while the widget is being refreshed. */ - refreshingText?: string; - /** A handler for the scroll event. */ - onScroll?: Function; - scrollAction?: Function; - /** A Boolean value specifying whether or not the search bar is visible. */ - searchEnabled?: boolean; - /** The text that is provided as a hint in the lookup's search bar. */ - searchPlaceholder?: string; - /** A Boolean value specifying whether or not the main screen is inactive while the lookup is active. */ - shading?: boolean; - /** Specifies whether to display the Cancel button in the lookup window. */ - showCancelButton?: boolean; - /** - * A Boolean value specifying whether the widget loads the next page automatically when you reach the bottom of the list or when a button is clicked. - * @deprecated pageLoadMode.md - */ - showNextButton?: boolean; - /** The title of the lookup window. */ - title?: string; - /** A template to be used for rendering the widget title. */ - titleTemplate?: any; - /** Specifies whether or not the widget uses native scrolling. */ - useNativeScrolling?: boolean; - /** Specifies whether or not to show lookup contents in a dxPopover widget. */ - usePopover?: boolean; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - contentReadyAction?: Function; - titleRender?: any; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - /** A Boolean value specifying whether or not to display the title in the popup window. */ - showPopupTitle?: boolean; - } - /** A widget that allows a user to select predefined values from a lookup window. */ - export class dxLookup extends dxDropDownList { - constructor(element: JQuery, options?: dxLookupOptions); - constructor(element: Element, options?: dxLookupOptions); - /** This section lists the data source fields that are used in a default template for lookup drop-down items. */ - } - export interface dxLoadPanelOptions extends dxOverlayOptions { - /** An object defining the animation options of the widget. */ - animation?: fx.AnimationOptions; - /** The delay in milliseconds after which the load panel is displayed. */ - delay?: number; - /** The height of the widget. */ - height?: number; - /** A URL pointing to an image to be used as a load indicator. */ - indicatorSrc?: string; - /** The text displayed in the load panel. */ - message?: string; - /** A Boolean value specifying whether or not to show a load indicator. */ - showIndicator?: boolean; - /** A Boolean value specifying whether or not to show the pane behind the load indicator. */ - showPane?: boolean; - /** The width of the widget. */ - width?: number; - } - /** A widget used to indicate whether or not an element is loading. */ - export class dxLoadPanel extends dxOverlay { - constructor(element: JQuery, options?: dxLoadPanelOptions); - constructor(element: Element, options?: dxLoadPanelOptions); - } - export interface dxLoadIndicatorOptions extends WidgetOptions { - /** Specifies the path to an image used as the indicator. */ - indicatorSrc?: string; - } - /** The widget used to indicate the loading process. */ - export class dxLoadIndicator extends Widget { - constructor(element: JQuery, options?: dxLoadIndicatorOptions); - constructor(element: Element, options?: dxLoadIndicatorOptions); - } - export interface dxListOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not to display a grouped list. */ - grouped?: boolean; - groupRender?: any; - /** The template to be used for rendering item groups. */ - groupTemplate?: any; - onItemDeleting?: Function; - /** A handler for the itemDeleted event. */ - onItemDeleted?: Function; - /** A handler for the groupRendered event. */ - onGroupRendered?: Function; - itemDeleteAction?: Function; - /** A handler for the itemReordered event. */ - onItemReordered?: Function; - itemReorderAction?: Function; - /** A handler for the itemClick event. */ - onItemClick?: any; - /** A handler for the itemSwipe event. */ - onItemSwipe?: Function; - itemSwipeAction?: Function; - /** The text displayed on the button used to load the next page from the data source. */ - nextButtonText?: string; - /** A handler for the pageLoading event. */ - onPageLoading?: Function; - pageLoadingAction?: Function; - /** Specifies the text shown in the pullDown panel, which is displayed when the list is scrolled to the bottom. */ - pageLoadingText?: string; - /** Specifies the text displayed in the pullDown panel when the list is pulled below the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the pullRefresh event. */ - onPullRefresh?: Function; - pullRefreshAction?: Function; - /** A Boolean value specifying whether or not the widget supports the "pull down to refresh" gesture. */ - pullRefreshEnabled?: boolean; - /** Specifies the text displayed in the pullDown panel while the list is being refreshed. */ - refreshingText?: string; - /** A handler for the scroll event. */ - onScroll?: Function; - scrollAction?: Function; - /** A Boolean value specifying whether to enable or disable list scrolling. */ - scrollingEnabled?: boolean; - /** Specifies when the widget shows the scrollbar. */ - showScrollbar?: string; - /** Specifies whether or not the widget uses native scrolling. */ - useNativeScrolling?: boolean; - /** A Boolean value specifying whether to enable or disable the bounce-back effect. */ - bounceEnabled?: boolean; - /** A Boolean value specifying if the list is scrolled by content. */ - scrollByContent?: boolean; - /** A Boolean value specifying if the list is scrolled using the scrollbar. */ - scrollByThumb?: boolean; - itemUnselectAction?: Function; - onItemContextMenu?: Function; - onItemHold?: Function; - /** Specifies whether or not an end-user can collapse groups. */ - collapsibleGroups?: boolean; - /** Specifies whether the next page is loaded when a user scrolls the widget to the bottom or when the "next" button is clicked. */ - pageLoadMode?: string; - /** Specifies whether or not to display controls used to select list items. */ - showSelectionControls?: boolean; - /** Specifies item selection mode. */ - selectionMode?: string; - selectAllText?: string; - /** Specifies the array of items for a context menu called for a list item. */ - menuItems?: Array; - /** Specifies whether an item context menu is shown when a user holds or swipes an item. */ - menuMode?: string; - /** Specifies whether or not an end user can delete list items. */ - allowItemDeleting?: boolean; - /** Specifies the way a user can delete items from the list. */ - itemDeleteMode?: string; - /** Specifies whether or not an end user can reorder list items. */ - allowItemReordering?: boolean; - /** Specifies whether or not to show the loading panel when the DataSource bound to the widget is loading data. */ - indicateLoading?: boolean; - activeStateEnabled?: boolean; - } - /** A list widget. */ - export class dxList extends CollectionWidget { - constructor(element: JQuery, options?: dxListOptions); - constructor(element: Element, options?: dxListOptions); - /** Returns the height of the widget in pixels. */ - clientHeight(): number; - /** Removes the specified item from the list. */ - deleteItem(itemIndex: any): JQueryPromise; - /** Removes the specified item from the list. */ - deleteItem(itemElement: Element): JQueryPromise; - /** Returns a Boolean value that indicates whether or not the specified item is selected. */ - isItemSelected(itemIndex: any): boolean; - /** Returns a Boolean value that indicates whether or not the specified item is selected. */ - isItemSelected(itemElement: Element): boolean; - /** Reloads list data. */ - reload(): void; - /** Moves the specified item to the specified position in the list. */ - reorderItem(itemElement: Element, toItemElement: Element): JQueryPromise; - /** Moves the specified item to the specified position in the list. */ - reorderItem(itemIndex: any, toItemIndex: any): JQueryPromise; - /** Scrolls the list content by the specified number of pixels. */ - scrollBy(distance: number): void; - /** Returns the height of the list content in pixels. */ - scrollHeight(): number; - /** Scrolls list content to the specified position. */ - scrollTo(location: number): void; - /** Scrolls the list to the specified item. */ - scrollToItem(itemElement: Element): void; - /** Scrolls the list to the specified item. */ - scrollToItem(itemIndex: any): void; - /** Returns how far the list content is scrolled from the top. */ - scrollTop(): number; - /** Selects the specified item from the list. */ - selectItem(itemElement: Element): void; - /** Selects the specified item from the list. */ - selectItem(itemIndex: any): void; - /** Deselects the specified item from the list. */ - unselectItem(itemElement: Element): void; - /** Unselects the specified item from the list. */ - unselectItem(itemIndex: any): void; - /** Updates the widget scrollbar according to widget content size. */ - updateDimensions(): JQueryPromise; - /** Expands the specified group. */ - expandGroup(groupIndex: number): JQueryPromise; - /** Collapses the specified group. */ - collapseGroup(groupIndex: number): JQueryPromise; - } - export interface dxGalleryOptions extends CollectionWidgetOptions { - /** The time, in milliseconds, spent on slide animation. */ - animationDuration?: number; - /** Specifies whether or not to animate the displayed item change. */ - animationEnabled?: boolean; - /** A Boolean value specifying whether or not to allow users to switch between items by clicking an indicator. */ - indicatorEnabled?: boolean; - /** A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped. */ - loop?: boolean; - /** The index of the currently active gallery item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to display an indicator that points to the selected gallery item. */ - showIndicator?: boolean; - /** A Boolean value that specifies the availability of the "Forward" and "Back" navigation buttons. */ - showNavButtons?: boolean; - /** The time interval in milliseconds, after which the gallery switches to the next item. */ - slideshowDelay?: number; - /** A Boolean value specifying whether or not to allow users to switch between items by swiping. */ - swipeEnabled?: boolean; - /** Specifies whether or not to display parts of previous and next images along the sides of the current image. */ - wrapAround?: boolean; - /** Specifies if the widget stretches images to fit the total gallery width. */ - stretchImages?: boolean; - /** Specifies the width of an area used to display a single image. */ - initialItemWidth?: number; - } - /** An image gallery widget. */ - export class dxGallery extends CollectionWidget { - constructor(element: JQuery, options?: dxGalleryOptions); - constructor(element: Element, options?: dxGalleryOptions); - /** Shows the specified gallery item. */ - goToItem(itemIndex: number, animation: boolean): JQueryPromise; - /** Shows the next gallery item. */ - nextItem(animation: boolean): JQueryPromise; - /** Shows the previous gallery item. */ - prevItem(animation: boolean): JQueryPromise; - } - export interface dxDropDownEditorOptions extends dxTextBoxOptions { - /** Specifies the current value displayed by the widget. */ - value?: Object; - /** A handler for the closed event. */ - onClosed?: Function; - /** A handler for the opened event. */ - onOpened?: Function; - /** Specifies whether or not the drop-down editor is displayed. */ - opened?: boolean; - closeAction?: Function; - openAction?: Function; - shownAction?: Function; - hiddenAction?: Function; - /** Specifies whether or not the widget allows an end-user to enter a custom value. */ - fieldEditEnabled?: boolean; - editEnabled?: boolean; - /** Specifies the way an end-user applies the selected value. */ - applyValueMode?: string; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - } - /** A drop-down editor widget. */ - export class dxDropDownEditor extends dxTextBox { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - /** Closes the drop-down editor. */ - close(): void; - /** Opens the drop-down editor. */ - open(): void; - /** Resets the widget's value to null. */ - reset(): void; - /** Returns an <input> element of the widget. */ - field(): JQuery; - /** Returns an HTML element of the popup window content. */ - content(): JQuery; - } - export interface dxDateBoxOptions extends dxTextEditorOptions { - /** A format used to display date/time information. */ - format?: string; - /** A Globalize format string specifying the date display format. */ - formatString?: string; - /** The last date that can be selected within the widget. */ - max?: any; - /** The minimum date that can be selected within the widget. */ - min?: any; - /** The text displayed by the widget when the widget value is not yet specified. This text is also used as a title of the date picker. */ - placeholder?: string; - /** - * Specifies whether or not a user can pick out a date using the drop-down calendar. - * @deprecated Use 'pickerType' option instead. - */ - useCalendar?: boolean; - /** An object or a value, specifying the date and time currently selected using the date box. */ - value?: any; - /** - * Specifies whether or not the widget uses the native HTML input element. - * @deprecated Use 'pickerType' option instead. - */ - useNative?: boolean; - /** Specifies the interval between neighboring values in the popup list in minutes. */ - interval?: number; - /** Specifies the maximum zoom level of a calendar, which is used to pick the date. */ - maxZoomLevel?: string; - /** Specifies the minimal zoom level of a calendar, which is used to pick the date. */ - minZoomLevel?: string; - /** Specifies the type of date/time picker. */ - pickerType?: string; - } - /** A date box widget. */ - export class dxDateBox extends dxDropDownEditor { - constructor(element: JQuery, options?: dxDateBoxOptions); - constructor(element: Element, options?: dxDateBoxOptions); - } - export interface dxCheckBoxOptions extends EditorOptions { - /** Specifies the widget state. */ - value?: boolean; - /** Specifies the text displayed by the check box. */ - text?: string; - } - /** A check box widget. */ - export class dxCheckBox extends Editor { - constructor(element: JQuery, options?: dxCheckBoxOptions); - constructor(element: Element, options?: dxCheckBoxOptions); - } - export interface dxCalendarOptions extends EditorOptions { - /** Specifies a date displayed on the current calendar page. */ - currentDate?: Date; - /** Specifies the first day of a week. */ - firstDayOfWeek?: number; - /** The latest date the widget allows to select. */ - max?: Date; - /** The earliest date the widget allows to select. */ - min?: Date; - /** Specifies whether or not the widget displays a button that selects the current date. */ - showTodayButton?: boolean; - /** Specifies the current calendar zoom level. */ - zoomLevel?: string; - /** Specifies the maximum zoom level of the calendar. */ - maxZoomLevel?: string; - /** Specifies the minimum zoom level of the calendar. */ - minZoomLevel?: string; - /** The template to be used for rendering calendar cells. */ - cellTemplate?: any; - } - /** A calendar widget. */ - export class dxCalendar extends Editor { - constructor(element: JQuery, options?: dxCalendarOptions); - constructor(element: Element, options?: dxCalendarOptions); - } - export interface dxButtonOptions extends WidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A handler for the click event. */ - onClick?: any; - clickAction?: any; - /** Specifies the icon to be displayed on the button. */ - icon?: string; - iconSrc?: string; - /** A template to be used for rendering the dxButton widget. */ - template?: any; - /** The text displayed on the button. */ - text?: string; - /** Specifies the button type. */ - type?: string; - /** Specifies the name of the validation group to be accessed in the click event handler. */ - validationGroup?: string; - } - /** A button widget. */ - export class dxButton extends Widget { - constructor(element: JQuery, options?: dxButtonOptions); - constructor(element: Element, options?: dxButtonOptions); - } - export interface dxBoxOptions extends CollectionWidget { - /** Specifies how widget items are aligned along the main direction. */ - align?: string; - /** Specifies the direction of item positioning in the widget. */ - direction?: string; - /** Specifies how widget items are aligned cross-wise. */ - crossAlign?: string; - } - /** A container widget used to arrange inner elements. */ - export class dxBox extends CollectionWidget { - constructor(element: JQuery, options?: dxBoxOptions); - constructor(element: Element, options?: dxBoxOptions); - } - export interface dxResponsiveBoxOptions extends CollectionWidgetOptions { - /** Specifies the collection of rows for the grid used to position layout elements. */ - rows?: Array; - /** Specifies the collection of columns for the grid used to position layout elements. */ - cols?: Array; - /** Specifies the function returning the screen factor depending on the screen width. */ - screenByWidth?: (width: number) => string; - /** Specifies the screen factor with which all elements are located in a single column. */ - singleColumnScreen?: string; - } - /** A widget used to build an adaptive markup that is dependent on screen resolution. */ - export class dxResponsiveBox extends CollectionWidget { - constructor(element: JQuery, options?: dxBoxOptions); - constructor(element: Element, options?: dxBoxOptions); - } - export interface dxAutocompleteOptions extends dxDropDownListOptions { - /** Specifies the current value displayed by the widget. */ - value?: string; - /** The minimum number of characters that must be entered into the text box to begin a search. */ - minSearchLength?: number; - /** Specifies the maximum count of items displayed by the widget. */ - maxItemCount?: number; - /** Gets the currently selected item. */ - selectedItem?: Object; - } - /** A textbox widget that supports autocompletion. */ - export class dxAutocomplete extends dxDropDownList { - constructor(element: JQuery, options?: dxAutocompleteOptions); - constructor(element: Element, options?: dxAutocompleteOptions); - /** Opens the drop-down editor. */ - open(): void; - /** Closes the drop-down editor. */ - close(): void; - } - export interface dxAccordionOptions extends CollectionWidgetOptions { - /** A number specifying the time in milliseconds spent on the animation of the expanding or collapsing of a panel. */ - animationDuration?: number; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies whether all items can be collapsed or whether at least one item must always be expanded. */ - collapsible?: boolean; - /** Specifies whether the widget can expand several items or only a single item at once. */ - multiple?: boolean; - /** The template to be used for rendering dxAccordion items. */ - itemTemplate?: any; - /** A handler for the itemTitleClick event. */ - onItemTitleClick?: any; - /** A handler for the itemTitleHold event. */ - onItemTitleHold?: Function; - /** The template to be used for rendering an item title. */ - itemTitleTemplate?: any; - /** The index number of the currently selected item. */ - selectedIndex?: number; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - } - /** A widget that displays data source items on collapsible panels. */ - export class dxAccordion extends CollectionWidget { - constructor(element: JQuery, options?: dxAccordionOptions); - constructor(element: Element, options?: dxAccordionOptions); - /** Collapses the specified item. */ - collapseItem(index: number): JQueryPromise; - /** Expands the specified item. */ - expandItem(index: number): JQueryPromise; - /** Updates the dimensions of the widget contents. */ - updateDimensions(): JQueryPromise; - } - export interface dxFileUploaderOptions extends EditorOptions { - /** A read-only option that holds a File instance representing the selected file. */ - value?: File; - /** Holds the File instances representing files selected in the widget. */ - values?: Array; - buttonText?: string; - /** The text displayed on the button that opens the file browser. */ - selectButtonText?: string; - /** The text displayed on the button that starts uploading. */ - uploadButtonText?: string; - /** Specifies the text displayed on the area to which an end-user can drop a file. */ - labelText?: string; - /** Specifies the value passed to the name attribute of the underlying input element. */ - name?: string; - /** Specifies whether the widget enables an end-user to select a single file or multiple files. */ - multiple?: boolean; - /** Specifies a file type or several types accepted by the widget. */ - accept?: string; - /** Specifies a target Url for the upload request. */ - uploadUrl?: string; - /** Specifies if an end user can remove a file from the selection and interrupt uploading. */ - allowCanceling?: boolean; - /** Specifies whether or not the widget displays the list of selected files. */ - showFileList?: boolean; - /** Gets the current progress in percentages. */ - progress?: number; - /** The message displayed by the widget when it is ready to upload the specified files. */ - readyToUploadMessage?: string; - /** The message displayed by the widget when uploading is finished. */ - uploadedMessage?: string; - /** The message displayed by the widget on uploading failure. */ - uploadFailedMessage?: string; - /** Specifies how the widget uploads files. */ - uploadMode?: string; - /** A handler for the uploaded event. */ - onUploaded?: Function; - /** A handler for the uploaded event. */ - onProgress?: Function; - /** A handler for the uploadError event. */ - onUploadError?: Function; - } - /** A widget used to select and upload a file or multiple files. */ - export class dxFileUploader extends Editor { - constructor(element: JQuery, options?: dxFileUploaderOptions); - constructor(element: Element, options?: dxFileUploaderOptions); - } - export interface dxTrackBarOptions extends EditorOptions { - /** The minimum value the widget can accept. */ - min?: number; - /** The maximum value the widget can accept. */ - max?: number; - /** The current widget value. */ - value?: number; - } - /** A base class for track bar widgets. */ - export class dxTrackBar extends Editor { - constructor(element: JQuery, options?: dxTrackBarOptions); - constructor(element: Element, options?: dxTrackBarOptions); - } - export interface dxProgressBarOptions extends dxTrackBarOptions { - /** Specifies a format for the progress status. */ - statusFormat?: any; - /** Specifies whether or not the widget displays a progress status. */ - showStatus?: boolean; - /** A handler for the complete event. */ - onComplete?: Function; - } - /** A widget used to indicate progress. */ - export class dxProgressBar extends dxTrackBar { - constructor(element: JQuery, options?: dxProgressBarOptions); - constructor(element: Element, options?: dxProgressBarOptions); - } - export interface dxSliderOptions extends dxTrackBarOptions { - /** The slider step size. */ - step?: number; - /** The current slider value. */ - value?: number; - /** Specifies whether or not to highlight a range selected within the widget. */ - showRange?: boolean; - /** Specifies the size of a step by which a slider handle is moved when a user uses the Page up or Page down keyboard shortcuts. */ - keyStep?: number; - /** Specifies options for the slider tooltip. */ - tooltip?: { - /** Specifies whether or not the tooltip is enabled. */ - enabled?: boolean; - /** Specifies format for the tooltip. */ - format?: any; - /** Specifies whether the tooltip is located over or under the slider. */ - position?: string; - /** Specifies whether the widget always shows a tooltip or only when a pointer is over the slider. */ - showMode?: string; - }; - /** Specifies options for labels displayed at the min and max values. */ - label?: { - /** Specifies whether or not slider labels are visible. */ - visible?: boolean; - /** Specifies whether labels are located over or under the scale. */ - position?: string; - /** Specifies a format for labels. */ - format?: any; - }; - } - /** A widget that allows a user to select a numeric value within a given range. */ - export class dxSlider extends dxTrackBar { - constructor(element: JQuery, options?: dxSliderOptions); - constructor(element: Element, options?: dxSliderOptions); - } - export interface dxRangeSliderOptions extends dxSliderOptions { - /** The left edge of the interval currently selected using the range slider. */ - start?: number; - /** The right edge of the interval currently selected using the range slider. */ - end?: number; - } - /** A widget that enables a user to select a range of numeric values. */ - export class dxRangeSlider extends dxSlider { - constructor(element: JQuery, options?: dxRangeSliderOptions); - constructor(element: Element, options?: dxRangeSliderOptions); - } -} -interface JQuery { - dxProgressBar(): JQuery; - dxProgressBar(options: "instance"): DevExpress.ui.dxProgressBar; - dxProgressBar(options: string): any; - dxProgressBar(options: string, ...params: any[]): any; - dxProgressBar(options: DevExpress.ui.dxProgressBarOptions): JQuery; - dxSlider(): JQuery; - dxSlider(options: "instance"): DevExpress.ui.dxSlider; - dxSlider(options: string): any; - dxSlider(options: string, ...params: any[]): any; - dxSlider(options: DevExpress.ui.dxSliderOptions): JQuery; - dxRangeSlider(): JQuery; - dxRangeSlider(options: "instance"): DevExpress.ui.dxRangeSlider; - dxRangeSlider(options: string): any; - dxRangeSlider(options: string, ...params: any[]): any; - dxRangeSlider(options: DevExpress.ui.dxRangeSliderOptions): JQuery; - dxFileUploader(): JQuery; - dxFileUploader(options: "instance"): DevExpress.ui.dxFileUploader; - dxFileUploader(options: string): any; - dxFileUploader(options: string, ...params: any[]): any; - dxFileUploader(options: DevExpress.ui.dxFileUploaderOptions): JQuery; - dxValidator(): JQuery; - dxValidator(options: "instance"): DevExpress.ui.dxValidator; - dxValidator(options: string): any; - dxValidator(options: string, ...params: any[]): any; - dxValidator(options: DevExpress.ui.dxValidatorOptions): JQuery; - dxValidationGroup(): JQuery; - dxValidationGroup(options: "instance"): DevExpress.ui.dxValidationGroup; - dxValidationGroup(options: string): any; - dxValidationGroup(options: string, ...params: any[]): any; - dxValidationSummary(): JQuery; - dxValidationSummary(options: "instance"): DevExpress.ui.dxValidationSummary; - dxValidationSummary(options: string): any; - dxValidationSummary(options: string, ...params: any[]): any; - dxValidationSummary(options: DevExpress.ui.dxValidationSummaryOptions): JQuery; - dxTooltip(): JQuery; - dxTooltip(options: "instance"): DevExpress.ui.dxTooltip; - dxTooltip(options: string): any; - dxTooltip(options: string, ...params: any[]): any; - dxTooltip(options: DevExpress.ui.dxTooltipOptions): JQuery; - dxResizable(): JQuery; - dxResizable(options: "instance"): DevExpress.ui.dxResizable; - dxResizable(options: string): any; - dxResizable(options: string, ...params: any[]): any; - dxResizable(options: DevExpress.ui.dxResizableOptions): JQuery; - dxDropDownList(): JQuery; - dxDropDownList(options: "instance"): DevExpress.ui.dxDropDownList; - dxDropDownList(options: string): any; - dxDropDownList(options: string, ...params: any[]): any; - dxDropDownList(options: DevExpress.ui.dxDropDownListOptions): JQuery; - dxToolbar(): JQuery; - dxToolbar(options: "instance"): DevExpress.ui.dxToolbar; - dxToolbar(options: string): any; - dxToolbar(options: string, ...params: any[]): any; - dxToolbar(options: DevExpress.ui.dxToolbarOptions): JQuery; - dxToast(): JQuery; - dxToast(options: "instance"): DevExpress.ui.dxToast; - dxToast(options: string): any; - dxToast(options: string, ...params: any[]): any; - dxToast(options: DevExpress.ui.dxToastOptions): JQuery; - dxTextEditor(): JQuery; - dxTextEditor(options: "instance"): DevExpress.ui.dxTextEditor; - dxTextEditor(options: string): any; - dxTextEditor(options: string, ...params: any[]): any; - dxTextEditor(options: DevExpress.ui.dxTextEditorOptions): JQuery; - dxTextBox(): JQuery; - dxTextBox(options: "instance"): DevExpress.ui.dxTextBox; - dxTextBox(options: string): any; - dxTextBox(options: string, ...params: any[]): any; - dxTextBox(options: DevExpress.ui.dxTextBoxOptions): JQuery; - dxTextArea(): JQuery; - dxTextArea(options: "instance"): DevExpress.ui.dxTextArea; - dxTextArea(options: string): any; - dxTextArea(options: string, ...params: any[]): any; - dxTextArea(options: DevExpress.ui.dxTextAreaOptions): JQuery; - dxTabs(): JQuery; - dxTabs(options: "instance"): DevExpress.ui.dxTabs; - dxTabs(options: string): any; - dxTabs(options: string, ...params: any[]): any; - dxTabs(options: DevExpress.ui.dxTabsOptions): JQuery; - dxTabPanel(): JQuery; - dxTabPanel(options: "instance"): DevExpress.ui.dxTabPanel; - dxTabPanel(options: string): any; - dxTabPanel(options: string, ...params: any[]): any; - dxTabPanel(options: DevExpress.ui.dxTabPanelOptions): JQuery; - dxSelectBox(): JQuery; - dxSelectBox(options: "instance"): DevExpress.ui.dxSelectBox; - dxSelectBox(options: string): any; - dxSelectBox(options: string, ...params: any[]): any; - dxSelectBox(options: DevExpress.ui.dxSelectBoxOptions): JQuery; - dxScrollView(): JQuery; - dxScrollView(options: "instance"): DevExpress.ui.dxScrollView; - dxScrollView(options: string): any; - dxScrollView(options: string, ...params: any[]): any; - dxScrollView(options: DevExpress.ui.dxScrollViewOptions): JQuery; - dxScrollable(): JQuery; - dxScrollable(options: "instance"): DevExpress.ui.dxScrollable; - dxScrollable(options: string): any; - dxScrollable(options: string, ...params: any[]): any; - dxScrollable(options: DevExpress.ui.dxScrollableOptions): JQuery; - dxRadioGroup(): JQuery; - dxRadioGroup(options: "instance"): DevExpress.ui.dxRadioGroup; - dxRadioGroup(options: string): any; - dxRadioGroup(options: string, ...params: any[]): any; - dxRadioGroup(options: DevExpress.ui.dxRadioGroupOptions): JQuery; - dxPopup(): JQuery; - dxPopup(options: "instance"): DevExpress.ui.dxPopup; - dxPopup(options: string): any; - dxPopup(options: string, ...params: any[]): any; - dxPopup(options: DevExpress.ui.dxPopupOptions): JQuery; - dxPopover(): JQuery; - dxPopover(options: "instance"): DevExpress.ui.dxPopover; - dxPopover(options: string): any; - dxPopover(options: string, ...params: any[]): any; - dxPopover(options: DevExpress.ui.dxPopoverOptions): JQuery; - dxOverlay(): JQuery; - dxOverlay(options: "instance"): DevExpress.ui.dxOverlay; - dxOverlay(options: string): any; - dxOverlay(options: string, ...params: any[]): any; - dxOverlay(options: DevExpress.ui.dxOverlayOptions): JQuery; - dxNumberBox(): JQuery; - dxNumberBox(options: "instance"): DevExpress.ui.dxNumberBox; - dxNumberBox(options: string): any; - dxNumberBox(options: string, ...params: any[]): any; - dxNumberBox(options: DevExpress.ui.dxNumberBoxOptions): JQuery; - dxNavBar(): JQuery; - dxNavBar(options: "instance"): DevExpress.ui.dxNavBar; - dxNavBar(options: string): any; - dxNavBar(options: string, ...params: any[]): any; - dxNavBar(options: DevExpress.ui.dxNavBarOptions): JQuery; - dxMultiView(): JQuery; - dxMultiView(options: "instance"): DevExpress.ui.dxMultiView; - dxMultiView(options: string): any; - dxMultiView(options: string, ...params: any[]): any; - dxMultiView(options: DevExpress.ui.dxMultiViewOptions): JQuery; - dxMap(): JQuery; - dxMap(options: "instance"): DevExpress.ui.dxMap; - dxMap(options: string): any; - dxMap(options: string, ...params: any[]): any; - dxMap(options: DevExpress.ui.dxMapOptions): JQuery; - dxLookup(): JQuery; - dxLookup(options: "instance"): DevExpress.ui.dxLookup; - dxLookup(options: string): any; - dxLookup(options: string, ...params: any[]): any; - dxLookup(options: DevExpress.ui.dxLookupOptions): JQuery; - dxLoadPanel(): JQuery; - dxLoadPanel(options: "instance"): DevExpress.ui.dxLoadPanel; - dxLoadPanel(options: string): any; - dxLoadPanel(options: string, ...params: any[]): any; - dxLoadPanel(options: DevExpress.ui.dxLoadPanelOptions): JQuery; - dxLoadIndicator(): JQuery; - dxLoadIndicator(options: "instance"): DevExpress.ui.dxLoadIndicator; - dxLoadIndicator(options: string): any; - dxLoadIndicator(options: string, ...params: any[]): any; - dxLoadIndicator(options: DevExpress.ui.dxLoadIndicatorOptions): JQuery; - dxList(): JQuery; - dxList(options: "instance"): DevExpress.ui.dxList; - dxList(options: string): any; - dxList(options: string, ...params: any[]): any; - dxList(options: DevExpress.ui.dxListOptions): JQuery; - dxGallery(): JQuery; - dxGallery(options: "instance"): DevExpress.ui.dxGallery; - dxGallery(options: string): any; - dxGallery(options: string, ...params: any[]): any; - dxGallery(options: DevExpress.ui.dxGalleryOptions): JQuery; - dxDropDownEditor(): JQuery; - dxDropDownEditor(options: "instance"): DevExpress.ui.dxDropDownEditor; - dxDropDownEditor(options: string): any; - dxDropDownEditor(options: string, ...params: any[]): any; - dxDropDownEditor(options: DevExpress.ui.dxDropDownEditorOptions): JQuery; - dxDateBox(): JQuery; - dxDateBox(options: "instance"): DevExpress.ui.dxDateBox; - dxDateBox(options: string): any; - dxDateBox(options: string, ...params: any[]): any; - dxDateBox(options: DevExpress.ui.dxDateBoxOptions): JQuery; - dxCheckBox(): JQuery; - dxCheckBox(options: "instance"): DevExpress.ui.dxCheckBox; - dxCheckBox(options: string): any; - dxCheckBox(options: string, ...params: any[]): any; - dxCheckBox(options: DevExpress.ui.dxCheckBoxOptions): JQuery; - dxBox(): JQuery; - dxBox(options: "instance"): DevExpress.ui.dxBox; - dxBox(options: string): any; - dxBox(options: string, ...params: any[]): any; - dxBox(options: DevExpress.ui.dxBoxOptions): JQuery; - dxButton(): JQuery; - dxButton(options: "instance"): DevExpress.ui.dxButton; - dxButton(options: string): any; - dxButton(options: string, ...params: any[]): any; - dxButton(options: DevExpress.ui.dxButtonOptions): JQuery; - dxCalendar(): JQuery; - dxCalendar(options: "instance"): DevExpress.ui.dxCalendar; - dxCalendar(options: string): any; - dxCalendar(options: string, ...params: any[]): any; - dxCalendar(options: DevExpress.ui.dxCalendarOptions): JQuery; - dxAccordion(): JQuery; - dxAccordion(options: "instance"): DevExpress.ui.dxAccordion; - dxAccordion(options: string): any; - dxAccordion(options: string, ...params: any[]): any; - dxAccordion(options: DevExpress.ui.dxAccordionOptions): JQuery; - dxResponsiveBox(): JQuery; - dxResponsiveBox(options: "instance"): DevExpress.ui.dxResponsiveBox; - dxResponsiveBox(options: string): any; - dxResponsiveBox(options: string, ...params: any[]): any; - dxResponsiveBox(options: DevExpress.ui.dxResponsiveBoxOptions): JQuery; - dxAutocomplete(): JQuery; - dxAutocomplete(options: "instance"): DevExpress.ui.dxAutocomplete; - dxAutocomplete(options: string): any; - dxAutocomplete(options: string, ...params: any[]): any; - dxAutocomplete(options: DevExpress.ui.dxAutocompleteOptions): JQuery; -} - -declare namespace DevExpress.ui { - export interface dxTileViewOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** Specifies the height of the base tile view item. */ - baseItemHeight?: number; - /** Specifies the width of the base tile view item. */ - baseItemWidth?: number; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies the distance in pixels between adjacent tiles. */ - itemMargin?: number; - /** A Boolean value specifying whether or not to display a scrollbar. */ - showScrollbar?: boolean; - } - /** A widget displaying several blocks of data as tiles. */ - export class dxTileView extends CollectionWidget { - constructor(element: JQuery, options?: dxTileViewOptions); - constructor(element: Element, options?: dxTileViewOptions); - /** Returns the current scroll position of the widget content. */ - scrollPosition(): number; - } - export interface dxSwitchOptions extends EditorOptions { - /** Text displayed when the widget is in a disabled state. */ - offText?: string; - /** Text displayed when the widget is in an enabled state. */ - onText?: string; - /** A Boolean value specifying whether the current switch state is "On" or "Off". */ - value?: boolean; - } - /** A switch widget. */ - export class dxSwitch extends Editor { - constructor(element: JQuery, options?: dxSwitchOptions); - constructor(element: Element, options?: dxSwitchOptions); - } - export interface dxSlideOutViewOptions extends WidgetOptions { - /** Specifies whether or not the menu panel is visible. */ - menuVisible?: boolean; - /** Specifies whether or not the menu is shown when a user swipes the widget content. */ - swipeEnabled?: boolean; - /** A template to be used for rendering menu panel content. */ - menuTemplate?: any; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - } - /** The widget that allows you to slide-out the current view to reveal a custom menu. */ - export class dxSlideOutView extends Widget { - constructor(element: JQuery, options?: dxSlideOutViewOptions); - constructor(element: Element, options?: dxSlideOutViewOptions); - /** Returns an HTML element of the widget menu block. */ - menuContent(): JQuery; - /** Returns an HTML element of the widget content block. */ - content(): JQuery; - /** Displays the widget's menu block. */ - showMenu(): JQueryPromise; - /** Hides the widget's menu block. */ - hideMenu(): JQueryPromise; - /** Toggles the visibility of the widget's menu block. */ - toggleMenuVisibility(): JQueryPromise; - } - export interface dxSlideOutOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A Boolean value specifying whether or not to display a grouped menu. */ - menuGrouped?: boolean; - menuGroupRender?: any; - /** The name of the template used to display a group header. */ - menuGroupTemplate?: any; - menuItemRender?: any; - /** The template used to render menu items. */ - menuItemTemplate?: any; - /** A handler for the menuGroupRendered event. */ - onMenuGroupRendered?: Function; - /** A handler for the menuItemRendered event. */ - onMenuItemRendered?: Function; - /** Specifies whether or not the slide-out menu is displayed. */ - menuVisible?: boolean; - /** Indicates whether the menu can be shown/hidden by swiping the widget's main panel. */ - swipeEnabled?: boolean; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - } - /** The widget that allows you to slide-out the current view to reveal an item list. */ - export class dxSlideOut extends CollectionWidget { - constructor(element: JQuery, options?: dxSlideOutOptions); - constructor(element: Element, options?: dxSlideOutOptions); - /** Hides the widget's slide-out menu. */ - hideMenu(): JQueryPromise; - /** Displays the widget's slide-out menu. */ - showMenu(): JQueryPromise; - /** Toggles the visibility of the widget's slide-out menu. */ - toggleMenuVisibility(showing: boolean): JQueryPromise; - } - export interface dxPivotOptions extends CollectionWidgetOptions { - /** The index of the currently active pivot item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to allow users to switch between items by swiping. */ - swipeEnabled?: boolean; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - /** The template to be used for rendering an item title. */ - itemTitleTemplate?: any; - } - /** A widget that is similar to a traditional tab control, but optimized for the phone with simplified end-user interaction. */ - export class dxPivot extends CollectionWidget { - constructor(element: JQuery, options?: dxPivotOptions); - constructor(element: Element, options?: dxPivotOptions); - } - export interface dxPanoramaOptions extends CollectionWidgetOptions { - /** An object exposing options for setting a background image for the panorama. */ - backgroundImage?: { - /** Specifies the height of the panorama's background image. */ - height?: number; - /** Specifies the URL of the image that is used as the panorama's background image. */ - url?: string; - /** Specifies the width of the panorama's background image. */ - width?: number; - }; - /** The index of the currently active panorama item. */ - selectedIndex?: number; - /** Specifies the widget content title. */ - title?: string; - } - /** A widget displaying the required content in a long horizontal canvas that extends beyond the frames of the screen. */ - export class dxPanorama extends CollectionWidget { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - } - export interface dxDropDownMenuOptions extends WidgetOptions { - /** A handler for the buttonClick event. */ - onButtonClick?: any; - buttonClickAction?: any; - /** The name of the icon to be displayed by the DropDownMenu button. */ - buttonIcon?: string; - buttonIconSrc?: string; - /** The text displayed in the DropDownMenu button. */ - buttonText?: string; - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** A handler for the itemClick event. */ - onItemClick?: any; - itemClickAction?: any; - itemRender?: any; - /** An array of items displayed by the widget. */ - items?: Array; - /** The template to be used for rendering items. */ - itemTemplate?: any; - /** Specifies whether or not to show the drop down menu within a dxPopover widget. */ - usePopover?: boolean; - /** The width of the menu popup in pixels. */ - popupWidth?: any; - /** The height of the menu popup in pixels. */ - popupHeight?: any; - /** Specifies whether or not the drop-down menu is displayed. */ - opened?: boolean; - /** A Boolean value specifying whether or not the widget changes its state when being hovered by an end user. */ - hoverStateEnabled?: boolean; - } - /** A drop-down menu widget. */ - export class dxDropDownMenu extends Widget { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - /** This section lists the data source fields that are used in a default template for drop-down menu items. */ - /** Opens the drop-down menu. */ - open(): void; - /** Closes the drop-down menu. */ - close(): void; - } - export interface dxActionSheetOptions extends CollectionWidgetOptions { - cancelClickAction?: any; - /** A handler for the cancelClick event. */ - onCancelClick?: any; - /** The text displayed in the button that closes the action sheet. */ - cancelText?: string; - /** Specifies whether or not to display the Cancel button in action sheet. */ - showCancelButton?: boolean; - /** A Boolean value specifying whether or not the title of the action sheet is visible. */ - showTitle?: boolean; - /** Specifies the element the action sheet popover points at. */ - target?: any; - /** The title of the action sheet. */ - title?: string; - /** Specifies whether or not to show the action sheet within a dxPopover widget. */ - usePopover?: boolean; - /** A Boolean value specifying whether or not the dxActionSheet widget is visible. */ - visible?: boolean; - } - /** A widget consisting of a set of choices related to a certain task. */ - export class dxActionSheet extends CollectionWidget { - constructor(element: JQuery, options?: dxActionSheetOptions); - constructor(element: Element, options?: dxActionSheetOptions); - /** Hides the widget. */ - hide(): JQueryPromise; - /** Shows the widget. */ - show(): JQueryPromise; - /** Shows or hides the widget depending on the Boolean value passed as the parameter. */ - toggle(showing: boolean): JQueryPromise; - } -} -interface JQuery { - dxTileView(): JQuery; - dxTileView(options: "instance"): DevExpress.ui.dxTileView; - dxTileView(options: string): any; - dxTileView(options: string, ...params: any[]): any; - dxTileView(options: DevExpress.ui.dxTileViewOptions): JQuery; - dxSwitch(): JQuery; - dxSwitch(options: "instance"): DevExpress.ui.dxSwitch; - dxSwitch(options: string): any; - dxSwitch(options: string, ...params: any[]): any; - dxSwitch(options: DevExpress.ui.dxSwitchOptions): JQuery; - dxSlideOut(): JQuery; - dxSlideOut(options: "instance"): DevExpress.ui.dxSlideOut; - dxSlideOut(options: string): any; - dxSlideOut(options: string, ...params: any[]): any; - dxSlideOut(options: DevExpress.ui.dxSlideOutOptions): JQuery; - dxPivot(): JQuery; - dxPivot(options: "instance"): DevExpress.ui.dxPivot; - dxPivot(options: string): any; - dxPivot(options: string, ...params: any[]): any; - dxPivot(options: DevExpress.ui.dxPivotOptions): JQuery; - dxPanorama(): JQuery; - dxPanorama(options: "instance"): DevExpress.ui.dxPanorama; - dxPanorama(options: string): any; - dxPanorama(options: string, ...params: any[]): any; - dxPanorama(options: DevExpress.ui.dxPanoramaOptions): JQuery; - dxActionSheet(): JQuery; - dxActionSheet(options: "instance"): DevExpress.ui.dxActionSheet; - dxActionSheet(options: string): any; - dxActionSheet(options: string, ...params: any[]): any; - dxActionSheet(options: DevExpress.ui.dxActionSheetOptions): JQuery; - dxDropDownMenu(): JQuery; - dxDropDownMenu(options: "instance"): DevExpress.ui.dxDropDownMenu; - dxDropDownMenu(options: string): any; - dxDropDownMenu(options: string, ...params: any[]): any; - dxDropDownMenu(options: DevExpress.ui.dxDropDownMenuOptions): JQuery; -} -declare namespace DevExpress.data { - export interface XmlaStoreOptions { - /** The HTTP address to an XMLA OLAP server. */ - url?: string; - /** The name of the database associated with the Store. */ - catalog?: string; - /** The cube name. */ - cube?: string; - beforeSend?: (request: Object) => void; - } - /** A Store that provides access to an OLAP cube using the XMLA standard. */ - export class XmlaStore { - constructor(options: XmlaStoreOptions); - } - export interface PivotGridField { - index?: number; - /** A boolean value specifying whether or not the field is visible in the pivot grid and the Field Chooser. */ - visible?: boolean; - /** Name of the data source field containing data for the pivot grid field. */ - dataField?: string; - /** A caption that will be displayed in the pivot grid's field chooser to identify the field. */ - caption?: string; - /** Specifies a type of field values. */ - dataType?: string; - /** Specifies how the values of the current field are combined into groups. Cannot be used for the XmlaStore store type. */ - groupInterval?: any; - /** Specifies how to aggregate field data. Cannot be used for th XmlaStore store type. */ - summaryType?: string; - /** Allows you to use a custom aggregate function to calculate the summary values. Cannot be used for the XmlaStore store type. */ - calculateCustomSummary?: (options: { - summaryProcess?: string; - value?: any; - totalValue?: any; - }) => void; - /** Specifies the function that determines how to split data from the data source into ranges for header items. Cannot be used for the XmlaStore store type. */ - selector?: (data: Object) => any; - /** Type of the area where the field is located. */ - area?: string; - /** Index among the other fields displayed within the same area. */ - areaIndex?: number; - /** The name of the folder in which the field is located. */ - displayFolder?: string; - /** The name of the group to which the field belongs. */ - groupName?: string; - /** The index of the field within a group. */ - groupIndex?: number; - /** Specifies the initial sort order of field values. */ - sortOrder?: string; - /** Specifies how field data should be sorted. Can be used for the XmlaStore store type only. */ - sortBy?: string; - /** Specifies the data field against which the header items of this field should be sorted. */ - sortBySummaryField?: string; - /** The array of field names that specify a path to column/row whose summary field is used for sorting of this field's header items. */ - sortBySummaryPath?: Array; - /** The filter values for the current field. */ - filterValues?: Array; - /** The filter type for the current field. */ - filterType?: string; - /** Indicates whether all header items of the field's header level are expanded. */ - expanded?: boolean; - /** Specifies whether the field should be treated as a Data Field. */ - isMeasure?: boolean; - /** Specifies a display format for field values. */ - format?: string; - /** Specifies a callback function that returns the text to be displayed in the cells of a field. */ - customizeText?: (cellInfo: { value: any; valueText: string }) => string; - /** Specifies a precision for formatted field values. */ - precision?: number; - /** Specifies how to sort the header items. */ - sortingMethod?: (a: Object, b: Object) => number; - /** Allows an end-user to change sorting options. */ - allowSorting?: boolean; - /** Allows an end-user to sort columns by summary values. */ - allowSortingBySummary?: boolean; - /** Allows an end-user to change filtering options. */ - allowFiltering?: boolean; - /** Allows an end-user to expand/collapse all header items within a header level. */ - allowExpandAll?: boolean; - /** Specifies the absolute width of the field in the pivot grid. */ - width?: number; - } - export interface PivotGridDataSourceOptions { - /** Specifies the underlying Store instance used to access data. */ - store?: any; - /** Indicates whether or not the automatic field generation from data in the Store is enabled. */ - retrieveFields?: boolean; - /** Specifies data filtering conditions. */ - filter?: Object; - /** An array of pivot grid fields. */ - fields?: Array; - /** Indicates whether or not the local sorting of the XMLA data should be performed. */ - localSorting?: boolean; - /** A handler for the changed event. */ - onChanged?: () => void; - /** A handler for the loadingChanged event. */ - onLoadingChanged?: (isLoading: boolean) => void; - /** A handler for the loadError event. */ - onLoadError?: (e?: Object) => void; - /** A handler for the fieldsPrepared event. */ - onFieldsPrepared?: (e?: Array) => void; - } - /** An object that provides access to data for the dxPivotGrid widget. */ - export class PivotGridDataSource implements EventsMixin { - constructor(options?: PivotGridDataSource); - /** Starts loading data. */ - load(): JQueryPromise; - /** Indicates whether or not the PivotGridDataSource is currently being loaded. */ - isLoading(): boolean; - /** Gets data displayed in a PivotGrid. */ - getData(): Object; - /** Gets all fields within a specified area. */ - getAreaFields(area: string, collectGroups: boolean): Array; - /** Gets all fields from the data source. */ - fields(): Array; - /** Sets the fields option. */ - fields(fields: Array): void; - /** Gets current options of a specified field. */ - field(id: any): PivotGridField; - /** Sets one or more options of a specified field. */ - field(id: any, field: PivotGridField): void; - /** Collapses a specified header item. */ - collapseHeaderItem(area: string, path: Array): void; - /** Expands a specified header item. */ - expandHeaderItem(area: string, path: Array): void; - /** Expands all header items of a field. */ - expandAll(id: any): void; - /** Collapses all header items of a field. */ - collapseAll(id: any): void; - /** Disposes of all resources associated with this PivotGridDataSource. */ - dispose(): void; - on(eventName: string, eventHandler: Function): PivotGridDataSource; - on(events: { [eventName: string]: Function; }): PivotGridDataSource; - off(eventName: string): PivotGridDataSource; - off(eventName: string, eventHandler: Function): PivotGridDataSource; - } -} -declare namespace DevExpress.ui { - export interface dxSchedulerOptions extends WidgetOptions { - /** Specifies a date displayed on the current scheduler view by default. */ - currentDate?: Date; - /** The earliest date the widget allows you to select. */ - min?: Date; - /** The latest date the widget allows you to select. */ - max?: Date; - /** Specifies the view used in the scheduler by default. */ - currentView?: string; - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** Specifies the first day of a week. */ - firstDayOfWeek?: number; - /** The template to be used for rendering appointments. */ - appointmentTemplate?: any; - /** Lists the views to be available within the scheduler's View Selector. */ - views?: Array; - /** Specifies the resource kinds by which the scheduler's appointments are grouped in a timetable. */ - groups?: Array; - /** Specifies a start hour in the scheduler view's time interval. */ - startDayHour?: number; - /** Specifies an end hour in the scheduler view's time interval. */ - endDayHour?: number; - /** Specifies whether the scheduler data can be edited at runtime. */ - editing?: boolean; - /** Specifies an array of resources available in the scheduler. */ - resources?: Array<{ - /** Indicates whether or not several resources of this kind can be assigned to an appointment. */ - allowMultiple?: boolean; - /** Indicates whether or not resources of this kind have priority in the color identification of the appointments that have resources of different kinds assigned. */ - mainColor?: boolean; - /** A data source used to fetch resources to be available in the scheduler. */ - dataSource?: any; - /** Specifies the resource object field whose value is displayed by the Resource editor in the Appointment popup window. */ - displayExpr?: any; - /** Specifies the resource object field that is used as a value of the Resource editor in the Appointment popup window. */ - valueExpr?: any; - /** The name of the appointment object field that specifies a resource of this kind. */ - field?: string; - /** Specifies the label of the Appointment popup window field that allows end users to assign a resource of this kind. */ - label?: string; - }>; - /** A handler for the AppointmentAdding event. */ - onAppointmentAdding?: Function; - /** A handler for the appointmentAdded event. */ - onAppointmentAdded?: Function; - /** A handler for the AppointmentUpdating event. */ - onAppointmentUpdating?: Function; - /** A handler for the appointmentUpdated event. */ - onAppointmentUpdated?: Function; - /** A handler for the AppointmentDeleting event. */ - onAppointmentDeleting?: Function; - /** A handler for the appointmentDeleted event. */ - onAppointmentDeleted?: Function; - /** A handler for the appointmentRendered event. */ - onAppointmentRendered?: Function; - } - /** A widget that displays scheduled data using different views and provides the capability to load, add and edit appointments. */ - export class dxScheduler extends Widget { - constructor(element: JQuery, options?: dxSchedulerOptions); - constructor(element: Element, options?: dxSchedulerOptions); - /** Add the appointment defined by the object passed as a parameter to the data associated with the widget. */ - addAppointment(appointment: Object): void; - /** Updates the appointment specified by the first method parameter by the appointment object specified by the second method parameter in the the data associated with the widget. */ - updateAppointment(target: Object, appointment: Object): void; - /** Deletes the appointment defined by the parameter from the the data associated with the widget. */ - deleteAppointment(appointment: Object): void; - /** Scrolls the scheduler work space to the specified time. */ - scrollToTime(hours: number, minutes: number): void; - } - export interface dxColorBoxOptions extends dxDropDownEditorOptions { - /** Specifies the text displayed on the button that applies changes and closes the drop-down editor. */ - applyButtonText?: string; - applyValueMode?: string; - /** Specifies the text displayed on the button that cancels changes and closes the drop-down editor. */ - cancelButtonText?: string; - /** Specifies whether or not the widget value includes the alpha channel component. */ - editAlphaChannel?: boolean; - /** Specifies the size of a step by which a handle is moved using a keyboard shortcut. */ - keyStep?: number; - } - /** A widget used to specify a color value. */ - export class dxColorBox extends dxDropDownEditor { - constructor(element: JQuery, options?: dxColorBoxOptions); - constructor(element: Element, options?: dxColorBoxOptions); - } - export interface dxColorPickerOptions extends dxColorBoxOptions { } - /** - * A widget used to specify a color value. - * @deprecated Use the dxColorBox widget instead - */ - export class dxColorPicker extends dxColorBox { - constructor(element: JQuery, options?: dxColorPickerOptions); - constructor(element: Element, options?: dxColorPickerOptions); - } - export interface dxTreeViewOptions extends CollectionWidgetOptions { - /** Specifies whether or not to animate item collapsing and expanding. */ - animationEnabled?: boolean; - /** Specifies whether a nested or plain array is used as a data source. */ - dataStructure?: string; - /** Specifies whether or not a user can expand all tree view items by the "*" hot key. */ - expandAllEnabled?: boolean; - /** - * An array of currently expanded item objects. - * @deprecated Use item.expanded field instead - */ - expandedItems?: Array; - /** Specifies whether or not a check box is displayed at each tree view item. */ - showCheckBoxes?: boolean; - /** Specifies whether or not to select nodes recursively. */ - selectNodesRecursive?: boolean; - /** Specifies whether the "Select All" check box is displayed over the tree view. */ - selectAllEnabled?: boolean; - /** Specifies the text displayed at the "Select All" check box. */ - selectAllText?: string; - /** Specifies the name of the data source item field used as a key. */ - keyExpr?: any; - /** Specifies the name of the data source item field whose value is displayed by the widget. */ - displayExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding node is selected. */ - selectedExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding node is expanded. */ - expandedExpr?: any; - /** Specifies the name of the data source item field that contains an array of nested items. */ - itemsExpr?: any; - /** Specifies the name of the data source item field that holds the key of the parent item. */ - parentIdExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding node is disabled. */ - disabledExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding node includes child nodes. */ - hasItemsExpr?: any; - /** Specifies if the virtual mode is enabled. */ - virtualModeEnabled?: boolean; - /** Specifies the parent ID value of the root item. */ - rootValue?: any; - /** A string value specifying available scrolling directions. */ - scrollDirection?: string; - /** A handler for the itemSelected event. */ - onItemSelected?: Function; - /** A handler for the itemExpanded event. */ - onItemExpanded?: Function; - /** A handler for the itemCollapsed event. */ - onItemCollapsed?: Function; - onItemClick?: Function; - onItemContextMenu?: Function; - onItemRendered?: Function; - onItemHold?: Function; - hoverStateEnabled?: boolean; - focusStateEnabled?: boolean; - } - /** A widget displaying specified data items as a tree. */ - export class dxTreeView extends CollectionWidget { - constructor(element: JQuery, options?: dxTreeViewOptions); - constructor(element: Element, options?: dxTreeViewOptions); - /** Updates the tree view scrollbars according to the current size of the widget content. */ - updateDimensions(): JQueryPromise; - /** Selects the specified item. */ - selectItem(itemElement: any): void; - /** Unselects the specified item. */ - unselectItem(itemElement: any): void; - /** Expands the specified item. */ - expandItem(itemElement: any): void; - /** Collapses the specified item. */ - collapseItem(itemElement: any): void; - /** Returns all nodes of the tree view. */ - getNodes(): Array; - /** Selects all widget items. */ - selectAll(): void; - /** Unselects all widget items. */ - unselectAll(): void; - } - export interface dxMenuBaseOptions extends CollectionWidgetOptions { - /** An object that defines the animation options of the widget. */ - animation?: fx.AnimationOptions; - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** Specifies the name of the CSS class associated with the menu. */ - cssClass?: string; - /** Holds an array of menu items. */ - items?: Array; - /** Specifies whether or not an item becomes selected if an end-user clicks it. */ - selectionByClick?: boolean; - /** Specifies the selection mode supported by the menu. */ - selectionMode?: string; - /** Specifies options of submenu showing and hiding. */ - showSubmenuMode?: { - /** Specifies the mode name. */ - name?: string; - /** Specifies the delay of submenu show and hiding. */ - delay?: { - /** The time span after which the submenu is shown. */ - show?: number; - /** The time span after which the submenu is hidden. */ - hide?: number; - }; - }; - /** A Boolean value specifying whether or not the widget changes its state when being hovered by an end user. */ - hoverStateEnabled?: boolean; - } - export class dxMenuBase extends CollectionWidget { - constructor(element: JQuery, options?: dxMenuBaseOptions); - constructor(element: Element, options?: dxMenuBaseOptions); - /** Selects the specified item. */ - selectItem(itemElement: any): void; - /** Unselects the specified item. */ - unselectItem(itemElement: any): void; - } - export interface dxMenuOptions extends dxMenuBaseOptions { - /** Specifies whether or not the submenu is hidden when the mouse pointer leaves it. */ - hideSubmenuOnMouseLeave?: boolean; - /** Specifies whether the menu has horizontal or vertical orientation. */ - orientation?: string; - /** Specifies options for showing and hiding the first level submenu. */ - showFirstSubmenuMode?: { - /** Specifies the mode name. */ - name?: string; - /** Specifies the delay of submenu showing and hiding. */ - delay?: { - /** The time span after which the submenu is shown. */ - show?: number; - /** The time span after which the submenu is hidden. */ - hide?: number; - }; - }; - /** Specifies the direction at which the submenus are displayed. */ - submenuDirection?: string; - /** A handler for the submenuHidden event. */ - onSubmenuHidden?: Function; - submenuHiddenAction?: Function; - /** A handler for the submenuHiding event. */ - onSubmenuHiding?: Function; - submenuHidingAction?: Function; - /** A handler for the submenuShowing event. */ - onSubmenuShowing?: Function; - submenuShowingAction?: Function; - /** A handler for the submenuShown event. */ - onSubmenuShown?: Function; - submenuShownAction?: Function; - } - /** A menu widget. */ - export class dxMenu extends dxMenuBase { - constructor(element: JQuery, options?: dxMenuOptions); - constructor(element: Element, options?: dxMenuOptions); - } - export interface dxContextMenuOptions extends dxMenuBaseOptions { - /** Holds an object that specifies options of alternative menu invocation. */ - alternativeInvocationMode?: { - /** Specifies whether or not the standard context menu invocation (on a right mouse click or on a long tap) is disabled. */ - enabled?: Boolean; - /** Specifies the element used to invoke the context menu. */ - invokingElement?: any; - }; - /** A handler for the hidden event. */ - onHidden?: Function; - /** A handler for the hiding event. */ - onHiding?: Function; - /** A handler for the positioning event. */ - onPositioning?: Function; - /** A handler for the showing event. */ - onShowing?: Function; - /** A handler for the shown event. */ - onShown?: Function; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** Specifies the direction at which submenus are displayed. */ - submenuDirection?: string; - /** The target element associated with a popover. */ - target?: any; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - } - /** A context menu widget. */ - export class dxContextMenu extends dxMenuBase { - constructor(element: JQuery, options?: dxContextMenuOptions); - constructor(element: Element, options?: dxContextMenuOptions); - /** Toggles the visibility of the widget. */ - toggle(showing: boolean): JQueryPromise; - /** Shows the widget. */ - show(): JQueryPromise; - /** Hides the widget. */ - hide(): JQueryPromise; - } - export interface dxRemoteOperations { - /** Specifies whether or not filtering must be performed on the server side. */ - filtering?: boolean; - /** Specifies whether or not paging must be performed on the server side. */ - paging?: boolean; - /** Specifies whether or not sorting must be performed on the server side. */ - sorting?: boolean; - } - export interface dxDataGridColumn { - /** Specifies the content alignment within column cells. */ - alignment?: string; - /** Specifies whether the values in a column can be edited at runtime. Setting this option makes sense only when editing is enabled for a grid. */ - allowEditing?: boolean; - /** Specifies whether or not a column can be used for filtering grid records. Setting this option makes sense only when the filter row and column header filtering are visible. */ - allowFiltering?: boolean; - /** Specifies whether or not the column can be anchored to a grid edge by end users. Setting this option makes sense only when the columnFixing | enabled option is set to true. */ - allowFixing?: boolean; - /** Specifies if a column can be used for searching grid records. Setting this option makes sense only when the search panel is visible. */ - allowSearch?: boolean; - /** Specifies whether a column can be used for grouping grid records at runtime. Setting this option makes sense only when the group panel is visible. */ - allowGrouping?: boolean; - /** Specifies whether or not a column can be hidden by a user. Setting this option makes sense only when the column chooser is visible. */ - allowHiding?: boolean; - /** Specifies whether or not a particular column can be used in column reordering. Setting this option makes sense only when the allowColumnReordering option is set to true. */ - allowReordering?: boolean; - /** Specifies whether or not a particular column can be resized by a user. Setting this option makes sense only when the allowColumnResizing option is true. */ - allowResizing?: boolean; - /** Specifies whether grid records can be sorted by a specific column at runtime. Setting this option makes sense only when the sorting mode differs from none. */ - allowSorting?: boolean; - /** Specifies whether groups appear expanded or not when records are grouped by a specific column. Setting this option makes sense only when grouping is allowed for this column. */ - autoExpandGroup?: boolean; - /** Specifies a callback function that returns a value to be displayed in a column cell. */ - calculateCellValue?: (rowData: Object) => string; - /** Specifies a callback function that defines filters for customary calculated grid cells. */ - calculateFilterExpression?: (filterValue: any, selectedFilterOperation: string) => Array; - /** Specifies a caption for a column. */ - caption?: string; - /** Specifies a custom template for grid column cells. */ - cellTemplate?: any; - /** Specifies a CSS class to be applied to a column. */ - cssClass?: string; - /** Specifies a field name or a function that returns a field name or a value to be used for grouping column cells. */ - calculateGroupValue?: any; - /** Specifies a field name or a function that returns a field name or a value to be used for sorting column cells. */ - calculateSortValue?: any; - /** Specifies a callback function that returns the text to be displayed in the cells of a column. */ - customizeText?: (cellInfo: { value: any; valueText: string }) => string; - /** Specifies the field of a data source that provides data for a column. */ - dataField?: string; - /** Specifies the required type of column values. */ - dataType?: string; - /** Specifies a custom template for the cell of a grid column when it is in an editing state. */ - editCellTemplate?: any; - /** Specifies whether HTML tags are displayed as plain text or applied to the values of the column. */ - encodeHtml?: boolean; - /** In a boolean column, replaces all false items with a specified text. */ - falseText?: string; - /** Specifies the set of available filter operations. */ - filterOperations?: Array; - /** Specifies a filter value for a column. */ - filterValue?: any; - /** Specifies initial filter values for the column's header filter. */ - filterValues?: Array; - /** Specifies whether to include or exclude the records with the values selected in the column's header filter. */ - filterType?: string; - /** Indicates whether the column takes part in horizontal grid scrolling or is anchored to a grid edge. */ - fixed?: boolean; - /** Specifies the grid edge to which the column is anchored. */ - fixedPosition?: string; - /** Specifies a format for the values displayed in a column. */ - format?: string; - /** Specifies a custom template for the group cell of a grid column. */ - groupCellTemplate?: any; - /** Specifies the index of a column when grid records are grouped by the values of this column. */ - groupIndex?: number; - /** Specifies a custom template for the header of a grid column. */ - headerCellTemplate?: any; - /** Specifies options of a lookup column. */ - lookup?: { - /** Specifies whether or not a user can nullify values of a lookup column. */ - allowClearing?: boolean; - /** Specifies the data source providing data for a lookup column. */ - dataSource?: any; - /** Specifies the expression defining the data source field whose values must be displayed. */ - displayExpr?: any; - /** Specifies the expression defining the data source field whose values must be replaced. */ - valueExpr?: string; - }; - /** Specifies a precision for formatted values displayed in a column. */ - precision?: number; - /** Specifies a filter operation applied to a column. */ - selectedFilterOperation?: string; - /** Specifies whether or not the column displays its values by using editors. */ - showEditorAlways?: boolean; - /** Specifies whether or not to display the column when grid records are grouped by it. */ - showWhenGrouped?: boolean; - /** Specifies the index of a column when grid records are sorted by the values of this column. */ - sortIndex?: number; - /** Specifies the initial sort order of column values. */ - sortOrder?: string; - /** In a boolean column, replaces all true items with a specified text. */ - trueText?: string; - /** Specifies whether a column is visible or not. */ - visible?: boolean; - /** Specifies the sequence number of the column in the grid. */ - visibleIndex?: number; - /** Specifies a column width in pixels or percentages. */ - width?: any; - /** Specifies an array of validation rules to be checked when updating column cell values. */ - validationRules?: Array; - /** Specifies whether or not to display the header of a hidden column in the column chooser. */ - showInColumnChooser?: boolean; - /** Specifies the identifier of the column. */ - name?: string; - // NOTE https://github.com/DefinitelyTyped/DefinitelyTyped/pull/5590 - text?: string; - value?: any; - } - export interface dxDataGridOptions extends WidgetOptions { - /** Specifies whether the outer borders of the grid are visible or not. */ - showBorders?: boolean; - /** Indicates whether to show the error row for the grid. */ - errorRowEnabled?: boolean; - /** A handler for the rowValidating event. */ - onRowValidating?: (e: Object) => void; - /** A handler for the contextMenuPreparing event. */ - onContextMenuPreparing?: (e: Object) => void; - initNewRow?: (e: { data: Object }) => void; - /** A handler for the initNewRow event. */ - onInitNewRow?: (e: { data: Object }) => void; - rowInserted?: (e: { data: Object; key: any }) => void; - /** A handler for the rowInserted event. */ - onRowInserted?: (e: { data: Object; key: any }) => void; - rowInserting?: (e: { data: Object; cancel: boolean }) => void; - /** A handler for the rowInserting event. */ - onRowInserting?: (e: { data: Object; cancel: boolean }) => void; - rowRemoved?: (e: { data: Object; key: any }) => void; - /** A handler for the rowRemoved event. */ - onRowRemoved?: (e: { data: Object; key: any }) => void; - rowRemoving?: (e: { data: Object; key: any; cancel: boolean }) => void; - /** A handler for the rowRemoving event. */ - onRowRemoving?: (e: { data: Object; key: any; cancel: boolean }) => void; - rowUpdated?: (e: { data: Object; key: any }) => void; - /** A handler for the rowUpdated event. */ - onRowUpdated?: (e: { data: Object; key: any }) => void; - rowUpdating?: (e: { oldData: Object; newData: Object; key: any; cancel: boolean }) => void; - /** A handler for the rowUpdating event. */ - onRowUpdating?: (e: { oldData: Object; newData: Object; key: any; cancel: boolean }) => void; - /** Enables a hint that appears when a user hovers the mouse pointer over a cell with truncated content. */ - cellHintEnabled?: boolean; - /** Specifies whether or not grid columns can be reordered by a user. */ - allowColumnReordering?: boolean; - /** Specifies whether or not grid columns can be resized by a user. */ - allowColumnResizing?: boolean; - cellClick?: any; - /** A handler for the cellClick event. */ - onCellClick?: any; - cellHoverChanged?: (e: Object) => void; - /** A handler for the cellHoverChanged event. */ - onCellHoverChanged?: (e: Object) => void; - cellPrepared?: (e: Object) => void; - /** A handler for the cellPrepared event. */ - onCellPrepared?: (e: Object) => void; - /** Specifies whether or not the width of grid columns depends on column content. */ - columnAutoWidth?: boolean; - /** Specifies the options of a column chooser. */ - columnChooser?: { - /** Specifies text displayed by the column chooser panel when it does not contain any columns. */ - emptyPanelText?: string; - /** Specifies whether a user can invoke the column chooser or not. */ - enabled?: boolean; - /** Specifies the height of the column chooser panel. */ - height?: number; - /** Specifies text displayed in the title of the column chooser panel. */ - title?: string; - /** Specifies the width of the column chooser panel. */ - width?: number; - }; - /** Specifies options for column fixing. */ - columnFixing?: { - /** Indicates if column fixing is enabled. */ - enabled?: boolean; - /** Contains options that specify texts for column-fixing related commands in the column header's context menu. */ - texts?: { - /** Specifies text for a context menu item that fixes the column for which the context menu is invoked. */ - fix?: string; - /** Specifies text for a context menu item that unfixes the column for which the context menu is invoked. */ - unfix?: string; - /** Specifies text for a context menu subitem that fixes a column, for which the context menu is invoked, to the left grid edge. */ - leftPosition?: string; - /** Specifies text for a context menu subitem that fixes a column, for which the context menu is invoked, to the right grid edge. */ - rightPosition?: string; - }; - }; - /** Specifies options for filtering using a column header filter. */ - headerFilter?: { - /** Indicates whether or not the column header filter button is visible. */ - visible?: boolean; - /** Specifies the height of the dropdown menu invoked when using a column header filter. */ - height?: number; - /** Specifies the width of the dropdown menu invoked when using a column header filter. */ - width?: number; - /** Contains options that specify texts for the dropdown menu invoked when you use a column header filter. */ - texts?: { - /** Specifies text for the item specifying an empty value in the column header filter's dropdown menu. */ - emptyValue?: string; - /** Specifies text for a button that closes the column header filter's dropdown menu and applies specified filtering. */ - ok?: string; - /** Specifies text for a button that closes the column header filter's dropdown menu without applying performed selection. */ - cancel?: string; - } - }; - /** An array of grid columns. */ - columns?: Array; - onContentReady?: Function; - contentReadyAction?: Function; - /** Specifies a function that customizes grid columns after they are created. */ - customizeColumns?: (columns: Array) => void; - dataErrorOccurred?: (errorObject: Error) => void; - /** Specifies a data source for the grid. */ - dataSource?: any; - editingStart?: (e: { - data: Object; - key: any; - cancel: boolean; - column: dxDataGridColumn - }) => void; - /** A handler for the editingStart event. */ - onEditingStart?: (e: { - data: Object; - key: any; - cancel: boolean; - column: dxDataGridColumn - }) => void; - editorPrepared?: (e: Object) => void; - /** A handler for the editorPrepared event. */ - onEditorPrepared?: (e: Object) => void; - editorPreparing?: (e: Object) => void; - /** A handler for the editorPreparing event. */ - onEditorPreparing?: (e: Object) => void; - /** Contains options that specify how grid content can be changed. */ - editing?: { - /** Specifies whether or not grid records can be edited at runtime. */ - editEnabled?: boolean; - /** Specifies how grid values can be edited manually. */ - editMode?: string; - /** Specifies whether or not new records can be inserted into a grid. */ - insertEnabled?: boolean; - /** Specifies whether or not records can be deleted from a grid. */ - removeEnabled?: boolean; - /** Contains options that specify texts for editing-related grid controls. */ - texts?: { - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Save" button. Setting this option makes sense only when the editMode option is set to batch. */ - saveAllChanges?: string; - /** Specifies text for a cancel button displayed when a row is in the editing state. Setting this option makes sense only when the editEnabled option is set to true. */ - cancelRowChanges?: string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Revert" button. Setting this option makes sense only when the editMode option is set to batch. */ - cancelAllChanges?: string; - /** Specifies a message to be displayed by a confirmation window. Setting this option makes sense only when the edit mode is "row". */ - confirmDeleteMessage?: string; - /** Specifies text to be displayed in the title of a confirmation window. Setting this option makes sense only when the edit mode is "row". */ - confirmDeleteTitle?: string; - /** Specifies text for a button that deletes a row from a grid. Setting this option makes sense only when the removeEnabled option is set to true. */ - deleteRow?: string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Add" button. Setting this option makes sense only when the insertEnabled option is true. */ - addRow?: string; - /** Specifies text for a button that turns a row into the editing state. Setting this option makes sense only when the editEnabled option is set to true. */ - editRow?: string; - /** Specifies text for a save button displayed when a row is in the editing state. Setting this option makes sense only when the editEnabled option is set to true. */ - saveRowChanges?: string; - /** Specifies text for a button that recovers a deleted row. Setting this option makes sense only if the grid uses the batch edit mode and the removeEnabled option is set to true. */ - undeleteRow?: string; - }; - }; - /** Specifies filter row options. */ - filterRow?: { - /** Specifies when to apply a filter. */ - applyFilter?: string; - /** Specifies text for the hint that pops up when a user hovers the mouse pointer over the "Apply Filter" button. */ - applyFilterText?: string; - /** Specifies descriptions for filter operations. */ - operationDescriptions?: { - "=": string; - "<>": string; - "<": string; - "<=": string; - ">": string; - ">=": string; - "startswith": string; - "contains": string; - "notcontains": string; - "endswith": string; - }; - /** Specifies text for the reset operation in a filter list. */ - resetOperationText?: string; - /** Specifies text for the operation of clearing the applied filter when a select box is used. */ - showAllText?: string; - /** Specifies whether or not an icon that allows the user to choose a filter operation is visible. */ - showOperationChooser?: boolean; - /** Specifies whether the filter row is visible or not. */ - visible?: boolean; - }; - /** Specifies the behavior of grouped grid records. */ - grouping?: { - /** Specifies whether the user can collapse grouped records in a grid or not. */ - allowCollapsing?: boolean; - /** Specifies whether groups appear expanded or not. */ - autoExpandAll?: boolean; - /** Specifies the message displayed in a group row when the corresponding group is continued from the previous page. */ - groupContinuedMessage?: string; - /** Specifies the message displayed in a group row when the corresponding group continues on the next page. */ - groupContinuesMessage?: string; - }; - /** Specifies options that configure the group panel. */ - groupPanel?: { - /** Specifies whether columns can be dragged onto or from the group panel. */ - allowColumnDragging?: boolean; - /** Specifies text displayed by the group panel when it does not contain any columns. */ - emptyPanelText?: string; - /** Specifies whether the group panel is visible or not. */ - visible?: boolean; - }; - /** Specifies options configuring the load panel. */ - loadPanel?: { - /** Specifies whether to show the load panel or not. */ - enabled?: boolean; - /** Specifies the height of the load panel in pixels. */ - height?: number; - /** Specifies a URL pointing to an image to be used as a loading indicator. */ - indicatorSrc?: string; - /** Specifies whether or not a loading indicator must be displayed on the load panel. */ - showIndicator?: boolean; - /** Specifies whether or not the pane of the load panel must be displayed. */ - showPane?: boolean; - /** Specifies text displayed by the load panel. */ - text?: string; - /** Specifies the width of the load panel in pixels. */ - width?: number; - }; - /** Specifies text displayed when a grid does not contain any records. */ - noDataText?: string; - /** Specifies the options of a grid pager. */ - pager?: { - /** Specifies the page sizes that can be selected at runtime. */ - allowedPageSizes?: any; - /** Specifies whether to show the page size selector or not. */ - showPageSizeSelector?: boolean; - /** Specifies whether to show the pager or not. */ - visible?: any; - /** Specifies the text accompanying the page navigator. */ - infoText?: string; - /** Specifies whether or not to display the text accompanying the page navigator. This text is specified by the infoText option. */ - showInfo?: boolean; - /** Specifies whether or not to display buttons that switch the grid to the previous or next page. */ - showNavigationButtons?: boolean; - }; - /** Specifies paging options. */ - paging?: { - /** Specifies whether dxDataGrid loads data page by page or all at once. */ - enabled?: boolean; - /** Specifies the grid page that should be displayed by default. */ - pageIndex?: number; - /** Specifies the size of grid pages. */ - pageSize?: number; - }; - /** Specifies whether or not grid rows must be shaded in a different way. */ - rowAlternationEnabled?: boolean; - rowClick?: any; - /** A handler for the rowClick event. */ - onRowClick?: any; - rowPrepared?: (e: Object) => void; - /** A handler for the rowPrepared event. */ - onRowPrepared?: (e: Object) => void; - /** Specifies a custom template for grid rows. */ - rowTemplate?: any; - /** A configuration object specifying scrolling options. */ - scrolling?: { - /** Specifies the scrolling mode. */ - mode?: string; - /** Specifies whether or not a grid must preload pages adjacent to the current page when using virtual scrolling. */ - preloadEnabled?: boolean; - }; - /** Specifies options of the search panel. */ - searchPanel?: { - /** Specifies whether or not search strings in the located grid records should be highlighted. */ - highlightSearchText?: boolean; - /** Specifies text displayed by the search panel when no search string was typed. */ - placeholder?: string; - /** Specifies whether the search panel is visible or not. */ - visible?: boolean; - /** Specifies the width of the search panel in pixels. */ - width?: number; - /** Sets a search string for the search panel. */ - text?: string; - }; - /** Specifies the operations that must be performed on the server side. */ - remoteOperations?: any; - /** Allows you to sort groups according to the values of group summary items. */ - sortByGroupSummaryInfo?: Array<{ - /** Specifies the group summary item whose values must be used to sort groups. */ - summaryItem?: string; - /** Specifies the identifier of the column that must be used in grouping so that sorting by group summary item values be applied. */ - groupColumn?: string; - /** Specifies the sort order of group summary item values. */ - sortOrder?: string; - }>; - /** Allows you to build a master-detail interface in the grid. */ - masterDetail?: { - /** Enables an end-user to expand/collapse detail sections. */ - enabled?: boolean; - /** Specifies whether detail sections appear expanded or collapsed. */ - autoExpandAll?: boolean; - /** Specifies the template for detail sections. */ - template?: any; - }; - /** Specifies options for exporting grid data. */ - export?: { - /** Indicates if the export feature is enabled in the grid. */ - enabled?: boolean; - /** Specifies a default name for the file to which grid data is exported. */ - fileName?: string; - /** Specifies whether to enable Excel filtering for the exported data in the resulting XLSX file. */ - excelFilterEnabled?: boolean; - /** Specifies whether to enable word wrapping for the exported data in the resulting XLSX file. */ - excelWrapTextEnabled?: boolean; - /** Specifies the URL of the server-side proxy that streams the resulting file to the end user to enable export in IE8, IE9 and Safari browsers. */ - proxyUrl?: string; - /** Indicates whether to allow end users to export not only the data displayed in the grid, but the selected rows only. */ - allowExportSelectedData?: boolean; - /** Contains options that specify texts for the export-related commands and hints. */ - texts?: { - /** Specifies text for the Export button when this button invokes a dropdown menu so you can choose the required export format. */ - exportTo?: string; - /** Specifies text for the Export button when this button exports to the XSLX format. */ - exportToExcel?: string; - /** Specifies text for the item in the Export dropdown menu that exports grid data to Excel. */ - excelFormat?: string; - /** Specifies text for the option in the Export dropdown menu that allows you to choose whether to export all the grid data or the selected rows only. */ - selectedRows?: string; - } - }; - /** Specifies the keys of the records that must appear selected initially. */ - selectedRowKeys?: Array; - /** Specifies options of runtime selection. */ - selection?: { - /** Specifies whether the user can select all grid records at once. */ - allowSelectAll?: boolean; - /** Specifies the selection mode. */ - mode?: string; - }; - selectionChanged?: (e: { - currentSelectedRowKeys: Array; - currentDeselectedRowKeys: Array; - selectedRowKeys: Array; - selectedRowsData: Array; - }) => void; - /** A handler for the dataErrorOccured event. */ - onDataErrorOccurred?: (e: { error: Error }) => void; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: (e: { - currentSelectedRowKeys: Array; - currentDeselectedRowKeys: Array; - selectedRowKeys: Array; - selectedRowsData: Array; - }) => void; - /** A handler for the exporting event. */ - onExporting?: (e: { - fileName: string; - format: string; - cancel: boolean; - }) => void; - /** A handler for the exported event. */ - onExported?: (e: Object) => void; - /** A handler for the keyDown event. */ - onKeyDown?: (e: Object) => void; - /** A handler for the rowExpanding event. */ - onRowExpanding?: (e: Object) => void; - /** A handler for the rowExpanded event. */ - onRowExpanded?: (e: Object) => void; - /** A handler for the rowCollapsing event. */ - onRowCollapsing?: (e: Object) => void; - /** A handler for the rowCollapsed event. */ - onRowCollapsed?: (e: Object) => void; - /** Specifies whether column headers are visible or not. */ - showColumnHeaders?: boolean; - /** Specifies whether or not vertical lines separating one grid column from another are visible. */ - showColumnLines?: boolean; - /** Specifies whether or not horizontal lines separating one grid row from another are visible. */ - showRowLines?: boolean; - /** Specifies options of runtime sorting. */ - sorting?: { - /** Specifies text for the context menu item that sets an ascending sort order in a column. */ - ascendingText?: string; - /** Specifies text for the context menu item that resets sorting settings for a column. */ - clearText?: string; - /** Specifies text for the context menu item that sets a descending sort order in a column. */ - descendingText?: string; - /** Specifies the runtime sorting mode. */ - mode?: string; - }; - /** Specifies options of state storing. */ - stateStoring?: { - /** Specifies a callback function that performs specific actions on state loading. */ - customLoad?: () => JQueryPromise; - /** Specifies a callback function that performs specific actions on state saving. */ - customSave?: (gridState: Object) => void; - /** Specifies whether or not a grid saves its state. */ - enabled?: boolean; - /** Specifies the delay between the last change of a grid state and the operation of saving this state in milliseconds. */ - savingTimeout?: number; - /** Specifies a unique key to be used for storing the grid state. */ - storageKey?: string; - /** Specifies the type of storage to be used for state storing. */ - type?: string; - }; - /** Specifies the options of the grid summary. */ - summary?: { - /** Contains options that specify text patterns for summary items. */ - texts?: { - /** Specifies a pattern for the 'sum' summary items when they are displayed in the parent column. */ - sum?: string; - /** Specifies a pattern for the 'sum' summary items displayed in a group row or in any other column rather than the parent one. */ - sumOtherColumn?: string; - /** Specifies a pattern for the 'min' summary items when they are displayed in the parent column. */ - min?: string; - /** Specifies a pattern for the 'min' summary items displayed in a group row or in any other column rather than the parent one. */ - minOtherColumn?: string; - /** Specifies a pattern for the 'max' summary items when they are displayed in the parent column. */ - max?: string; - /** Specifies a pattern for the 'max' summary items displayed in a group row or in any other column rather than the parent one. */ - maxOtherColumn?: string; - /** Specifies a pattern for the 'avg' summary items when they are displayed in the parent column. */ - avg?: string; - /** Specifies a pattern for the 'avg' summary items displayed in a group row or in any other column rather than the parent one. */ - avgOtherColumn?: string; - /** Specifies a pattern for the 'count' summary items. */ - count?: string; - }; - /** Specifies items of the group summary. */ - groupItems?: Array<{ - /** Specifies the identifier of a summary item. */ - name?: string; - /** Specifies the column that provides data for a group summary item. */ - column?: string; - /** Customizes the text to be displayed in the summary item. */ - customizeText?: (itemInfo: { - value: any; - valueText: string; - }) => string; - /** Specifies a pattern for the summary item text. */ - displayFormat?: string; - /** Specifies a precision for the summary item value of a numeric format. */ - precision?: number; - /** Specifies whether or not a summary item must be displayed in the group footer. */ - showInGroupFooter?: boolean; - /** Indicates whether to display group summary items in parentheses after the group row header or to align them by the corresponding columns within the group row. */ - alignByColumn?: boolean; - /** Specifies the column that must hold the summary item when this item is displayed in the group footer or aligned by a column in the group row. */ - showInColumn?: string; - /** Specifies how to aggregate data for a summary item. */ - summaryType?: string; - /** Specifies a format for the summary item value. */ - valueFormat?: string; - }>; - /** Specifies items of the total summary. */ - totalItems?: Array<{ - /** Specifies the identifier of a summary item. */ - name?: string; - /** Specifies the alignment of a summary item. */ - alignment?: string; - /** Specifies the column that provides data for a summary item. */ - column?: string; - /** Specifies a CSS class to be applied to a summary item. */ - cssClass?: string; - /** Customizes the text to be displayed in the summary item. */ - customizeText?: (itemInfo: { - value: any; - valueText: string; - }) => string; - /** Specifies a pattern for the summary item text. */ - displayFormat?: string; - /** Specifies a precision for the summary item value of a numeric format. */ - precision?: number; - /** Specifies the column that must hold the summary item. */ - showInColumn?: string; - /** Specifies how to aggregate data for a summary item. */ - summaryType?: string; - /** Specifies a format for the summary item value. */ - valueFormat?: string; - }>; - /** Allows you to use a custom aggregate function to calculate the value of a summary item. */ - calculateCustomSummary?: (options: { - component: dxDataGrid; - name?: string; - value: any; - totalValue: any; - summaryProcess: string - }) => void; - }; - /** Specifies whether text that does not fit into a column should be wrapped. */ - wordWrapEnabled?: boolean; - } - /** A data grid widget. */ - export class dxDataGrid extends Widget { - constructor(element: JQuery, options?: dxDataGridOptions); - constructor(element: Element, options?: dxDataGridOptions); - /** Ungroups grid records. */ - clearGrouping(): void; - /** Clears sorting settings of all grid columns at once. */ - clearSorting(): void; - /** Allows you to obtain a cell by its row index and the data field of its column. */ - getCellElement(rowIndex: number, dataField: string): any; - /** Allows you to obtain a cell by its row index and the visible index of its column. */ - getCellElement(rowIndex: number, visibleColumnIndex: number): any; - /** Returns the current state of the grid. */ - state(): Object; - /** Sets the grid state. */ - state(state: Object): void; - /** Allows you to obtain the row index by a data key. */ - getRowIndexByKey(key: any): number; - /** Allows you to obtain the data key by a row index. */ - getKeyByRowIndex(rowIndex: number): any; - /** Adds a new column to a grid. */ - addColumn(columnOptions: dxDataGridColumn): void; - /** Displays the load panel. */ - beginCustomLoading(messageText: string): void; - /** Discards changes made in a grid. */ - cancelEditData(): void; - /** Clears all the filters of a specific type applied to grid records. */ - clearFilter(): void; - /** Deselects all grid records. */ - clearSelection(): void; - /** Draws the cell being edited from the editing state. Use this method when the edit mode is batch. */ - closeEditCell(): void; - /** Collapses groups or master rows in a grid. */ - collapseAll(groupIndex?: number): void; - /** Returns the number of data columns in a grid. */ - columnCount(): number; - /** Returns the value of a specific column option. */ - columnOption(id: any, optionName: string): any; - /** Sets an option of a specific column. */ - columnOption(id: any, optionName: string, optionValue: any): void; - /** Returns the options of a column by an identifier. */ - columnOption(id: any): Object; - /** Sets several options of a column at once. */ - columnOption(id: any, options: Object): void; - /** Sets a specific cell into the editing state. */ - editCell(rowIndex: number, columnIndex: number): void; - /** Sets a specific row into the editing state. */ - editRow(rowIndex: number): void; - /** Hides the load panel. */ - endCustomLoading(): void; - /** Expands groups or master rows in a grid. */ - expandAll(groupIndex: number): void; - /** Allows you to find out whether a specific group or master row is expanded or collapsed. */ - isRowExpanded(key: any): boolean; - /** Allows you to expand a specific group or master row by its key. */ - expandRow(key: any): void; - /** Allows you to collapse a specific group or master row by its key. */ - collapseRow(key: any): void; - /** Applies a filter to the grid's data source. */ - filter(filterExpr?: any): void; - /** Returns a filter expression applied to the grid's data source using the filter(filterExpr) method. */ - filter(): any; - /** Returns a filter expression applied to the grid using all possible scenarious. */ - getCombinedFilter(): any; - /** Gets the keys of currently selected grid records. */ - getSelectedRowKeys(): Array; - /** Gets the data objects of currently selected grid records. */ - getSelectedRowsData(): Array; - /** Hides the column chooser panel. */ - hideColumnChooser(): void; - /** Adds a new data row to a grid. */ - insertRow(): void; - /** Returns the key corresponding to the passed data object. */ - keyOf(obj: Object): any; - /** Switches a grid to a specified page. */ - pageIndex(newIndex: number): void; - /** Gets the index of the current page. */ - pageIndex(): number; - /** Sets the page size. */ - pageSize(value: number): void; - /** Gets the current page size. */ - pageSize(): number; - /** Refreshes grid data. */ - refresh(): void; - /** Removes a specific row from a grid. */ - removeRow(rowIndex: number): void; - /** Saves changes made in a grid. */ - saveEditData(): void; - /** Searches grid records by a search string. */ - searchByText(text: string): void; - /** Selects all grid records. */ - selectAll(): void; - /** Deselects the rows that are currently selected within the applied filter. */ - deselectAll(): void; - /** Selects specific grid records. */ - selectRows(keys: Array, preserve: boolean): void; - /** Deselects specific grid records. */ - deselectRows(keys: Array): void; - /** Selects grid rows by indexes. */ - selectRowsByIndexes(indexes: Array): void; - /** Allows you to find out whether a row is selected or not. */ - isRowSelected(key: any): boolean; - /** Invokes the column chooser panel. */ - showColumnChooser(): void; - startSelectionWithCheckboxes(): boolean; - /** Returns the number of records currently held by a grid. */ - totalCount(): number; - /** Recovers a row deleted in the batch edit mode. */ - undeleteRow(rowIndex: number): void; - /** Allows you to obtain a data object by its key. */ - byKey(key: any): JQueryPromise; - /** Gets the value of a total summary item. */ - getTotalSummaryValue(summaryItemName: string): any; - /** Exports grid data to Excel. */ - exportToExcel(selectionOnly: boolean): void; - /** Updates the grid to the size of its content. */ - updateDimensions(): void; - /** Focuses the specified cell element in the grid. */ - focus(element?: JQuery): void; - } - export interface dxPivotGridOptions extends WidgetOptions { - onContentReady?: Function; - /** Specifies a data source for the pivot grid. */ - dataSource?: any; - /** Specifies whether or not the widget uses native scrolling. */ - useNativeScrolling?: any; - /** Allows an end-user to change sorting options. */ - allowSorting?: boolean; - /** Allows an end-user to sort columns by summary values. */ - allowSortingBySummary?: boolean; - /** Allows an end-user to change filtering options. */ - allowFiltering?: boolean; - /** Allows an end-user to expand/collapse all header items within a header level. */ - allowExpandAll?: boolean; - /** Specifies whether to display the Total rows. */ - showRowTotals?: boolean; - /** Specifies whether to display the Grand Total row. */ - showRowGrandTotals?: boolean; - /** Specifies whether to display the Total columns. */ - showColumnTotals?: boolean; - /** Specifies whether to display the Grand Total column. */ - showColumnGrandTotals?: boolean; - /** The Field Chooser configuration options. */ - fieldChooser?: { - /** Enables or disables the field chooser. */ - enabled?: boolean; - /** Specifies the field chooser layout. */ - layout?: number; - /** Specifies the text to display as a title of the field chooser popup window. */ - title?: string; - /** Specifies the field chooser width. */ - width?: number; - /** Specifies the field chooser height. */ - height?: number; - /** Strings that can be changed or localized in the pivot grid's integrated Field Chooser. */ - texts?: { - /** The string to display instead of Row Fields. */ - rowFields?: string; - /** The string to display instead of Column Fields. */ - columnFields?: string; - /** The string to display instead of Data Fields. */ - dataFields?: string; - /** The string to display instead of Filter Fields. */ - filterFields?: string; - /** The string to display instead of All Fields. */ - allFields?: string; - }; - } - /** Strings that can be changed or localized in the dxPivotGrid widget. */ - texts?: { - /** The string to display as a header of the Grand Total row and column. */ - grandTotal?: string; - /** The string to display as a header of the Total row and column. */ - total?: string; - /** Specifies the text displayed when a pivot grid does not contain any fields. */ - noData?: string; - /** The string to display as a Show Field Chooser context menu item. */ - showFieldChooser?: string; - /** The string to display as an Expand All context menu item. */ - expandAll?: string; - /** The string to display as a Collapse All context menu item. */ - collapseAll?: string; - /** The string to display as a Sort Column by Summary Value context menu item. */ - sortColumnBySummary?: string; - /** The string to display as a Sort Row by Summary Value context menu item. */ - sortRowBySummary?: string; - /** The string to display as a Remove All Sorting context menu item. */ - removeAllSorting?: string; - }; - /** The Load panel configuration options. */ - loadPanel?: { - /** Enables or disables the load panel. */ - enabled?: boolean; - /** Specifies the height of the load panel. */ - height?: number; - /** Specifies the URL pointing to an image that will be used as a load indicator. */ - indicatorSrc?: string; - /** Specifies whether or not to show a load indicator. */ - showIndicator?: boolean; - /** Specifies whether or not to show load panel background. */ - showPane?: boolean; - /** Specifies the text to display inside a load panel. */ - text?: string; - /** Specifies the width of the load panel. */ - width?: number; - }; - /** A handler for the cellClick event. */ - onCellClick?: (e: any) => void; - /** A handler for the cellPrepared event. */ - onCellPrepared?: (e: any) => void; - /** A handler for the contextMenuPreparing event. */ - onContextMenuPreparing?: (e: Object) => void; - } - /** A data summarization widget for multi-dimensional data analysis and data mining. */ - export class dxPivotGrid extends Widget { - constructor(element: JQuery, options?: dxPivotGridOptions); - constructor(element: Element, options?: dxPivotGridOptions); - /** Gets the PivotGridDataSource instance. */ - getDataSource(): DevExpress.data.PivotGridDataSource; - /** Updates the widget to the size of its content. */ - updateDimensions(): void; - } - export interface dxPivotGridFieldChooserOptions extends WidgetOptions { - /** Specifies the height of the widget. */ - height?: any; - /** Specifies the field chooser layout. */ - layout?: number; - /** The data source of a dxPivotGrid widget. */ - dataSource?: DevExpress.data.PivotGridDataSource; - onContentReady?: Function; - /** Strings that can be changed or localized in the dxPivotGridFieldChooser widget. */ - texts?: { - /** The string to display instead of Row Fields. */ - rowFields?: string; - /** The string to display instead of Column Fields. */ - columnFields?: string; - /** The string to display instead of Data Fields. */ - dataFields?: string; - /** The string to display instead of Filter Fields. */ - filterFields?: string; - /** The string to display instead of All Fields. */ - allFields?: string; - }; - } - /** A complementary widget for dxPivotGrid that allows you to manage data displayed in the dxPivotGrid. */ - export class dxPivotGridFieldChooser extends Widget { - constructor(element: JQuery, options?: dxPivotGridFieldChooserOptions); - constructor(element: Element, options?: dxPivotGridFieldChooserOptions); - /** Updates the widget to the size of its content. */ - updateDimensions(): void; - } -} -interface JQuery { - dxTreeView(): JQuery; - dxTreeView(options: "instance"): DevExpress.ui.dxTreeView; - dxTreeView(options: string): any; - dxTreeView(options: string, ...params: any[]): any; - dxTreeView(options: DevExpress.ui.dxTreeViewOptions): JQuery; - dxMenuBase(): JQuery; - dxMenuBase(options: "instance"): DevExpress.ui.dxMenuBase; - dxMenuBase(options: string): any; - dxMenuBase(options: string, ...params: any[]): any; - dxMenuBase(options: DevExpress.ui.dxMenuBaseOptions): JQuery; - dxMenu(): JQuery; - dxMenu(options: "instance"): DevExpress.ui.dxMenu; - dxMenu(options: string): any; - dxMenu(options: string, ...params: any[]): any; - dxMenu(options: DevExpress.ui.dxMenuOptions): JQuery; - dxContextMenu(): JQuery; - dxContextMenu(options: "instance"): DevExpress.ui.dxContextMenu; - dxContextMenu(options: string): any; - dxContextMenu(options: string, ...params: any[]): any; - dxContextMenu(options: DevExpress.ui.dxContextMenuOptions): JQuery; - dxColorBox(): JQuery; - dxColorBox(options: "instance"): DevExpress.ui.dxColorBox; - dxColorBox(options: string): any; - dxColorBox(options: string, ...params: any[]): any; - dxColorBox(options: DevExpress.ui.dxColorBoxOptions): JQuery; - dxDataGrid(): JQuery; - dxDataGrid(options: "instance"): DevExpress.ui.dxDataGrid; - dxDataGrid(options: string): any; - dxDataGrid(options: string, ...params: any[]): any; - dxDataGrid(options: DevExpress.ui.dxDataGridOptions): JQuery; - dxPivotGrid(): JQuery; - dxPivotGrid(options: "instance"): DevExpress.ui.dxPivotGrid; - dxPivotGrid(options: string): any; - dxPivotGrid(options: string, ...params: any[]): any; - dxPivotGrid(options: DevExpress.ui.dxPivotGridOptions): JQuery; - dxPivotGridFieldChooser(): JQuery; - dxPivotGridFieldChooser(options: "instance"): DevExpress.ui.dxPivotGridFieldChooser; - dxPivotGridFieldChooser(options: string): any; - dxPivotGridFieldChooser(options: string, ...params: any[]): any; - dxPivotGridFieldChooser(options: DevExpress.ui.dxPivotGridFieldChooserOptions): JQuery; - dxScheduler(): JQuery; - dxScheduler(options: "instance"): DevExpress.ui.dxScheduler; - dxScheduler(options: string): any; - dxScheduler(options: string, ...params: any[]): any; - dxScheduler(options: DevExpress.ui.dxSchedulerOptions): JQuery; -} -declare namespace DevExpress.framework { - /** An object used to store information on the views displayed in an application. */ - export class ViewCache { - viewRemoved: JQueryCallback; - /** Removes all the viewInfo objects from the cache. */ - clear(): void; - /** Obtains a viewInfo object from the cache by the specified key. */ - getView(key: string): Object; - /** Checks whether or not a viewInfo object is contained in the view cache under the specified key. */ - hasView(key: string): boolean; - /** Removes a viewInfo object from the cache by the specified key. */ - removeView(key: string): Object; - /** Adds the specified viewInfo object to the cache under the specified key. */ - setView(key: string, viewInfo: Object): void; - } - export interface dxCommandOptions extends DOMComponentOptions { - action?: any; - /** Specifies an action performed when the execute() method of the command is called. */ - onExecute?: any; - /** Indicates whether or not the widget that displays this command is disabled. */ - disabled?: boolean; - /** Specifies whether the current command is rendered when a view is being rendered or after a view is shown. */ - renderStage?: string; - /** Specifies the name of the icon shown inside the widget associated with this command. */ - icon?: string; - iconSrc?: string; - /** The identifier of the command. */ - id?: string; - /** Specifies the title of the widget associated with this command. */ - title?: string; - /** Specifies the type of the button, if the command is rendered as a dxButton widget. */ - type?: string; - /** A Boolean value specifying whether or not the widget associated with this command is visible. */ - visible?: boolean; - } - /** A markup component used to define markup options for a command. */ - export class dxCommand extends DOMComponent { - constructor(element: JQuery, options: dxCommandOptions); - constructor(options: dxCommandOptions); - /** Executes the action associated with this command. */ - execute(): void; - } - /** An object responsible for routing. */ - export class Router { - /** Adds a routing rule to the list of registered rules. */ - register(pattern: string, defaults?: Object, constraints?: Object): void; - /** Decodes the specified URI to an object using the registered routing rules. */ - parse(uri: string): Object; - /** Formats an object to a URI. */ - format(obj: Object): string; - } - export interface StateManagerOptions { - /** A storage to which the state manager saves the application state. */ - storage?: Object; - } - /** An object used to store the current application state. */ - export class StateManager { - constructor(options?: StateManagerOptions); - /** Adds an object that implements an interface of a state source to the state manager's collection of state sources. */ - addStateSource(stateSource: Object): void; - /** Removes a specified state source from the state manager's collection of state sources. */ - removeStateSource(stateSource: Object): void; - /** Saves the current application state. */ - saveState(): void; - /** Restores the application state that has been saved by the saveState() method to the state storage. */ - restoreState(): void; - /** Removes the application state that has been saved by the saveState() method to the state storage. */ - clearState(): void; - } - export module html { - export var layoutSets: Array; - export var animationSets: { [animationSetName: string]: AnimationSet }; - export interface AnimationSet { - [animationName: string]: any - } - export interface HtmlApplicationOptions { - /** Specifies where the commands that are defined in the application's views must be displayed. */ - commandMapping?: Object; - /** Specifies whether or not view caching is disabled. */ - disableViewCache?: boolean; - /** An array of layout controllers that should be used to show application views in the current navigation context. */ - layoutSet?: any; - /** Specifies the animation presets that are used to animate different UI elements in the current application. */ - animationSet?: AnimationSet; - /** Specifies whether the current application must behave as a mobile or web application. */ - mode?: string; - /** Specifies the object that represents a root namespace of the application. */ - namespace?: Object; - /** Specifies application behavior when the user navigates to a root view. */ - navigateToRootViewMode?: string; - /** An array of dxCommand configuration objects used to define commands available from the application's global navigation. */ - navigation?: Array; - /** A state manager to be used in the application. */ - stateManager?: StateManager; - /** Specifies the storage to be used by the application's state manager to store the application state. */ - stateStorage?: Object; - /** Indicates whether on not to use the title of the previously displayed view as text on the Back button. */ - useViewTitleAsBackText?: boolean; - /** A custom view cache to be used in the application. */ - viewCache?: Object; - /** Specifies a limit for the views that can be cached. */ - viewCacheSize?: number; - /** Specifies options for the viewport meta tag of a mobile browser. */ - viewPort?: JQuery; - /** A custom router to be used in the application. */ - router?: Router; - } - /** An object used to manage views, as well as control the application life cycle. */ - export class HtmlApplication implements EventsMixin { - constructor(options: HtmlApplicationOptions); - afterViewSetup: JQueryCallback; - beforeViewSetup: JQueryCallback; - initialized: JQueryCallback; - navigating: JQueryCallback; - navigatingBack: JQueryCallback; - resolveLayoutController: JQueryCallback; - viewDisposed: JQueryCallback; - viewDisposing: JQueryCallback; - viewHidden: JQueryCallback; - viewRendered: JQueryCallback; - viewShowing: JQueryCallback; - viewShown: JQueryCallback; - /** Provides access to the ViewCache object. */ - viewCache: ViewCache; - /** An array of dxCommand components that are created based on the application's navigation option value. */ - navigation: Array; - /** Provides access to the StateManager object. */ - stateManager: StateManager; - /** Provides access to the Router object. */ - router: Router; - /** Navigates to the URI preceding the current one in the navigation history. */ - back(): void; - /** Returns a Boolean value indicating whether or not backwards navigation is currently possible. */ - canBack(): boolean; - /** Calls the clearState() method of the application's StateManager object. */ - clearState(): void; - /** Creates global navigation commands. */ - createNavigation(navigationConfig: Array): void; - /** Returns an HTML template of the specified view. */ - getViewTemplate(viewName: string): JQuery; - /** Returns a configuration object used to create a dxView component for a specified view. */ - getViewTemplateInfo(viewName: string): Object; - /** Adds a specified HTML template to a collection of view or layout templates. */ - loadTemplates(source: any): JQueryPromise; - /** Navigates to the specified URI. */ - navigate(uri?: any, options?: Object): void; - /** Renders navigation commands to the navigation command containers that are located in the layouts used in the application. */ - renderNavigation(): void; - /** Calls the restoreState() method of the application's StateManager object. */ - restoreState(): void; - /** Calls the saveState method of the application's StateManager object. */ - saveState(): void; - /** Provides access to the object that defines the current context to be considered when choosing an appropriate template for a view. */ - templateContext(): Object; - on(eventName: "initialized", eventHandler: () => void): HtmlApplication; - on(eventName: "afterViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "beforeViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "navigating", eventHandler: (e: { - currentUri: string; - uri: string; - cancel: boolean; - options: { - root: boolean; - target: string; - direction: string; - rootInDetailPane: boolean; - modal: boolean; - }; - }) => void): HtmlApplication; - on(eventName: "navigatingBack", eventHandler: (e: { - cancel: boolean; - isHardwareButton: boolean; - }) => void): HtmlApplication; - on(eventName: "resolveLayoutController", eventHandler: (e: { - viewInfo: Object; - layoutController: Object; - availableLayoutControllers: Array; - }) => void): HtmlApplication; - on(eventName: "viewDisposed", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewDisposing", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewHidden", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewRendered", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewShowing", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - on(eventName: "viewShown", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - on(eventName: string, eventHandler: Function): HtmlApplication; - on(events: { [eventName: string]: Function; }): HtmlApplication; - off(eventName: "initialized"): HtmlApplication; - off(eventName: "afterViewSetup"): HtmlApplication; - off(eventName: "beforeViewSetup"): HtmlApplication; - off(eventName: "navigating"): HtmlApplication; - off(eventName: "navigatingBack"): HtmlApplication; - off(eventName: "resolveLayoutController"): HtmlApplication; - off(eventName: "viewDisposed"): HtmlApplication; - off(eventName: "viewDisposing"): HtmlApplication; - off(eventName: "viewHidden"): HtmlApplication; - off(eventName: "viewRendered"): HtmlApplication; - off(eventName: "viewShowing"): HtmlApplication; - off(eventName: "viewShown"): HtmlApplication; - off(eventName: string): HtmlApplication; - off(eventName: "initialized", eventHandler: () => void): HtmlApplication; - off(eventName: "afterViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "beforeViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "navigating", eventHandler: (e: { - currentUri: string; - uri: string; - cancel: boolean; - options: { - root: boolean; - target: string; - direction: string; - rootInDetailPane: boolean; - modal: boolean; - }; - }) => void): HtmlApplication; - off(eventName: "navigatingBack", eventHandler: (e: { - cancel: boolean; - isHardwareButton: boolean; - }) => void): HtmlApplication; - off(eventName: "resolveLayoutController", eventHandler: (e: { - viewInfo: Object; - layoutController: Object; - availableLayoutControllers: Array; - }) => void): HtmlApplication; - off(eventName: "viewDisposed", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewDisposing", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewHidden", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewRendered", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewShowing", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - off(eventName: "viewShown", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - off(eventName: string, eventHandler: Function): HtmlApplication; - } - } -} -declare namespace DevExpress.viz.core { - /** - * Applies a theme for the entire page with several DevExtreme visualization widgets. - * @deprecated Use the DevExpress.viz.currentTheme(theme) method instead. - */ - export function currentTheme(theme: string): void; - /** - * Applies a new theme (with the color scheme defined separately) for the entire page with several DevExtreme visualization widgets. - * @deprecated Use the DevExpress.viz.currentTheme(platform, colorScheme) method instead. - */ - export function currentTheme(platform: string, colorScheme: string): void; - /** - * Registers a new theme based on the existing one. - * @deprecated Use the DevExpress.viz.registerTheme(customTheme, baseTheme) method instead. - */ - export function registerTheme(customTheme: Object, baseTheme: string): void; - /** - * Applies a predefined or registered custom palette to all visualization widgets at once. - * @deprecated Use the DevExpress.viz.currentPalette(paletteName) method instead. - */ - export function currentPalette(paletteName: string): void; - /** - * Obtains the color sets of a predefined or registered palette. - * @deprecated Use the DevExpress.viz.getPalette(paletteName) method instead. - */ - export function getPalette(paletteName: string): Object; - /** - * Registers a new palette. - * @deprecated Use the DevExpress.viz.registerPalette(paletteName, palette) method instead. - */ - export function registerPalette(paletteName: string, palette: Object): void; - export interface Border { - /** Sets a border color for a selected series. */ - color?: string; - /** Sets border visibility for a selected series. */ - visible?: boolean; - /** Sets a border width for a selected series. */ - width?: number; - } - export interface DashedBorder extends Border { - /** Specifies a dash style for the border of a selected series point. */ - dashStyle?: string; - } - export interface DashedBorderWithOpacity extends DashedBorder { - /** Specifies the opacity of the tooltip's border. */ - opacity?: number; - } - export interface Font { - /** Specifies the font color for a strip label. */ - color?: string; - /** Specifies the font family for a strip label. */ - family?: string; - /** Specifies the font opacity for a strip label. */ - opacity?: number; - /** Specifies the font size for a strip label. */ - size?: any; - /** Specifies the font weight for the text displayed in strips. */ - weight?: number; - } - export interface Hatching { - direction?: string; - /** Specifies the opacity of hatching lines. */ - opacity?: number; - /** Specifies the distance between hatching lines in pixels. */ - step?: number; - /** Specifies the width of hatching lines in pixels. */ - width?: number; - } - export interface Margins { - /** Specifies the legend's bottom margin in pixels. */ - bottom?: number; - /** Specifies the legend's left margin in pixels. */ - left?: number; - /** Specifies the legend's right margin in pixels. */ - right?: number; - /** Specifies the legend's bottom margin in pixels. */ - top?: number; - } - export interface Size { - /** Specifies the width of the widget. */ - width?: number; - /** Specifies the height of the widget. */ - height?: number; - } - export interface Tooltip { - /** Specifies the length of the tooltip's arrow in pixels. */ - arrowLength?: number; - /** Specifies the appearance of the tooltip's border. */ - border?: viz.core.DashedBorderWithOpacity; - /** Specifies a color for the tooltip. */ - color?: string; - /** Specifies the z-index for tooltips. */ - zIndex?: number; - container?: any; - /** Specifies text and appearance of a set of tooltips. */ - customizeTooltip?: (arg: Object) => { color?: string; text?: string }; - /** Specifies whether or not the tooltip is enabled. */ - enabled?: boolean; - /** Specifies font options for the text displayed by the tooltip. */ - font?: Font; - /** Specifies a format for the text displayed by the tooltip. */ - format?: string; - /** Specifies the opacity of a tooltip. */ - opacity?: number; - /** Specifies a distance from the tooltip's left/right boundaries to the inner text in pixels. */ - paddingLeftRight?: number; - /** Specifies a distance from the tooltip's top/bottom boundaries to the inner text in pixels. */ - paddingTopBottom?: number; - /** Specifies a precision for formatted values displayed by the tooltip. */ - precision?: number; - /** Specifies options of the tooltip's shadow. */ - shadow?: { - /** Specifies the blur distance of the tooltip's shadow. */ - blur?: number; - /** Specifies the color of the tooltip's shadow. */ - color?: string; - /** Specifies the horizontal offset of the tooltip's shadow relative to the tooltip in pixels. */ - offsetX?: number; - /** Specifies the vertical offset of the tooltip's shadow relative to the tooltip in pixels. */ - offsetY?: number; - /** Specifies the opacity of the tooltip's shadow. */ - opacity?: number; - }; - } - export interface Animation { - /** Determines how long animation runs. */ - duration?: number; - /** Specifies the animation easing mode. */ - easing?: string; - /** Indicates whether or not animation is enabled. */ - enabled?: boolean; - } - export interface LoadingIndicator { - /** Specifies a color for the loading indicator background. */ - backgroundColor?: string; - /** Specifies font options for the loading indicator text. */ - font?: viz.core.Font; - /** Specifies whether to show the loading indicator or not. */ - show?: boolean; - /** Specifies a text to be displayed by the loading indicator. */ - text?: string; - } - export interface LegendBorder extends viz.core.DashedBorderWithOpacity { - /** Specifies a radius for the corners of the legend border. */ - cornerRadius?: number; - } - export interface BaseLegend { - /** Specifies the color of the legend's background. */ - backgroundColor?: string; - /** Specifies legend border settings. */ - border?: viz.core.LegendBorder; - /** Specifies how many columns must be taken to arrange legend items. */ - columnCount?: number; - /** Specifies the spacing between a pair of neighboring legend columns in pixels. */ - columnItemSpacing?: number; - /** Specifies font options for legend items. */ - font?: viz.core.Font; - /** Specifies the legend's position on the map. */ - horizontalAlignment?: string; - /** Specifies the alignment of legend items. */ - itemsAlignment?: string; - /** Specifies the position of text relative to the item marker. */ - itemTextPosition?: string; - /** Specifies the distance between the legend and the container borders in pixels. */ - margin?: viz.core.Margins; - /** Specifies the size of item markers in the legend in pixels. */ - markerSize?: number; - /** Specifies whether to arrange legend items horizontally or vertically. */ - orientation?: string; - /** Specifies the spacing between the legend left/right border and legend items in pixels. */ - paddingLeftRight?: number; - /** Specifies the spacing between the legend top/bottom border and legend items in pixels. */ - paddingTopBottom?: number; - /** Specifies how many rows must be taken to arrange legend items. */ - rowCount?: number; - /** Specifies the spacing between a pair of neighboring legend rows in pixels. */ - rowItemSpacing?: number; - /** Specifies the legend's position on the map. */ - verticalAlignment?: string; - /** Specifies whether or not the legend is visible on the map. */ - visible?: boolean; - } - export interface BaseWidgetOptions { - drawn?: (widget: Object) => void; - /** A handler for the drawn event. */ - onDrawn?: (e: { - component: BaseWidget; - element: Element; - }) => void; - incidentOccured?: (incidentInfo: { - id: string; - type: string; - args: any; - text: string; - widget: string; - version: string; - }) => void; - /** A handler for the incidentOccurred event. */ - onIncidentOccurred?: ( - component: BaseWidget, - element: Element, - target: { - id: string; - type: string; - args: any; - text: string; - widget: string; - version: string; - } - ) => void; - /** Notifies a widget that it is embedded into an HTML page that uses a path modifier. */ - pathModified?: boolean; - /** Specifies whether or not the widget supports right-to-left representation. */ - rtlEnabled?: boolean; - /** Sets the name of the theme to be used in the widget. */ - theme?: string; - } - /** This section describes options and methods that are common to all widgets. */ - export class BaseWidget extends DOMComponent { - /** Returns the widget's SVG markup. */ - svg(): string; - } -} -declare namespace DevExpress.viz.charts { - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface BaseSeries { - /** Provides information about the state of the series object. */ - fullState: number; - /** Returns the type of the series. */ - type: string; - /** Unselects all the selected points of the series. The points are displayed in an initial style. */ - clearSelection(): void; - /** Gets the color of a particular series. */ - getColor(): string; - /** - * Gets a point from the series point collection based on the specified argument. - * @deprecated getPointsByArg(pointArg).md - */ - getPointByArg(pointArg: any): Object; - /** Gets points from the series point collection based on the specified argument. */ - getPointsByArg(pointArg: any): Array; - /** Gets a point from the series point collection based on the specified point position. */ - getPointByPos(positionIndex: number): Object; - /** Selects the series. The series is displayed in a 'selected' style until another series is selected or the current series is deselected programmatically. */ - select(): void; - /** Selects the specified point. The point is displayed in a 'selected' style. */ - selectPoint(point: BasePoint): void; - /** Deselects the specified point. The point is displayed in an initial style. */ - deselectPoint(point: BasePoint): void; - /** Returns an array of all points in the series. */ - getAllPoints(): Array; - /** Returns visible series points. */ - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface BasePoint { - /** Provides information about the state of the point object. */ - fullState: number; - /** Returns the point's argument value that was set in the data source. */ - originalArgument: any; - /** Returns the point's value that was set in the data source. */ - originalValue: any; - /** Returns the tag of the point. */ - tag: string; - /** Deselects the point. */ - clearSelection(): void; - /** Gets the color of a particular point. */ - getColor(): string; - /** Hides the tooltip of the point. */ - hideTooltip(): void; - /** Provides information about the hover state of a point. */ - isHovered(): any; - /** Provides information about the selection state of a point. */ - isSelected(): any; - /** Selects the point. The point is displayed in a 'selected' style until another point is selected or the current point is deselected programmatically. */ - select(): void; - /** Shows the tooltip of the point. */ - showTooltip(): void; - /** Allows you to obtain the label of a series point. */ - getLabel(): any; - /** Returns the series object to which the point belongs. */ - series: BaseSeries; - } - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface ChartSeries extends BaseSeries { - /** Returns the name of the series pane. */ - pane: string; - /** Returns the name of the value axis of the series. */ - axis: string; - /** Returns the name of the series. */ - name: string; - /** Returns the tag of the series. */ - tag: string; - /** Hides a series. */ - hide(): void; - /** Provides information about the hover state of a series. */ - isHovered(): any; - /** Provides information about the selection state of a series. */ - isSelected(): any; - /** Provides information about the visibility state of a series. */ - isVisible(): boolean; - /** Makes a particular series visible. */ - show(): void; - selectPoint(point: ChartPoint): void; - deselectPoint(point: ChartPoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface ChartPoint extends BasePoint { - /** Contains the close value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalCloseValue: any; - /** Contains the high value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalHighValue: any; - /** Contains the low value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalLowValue: any; - /** Contains the first value of the point. This field is useful for points belonging to a series of the range area or range bar type only. */ - originalMinValue: any; - /** Contains the open value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalOpenValue: any; - /** Contains the size of the bubble as it was set in the data source. This field is useful for points belonging to a series of the bubble type only. */ - size: any; - /** Gets the parameters of the point's minimum bounding rectangle (MBR). */ - getBoundingRect(): { x: number; y: number; width: number; height: number; }; - series: ChartSeries; - } - /** This section describes the methods that can be used in code to manipulate the Label object. */ - export interface Label { - /** Gets the parameters of the label's minimum bounding rectangle (MBR). */ - getBoundingRect(): { x: number; y: number; width: number; height: number; }; - /** Hides the point label. */ - hide(): void; - /** Shows the point label. */ - show(): void; - } - export interface PieSeries extends BaseSeries { - selectPoint(point: PiePoint): void; - deselectPoint(point: PiePoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface PiePoint extends BasePoint { - /** Gets the percentage value of the specific point. */ - percent: any; - /** Provides information about the visibility state of a point. */ - isVisible(): boolean; - /** Makes a specific point visible. */ - show(): void; - /** Hides a specific point. */ - hide(): void; - series: PieSeries; - } - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface PolarSeries extends BaseSeries { - /** Returns the name of the value axis of the series. */ - axis: string; - /** Returns the name of the series. */ - name: string; - /** Returns the tag of the series. */ - tag: string; - /** Hides a series. */ - hide(): void; - /** Provides information about the hover state of a series. */ - isHovered(): any; - /** Provides information about the selection state of a series. */ - isSelected(): any; - /** Provides information about the visibility state of a series. */ - isVisible(): boolean; - /** Makes a particular series visible. */ - show(): void; - selectPoint(point: PolarPoint): void; - deselectPoint(point: PolarPoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface PolarPoint extends BasePoint { - series: PolarSeries; - } - export interface Strip { - /** Specifies a color for a strip. */ - color?: string; - /** An object that defines the label configuration options of a strip. */ - label?: { - /** Specifies the text displayed in a strip. */ - text?: string; - }; - /** Specifies a start value for a strip. */ - startValue?: any; - /** Specifies an end value for a strip. */ - endValue?: any; - } - export interface BaseSeriesConfigLabel { - /** Specifies a format for arguments displayed by point labels. */ - argumentFormat?: string; - /** Specifies a precision for formatted point arguments displayed in point labels. */ - argumentPrecision?: number; - /** Specifies a background color for point labels. */ - backgroundColor?: string; - /** Specifies border options for point labels. */ - border?: viz.core.DashedBorder; - /** Specifies connector options for series point labels. */ - connector?: { - /** Specifies the color of label connectors. */ - color?: string; - /** Indicates whether or not label connectors are visible. */ - visible?: boolean; - /** Specifies the width of label connectors. */ - width?: number; - }; - /** Specifies a callback function that returns the text to be displayed by point labels. */ - customizeText?: (pointInfo: Object) => string; - /** Specifies font options for the text displayed in point labels. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed by point labels. */ - format?: string; - position?: string; - /** Specifies a precision for formatted point values displayed in point labels. */ - precision?: number; - /** Specifies the angle used to rotate point labels from their initial position. */ - rotationAngle?: number; - /** Specifies the visibility of point labels. */ - visible?: boolean; - } - export interface SeriesConfigLabel extends BaseSeriesConfigLabel { - /** Specifies whether or not to show a label when the point has a zero value. */ - showForZeroValues?: boolean; - } - export interface ChartSeriesConfigLabel extends SeriesConfigLabel { - /** Specifies how to align point labels relative to the corresponding data points that they represent. */ - alignment?: string; - /** Specifies how to shift point labels horizontally from their initial positions. */ - horizontalOffset?: number; - /** Specifies how to shift point labels vertically from their initial positions. */ - verticalOffset?: number; - /** Specifies a precision for the percentage values displayed in the labels of a full-stacked-like series. */ - percentPrecision?: number; - } - export interface BaseCommonSeriesConfig { - /** Specifies the data source field that provides arguments for series points. */ - argumentField?: string; - axis?: string; - /** An object defining the label configuration options for a series in the dxChart widget. */ - label?: ChartSeriesConfigLabel; - /** Specifies border options for point labels. */ - border?: viz.core.DashedBorder; - /** Specifies a series color. */ - color?: string; - /** Specifies the dash style of the series' line. */ - dashStyle?: string; - hoverMode?: string; - hoverStyle?: { - /** An object defining the border options for a hovered series. */ - border?: viz.core.DashedBorder; - /**

Sets a color for a series when it is hovered over.

*/ - color?: string; - /** Specifies the dash style for the line in a hovered series. */ - dashStyle?: string; - hatching?: viz.core.Hatching; - /** Specifies the width of a line in a hovered series. */ - width?: number; - }; - /** Specifies whether a chart ignores null data points or not. */ - ignoreEmptyPoints?: boolean; - /** Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed. */ - maxLabelCount?: number; - /** Specifies the minimal length of a displayed bar in pixels. */ - minBarSize?: number; - /** Specifies opacity for a series. */ - opacity?: number; - /** Specifies the series elements to highlight when the series is selected. */ - selectionMode?: string; - selectionStyle?: { - /** An object defining the border options for a selected series. */ - border?: viz.core.DashedBorder; - /** Sets a color for a series when it is selected. */ - color?: string; - /** Specifies the dash style for the line in a selected series. */ - dashStyle?: string; - hatching?: viz.core.Hatching; - /** Specifies the width of a line in a selected series. */ - width?: number; - }; - /** Specifies whether or not to show the series in the chart's legend. */ - showInLegend?: boolean; - /** Specifies the name of the stack where the values of the _stackedBar_ series must be located. */ - stack?: string; - /** Specifies the name of the data source field that provides data about a point. */ - tagField?: string; - /** Specifies the data source field that provides values for series points. */ - valueField?: string; - /** Specifies the visibility of a series. */ - visible?: boolean; - /** Specifies a line width. */ - width?: number; - /** Configures error bars. */ - valueErrorBar?: { - /** Specifies whether error bars must be displayed in full or partially. */ - displayMode?: string; - /** Specifies the data field that provides data for low error values. */ - lowValueField?: string; - /** Specifies the data field that provides data for high error values. */ - highValueField?: string; - /** Specifies how error bar values must be calculated. */ - type?: string; - /** Specifies the value to be used for generating error bars. */ - value?: number; - /** Specifies the color of error bars. */ - color?: string; - /** Specifies the opacity of error bars. */ - opacity?: number; - /** Specifies the length of the lines that indicate the error bar edges. */ - edgeLength?: number; - /** Specifies the width of the error bar line. */ - lineWidth?: number; - }; - } - export interface CommonPointOptions { - /** Specifies border options for points in the line and area series. */ - border?: viz.core.Border; - /** Specifies the points color. */ - color?: string; - /** Specifies what series points to highlight when a point is hovered over. */ - hoverMode?: string; - /** An object defining configuration options for a hovered point. */ - hoverStyle?: { - /** An object defining the border options for a hovered point. */ - border?: viz.core.Border; - /** Sets a color for a point when it is hovered over. */ - color?: string; - /** Specifies the diameter of a hovered point in the series that represents data points as symbols (not as bars for instance). */ - size?: number; - }; - /** Specifies what series points to highlight when a point is selected. */ - selectionMode?: string; - /** An object defining configuration options for a selected point. */ - selectionStyle?: { - /** An object defining the border options for a selected point. */ - border?: viz.core.Border; - /**

Sets a color for a point when it is selected.

*/ - color?: string; - /** Specifies the diameter of a selected point in the series that represents data points as symbols (not as bars for instance). */ - size?: number; - }; - /** Specifies the point diameter in pixels for those series that represent data points as symbols (not as bars for instance). */ - size?: number; - /** Specifies a symbol for presenting points of the line and area series. */ - symbol?: string; - visible?: boolean; - } - export interface ChartCommonPointOptions extends CommonPointOptions { - /** An object specifying the parameters of an image that is used as a point marker. */ - image?: { - /** Specifies the height of an image that is used as a point marker. */ - height?: any; - /** Specifies a URL leading to the image to be used as a point marker. */ - url?: any; - /** Specifies the width of an image that is used as a point marker. */ - width?: any; - }; - } - export interface PolarCommonPointOptions extends CommonPointOptions { - /** An object specifying the parameters of an image that is used as a point marker. */ - image?: { - /** Specifies the height of an image that is used as a point marker. */ - height?: number; - /** Specifies a URL leading to the image to be used as a point marker. */ - url?: string; - /** Specifies the width of an image that is used as a point marker. */ - width?: number; - }; - } - /** An object that defines configuration options for chart series. */ - export interface CommonSeriesConfig extends BaseCommonSeriesConfig { - /** Specifies the data source field that provides a 'close' value for a _candleStick_ or _stock_ series. */ - closeValueField?: string; - /** Specifies a radius for bar corners. */ - cornerRadius?: number; - /** Specifies the data source field that provides a 'high' value for a _candleStick_ or _stock_ series. */ - highValueField?: string; - /** Specifies the color for the body (rectangle) of a _candleStick_ series. */ - innerColor?: string; - /** Specifies the data source field that provides a 'low' value for a _candleStick_ or _stock_ series. */ - lowValueField?: string; - /** Specifies the data source field that provides an 'open' value for a _candleStick_ or _stock_ series. */ - openValueField?: string; - /** Specifies the pane that will be used to display a series. */ - pane?: string; - /** An object defining configuration options for points in line-, scatter- and area-like series. */ - point?: ChartCommonPointOptions; - /** Specifies the data source field that provides values for one end of a range series. To set the data source field for the other end of the range series, use the rangeValue2Field property. */ - rangeValue1Field?: string; - /** Specifies the data source field that provides values for the second end of a range series. To set the data source field for the other end of the range series, use the rangeValue1Field property. */ - rangeValue2Field?: string; - /** Specifies reduction options for the stock or candleStick series. */ - reduction?: { - /** Specifies a color for the points whose reduction level price is lower in comparison to the value in the previous point. */ - color?: string; - /** Specifies for which price level (open, high, low or close) to enable reduction options in the series. */ - level?: string; - }; - /** Specifies the data source field that defines the size of bubbles. */ - sizeField?: string; - } - export interface CommonSeriesSettings extends CommonSeriesConfig { - /**

An object that specifies configuration options for all series of the area type in the chart.

*/ - area?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _bar_ type in the chart. */ - bar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the bubble type in the chart. */ - bubble?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _candleStick_ type in the chart. */ - candlestick?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _fullStackedArea_ type in the chart. */ - fullstackedarea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Full-Stacked Spline Area type in the chart. */ - fullstackedsplinearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _fullStackedBar_ type in the chart. */ - fullstackedbar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _fullStackedLine_ type in the chart. */ - fullstackedline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Full-Stacked Spline type in the chart. */ - fullstackedspline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _line_ type in the chart. */ - line?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _rangeArea_ type in the chart. */ - rangearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _rangeBar_ type in the chart. */ - rangebar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _scatter_ type in the chart. */ - scatter?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _spline_ type in the chart. */ - spline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _splineArea_ type in the chart. */ - splinearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedArea_ type in the chart. */ - stackedarea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Stacked Spline Area type in the chart. */ - stackedsplinearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedBar_ type in the chart. */ - stackedbar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedLine_ type in the chart. */ - stackedline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Stacked Spline type in the chart. */ - stackedspline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stepArea_ type in the chart. */ - steparea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stepLine_ type in the chart. */ - stepline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stock_ type in the chart. */ - stock?: CommonSeriesConfig; - /** Sets a series type. */ - type?: string; - } - export interface SeriesConfig extends CommonSeriesConfig { - /** Specifies the name that identifies the series. */ - name?: string; - /** Specifies data about a series. */ - tag?: any; - /** Sets the series type. */ - type?: string; - } - /** An object that defines configuration options for polar chart series. */ - export interface CommonPolarSeriesConfig extends BaseCommonSeriesConfig { - /** Specifies whether or not to close the chart by joining the end point with the first point. */ - closed?: boolean; - label?: SeriesConfigLabel; - point?: PolarCommonPointOptions; - } - export interface CommonPolarSeriesSettings extends CommonPolarSeriesConfig { - /** An object that specifies configuration options for all series of the area type in the chart. */ - area?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _bar_ type in the chart. */ - bar?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _line_ type in the chart. */ - line?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _scatter_ type in the chart. */ - scatter?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedBar_ type in the chart. */ - stackedbar?: CommonPolarSeriesConfig; - /** Sets a series type. */ - type?: string; - } - export interface PolarSeriesConfig extends CommonPolarSeriesConfig { - /** Specifies the name that identifies the series. */ - name?: string; - /** Specifies data about a series. */ - tag?: any; - /** Sets the series type. */ - type?: string; - } - export interface PieSeriesConfigLabel extends BaseSeriesConfigLabel { - /** Specifies how to shift labels from their initial position in a radial direction in pixels. */ - radialOffset?: number; - /** Specifies a precision for the percentage values displayed in labels. */ - percentPrecision?: number; - } - /** An object that defines configuration options for chart series. */ - export interface CommonPieSeriesConfig { - /** Specifies the data source field that provides arguments for series points. */ - argumentField?: string; - /** Specifies the required type for series arguments. */ - argumentType?: string; - /** An object defining the series border configuration options. */ - border?: viz.core.DashedBorder; - /** Specifies a series color. */ - color?: string; - /** Specifies the chart elements to highlight when a series is hovered over. */ - hoverMode?: string; - /** An object defining configuration options for a hovered series. */ - hoverStyle?: { - /** An object defining the border options for a hovered series. */ - border?: viz.core.DashedBorder; - /** Sets a color for the series when it is hovered over. */ - color?: string; - /** Specifies the hatching options to be applied when a point is hovered over. */ - hatching?: viz.core.Hatching; - }; - /** Specifies the fraction of the inner radius relative to the total radius in the series of the 'doughnut' type. */ - innerRadius?: number; - /** An object defining the label configuration options. */ - label?: PieSeriesConfigLabel; - /** Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed. */ - maxLabelCount?: number; - /** Specifies a minimal size of a displayed pie segment. */ - minSegmentSize?: number; - /** Specifies the direction in which the dxPieChart's series points are located. */ - segmentsDirection?: string; - /**

Specifies the chart elements to highlight when the series is selected.

*/ - selectionMode?: string; - /** An object defining configuration options for the series when it is selected. */ - selectionStyle?: { - /** An object defining the border options for a selected series. */ - border?: viz.core.DashedBorder; - /** Sets a color for a series when it is selected. */ - color?: string; - /** Specifies the hatching options to be applied when a point is selected. */ - hatching?: viz.core.Hatching; - }; - /** Specifies chart segment grouping options. */ - smallValuesGrouping?: { - /** Specifies the name of the grouped chart segment. This name represents the segment in the chart legend. */ - groupName?: string; - /** Specifies the segment grouping mode. */ - mode?: string; - /** Specifies a threshold for segment values. */ - threshold?: number; - /** Specifies how many segments must not be grouped. */ - topCount?: number; - }; - /** Specifies a start angle for a pie chart in arc degrees. */ - startAngle?: number; - /**

Specifies the name of the data source field that provides data about a point.

*/ - tagField?: string; - /** Specifies the data source field that provides values for series points. */ - valueField?: string; - } - export interface PieSeriesConfig extends CommonPieSeriesConfig { - /** Sets the series type. */ - type?: string; - } - export interface SeriesTemplate { - /** Specifies a callback function that returns a series object with individual series settings. */ - customizeSeries?: (seriesName: string) => SeriesConfig; - /** Specifies a data source field that represents the series name. */ - nameField?: string; - } - export interface PolarSeriesTemplate { - /** Specifies a callback function that returns a series object with individual series settings. */ - customizeSeries?: (seriesName: string) => PolarSeriesConfig; - /** Specifies a data source field that represents the series name. */ - nameField?: string; - } - export interface ChartCommonConstantLineLabel { - /** Specifies font options for a constant line label. */ - font?: viz.core.Font; - /** Specifies the position of the constant line label relative to the chart plot. */ - position?: string; - /** Indicates whether or not to display labels for the axis constant lines. */ - visible?: boolean; - } - export interface PolarCommonConstantLineLabel { - /** Indicates whether or not to display labels for the axis constant lines. */ - visible?: boolean; - /** Specifies font options for a constant line label. */ - font?: viz.core.Font; - } - export interface ConstantLineStyle { - /** Specifies a color for a constant line. */ - color?: string; - /** Specifies a dash style for a constant line. */ - dashStyle?: string; - /** Specifies a constant line width in pixels. */ - width?: number; - } - export interface ChartCommonConstantLineStyle extends ConstantLineStyle { - /** An object defining constant line label options. */ - label?: ChartCommonConstantLineLabel; - /** Specifies the space between the constant line label and the left/right side of the constant line. */ - paddingLeftRight?: number; - /** Specifies the space between the constant line label and the top/bottom side of the constant line. */ - paddingTopBottom?: number; - } - export interface PolarCommonConstantLineStyle extends ConstantLineStyle { - /** An object defining constant line label options. */ - label?: PolarCommonConstantLineLabel; - } - export interface CommonAxisLabel { - /** Specifies font options for axis labels. */ - font?: viz.core.Font; - /** Specifies the spacing between an axis and its labels in pixels. */ - indentFromAxis?: number; - /** Indicates whether or not axis labels are visible. */ - visible?: boolean; - } - export interface ChartCommonAxisLabel extends CommonAxisLabel { - /** Specifies the label's position relative to the tick (grid line). */ - alignment?: string; - /** Specifies the overlap resolving algorithm to be applied to axis labels. */ - overlappingBehavior?: { - /** Specifies how to arrange axis labels. */ - mode?: string; - /** Specifies the angle used to rotate axis labels. */ - rotationAngle?: number; - /** Specifies the spacing that must be set between staggered rows when the 'stagger' algorithm is applied. */ - staggeringSpacing?: number; - }; - } - export interface PolarCommonAxisLabel extends CommonAxisLabel { - /** Specifies the overlap resolving algorithm to be applied to axis labels. */ - overlappingBehavior?: string; - } - export interface CommonAxisTitle { - /** Specifies font options for an axis title. */ - font?: viz.core.Font; - /** Specifies a margin for an axis title in pixels. */ - margin?: number; - } - export interface BaseCommonAxisSettings { - /** Specifies the color of the line that represents an axis. */ - color?: string; - /** Specifies whether ticks/grid lines of a discrete axis are located between labels or cross the labels. */ - discreteAxisDivisionMode?: string; - /** An object defining the configuration options for the grid lines of an axis in the dxPolarChart widget. */ - grid?: { - /** Specifies a color for grid lines. */ - color?: string; - /** Specifies an opacity for grid lines. */ - opacity?: number; - /** Indicates whether or not the grid lines of an axis are visible. */ - visible?: boolean; - /** Specifies the width of grid lines. */ - width?: number; - }; - /** Specifies the options of the minor grid. */ - minorGrid?: { - /** Specifies a color for the lines of the minor grid. */ - color?: string; - /** Specifies an opacity for the lines of the minor grid. */ - opacity?: number; - /** Indicates whether the minor grid is visible or not. */ - visible?: boolean; - /** Specifies a width for the lines of the minor grid. */ - width?: number; - }; - /** Indicates whether or not an axis is inverted. */ - inverted?: boolean; - /** Specifies the opacity of the line that represents an axis. */ - opacity?: number; - /** Indicates whether or not to set ticks/grid lines of a continuous axis of the 'date-time' type at the beginning of each date-time interval. */ - setTicksAtUnitBeginning?: boolean; - /** An object defining the configuration options for axis ticks. */ - tick?: { - /** Specifies ticks color. */ - color?: string; - /** Specifies tick opacity. */ - opacity?: number; - /** Indicates whether or not ticks are visible on an axis. */ - visible?: boolean; - }; - /** Specifies the options of the minor ticks. */ - minorTick?: { - /** Specifies a color for the minor ticks. */ - color?: string; - /** Specifies an opacity for the minor ticks. */ - opacity?: number; - /** Indicates whether or not the minor ticks are displayed on an axis. */ - visible?: boolean; - }; - /** Indicates whether or not the line that represents an axis in a chart is visible. */ - visible?: boolean; - /** Specifies the width of the line that represents an axis in the chart. */ - width?: number; - } - export interface ChartCommonAxisSettings extends BaseCommonAxisSettings { - /** Specifies the appearance of all the widget's constant lines. */ - constantLineStyle?: ChartCommonConstantLineStyle; - /** An object defining the label configuration options that are common for all axes in the dxChart widget. */ - label?: ChartCommonAxisLabel; - /** Specifies a coefficient that determines the spacing between the maximum series point and the axis. */ - maxValueMargin?: number; - /** Specifies a coefficient that determines the spacing between the minimum series point and the axis. */ - minValueMargin?: number; - /** Specifies, in pixels, the space reserved for an axis. */ - placeholderSize?: number; - /** An object defining configuration options for strip style. */ - stripStyle?: { - /** An object defining the configuration options for a strip label style. */ - label?: { - /** Specifies font options for a strip label. */ - font?: viz.core.Font; - /** Specifies the label's position on a strip. */ - horizontalAlignment?: string; - /** Specifies a label's position on a strip. */ - verticalAlignment?: string; - }; - /** Specifies the spacing, in pixels, between the left/right strip border and the strip label. */ - paddingLeftRight?: number; - /** Specifies the spacing, in pixels, between the top/bottom strip borders and the strip label. */ - paddingTopBottom?: number; - }; - /** An object defining the title configuration options that are common for all axes in the dxChart widget. */ - title?: CommonAxisTitle; - /** Indicates whether or not to display series with indents from axis boundaries. */ - valueMarginsEnabled?: boolean; - } - export interface PolarCommonAxisSettings extends BaseCommonAxisSettings { - /** Specifies the appearance of all the widget's constant lines. */ - constantLineStyle?: PolarCommonConstantLineStyle; - /** An object defining the label configuration options that are common for all axes in the dxPolarChart widget. */ - label?: PolarCommonAxisLabel; - /** An object defining configuration options for strip style. */ - stripStyle?: { - /** An object defining the configuration options for a strip label style. */ - label?: { - /** Specifies font options for a strip label. */ - font?: viz.core.Font; - }; - }; - } - export interface ChartConstantLineLabel extends ChartCommonConstantLineLabel { - /** Specifies the horizontal alignment of a constant line label. */ - horizontalAlignment?: string; - /** Specifies the vertical alignment of a constant line label. */ - verticalAlignment?: string; - /** Specifies the text to be displayed in a constant line label. */ - text?: string; - } - export interface PolarConstantLineLabel extends PolarCommonConstantLineLabel { - /** Specifies the text to be displayed in a constant line label. */ - text?: string; - } - export interface AxisLabel { - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a label on the value axis. */ - customizeHint?: (argument: { value: any; valueText: string }) => string; - /** Specifies a callback function that returns the text to be displayed in value axis labels. */ - customizeText?: (argument: { value: any; valueText: string }) => string; - /** Specifies a format for the text displayed by axis labels. */ - format?: string; - /** Specifies a precision for the formatted value displayed in the axis labels. */ - precision?: number; - } - export interface ChartAxisLabel extends ChartCommonAxisLabel, AxisLabel { } - export interface PolarAxisLabel extends PolarCommonAxisLabel, AxisLabel { } - export interface AxisTitle extends CommonAxisTitle { - /** Specifies the text for the value axis title. */ - text?: string; - } - export interface ChartConstantLineStyle extends ChartCommonConstantLineStyle { - /** An object defining constant line label options. */ - label?: ChartConstantLineLabel; - } - export interface ChartConstantLine extends ChartConstantLineStyle { - /** An object defining constant line label options. */ - label?: ChartConstantLineLabel; - /** Specifies a value to be displayed by a constant line. */ - value?: any; - } - export interface PolarConstantLine extends PolarCommonConstantLineStyle { - /** An object defining constant line label options. */ - label?: PolarConstantLineLabel; - /** Specifies a value to be displayed by a constant line. */ - value?: any; - } - export interface Axis { - /** Specifies a coefficient for dividing the value axis. */ - axisDivisionFactor?: number; - /** Specifies the order in which discrete values are arranged on the value axis. */ - categories?: Array; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic axis. */ - logarithmBase?: number; - /** Specifies an interval between axis ticks/grid lines. */ - tickInterval?: any; - /** Specifies the interval between minor ticks. */ - minorTickInterval?: any; - /** Specifies the number of minor ticks between two neighboring major ticks. */ - minorTickCount?: number; - /** Specifies the required type of the value axis. */ - type?: string; - /** Specifies the pane on which the current value axis will be displayed. */ - pane?: string; - /** Specifies options for value axis strips. */ - strips?: Array; - } - export interface ChartAxis extends ChartCommonAxisSettings, Axis { - /** Defines an array of the value axis constant lines. */ - constantLines?: Array; - /** Specifies the appearance options for the constant lines of the value axis. */ - constantLineStyle?: ChartCommonConstantLineStyle; - /** Specifies options for value axis labels. */ - label?: ChartAxisLabel; - /** Specifies the maximum value on the value axis. */ - max?: any; - /** Specifies the minimum value on the value axis. */ - min?: any; - /** Specifies the position of the value axis on a chart. */ - position?: string; - /** Specifies the title for a value axis. */ - title?: AxisTitle; - } - export interface PolarAxis extends PolarCommonAxisSettings, Axis { - /** Defines an array of the value axis constant lines. */ - constantLines?: Array; - /** Specifies options for value axis labels. */ - label?: PolarAxisLabel; - } - export interface ArgumentAxis { - /** Specifies the desired type of axis values. */ - argumentType?: string; - /** Specifies the elements that will be highlighted when the argument axis is hovered over. */ - hoverMode?: string; - } - export interface ChartArgumentAxis extends ChartAxis, ArgumentAxis { } - export interface PolarArgumentAxis extends PolarAxis, ArgumentAxis { - /** Specifies a start angle for the argument axis in degrees. */ - startAngle?: number; - /** Specifies whether or not to display the first point at the angle specified by the startAngle option. */ - firstPointOnStartAngle?: boolean; - /** Specifies the period of the argument values in the data source. */ - period?: number; - } - export interface ValueAxis { - /** Specifies the name of the value axis. */ - name?: string; - /** Specifies whether or not to indicate a zero value on the value axis. */ - showZero?: boolean; - /** Specifies the desired type of axis values. */ - valueType?: string; - } - export interface ChartValueAxis extends ChartAxis, ValueAxis { - /** Specifies the spacing, in pixels, between multiple value axes in a chart. */ - multipleAxesSpacing?: number; - /** Specifies the value by which the chart's value axes are synchronized. */ - synchronizedValue?: number; - } - export interface PolarValueAxis extends PolarAxis, ValueAxis { - /** Indicates whether to display series with indents from axis boundaries. */ - valueMarginsEnabled?: boolean; - /** Specifies a coefficient that determines the spacing between the maximum series point and the axis. */ - maxValueMargin?: number; - /** Specifies a coefficient that determines the spacing between the minimum series point and the axis. */ - minValueMargin?: number; - tick?: { - visible?: boolean; - } - } - export interface CommonPane { - /** Specifies a background color in a pane. */ - backgroundColor?: string; - /** Specifies the border options of a chart's pane. */ - border?: PaneBorder; - } - export interface Pane extends CommonPane { - /** Specifies the name of a pane. */ - name?: string; - } - export interface PaneBorder extends viz.core.DashedBorderWithOpacity { - /** Specifies the bottom border's visibility state in a pane. */ - bottom?: boolean; - /** Specifies the left border's visibility state in a pane. */ - left?: boolean; - /** Specifies the right border's visibility state in a pane. */ - right?: boolean; - /** Specifies the top border's visibility state in a pane. */ - top?: boolean; - } - export interface ChartAnimation extends viz.core.Animation { - /** Specifies the maximum series point count in the chart that the animation supports. */ - maxPointCountSupported?: number; - } - export interface BaseChartTooltip extends viz.core.Tooltip { - /** Specifies a format for arguments of the chart's series points. */ - argumentFormat?: string; - /** Specifies a precision for formatted arguments displayed in tooltips. */ - argumentPrecision?: number; - /** Specifies a precision for a percent value displayed in tooltips for stacked series and dxPieChart series. */ - percentPrecision?: number; - } - export interface BaseChartOptions extends viz.core.BaseWidgetOptions { - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - /** Specifies the width of the widget container that is small enough for the layout to begin adapting. */ - width?: number; - /** Specifies the height of the widget container that is small enough for the layout to begin adapting. */ - height?: number; - /** Specifies whether or not point labels can be hidden when the layout is adapting. */ - keepLabels?: boolean; - }; - /** Specifies animation options. */ - animation?: ChartAnimation; - /** Specifies a callback function that returns an object with options for a specific point label. */ - customizeLabel?: (labelInfo: Object) => Object; - /** Specifies a callback function that returns an object with options for a specific point. */ - customizePoint?: (pointInfo: Object) => Object; - /** Specifies a data source for the chart. */ - dataSource?: any; - done?: Function; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies options of a dxChart's (dxPieChart's) legend. */ - legend?: core.BaseLegend; - /** Specifies the blank space between the chart's extreme elements and the boundaries of the area provided for the widget (see size) in pixels. */ - margin?: viz.core.Margins; - /** Sets the name of the palette to be used in the chart. Alternatively, an array of colors can be set as a custom palette to be used within this chart. */ - palette?: any; - /** A handler for the done event. */ - onDone?: (e: { - component: BaseChart; - element: Element; - }) => void; - /** A handler for the pointClick event. */ - onPointClick?: any; - pointClick?: any; - /** A handler for the pointHoverChanged event. */ - onPointHoverChanged?: (e: { - component: BaseChart; - element: Element; - target: TPoint; - }) => void; - pointHoverChanged?: (point: TPoint) => void; - /** A handler for the pointSelectionChanged event. */ - onPointSelectionChanged?: (e: { - component: BaseChart; - element: Element; - target: TPoint; - }) => void; - pointSelectionChanged?: (point: TPoint) => void; - /** Specifies whether a single point or multiple points can be selected in the chart. */ - pointSelectionMode?: string; - /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */ - redrawOnResize?: boolean; - /** Specifies options for the dxChart and dxPieChart widget series. */ - series?: any; - /** Specifies the size of the widget in pixels. */ - size?: viz.core.Size; - /** Specifies a title for the chart. */ - title?: { - /** Specifies font options for the title. */ - font?: viz.core.Font; - /** Specifies the title's horizontal position in the chart. */ - horizontalAlignment?: string; - /** Specifies a title's position on the chart in the vertical direction. */ - verticalAlignment?: string; - /** Specifies the distance between the title and surrounding chart elements in pixels. */ - margin?: viz.core.Margins; - /** Specifies the height of the space reserved for the title. */ - placeholderSize?: number; - /** Specifies a text for the chart's title. */ - text?: string; - }; - /** Specifies tooltip options. */ - tooltip?: BaseChartTooltip; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: BaseChart; - element: Element; - target: BasePoint; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: BaseChart; - element: Element; - target: BasePoint; - }) => void; - tooltipHidden?: (point: TPoint) => void; - tooltipShown?: (point: TPoint) => void; - } - /** A base class for all chart widgets included in the ChartJS library. */ - export class BaseChart extends viz.core.BaseWidget { - /** Deselects the chart's selected series. The series is displayed in an initial style. */ - clearSelection(): void; - /** Gets the current size of the widget. */ - getSize(): { width: number; height: number }; - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Hides all widget tooltips. */ - hideTooltip(): void; - /** Redraws a widget. */ - render(renderOptions?: { - force?: boolean; - animate?: boolean; - asyncSeriesRendering?: boolean; - }): void; - } - export interface AdvancedLegend extends core.BaseLegend { - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item. */ - customizeHint?: (seriesInfo: { seriesName: string; seriesIndex: number; seriesColor: string; }) => string; - /**

Specifies a callback function that returns the text to be displayed by legend items.

*/ - customizeText?: (seriesInfo: { seriesName: string; seriesIndex: number; seriesColor: string; }) => string; - /** Specifies what series elements to highlight when a corresponding item in the legend is hovered over. */ - hoverMode?: string; - } - export interface AdvancedOptions extends BaseChartOptions { - /** A handler for the argumentAxisClick event. */ - onArgumentAxisClick?: any; - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** An object providing options for managing data from a data source. */ - dataPrepareSettings?: { - /** Specifies whether or not to validate the values from a data source. */ - checkTypeForAllData?: boolean; - /** Specifies whether or not to convert the values from a data source into the data type of an axis. */ - convertToAxisDataType?: boolean; - /** Specifies how to sort the series points. */ - sortingMethod?: any; - }; - /** A handler for the legendClick event. */ - onLegendClick?: any; - /** A handler for the seriesClick event. */ - onSeriesClick?: any; - /** A handler for the seriesHoverChanged event. */ - onSeriesHoverChanged?: (e: { - component: BaseChart; - element: Element; - target: TSeries; - }) => void; - /** A handler for the seriesSelectionChanged event. */ - onSeriesSelectionChanged?: (e: { - component: BaseChart; - element: Element; - target: TSeries; - }) => void; - /** Specifies whether a single series or multiple series can be selected in the chart. */ - seriesSelectionMode?: string; - /** Specifies how the chart must behave when series point labels overlap. */ - resolveLabelOverlapping?: string; - } - export interface Legend extends AdvancedLegend { - /** Specifies whether the legend is located outside or inside the chart's plot. */ - position?: string; - } - export interface ChartTooltip extends BaseChartTooltip { - /** Specifies whether the tooltip must be located in the center of a bar or on its edge. Applies to the Bar and Bubble series. */ - location?: string; - /** Specifies the kind of information to display in a tooltip. */ - shared?: boolean; - } - export interface dxChartOptions extends AdvancedOptions { - /** Specifies a value indicating whether all bars in a series must have the same width, or may have different widths if any points in other series are missing. */ - equalBarWidth?: any; - adaptiveLayout?: { - keepLabels?: boolean; - }; - /** Indicates whether or not to synchronize value axes when they are displayed on a single pane. */ - synchronizeMultiAxes?: boolean; - /** Specifies whether or not to filter the series points depending on their quantity. */ - useAggregation?: boolean; - /** Indicates whether or not to adjust a value axis to the current minimum and maximum values of a zoomed chart. */ - adjustOnZoom?: boolean; - /** Specifies argument axis options for the dxChart widget. */ - argumentAxis?: ChartArgumentAxis; - argumentAxisClick?: any; - /** An object defining the configuration options that are common for all axes of the dxChart widget. */ - commonAxisSettings?: ChartCommonAxisSettings; - /** An object defining the configuration options that are common for all panes in the dxChart widget. */ - commonPaneSettings?: CommonPane; - /** An object defining the configuration options that are common for all series of the dxChart widget. */ - commonSeriesSettings?: CommonSeriesSettings; - /** An object that specifies the appearance options of the chart crosshair. */ - crosshair?: { - /** Specifies a color for the crosshair lines. */ - color?: string; - /** Specifies a dash style for the crosshair lines. */ - dashStyle?: string; - /** Specifies whether to enable the crosshair or not. */ - enabled?: boolean; - /** Specifies the opacity of the crosshair lines. */ - opacity?: number; - /** Specifies the width of the crosshair lines. */ - width?: number; - /** Specifies the appearance of the horizontal crosshair line. */ - horizontalLine?: CrosshaierWithLabel; - /** Specifies the appearance of the vertical crosshair line. */ - verticalLine?: CrosshaierWithLabel; - /** Specifies the options of the crosshair labels. */ - label?: { - /** Specifies a color for the background of the crosshair labels. */ - backgroundColor?: string; - /** Specifies whether the crosshair labels are visible or not. */ - visible?: boolean; - /** Specifies font options for the text of the crosshair labels. */ - font?: viz.core.Font; - } - }; - /** Specifies a default pane for the chart's series. */ - defaultPane?: string; - /** Specifies a coefficient determining the diameter of the largest bubble. */ - maxBubbleSize?: number; - /** Specifies the diameter of the smallest bubble measured in pixels. */ - minBubbleSize?: number; - /** Defines the dxChart widget's pane(s). */ - panes?: Array; - /** Swaps the axes round so that the value axis becomes horizontal and the argument axes becomes vertical. */ - rotated?: boolean; - /** Specifies the options of a chart's legend. */ - legend?: Legend; - /** Specifies options for dxChart widget series. */ - series?: Array; - legendClick?: any; - seriesClick?: any; - seriesHoverChanged?: (series: ChartSeries) => void; - seriesSelectionChanged?: (series: ChartSeries) => void; - /** Defines options for the series template. */ - seriesTemplate?: SeriesTemplate; - /** Specifies tooltip options. */ - tooltip?: ChartTooltip; - /** Specifies value axis options for the dxChart widget. */ - valueAxis?: Array; - /** Enables scrolling in your chart. */ - scrollingMode?: string; - /** Enables zooming in your chart. */ - zoomingMode?: string; - /** Specifies the settings of the scroll bar. */ - scrollBar?: { - /** Specifies whether the scroll bar is visible or not. */ - visible?: boolean; - /** Specifies the spacing between the scroll bar and the chart's plot in pixels. */ - offset?: number; - /** Specifies the color of the scroll bar. */ - color?: string; - /** Specifies the width of the scroll bar in pixels. */ - width?: number; - /** Specifies the opacity of the scroll bar. */ - opacity?: number; - /** Specifies the position of the scroll bar in the chart. */ - position?: string; - }; - } - /** A widget used to embed charts into HTML JS applications. */ - export class dxChart extends BaseChart { - constructor(element: JQuery, options?: dxChartOptions); - constructor(element: Element, options?: dxChartOptions); - /** Returns an array of all series in the chart. */ - getAllSeries(): Array; - /** Gets a series within the chart's series collection by the specified name (see the name option). */ - getSeriesByName(seriesName: string): ChartSeries; - /** Gets a series within the chart's series collection by its position number. */ - getSeriesByPos(seriesIndex: number): ChartSeries; - /** Sets the specified start and end values for the chart's argument axis. */ - zoomArgument(startValue: any, endValue: any): void; - } - interface CrosshaierWithLabel extends viz.core.DashedBorderWithOpacity { - /** Configures the label that belongs to the horizontal crosshair line. */ - label?: { - /** Specifies a color for the background of the label that belongs to the horizontal crosshair line. */ - backgroundColor?: string; - /** Specifies whether the label of the horizontal crosshair line is visible or not. */ - visible?: boolean; - /** Specifies font options for the text of the label that belongs to the horizontal crosshair line. */ - font?: viz.core.Font; - } - } - export interface PolarChartTooltip extends BaseChartTooltip { - /** Specifies the kind of information to display in a tooltip. */ - shared?: boolean; - } - export interface dxPolarChartOptions extends AdvancedOptions { - /** Specifies a value indicating whether all bars in a series must have the same angle, or may have different angles if any points in other series are missing. */ - equalBarWidth?: boolean; - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - width?: number; - height?: number; - /** Specifies whether or not point labels can be hidden when the layout is adapting. */ - keepLabels?: boolean; - }; - /** Indicates whether or not to display a "spider web". */ - useSpiderWeb?: boolean; - /** Specifies argument axis options for the dxPolarChart widget. */ - argumentAxis?: PolarArgumentAxis; - /** An object defining the configuration options that are common for all axes of the dxPolarChart widget. */ - commonAxisSettings?: PolarCommonAxisSettings; - /** An object defining the configuration options that are common for all series of the dxPolarChart widget. */ - commonSeriesSettings?: CommonPolarSeriesSettings; - /** Specifies the options of a chart's legend. */ - legend?: AdvancedLegend; - /** Specifies options for dxPolarChart widget series. */ - series?: Array; - /** Defines options for the series template. */ - seriesTemplate?: PolarSeriesTemplate; - /** Specifies tooltip options. */ - tooltip?: PolarChartTooltip; - /** Specifies value axis options for the dxPolarChart widget. */ - valueAxis?: PolarValueAxis; - } - /** A chart widget displaying data in a polar coordinate system. */ - export class dxPolarChart extends BaseChart { - constructor(element: JQuery, options?: dxPolarChartOptions); - constructor(element: Element, options?: dxPolarChartOptions); - /** Returns an array of all series in the chart. */ - getAllSeries(): Array; - /** Gets a series within the chart's series collection by the specified name (see the name option). */ - getSeriesByName(seriesName: string): PolarSeries; - /** Gets a series within the chart's series collection by its position number. */ - getSeriesByPos(seriesIndex: number): PolarSeries; - } - export interface PieLegend extends core.BaseLegend { - /** Specifies what chart elements to highlight when a corresponding item in the legend is hovered over. */ - hoverMode?: string; - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item. */ - customizeHint?: (pointInfo: { pointName: string; pointIndex: number; pointColor: string; }) => string; - /** Specifies a callback function that returns the text to be displayed by a legend item. */ - customizeText?: (pointInfo: { pointName: string; pointIndex: number; pointColor: string; }) => string; - } - export interface dxPieChartOptions extends BaseChartOptions { - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - /** Specifies whether or not point labels can be hidden when the layout is adapting. */ - keepLabels?: boolean; - }; - /** Specifies dxPieChart legend options. */ - legend?: PieLegend; - /** Specifies options for the series of the dxPieChart widget. */ - series?: Array; - /** Specifies the diameter of the pie. */ - diameter?: number; - /** A handler for the legendClick event. */ - onLegendClick?: any; - legendClick?: any; - /** Specifies how a chart must behave when series point labels overlap. */ - resolveLabelOverlapping?: string; - } - /** A circular chart widget for HTML JS applications. */ - export class dxPieChart extends BaseChart { - constructor(element: JQuery, options?: dxPieChartOptions); - constructor(element: Element, options?: dxPieChartOptions); - /** Provides access to the dxPieChart series. */ - getSeries(): PieSeries; - } -} -interface JQuery { - dxChart(options?: DevExpress.viz.charts.dxChartOptions): JQuery; - dxChart(methodName: string, ...params: any[]): any; - dxChart(methodName: "instance"): DevExpress.viz.charts.dxChart; - dxPieChart(options?: DevExpress.viz.charts.dxPieChartOptions): JQuery; - dxPieChart(methodName: string, ...params: any[]): any; - dxPieChart(methodName: "instance"): DevExpress.viz.charts.dxPieChart; - dxPolarChart(options?: DevExpress.viz.charts.dxPolarChartOptions): JQuery; - dxPolarChart(methodName: string, ...params: any[]): any; - dxPolarChart(methodName: "instance"): DevExpress.viz.charts.dxPolarChart; -} -declare namespace DevExpress.viz.gauges { - export interface BaseRangeContainer { - /** Specifies a range container's background color. */ - backgroundColor?: string; - /** Specifies the offset of the range container from an invisible scale line in pixels. */ - offset?: number; - /** Sets the name of the palette or an array of colors to be used for coloring the gauge range container. */ - palette?: any; - /** An array of objects representing ranges contained in the range container. */ - ranges?: Array<{ startValue: number; endValue: number; color: string }>; - /** Specifies a color of a range. */ - color?: string; - /** Specifies an end value of a range. */ - endValue?: number; - /** Specifies a start value of a range. */ - startValue?: number; - } - export interface ScaleTick { - /** Specifies the color of the scale's minor ticks. */ - color?: string; - /** Specifies an array of custom minor ticks. */ - customTickValues?: Array; - /** Specifies the length of the scale's minor ticks. */ - length?: number; - /** Indicates whether automatically calculated minor ticks are visible or not. */ - showCalculatedTicks?: boolean; - /** Specifies an interval between minor ticks. */ - tickInterval?: number; - /** Indicates whether scale minor ticks are visible or not. */ - visible?: boolean; - /** Specifies the width of the scale's minor ticks. */ - width?: number; - } - export interface ScaleMajorTick extends ScaleTick { - /** Specifies whether or not to expand the current major tick interval if labels overlap each other. */ - useTicksAutoArrangement?: boolean; - } - export interface BaseScaleLabel { - /** Specifies whether or not scale labels should be colored similarly to their corresponding ranges in the range container. */ - useRangeColors?: boolean; - /** Specifies a callback function that returns the text to be displayed in scale labels. */ - customizeText?: (scaleValue: { value: number; valueText: string }) => string; - /** Specifies font options for the text displayed in the scale labels of the gauge. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in scale labels. */ - format?: string; - /** Specifies a precision for the formatted value displayed in the scale labels. */ - precision?: number; - /** Specifies whether or not scale labels are visible on the gauge. */ - visible?: boolean; - } - export interface BaseScale { - /** Specifies the end value for the scale of the gauge. */ - endValue?: number; - /** Specifies whether or not to hide the first scale label. */ - hideFirstLabel?: boolean; - /** Specifies whether or not to hide the first major tick on the scale. */ - hideFirstTick?: boolean; - /** Specifies whether or not to hide the last scale label. */ - hideLastLabel?: boolean; - /** Specifies whether or not to hide the last major tick on the scale. */ - hideLastTick?: boolean; - /** Specifies common options for scale labels. */ - label?: BaseScaleLabel; - /** Specifies options of the gauge's major ticks. */ - majorTick?: ScaleMajorTick; - /** Specifies options of the gauge's minor ticks. */ - minorTick?: ScaleTick; - /** Specifies the start value for the scale of the gauge. */ - startValue?: number; - } - export interface BaseValueIndicator { - /** Specifies the type of subvalue indicators. */ - type?: string; - /** Specifies the background color for the indicator of the rangeBar type. */ - backgroundColor?: string; - /** Specifies the base value for the indicator of the rangeBar type. */ - baseValue?: number; - /** Specifies a color of the indicator. */ - color?: string; - /** Specifies the range bar size for an indicator of the rangeBar type. */ - size?: number; - text?: { - /** Specifies a callback function that returns the text to be displayed in an indicator. */ - customizeText?: (indicatedValue: { value: number; valueText: string }) => string; - font?: viz.core.Font; - /** Specifies a format for the text displayed in an indicator. */ - format?: string; - /** Specifies the range bar's label indent in pixels. */ - indent?: number; - /** Specifies a precision for the formatted value displayed by an indicator. */ - precision?: number; - }; - offset?: number; - length?: number; - width?: number; - /** Specifies the length of an arrow for the indicator of the textCloud type in pixels. */ - arrowLength?: number; - /** Sets the array of colors to be used for coloring subvalue indicators. */ - palette?: Array; - /** Specifies the distance between the needle and the center of a gauge for the indicator of a needle-like type. */ - indentFromCenter?: number; - /** Specifies the second color for the indicator of the twoColorNeedle type. */ - secondColor?: string; - /** Specifies the length of a twoNeedleColor type indicator tip as a percentage. */ - secondFraction?: number; - /** Specifies the spindle's diameter in pixels for the indicator of a needle-like type. */ - spindleSize?: number; - /** Specifies the inner diameter in pixels, so that the spindle has the shape of a ring. */ - spindleGapSize?: number; - /** Specifies the orientation of the rangeBar indicator on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - /** Specifies the orientation of the rangeBar indicator on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - } - export interface SharedGaugeOptions { - /** Specifies animation options. */ - animation?: viz.core.Animation; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */ - redrawOnResize?: boolean; - /** Specifies the size of the widget in pixels. */ - size?: viz.core.Size; - /** Specifies a subtitle for a gauge. */ - subtitle?: { - /** Specifies font options for the subtitle. */ - font?: viz.core.Font; - /** Specifies a text for the subtitle. */ - text?: string; - }; - /** Specifies a title for a gauge. */ - title?: { - /** Specifies font options for the title. */ - font?: viz.core.Font; - /** Specifies a title's position on the gauge. */ - position?: string; - /** Specifies a text for the title. */ - text?: string; - }; - /** Specifies options for gauge tooltips. */ - tooltip?: viz.core.Tooltip; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: dxBaseGauge; - element: Element; - target: {}; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: dxBaseGauge; - element: Element; - target: {}; - }) => void; - } - export interface BaseGaugeOptions extends viz.core.BaseWidgetOptions, SharedGaugeOptions { - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** Specifies the blank space in pixels between the widget's extreme elements and the boundaries of the area provided for the widget (see the size option). */ - margin?: viz.core.Margins; - /** Specifies options of the gauge's range container. */ - rangeContainer?: BaseRangeContainer; - /** Specifies a gauge's scale options. */ - scale?: BaseScale; - /** Specifies the appearance options of subvalue indicators. */ - subvalueIndicator?: BaseValueIndicator; - /** Specifies a set of subvalues to be designated by the subvalue indicators. */ - subvalues?: Array; - /** Specifies the main value on a gauge. */ - value?: number; - /** Specifies the appearance options of the value indicator. */ - valueIndicator?: BaseValueIndicator; - } - /** A gauge widget. */ - export class dxBaseGauge extends viz.core.BaseWidget { - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(): void; - /** Returns the main gauge value. */ - value(): number; - /** Updates a gauge value. */ - value(value: number): void; - /** Returns an array of gauge subvalues. */ - subvalues(): Array; - /** Updates gauge subvalues. */ - subvalues(subvalues: Array): void; - } - export interface LinearRangeContainer extends BaseRangeContainer { - /** Specifies the orientation of the range container on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - /** Specifies the orientation of a range container on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - /** Specifies the width of the range container's start and end boundaries in the dxLinearGauge widget. */ - width?: any; - /** Specifies an end width of a range container. */ - end?: number; - /** Specifies a start width of a range container. */ - start?: number; - } - export interface LinearScaleLabel extends BaseScaleLabel { - /** Specifies the spacing between scale labels and ticks. */ - indentFromTick?: number; - } - export interface LinearScale extends BaseScale { - /** Specifies the orientation of scale ticks on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - label?: LinearScaleLabel; - /** Specifies the orientation of scale ticks on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - } - export interface dxLinearGaugeOptions extends BaseGaugeOptions { - /** Specifies the options required to set the geometry of the dxLinearGauge widget. */ - geometry?: { - /** Indicates whether to display the dxLinearGauge widget vertically or horizontally. */ - orientation?: string; - }; - /** Specifies gauge range container options. */ - rangeContainer?: LinearRangeContainer; - scale?: LinearScale; - } - /** A widget that represents a gauge with a linear scale. */ - export class dxLinearGauge extends dxBaseGauge { - constructor(element: JQuery, options?: dxLinearGaugeOptions); - constructor(element: Element, options?: dxLinearGaugeOptions); - } - export interface CircularRangeContainer extends BaseRangeContainer { - /** Specifies the orientation of the range container in the dxCircularGauge widget. */ - orientation?: string; - /** Specifies the range container's width in pixels. */ - width?: number; - } - export interface CircularScaleLabel extends BaseScaleLabel { - /** Specifies the spacing between scale labels and ticks. */ - indentFromTick?: number; - } - export interface CircularScale extends BaseScale { - label?: CircularScaleLabel; - /** Specifies the orientation of scale ticks. */ - orientation?: string; - } - export interface dxCircularGaugeOptions extends BaseGaugeOptions { - /** Specifies the options required to set the geometry of the dxCircularGauge widget. */ - geometry?: { - /** Specifies the end angle of the circular gauge's arc. */ - endAngle?: number; - /** Specifies the start angle of the circular gauge's arc. */ - startAngle?: number; - }; - /** Specifies gauge range container options. */ - rangeContainer?: CircularRangeContainer; - scale?: CircularScale; - } - /** A widget that represents a gauge with a circular scale. */ - export class dxCircularGauge extends dxBaseGauge { - constructor(element: JQuery, options?: dxCircularGaugeOptions); - constructor(element: Element, options?: dxCircularGaugeOptions); - } - export interface dxBarGaugeOptions extends viz.core.BaseWidgetOptions, SharedGaugeOptions { - /** Specifies a color for the remaining segment of the bar's track. */ - backgroundColor?: string; - /** Specifies a distance between bars in pixels. */ - barSpacing?: number; - /** Specifies a base value for bars. */ - baseValue?: number; - /** Specifies an end value for the gauge's invisible scale. */ - endValue?: number; - /** Defines the shape of the gauge's arc. */ - geometry?: { - /** Specifies the end angle of the bar gauge's arc. */ - endAngle?: number; - /** Specifies the start angle of the bar gauge's arc. */ - startAngle?: number; - }; - /** Specifies the options of the labels that accompany gauge bars. */ - label?: { - /** Specifies a color for the label connector text. */ - connectorColor?: string; - /** Specifies the width of the label connector in pixels. */ - connectorWidth?: number; - /** Specifies a callback function that returns a text for labels. */ - customizeText?: (barValue: { value: number; valueText: string }) => string; - /** Specifies font options for bar labels. */ - font?: viz.core.Font; - /** Specifies a format for bar labels. */ - format?: string; - /** Specifies the distance between the upper bar and bar labels in pixels. */ - indent?: number; - /** Specifies a precision for the formatted value displayed by labels. */ - precision?: number; - /** Specifies whether bar labels appear on a gauge or not. */ - visible?: boolean; - }; - /** Sets the name of the palette or an array of colors to be used for coloring the gauge range container. */ - palette?: string; - /** Defines the radius of the bar that is closest to the center relatively to the radius of the topmost bar. */ - relativeInnerRadius?: number; - /** Specifies a start value for the gauge's invisible scale. */ - startValue?: number; - /** Specifies the array of values to be indicated on a bar gauge. */ - values?: Array; - } - /** A circular bar widget. */ - export class dxBarGauge extends viz.core.BaseWidget { - constructor(element: JQuery, options?: dxBarGaugeOptions); - constructor(element: Element, options?: dxBarGaugeOptions); - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws the widget. */ - render(): void; - /** Returns an array of gauge values. */ - values(): Array; - /** Updates the values displayed by a gauge. */ - values(values: Array): void; - } -} -interface JQuery { - dxLinearGauge(options?: DevExpress.viz.gauges.dxLinearGaugeOptions): JQuery; - dxLinearGauge(methodName: string, ...params: any[]): any; - dxLinearGauge(methodName: "instance"): DevExpress.viz.gauges.dxLinearGauge; - dxCircularGauge(options?: DevExpress.viz.gauges.dxCircularGaugeOptions): JQuery; - dxCircularGauge(methodName: string, ...params: any[]): any; - dxCircularGauge(methodName: "instance"): DevExpress.viz.gauges.dxCircularGauge; - dxBarGauge(options?: DevExpress.viz.gauges.dxBarGaugeOptions): JQuery; - dxBarGauge(methodName: string, ...params: any[]): any; - dxBarGauge(methodName: "instance"): DevExpress.viz.gauges.dxBarGauge; -} -declare namespace DevExpress.viz.rangeSelector { - export interface dxRangeSelectorOptions extends viz.core.BaseWidgetOptions { - /** Specifies the options for the range selector's background. */ - background?: { - /** Specifies the background color for the dxRangeSelector. */ - color?: string; - /** Specifies image options. */ - image?: { - /** Specifies a location for the image in the background of a range selector. */ - location?: string; - /** Specifies the image's URL. */ - url?: string; - }; - /** Indicates whether or not the background (background color and/or image) is visible. */ - visible?: boolean; - }; - /** Specifies the dxRangeSelector's behavior options. */ - behavior?: { - /** Indicates whether or not you can swap sliders. */ - allowSlidersSwap?: boolean; - /** Indicates whether or not animation is enabled. */ - animationEnabled?: boolean; - /** Specifies when to call the onSelectedRangeChanged function. */ - callSelectedRangeChanged?: string; - /** Indicates whether or not an end user can specify the range using a mouse, without the use of sliders. */ - manualRangeSelectionEnabled?: boolean; - /** Indicates whether or not an end user can shift the selected range to the required location on a scale by clicking. */ - moveSelectedRangeByClick?: boolean; - /** Indicates whether to snap a slider to ticks. */ - snapToTicks?: boolean; - }; - /** Specifies the options required to display a chart as the range selector's background. */ - chart?: { - /** Specifies a coefficient for determining an indent from the bottom background boundary to the lowest chart point. */ - bottomIndent?: number; - /** An object defining the common configuration options for the chart’s series. */ - commonSeriesSettings?: viz.charts.CommonSeriesSettings; - /** An object providing options for managing data from a data source. */ - dataPrepareSettings?: { - /** Specifies whether or not to validate values from a data source. */ - checkTypeForAllData?: boolean; - /** Specifies whether or not to convert the values from a data source into the data type of an axis. */ - convertToAxisDataType?: boolean; - /** Specifies how to sort series points. */ - sortingMethod?: any; - }; - /** Specifies a value indicating whether all bars in a series must have the same width, or may have different widths if any points in other series are missing. */ - equalBarWidth?: any; - /** Sets the name of the palette to be used in the range selector's chart. Alternatively, an array of colors can be set as a custom palette to be used within this chart. */ - palette?: any; - /** An object defining the chart’s series. */ - series?: Array; - /** Defines options for the series template. */ - seriesTemplate?: viz.charts.SeriesTemplate; - /** Specifies a coefficient for determining an indent from the background's top boundary to the topmost chart point. */ - topIndent?: number; - /** Specifies whether or not to filter the series points depending on their quantity. */ - useAggregation?: boolean; - /** Specifies options for the chart's value axis. */ - valueAxis?: { - /** Indicates whether or not the chart's value axis must be inverted. */ - inverted?: boolean; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic value axis. */ - logarithmBase?: number; - /** Specifies the maximum value of the chart's value axis. */ - max?: number; - /** Specifies the minimum value of the chart's value axis. */ - min?: number; - /** Specifies the type of the value axis. */ - type?: string; - /** Specifies the desired type of axis values. */ - valueType?: string; - }; - }; - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** Specifies a data source for the scale values and for the chart at the background. */ - dataSource?: any; - /** Specifies the data source field that provides data for the scale. */ - dataSourceField?: string; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies the blank space in pixels between the dxRangeSelector widget's extreme elements and the boundaries of the area provided for the widget (see size). */ - margin?: viz.core.Margins; - /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */ - redrawOnResize?: boolean; - /** Specifies options of the range selector's scale. */ - scale?: { - /** Specifies the scale's end value. */ - endValue?: any; - /** Specifies common options for scale labels. */ - label?: { - /** Specifies a callback function that returns the text to be displayed in scale labels. */ - customizeText?: (scaleValue: { value: any; valueText: string; }) => string; - /** Specifies font options for the text displayed in the range selector's scale labels. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in scale labels. */ - format?: string; - /** Specifies a precision for the formatted value displayed in the scale labels. */ - precision?: number; - /** Specifies a spacing between scale labels and the background bottom edge. */ - topIndent?: number; - /** Specifies whether or not the scale's labels are visible. */ - visible?: boolean; - }; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic scale. */ - logarithmBase?: number; - /** Specifies an interval between major ticks. */ - majorTickInterval?: any; - /** Specifies options for the date-time scale's markers. */ - marker?: { - /** Defines the options that can be set for the text that is displayed by the scale markers. */ - label?: { - /** Specifies a callback function that returns the text to be displayed in scale markers. */ - customizeText?: (markerValue: { value: any; valueText: string }) => string; - /** Specifies a format for the text displayed in scale markers. */ - format?: string; - }; - /** Specifies the height of the marker's separator. */ - separatorHeight?: number; - /** Specifies the space between the marker label and the marker separator. */ - textLeftIndent?: number; - /** Specifies the space between the marker's label and the top edge of the marker's separator. */ - textTopIndent?: number; - /** Specified the indent between the marker and the scale lables. */ - topIndent?: number; - /** Indicates whether scale markers are visible. */ - visible?: boolean; - }; - /** Specifies the maximum range that can be selected. */ - maxRange?: any; - /** Specifies the number of minor ticks between neighboring major ticks. */ - minorTickCount?: number; - /** Specifies an interval between minor ticks. */ - minorTickInterval?: any; - /** Specifies the minimum range that can be selected. */ - minRange?: any; - /** Specifies the height of the space reserved for the scale in pixels. */ - placeholderHeight?: number; - /** Indicates whether or not to set ticks of a date-time scale at the beginning of each date-time interval. */ - setTicksAtUnitBeginning?: boolean; - /** Specifies whether or not to show ticks for the boundary scale values, when neither major ticks nor minor ticks are created for these values. */ - showCustomBoundaryTicks?: boolean; - /** Indicates whether or not to show minor ticks on the scale. */ - showMinorTicks?: boolean; - /** Specifies the scale's start value. */ - startValue?: any; - /** Specifies options defining the appearance of scale ticks. */ - tick?: { - /** Specifies the color of scale ticks (both major and minor ticks). */ - color?: string; - /** Specifies the opacity of scale ticks (both major and minor ticks). */ - opacity?: number; - /** Specifies the width of the scale's ticks (both major and minor ticks). */ - width?: number; - }; - /** Specifies the type of the scale. */ - type?: string; - /** Specifies whether or not to expand the current tick interval if labels overlap each other. */ - useTicksAutoArrangement?: boolean; - /** Specifies the type of values on the scale. */ - valueType?: string; - /** Specifies the order of arguments on a discrete scale. */ - categories?: Array; - }; - /** Specifies the range to be selected when displaying the dxRangeSelector. */ - selectedRange?: { - /** Specifies the start value of the range to be selected when displaying the dxRangeSelector widget on a page. */ - startValue?: any; - /** Specifies the end value of the range to be selected when displaying the dxRangeSelector widget on a page. */ - endValue?: any; - }; - /** Specifies the color of the selected range. */ - selectedRangeColor?: string; - /** Range selector's indent options. */ - indent?: { - /** Specifies range selector's left indent. */ - left?: number; - /** Specifies range selector's right indent. */ - right?: number; - }; - selectedRangeChanged?: (selectedRange: { startValue: any; endValue: any; }) => void; - /** A handler for the selectedRangeChanged event. */ - onSelectedRangeChanged?: (e: { - startValue: any; - endValue: any; - component: dxRangeSelector; - element: Element; - }) => void; - /** Specifies range selector shutter options. */ - shutter?: { - /** Specifies shutter color. */ - color?: string; - /** Specifies the opacity of the color of shutters. */ - opacity?: number; - }; - /** Specifies in pixels the size of the dxRangeSelector widget. */ - size?: viz.core.Size; - /** Specifies the appearance of the range selector's slider handles. */ - sliderHandle?: { - /** Specifies the color of the slider handles. */ - color?: string; - /** Specifies the opacity of the slider handles. */ - opacity?: number; - /** Specifies the width of the slider handles. */ - width?: number; - }; - /** Defines the options of the range selector slider markers. */ - sliderMarker?: { - /** Specifies the color of the slider markers. */ - color?: string; - /** Specifies a callback function that returns the text to be displayed by slider markers. */ - customizeText?: (scaleValue: { value: any; valueText: any; }) => string; - /** Specifies font options for the text displayed by the range selector slider markers. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in slider markers. */ - format?: string; - /** Specifies the color used for the slider marker text when the currently selected range does not match the minRange and maxRange values. */ - invalidRangeColor?: string; - /** - * Specifies the empty space between the marker's border and the marker’s text. - * @deprecated Use the 'paddingTopBottom' and 'paddingLeftRight' options instead - */ - padding?: number; - /** Specifies the empty space between the marker's top and bottom borders and the marker's text. */ - paddingTopBottom?: number; - /** Specifies the empty space between the marker's left and right borders and the marker's text. */ - paddingLeftRight?: number; - /** Specifies the placeholder height of the slider marker. */ - placeholderHeight?: number; - /** - * Specifies in pixels the height and width of the space reserved for the range selector slider markers. - * @deprecated Use the 'placeholderHeight' and 'indent' options instead - */ - placeholderSize?: { - /** Specifies the height of the placeholder for the left and right slider markers. */ - height?: number; - /** Specifies the width of the placeholder for the left and right slider markers. */ - width?: { - /** Specifies the width of the left slider marker's placeholder. */ - left?: number; - /** Specifies the width of the right slider marker's placeholder. */ - right?: number; - }; - }; - /** Specifies a precision for the formatted value displayed in slider markers. */ - precision?: number; - /** Indicates whether or not the slider markers are visible. */ - visible?: boolean; - }; - } - /** A widget that allows end users to select a range of values on a scale. */ - export class dxRangeSelector extends viz.core.BaseWidget { - constructor(element: JQuery, options?: dxRangeSelectorOptions); - constructor(element: Element, options?: dxRangeSelectorOptions); - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(skipChartAnimation?: boolean): void; - /** Returns the currently selected range. */ - getSelectedRange(): { startValue: any; endValue: any; }; - /** Sets a specified range. */ - setSelectedRange(selectedRange: { startValue: any; endValue: any; }): void; - } -} -interface JQuery { - dxRangeSelector(options?: DevExpress.viz.rangeSelector.dxRangeSelectorOptions): JQuery; - dxRangeSelector(methodName: string, ...params: any[]): any; - dxRangeSelector(methodName: "instance"): DevExpress.viz.rangeSelector.dxRangeSelector; -} -declare namespace DevExpress.viz.map { - /** This section describes the fields and methods that can be used in code to manipulate the Area object. */ - export interface Area { - /** Contains the element type. */ - type: string; - /** Return the value of an attribute. */ - attribute(name: string): any; - /** Provides information about the selection state of an area. */ - selected(): boolean; - /** Sets a new selection state for an area. */ - selected(state: boolean): void; - /** Applies the area settings specified as a parameter and updates the area appearance. */ - applySettings(settings: any): void; - } - /** This section describes the fields and methods that can be used in code to manipulate the Markers object. */ - export interface Marker { - /** Contains the descriptive text accompanying the map marker. */ - text: string; - /** Contains the type of the element. */ - type: string; - /** Contains the URL of an image map marker. */ - url: string; - /** Contains the value of a bubble map marker. */ - value: number; - /** Contains the values of a pie map marker. */ - values: Array; - /** Returns the value of an attribute. */ - attribute(name: string): any; - /** Returns the coordinates of a specific marker. */ - coordinates(): Array; - /** Provides information about the selection state of a marker. */ - selected(): boolean; - /** Sets a new selection state for a marker. */ - selected(state: boolean): void; - /** Applies the marker settings specified as a parameter and updates the marker appearance. */ - applySettings(settings: any): void; - } - export interface AreaSettings { - /** Specifies the width of the area border in pixels. */ - borderWidth?: number; - /** Specifies a color for the area border. */ - borderColor?: string; - click?: any; - /** Specifies a color for an area. */ - color?: string; - /** Specifies the function that customizes each area individually. */ - customize?: (areaInfo: Area) => AreaSettings; - /** Specifies a color for the area border when the area is hovered over. */ - hoveredBorderColor?: string; - /** Specifies the pixel-measured width of the area border when the area is hovered over. */ - hoveredBorderWidth?: number; - /** Specifies a color for an area when this area is hovered over. */ - hoveredColor?: string; - /** Specifies whether or not to change the appearance of an area when it is hovered over. */ - hoverEnabled?: boolean; - /** Configures area labels. */ - label?: { - /** Specifies the data field that provides data for area labels. */ - dataField?: string; - /** Enables area labels. */ - enabled?: boolean; - /** Specifies font options for area labels. */ - font?: viz.core.Font; - }; - /** Specifies the name of the palette or a custom range of colors to be used for coloring a map. */ - palette?: any; - /** Specifies the number of colors in a palette. */ - paletteSize?: number; - /** Allows you to paint areas with similar attributes in the same color. */ - colorGroups?: Array; - /** Specifies the field that provides data to be used for coloring areas. */ - colorGroupingField?: string; - /** Specifies a color for the area border when the area is selected. */ - selectedBorderColor?: string; - /** Specifies a color for an area when this area is selected. */ - selectedColor?: string; - /** Specifies the pixel-measured width of the area border when the area is selected. */ - selectedBorderWidth?: number; - selectionChanged?: (area: Area) => void; - /** Specifies whether single or multiple areas can be selected on a vector map. */ - selectionMode?: string; - } - export interface MarkerSettings { - /** Specifies a color for the marker border. */ - borderColor?: string; - /** Specifies the width of the marker border in pixels. */ - borderWidth?: number; - click?: any; - /** Specifies a color for a marker of the dot or bubble type. */ - color?: string; - /** Specifies the function that customizes each marker individually. */ - customize?: (markerInfo: Marker) => MarkerSettings; - font?: Object; - /** Specifies the pixel-measured width of the marker border when the marker is hovered over. */ - hoveredBorderWidth?: number; - /** Specifies a color for the marker border when the marker is hovered over. */ - hoveredBorderColor?: string; - /** Specifies a color for a marker of the dot or bubble type when this marker is hovered over. */ - hoveredColor?: string; - /** Specifies whether or not to change the appearance of a marker when it is hovered over. */ - hoverEnabled?: boolean; - /** Specifies marker label options. */ - label?: { - /** Enables marker labels. */ - enabled?: boolean; - /** Specifies font options for marker labels. */ - font?: viz.core.Font; - }; - /** Specifies the pixel-measured diameter of the marker that represents the biggest value. Setting this option makes sense only if you use markers of the bubble type. */ - maxSize?: number; - /** Specifies the pixel-measured diameter of the marker that represents the smallest value. Setting this option makes sense only if you use markers of the bubble type. */ - minSize?: number; - /** Specifies the opacity of markers. Setting this option makes sense only if you use markers of the bubble type. */ - opacity?: number; - /** Specifies the pixel-measured width of the marker border when the marker is selected. */ - selectedBorderWidth?: number; - /** Specifies a color for the marker border when the marker is selected. */ - selectedBorderColor?: string; - /** Specifies a color for a marker of the dot or bubble type when this marker is selected. */ - selectedColor?: string; - selectionChanged?: (marker: Marker) => void; - /** Specifies whether a single or multiple markers can be selected on a vector map. */ - selectionMode?: string; - /** Specifies the size of markers. Setting this option makes sense for any type of marker except bubble. */ - size?: number; - /** Specifies the type of markers to be used on the map. */ - type?: string; - /** Specifies the name of a palette or a custom set of colors to be used for coloring markers of the pie type. */ - palette?: any; - /** Allows you to paint markers with similar attributes in the same color. */ - colorGroups?: Array; - /** Specifies the field that provides data to be used for coloring markers. */ - colorGroupingField?: string; - /** Allows you to display bubbles with similar attributes in the same size. */ - sizeGroups?: Array; - /** Specifies the field that provides data to be used for sizing bubble markers. */ - sizeGroupingField?: string; - } - export interface dxVectorMapOptions extends viz.core.BaseWidgetOptions { - /** An object specifying options for the map areas. */ - areaSettings?: AreaSettings; - /** Specifies the options for the map background. */ - background?: { - /** Specifies a color for the background border. */ - borderColor?: string; - /** Specifies a color for the background. */ - color?: string; - }; - /** Specifies the positioning of a map in geographical coordinates. */ - bounds?: Array; - /** Specifies the options of the control bar. */ - controlBar?: { - /** Specifies a color for the outline of the control bar elements. */ - borderColor?: string; - /** Specifies a color for the inner area of the control bar elements. */ - color?: string; - /** Specifies whether or not to display the control bar. */ - enabled?: boolean; - /** Specifies the margin of the control bar in pixels. */ - margin?: number; - /** Specifies the position of the control bar. */ - horizontalAlignment?: string; - /** Specifies the position of the control bar. */ - verticalAlignment?: string; - /** Specifies the opacity of the Control_Bar. */ - opacity?: number; - }; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies a data source for the map area. */ - mapData?: any; - /** Specifies a data source for the map markers. */ - markers?: any; - /** An object specifying options for the map markers. */ - markerSettings?: MarkerSettings; - /** Specifies the size of the dxVectorMap widget. */ - size?: viz.core.Size; - /** Specifies tooltip options. */ - tooltip?: viz.core.Tooltip; - /** Configures map legends. */ - legends?: Array; - /** Specifies whether or not the map should respond when a user rolls the mouse wheel. */ - wheelEnabled?: boolean; - /** Specifies whether the map should respond to touch gestures. */ - touchEnabled?: boolean; - /** Disables the zooming capability. */ - zoomingEnabled?: boolean; - /** Specifies the geographical coordinates of the center for a map. */ - center?: Array; - centerChanged?: (center: Array) => void; - /** A handler for the centerChanged event. */ - onCenterChanged?: (e: { - center: Array; - component: dxVectorMap; - element: Element; - }) => void; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: dxVectorMap; - element: Element; - target: {}; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: dxVectorMap; - element: Element; - target: {}; - }) => void; - /** Specifies a number that is used to zoom a map initially. */ - zoomFactor?: number; - /** Specifies a map's maximum zoom factor. */ - maxZoomFactor?: number; - zoomFactorChanged?: (zoomFactor: number) => void; - /** A handler for the zoomFactorChanged event. */ - onZoomFactorChanged?: (e: { - zoomFactor: number; - component: dxVectorMap; - element: Element; - }) => void; - click?: any; - /** A handler for the click event. */ - onClick?: any; - /** A handler for the areaClick event. */ - onAreaClick?: any; - /** A handler for the areaSelectionChanged event. */ - onAreaSelectionChanged?: (e: { - target: Area; - component: dxVectorMap; - element: Element; - }) => void; - /** A handler for the markerClick event. */ - onMarkerClick?: any; - /** A handler for the markerSelectionChanged event. */ - onMarkerSelectionChanged?: (e: { - target: Marker; - component: dxVectorMap; - element: Element; - }) => void; - /** Disables the panning capability. */ - panningEnabled?: boolean; - } - export interface Legend extends viz.core.BaseLegend { - /** Specifies text for legend items. */ - customizeText?: (itemInfo: { start: number; end: number; index: number; color: string; size: number; }) => string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the text of a legend item. */ - customizeHint?: (itemInfo: { start: number; end: number; index: number; color: string; size: number }) => string; - /** Specifies the source of data for the legend. */ - source?: string; - } - /** A vector map widget. */ - export class dxVectorMap extends viz.core.BaseWidget { - constructor(element: JQuery, options?: dxVectorMapOptions); - constructor(element: Element, options?: dxVectorMapOptions); - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(): void; - /** Gets the current coordinates of the map center. */ - center(): Array; - /** Sets the coordinates of the map center. */ - center(centerCoordinates: Array): void; - /** Deselects all the selected areas on a map. The areas are displayed in their initial style after. */ - clearAreaSelection(): void; - /** Deselects all the selected markers on a map. The markers are displayed in their initial style after. */ - clearMarkerSelection(): void; - /** Deselects all the selected area and markers on a map at once. The areas and markers are displayed in their initial style after. */ - clearSelection(): void; - /** Converts client area coordinates into map coordinates. */ - convertCoordinates(x: number, y: number): Array; - /** Returns an array with all the map areas. */ - getAreas(): Array; - /** Returns an array with all the map markers. */ - getMarkers(): Array; - /** Gets the current coordinates of the map viewport. */ - viewport(): Array; - /** Sets the coordinates of the map viewport. */ - viewport(viewportCoordinates: Array): void; - /** Gets the current value of the map zoom factor. */ - zoomFactor(): number; - /** Sets the value of the map zoom factor. */ - zoomFactor(zoomFactor: number): void; - } -} -interface JQuery { - dxVectorMap(options?: DevExpress.viz.map.dxVectorMapOptions): JQuery; - dxVectorMap(methodName: string, ...params: any[]): any; - dxVectorMap(methodName: "instance"): DevExpress.viz.map.dxVectorMap; -} -declare namespace DevExpress.viz.sparklines { - export interface SparklineTooltip extends viz.core.Tooltip { - /** - * Specifies how a tooltip is horizontally aligned relative to the graph. - * @deprecated Tooltip alignment is no more available. - */ - horizontalAlignment?: string; - /** - * Specifies how a tooltip is vertically aligned relative to the graph. - * @deprecated Tooltip alignment is no more available. - */ - verticalAlignment?: string; - } - export interface BaseSparklineOptions extends viz.core.BaseWidgetOptions { - /** Specifies the blank space between the widget's extreme elements and the boundaries of the area provided for the widget in pixels. */ - margin?: viz.core.Margins; - /** Specifies the size of the widget. */ - size?: viz.core.Size; - /** Specifies tooltip options. */ - tooltip?: SparklineTooltip; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: BaseSparkline; - element: Element; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: BaseSparkline; - element: Element; - }) => void; - } - /** Overridden by descriptions for particular widgets. */ - export class BaseSparkline extends viz.core.BaseWidget { - /** Redraws a widget. */ - render(): void; - } - export interface dxBulletOptions extends BaseSparkline { - /** Specifies a color for the bullet bar. */ - color?: string; - /** Specifies an end value for the invisible scale. */ - endScaleValue?: number; - /** Specifies whether or not to show the target line. */ - showTarget?: boolean; - /** Specifies whether or not to show the line indicating zero on the invisible scale. */ - showZeroLevel?: boolean; - /** Specifies a start value for the invisible scale. */ - startScaleValue?: number; - /** Specifies the value indicated by the target line. */ - target?: number; - /** Specifies a color for both the target and zero level lines. */ - targetColor?: string; - /** Specifies the width of the target line. */ - targetWidth?: number; - /** Specifies the primary value indicated by the bullet bar. */ - value?: number; - } - /** A bullet graph widget. */ - export class dxBullet extends BaseSparkline { - constructor(element: JQuery, options?: dxBulletOptions); - constructor(element: Element, options?: dxBulletOptions); - } - export interface dxSparklineOptions extends BaseSparklineOptions { - /** Specifies the data source field that provides arguments for a sparkline. */ - argumentField?: string; - /** Sets a color for the bars indicating negative values. Available for a sparkline of the bar type only. */ - barNegativeColor?: string; - /** Sets a color for the bars indicating positive values. Available for a sparkline of the bar type only. */ - barPositiveColor?: string; - /** Specifies a data source for the sparkline. */ - dataSource?: Array; - /** Sets a color for the boundary of both the first and last points on a sparkline. */ - firstLastColor?: string; - /** Specifies whether a sparkline ignores null data points or not. */ - ignoreEmptyPoints?: boolean; - /** Sets a color for a line on a sparkline. Available for the sparklines of the line- and area-like types. */ - lineColor?: string; - /** Specifies a width for a line on a sparkline. Available for the sparklines of the line- and area-like types. */ - lineWidth?: number; - /** Sets a color for the bars indicating the values that are less than the winloss threshold. Available for a sparkline of the winloss type only. */ - lossColor?: string; - /** Sets a color for the boundary of the maximum point on a sparkline. */ - maxColor?: string; - /** Sets a color for the boundary of the minimum point on a sparkline. */ - minColor?: string; - /** Sets a color for points on a sparkline. Available for the sparklines of the line- and area-like types. */ - pointColor?: string; - /** Specifies the diameter of sparkline points in pixels. Available for the sparklines of line- and area-like types. */ - pointSize?: number; - /** Specifies a symbol to use as a point marker on a sparkline. Available for the sparklines of the line- and area-like types. */ - pointSymbol?: string; - /** Specifies whether or not to indicate both the first and last values on a sparkline. */ - showFirstLast?: boolean; - /** Specifies whether or not to indicate both the minimum and maximum values on a sparkline. */ - showMinMax?: boolean; - /** Determines the type of a sparkline. */ - type?: string; - /** Specifies the data source field that provides values for a sparkline. */ - valueField?: string; - /** Sets a color for the bars indicating the values greater than a winloss threshold. Available for a sparkline of the winloss type only. */ - winColor?: string; - /** Specifies a value that serves as a threshold for the sparkline of the winloss type. */ - winlossThreshold?: number; - /** Specifies the minimum value of the sparkline value axis. */ - minValue?: number; - /** Specifies the maximum value of the sparkline's value axis. */ - maxValue?: number; - } - /** A sparkline widget. */ - export class dxSparkline extends BaseSparkline { - constructor(element: JQuery, options?: dxSparklineOptions); - constructor(element: Element, options?: dxSparklineOptions); - } -} -interface JQuery { - dxBullet(options?: DevExpress.viz.sparklines.dxBulletOptions): JQuery; - dxBullet(methodName: string, ...params: any[]): any; - dxBullet(methodName: "instance"): DevExpress.viz.sparklines.dxBullet; - dxSparkline(options?: DevExpress.viz.sparklines.dxSparklineOptions): JQuery; - dxSparkline(methodName: string, ...params: any[]): any; - dxSparkline(methodName: "instance"): DevExpress.viz.sparklines.dxSparkline; -} diff --git a/devextreme/devextreme-15.1.8.d.ts b/devextreme/devextreme-15.1.8.d.ts deleted file mode 100644 index 447e0b15b9..0000000000 --- a/devextreme/devextreme-15.1.8.d.ts +++ /dev/null @@ -1,6580 +0,0 @@ -// Type definitions for DevExtreme 15.1.8 -// Project: http://js.devexpress.com/ -// Definitions by: DevExpress Inc. -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -/// - -declare namespace DevExpress { - /** A mixin that provides a capability to fire and subscribe to events. */ - export interface EventsMixin { - /** Subscribes to a specified event. */ - on(eventName: string, eventHandler: Function): T; - /** Subscribes to the specified events. */ - on(events: { [eventName: string]: Function; }): T; - /** Detaches all event handlers from the specified event. */ - off(eventName: string): Object; - /** Detaches a particular event handler from the specified event. */ - off(eventName: string, eventHandler: Function): T; - } - /** An object that serves as a namespace for the methods required to perform validation. */ - export module validationEngine { - export interface IValidator { - validate(): ValidatorValidationResult; - reset(): void; - } - export interface ValidatorValidationResult { - isValid: boolean; - name?: string; - value: any; - brokenRule: any; - validationRules: any[]; - } - export interface ValidationGroupValidationResult { - isValid: boolean; - brokenRules: any[]; - validators: IValidator[]; - } - export interface GroupConfig extends EventsMixin { - group: any; - validators: IValidator[]; - validate(): ValidationGroupValidationResult; - reset(): void; - } - /** Provides access to the object that represents the specified validation group. */ - export function getGroupConfig(group: any): GroupConfig - /** Provides access to the object that represents the default validation group. */ - export function getGroupConfig(): GroupConfig - /** Validates rules of the validators that belong to the specified validation group. */ - export function validateGroup(group: any): ValidationGroupValidationResult; - /** Validates rules of the validators that belong to the default validation group. */ - export function validateGroup(): ValidationGroupValidationResult; - /** Resets the values and validation result of the editors that belong to the specified validation group. */ - export function resetGroup(group: any): void; - /** Resets the values and validation result of the editors that belong to the default validation group. */ - export function resetGroup(): void; - /** Validates the rules that are defined within the dxValidator objects that are registered for the specified ViewModel. */ - export function validateModel(model: Object): ValidationGroupValidationResult; - /** Registers all the dxValidator objects by which the fields of the specified ViewModel are extended. */ - export function registerModelForValidation(model: Object) : void; - } - export var hardwareBackButton: JQueryCallback; - /** Processes the hardware back button click. */ - export function processHardwareBackButton(): void; - /** Hides the last displayed overlay widget. */ - export function hideTopOverlay(): boolean; - /** Specifies whether or not the entire application/site supports right-to-left representation. */ - export var rtlEnabled: boolean; - /** Registers a new component in the DevExpress.ui namespace as a jQuery plugin, Angular directive and Knockout binding. */ - export function registerComponent(name: string, componentClass: Object): void; - /** Registers a new component in the specified namespace as a jQuery plugin, Angular directive and Knockout binding. */ - export function registerComponent(name: string, namespace: Object, componentClass: Object): void; - /** Requests that the browser call a specified function to update animation before the next repaint. */ - export function requestAnimationFrame(callback: Function): number; - /** Cancels an animation frame request scheduled with the requestAnimationFrame method. */ - export function cancelAnimationFrame(requestID: number): void; - /** Custom Knockout binding that links an HTML element with a specific action. */ - export class Action { } - /** Used to get URLs that vary in a locally running application and the application running on production. */ - export class EndpointSelector { - constructor(options: { - [key: string]: { - local?: string; - production?: string; - } - }); - /** Returns a local or a productional URL depending on how the application is currently running. */ - urlFor(key: string): string; - } - /** An object that serves as a namespace for the methods that are used to animate UI elements. */ - export module fx { - /** Defines animation options. */ - export interface AnimationOptions { - /** A function called after animation is completed. */ - complete?: (element: JQuery, config: AnimationOptions) => void; - /** A number specifying wait time before animation execution. */ - delay?: number; - /** A number specifying the time period to wait before the animation of the next stagger item starts. */ - staggerDelay?: number; - /** A number specifying the time in milliseconds spent on animation. */ - duration?: number; - /** A string specifying the type of an easing function used for animation. */ - easing?: string; - /** Specifies the initial animation state. */ - from?: any; - /** A function called before animation is started. */ - start?: (element: JQuery, config: AnimationOptions) => void; - /** Specifies a final animation state. */ - to?: any; - /** A string value specifying the animation type. */ - type?: string; - /** Specifies the animation direction for the "slideIn" and "slideOut" animation types. */ - direction?: string; - } - /** Animates the specified element. */ - export function animate(element: HTMLElement, config: AnimationOptions): Object; - /** Returns a value indicating whether the specified element is being animated. */ - export function isAnimating(element: HTMLElement): boolean; - /** Stops the animation. */ - export function stop(element: HTMLElement, jumpToEnd: boolean): void; - } - /** The manager that performs several specified animations at a time. */ - export class TransitionExecutor { - /** Deletes all the animations registered in the Transition Executor by using the enter(elements, animation) and leave(elements, animation) methods. */ - reset(): void; - /** Registers a set of elements that should be animated as "entering" using the specified animation configuration. */ - enter(elements: JQuery, animation: any): void; - /** Registers a set of elements that should be animated as "leaving" using the specified animation configuration. */ - leave(elements: JQuery, animation: any): void; - /** Starts all the animations registered using the enter(elements, animation) and leave(elements, animation) methods beforehand. */ - start(config: Object): JQueryPromise; - } - export class AnimationPresetCollection { - /** Resets all the changes made in the animation repository. */ - resetToDefaults(): void; - /** Deletes the specified animation or clears all the animation repository, if an animation name is not passed. */ - clear(name: string): void; - /** Adds the specified animation preset to the animation repository by the specified name. */ - registerPreset(name: string, config: any): void; - /** Applies the changes made in the animation repository. */ - applyChanges(): void; - /** Returns the configuration of the animation found in the animation repository by the specified name for the current device. */ - getPreset(name: string): void; - /** Registers predefined animations in the animation repository. */ - registerDefaultPresets(): void; - } - /** A repository of animations. */ - export var animationPresets: AnimationPresetCollection; - /** The device object defines the device on which the application is running. */ - export interface Device { - /** Indicates whether or not the device platform is Android. */ - android?: boolean; - /** Specifies the type of the device on which the application is running. */ - deviceType?: string; - /** Indicates whether or not the device platform is generic, which means that the application will look and behave according to a generic "light" or "dark" theme. */ - generic?: boolean; - /** Indicates whether or not the device platform is iOS. */ - ios?: boolean; - /** Indicates whether or not the device type is 'phone'. */ - phone?: boolean; - /** Specifies the platform of the device on which the application is running. */ - platform?: string; - /** Indicates whether or not the device type is 'tablet'. */ - tablet?: boolean; - /** Specifies an array with the major and minor versions of the device platform. */ - version?: Array; - /** Indicates whether or not the device platform is Windows8. */ - win8?: boolean; - /** Specifies a performance grade of the current device. */ - grade?: string; - } - export class Devices implements EventsMixin { - constructor(options: { window: Window }); - /** Overrides actual device information to force the application to operate as if it was running on the specified device. */ - current(deviceName: any): void; - /** Returns information about the current device. */ - current(): Device; - orientationChanged: JQueryCallback; - /** Returns the current device orientation. */ - orientation(): string; - /** Returns real information about the current device regardless of the value passed to the devices.current(deviceName) method. */ - real(): Device; - on(eventName: "orientationChanged", eventHandler: (e: { orientation: string }) => void): Devices; - on(eventName: string, eventHandler: Function): Devices; - on(events: { [eventName: string]: Function; }): Devices; - off(eventName: "orientationChanged"): Devices; - off(eventName: string): Devices; - off(eventName: "orientationChanged", eventHandler: (e: { orientation: string }) => void): Devices; - off(eventName: string, eventHandler: Function): Devices; - } - /** An object that serves as a namespace for the methods and events specifying information on the current device. */ - export var devices: Devices; - /** The position object specifies the widget positioning options. */ - export interface PositionOptions { - /** The target element position that the widget is positioned against. */ - at?: string; - /** The element within which the widget is positioned. */ - boundary?: Element; - /** A string value holding horizontal and vertical offset from the window's boundaries. */ - boundaryOffset?: string; - /** Specifies how to move the widget if it overflows the screen. */ - collision?: any; - /** The position of the widget to align against the target element. */ - my?: string; - /** The target element that the widget is positioned against. */ - of?: HTMLElement; - /** A string value holding horizontal and vertical offset in pixels, separated by a space (e.g., "5 -10"). */ - offset?: string; - } - export interface ComponentOptions { - /** A handler for the initialized event. */ - onInitialized?: Function; - /** A handler for the optionChanged event. */ - onOptionChanged?: Function; - /** A handler for the disposing event. */ - onDisposing?: Function; - } - /** A base class for all components and widgets. */ - export class Component { - constructor(options?: ComponentOptions) - /** Prevents the component from refreshing until the endUpdate method is called. */ - beginUpdate(): void; - /** Enables the component to refresh after the beginUpdate method call. */ - endUpdate(): void; - /** Returns an instance of this component class. */ - instance(): Component; - /** Returns the configuration options of this component. */ - option(): { - [optionKey: string]: any; - }; - /** Sets one or more options of this component. */ - option(options: { - [optionKey: string]: any; - }): void; - /** Gets the value of the specified configuration option of this component. */ - option(optionName: string): any; - /** Sets a value to the specified configuration option of this component. */ - option(optionName: string, optionValue: any): void; - } - export interface DOMComponentOptions extends ComponentOptions { - /** Specifies whether or not the current component supports a right-to-left representation. */ - rtlEnabled?: boolean; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies the width of the widget. */ - width?: any; - } - /** A base class for all components. */ - export class DOMComponent extends Component { - constructor(element: JQuery, options?: DOMComponentOptions); - constructor(element: HTMLElement, options?: DOMComponentOptions); - /** Returns the root HTML element of the widget. */ - element(): JQuery; - /** Specifies the device-dependent default configuration options for this component. */ - static defaultOptions(rule: { - device?: any; - options?: any; - }): void; - } - export module data { - export interface ODataError extends Error { - httpStatus?: number; - errorDetails?: any; - } - export interface StoreOptions { - inserted?: (values: Object, key: any) => void; - inserting?: (values: Object) => void; - loaded?: (result: Array) => void; - loading?: (loadOptions: LoadOptions) => void; - modified?: () => void; - modifying?: () => void; - removed?: (key: any) => void; - removing?: (key: any) => void; - updated?: (key: any, values: Object) => void; - updating?: (key: any, values: Object) => void; - /** A handler for the modified event. */ - onModified?: () => void; - /** A handler for the modifying event. */ - onModifying?: () => void; - /** A handler for the removed event. */ - onRemoved?: (key: any) => void; - /** A handler for the removing event. */ - onRemoving?: (key: any) => void; - /** A handler for the updated event. */ - onUpdated?: (key: any, values: Object) => void; - /** A handler for the updating event. */ - onUpdating?: (key: any, values: Object) => void; - /** A handler for the loaded event. */ - onLoaded?: (result: Array) => void; - /** A handler for the loading event. */ - onLoading?: (loadOptions: LoadOptions) => void; - /** A handler for the inserted event. */ - onInserted?: (values: Object, key: any) => void; - /** A handler for the inserting event. */ - onInserting?: (values: Object) => void; - /** Specifies the function called when the Store causes an error. */ - errorHandler?: (e: Error) => void; - /** Specifies the key properties within the data associated with the Store. */ - key?: any; - } - export interface LoadOptions { - filter?: Object; - sort?: Object; - select?: Object; - expand?: Object; - group?: Object; - skip?: number; - take?: number; - userData?: Object; - requireTotalCount?: boolean; - } - /** The base class for all Stores. */ - export class Store implements EventsMixin { - inserted: JQueryCallback; - inserting: JQueryCallback; - loaded: JQueryCallback; - loading: JQueryCallback; - modified: JQueryCallback; - modifying: JQueryCallback; - removed: JQueryCallback; - removing: JQueryCallback; - updated: JQueryCallback; - updating: JQueryCallback; - constructor(options?: StoreOptions); - /** Returns the data item specified by the key. */ - byKey(key: any): JQueryPromise; - /** Adds an item to the data associated with this Store. */ - insert(values: Object): JQueryPromise; - /** Returns the key expression specified via the key configuration option. */ - key(): any; - /** Returns the key of the Store item that matches the specified object. */ - keyOf(obj: Object): any; - /** Starts loading data. */ - load(obj?: LoadOptions): JQueryPromise; - /** Removes the data item specified by the key. */ - remove(key: any): JQueryPromise; - /** Obtains the total count of items that will be returned by the load() function. */ - totalCount(options?: { - filter?: Object; - group?: Object; - }): JQueryPromise; - /** Updates the data item specified by the key. */ - update(key: any, values: Object): JQueryPromise; - on(eventName: "removing", eventHandler: (key: any) => void): Store; - on(eventName: "removed", eventHandler: (key: any) => void): Store; - on(eventName: "updating", eventHandler: (key: any, values: Object) => void): Store; - on(eventName: "updated", eventHandler: (key: any, values: Object) => void): Store; - on(eventName: "inserting", eventHandler: (values: Object) => void): Store; - on(eventName: "inserted", eventHandler: (values: Object, key: any) => void): Store; - on(eventName: "modifying", eventHandler: () => void): Store; - on(eventName: "modified", eventHandler: () => void): Store; - on(eventName: "loading", eventHandler: (loadOptions: LoadOptions) => void): Store; - on(eventName: "loaded", eventHandler: (result: Array) => void): Store; - on(eventName: string, eventHandler: Function): Store; - on(events: { [eventName: string]: Function; }): Store; - off(eventName: "removing"): Store; - off(eventName: "removed"): Store; - off(eventName: "updating"): Store; - off(eventName: "updated"): Store; - off(eventName: "inserting"): Store; - off(eventName: "inserted"): Store; - off(eventName: "modifying"): Store; - off(eventName: "modified"): Store; - off(eventName: "loading"): Store; - off(eventName: "loaded"): Store; - off(eventName: string): Store; - off(eventName: "removing", eventHandler: (key: any) => void): Store; - off(eventName: "removed", eventHandler: (key: any) => void): Store; - off(eventName: "updating", eventHandler: (key: any, values: Object) => void): Store; - off(eventName: "updated", eventHandler: (key: any, values: Object) => void): Store; - off(eventName: "inserting", eventHandler: (values: Object) => void): Store; - off(eventName: "inserted", eventHandler: (values: Object, key: any) => void): Store; - off(eventName: "modifying", eventHandler: () => void): Store; - off(eventName: "modified", eventHandler: () => void): Store; - off(eventName: "loading", eventHandler: (loadOptions: LoadOptions) => void): Store; - off(eventName: "loaded", eventHandler: (result: Array) => void): Store; - off(eventName: string, eventHandler: Function): Store; - } - export interface ArrayStoreOptions extends StoreOptions { - /** Specifies the array associated with this Store. */ - data?: Array; - } - /** A Store accessing an in-memory array. */ - export class ArrayStore extends Store { - constructor(options?: ArrayStoreOptions); - /** Clears all data associated with the current ArrayStore. */ - clear(): void; - /** Creates the Query object for the underlying array. */ - createQuery(): Query; - } - interface Promise { - then(doneFn?: Function, failFn?: Function, progressFn?: Function): Promise; - } - export interface CustomStoreOptions extends StoreOptions { - /** The user implementation of the byKey(key, extraOptions) method. */ - byKey?: (key: any) => Promise; - /** The user implementation of the insert(values) method. */ - insert?: (values: Object) => Promise; - /** The user implementation of the load(options) method. */ - load?: (options?: LoadOptions) => Promise; - /** The user implementation of the remove(key) method. */ - remove?: (key: any) => Promise; - /** The user implementation of the totalCount(options) method. */ - totalCount?: (options?: { - filter?: Object; - group?: Object; - }) => Promise; - /** The user implementation of the update(key, values) method. */ - update?: (key: any, values: Object) => Promise; - } - /** A Store object that enables you to implement your own data access logic. */ - export class CustomStore extends Store { - constructor(options: CustomStoreOptions); - } - export interface DataSourceOptions { - /** Specifies data filtering conditions. */ - filter?: Object; - /** Specifies data grouping conditions. */ - group?: Object; - /** The item mapping function. */ - map?: (record: any) => any; - /** Specifies the maximum number of items the page can contain. */ - pageSize?: number; - /** Specifies whether a DataSource loads data by pages, or all items at once. */ - paginate?: boolean; - /** The data post processing function. */ - postProcess?: (data: any[]) => any[]; - /** Specifies a value by which the required items are searched. */ - searchExpr?: Object; - /** Specifies the comparison operation used to search for the required items. */ - searchOperation?: string; - /** Specifies the value to which the search expression is compared. */ - searchValue?: Object; - /** Specifies the initial select option value. */ - select?: Object; - /** An array of the strings that represent the names of the navigation properties to be loaded simultaneously with the OData store's entity. */ - expand?: Object; - /** Specifies whether or not the DataSource instance requests the total count of items available in the storage. */ - requireTotalCount?: boolean; - /** Specifies the initial sort option value. */ - sort?: Object; - /** Specifies the underlying Store instance used to access data. */ - store?: any; - /** A handler for the changed event. */ - onChanged?: () => void; - /** A handler for the loadingChanged event. */ - onLoadingChanged?: (isLoading: boolean) => void; - /** A handler for the loadError event. */ - onLoadError?: (e?: Error) => void; - } - /** An object that provides access to a data web service or local data storage for collection container widgets. */ - export class DataSource implements EventsMixin { - constructor(options?: DataSourceOptions); - changed: JQueryCallback; - loadError: JQueryCallback; - loadingChanged: JQueryCallback; - /** Disposes all resources associated with this DataSource. */ - dispose(): void; - /** Returns the current filter option value. */ - filter(): Object; - /** Sets the filter option value. */ - filter(filterExpr: Object): void; - /** Returns the current group option value. */ - group(): Object; - /** Sets the group option value. */ - group(groupExpr: Object): void; - /** Indicates whether or not the current page contains fewer items than the number of items specified by the pageSize configuration option. */ - isLastPage(): boolean; - /** Indicates whether or not at least one load() method execution has successfully finished. */ - isLoaded(): boolean; - /** Indicates whether or not the DataSource is currently being loaded. */ - isLoading(): boolean; - /** Returns the array of items currently operated by the DataSource. */ - items(): Array; - /** Returns the key expression. */ - key(): any; - /** Starts loading data. */ - load(): JQueryPromise>; - /** Returns an object that would be passed to the load() method of the underlying Store according to the current data shaping option values of the current DataSource instance. */ - loadOptions(): Object; - /** Returns the current pageSize option value. */ - pageSize(): number; - /** Sets the pageSize option value. */ - pageSize(value: number): void; - /** Specifies the index of the currently loaded page. */ - pageIndex(): number; - /** Specifies the index of the page to be loaded during the next load() method execution. */ - pageIndex(newIndex: number): void; - /** Returns the current paginate option value. */ - paginate(): boolean; - /** Sets the paginate option value. */ - paginate(value: boolean): void; - /** Returns the searchExpr option value. */ - searchExpr(): Object; - /** Sets the searchExpr option value. */ - searchExpr(expr: Object): void; - /** Returns the currently specified search operation. */ - searchOperation(): string; - /** Sets the current search operation. */ - searchOperation(op: string): void; - /** Returns the searchValue option value. */ - searchValue(): Object; - /** Sets the searchValue option value. */ - searchValue(value: Object): void; - /** Returns the current select option value. */ - select(): Object; - /** Sets the select option value. */ - select(expr: Object): void; - /** Returns the current requireTotalCount option value. */ - requireTotalCount(): boolean; - /** Sets the requireTotalCount option value. */ - requireTotalCount(value: boolean): void; - /** Returns the current sort option value. */ - sort(): Object; - /** Sets the sort option value. */ - sort(sortExpr: Object): void; - /** Returns the underlying Store instance. */ - store(): Store; - /** Returns the number of data items available in an underlying Store after the last load() operation without paging. */ - totalCount(): number; - on(eventName: "loadingChanged", eventHandler: (isLoading: boolean) => void): DataSource; - on(eventName: "loadError", eventHandler: (e?: Error) => void): DataSource; - on(eventName: "changed", eventHandler: () => void): DataSource; - on(eventName: string, eventHandler: Function): DataSource; - on(events: { [eventName: string]: Function; }): DataSource; - off(eventName: "loadingChanged"): DataSource; - off(eventName: "loadError"): DataSource; - off(eventName: "changed"): DataSource; - off(eventName: string): DataSource; - off(eventName: "loadingChanged", eventHandler: (isLoading: boolean) => void): DataSource; - off(eventName: "loadError", eventHandler: (e?: Error) => void): DataSource; - off(eventName: "changed", eventHandler: () => void): DataSource; - off(eventName: string, eventHandler: Function): DataSource; - } - /** An object used to work with primitive data types not supported by JavaScript when accessing an OData web service. */ - export class EdmLiteral { - /** Creates an EdmLiteral instance and assigns the specified value to it. */ - constructor(value: string); - /** Returns a string representation of the value associated with this EdmLiteral object. */ - valueOf(): string; - } - /** An object used to generate and hold the GUID. */ - export class Guid { - /** Creates a new Guid instance that holds the specified GUID. */ - constructor(value: string); - /** Creates a new Guid instance holding the generated GUID. */ - constructor(); - /** Returns a string representation of the Guid instance. */ - toString(): string; - /** Returns a string representation of the Guid instance. */ - valueOf(): string; - } - export interface LocalStoreOptions extends ArrayStoreOptions { - /** Specifies the time (in miliseconds) after the change operation, before the data is flushed. */ - flushInterval?: number; - /** Specifies whether the data is flushed immediatelly after each change operation, or after the delay specified via the flushInterval option. */ - immediate?: boolean; - /** The unique identifier used to distinguish the data within the HTML5 Web Storage. */ - name?: string; - } - /** A Store providing access to the HTML5 Web Storage. */ - export class LocalStore extends ArrayStore { - constructor(options?: LocalStoreOptions); - /** Removes all data associated with this Store. */ - clear(): void; - } - export interface ODataContextOptions extends ODataStoreOptions { - /** Specifies the list of entities to be accessed via the ODataContext. */ - entities?: Object; - /** Specifies the function called if the ODataContext causes an error. */ - errorHandler?: (e: Error) => void; - } - /** Provides access to the entire OData service. */ - export class ODataContext { - constructor(options?: ODataContextOptions); - /** Initiates the specified WebGet service operation that returns a value. For the information on service operations, refer to the OData documentation. */ - get(operationName: string, params: Object): JQueryPromise; - /** Initiates the specified WebGet service operation that returns nothing. For the information on service operations, refer to the OData documentation. */ - invoke(operationName: string, params: Object, httpMethod: Object): JQueryPromise; - /** Return a special proxy object to describe the entity link. */ - objectLink(entityAlias: string, key: any): Object; - } - export interface ODataStoreOptions extends StoreOptions { - /** A function used to customize a web request before it is sent. */ - beforeSend?: (request: { - url: string; - method: string; - timeout: number; - params: Object; - payload: Object; - headers: Object; - }) => void; - /** Specifies whether the ODataStore uses the JSONP approach to access non-CORS-compatible remote services. */ - jsonp?: boolean; - /** Specifies the type of the ODataStore key property. The following key types are supported out of the box: String, Int32, Int64, and Guid. */ - keyType?: any; - /** Specifies the URL of the data service being accessed via the current ODataContext. */ - url?: string; - /** Specifies the version of the OData protocol used to interact with the data service. */ - version?: number; - /** Specifies the value of the withCredentials field of the underlying jqXHR object. */ - withCredentials?: boolean; - } - /** A Store providing access to a separate OData web service entity. */ - export class ODataStore extends Store { - constructor(options?: ODataStoreOptions); - /** Creates the Query object for the OData endpoint. */ - createQuery(loadOptions: Object): Object; - /** Returns the data item specified by the key. */ - byKey(key: any, extraOptions?: { expand?: Object }): JQueryPromise; - } - /** An universal chainable data query interface object. */ - export interface Query { - /** Calculates a custom summary for the items in the current Query. */ - aggregate(step: (accumulator: any, value: any) => any): JQueryPromise; - /** Calculates a custom summary for the items in the current Query. */ - aggregate(seed: any, step: (accumulator: any, value: any) => any, finalize: (result: any) => any): JQueryPromise; - /** Calculates the average item value for the current Query. */ - avg(getter: Object): JQueryPromise; - /** Finds the item with the maximum getter value. */ - max(getter: Object): JQueryPromise; - /** Finds the item with the maximum value in the Query. */ - max(): JQueryPromise; - /** Finds the item with the minimum value in the Query. */ - min(): JQueryPromise; - /** Finds the item with the minimum getter value. */ - min(getter: Object): JQueryPromise; - /** Calculates the average item value for the current Query, if each Query item has a numeric type. */ - avg(): JQueryPromise; - /** Returns the total count of items in the current Query. */ - count(): JQueryPromise; - /** Executes the Query. */ - enumerate(): JQueryPromise; - /** Filters the current Query data. */ - filter(criteria: Array): Query; - /** Groups the current Query data. */ - groupBy(getter: Object): Query; - /** Applies the specified transformation to each item. */ - select(getter: Object): Query; - /** Limits the data item count. */ - slice(skip: number, take?: number): Query; - /** Sorts current Query data. */ - sortBy(getter: Object, desc: boolean): Query; - /** Sorts current Query data. */ - sortBy(getter: Object): Query; - /** Calculates the sum of item getter values in the current Query. */ - sum(getter: Object): JQueryPromise; - /** Calculates the sum of item values in the current Query. */ - sum(): JQueryPromise; - /** Adds one more sorting condition to the current Query. */ - thenBy(getter: Object): Query; - /** Adds one more sorting condition to the current Query. */ - thenBy(getter: Object, desc: boolean): Query; - /** Returns the array of current Query items. */ - toArray(): Array; - } - /** The global data layer error handler. */ - export var errorHandler: (e: Error) => void; - /** Encodes the specified string or array of bytes to base64 encoding. */ - export function base64_encode(input: any): string; - /** Creates a Query instance. */ - export function query(array: Array): Query; - /** Creates a Query instance for accessing the remote service specified by a URL. */ - export function query(url: string, queryOptions: Object): Query; - /** This section describes the utility objects provided by the DevExtreme data layer. */ - export var utils: { - /** Compiles a getter function from the getter expression. */ - compileGetter(expr: any): Function; - /** Compiles a setter function from the setter expression. */ - compileSetter(expr: any): Function; - odata: { - /** Holds key value converters for OData. */ - keyConverters: { - String(value: any): string; - Int32(value: any): number; - Int64(value: any): EdmLiteral; - Guid(value: any): Guid; - Boolean(value: any): boolean; - Single(value: any): EdmLiteral; - Decimal(value: any): EdmLiteral; - }; - } - } - } - /** An object that serves as a namespace for DevExtreme UI widgets as well as for methods implementing UI logic in DevExtreme sites/applications. */ - export module ui { - export interface WidgetOptions extends DOMComponentOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A Boolean value specifying whether or not the widget can respond to user interaction. */ - disabled?: boolean; - /** A Boolean value specifying whether or not the widget changes its state when being hovered by an end user. */ - hoverStateEnabled?: boolean; - /** Specifies whether or not the widget can be focused. */ - focusStateEnabled?: boolean; - /** Specifies a shortcut key that sets focus on the widget element. */ - accessKey?: string; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - /** Specifies the widget tab index. */ - tabIndex?: number; - /** Specifies the text of the hint displayed for the widget. */ - hint?: string; - } - /** The base class for widgets. */ - export class Widget extends DOMComponent { - constructor(options?: WidgetOptions); - /** Redraws the widget. */ - repaint(): void; - /** Sets focus on the widget. */ - focus(): void; - /** Registers a handler when a specified key is pressed. */ - registerKeyHandler(key: string, handler: Function): void; - } - export interface CollectionWidgetOptions extends WidgetOptions { - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - itemClickAction?: any; - itemHoldAction?: Function; - /** The time period in milliseconds before the onItemHold event is raised. */ - itemHoldTimeout?: number; - itemRender?: any; - itemRenderedAction?: Function; - /** An array of items displayed by the widget. */ - items?: Array; - /** - * A function performed when a widget item is selected. - * @deprecated onSelectionChanged.md - */ - itemSelectAction?: Function; - /** The template to be used for rendering items. */ - itemTemplate?: any; - loopItemFocus?: boolean; - /** The text or HTML markup displayed by the widget if the item collection is empty. */ - noDataText?: string; - onContentReady?: any; - contentReadyAction?: any; - /** A handler for the itemClick event. */ - onItemClick?: any; - /** A handler for the itemContextMenu event. */ - onItemContextMenu?: Function; - /** A handler for the itemHold event. */ - onItemHold?: Function; - /** A handler for the itemRendered event. */ - onItemRendered?: Function; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: Function; - /** The index of the currently selected widget item. */ - selectedIndex?: number; - /** The selected item object. */ - selectedItem?: Object; - /** An array of currently selected item objects. */ - selectedItems?: Array; - /** A handler for the itemDeleting event. */ - onItemDeleting?: Function; - /** A handler for the itemDeleted event. */ - onItemDeleted?: Function; - /** A handler for the itemReordered event. */ - onItemReordered?: Function; - } - /** The base class for widgets containing an item collection. */ - export class CollectionWidget extends Widget { - constructor(element: JQuery, options?: CollectionWidgetOptions); - constructor(element: HTMLElement, options?: CollectionWidgetOptions); - selectItem(itemElement: any): void; - unselectItem(itemElement: any): void; - deleteItem(itemElement: any): JQueryPromise; - isItemSelected(itemElement: any): boolean; - reorderItem(itemElement: any, toItemElement: any): JQueryPromise; - } - export interface DataExpressionMixinOptions { - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** Specifies the name of the data source item field whose value is displayed by the widget. */ - displayExpr?: any; - /** Specifies the name of a data source item field whose value is held in the value configuration option. */ - valueExpr?: any; - itemRender?: any; - /** An array of items displayed by the widget. */ - items?: Array; - /** The template to be used for rendering items. */ - itemTemplate?: any; - /** The currently selected value in the widget. */ - value?: Object; - } - export interface EditorOptions extends WidgetOptions { - /** The currently specified value. */ - value?: Object; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - valueChangeAction?: Function; - /** A Boolean value specifying whether or not the widget is read-only. */ - readOnly?: boolean; - /** Holds the object that defines the error that occurred during validation. */ - validationError?: Object; - /** Specifies whether the editor's value is valid. */ - isValid?: boolean; - /** Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed. */ - validationMessageMode?: string; - } - /** A base class for editors. */ - export class Editor extends Widget { - /** Resets the editor's value to undefined. */ - reset(): void; - } - /** An object that serves as a namespace for methods displaying a message in an application/site. */ - export var dialog: { - /** Creates an alert dialog message containing a single "OK" button. */ - alert(message: string, title: string): JQueryPromise; - /** Creates a confirm dialog that contains "Yes" and "No" buttons. */ - confirm(message: string, title: string): JQueryPromise; - /** Creates a custom dialog using the options specified by the passed configuration object. */ - custom(options: { title?: string; message?: string; buttons?: Array; }): { - show(): JQueryPromise; - hide(): void; - hide(value: any): void; - }; - }; - /** Creates a toast message. */ - export function notify(message: any, type: string, displayTime: number): void; - /** Creates a toast message. */ - export function notify(options: Object): void; - /** An object that serves as a namespace for the methods that work with DevExtreme CSS Themes. */ - export var themes: { - /** Returns the name of the currently applied theme. */ - current(): string; - /** Changes the current theme to the specified one. */ - current(themeName: string): void; - }; - /** Sets a specified template engine. */ - export function setTemplateEngine(name: string): void; - /** Sets a custom template engine defined via custom compile and render functions. */ - export function setTemplateEngine(options: Object): void; - } - /** An object that serves as a namespace for utility methods that can be helpful when working with the DevExtreme framework and UI widgets. */ - export var utils: { - /** Sets parameters for the viewport meta tag. */ - initMobileViewport(options: { allowZoom?: boolean; allowPan?: boolean; allowSelection?: boolean }): void; - }; - /** An object that serves as a namespace for DevExtreme Data Visualization Widgets. */ - export module viz { - /** Applies a theme for the entire page with several DevExtreme visualization widgets. */ - export function currentTheme(theme: string): void; - /** Applies a new theme (with the color scheme defined separately) for the entire page with several DevExtreme visualization widgets. */ - export function currentTheme(platform: string, colorScheme: string): void; - /** Registers a new theme based on the existing one. */ - export function registerTheme(customTheme: Object, baseTheme: string): void; - /** Applies a predefined or registered custom palette to all visualization widgets at once. */ - export function currentPalette(paletteName: string): void; - /** Obtains the color sets of a predefined or registered palette. */ - export function getPalette(paletteName: string): Object; - /** Registers a new palette. */ - export function registerPalette(paletteName: string, palette: Object): void; - } -} -declare namespace DevExpress.ui { - export interface dxValidatorOptions extends DOMComponentOptions { - /** An array of validation rules to be checked for the editor with which the dxValidator object is associated. */ - validationRules?: Array; - /** Specifies the editor name to be used in the validation default messages. */ - name?: string; - /** An object that specifies what and when to validate and how to apply the validation result. */ - adapter?: Object; - /** Specifies the validation group the editor will be related to. */ - validationGroup?: string; - /** A handler for the validated event. */ - onValidated?: (params: validationEngine.ValidatorValidationResult) => void; - } - /** A widget that is used to validate the associated DevExtreme editors against the defined validation rules. */ - export class dxValidator extends DOMComponent implements validationEngine.IValidator { - constructor(element: JQuery, options?: dxValidatorOptions); - constructor(element: Element, options?: dxValidatorOptions); - /** Validates the value of the editor that is controlled by the current dxValidator object against the list of the specified validation rules. */ - validate(): validationEngine.ValidatorValidationResult; - /** Resets the value and validation result of the editor associated with the current dxValidator object. */ - reset(): void; - } - /** The widget that is used in the Knockout and Angular approaches to combine the editors to be validated. */ - export class dxValidationGroup extends DOMComponent { - constructor(element: JQuery); - constructor(element: Element); - /** Validates rules of the validators that belong to the current validation group. */ - validate(): validationEngine.ValidationGroupValidationResult; - /** Resets the value and validation result of the editors that are included to the current validation group. */ - reset(): void; - } - export interface dxValidationSummaryOptions extends CollectionWidgetOptions { - /** Specifies the validation group for which summary should be generated. */ - validationGroup?: string; - } - /** A widget for displaying the result of checking validation rules for editors. */ - export class dxValidationSummary extends CollectionWidget { - constructor(element: JQuery, options?: dxValidationSummaryOptions); - constructor(element: Element, options?: dxValidationSummaryOptions); - } - export interface dxResizableOptions extends DOMComponentOptions { - /** Specifies which borders of the widget element are used as a handle. */ - handles?: string; - /** Specifies the lower width boundary for resizing. */ - minWidth?: number; - /** Specifies the upper width boundary for resizing. */ - maxWidth?: number; - /** Specifies the lower height boundary for resizing. */ - minHeight?: number; - /** Specifies the upper height boundary for resizing. */ - maxHeight?: number; - /** A handler for the resizeStart event. */ - onResizeStart?: Function; - /** A handler for the resize event. */ - onResize?: Function; - /** A handler for the resizeEnd event. */ - onResizeEnd?: Function; - } - /** A widget that displays required content in a resizable element. */ - export class dxResizable extends DOMComponent { - constructor(element: JQuery, options?: dxResizableOptions); - constructor(element: Element, options?: dxResizableOptions); - } - export interface dxTooltipOptions extends dxPopoverOptions { - } - /** A tooltip widget. */ - export class dxTooltip extends dxPopover { - constructor(element: JQuery, options?: dxTooltipOptions); - constructor(element: Element, options?: dxTooltipOptions); - } - export interface dxDropDownListOptions extends dxDropDownEditorOptions, DataExpressionMixinOptions { - /** Returns the value currently displayed by the widget. */ - displayValue?: string; - /** The minimum number of characters that must be entered into the text box to begin a search. */ - minSearchLength?: number; - /** Specifies the name of a data source item field or an expression whose value is compared to the search criterion. */ - searchExpr?: Object; - /** Specifies the binary operation used to filter data. */ - searchMode?: string; - /** Specifies the time delay, in milliseconds, after the last character has been typed in, before a search is executed. */ - searchTimeout?: number; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - /** Specifies DOM event names that update a widget's value. */ - valueChangeEvent?: string; - /** Specifies whether or not the widget supports searching. */ - searchEnabled?: boolean; - /** - * Specifies whether or not the widget displays items by pages. - * @deprecated dataSource.paginate.md - */ - pagingEnabled?: boolean; - /** The text or HTML markup displayed by the widget if the item collection is empty. */ - noDataText?: string; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: Function; - /** A handler for the itemClick event. */ - onItemClick?: Function; - onContentReady?: Function; - } - /** A base class for drop-down list widgets. */ - export class dxDropDownList extends dxDropDownEditor { - constructor(element: JQuery, options?: dxDropDownListOptions); - constructor(element: Element, options?: dxDropDownListOptions); - } - export interface dxToolbarOptions extends CollectionWidgetOptions { - menuItemRender?: any; - /** The template used to render menu items. */ - menuItemTemplate?: any; - /** Informs the widget about its location in a view HTML markup. */ - renderAs?: string; - } - /** A toolbar widget. */ - export class dxToolbar extends CollectionWidget { - constructor(element: JQuery, options?: dxToolbarOptions); - constructor(element: Element, options?: dxToolbarOptions); - } - export interface dxToastOptions extends dxOverlayOptions { - animation?: fx.AnimationOptions; - /** The time span in milliseconds during which the dxToast widget is visible. */ - displayTime?: number; - height?: any; - /** The dxToast message text. */ - message?: string; - position?: PositionOptions; - shading?: boolean; - /** Specifies the dxToast widget type. */ - type?: string; - width?: any; - closeOnBackButton?: boolean; - } - /** The toast message widget. */ - export class dxToast extends dxOverlay { - constructor(element: JQuery, options?: dxToastOptions); - constructor(element: Element, options?: dxToastOptions); - } - export interface dxTextEditorOptions extends EditorOptions { - /** A handler for the change event. */ - onChange?: Function; - changeAction?: Function; - /** A handler for the copy event. */ - onCopy?: Function; - copyAction?: Function; - /** A handler for the cut event. */ - onCut?: Function; - cutAction?: Function; - /** A handler for the enterKey event. */ - onEnterKey?: Function; - enterKeyAction?: Function; - /** A handler for the focusIn event. */ - onFocusIn?: Function; - focusInAction?: Function; - /** A handler for the focusOut event. */ - onFocusOut?: Function; - focusOutAction?: Function; - /** A handler for the input event. */ - onInput?: Function; - inputAction?: Function; - /** A handler for the keyDown event. */ - onKeyDown?: Function; - keyDownAction?: Function; - /** A handler for the keyPress event. */ - onKeyPress?: Function; - keyPressAction?: Function; - /** A handler for the keyUp event. */ - onKeyUp?: Function; - keyUpAction?: Function; - /** A handler for the paste event. */ - onPaste?: Function; - pasteAction?: Function; - /** The text displayed by the widget when the widget value is empty. */ - placeholder?: string; - /** Specifies whether to display the Clear button in the widget. */ - showClearButton?: boolean; - /** Specifies the current value displayed by the widget. */ - value?: any; - /** Specifies DOM event names that update a widget's value. */ - valueChangeEvent?: string; - /** Specifies whether or not the widget checks the inner text for spelling mistakes. */ - spellcheck?: boolean; - /** Specifies HTML attributes applied to the inner input element of the widget. */ - attr?: Object; - /** The read-only option that holds the text displayed by the widget input element. */ - text?: string; - /** Specifies whether or not the widget supports the focused state and keyboard navigation. */ - focusStateEnabled?: boolean; - /** A Boolean value specifying whether or not the widget changes its state when being hovered by an end user. */ - hoverStateEnabled?: boolean; - /** The editor mask that specifies the format of the entered string. */ - mask?: string; - /** Specifies a mask placeholder character. */ - maskChar?: string; - /** Specifies custom mask rules. */ - maskRules?: Object; - /** A message displayed when the entered text does not match the specified pattern. */ - maskInvalidMessage?: string; - } - /** A base class for text editing widgets. */ - export class dxTextEditor extends Editor { - constructor(element: JQuery, options?: dxTextEditorOptions); - constructor(element: Element, options?: dxTextEditorOptions); - /** Removes focus from the input element. */ - blur(): void; - /** Sets focus to the input element representing the widget. */ - focus(): void; - } - export interface dxTextBoxOptions extends dxTextEditorOptions { - /** Specifies the maximum number of characters you can enter into the textbox. */ - maxLength?: any; - /** The "mode" attribute value of the actual HTML input element representing the text box. */ - mode?: string; - } - /** A single-line text box widget. */ - export class dxTextBox extends dxTextEditor { - constructor(element: JQuery, options?: dxTextBoxOptions); - constructor(element: Element, options?: dxTextBoxOptions); - } - export interface dxTextAreaOptions extends dxTextBoxOptions { - /** Specifies whether or not the widget checks the inner text for spelling mistakes. */ - spellcheck?: boolean; - } - /** A widget used to display and edit multi-line text. */ - export class dxTextArea extends dxTextBox { - constructor(element: JQuery, options?: dxTextAreaOptions); - constructor(element: Element, options?: dxTextAreaOptions); - } - export interface dxTabsOptions extends CollectionWidgetOptions { - /** Specifies whether the widget enables an end-user to select only a single item or multiple items. */ - selectionMode?: string; - /** Specifies whether or not an end-user can scroll tabs by swiping. */ - scrollByContent?: boolean; - /** Specifies whether or not an end-user can scroll tabs. */ - scrollingEnabled?: boolean; - /** A Boolean value that specifies the availability of navigation buttons. */ - showNavButtons?: boolean; - } - /** A tab strip used to switch between pages. */ - export class dxTabs extends CollectionWidget { - constructor(element: JQuery, options?: dxTabsOptions); - constructor(element: Element, options?: dxTabsOptions); - } - export interface dxTabPanelOptions extends dxMultiViewOptions { - /** A handler for the titleClick event. */ - onTitleClick?: any; - /** A handler for the titleHold event. */ - onTitleHold?: Function; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - titleTemplate?: any; - /** The template to be used for rendering an item title. */ - itemTitleTemplate?: any; - } - /** A widget used to display a view and to switch between several views by clicking the appropriate tabs. */ - export class dxTabPanel extends dxMultiView { - constructor(element: JQuery, options?: dxTabPanelOptions); - constructor(element: Element, options?: dxTabPanelOptions); - } - export interface dxSelectBoxOptions extends dxDropDownListOptions { - /** The template to be used for rendering the widget text field. */ - fieldTemplate?: any; - /** The text that is provided as a hint in the select box editor. */ - placeholder?: string; - /** Specifies whether or not the widget allows an end-user to enter a custom value. */ - fieldEditEnabled?: boolean; - } - /** A widget that allows you to select an item in a dropdown list. */ - export class dxSelectBox extends dxDropDownList { - constructor(element: JQuery, options?: dxSelectBoxOptions); - constructor(element: Element, options?: dxSelectBoxOptions); - } - export interface dxTagBoxOptions extends dxSelectBoxOptions { - /** Holds the list of selected values. */ - values?: Array; - } - /** A widget that allows you to select multiple items from a dropdown list. */ - export class dxTagBox extends dxSelectBox { - constructor(element: JQuery, options?: dxTagBoxOptions); - constructor(element: Element, options?: dxTagBoxOptions); - } - export interface dxScrollViewOptions extends dxScrollableOptions { - /** A handler for the pullDown event. */ - onPullDown?: Function; - pullDownAction?: Function; - /** Specifies the text shown in the pullDown panel when pulling the content down lowers the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while pulling the content down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the reachBottom event. */ - onReachBottom?: Function; - reachBottomAction?: Function; - /** Specifies the text shown in the pullDown panel displayed when content is scrolled to the bottom. */ - reachBottomText?: string; - /** Specifies the text shown in the pullDown panel displayed when the content is being refreshed. */ - refreshingText?: string; - /** Returns a value indicating if the scrollView content is larger then the widget container. */ - isFull(): boolean; - /** Locks the widget until the release(preventScrollBottom) method is called and executes the function passed to the onPullDown option and the handler assigned to the pullDown event. */ - refresh(): void; - /** Notifies the scroll view that data loading is finished. */ - release(preventScrollBottom: boolean): JQueryPromise; - /** Toggles the loading state of the widget. */ - toggleLoading(showOrHide: boolean): void; - } - /** A widget used to display scrollable content. */ - export class dxScrollView extends dxScrollable { - constructor(element: JQuery, options?: dxScrollViewOptions); - constructor(element: Element, options?: dxScrollViewOptions); - } - export interface dxScrollableLocation { - top?: number; - left?: number; - } - export interface dxScrollableOptions extends DOMComponentOptions { - /** A string value specifying the available scrolling directions. */ - direction?: string; - /** A Boolean value specifying whether or not the widget can respond to user interaction. */ - disabled?: boolean; - /** A handler for the scroll event. */ - onScroll?: Function; - scrollAction?: Function; - /** Specifies when the widget shows the scrollbar. */ - showScrollbar?: string; - /** A handler for the update event. */ - onUpdated?: Function; - updateAction?: Function; - /** Indicates whether to use native or simulated scrolling. */ - useNative?: boolean; - /** A Boolean value specifying whether to enable or disable the bounce-back effect. */ - bounceEnabled?: boolean; - /** A Boolean value specifying whether or not an end-user can scroll the widget content swiping it up or down. */ - scrollByContent?: boolean; - /** A Boolean value specifying whether or not an end-user can scroll the widget content using the scrollbar. */ - scrollByThumb?: boolean; - } - /** A widget used to display scrollable content. */ - export class dxScrollable extends DOMComponent { - constructor(element: JQuery, options?: dxScrollableOptions); - constructor(element: Element, options?: dxScrollableOptions); - /** Returns the height of the scrollable widget in pixels. */ - clientHeight(): number; - /** Returns the width of the scrollable widget in pixels. */ - clientWidth(): number; - /** Returns an HTML element of the widget. */ - content(): JQuery; - /** Scrolls the widget content by the specified number of pixels. */ - scrollBy(distance: number): void; - /** Scrolls widget content by the specified number of pixels in horizontal and vertical directions. */ - scrollBy(distanceObject: dxScrollableLocation): void; - /** Returns the height of the scrollable content in pixels. */ - scrollHeight(): number; - /** Returns the current scroll position against the leftmost position. */ - scrollLeft(): number; - /** Returns how far the scrollable content is scrolled from the top and from the left. */ - scrollOffset(): dxScrollableLocation; - /** Scrolls widget content to the specified position. */ - scrollTo(targetLocation: number): void; - /** Scrolls widget content to a specified position. */ - scrollTo(targetLocation: dxScrollableLocation): void; - /** Scrolls widget content to the specified element. */ - scrollToElement(element: Element): void; - /** Returns the current scroll position against the topmost position. */ - scrollTop(): number; - /** Returns the width of the scrollable content in pixels. */ - scrollWidth(): number; - /** Updates the dimensions of the scrollable contents. */ - update(): void; - } - export interface dxRadioGroupOptions extends CollectionWidgetOptions, DataExpressionMixinOptions { - /** Specifies the radio group layout. */ - layout?: string; - } - /** A widget that enables a user to select one item within a list of items represented by radio buttons. */ - export class dxRadioGroup extends CollectionWidget { - constructor(element: JQuery, options?: dxRadioGroupOptions); - constructor(element: Element, options?: dxRadioGroupOptions); - } - export interface dxPopupOptions extends dxOverlayOptions { - animation?: fx.AnimationOptions; - /** Specifies whether or not to allow a user to drag the popup window. */ - dragEnabled?: boolean; - /** A Boolean value specifying whether or not to display the widget in full-screen mode. */ - fullScreen?: boolean; - position?: PositionOptions; - /** A Boolean value specifying whether or not to display the title in the popup window. */ - showTitle?: boolean; - /** The title in the overlay window. */ - title?: string; - /** A template to be used for rendering the widget title. */ - titleTemplate?: any; - width?: any; - /** Specifies items displayed on the top or bottom toolbar of the popup window. */ - buttons?: Array; - /** Specifies whether or not the widget displays the Close button. */ - showCloseButton?: boolean; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - } - /** A widget that displays required content in a popup window. */ - export class dxPopup extends dxOverlay { - constructor(element: JQuery, options?: dxPopupOptions); - constructor(element: Element, options?: dxPopupOptions); - } - export interface dxPopoverOptions extends dxPopupOptions { - /** An object defining animation options of the widget. */ - animation?: fx.AnimationOptions; - /** Specifies the height of the widget. */ - height?: any; - /** An object defining widget positioning options. */ - position?: PositionOptions; - shading?: boolean; - /** A Boolean value specifying whether or not to display the title in the overlay window. */ - showTitle?: boolean; - /** The target element associated with a popover. */ - target?: any; - /** Specifies the width of the widget. */ - width?: any; - } - /** A widget that displays the required content in a popup window. */ - export class dxPopover extends dxPopup { - constructor(element: JQuery, options?: dxPopoverOptions); - constructor(element: Element, options?: dxPopoverOptions); - /** Displays the widget for the specified target element. */ - show(target?: any): JQueryPromise; - } - export interface dxOverlayOptions extends WidgetOptions { - /** An object that defines the animation options of the widget. */ - animation?: fx.AnimationOptions; - /** A Boolean value specifying whether or not the widget is closed if a user presses the Back hardware button. */ - closeOnBackButton?: boolean; - /** A Boolean value specifying whether or not the widget is closed if a user clicks outside of the overlapping window. */ - closeOnOutsideClick?: any; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - /** Specifies whether or not an end-user can drag the widget. */ - dragEnabled?: boolean; - /** Specifies whether or not an end user can resize the widget. */ - resizeEnabled?: boolean; - /** The height of the widget in pixels. */ - height?: any; - /** A handler for the hidden event. */ - onHidden?: Function; - hiddenAction?: Function; - /** A handler for the hiding event. */ - onHiding?: Function; - hidingAction?: Function; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** A Boolean value specifying whether or not the main screen is inactive while the widget is active. */ - shading?: boolean; - /** Specifies the shading color. */ - shadingColor?: string; - /** A handler for the showing event. */ - onShowing?: Function; - showingAction?: Function; - /** A handler for the shown event. */ - onShown?: Function; - shownAction?: Function; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - /** The widget width in pixels. */ - width?: any; - } - /** A widget displaying the required content in an overlay window. */ - export class dxOverlay extends Widget { - constructor(element: JQuery, options?: dxOverlayOptions); - constructor(element: Element, options?: dxOverlayOptions); - /** An HTML element of the widget. */ - content(): JQuery; - /** Hides the widget. */ - hide(): JQueryPromise; - /** Recalculates the overlay's size and position. */ - repaint(): void; - /** Shows the widget. */ - show(): JQueryPromise; - /** Toggles the visibility of the widget. */ - toggle(showing: boolean): JQueryPromise; - /** A static method that specifies the base z-index for all overlay widgets. */ - static baseZIndex(zIndex: number): void; - } - export interface dxNumberBoxOptions extends dxTextEditorOptions { - /** The maximum value accepted by the number box. */ - max?: number; - /** The minimum value accepted by the number box. */ - min?: number; - /** Specifies whether or not to show spin buttons. */ - showSpinButtons?: boolean; - useTouchSpinButtons?: boolean; - /** Specifies by which value the widget value changes when a spin button is clicked. */ - step?: number; - /** The current number box value. */ - value?: number; - } - /** A textbox widget that enables a user to enter numeric values. */ - export class dxNumberBox extends dxTextEditor { - constructor(element: JQuery, options?: dxNumberBoxOptions); - constructor(element: Element, options?: dxNumberBoxOptions); - } - export interface dxNavBarOptions extends dxTabsOptions { - scrollingEnabled?: boolean; - } - /** A widget that contains items used to navigate through application views. */ - export class dxNavBar extends dxTabs { - constructor(element: JQuery, options?: dxNavBarOptions); - constructor(element: Element, options?: dxNavBarOptions); - } - export interface dxMultiViewOptions extends CollectionWidgetOptions { - /** Specifies whether or not to animate the displayed item change. */ - animationEnabled?: boolean; - /** A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped. */ - loop?: boolean; - /** The index of the currently displayed item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to allow users to change the selected index by swiping. */ - swipeEnabled?: boolean; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - } - /** A widget used to display a view and to switch between several views. */ - export class dxMultiView extends CollectionWidget { - constructor(element: JQuery, options?: dxMultiViewOptions); - constructor(element: Element, options?: dxMultiViewOptions); - } - export interface dxMapOptions extends WidgetOptions { - /** Specifies whether or not the widget automatically adjusts center and zoom option values when adding a new marker or route. */ - autoAdjust?: boolean; - /** An object, a string, or an array specifying the location displayed at the center of the widget. */ - center?: { - /** The latitude location displayed in the center of the widget. */ - lat?: number; - /** The longitude location displayed in the center of the widget. */ - lng?: number; - }; - /** A handler for the click event. */ - onClick?: any; - clickAction?: any; - /** Specifies whether or not map widget controls are available. */ - controls?: boolean; - /** Specifies the height of the widget. */ - height?: any; - /** A key used to authenticate the application within the required map provider. */ - key?: { - /** A key used to authenticate the application within the "Bing" map provider. */ - bing?: string; - /** A key used to authenticate the application within the "Google" map provider. */ - google?: string; - /** A key used to authenticate the application within the "Google Static" map provider. */ - googleStatic?: string; - } - /** A handler for the markerAdded event. */ - onMarkerAdded?: Function; - markerAddedAction?: Function; - /** A URL pointing to the custom icon to be used for map markers. */ - markerIconSrc?: string; - /** A handler for the markerRemoved event. */ - onMarkerRemoved?: Function; - markerRemovedAction?: Function; - /** An array of markers displayed on a map. */ - markers?: Array; - /** The name of the current map data provider. */ - provider?: string; - /** A handler for the ready event. */ - onReady?: Function; - readyAction?: Function; - /** A handler for the routeAdded event. */ - onRouteAdded?: Function; - routeAddedAction?: Function; - /** A handler for the routeRemoved event. */ - onRouteRemoved?: Function; - routeRemovedAction?: Function; - /** An array of routes shown on the map. */ - routes?: Array; - /** The type of a map to display. */ - type?: string; - /** Specifies the width of the widget. */ - width?: any; - /** The zoom level of the map. */ - zoom?: number; - } - /** An interactive map widget. */ - export class dxMap extends Widget { - constructor(element: JQuery, options?: dxMapOptions); - constructor(element: Element, options?: dxMapOptions); - /** Adds a marker to the map. */ - addMarker(markerOptions: Object): JQueryPromise; - /** Adds a route to the map. */ - addRoute(routeOptions: Object): JQueryPromise; - /** Removes a marker from the map. */ - removeMarker(marker: Object): JQueryPromise; - /** Removes a route from the map. */ - removeRoute(route: any): JQueryPromise; - } - export interface dxLookupOptions extends dxDropDownListOptions { - /** An object defining widget animation options. */ - animation?: fx.AnimationOptions; - /** The text displayed on the Cancel button. */ - cancelButtonText?: string; - /** The text displayed on the Clear button. */ - clearButtonText?: string; - /** Specifies whether or not the widget cleans the search box when the popup window is displayed. */ - cleanSearchOnOpening?: boolean; - /** A Boolean value specifying whether or not the widget is closed if a user clicks outside of the overlaying window. */ - closeOnOutsideClick?: any; - /** The text displayed on the Apply button. */ - applyButtonText?: string; - /** A Boolean value specifying whether or not to display the lookup in full-screen mode. */ - fullScreen?: boolean; - focusStateEnabled?: boolean; - /** A Boolean value specifying whether or not to group widget items. */ - grouped?: boolean; - groupRender?: any; - /** The name of the template used to display a group header. */ - groupTemplate?: any; - /** The text displayed on the button used to load the next page from the data source. */ - nextButtonText?: string; - /** A handler for the pageLoading event. */ - onPageLoading?: Function; - /** Specifies whether the next page is loaded when a user scrolls the widget to the bottom or when the "next" button is clicked. */ - pageLoadMode?: string; - pageLoadingAction?: Function; - /** Specifies the text shown in the pullDown panel, which is displayed when the widget is scrolled to the bottom. */ - pageLoadingText?: string; - /** The text displayed by the widget when nothing is selected. */ - placeholder?: string; - /** The height of the widget popup element. */ - popupHeight?: any; - /** The width of the widget popup element. */ - popupWidth?: any; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** Specifies the text displayed in the pullDown panel when the widget is pulled below the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the pullRefresh event. */ - onPullRefresh?: Function; - pullRefreshAction?: Function; - /** A Boolean value specifying whether or not the widget supports the "pull down to refresh" gesture. */ - pullRefreshEnabled?: boolean; - /** Specifies the text displayed in the pullDown panel while the widget is being refreshed. */ - refreshingText?: string; - /** A handler for the scroll event. */ - onScroll?: Function; - scrollAction?: Function; - /** A Boolean value specifying whether or not the search bar is visible. */ - searchEnabled?: boolean; - /** The text that is provided as a hint in the lookup's search bar. */ - searchPlaceholder?: string; - /** A Boolean value specifying whether or not the main screen is inactive while the lookup is active. */ - shading?: boolean; - /** Specifies whether to display the Cancel button in the lookup window. */ - showCancelButton?: boolean; - /** - * A Boolean value specifying whether the widget loads the next page automatically when you reach the bottom of the list or when a button is clicked. - * @deprecated pageLoadMode.md - */ - showNextButton?: boolean; - /** The title of the lookup window. */ - title?: string; - /** A template to be used for rendering the widget title. */ - titleTemplate?: any; - /** Specifies whether or not the widget uses native scrolling. */ - useNativeScrolling?: boolean; - /** Specifies whether or not to show lookup contents in a dxPopover widget. */ - usePopover?: boolean; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - contentReadyAction?: Function; - titleRender?: any; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - /** A Boolean value specifying whether or not to display the title in the popup window. */ - showPopupTitle?: boolean; - } - /** A widget that allows a user to select predefined values from a lookup window. */ - export class dxLookup extends dxDropDownList { - constructor(element: JQuery, options?: dxLookupOptions); - constructor(element: Element, options?: dxLookupOptions); - /** This section lists the data source fields that are used in a default template for lookup drop-down items. */ - } - export interface dxLoadPanelOptions extends dxOverlayOptions { - /** An object defining the animation options of the widget. */ - animation?: fx.AnimationOptions; - /** The delay in milliseconds after which the load panel is displayed. */ - delay?: number; - /** The height of the widget. */ - height?: number; - /** A URL pointing to an image to be used as a load indicator. */ - indicatorSrc?: string; - /** The text displayed in the load panel. */ - message?: string; - /** A Boolean value specifying whether or not to show a load indicator. */ - showIndicator?: boolean; - /** A Boolean value specifying whether or not to show the pane behind the load indicator. */ - showPane?: boolean; - /** The width of the widget. */ - width?: number; - } - /** A widget used to indicate whether or not an element is loading. */ - export class dxLoadPanel extends dxOverlay { - constructor(element: JQuery, options?: dxLoadPanelOptions); - constructor(element: Element, options?: dxLoadPanelOptions); - } - export interface dxLoadIndicatorOptions extends WidgetOptions { - /** Specifies the path to an image used as the indicator. */ - indicatorSrc?: string; - } - /** The widget used to indicate the loading process. */ - export class dxLoadIndicator extends Widget { - constructor(element: JQuery, options?: dxLoadIndicatorOptions); - constructor(element: Element, options?: dxLoadIndicatorOptions); - } - export interface dxListOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not to display a grouped list. */ - grouped?: boolean; - groupRender?: any; - /** The template to be used for rendering item groups. */ - groupTemplate?: any; - onItemDeleting?: Function; - /** A handler for the itemDeleted event. */ - onItemDeleted?: Function; - /** A handler for the groupRendered event. */ - onGroupRendered?: Function; - itemDeleteAction?: Function; - /** A handler for the itemReordered event. */ - onItemReordered?: Function; - itemReorderAction?: Function; - /** A handler for the itemClick event. */ - onItemClick?: any; - /** A handler for the itemSwipe event. */ - onItemSwipe?: Function; - itemSwipeAction?: Function; - /** The text displayed on the button used to load the next page from the data source. */ - nextButtonText?: string; - /** A handler for the pageLoading event. */ - onPageLoading?: Function; - pageLoadingAction?: Function; - /** Specifies the text shown in the pullDown panel, which is displayed when the list is scrolled to the bottom. */ - pageLoadingText?: string; - /** Specifies the text displayed in the pullDown panel when the list is pulled below the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the pullRefresh event. */ - onPullRefresh?: Function; - pullRefreshAction?: Function; - /** A Boolean value specifying whether or not the widget supports the "pull down to refresh" gesture. */ - pullRefreshEnabled?: boolean; - /** Specifies the text displayed in the pullDown panel while the list is being refreshed. */ - refreshingText?: string; - /** A handler for the scroll event. */ - onScroll?: Function; - scrollAction?: Function; - /** A Boolean value specifying whether to enable or disable list scrolling. */ - scrollingEnabled?: boolean; - /** Specifies when the widget shows the scrollbar. */ - showScrollbar?: string; - /** Specifies whether or not the widget uses native scrolling. */ - useNativeScrolling?: boolean; - /** A Boolean value specifying whether to enable or disable the bounce-back effect. */ - bounceEnabled?: boolean; - /** A Boolean value specifying if the list is scrolled by content. */ - scrollByContent?: boolean; - /** A Boolean value specifying if the list is scrolled using the scrollbar. */ - scrollByThumb?: boolean; - itemUnselectAction?: Function; - onItemContextMenu?: Function; - onItemHold?: Function; - /** Specifies whether or not an end-user can collapse groups. */ - collapsibleGroups?: boolean; - /** Specifies whether the next page is loaded when a user scrolls the widget to the bottom or when the "next" button is clicked. */ - pageLoadMode?: string; - /** Specifies whether or not to display controls used to select list items. */ - showSelectionControls?: boolean; - /** Specifies item selection mode. */ - selectionMode?: string; - selectAllText?: string; - /** Specifies the array of items for a context menu called for a list item. */ - menuItems?: Array; - /** Specifies whether an item context menu is shown when a user holds or swipes an item. */ - menuMode?: string; - /** Specifies whether or not an end user can delete list items. */ - allowItemDeleting?: boolean; - /** Specifies the way a user can delete items from the list. */ - itemDeleteMode?: string; - /** Specifies whether or not an end user can reorder list items. */ - allowItemReordering?: boolean; - /** Specifies whether or not to show the loading panel when the DataSource bound to the widget is loading data. */ - indicateLoading?: boolean; - activeStateEnabled?: boolean; - } - /** A list widget. */ - export class dxList extends CollectionWidget { - constructor(element: JQuery, options?: dxListOptions); - constructor(element: Element, options?: dxListOptions); - /** Returns the height of the widget in pixels. */ - clientHeight(): number; - /** Removes the specified item from the list. */ - deleteItem(itemIndex: any): JQueryPromise; - /** Removes the specified item from the list. */ - deleteItem(itemElement: Element): JQueryPromise; - /** Returns a Boolean value that indicates whether or not the specified item is selected. */ - isItemSelected(itemIndex: any): boolean; - /** Returns a Boolean value that indicates whether or not the specified item is selected. */ - isItemSelected(itemElement: Element): boolean; - /** Reloads list data. */ - reload(): void; - /** Moves the specified item to the specified position in the list. */ - reorderItem(itemElement: Element, toItemElement: Element): JQueryPromise; - /** Moves the specified item to the specified position in the list. */ - reorderItem(itemIndex: any, toItemIndex: any): JQueryPromise; - /** Scrolls the list content by the specified number of pixels. */ - scrollBy(distance: number): void; - /** Returns the height of the list content in pixels. */ - scrollHeight(): number; - /** Scrolls list content to the specified position. */ - scrollTo(location: number): void; - /** Scrolls the list to the specified item. */ - scrollToItem(itemElement: Element): void; - /** Scrolls the list to the specified item. */ - scrollToItem(itemIndex: any): void; - /** Returns how far the list content is scrolled from the top. */ - scrollTop(): number; - /** Selects the specified item from the list. */ - selectItem(itemElement: Element): void; - /** Selects the specified item from the list. */ - selectItem(itemIndex: any): void; - /** Deselects the specified item from the list. */ - unselectItem(itemElement: Element): void; - /** Unselects the specified item from the list. */ - unselectItem(itemIndex: any): void; - /** Updates the widget scrollbar according to widget content size. */ - updateDimensions(): JQueryPromise; - /** Expands the specified group. */ - expandGroup(groupIndex: number): JQueryPromise; - /** Collapses the specified group. */ - collapseGroup(groupIndex: number): JQueryPromise; - } - export interface dxGalleryOptions extends CollectionWidgetOptions { - /** The time, in milliseconds, spent on slide animation. */ - animationDuration?: number; - /** Specifies whether or not to animate the displayed item change. */ - animationEnabled?: boolean; - /** A Boolean value specifying whether or not to allow users to switch between items by clicking an indicator. */ - indicatorEnabled?: boolean; - /** A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped. */ - loop?: boolean; - /** The index of the currently active gallery item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to display an indicator that points to the selected gallery item. */ - showIndicator?: boolean; - /** A Boolean value that specifies the availability of the "Forward" and "Back" navigation buttons. */ - showNavButtons?: boolean; - /** The time interval in milliseconds, after which the gallery switches to the next item. */ - slideshowDelay?: number; - /** A Boolean value specifying whether or not to allow users to switch between items by swiping. */ - swipeEnabled?: boolean; - /** Specifies whether or not to display parts of previous and next images along the sides of the current image. */ - wrapAround?: boolean; - /** Specifies if the widget stretches images to fit the total gallery width. */ - stretchImages?: boolean; - /** Specifies the width of an area used to display a single image. */ - initialItemWidth?: number; - } - /** An image gallery widget. */ - export class dxGallery extends CollectionWidget { - constructor(element: JQuery, options?: dxGalleryOptions); - constructor(element: Element, options?: dxGalleryOptions); - /** Shows the specified gallery item. */ - goToItem(itemIndex: number, animation: boolean): JQueryPromise; - /** Shows the next gallery item. */ - nextItem(animation: boolean): JQueryPromise; - /** Shows the previous gallery item. */ - prevItem(animation: boolean): JQueryPromise; - } - export interface dxDropDownEditorOptions extends dxTextBoxOptions { - /** Specifies the current value displayed by the widget. */ - value?: Object; - /** A handler for the closed event. */ - onClosed?: Function; - /** A handler for the opened event. */ - onOpened?: Function; - /** Specifies whether or not the drop-down editor is displayed. */ - opened?: boolean; - closeAction?: Function; - openAction?: Function; - shownAction?: Function; - hiddenAction?: Function; - /** Specifies whether or not the widget allows an end-user to enter a custom value. */ - fieldEditEnabled?: boolean; - editEnabled?: boolean; - /** Specifies the way an end-user applies the selected value. */ - applyValueMode?: string; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - } - /** A drop-down editor widget. */ - export class dxDropDownEditor extends dxTextBox { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - /** Closes the drop-down editor. */ - close(): void; - /** Opens the drop-down editor. */ - open(): void; - /** Resets the widget's value to null. */ - reset(): void; - /** Returns an <input> element of the widget. */ - field(): JQuery; - /** Returns an HTML element of the popup window content. */ - content(): JQuery; - } - export interface dxDateBoxOptions extends dxTextEditorOptions { - /** A format used to display date/time information. */ - format?: string; - /** A Globalize format string specifying the date display format. */ - formatString?: string; - /** The last date that can be selected within the widget. */ - max?: any; - /** The minimum date that can be selected within the widget. */ - min?: any; - /** The text displayed by the widget when the widget value is not yet specified. This text is also used as a title of the date picker. */ - placeholder?: string; - /** - * Specifies whether or not a user can pick out a date using the drop-down calendar. - * @deprecated Use 'pickerType' option instead. - */ - useCalendar?: boolean; - /** An object or a value, specifying the date and time currently selected using the date box. */ - value?: any; - /** - * Specifies whether or not the widget uses the native HTML input element. - * @deprecated Use 'pickerType' option instead. - */ - useNative?: boolean; - /** Specifies the interval between neighboring values in the popup list in minutes. */ - interval?: number; - /** Specifies the maximum zoom level of a calendar, which is used to pick the date. */ - maxZoomLevel?: string; - /** Specifies the minimal zoom level of a calendar, which is used to pick the date. */ - minZoomLevel?: string; - /** Specifies the type of date/time picker. */ - pickerType?: string; - } - /** A date box widget. */ - export class dxDateBox extends dxDropDownEditor { - constructor(element: JQuery, options?: dxDateBoxOptions); - constructor(element: Element, options?: dxDateBoxOptions); - } - export interface dxCheckBoxOptions extends EditorOptions { - /** Specifies the widget state. */ - value?: boolean; - /** Specifies the text displayed by the check box. */ - text?: string; - } - /** A check box widget. */ - export class dxCheckBox extends Editor { - constructor(element: JQuery, options?: dxCheckBoxOptions); - constructor(element: Element, options?: dxCheckBoxOptions); - } - export interface dxCalendarOptions extends EditorOptions { - /** Specifies a date displayed on the current calendar page. */ - currentDate?: Date; - /** Specifies the first day of a week. */ - firstDayOfWeek?: number; - /** The latest date the widget allows to select. */ - max?: Date; - /** The earliest date the widget allows to select. */ - min?: Date; - /** Specifies whether or not the widget displays a button that selects the current date. */ - showTodayButton?: boolean; - /** Specifies the current calendar zoom level. */ - zoomLevel?: string; - /** Specifies the maximum zoom level of the calendar. */ - maxZoomLevel?: string; - /** Specifies the minimum zoom level of the calendar. */ - minZoomLevel?: string; - /** The template to be used for rendering calendar cells. */ - cellTemplate?: any; - } - /** A calendar widget. */ - export class dxCalendar extends Editor { - constructor(element: JQuery, options?: dxCalendarOptions); - constructor(element: Element, options?: dxCalendarOptions); - } - export interface dxButtonOptions extends WidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A handler for the click event. */ - onClick?: any; - clickAction?: any; - /** Specifies the icon to be displayed on the button. */ - icon?: string; - iconSrc?: string; - /** A template to be used for rendering the dxButton widget. */ - template?: any; - /** The text displayed on the button. */ - text?: string; - /** Specifies the button type. */ - type?: string; - /** Specifies the name of the validation group to be accessed in the click event handler. */ - validationGroup?: string; - } - /** A button widget. */ - export class dxButton extends Widget { - constructor(element: JQuery, options?: dxButtonOptions); - constructor(element: Element, options?: dxButtonOptions); - } - export interface dxBoxOptions extends CollectionWidget { - /** Specifies how widget items are aligned along the main direction. */ - align?: string; - /** Specifies the direction of item positioning in the widget. */ - direction?: string; - /** Specifies how widget items are aligned cross-wise. */ - crossAlign?: string; - } - /** A container widget used to arrange inner elements. */ - export class dxBox extends CollectionWidget { - constructor(element: JQuery, options?: dxBoxOptions); - constructor(element: Element, options?: dxBoxOptions); - } - export interface dxResponsiveBoxOptions extends CollectionWidgetOptions { - /** Specifies the collection of rows for the grid used to position layout elements. */ - rows?: Array; - /** Specifies the collection of columns for the grid used to position layout elements. */ - cols?: Array; - /** Specifies the function returning the screen factor depending on the screen width. */ - screenByWidth?: (width: number) => string; - /** Specifies the screen factor with which all elements are located in a single column. */ - singleColumnScreen?: string; - } - /** A widget used to build an adaptive markup that is dependent on screen resolution. */ - export class dxResponsiveBox extends CollectionWidget { - constructor(element: JQuery, options?: dxBoxOptions); - constructor(element: Element, options?: dxBoxOptions); - } - export interface dxAutocompleteOptions extends dxDropDownListOptions { - /** Specifies the current value displayed by the widget. */ - value?: string; - /** The minimum number of characters that must be entered into the text box to begin a search. */ - minSearchLength?: number; - /** Specifies the maximum count of items displayed by the widget. */ - maxItemCount?: number; - /** Gets the currently selected item. */ - selectedItem?: Object; - } - /** A textbox widget that supports autocompletion. */ - export class dxAutocomplete extends dxDropDownList { - constructor(element: JQuery, options?: dxAutocompleteOptions); - constructor(element: Element, options?: dxAutocompleteOptions); - /** Opens the drop-down editor. */ - open(): void; - /** Closes the drop-down editor. */ - close(): void; - } - export interface dxAccordionOptions extends CollectionWidgetOptions { - /** A number specifying the time in milliseconds spent on the animation of the expanding or collapsing of a panel. */ - animationDuration?: number; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies whether all items can be collapsed or whether at least one item must always be expanded. */ - collapsible?: boolean; - /** Specifies whether the widget can expand several items or only a single item at once. */ - multiple?: boolean; - /** The template to be used for rendering dxAccordion items. */ - itemTemplate?: any; - /** A handler for the itemTitleClick event. */ - onItemTitleClick?: any; - /** A handler for the itemTitleHold event. */ - onItemTitleHold?: Function; - /** The template to be used for rendering an item title. */ - itemTitleTemplate?: any; - /** The index number of the currently selected item. */ - selectedIndex?: number; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - } - /** A widget that displays data source items on collapsible panels. */ - export class dxAccordion extends CollectionWidget { - constructor(element: JQuery, options?: dxAccordionOptions); - constructor(element: Element, options?: dxAccordionOptions); - /** Collapses the specified item. */ - collapseItem(index: number): JQueryPromise; - /** Expands the specified item. */ - expandItem(index: number): JQueryPromise; - /** Updates the dimensions of the widget contents. */ - updateDimensions(): JQueryPromise; - } - export interface dxFileUploaderOptions extends EditorOptions { - /** A read-only option that holds a File instance representing the selected file. */ - value?: File; - /** Holds the File instances representing files selected in the widget. */ - values?: Array; - buttonText?: string; - /** The text displayed on the button that opens the file browser. */ - selectButtonText?: string; - /** The text displayed on the button that starts uploading. */ - uploadButtonText?: string; - /** Specifies the text displayed on the area to which an end-user can drop a file. */ - labelText?: string; - /** Specifies the value passed to the name attribute of the underlying input element. */ - name?: string; - /** Specifies whether the widget enables an end-user to select a single file or multiple files. */ - multiple?: boolean; - /** Specifies a file type or several types accepted by the widget. */ - accept?: string; - /** Specifies a target Url for the upload request. */ - uploadUrl?: string; - /** Specifies if an end user can remove a file from the selection and interrupt uploading. */ - allowCanceling?: boolean; - /** Specifies whether or not the widget displays the list of selected files. */ - showFileList?: boolean; - /** Gets the current progress in percentages. */ - progress?: number; - /** The message displayed by the widget when it is ready to upload the specified files. */ - readyToUploadMessage?: string; - /** The message displayed by the widget when uploading is finished. */ - uploadedMessage?: string; - /** The message displayed by the widget on uploading failure. */ - uploadFailedMessage?: string; - /** Specifies how the widget uploads files. */ - uploadMode?: string; - /** A handler for the uploaded event. */ - onUploaded?: Function; - /** A handler for the uploaded event. */ - onProgress?: Function; - /** A handler for the uploadError event. */ - onUploadError?: Function; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - } - /** A widget used to select and upload a file or multiple files. */ - export class dxFileUploader extends Editor { - constructor(element: JQuery, options?: dxFileUploaderOptions); - constructor(element: Element, options?: dxFileUploaderOptions); - } - export interface dxTrackBarOptions extends EditorOptions { - /** The minimum value the widget can accept. */ - min?: number; - /** The maximum value the widget can accept. */ - max?: number; - /** The current widget value. */ - value?: number; - } - /** A base class for track bar widgets. */ - export class dxTrackBar extends Editor { - constructor(element: JQuery, options?: dxTrackBarOptions); - constructor(element: Element, options?: dxTrackBarOptions); - } - export interface dxProgressBarOptions extends dxTrackBarOptions { - /** Specifies a format for the progress status. */ - statusFormat?: any; - /** Specifies whether or not the widget displays a progress status. */ - showStatus?: boolean; - /** A handler for the complete event. */ - onComplete?: Function; - } - /** A widget used to indicate progress. */ - export class dxProgressBar extends dxTrackBar { - constructor(element: JQuery, options?: dxProgressBarOptions); - constructor(element: Element, options?: dxProgressBarOptions); - } - export interface dxSliderOptions extends dxTrackBarOptions { - /** The slider step size. */ - step?: number; - /** The current slider value. */ - value?: number; - /** Specifies whether or not to highlight a range selected within the widget. */ - showRange?: boolean; - /** Specifies the size of a step by which a slider handle is moved when a user uses the Page up or Page down keyboard shortcuts. */ - keyStep?: number; - /** Specifies options for the slider tooltip. */ - tooltip?: { - /** Specifies whether or not the tooltip is enabled. */ - enabled?: boolean; - /** Specifies format for the tooltip. */ - format?: any; - /** Specifies whether the tooltip is located over or under the slider. */ - position?: string; - /** Specifies whether the widget always shows a tooltip or only when a pointer is over the slider. */ - showMode?: string; - }; - /** Specifies options for labels displayed at the min and max values. */ - label?: { - /** Specifies whether or not slider labels are visible. */ - visible?: boolean; - /** Specifies whether labels are located over or under the scale. */ - position?: string; - /** Specifies a format for labels. */ - format?: any; - }; - } - /** A widget that allows a user to select a numeric value within a given range. */ - export class dxSlider extends dxTrackBar { - constructor(element: JQuery, options?: dxSliderOptions); - constructor(element: Element, options?: dxSliderOptions); - } - export interface dxRangeSliderOptions extends dxSliderOptions { - /** The left edge of the interval currently selected using the range slider. */ - start?: number; - /** The right edge of the interval currently selected using the range slider. */ - end?: number; - } - /** A widget that enables a user to select a range of numeric values. */ - export class dxRangeSlider extends dxSlider { - constructor(element: JQuery, options?: dxRangeSliderOptions); - constructor(element: Element, options?: dxRangeSliderOptions); - } -} -interface JQuery { - dxProgressBar(): JQuery; - dxProgressBar(options: "instance"): DevExpress.ui.dxProgressBar; - dxProgressBar(options: string): any; - dxProgressBar(options: string, ...params: any[]): any; - dxProgressBar(options: DevExpress.ui.dxProgressBarOptions): JQuery; - dxSlider(): JQuery; - dxSlider(options: "instance"): DevExpress.ui.dxSlider; - dxSlider(options: string): any; - dxSlider(options: string, ...params: any[]): any; - dxSlider(options: DevExpress.ui.dxSliderOptions): JQuery; - dxRangeSlider(): JQuery; - dxRangeSlider(options: "instance"): DevExpress.ui.dxRangeSlider; - dxRangeSlider(options: string): any; - dxRangeSlider(options: string, ...params: any[]): any; - dxRangeSlider(options: DevExpress.ui.dxRangeSliderOptions): JQuery; - dxFileUploader(): JQuery; - dxFileUploader(options: "instance"): DevExpress.ui.dxFileUploader; - dxFileUploader(options: string): any; - dxFileUploader(options: string, ...params: any[]): any; - dxFileUploader(options: DevExpress.ui.dxFileUploaderOptions): JQuery; - dxValidator(): JQuery; - dxValidator(options: "instance"): DevExpress.ui.dxValidator; - dxValidator(options: string): any; - dxValidator(options: string, ...params: any[]): any; - dxValidator(options: DevExpress.ui.dxValidatorOptions): JQuery; - dxValidationGroup(): JQuery; - dxValidationGroup(options: "instance"): DevExpress.ui.dxValidationGroup; - dxValidationGroup(options: string): any; - dxValidationGroup(options: string, ...params: any[]): any; - dxValidationSummary(): JQuery; - dxValidationSummary(options: "instance"): DevExpress.ui.dxValidationSummary; - dxValidationSummary(options: string): any; - dxValidationSummary(options: string, ...params: any[]): any; - dxValidationSummary(options: DevExpress.ui.dxValidationSummaryOptions): JQuery; - dxTooltip(): JQuery; - dxTooltip(options: "instance"): DevExpress.ui.dxTooltip; - dxTooltip(options: string): any; - dxTooltip(options: string, ...params: any[]): any; - dxTooltip(options: DevExpress.ui.dxTooltipOptions): JQuery; - dxResizable(): JQuery; - dxResizable(options: "instance"): DevExpress.ui.dxResizable; - dxResizable(options: string): any; - dxResizable(options: string, ...params: any[]): any; - dxResizable(options: DevExpress.ui.dxResizableOptions): JQuery; - dxDropDownList(): JQuery; - dxDropDownList(options: "instance"): DevExpress.ui.dxDropDownList; - dxDropDownList(options: string): any; - dxDropDownList(options: string, ...params: any[]): any; - dxDropDownList(options: DevExpress.ui.dxDropDownListOptions): JQuery; - dxToolbar(): JQuery; - dxToolbar(options: "instance"): DevExpress.ui.dxToolbar; - dxToolbar(options: string): any; - dxToolbar(options: string, ...params: any[]): any; - dxToolbar(options: DevExpress.ui.dxToolbarOptions): JQuery; - dxToast(): JQuery; - dxToast(options: "instance"): DevExpress.ui.dxToast; - dxToast(options: string): any; - dxToast(options: string, ...params: any[]): any; - dxToast(options: DevExpress.ui.dxToastOptions): JQuery; - dxTextEditor(): JQuery; - dxTextEditor(options: "instance"): DevExpress.ui.dxTextEditor; - dxTextEditor(options: string): any; - dxTextEditor(options: string, ...params: any[]): any; - dxTextEditor(options: DevExpress.ui.dxTextEditorOptions): JQuery; - dxTextBox(): JQuery; - dxTextBox(options: "instance"): DevExpress.ui.dxTextBox; - dxTextBox(options: string): any; - dxTextBox(options: string, ...params: any[]): any; - dxTextBox(options: DevExpress.ui.dxTextBoxOptions): JQuery; - dxTextArea(): JQuery; - dxTextArea(options: "instance"): DevExpress.ui.dxTextArea; - dxTextArea(options: string): any; - dxTextArea(options: string, ...params: any[]): any; - dxTextArea(options: DevExpress.ui.dxTextAreaOptions): JQuery; - dxTabs(): JQuery; - dxTabs(options: "instance"): DevExpress.ui.dxTabs; - dxTabs(options: string): any; - dxTabs(options: string, ...params: any[]): any; - dxTabs(options: DevExpress.ui.dxTabsOptions): JQuery; - dxTabPanel(): JQuery; - dxTabPanel(options: "instance"): DevExpress.ui.dxTabPanel; - dxTabPanel(options: string): any; - dxTabPanel(options: string, ...params: any[]): any; - dxTabPanel(options: DevExpress.ui.dxTabPanelOptions): JQuery; - dxSelectBox(): JQuery; - dxSelectBox(options: "instance"): DevExpress.ui.dxSelectBox; - dxSelectBox(options: string): any; - dxSelectBox(options: string, ...params: any[]): any; - dxSelectBox(options: DevExpress.ui.dxSelectBoxOptions): JQuery; - dxTagBox(): JQuery; - dxTagBox(options: "instance"): DevExpress.ui.dxTagBox; - dxTagBox(options: string): any; - dxTagBox(options: string, ...params: any[]): any; - dxTagBox(options: DevExpress.ui.dxTagBoxOptions): JQuery; - dxScrollView(): JQuery; - dxScrollView(options: "instance"): DevExpress.ui.dxScrollView; - dxScrollView(options: string): any; - dxScrollView(options: string, ...params: any[]): any; - dxScrollView(options: DevExpress.ui.dxScrollViewOptions): JQuery; - dxScrollable(): JQuery; - dxScrollable(options: "instance"): DevExpress.ui.dxScrollable; - dxScrollable(options: string): any; - dxScrollable(options: string, ...params: any[]): any; - dxScrollable(options: DevExpress.ui.dxScrollableOptions): JQuery; - dxRadioGroup(): JQuery; - dxRadioGroup(options: "instance"): DevExpress.ui.dxRadioGroup; - dxRadioGroup(options: string): any; - dxRadioGroup(options: string, ...params: any[]): any; - dxRadioGroup(options: DevExpress.ui.dxRadioGroupOptions): JQuery; - dxPopup(): JQuery; - dxPopup(options: "instance"): DevExpress.ui.dxPopup; - dxPopup(options: string): any; - dxPopup(options: string, ...params: any[]): any; - dxPopup(options: DevExpress.ui.dxPopupOptions): JQuery; - dxPopover(): JQuery; - dxPopover(options: "instance"): DevExpress.ui.dxPopover; - dxPopover(options: string): any; - dxPopover(options: string, ...params: any[]): any; - dxPopover(options: DevExpress.ui.dxPopoverOptions): JQuery; - dxOverlay(): JQuery; - dxOverlay(options: "instance"): DevExpress.ui.dxOverlay; - dxOverlay(options: string): any; - dxOverlay(options: string, ...params: any[]): any; - dxOverlay(options: DevExpress.ui.dxOverlayOptions): JQuery; - dxNumberBox(): JQuery; - dxNumberBox(options: "instance"): DevExpress.ui.dxNumberBox; - dxNumberBox(options: string): any; - dxNumberBox(options: string, ...params: any[]): any; - dxNumberBox(options: DevExpress.ui.dxNumberBoxOptions): JQuery; - dxNavBar(): JQuery; - dxNavBar(options: "instance"): DevExpress.ui.dxNavBar; - dxNavBar(options: string): any; - dxNavBar(options: string, ...params: any[]): any; - dxNavBar(options: DevExpress.ui.dxNavBarOptions): JQuery; - dxMultiView(): JQuery; - dxMultiView(options: "instance"): DevExpress.ui.dxMultiView; - dxMultiView(options: string): any; - dxMultiView(options: string, ...params: any[]): any; - dxMultiView(options: DevExpress.ui.dxMultiViewOptions): JQuery; - dxMap(): JQuery; - dxMap(options: "instance"): DevExpress.ui.dxMap; - dxMap(options: string): any; - dxMap(options: string, ...params: any[]): any; - dxMap(options: DevExpress.ui.dxMapOptions): JQuery; - dxLookup(): JQuery; - dxLookup(options: "instance"): DevExpress.ui.dxLookup; - dxLookup(options: string): any; - dxLookup(options: string, ...params: any[]): any; - dxLookup(options: DevExpress.ui.dxLookupOptions): JQuery; - dxLoadPanel(): JQuery; - dxLoadPanel(options: "instance"): DevExpress.ui.dxLoadPanel; - dxLoadPanel(options: string): any; - dxLoadPanel(options: string, ...params: any[]): any; - dxLoadPanel(options: DevExpress.ui.dxLoadPanelOptions): JQuery; - dxLoadIndicator(): JQuery; - dxLoadIndicator(options: "instance"): DevExpress.ui.dxLoadIndicator; - dxLoadIndicator(options: string): any; - dxLoadIndicator(options: string, ...params: any[]): any; - dxLoadIndicator(options: DevExpress.ui.dxLoadIndicatorOptions): JQuery; - dxList(): JQuery; - dxList(options: "instance"): DevExpress.ui.dxList; - dxList(options: string): any; - dxList(options: string, ...params: any[]): any; - dxList(options: DevExpress.ui.dxListOptions): JQuery; - dxGallery(): JQuery; - dxGallery(options: "instance"): DevExpress.ui.dxGallery; - dxGallery(options: string): any; - dxGallery(options: string, ...params: any[]): any; - dxGallery(options: DevExpress.ui.dxGalleryOptions): JQuery; - dxDropDownEditor(): JQuery; - dxDropDownEditor(options: "instance"): DevExpress.ui.dxDropDownEditor; - dxDropDownEditor(options: string): any; - dxDropDownEditor(options: string, ...params: any[]): any; - dxDropDownEditor(options: DevExpress.ui.dxDropDownEditorOptions): JQuery; - dxDateBox(): JQuery; - dxDateBox(options: "instance"): DevExpress.ui.dxDateBox; - dxDateBox(options: string): any; - dxDateBox(options: string, ...params: any[]): any; - dxDateBox(options: DevExpress.ui.dxDateBoxOptions): JQuery; - dxCheckBox(): JQuery; - dxCheckBox(options: "instance"): DevExpress.ui.dxCheckBox; - dxCheckBox(options: string): any; - dxCheckBox(options: string, ...params: any[]): any; - dxCheckBox(options: DevExpress.ui.dxCheckBoxOptions): JQuery; - dxBox(): JQuery; - dxBox(options: "instance"): DevExpress.ui.dxBox; - dxBox(options: string): any; - dxBox(options: string, ...params: any[]): any; - dxBox(options: DevExpress.ui.dxBoxOptions): JQuery; - dxButton(): JQuery; - dxButton(options: "instance"): DevExpress.ui.dxButton; - dxButton(options: string): any; - dxButton(options: string, ...params: any[]): any; - dxButton(options: DevExpress.ui.dxButtonOptions): JQuery; - dxCalendar(): JQuery; - dxCalendar(options: "instance"): DevExpress.ui.dxCalendar; - dxCalendar(options: string): any; - dxCalendar(options: string, ...params: any[]): any; - dxCalendar(options: DevExpress.ui.dxCalendarOptions): JQuery; - dxAccordion(): JQuery; - dxAccordion(options: "instance"): DevExpress.ui.dxAccordion; - dxAccordion(options: string): any; - dxAccordion(options: string, ...params: any[]): any; - dxAccordion(options: DevExpress.ui.dxAccordionOptions): JQuery; - dxResponsiveBox(): JQuery; - dxResponsiveBox(options: "instance"): DevExpress.ui.dxResponsiveBox; - dxResponsiveBox(options: string): any; - dxResponsiveBox(options: string, ...params: any[]): any; - dxResponsiveBox(options: DevExpress.ui.dxResponsiveBoxOptions): JQuery; - dxAutocomplete(): JQuery; - dxAutocomplete(options: "instance"): DevExpress.ui.dxAutocomplete; - dxAutocomplete(options: string): any; - dxAutocomplete(options: string, ...params: any[]): any; - dxAutocomplete(options: DevExpress.ui.dxAutocompleteOptions): JQuery; -} - -declare namespace DevExpress.ui { - export interface dxTileViewOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** Specifies the height of the base tile view item. */ - baseItemHeight?: number; - /** Specifies the width of the base tile view item. */ - baseItemWidth?: number; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies the distance in pixels between adjacent tiles. */ - itemMargin?: number; - /** A Boolean value specifying whether or not to display a scrollbar. */ - showScrollbar?: boolean; - } - /** A widget displaying several blocks of data as tiles. */ - export class dxTileView extends CollectionWidget { - constructor(element: JQuery, options?: dxTileViewOptions); - constructor(element: Element, options?: dxTileViewOptions); - /** Returns the current scroll position of the widget content. */ - scrollPosition(): number; - } - export interface dxSwitchOptions extends EditorOptions { - /** Text displayed when the widget is in a disabled state. */ - offText?: string; - /** Text displayed when the widget is in an enabled state. */ - onText?: string; - /** A Boolean value specifying whether the current switch state is "On" or "Off". */ - value?: boolean; - } - /** A switch widget. */ - export class dxSwitch extends Editor { - constructor(element: JQuery, options?: dxSwitchOptions); - constructor(element: Element, options?: dxSwitchOptions); - } - export interface dxSlideOutViewOptions extends WidgetOptions { - /** Specifies whether or not the menu panel is visible. */ - menuVisible?: boolean; - /** Specifies whether or not the menu is shown when a user swipes the widget content. */ - swipeEnabled?: boolean; - /** A template to be used for rendering menu panel content. */ - menuTemplate?: any; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - } - /** The widget that allows you to slide-out the current view to reveal a custom menu. */ - export class dxSlideOutView extends Widget { - constructor(element: JQuery, options?: dxSlideOutViewOptions); - constructor(element: Element, options?: dxSlideOutViewOptions); - /** Returns an HTML element of the widget menu block. */ - menuContent(): JQuery; - /** Returns an HTML element of the widget content block. */ - content(): JQuery; - /** Displays the widget's menu block. */ - showMenu(): JQueryPromise; - /** Hides the widget's menu block. */ - hideMenu(): JQueryPromise; - /** Toggles the visibility of the widget's menu block. */ - toggleMenuVisibility(): JQueryPromise; - } - export interface dxSlideOutOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A Boolean value specifying whether or not to display a grouped menu. */ - menuGrouped?: boolean; - menuGroupRender?: any; - /** The name of the template used to display a group header. */ - menuGroupTemplate?: any; - menuItemRender?: any; - /** The template used to render menu items. */ - menuItemTemplate?: any; - /** A handler for the menuGroupRendered event. */ - onMenuGroupRendered?: Function; - /** A handler for the menuItemRendered event. */ - onMenuItemRendered?: Function; - /** Specifies whether or not the slide-out menu is displayed. */ - menuVisible?: boolean; - /** Indicates whether the menu can be shown/hidden by swiping the widget's main panel. */ - swipeEnabled?: boolean; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - } - /** The widget that allows you to slide-out the current view to reveal an item list. */ - export class dxSlideOut extends CollectionWidget { - constructor(element: JQuery, options?: dxSlideOutOptions); - constructor(element: Element, options?: dxSlideOutOptions); - /** Hides the widget's slide-out menu. */ - hideMenu(): JQueryPromise; - /** Displays the widget's slide-out menu. */ - showMenu(): JQueryPromise; - /** Toggles the visibility of the widget's slide-out menu. */ - toggleMenuVisibility(showing: boolean): JQueryPromise; - } - export interface dxPivotOptions extends CollectionWidgetOptions { - /** The index of the currently active pivot item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to allow users to switch between items by swiping. */ - swipeEnabled?: boolean; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - /** The template to be used for rendering an item title. */ - itemTitleTemplate?: any; - } - /** A widget that is similar to a traditional tab control, but optimized for the phone with simplified end-user interaction. */ - export class dxPivot extends CollectionWidget { - constructor(element: JQuery, options?: dxPivotOptions); - constructor(element: Element, options?: dxPivotOptions); - } - export interface dxPanoramaOptions extends CollectionWidgetOptions { - /** An object exposing options for setting a background image for the panorama. */ - backgroundImage?: { - /** Specifies the height of the panorama's background image. */ - height?: number; - /** Specifies the URL of the image that is used as the panorama's background image. */ - url?: string; - /** Specifies the width of the panorama's background image. */ - width?: number; - }; - /** The index of the currently active panorama item. */ - selectedIndex?: number; - /** Specifies the widget content title. */ - title?: string; - } - /** A widget displaying the required content in a long horizontal canvas that extends beyond the frames of the screen. */ - export class dxPanorama extends CollectionWidget { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - } - export interface dxDropDownMenuOptions extends WidgetOptions { - /** A handler for the buttonClick event. */ - onButtonClick?: any; - buttonClickAction?: any; - /** The name of the icon to be displayed by the DropDownMenu button. */ - buttonIcon?: string; - buttonIconSrc?: string; - /** The text displayed in the DropDownMenu button. */ - buttonText?: string; - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** A handler for the itemClick event. */ - onItemClick?: any; - itemClickAction?: any; - itemRender?: any; - /** An array of items displayed by the widget. */ - items?: Array; - /** The template to be used for rendering items. */ - itemTemplate?: any; - /** Specifies whether or not to show the drop down menu within a dxPopover widget. */ - usePopover?: boolean; - /** The width of the menu popup in pixels. */ - popupWidth?: any; - /** The height of the menu popup in pixels. */ - popupHeight?: any; - /** Specifies whether or not the drop-down menu is displayed. */ - opened?: boolean; - /** A Boolean value specifying whether or not the widget changes its state when being hovered by an end user. */ - hoverStateEnabled?: boolean; - } - /** A drop-down menu widget. */ - export class dxDropDownMenu extends Widget { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - /** This section lists the data source fields that are used in a default template for drop-down menu items. */ - /** Opens the drop-down menu. */ - open(): void; - /** Closes the drop-down menu. */ - close(): void; - } - export interface dxActionSheetOptions extends CollectionWidgetOptions { - cancelClickAction?: any; - /** A handler for the cancelClick event. */ - onCancelClick?: any; - /** The text displayed in the button that closes the action sheet. */ - cancelText?: string; - /** Specifies whether or not to display the Cancel button in action sheet. */ - showCancelButton?: boolean; - /** A Boolean value specifying whether or not the title of the action sheet is visible. */ - showTitle?: boolean; - /** Specifies the element the action sheet popover points at. */ - target?: any; - /** The title of the action sheet. */ - title?: string; - /** Specifies whether or not to show the action sheet within a dxPopover widget. */ - usePopover?: boolean; - /** A Boolean value specifying whether or not the dxActionSheet widget is visible. */ - visible?: boolean; - } - /** A widget consisting of a set of choices related to a certain task. */ - export class dxActionSheet extends CollectionWidget { - constructor(element: JQuery, options?: dxActionSheetOptions); - constructor(element: Element, options?: dxActionSheetOptions); - /** Hides the widget. */ - hide(): JQueryPromise; - /** Shows the widget. */ - show(): JQueryPromise; - /** Shows or hides the widget depending on the Boolean value passed as the parameter. */ - toggle(showing: boolean): JQueryPromise; - } -} -interface JQuery { - dxTileView(): JQuery; - dxTileView(options: "instance"): DevExpress.ui.dxTileView; - dxTileView(options: string): any; - dxTileView(options: string, ...params: any[]): any; - dxTileView(options: DevExpress.ui.dxTileViewOptions): JQuery; - dxSwitch(): JQuery; - dxSwitch(options: "instance"): DevExpress.ui.dxSwitch; - dxSwitch(options: string): any; - dxSwitch(options: string, ...params: any[]): any; - dxSwitch(options: DevExpress.ui.dxSwitchOptions): JQuery; - dxSlideOut(): JQuery; - dxSlideOut(options: "instance"): DevExpress.ui.dxSlideOut; - dxSlideOut(options: string): any; - dxSlideOut(options: string, ...params: any[]): any; - dxSlideOut(options: DevExpress.ui.dxSlideOutOptions): JQuery; - dxPivot(): JQuery; - dxPivot(options: "instance"): DevExpress.ui.dxPivot; - dxPivot(options: string): any; - dxPivot(options: string, ...params: any[]): any; - dxPivot(options: DevExpress.ui.dxPivotOptions): JQuery; - dxPanorama(): JQuery; - dxPanorama(options: "instance"): DevExpress.ui.dxPanorama; - dxPanorama(options: string): any; - dxPanorama(options: string, ...params: any[]): any; - dxPanorama(options: DevExpress.ui.dxPanoramaOptions): JQuery; - dxActionSheet(): JQuery; - dxActionSheet(options: "instance"): DevExpress.ui.dxActionSheet; - dxActionSheet(options: string): any; - dxActionSheet(options: string, ...params: any[]): any; - dxActionSheet(options: DevExpress.ui.dxActionSheetOptions): JQuery; - dxDropDownMenu(): JQuery; - dxDropDownMenu(options: "instance"): DevExpress.ui.dxDropDownMenu; - dxDropDownMenu(options: string): any; - dxDropDownMenu(options: string, ...params: any[]): any; - dxDropDownMenu(options: DevExpress.ui.dxDropDownMenuOptions): JQuery; -} -declare namespace DevExpress.data { - export interface XmlaStoreOptions { - /** The HTTP address to an XMLA OLAP server. */ - url?: string; - /** The name of the database associated with the Store. */ - catalog?: string; - /** The cube name. */ - cube?: string; - beforeSend?: (request: Object) => void; - } - /** A Store that provides access to an OLAP cube using the XMLA standard. */ - export class XmlaStore { - constructor(options: XmlaStoreOptions); - } - export interface PivotGridField { - index?: number; - /** A boolean value specifying whether or not the field is visible in the pivot grid and the Field Chooser. */ - visible?: boolean; - /** Name of the data source field containing data for the pivot grid field. */ - dataField?: string; - /** A caption that will be displayed in the pivot grid's field chooser to identify the field. */ - caption?: string; - /** Specifies a type of field values. */ - dataType?: string; - /** Specifies how the values of the current field are combined into groups. Cannot be used for the XmlaStore store type. */ - groupInterval?: any; - /** Specifies how to aggregate field data. Cannot be used for th XmlaStore store type. */ - summaryType?: string; - /** Allows you to use a custom aggregate function to calculate the summary values. Cannot be used for the XmlaStore store type. */ - calculateCustomSummary?: (options: { - summaryProcess?: string; - value?: any; - totalValue?: any; - }) => void; - /** Specifies the function that determines how to split data from the data source into ranges for header items. Cannot be used for the XmlaStore store type. */ - selector?: (data: Object) => any; - /** Type of the area where the field is located. */ - area?: string; - /** Index among the other fields displayed within the same area. */ - areaIndex?: number; - /** The name of the folder in which the field is located. */ - displayFolder?: string; - /** The name of the group to which the field belongs. */ - groupName?: string; - /** The index of the field within a group. */ - groupIndex?: number; - /** Specifies the initial sort order of field values. */ - sortOrder?: string; - /** Specifies how field data should be sorted. Can be used for the XmlaStore store type only. */ - sortBy?: string; - /** Specifies the data field against which the header items of this field should be sorted. */ - sortBySummaryField?: string; - /** The array of field names that specify a path to column/row whose summary field is used for sorting of this field's header items. */ - sortBySummaryPath?: Array; - /** The filter values for the current field. */ - filterValues?: Array; - /** The filter type for the current field. */ - filterType?: string; - /** Indicates whether all header items of the field's header level are expanded. */ - expanded?: boolean; - /** Specifies whether the field should be treated as a Data Field. */ - isMeasure?: boolean; - /** Specifies a display format for field values. */ - format?: string; - /** Specifies a callback function that returns the text to be displayed in the cells of a field. */ - customizeText?: (cellInfo: { value: any; valueText: string }) => string; - /** Specifies a precision for formatted field values. */ - precision?: number; - /** Specifies how to sort the header items. */ - sortingMethod?: (a: Object, b: Object) => number; - /** Allows an end-user to change sorting options. */ - allowSorting?: boolean; - /** Allows an end-user to sort columns by summary values. */ - allowSortingBySummary?: boolean; - /** Allows an end-user to change filtering options. */ - allowFiltering?: boolean; - /** Allows an end-user to expand/collapse all header items within a header level. */ - allowExpandAll?: boolean; - /** Specifies the absolute width of the field in the pivot grid. */ - width?: number; - } - export interface PivotGridDataSourceOptions { - /** Specifies the underlying Store instance used to access data. */ - store?: any; - /** Indicates whether or not the automatic field generation from data in the Store is enabled. */ - retrieveFields?: boolean; - /** Specifies data filtering conditions. */ - filter?: Object; - /** An array of pivot grid fields. */ - fields?: Array; - /** Indicates whether or not the local sorting of the XMLA data should be performed. */ - localSorting?: boolean; - /** A handler for the changed event. */ - onChanged?: () => void; - /** A handler for the loadingChanged event. */ - onLoadingChanged?: (isLoading: boolean) => void; - /** A handler for the loadError event. */ - onLoadError?: (e?: Object) => void; - /** A handler for the fieldsPrepared event. */ - onFieldsPrepared?: (e?: Array) => void; - } - /** An object that provides access to data for the dxPivotGrid widget. */ - export class PivotGridDataSource implements EventsMixin { - constructor(options?: PivotGridDataSource); - /** Starts loading data. */ - load(): JQueryPromise; - /** Indicates whether or not the PivotGridDataSource is currently being loaded. */ - isLoading(): boolean; - /** Gets data displayed in a PivotGrid. */ - getData(): Object; - /** Gets all fields within a specified area. */ - getAreaFields(area: string, collectGroups: boolean): Array; - /** Gets all fields from the data source. */ - fields(): Array; - /** Sets the fields option. */ - fields(fields: Array): void; - /** Gets current options of a specified field. */ - field(id: any): PivotGridField; - /** Sets one or more options of a specified field. */ - field(id: any, field: PivotGridField): void; - /** Collapses a specified header item. */ - collapseHeaderItem(area: string, path: Array): void; - /** Expands a specified header item. */ - expandHeaderItem(area: string, path: Array): void; - /** Expands all header items of a field. */ - expandAll(id: any): void; - /** Collapses all header items of a field. */ - collapseAll(id: any): void; - /** Disposes of all resources associated with this PivotGridDataSource. */ - dispose(): void; - on(eventName: string, eventHandler: Function): PivotGridDataSource; - on(events: { [eventName: string]: Function; }): PivotGridDataSource; - off(eventName: string): PivotGridDataSource; - off(eventName: string, eventHandler: Function): PivotGridDataSource; - } -} -declare namespace DevExpress.ui { - export interface dxSchedulerOptions extends WidgetOptions { - /** Specifies a date displayed on the current scheduler view by default. */ - currentDate?: Date; - /** The earliest date the widget allows you to select. */ - min?: Date; - /** The latest date the widget allows you to select. */ - max?: Date; - /** Specifies the view used in the scheduler by default. */ - currentView?: string; - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** Specifies the first day of a week. */ - firstDayOfWeek?: number; - /** The template to be used for rendering appointments. */ - appointmentTemplate?: any; - /** Lists the views to be available within the scheduler's View Selector. */ - views?: Array; - /** Specifies the resource kinds by which the scheduler's appointments are grouped in a timetable. */ - groups?: Array; - /** Specifies a start hour in the scheduler view's time interval. */ - startDayHour?: number; - /** Specifies an end hour in the scheduler view's time interval. */ - endDayHour?: number; - /** Specifies whether the scheduler data can be edited at runtime. */ - editing?: boolean; - /** Specifies an array of resources available in the scheduler. */ - resources?: Array<{ - /** Indicates whether or not several resources of this kind can be assigned to an appointment. */ - allowMultiple?: boolean; - /** Indicates whether or not resources of this kind have priority in the color identification of the appointments that have resources of different kinds assigned. */ - mainColor?: boolean; - /** A data source used to fetch resources to be available in the scheduler. */ - dataSource?: any; - /** Specifies the resource object field whose value is displayed by the Resource editor in the Appointment popup window. */ - displayExpr?: any; - /** Specifies the resource object field that is used as a value of the Resource editor in the Appointment popup window. */ - valueExpr?: any; - /** The name of the appointment object field that specifies a resource of this kind. */ - field?: string; - /** Specifies the label of the Appointment popup window field that allows end users to assign a resource of this kind. */ - label?: string; - }>; - /** A handler for the AppointmentAdding event. */ - onAppointmentAdding?: Function; - /** A handler for the appointmentAdded event. */ - onAppointmentAdded?: Function; - /** A handler for the AppointmentUpdating event. */ - onAppointmentUpdating?: Function; - /** A handler for the appointmentUpdated event. */ - onAppointmentUpdated?: Function; - /** A handler for the AppointmentDeleting event. */ - onAppointmentDeleting?: Function; - /** A handler for the appointmentDeleted event. */ - onAppointmentDeleted?: Function; - /** A handler for the appointmentRendered event. */ - onAppointmentRendered?: Function; - } - /** A widget that displays scheduled data using different views and provides the capability to load, add and edit appointments. */ - export class dxScheduler extends Widget { - constructor(element: JQuery, options?: dxSchedulerOptions); - constructor(element: Element, options?: dxSchedulerOptions); - /** Add the appointment defined by the object passed as a parameter to the data associated with the widget. */ - addAppointment(appointment: Object): void; - /** Updates the appointment specified by the first method parameter by the appointment object specified by the second method parameter in the the data associated with the widget. */ - updateAppointment(target: Object, appointment: Object): void; - /** Deletes the appointment defined by the parameter from the the data associated with the widget. */ - deleteAppointment(appointment: Object): void; - /** Scrolls the scheduler work space to the specified time. */ - scrollToTime(hours: number, minutes: number): void; - } - export interface dxColorBoxOptions extends dxDropDownEditorOptions { - /** Specifies the text displayed on the button that applies changes and closes the drop-down editor. */ - applyButtonText?: string; - applyValueMode?: string; - /** Specifies the text displayed on the button that cancels changes and closes the drop-down editor. */ - cancelButtonText?: string; - /** Specifies whether or not the widget value includes the alpha channel component. */ - editAlphaChannel?: boolean; - /** Specifies the size of a step by which a handle is moved using a keyboard shortcut. */ - keyStep?: number; - } - /** A widget used to specify a color value. */ - export class dxColorBox extends dxDropDownEditor { - constructor(element: JQuery, options?: dxColorBoxOptions); - constructor(element: Element, options?: dxColorBoxOptions); - } - export interface dxColorPickerOptions extends dxColorBoxOptions { } - /** - * A widget used to specify a color value. - * @deprecated Use the dxColorBox widget instead - */ - export class dxColorPicker extends dxColorBox { - constructor(element: JQuery, options?: dxColorPickerOptions); - constructor(element: Element, options?: dxColorPickerOptions); - } - export interface dxTreeViewOptions extends CollectionWidgetOptions { - /** Specifies whether or not to animate item collapsing and expanding. */ - animationEnabled?: boolean; - /** Specifies whether a nested or plain array is used as a data source. */ - dataStructure?: string; - /** Specifies whether or not a user can expand all tree view items by the "*" hot key. */ - expandAllEnabled?: boolean; - /** - * An array of currently expanded item objects. - * @deprecated Use item.expanded field instead - */ - expandedItems?: Array; - /** Specifies whether or not a check box is displayed at each tree view item. */ - showCheckBoxes?: boolean; - /** Specifies whether or not to select nodes recursively. */ - selectNodesRecursive?: boolean; - /** Specifies whether the "Select All" check box is displayed over the tree view. */ - selectAllEnabled?: boolean; - /** Specifies the text displayed at the "Select All" check box. */ - selectAllText?: string; - /** Specifies the name of the data source item field used as a key. */ - keyExpr?: any; - /** Specifies the name of the data source item field whose value is displayed by the widget. */ - displayExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding node is selected. */ - selectedExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding node is expanded. */ - expandedExpr?: any; - /** Specifies the name of the data source item field that contains an array of nested items. */ - itemsExpr?: any; - /** Specifies the name of the data source item field that holds the key of the parent item. */ - parentIdExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding node is disabled. */ - disabledExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding node includes child nodes. */ - hasItemsExpr?: any; - /** Specifies if the virtual mode is enabled. */ - virtualModeEnabled?: boolean; - /** Specifies the parent ID value of the root item. */ - rootValue?: any; - /** A string value specifying available scrolling directions. */ - scrollDirection?: string; - /** A handler for the itemSelected event. */ - onItemSelected?: Function; - /** A handler for the itemExpanded event. */ - onItemExpanded?: Function; - /** A handler for the itemCollapsed event. */ - onItemCollapsed?: Function; - onItemClick?: Function; - onItemContextMenu?: Function; - onItemRendered?: Function; - onItemHold?: Function; - hoverStateEnabled?: boolean; - focusStateEnabled?: boolean; - } - /** A widget displaying specified data items as a tree. */ - export class dxTreeView extends CollectionWidget { - constructor(element: JQuery, options?: dxTreeViewOptions); - constructor(element: Element, options?: dxTreeViewOptions); - /** Updates the tree view scrollbars according to the current size of the widget content. */ - updateDimensions(): JQueryPromise; - /** Selects the specified item. */ - selectItem(itemElement: any): void; - /** Unselects the specified item. */ - unselectItem(itemElement: any): void; - /** Expands the specified item. */ - expandItem(itemElement: any): void; - /** Collapses the specified item. */ - collapseItem(itemElement: any): void; - /** Returns all nodes of the tree view. */ - getNodes(): Array; - /** Selects all widget items. */ - selectAll(): void; - /** Unselects all widget items. */ - unselectAll(): void; - } - export interface dxMenuBaseOptions extends CollectionWidgetOptions { - /** An object that defines the animation options of the widget. */ - animation?: fx.AnimationOptions; - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** Specifies the name of the CSS class associated with the menu. */ - cssClass?: string; - /** Holds an array of menu items. */ - items?: Array; - /** Specifies whether or not an item becomes selected if an end-user clicks it. */ - selectionByClick?: boolean; - /** Specifies the selection mode supported by the menu. */ - selectionMode?: string; - /** Specifies options of submenu showing and hiding. */ - showSubmenuMode?: { - /** Specifies the mode name. */ - name?: string; - /** Specifies the delay of submenu show and hiding. */ - delay?: { - /** The time span after which the submenu is shown. */ - show?: number; - /** The time span after which the submenu is hidden. */ - hide?: number; - }; - }; - /** A Boolean value specifying whether or not the widget changes its state when being hovered by an end user. */ - hoverStateEnabled?: boolean; - } - export class dxMenuBase extends CollectionWidget { - constructor(element: JQuery, options?: dxMenuBaseOptions); - constructor(element: Element, options?: dxMenuBaseOptions); - /** Selects the specified item. */ - selectItem(itemElement: any): void; - /** Unselects the specified item. */ - unselectItem(itemElement: any): void; - } - export interface dxMenuOptions extends dxMenuBaseOptions { - /** Specifies whether or not the submenu is hidden when the mouse pointer leaves it. */ - hideSubmenuOnMouseLeave?: boolean; - /** Specifies whether the menu has horizontal or vertical orientation. */ - orientation?: string; - /** Specifies options for showing and hiding the first level submenu. */ - showFirstSubmenuMode?: { - /** Specifies the mode name. */ - name?: string; - /** Specifies the delay of submenu showing and hiding. */ - delay?: { - /** The time span after which the submenu is shown. */ - show?: number; - /** The time span after which the submenu is hidden. */ - hide?: number; - }; - }; - /** Specifies the direction at which the submenus are displayed. */ - submenuDirection?: string; - /** A handler for the submenuHidden event. */ - onSubmenuHidden?: Function; - submenuHiddenAction?: Function; - /** A handler for the submenuHiding event. */ - onSubmenuHiding?: Function; - submenuHidingAction?: Function; - /** A handler for the submenuShowing event. */ - onSubmenuShowing?: Function; - submenuShowingAction?: Function; - /** A handler for the submenuShown event. */ - onSubmenuShown?: Function; - submenuShownAction?: Function; - } - /** A menu widget. */ - export class dxMenu extends dxMenuBase { - constructor(element: JQuery, options?: dxMenuOptions); - constructor(element: Element, options?: dxMenuOptions); - } - export interface dxContextMenuOptions extends dxMenuBaseOptions { - /** Holds an object that specifies options of alternative menu invocation. */ - alternativeInvocationMode?: { - /** Specifies whether or not the standard context menu invocation (on a right mouse click or on a long tap) is disabled. */ - enabled?: Boolean; - /** Specifies the element used to invoke the context menu. */ - invokingElement?: any; - }; - /** A handler for the hidden event. */ - onHidden?: Function; - /** A handler for the hiding event. */ - onHiding?: Function; - /** A handler for the positioning event. */ - onPositioning?: Function; - /** A handler for the showing event. */ - onShowing?: Function; - /** A handler for the shown event. */ - onShown?: Function; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** Specifies the direction at which submenus are displayed. */ - submenuDirection?: string; - /** The target element associated with a popover. */ - target?: any; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - } - /** A context menu widget. */ - export class dxContextMenu extends dxMenuBase { - constructor(element: JQuery, options?: dxContextMenuOptions); - constructor(element: Element, options?: dxContextMenuOptions); - /** Toggles the visibility of the widget. */ - toggle(showing: boolean): JQueryPromise; - /** Shows the widget. */ - show(): JQueryPromise; - /** Hides the widget. */ - hide(): JQueryPromise; - } - export interface dxRemoteOperations { - /** Specifies whether or not filtering must be performed on the server side. */ - filtering?: boolean; - /** Specifies whether or not paging must be performed on the server side. */ - paging?: boolean; - /** Specifies whether or not sorting must be performed on the server side. */ - sorting?: boolean; - } - export interface dxDataGridColumn { - /** Specifies the content alignment within column cells. */ - alignment?: string; - /** Specifies whether the values in a column can be edited at runtime. Setting this option makes sense only when editing is enabled for a grid. */ - allowEditing?: boolean; - /** Specifies whether or not a column can be used for filtering grid records. Setting this option makes sense only when the filter row and column header filtering are visible. */ - allowFiltering?: boolean; - /** Specifies whether or not the column can be anchored to a grid edge by end users. Setting this option makes sense only when the columnFixing | enabled option is set to true. */ - allowFixing?: boolean; - /** Specifies if a column can be used for searching grid records. Setting this option makes sense only when the search panel is visible. */ - allowSearch?: boolean; - /** Specifies whether a column can be used for grouping grid records at runtime. Setting this option makes sense only when the group panel is visible. */ - allowGrouping?: boolean; - /** Specifies whether or not a column can be hidden by a user. Setting this option makes sense only when the column chooser is visible. */ - allowHiding?: boolean; - /** Specifies whether or not a particular column can be used in column reordering. Setting this option makes sense only when the allowColumnReordering option is set to true. */ - allowReordering?: boolean; - /** Specifies whether or not a particular column can be resized by a user. Setting this option makes sense only when the allowColumnResizing option is true. */ - allowResizing?: boolean; - /** Specifies whether grid records can be sorted by a specific column at runtime. Setting this option makes sense only when the sorting mode differs from none. */ - allowSorting?: boolean; - /** Specifies whether groups appear expanded or not when records are grouped by a specific column. Setting this option makes sense only when grouping is allowed for this column. */ - autoExpandGroup?: boolean; - /** Specifies a callback function that returns a value to be displayed in a column cell. */ - calculateCellValue?: (rowData: Object) => string; - /** Specifies a callback function that defines filters for customary calculated grid cells. */ - calculateFilterExpression?: (filterValue: any, selectedFilterOperation: string) => Array; - /** Specifies a caption for a column. */ - caption?: string; - /** Specifies a custom template for grid column cells. */ - cellTemplate?: any; - /** Specifies a CSS class to be applied to a column. */ - cssClass?: string; - /** Specifies a field name or a function that returns a field name or a value to be used for grouping column cells. */ - calculateGroupValue?: any; - /** Specifies a field name or a function that returns a field name or a value to be used for sorting column cells. */ - calculateSortValue?: any; - /** Specifies a callback function that returns the text to be displayed in the cells of a column. */ - customizeText?: (cellInfo: { value: any; valueText: string }) => string; - /** Specifies the field of a data source that provides data for a column. */ - dataField?: string; - /** Specifies the required type of column values. */ - dataType?: string; - /** Specifies a custom template for the cell of a grid column when it is in an editing state. */ - editCellTemplate?: any; - /** Specifies whether HTML tags are displayed as plain text or applied to the values of the column. */ - encodeHtml?: boolean; - /** In a boolean column, replaces all false items with a specified text. */ - falseText?: string; - /** Specifies the set of available filter operations. */ - filterOperations?: Array; - /** Specifies a filter value for a column. */ - filterValue?: any; - /** Specifies initial filter values for the column's header filter. */ - filterValues?: Array; - /** Specifies whether to include or exclude the records with the values selected in the column's header filter. */ - filterType?: string; - /** Indicates whether the column takes part in horizontal grid scrolling or is anchored to a grid edge. */ - fixed?: boolean; - /** Specifies the grid edge to which the column is anchored. */ - fixedPosition?: string; - /** Specifies a format for the values displayed in a column. */ - format?: string; - /** Specifies a custom template for the group cell of a grid column. */ - groupCellTemplate?: any; - /** Specifies the index of a column when grid records are grouped by the values of this column. */ - groupIndex?: number; - /** Specifies a custom template for the header of a grid column. */ - headerCellTemplate?: any; - /** Specifies options of a lookup column. */ - lookup?: { - /** Specifies whether or not a user can nullify values of a lookup column. */ - allowClearing?: boolean; - /** Specifies the data source providing data for a lookup column. */ - dataSource?: any; - /** Specifies the expression defining the data source field whose values must be displayed. */ - displayExpr?: any; - /** Specifies the expression defining the data source field whose values must be replaced. */ - valueExpr?: string; - }; - /** Specifies a precision for formatted values displayed in a column. */ - precision?: number; - /** Specifies a filter operation applied to a column. */ - selectedFilterOperation?: string; - /** Specifies whether or not the column displays its values by using editors. */ - showEditorAlways?: boolean; - /** Specifies whether or not to display the column when grid records are grouped by it. */ - showWhenGrouped?: boolean; - /** Specifies the index of a column when grid records are sorted by the values of this column. */ - sortIndex?: number; - /** Specifies the initial sort order of column values. */ - sortOrder?: string; - /** In a boolean column, replaces all true items with a specified text. */ - trueText?: string; - /** Specifies whether a column is visible or not. */ - visible?: boolean; - /** Specifies the sequence number of the column in the grid. */ - visibleIndex?: number; - /** Specifies a column width in pixels or percentages. */ - width?: any; - /** Specifies an array of validation rules to be checked when updating column cell values. */ - validationRules?: Array; - /** Specifies whether or not to display the header of a hidden column in the column chooser. */ - showInColumnChooser?: boolean; - /** Specifies the identifier of the column. */ - name?: string; - } - export interface dxDataGridOptions extends WidgetOptions { - /** Specifies whether the outer borders of the grid are visible or not. */ - showBorders?: boolean; - /** Indicates whether to show the error row for the grid. */ - errorRowEnabled?: boolean; - /** A handler for the rowValidating event. */ - onRowValidating?: (e: Object) => void; - /** A handler for the contextMenuPreparing event. */ - onContextMenuPreparing?: (e: Object) => void; - initNewRow?: (e: { data: Object }) => void; - /** A handler for the initNewRow event. */ - onInitNewRow?: (e: { data: Object }) => void; - rowInserted?: (e: { data: Object; key: any }) => void; - /** A handler for the rowInserted event. */ - onRowInserted?: (e: { data: Object; key: any }) => void; - rowInserting?: (e: { data: Object; cancel: boolean }) => void; - /** A handler for the rowInserting event. */ - onRowInserting?: (e: { data: Object; cancel: boolean }) => void; - rowRemoved?: (e: { data: Object; key: any }) => void; - /** A handler for the rowRemoved event. */ - onRowRemoved?: (e: { data: Object; key: any }) => void; - rowRemoving?: (e: { data: Object; key: any; cancel: boolean }) => void; - /** A handler for the rowRemoving event. */ - onRowRemoving?: (e: { data: Object; key: any; cancel: boolean }) => void; - rowUpdated?: (e: { data: Object; key: any }) => void; - /** A handler for the rowUpdated event. */ - onRowUpdated?: (e: { data: Object; key: any }) => void; - rowUpdating?: (e: { oldData: Object; newData: Object; key: any; cancel: boolean }) => void; - /** A handler for the rowUpdating event. */ - onRowUpdating?: (e: { oldData: Object; newData: Object; key: any; cancel: boolean }) => void; - /** Enables a hint that appears when a user hovers the mouse pointer over a cell with truncated content. */ - cellHintEnabled?: boolean; - /** Specifies whether or not grid columns can be reordered by a user. */ - allowColumnReordering?: boolean; - /** Specifies whether or not grid columns can be resized by a user. */ - allowColumnResizing?: boolean; - cellClick?: any; - /** A handler for the cellClick event. */ - onCellClick?: any; - cellHoverChanged?: (e: Object) => void; - /** A handler for the cellHoverChanged event. */ - onCellHoverChanged?: (e: Object) => void; - cellPrepared?: (e: Object) => void; - /** A handler for the cellPrepared event. */ - onCellPrepared?: (e: Object) => void; - /** Specifies whether or not the width of grid columns depends on column content. */ - columnAutoWidth?: boolean; - /** Specifies the options of a column chooser. */ - columnChooser?: { - /** Specifies text displayed by the column chooser panel when it does not contain any columns. */ - emptyPanelText?: string; - /** Specifies whether a user can invoke the column chooser or not. */ - enabled?: boolean; - /** Specifies the height of the column chooser panel. */ - height?: number; - /** Specifies text displayed in the title of the column chooser panel. */ - title?: string; - /** Specifies the width of the column chooser panel. */ - width?: number; - }; - /** Specifies options for column fixing. */ - columnFixing?: { - /** Indicates if column fixing is enabled. */ - enabled?: boolean; - /** Contains options that specify texts for column-fixing related commands in the column header's context menu. */ - texts?: { - /** Specifies text for a context menu item that fixes the column for which the context menu is invoked. */ - fix?: string; - /** Specifies text for a context menu item that unfixes the column for which the context menu is invoked. */ - unfix?: string; - /** Specifies text for a context menu subitem that fixes a column, for which the context menu is invoked, to the left grid edge. */ - leftPosition?: string; - /** Specifies text for a context menu subitem that fixes a column, for which the context menu is invoked, to the right grid edge. */ - rightPosition?: string; - }; - }; - /** Specifies options for filtering using a column header filter. */ - headerFilter?: { - /** Indicates whether or not the column header filter button is visible. */ - visible?: boolean; - /** Specifies the height of the dropdown menu invoked when using a column header filter. */ - height?: number; - /** Specifies the width of the dropdown menu invoked when using a column header filter. */ - width?: number; - /** Contains options that specify texts for the dropdown menu invoked when you use a column header filter. */ - texts?: { - /** Specifies text for the item specifying an empty value in the column header filter's dropdown menu. */ - emptyValue?: string; - /** Specifies text for a button that closes the column header filter's dropdown menu and applies specified filtering. */ - ok?: string; - /** Specifies text for a button that closes the column header filter's dropdown menu without applying performed selection. */ - cancel?: string; - } - }; - /** An array of grid columns. */ - columns?: Array; - onContentReady?: Function; - contentReadyAction?: Function; - /** Specifies a function that customizes grid columns after they are created. */ - customizeColumns?: (columns: Array) => void; - dataErrorOccurred?: (errorObject: Error) => void; - /** Specifies a data source for the grid. */ - dataSource?: any; - editingStart?: (e: { - data: Object; - key: any; - cancel: boolean; - column: dxDataGridColumn - }) => void; - /** A handler for the editingStart event. */ - onEditingStart?: (e: { - data: Object; - key: any; - cancel: boolean; - column: dxDataGridColumn - }) => void; - editorPrepared?: (e: Object) => void; - /** A handler for the editorPrepared event. */ - onEditorPrepared?: (e: Object) => void; - editorPreparing?: (e: Object) => void; - /** A handler for the editorPreparing event. */ - onEditorPreparing?: (e: Object) => void; - /** Contains options that specify how grid content can be changed. */ - editing?: { - /** Specifies whether or not grid records can be edited at runtime. */ - editEnabled?: boolean; - /** Specifies how grid values can be edited manually. */ - editMode?: string; - /** Specifies whether or not new records can be inserted into a grid. */ - insertEnabled?: boolean; - /** Specifies whether or not records can be deleted from a grid. */ - removeEnabled?: boolean; - /** Contains options that specify texts for editing-related grid controls. */ - texts?: { - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Save" button. Setting this option makes sense only when the editMode option is set to batch. */ - saveAllChanges?: string; - /** Specifies text for a cancel button displayed when a row is in the editing state. Setting this option makes sense only when the editEnabled option is set to true. */ - cancelRowChanges?: string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Revert" button. Setting this option makes sense only when the editMode option is set to batch. */ - cancelAllChanges?: string; - /** Specifies a message to be displayed by a confirmation window. Setting this option makes sense only when the edit mode is "row". */ - confirmDeleteMessage?: string; - /** Specifies text to be displayed in the title of a confirmation window. Setting this option makes sense only when the edit mode is "row". */ - confirmDeleteTitle?: string; - /** Specifies text for a button that deletes a row from a grid. Setting this option makes sense only when the removeEnabled option is set to true. */ - deleteRow?: string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Add" button. Setting this option makes sense only when the insertEnabled option is true. */ - addRow?: string; - /** Specifies text for a button that turns a row into the editing state. Setting this option makes sense only when the editEnabled option is set to true. */ - editRow?: string; - /** Specifies text for a save button displayed when a row is in the editing state. Setting this option makes sense only when the editEnabled option is set to true. */ - saveRowChanges?: string; - /** Specifies text for a button that recovers a deleted row. Setting this option makes sense only if the grid uses the batch edit mode and the removeEnabled option is set to true. */ - undeleteRow?: string; - }; - }; - /** Specifies filter row options. */ - filterRow?: { - /** Specifies when to apply a filter. */ - applyFilter?: string; - /** Specifies text for the hint that pops up when a user hovers the mouse pointer over the "Apply Filter" button. */ - applyFilterText?: string; - /** Specifies descriptions for filter operations. */ - operationDescriptions?: { - "=": string; - "<>": string; - "<": string; - "<=": string; - ">": string; - ">=": string; - "startswith": string; - "contains": string; - "notcontains": string; - "endswith": string; - }; - /** Specifies text for the reset operation in a filter list. */ - resetOperationText?: string; - /** Specifies text for the operation of clearing the applied filter when a select box is used. */ - showAllText?: string; - /** Specifies whether or not an icon that allows the user to choose a filter operation is visible. */ - showOperationChooser?: boolean; - /** Specifies whether the filter row is visible or not. */ - visible?: boolean; - }; - /** Specifies the behavior of grouped grid records. */ - grouping?: { - /** Specifies whether the user can collapse grouped records in a grid or not. */ - allowCollapsing?: boolean; - /** Specifies whether groups appear expanded or not. */ - autoExpandAll?: boolean; - /** Specifies the message displayed in a group row when the corresponding group is continued from the previous page. */ - groupContinuedMessage?: string; - /** Specifies the message displayed in a group row when the corresponding group continues on the next page. */ - groupContinuesMessage?: string; - }; - /** Specifies options that configure the group panel. */ - groupPanel?: { - /** Specifies whether columns can be dragged onto or from the group panel. */ - allowColumnDragging?: boolean; - /** Specifies text displayed by the group panel when it does not contain any columns. */ - emptyPanelText?: string; - /** Specifies whether the group panel is visible or not. */ - visible?: boolean; - }; - /** Specifies options configuring the load panel. */ - loadPanel?: { - /** Specifies whether to show the load panel or not. */ - enabled?: boolean; - /** Specifies the height of the load panel in pixels. */ - height?: number; - /** Specifies a URL pointing to an image to be used as a loading indicator. */ - indicatorSrc?: string; - /** Specifies whether or not a loading indicator must be displayed on the load panel. */ - showIndicator?: boolean; - /** Specifies whether or not the pane of the load panel must be displayed. */ - showPane?: boolean; - /** Specifies text displayed by the load panel. */ - text?: string; - /** Specifies the width of the load panel in pixels. */ - width?: number; - }; - /** Specifies text displayed when a grid does not contain any records. */ - noDataText?: string; - /** Specifies the options of a grid pager. */ - pager?: { - /** Specifies the page sizes that can be selected at runtime. */ - allowedPageSizes?: any; - /** Specifies whether to show the page size selector or not. */ - showPageSizeSelector?: boolean; - /** Specifies whether to show the pager or not. */ - visible?: any; - /** Specifies the text accompanying the page navigator. */ - infoText?: string; - /** Specifies whether or not to display the text accompanying the page navigator. This text is specified by the infoText option. */ - showInfo?: boolean; - /** Specifies whether or not to display buttons that switch the grid to the previous or next page. */ - showNavigationButtons?: boolean; - }; - /** Specifies paging options. */ - paging?: { - /** Specifies whether dxDataGrid loads data page by page or all at once. */ - enabled?: boolean; - /** Specifies the grid page that should be displayed by default. */ - pageIndex?: number; - /** Specifies the size of grid pages. */ - pageSize?: number; - }; - /** Specifies whether or not grid rows must be shaded in a different way. */ - rowAlternationEnabled?: boolean; - rowClick?: any; - /** A handler for the rowClick event. */ - onRowClick?: any; - rowPrepared?: (e: Object) => void; - /** A handler for the rowPrepared event. */ - onRowPrepared?: (e: Object) => void; - /** Specifies a custom template for grid rows. */ - rowTemplate?: any; - /** A configuration object specifying scrolling options. */ - scrolling?: { - /** Specifies the scrolling mode. */ - mode?: string; - /** Specifies whether or not a grid must preload pages adjacent to the current page when using virtual scrolling. */ - preloadEnabled?: boolean; - }; - /** Specifies options of the search panel. */ - searchPanel?: { - /** Specifies whether or not search strings in the located grid records should be highlighted. */ - highlightSearchText?: boolean; - /** Specifies text displayed by the search panel when no search string was typed. */ - placeholder?: string; - /** Specifies whether the search panel is visible or not. */ - visible?: boolean; - /** Specifies the width of the search panel in pixels. */ - width?: number; - /** Sets a search string for the search panel. */ - text?: string; - }; - /** Specifies the operations that must be performed on the server side. */ - remoteOperations?: any; - /** Allows you to sort groups according to the values of group summary items. */ - sortByGroupSummaryInfo?: Array<{ - /** Specifies the group summary item whose values must be used to sort groups. */ - summaryItem?: string; - /** Specifies the identifier of the column that must be used in grouping so that sorting by group summary item values be applied. */ - groupColumn?: string; - /** Specifies the sort order of group summary item values. */ - sortOrder?: string; - }>; - /** Allows you to build a master-detail interface in the grid. */ - masterDetail?: { - /** Enables an end-user to expand/collapse detail sections. */ - enabled?: boolean; - /** Specifies whether detail sections appear expanded or collapsed. */ - autoExpandAll?: boolean; - /** Specifies the template for detail sections. */ - template?: any; - }; - /** Specifies options for exporting grid data. */ - export?: { - /** Indicates if the export feature is enabled in the grid. */ - enabled?: boolean; - /** Specifies a default name for the file to which grid data is exported. */ - fileName?: string; - /** Specifies whether to enable Excel filtering for the exported data in the resulting XLSX file. */ - excelFilterEnabled?: boolean; - /** Specifies whether to enable word wrapping for the exported data in the resulting XLSX file. */ - excelWrapTextEnabled?: boolean; - /** Specifies the URL of the server-side proxy that streams the resulting file to the end user to enable export in IE8, IE9 and Safari browsers. */ - proxyUrl?: string; - /** Indicates whether to allow end users to export not only the data displayed in the grid, but the selected rows only. */ - allowExportSelectedData?: boolean; - /** Contains options that specify texts for the export-related commands and hints. */ - texts?: { - /** Specifies text for the Export button when this button invokes a dropdown menu so you can choose the required export format. */ - exportTo?: string; - /** Specifies text for the Export button when this button exports to the XSLX format. */ - exportToExcel?: string; - /** Specifies text for the item in the Export dropdown menu that exports grid data to Excel. */ - excelFormat?: string; - /** Specifies text for the option in the Export dropdown menu that allows you to choose whether to export all the grid data or the selected rows only. */ - selectedRows?: string; - } - }; - /** Specifies the keys of the records that must appear selected initially. */ - selectedRowKeys?: Array; - /** Specifies options of runtime selection. */ - selection?: { - /** Specifies whether the user can select all grid records at once. */ - allowSelectAll?: boolean; - /** Specifies the selection mode. */ - mode?: string; - }; - selectionChanged?: (e: { - currentSelectedRowKeys: Array; - currentDeselectedRowKeys: Array; - selectedRowKeys: Array; - selectedRowsData: Array; - }) => void; - /** A handler for the dataErrorOccured event. */ - onDataErrorOccurred?: (e: { error: Error }) => void; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: (e: { - currentSelectedRowKeys: Array; - currentDeselectedRowKeys: Array; - selectedRowKeys: Array; - selectedRowsData: Array; - }) => void; - /** A handler for the exporting event. */ - onExporting?: (e: { - fileName: string; - format: string; - cancel: boolean; - }) => void; - /** A handler for the exported event. */ - onExported?: (e: Object) => void; - /** A handler for the keyDown event. */ - onKeyDown?: (e: Object) => void; - /** A handler for the rowExpanding event. */ - onRowExpanding?: (e: Object) => void; - /** A handler for the rowExpanded event. */ - onRowExpanded?: (e: Object) => void; - /** A handler for the rowCollapsing event. */ - onRowCollapsing?: (e: Object) => void; - /** A handler for the rowCollapsed event. */ - onRowCollapsed?: (e: Object) => void; - /** Specifies whether column headers are visible or not. */ - showColumnHeaders?: boolean; - /** Specifies whether or not vertical lines separating one grid column from another are visible. */ - showColumnLines?: boolean; - /** Specifies whether or not horizontal lines separating one grid row from another are visible. */ - showRowLines?: boolean; - /** Specifies options of runtime sorting. */ - sorting?: { - /** Specifies text for the context menu item that sets an ascending sort order in a column. */ - ascendingText?: string; - /** Specifies text for the context menu item that resets sorting settings for a column. */ - clearText?: string; - /** Specifies text for the context menu item that sets a descending sort order in a column. */ - descendingText?: string; - /** Specifies the runtime sorting mode. */ - mode?: string; - }; - /** Specifies options of state storing. */ - stateStoring?: { - /** Specifies a callback function that performs specific actions on state loading. */ - customLoad?: () => JQueryPromise; - /** Specifies a callback function that performs specific actions on state saving. */ - customSave?: (gridState: Object) => void; - /** Specifies whether or not a grid saves its state. */ - enabled?: boolean; - /** Specifies the delay between the last change of a grid state and the operation of saving this state in milliseconds. */ - savingTimeout?: number; - /** Specifies a unique key to be used for storing the grid state. */ - storageKey?: string; - /** Specifies the type of storage to be used for state storing. */ - type?: string; - }; - /** Specifies the options of the grid summary. */ - summary?: { - /** Contains options that specify text patterns for summary items. */ - texts?: { - /** Specifies a pattern for the 'sum' summary items when they are displayed in the parent column. */ - sum?: string; - /** Specifies a pattern for the 'sum' summary items displayed in a group row or in any other column rather than the parent one. */ - sumOtherColumn?: string; - /** Specifies a pattern for the 'min' summary items when they are displayed in the parent column. */ - min?: string; - /** Specifies a pattern for the 'min' summary items displayed in a group row or in any other column rather than the parent one. */ - minOtherColumn?: string; - /** Specifies a pattern for the 'max' summary items when they are displayed in the parent column. */ - max?: string; - /** Specifies a pattern for the 'max' summary items displayed in a group row or in any other column rather than the parent one. */ - maxOtherColumn?: string; - /** Specifies a pattern for the 'avg' summary items when they are displayed in the parent column. */ - avg?: string; - /** Specifies a pattern for the 'avg' summary items displayed in a group row or in any other column rather than the parent one. */ - avgOtherColumn?: string; - /** Specifies a pattern for the 'count' summary items. */ - count?: string; - }; - /** Specifies items of the group summary. */ - groupItems?: Array<{ - /** Specifies the identifier of a summary item. */ - name?: string; - /** Specifies the column that provides data for a group summary item. */ - column?: string; - /** Customizes the text to be displayed in the summary item. */ - customizeText?: (itemInfo: { - value: any; - valueText: string; - }) => string; - /** Specifies a pattern for the summary item text. */ - displayFormat?: string; - /** Specifies a precision for the summary item value of a numeric format. */ - precision?: number; - /** Specifies whether or not a summary item must be displayed in the group footer. */ - showInGroupFooter?: boolean; - /** Indicates whether to display group summary items in parentheses after the group row header or to align them by the corresponding columns within the group row. */ - alignByColumn?: boolean; - /** Specifies the column that must hold the summary item when this item is displayed in the group footer or aligned by a column in the group row. */ - showInColumn?: string; - /** Specifies how to aggregate data for a summary item. */ - summaryType?: string; - /** Specifies a format for the summary item value. */ - valueFormat?: string; - }>; - /** Specifies items of the total summary. */ - totalItems?: Array<{ - /** Specifies the identifier of a summary item. */ - name?: string; - /** Specifies the alignment of a summary item. */ - alignment?: string; - /** Specifies the column that provides data for a summary item. */ - column?: string; - /** Specifies a CSS class to be applied to a summary item. */ - cssClass?: string; - /** Customizes the text to be displayed in the summary item. */ - customizeText?: (itemInfo: { - value: any; - valueText: string; - }) => string; - /** Specifies a pattern for the summary item text. */ - displayFormat?: string; - /** Specifies a precision for the summary item value of a numeric format. */ - precision?: number; - /** Specifies the column that must hold the summary item. */ - showInColumn?: string; - /** Specifies how to aggregate data for a summary item. */ - summaryType?: string; - /** Specifies a format for the summary item value. */ - valueFormat?: string; - }>; - /** Allows you to use a custom aggregate function to calculate the value of a summary item. */ - calculateCustomSummary?: (options: { - component: dxDataGrid; - name?: string; - value: any; - totalValue: any; - summaryProcess: string - }) => void; - }; - /** Specifies whether text that does not fit into a column should be wrapped. */ - wordWrapEnabled?: boolean; - } - /** A data grid widget. */ - export class dxDataGrid extends Widget { - constructor(element: JQuery, options?: dxDataGridOptions); - constructor(element: Element, options?: dxDataGridOptions); - /** Ungroups grid records. */ - clearGrouping(): void; - /** Clears sorting settings of all grid columns at once. */ - clearSorting(): void; - /** Allows you to obtain a cell by its row index and the data field of its column. */ - getCellElement(rowIndex: number, dataField: string): any; - /** Allows you to obtain a cell by its row index and the visible index of its column. */ - getCellElement(rowIndex: number, visibleColumnIndex: number): any; - /** Returns the current state of the grid. */ - state(): Object; - /** Sets the grid state. */ - state(state: Object): void; - /** Allows you to obtain the row index by a data key. */ - getRowIndexByKey(key: any): number; - /** Allows you to obtain the data key by a row index. */ - getKeyByRowIndex(rowIndex: number): any; - /** Adds a new column to a grid. */ - addColumn(columnOptions: dxDataGridColumn): void; - /** Displays the load panel. */ - beginCustomLoading(messageText: string): void; - /** Discards changes made in a grid. */ - cancelEditData(): void; - /** Clears all the filters of a specific type applied to grid records. */ - clearFilter(): void; - /** Deselects all grid records. */ - clearSelection(): void; - /** Draws the cell being edited from the editing state. Use this method when the edit mode is batch. */ - closeEditCell(): void; - /** Collapses groups or master rows in a grid. */ - collapseAll(groupIndex?: number): void; - /** Returns the number of data columns in a grid. */ - columnCount(): number; - /** Returns the value of a specific column option. */ - columnOption(id: any, optionName: string): any; - /** Sets an option of a specific column. */ - columnOption(id: any, optionName: string, optionValue: any): void; - /** Returns the options of a column by an identifier. */ - columnOption(id: any): Object; - /** Sets several options of a column at once. */ - columnOption(id: any, options: Object): void; - /** Sets a specific cell into the editing state. */ - editCell(rowIndex: number, columnIndex: number): void; - /** Sets a specific row into the editing state. */ - editRow(rowIndex: number): void; - /** Hides the load panel. */ - endCustomLoading(): void; - /** Expands groups or master rows in a grid. */ - expandAll(groupIndex: number): void; - /** Allows you to find out whether a specific group or master row is expanded or collapsed. */ - isRowExpanded(key: any): boolean; - /** Allows you to expand a specific group or master row by its key. */ - expandRow(key: any): void; - /** Allows you to collapse a specific group or master row by its key. */ - collapseRow(key: any): void; - /** Applies a filter to the grid's data source. */ - filter(filterExpr?: any): void; - /** Returns a filter expression applied to the grid's data source using the filter(filterExpr) method. */ - filter(): any; - /** Returns a filter expression applied to the grid using all possible scenarious. */ - getCombinedFilter(): any; - /** Gets the keys of currently selected grid records. */ - getSelectedRowKeys(): Array; - /** Gets the data objects of currently selected grid records. */ - getSelectedRowsData(): Array; - /** Hides the column chooser panel. */ - hideColumnChooser(): void; - /** Adds a new data row to a grid. */ - insertRow(): void; - /** Returns the key corresponding to the passed data object. */ - keyOf(obj: Object): any; - /** Switches a grid to a specified page. */ - pageIndex(newIndex: number): void; - /** Gets the index of the current page. */ - pageIndex(): number; - /** Sets the page size. */ - pageSize(value: number): void; - /** Gets the current page size. */ - pageSize(): number; - /** Refreshes grid data. */ - refresh(): void; - /** Removes a specific row from a grid. */ - removeRow(rowIndex: number): void; - /** Saves changes made in a grid. */ - saveEditData(): void; - /** Searches grid records by a search string. */ - searchByText(text: string): void; - /** Selects all grid records. */ - selectAll(): void; - /** Deselects the rows that are currently selected within the applied filter. */ - deselectAll(): void; - /** Selects specific grid records. */ - selectRows(keys: Array, preserve: boolean): void; - /** Deselects specific grid records. */ - deselectRows(keys: Array): void; - /** Selects grid rows by indexes. */ - selectRowsByIndexes(indexes: Array): void; - /** Allows you to find out whether a row is selected or not. */ - isRowSelected(key: any): boolean; - /** Invokes the column chooser panel. */ - showColumnChooser(): void; - startSelectionWithCheckboxes(): boolean; - /** Returns the number of records currently held by a grid. */ - totalCount(): number; - /** Recovers a row deleted in the batch edit mode. */ - undeleteRow(rowIndex: number): void; - /** Allows you to obtain a data object by its key. */ - byKey(key: any): JQueryPromise; - /** Gets the value of a total summary item. */ - getTotalSummaryValue(summaryItemName: string): any; - /** Exports grid data to Excel. */ - exportToExcel(selectionOnly: boolean): void; - /** Updates the grid to the size of its content. */ - updateDimensions(): void; - /** Focuses the specified cell element in the grid. */ - focus(element?: JQuery): void; - } - export interface dxPivotGridOptions extends WidgetOptions { - onContentReady?: Function; - /** Specifies a data source for the pivot grid. */ - dataSource?: any; - /** Specifies whether or not the widget uses native scrolling. */ - useNativeScrolling?: any; - /** Allows an end-user to change sorting options. */ - allowSorting?: boolean; - /** Allows an end-user to sort columns by summary values. */ - allowSortingBySummary?: boolean; - /** Allows an end-user to change filtering options. */ - allowFiltering?: boolean; - /** Allows an end-user to expand/collapse all header items within a header level. */ - allowExpandAll?: boolean; - /** Specifies whether to display the Total rows. */ - showRowTotals?: boolean; - /** Specifies whether to display the Grand Total row. */ - showRowGrandTotals?: boolean; - /** Specifies whether to display the Total columns. */ - showColumnTotals?: boolean; - /** Specifies whether to display the Grand Total column. */ - showColumnGrandTotals?: boolean; - /** The Field Chooser configuration options. */ - fieldChooser?: { - /** Enables or disables the field chooser. */ - enabled?: boolean; - /** Specifies the field chooser layout. */ - layout?: number; - /** Specifies the text to display as a title of the field chooser popup window. */ - title?: string; - /** Specifies the field chooser width. */ - width?: number; - /** Specifies the field chooser height. */ - height?: number; - /** Strings that can be changed or localized in the pivot grid's integrated Field Chooser. */ - texts?: { - /** The string to display instead of Row Fields. */ - rowFields?: string; - /** The string to display instead of Column Fields. */ - columnFields?: string; - /** The string to display instead of Data Fields. */ - dataFields?: string; - /** The string to display instead of Filter Fields. */ - filterFields?: string; - /** The string to display instead of All Fields. */ - allFields?: string; - }; - } - /** Strings that can be changed or localized in the dxPivotGrid widget. */ - texts?: { - /** The string to display as a header of the Grand Total row and column. */ - grandTotal?: string; - /** The string to display as a header of the Total row and column. */ - total?: string; - /** Specifies the text displayed when a pivot grid does not contain any fields. */ - noData?: string; - /** The string to display as a Show Field Chooser context menu item. */ - showFieldChooser?: string; - /** The string to display as an Expand All context menu item. */ - expandAll?: string; - /** The string to display as a Collapse All context menu item. */ - collapseAll?: string; - /** The string to display as a Sort Column by Summary Value context menu item. */ - sortColumnBySummary?: string; - /** The string to display as a Sort Row by Summary Value context menu item. */ - sortRowBySummary?: string; - /** The string to display as a Remove All Sorting context menu item. */ - removeAllSorting?: string; - }; - /** The Load panel configuration options. */ - loadPanel?: { - /** Enables or disables the load panel. */ - enabled?: boolean; - /** Specifies the height of the load panel. */ - height?: number; - /** Specifies the URL pointing to an image that will be used as a load indicator. */ - indicatorSrc?: string; - /** Specifies whether or not to show a load indicator. */ - showIndicator?: boolean; - /** Specifies whether or not to show load panel background. */ - showPane?: boolean; - /** Specifies the text to display inside a load panel. */ - text?: string; - /** Specifies the width of the load panel. */ - width?: number; - }; - /** A handler for the cellClick event. */ - onCellClick?: (e: any) => void; - /** A handler for the cellPrepared event. */ - onCellPrepared?: (e: any) => void; - /** A handler for the contextMenuPreparing event. */ - onContextMenuPreparing?: (e: Object) => void; - } - /** A data summarization widget for multi-dimensional data analysis and data mining. */ - export class dxPivotGrid extends Widget { - constructor(element: JQuery, options?: dxPivotGridOptions); - constructor(element: Element, options?: dxPivotGridOptions); - /** Gets the PivotGridDataSource instance. */ - getDataSource(): DevExpress.data.PivotGridDataSource; - /** Updates the widget to the size of its content. */ - updateDimensions(): void; - } - export interface dxPivotGridFieldChooserOptions extends WidgetOptions { - /** Specifies the height of the widget. */ - height?: any; - /** Specifies the field chooser layout. */ - layout?: number; - /** The data source of a dxPivotGrid widget. */ - dataSource?: DevExpress.data.PivotGridDataSource; - onContentReady?: Function; - /** Strings that can be changed or localized in the dxPivotGridFieldChooser widget. */ - texts?: { - /** The string to display instead of Row Fields. */ - rowFields?: string; - /** The string to display instead of Column Fields. */ - columnFields?: string; - /** The string to display instead of Data Fields. */ - dataFields?: string; - /** The string to display instead of Filter Fields. */ - filterFields?: string; - /** The string to display instead of All Fields. */ - allFields?: string; - }; - } - /** A complementary widget for dxPivotGrid that allows you to manage data displayed in the dxPivotGrid. */ - export class dxPivotGridFieldChooser extends Widget { - constructor(element: JQuery, options?: dxPivotGridFieldChooserOptions); - constructor(element: Element, options?: dxPivotGridFieldChooserOptions); - /** Updates the widget to the size of its content. */ - updateDimensions(): void; - } -} -interface JQuery { - dxTreeView(): JQuery; - dxTreeView(options: "instance"): DevExpress.ui.dxTreeView; - dxTreeView(options: string): any; - dxTreeView(options: string, ...params: any[]): any; - dxTreeView(options: DevExpress.ui.dxTreeViewOptions): JQuery; - dxMenuBase(): JQuery; - dxMenuBase(options: "instance"): DevExpress.ui.dxMenuBase; - dxMenuBase(options: string): any; - dxMenuBase(options: string, ...params: any[]): any; - dxMenuBase(options: DevExpress.ui.dxMenuBaseOptions): JQuery; - dxMenu(): JQuery; - dxMenu(options: "instance"): DevExpress.ui.dxMenu; - dxMenu(options: string): any; - dxMenu(options: string, ...params: any[]): any; - dxMenu(options: DevExpress.ui.dxMenuOptions): JQuery; - dxContextMenu(): JQuery; - dxContextMenu(options: "instance"): DevExpress.ui.dxContextMenu; - dxContextMenu(options: string): any; - dxContextMenu(options: string, ...params: any[]): any; - dxContextMenu(options: DevExpress.ui.dxContextMenuOptions): JQuery; - dxColorBox(): JQuery; - dxColorBox(options: "instance"): DevExpress.ui.dxColorBox; - dxColorBox(options: string): any; - dxColorBox(options: string, ...params: any[]): any; - dxColorBox(options: DevExpress.ui.dxColorBoxOptions): JQuery; - dxDataGrid(): JQuery; - dxDataGrid(options: "instance"): DevExpress.ui.dxDataGrid; - dxDataGrid(options: string): any; - dxDataGrid(options: string, ...params: any[]): any; - dxDataGrid(options: DevExpress.ui.dxDataGridOptions): JQuery; - dxPivotGrid(): JQuery; - dxPivotGrid(options: "instance"): DevExpress.ui.dxPivotGrid; - dxPivotGrid(options: string): any; - dxPivotGrid(options: string, ...params: any[]): any; - dxPivotGrid(options: DevExpress.ui.dxPivotGridOptions): JQuery; - dxPivotGridFieldChooser(): JQuery; - dxPivotGridFieldChooser(options: "instance"): DevExpress.ui.dxPivotGridFieldChooser; - dxPivotGridFieldChooser(options: string): any; - dxPivotGridFieldChooser(options: string, ...params: any[]): any; - dxPivotGridFieldChooser(options: DevExpress.ui.dxPivotGridFieldChooserOptions): JQuery; - dxScheduler(): JQuery; - dxScheduler(options: "instance"): DevExpress.ui.dxScheduler; - dxScheduler(options: string): any; - dxScheduler(options: string, ...params: any[]): any; - dxScheduler(options: DevExpress.ui.dxSchedulerOptions): JQuery; -} -declare namespace DevExpress.framework { - /** An object used to store information on the views displayed in an application. */ - export class ViewCache { - viewRemoved: JQueryCallback; - /** Removes all the viewInfo objects from the cache. */ - clear(): void; - /** Obtains a viewInfo object from the cache by the specified key. */ - getView(key: string): Object; - /** Checks whether or not a viewInfo object is contained in the view cache under the specified key. */ - hasView(key: string): boolean; - /** Removes a viewInfo object from the cache by the specified key. */ - removeView(key: string): Object; - /** Adds the specified viewInfo object to the cache under the specified key. */ - setView(key: string, viewInfo: Object): void; - } - export interface dxCommandOptions extends DOMComponentOptions { - action?: any; - /** Specifies an action performed when the execute() method of the command is called. */ - onExecute?: any; - /** Indicates whether or not the widget that displays this command is disabled. */ - disabled?: boolean; - /** Specifies whether the current command is rendered when a view is being rendered or after a view is shown. */ - renderStage?: string; - /** Specifies the name of the icon shown inside the widget associated with this command. */ - icon?: string; - iconSrc?: string; - /** The identifier of the command. */ - id?: string; - /** Specifies the title of the widget associated with this command. */ - title?: string; - /** Specifies the type of the button, if the command is rendered as a dxButton widget. */ - type?: string; - /** A Boolean value specifying whether or not the widget associated with this command is visible. */ - visible?: boolean; - } - /** A markup component used to define markup options for a command. */ - export class dxCommand extends DOMComponent { - constructor(element: JQuery, options: dxCommandOptions); - constructor(options: dxCommandOptions); - /** Executes the action associated with this command. */ - execute(): void; - } - /** An object responsible for routing. */ - export class Router { - /** Adds a routing rule to the list of registered rules. */ - register(pattern: string, defaults?: Object, constraints?: Object): void; - /** Decodes the specified URI to an object using the registered routing rules. */ - parse(uri: string): Object; - /** Formats an object to a URI. */ - format(obj: Object): string; - } - export interface StateManagerOptions { - /** A storage to which the state manager saves the application state. */ - storage?: Object; - } - /** An object used to store the current application state. */ - export class StateManager { - constructor(options?: StateManagerOptions); - /** Adds an object that implements an interface of a state source to the state manager's collection of state sources. */ - addStateSource(stateSource: Object): void; - /** Removes a specified state source from the state manager's collection of state sources. */ - removeStateSource(stateSource: Object): void; - /** Saves the current application state. */ - saveState(): void; - /** Restores the application state that has been saved by the saveState() method to the state storage. */ - restoreState(): void; - /** Removes the application state that has been saved by the saveState() method to the state storage. */ - clearState(): void; - } - export module html { - export var layoutSets: Array; - export var animationSets: { [animationSetName: string]: AnimationSet }; - export interface AnimationSet { - [animationName: string]: any - } - export interface HtmlApplicationOptions { - /** Specifies where the commands that are defined in the application's views must be displayed. */ - commandMapping?: Object; - /** Specifies whether or not view caching is disabled. */ - disableViewCache?: boolean; - /** An array of layout controllers that should be used to show application views in the current navigation context. */ - layoutSet?: any; - /** Specifies the animation presets that are used to animate different UI elements in the current application. */ - animationSet?: AnimationSet; - /** Specifies whether the current application must behave as a mobile or web application. */ - mode?: string; - /** Specifies the object that represents a root namespace of the application. */ - namespace?: Object; - /** Specifies application behavior when the user navigates to a root view. */ - navigateToRootViewMode?: string; - /** An array of dxCommand configuration objects used to define commands available from the application's global navigation. */ - navigation?: Array; - /** A state manager to be used in the application. */ - stateManager?: StateManager; - /** Specifies the storage to be used by the application's state manager to store the application state. */ - stateStorage?: Object; - /** Indicates whether on not to use the title of the previously displayed view as text on the Back button. */ - useViewTitleAsBackText?: boolean; - /** A custom view cache to be used in the application. */ - viewCache?: Object; - /** Specifies a limit for the views that can be cached. */ - viewCacheSize?: number; - /** Specifies options for the viewport meta tag of a mobile browser. */ - viewPort?: JQuery; - /** A custom router to be used in the application. */ - router?: Router; - } - /** An object used to manage views, as well as control the application life cycle. */ - export class HtmlApplication implements EventsMixin { - constructor(options: HtmlApplicationOptions); - afterViewSetup: JQueryCallback; - beforeViewSetup: JQueryCallback; - initialized: JQueryCallback; - navigating: JQueryCallback; - navigatingBack: JQueryCallback; - resolveLayoutController: JQueryCallback; - viewDisposed: JQueryCallback; - viewDisposing: JQueryCallback; - viewHidden: JQueryCallback; - viewRendered: JQueryCallback; - viewShowing: JQueryCallback; - viewShown: JQueryCallback; - /** Provides access to the ViewCache object. */ - viewCache: ViewCache; - /** An array of dxCommand components that are created based on the application's navigation option value. */ - navigation: Array; - /** Provides access to the StateManager object. */ - stateManager: StateManager; - /** Provides access to the Router object. */ - router: Router; - /** Navigates to the URI preceding the current one in the navigation history. */ - back(): void; - /** Returns a Boolean value indicating whether or not backwards navigation is currently possible. */ - canBack(): boolean; - /** Calls the clearState() method of the application's StateManager object. */ - clearState(): void; - /** Creates global navigation commands. */ - createNavigation(navigationConfig: Array): void; - /** Returns an HTML template of the specified view. */ - getViewTemplate(viewName: string): JQuery; - /** Returns a configuration object used to create a dxView component for a specified view. */ - getViewTemplateInfo(viewName: string): Object; - /** Adds a specified HTML template to a collection of view or layout templates. */ - loadTemplates(source: any): JQueryPromise; - /** Navigates to the specified URI. */ - navigate(uri?: any, options?: Object): void; - /** Renders navigation commands to the navigation command containers that are located in the layouts used in the application. */ - renderNavigation(): void; - /** Calls the restoreState() method of the application's StateManager object. */ - restoreState(): void; - /** Calls the saveState method of the application's StateManager object. */ - saveState(): void; - /** Provides access to the object that defines the current context to be considered when choosing an appropriate template for a view. */ - templateContext(): Object; - on(eventName: "initialized", eventHandler: () => void): HtmlApplication; - on(eventName: "afterViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "beforeViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "navigating", eventHandler: (e: { - currentUri: string; - uri: string; - cancel: boolean; - options: { - root: boolean; - target: string; - direction: string; - rootInDetailPane: boolean; - modal: boolean; - }; - }) => void): HtmlApplication; - on(eventName: "navigatingBack", eventHandler: (e: { - cancel: boolean; - isHardwareButton: boolean; - }) => void): HtmlApplication; - on(eventName: "resolveLayoutController", eventHandler: (e: { - viewInfo: Object; - layoutController: Object; - availableLayoutControllers: Array; - }) => void): HtmlApplication; - on(eventName: "viewDisposed", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewDisposing", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewHidden", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewRendered", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewShowing", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - on(eventName: "viewShown", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - on(eventName: string, eventHandler: Function): HtmlApplication; - on(events: { [eventName: string]: Function; }): HtmlApplication; - off(eventName: "initialized"): HtmlApplication; - off(eventName: "afterViewSetup"): HtmlApplication; - off(eventName: "beforeViewSetup"): HtmlApplication; - off(eventName: "navigating"): HtmlApplication; - off(eventName: "navigatingBack"): HtmlApplication; - off(eventName: "resolveLayoutController"): HtmlApplication; - off(eventName: "viewDisposed"): HtmlApplication; - off(eventName: "viewDisposing"): HtmlApplication; - off(eventName: "viewHidden"): HtmlApplication; - off(eventName: "viewRendered"): HtmlApplication; - off(eventName: "viewShowing"): HtmlApplication; - off(eventName: "viewShown"): HtmlApplication; - off(eventName: string): HtmlApplication; - off(eventName: "initialized", eventHandler: () => void): HtmlApplication; - off(eventName: "afterViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "beforeViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "navigating", eventHandler: (e: { - currentUri: string; - uri: string; - cancel: boolean; - options: { - root: boolean; - target: string; - direction: string; - rootInDetailPane: boolean; - modal: boolean; - }; - }) => void): HtmlApplication; - off(eventName: "navigatingBack", eventHandler: (e: { - cancel: boolean; - isHardwareButton: boolean; - }) => void): HtmlApplication; - off(eventName: "resolveLayoutController", eventHandler: (e: { - viewInfo: Object; - layoutController: Object; - availableLayoutControllers: Array; - }) => void): HtmlApplication; - off(eventName: "viewDisposed", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewDisposing", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewHidden", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewRendered", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewShowing", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - off(eventName: "viewShown", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - off(eventName: string, eventHandler: Function): HtmlApplication; - } - } -} -declare namespace DevExpress.viz.core { - /** - * Applies a theme for the entire page with several DevExtreme visualization widgets. - * @deprecated Use the DevExpress.viz.currentTheme(theme) method instead. - */ - export function currentTheme(theme: string): void; - /** - * Applies a new theme (with the color scheme defined separately) for the entire page with several DevExtreme visualization widgets. - * @deprecated Use the DevExpress.viz.currentTheme(platform, colorScheme) method instead. - */ - export function currentTheme(platform: string, colorScheme: string): void; - /** - * Registers a new theme based on the existing one. - * @deprecated Use the DevExpress.viz.registerTheme(customTheme, baseTheme) method instead. - */ - export function registerTheme(customTheme: Object, baseTheme: string): void; - /** - * Applies a predefined or registered custom palette to all visualization widgets at once. - * @deprecated Use the DevExpress.viz.currentPalette(paletteName) method instead. - */ - export function currentPalette(paletteName: string): void; - /** - * Obtains the color sets of a predefined or registered palette. - * @deprecated Use the DevExpress.viz.getPalette(paletteName) method instead. - */ - export function getPalette(paletteName: string): Object; - /** - * Registers a new palette. - * @deprecated Use the DevExpress.viz.registerPalette(paletteName, palette) method instead. - */ - export function registerPalette(paletteName: string, palette: Object): void; - export interface Border { - /** Sets a border color for a selected series. */ - color?: string; - /** Sets border visibility for a selected series. */ - visible?: boolean; - /** Sets a border width for a selected series. */ - width?: number; - } - export interface DashedBorder extends Border { - /** Specifies a dash style for the border of a selected series point. */ - dashStyle?: string; - } - export interface DashedBorderWithOpacity extends DashedBorder { - /** Specifies the opacity of the tooltip's border. */ - opacity?: number; - } - export interface Font { - /** Specifies the font color for a strip label. */ - color?: string; - /** Specifies the font family for a strip label. */ - family?: string; - /** Specifies the font opacity for a strip label. */ - opacity?: number; - /** Specifies the font size for a strip label. */ - size?: any; - /** Specifies the font weight for the text displayed in strips. */ - weight?: number; - } - export interface Hatching { - direction?: string; - /** Specifies the opacity of hatching lines. */ - opacity?: number; - /** Specifies the distance between hatching lines in pixels. */ - step?: number; - /** Specifies the width of hatching lines in pixels. */ - width?: number; - } - export interface Margins { - /** Specifies the legend's bottom margin in pixels. */ - bottom?: number; - /** Specifies the legend's left margin in pixels. */ - left?: number; - /** Specifies the legend's right margin in pixels. */ - right?: number; - /** Specifies the legend's bottom margin in pixels. */ - top?: number; - } - export interface Size { - /** Specifies the width of the widget. */ - width?: number; - /** Specifies the height of the widget. */ - height?: number; - } - export interface Tooltip { - /** Specifies the length of the tooltip's arrow in pixels. */ - arrowLength?: number; - /** Specifies the appearance of the tooltip's border. */ - border?: viz.core.DashedBorderWithOpacity; - /** Specifies a color for the tooltip. */ - color?: string; - /** Specifies the z-index for tooltips. */ - zIndex?: number; - container?: any; - /** Specifies text and appearance of a set of tooltips. */ - customizeTooltip?: (arg: Object) => { color?: string; text?: string }; - /** Specifies whether or not the tooltip is enabled. */ - enabled?: boolean; - /** Specifies font options for the text displayed by the tooltip. */ - font?: Font; - /** Specifies a format for the text displayed by the tooltip. */ - format?: string; - /** Specifies the opacity of a tooltip. */ - opacity?: number; - /** Specifies a distance from the tooltip's left/right boundaries to the inner text in pixels. */ - paddingLeftRight?: number; - /** Specifies a distance from the tooltip's top/bottom boundaries to the inner text in pixels. */ - paddingTopBottom?: number; - /** Specifies a precision for formatted values displayed by the tooltip. */ - precision?: number; - /** Specifies options of the tooltip's shadow. */ - shadow?: { - /** Specifies the blur distance of the tooltip's shadow. */ - blur?: number; - /** Specifies the color of the tooltip's shadow. */ - color?: string; - /** Specifies the horizontal offset of the tooltip's shadow relative to the tooltip in pixels. */ - offsetX?: number; - /** Specifies the vertical offset of the tooltip's shadow relative to the tooltip in pixels. */ - offsetY?: number; - /** Specifies the opacity of the tooltip's shadow. */ - opacity?: number; - }; - } - export interface Animation { - /** Determines how long animation runs. */ - duration?: number; - /** Specifies the animation easing mode. */ - easing?: string; - /** Indicates whether or not animation is enabled. */ - enabled?: boolean; - } - export interface LoadingIndicator { - /** Specifies a color for the loading indicator background. */ - backgroundColor?: string; - /** Specifies font options for the loading indicator text. */ - font?: viz.core.Font; - /** Specifies whether to show the loading indicator or not. */ - show?: boolean; - /** Specifies a text to be displayed by the loading indicator. */ - text?: string; - } - export interface LegendBorder extends viz.core.DashedBorderWithOpacity { - /** Specifies a radius for the corners of the legend border. */ - cornerRadius?: number; - } - export interface BaseLegend { - /** Specifies the color of the legend's background. */ - backgroundColor?: string; - /** Specifies legend border settings. */ - border?: viz.core.LegendBorder; - /** Specifies how many columns must be taken to arrange legend items. */ - columnCount?: number; - /** Specifies the spacing between a pair of neighboring legend columns in pixels. */ - columnItemSpacing?: number; - /** Specifies font options for legend items. */ - font?: viz.core.Font; - /** Specifies the legend's position on the map. */ - horizontalAlignment?: string; - /** Specifies the alignment of legend items. */ - itemsAlignment?: string; - /** Specifies the position of text relative to the item marker. */ - itemTextPosition?: string; - /** Specifies the distance between the legend and the container borders in pixels. */ - margin?: viz.core.Margins; - /** Specifies the size of item markers in the legend in pixels. */ - markerSize?: number; - /** Specifies whether to arrange legend items horizontally or vertically. */ - orientation?: string; - /** Specifies the spacing between the legend left/right border and legend items in pixels. */ - paddingLeftRight?: number; - /** Specifies the spacing between the legend top/bottom border and legend items in pixels. */ - paddingTopBottom?: number; - /** Specifies how many rows must be taken to arrange legend items. */ - rowCount?: number; - /** Specifies the spacing between a pair of neighboring legend rows in pixels. */ - rowItemSpacing?: number; - /** Specifies the legend's position on the map. */ - verticalAlignment?: string; - /** Specifies whether or not the legend is visible on the map. */ - visible?: boolean; - } - export interface BaseWidgetOptions { - drawn?: (widget: Object) => void; - /** A handler for the drawn event. */ - onDrawn?: (e: { - component: BaseWidget; - element: Element; - }) => void; - incidentOccured?: (incidentInfo: { - id: string; - type: string; - args: any; - text: string; - widget: string; - version: string; - }) => void; - /** A handler for the incidentOccurred event. */ - onIncidentOccurred?: ( - component: BaseWidget, - element: Element, - target: { - id: string; - type: string; - args: any; - text: string; - widget: string; - version: string; - } - ) => void; - /** Notifies a widget that it is embedded into an HTML page that uses a path modifier. */ - pathModified?: boolean; - /** Specifies whether or not the widget supports right-to-left representation. */ - rtlEnabled?: boolean; - /** Sets the name of the theme to be used in the widget. */ - theme?: string; - } - /** This section describes options and methods that are common to all widgets. */ - export class BaseWidget extends DOMComponent { - /** Returns the widget's SVG markup. */ - svg(): string; - } -} -declare namespace DevExpress.viz.charts { - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface BaseSeries { - /** Provides information about the state of the series object. */ - fullState: number; - /** Returns the type of the series. */ - type: string; - /** Unselects all the selected points of the series. The points are displayed in an initial style. */ - clearSelection(): void; - /** Gets the color of a particular series. */ - getColor(): string; - /** - * Gets a point from the series point collection based on the specified argument. - * @deprecated getPointsByArg(pointArg).md - */ - getPointByArg(pointArg: any): Object; - /** Gets points from the series point collection based on the specified argument. */ - getPointsByArg(pointArg: any): Array; - /** Gets a point from the series point collection based on the specified point position. */ - getPointByPos(positionIndex: number): Object; - /** Selects the series. The series is displayed in a 'selected' style until another series is selected or the current series is deselected programmatically. */ - select(): void; - /** Selects the specified point. The point is displayed in a 'selected' style. */ - selectPoint(point: BasePoint): void; - /** Deselects the specified point. The point is displayed in an initial style. */ - deselectPoint(point: BasePoint): void; - /** Returns an array of all points in the series. */ - getAllPoints(): Array; - /** Returns visible series points. */ - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface BasePoint { - /** Provides information about the state of the point object. */ - fullState: number; - /** Returns the point's argument value that was set in the data source. */ - originalArgument: any; - /** Returns the point's value that was set in the data source. */ - originalValue: any; - /** Returns the tag of the point. */ - tag: string; - /** Deselects the point. */ - clearSelection(): void; - /** Gets the color of a particular point. */ - getColor(): string; - /** Hides the tooltip of the point. */ - hideTooltip(): void; - /** Provides information about the hover state of a point. */ - isHovered(): any; - /** Provides information about the selection state of a point. */ - isSelected(): any; - /** Selects the point. The point is displayed in a 'selected' style until another point is selected or the current point is deselected programmatically. */ - select(): void; - /** Shows the tooltip of the point. */ - showTooltip(): void; - /** Allows you to obtain the label of a series point. */ - getLabel(): any; - /** Returns the series object to which the point belongs. */ - series: BaseSeries; - } - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface ChartSeries extends BaseSeries { - /** Returns the name of the series pane. */ - pane: string; - /** Returns the name of the value axis of the series. */ - axis: string; - /** Returns the name of the series. */ - name: string; - /** Returns the tag of the series. */ - tag: string; - /** Hides a series. */ - hide(): void; - /** Provides information about the hover state of a series. */ - isHovered(): any; - /** Provides information about the selection state of a series. */ - isSelected(): any; - /** Provides information about the visibility state of a series. */ - isVisible(): boolean; - /** Makes a particular series visible. */ - show(): void; - selectPoint(point: ChartPoint): void; - deselectPoint(point: ChartPoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface ChartPoint extends BasePoint { - /** Contains the close value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalCloseValue: any; - /** Contains the high value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalHighValue: any; - /** Contains the low value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalLowValue: any; - /** Contains the first value of the point. This field is useful for points belonging to a series of the range area or range bar type only. */ - originalMinValue: any; - /** Contains the open value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalOpenValue: any; - /** Contains the size of the bubble as it was set in the data source. This field is useful for points belonging to a series of the bubble type only. */ - size: any; - /** Gets the parameters of the point's minimum bounding rectangle (MBR). */ - getBoundingRect(): { x: number; y: number; width: number; height: number; }; - series: ChartSeries; - } - /** This section describes the methods that can be used in code to manipulate the Label object. */ - export interface Label { - /** Gets the parameters of the label's minimum bounding rectangle (MBR). */ - getBoundingRect(): { x: number; y: number; width: number; height: number; }; - /** Hides the point label. */ - hide(): void; - /** Shows the point label. */ - show(): void; - } - export interface PieSeries extends BaseSeries { - selectPoint(point: PiePoint): void; - deselectPoint(point: PiePoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface PiePoint extends BasePoint { - /** Gets the percentage value of the specific point. */ - percent: any; - /** Provides information about the visibility state of a point. */ - isVisible(): boolean; - /** Makes a specific point visible. */ - show(): void; - /** Hides a specific point. */ - hide(): void; - series: PieSeries; - } - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface PolarSeries extends BaseSeries { - /** Returns the name of the value axis of the series. */ - axis: string; - /** Returns the name of the series. */ - name: string; - /** Returns the tag of the series. */ - tag: string; - /** Hides a series. */ - hide(): void; - /** Provides information about the hover state of a series. */ - isHovered(): any; - /** Provides information about the selection state of a series. */ - isSelected(): any; - /** Provides information about the visibility state of a series. */ - isVisible(): boolean; - /** Makes a particular series visible. */ - show(): void; - selectPoint(point: PolarPoint): void; - deselectPoint(point: PolarPoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface PolarPoint extends BasePoint { - series: PolarSeries; - } - export interface Strip { - /** Specifies a color for a strip. */ - color?: string; - /** An object that defines the label configuration options of a strip. */ - label?: { - /** Specifies the text displayed in a strip. */ - text?: string; - }; - /** Specifies a start value for a strip. */ - startValue?: any; - /** Specifies an end value for a strip. */ - endValue?: any; - } - export interface BaseSeriesConfigLabel { - /** Specifies a format for arguments displayed by point labels. */ - argumentFormat?: string; - /** Specifies a precision for formatted point arguments displayed in point labels. */ - argumentPrecision?: number; - /** Specifies a background color for point labels. */ - backgroundColor?: string; - /** Specifies border options for point labels. */ - border?: viz.core.DashedBorder; - /** Specifies connector options for series point labels. */ - connector?: { - /** Specifies the color of label connectors. */ - color?: string; - /** Indicates whether or not label connectors are visible. */ - visible?: boolean; - /** Specifies the width of label connectors. */ - width?: number; - }; - /** Specifies a callback function that returns the text to be displayed by point labels. */ - customizeText?: (pointInfo: Object) => string; - /** Specifies font options for the text displayed in point labels. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed by point labels. */ - format?: string; - position?: string; - /** Specifies a precision for formatted point values displayed in point labels. */ - precision?: number; - /** Specifies the angle used to rotate point labels from their initial position. */ - rotationAngle?: number; - /** Specifies the visibility of point labels. */ - visible?: boolean; - } - export interface SeriesConfigLabel extends BaseSeriesConfigLabel { - /** Specifies whether or not to show a label when the point has a zero value. */ - showForZeroValues?: boolean; - } - export interface ChartSeriesConfigLabel extends SeriesConfigLabel { - /** Specifies how to align point labels relative to the corresponding data points that they represent. */ - alignment?: string; - /** Specifies how to shift point labels horizontally from their initial positions. */ - horizontalOffset?: number; - /** Specifies how to shift point labels vertically from their initial positions. */ - verticalOffset?: number; - /** Specifies a precision for the percentage values displayed in the labels of a full-stacked-like series. */ - percentPrecision?: number; - } - export interface BaseCommonSeriesConfig { - /** Specifies the data source field that provides arguments for series points. */ - argumentField?: string; - axis?: string; - /** An object defining the label configuration options for a series in the dxChart widget. */ - label?: ChartSeriesConfigLabel; - /** Specifies border options for point labels. */ - border?: viz.core.DashedBorder; - /** Specifies a series color. */ - color?: string; - /** Specifies the dash style of the series' line. */ - dashStyle?: string; - hoverMode?: string; - hoverStyle?: { - /** An object defining the border options for a hovered series. */ - border?: viz.core.DashedBorder; - /**

Sets a color for a series when it is hovered over.

*/ - color?: string; - /** Specifies the dash style for the line in a hovered series. */ - dashStyle?: string; - hatching?: viz.core.Hatching; - /** Specifies the width of a line in a hovered series. */ - width?: number; - }; - /** Specifies whether a chart ignores null data points or not. */ - ignoreEmptyPoints?: boolean; - /** Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed. */ - maxLabelCount?: number; - /** Specifies the minimal length of a displayed bar in pixels. */ - minBarSize?: number; - /** Specifies opacity for a series. */ - opacity?: number; - /** Specifies the series elements to highlight when the series is selected. */ - selectionMode?: string; - selectionStyle?: { - /** An object defining the border options for a selected series. */ - border?: viz.core.DashedBorder; - /** Sets a color for a series when it is selected. */ - color?: string; - /** Specifies the dash style for the line in a selected series. */ - dashStyle?: string; - hatching?: viz.core.Hatching; - /** Specifies the width of a line in a selected series. */ - width?: number; - }; - /** Specifies whether or not to show the series in the chart's legend. */ - showInLegend?: boolean; - /** Specifies the name of the stack where the values of the _stackedBar_ series must be located. */ - stack?: string; - /** Specifies the name of the data source field that provides data about a point. */ - tagField?: string; - /** Specifies the data source field that provides values for series points. */ - valueField?: string; - /** Specifies the visibility of a series. */ - visible?: boolean; - /** Specifies a line width. */ - width?: number; - /** Configures error bars. */ - valueErrorBar?: { - /** Specifies whether error bars must be displayed in full or partially. */ - displayMode?: string; - /** Specifies the data field that provides data for low error values. */ - lowValueField?: string; - /** Specifies the data field that provides data for high error values. */ - highValueField?: string; - /** Specifies how error bar values must be calculated. */ - type?: string; - /** Specifies the value to be used for generating error bars. */ - value?: number; - /** Specifies the color of error bars. */ - color?: string; - /** Specifies the opacity of error bars. */ - opacity?: number; - /** Specifies the length of the lines that indicate the error bar edges. */ - edgeLength?: number; - /** Specifies the width of the error bar line. */ - lineWidth?: number; - }; - } - export interface CommonPointOptions { - /** Specifies border options for points in the line and area series. */ - border?: viz.core.Border; - /** Specifies the points color. */ - color?: string; - /** Specifies what series points to highlight when a point is hovered over. */ - hoverMode?: string; - /** An object defining configuration options for a hovered point. */ - hoverStyle?: { - /** An object defining the border options for a hovered point. */ - border?: viz.core.Border; - /** Sets a color for a point when it is hovered over. */ - color?: string; - /** Specifies the diameter of a hovered point in the series that represents data points as symbols (not as bars for instance). */ - size?: number; - }; - /** Specifies what series points to highlight when a point is selected. */ - selectionMode?: string; - /** An object defining configuration options for a selected point. */ - selectionStyle?: { - /** An object defining the border options for a selected point. */ - border?: viz.core.Border; - /**

Sets a color for a point when it is selected.

*/ - color?: string; - /** Specifies the diameter of a selected point in the series that represents data points as symbols (not as bars for instance). */ - size?: number; - }; - /** Specifies the point diameter in pixels for those series that represent data points as symbols (not as bars for instance). */ - size?: number; - /** Specifies a symbol for presenting points of the line and area series. */ - symbol?: string; - visible?: boolean; - } - export interface ChartCommonPointOptions extends CommonPointOptions { - /** An object specifying the parameters of an image that is used as a point marker. */ - image?: { - /** Specifies the height of an image that is used as a point marker. */ - height?: any; - /** Specifies a URL leading to the image to be used as a point marker. */ - url?: any; - /** Specifies the width of an image that is used as a point marker. */ - width?: any; - }; - } - export interface PolarCommonPointOptions extends CommonPointOptions { - /** An object specifying the parameters of an image that is used as a point marker. */ - image?: { - /** Specifies the height of an image that is used as a point marker. */ - height?: number; - /** Specifies a URL leading to the image to be used as a point marker. */ - url?: string; - /** Specifies the width of an image that is used as a point marker. */ - width?: number; - }; - } - /** An object that defines configuration options for chart series. */ - export interface CommonSeriesConfig extends BaseCommonSeriesConfig { - /** Specifies the data source field that provides a 'close' value for a _candleStick_ or _stock_ series. */ - closeValueField?: string; - /** Specifies a radius for bar corners. */ - cornerRadius?: number; - /** Specifies the data source field that provides a 'high' value for a _candleStick_ or _stock_ series. */ - highValueField?: string; - /** Specifies the color for the body (rectangle) of a _candleStick_ series. */ - innerColor?: string; - /** Specifies the data source field that provides a 'low' value for a _candleStick_ or _stock_ series. */ - lowValueField?: string; - /** Specifies the data source field that provides an 'open' value for a _candleStick_ or _stock_ series. */ - openValueField?: string; - /** Specifies the pane that will be used to display a series. */ - pane?: string; - /** An object defining configuration options for points in line-, scatter- and area-like series. */ - point?: ChartCommonPointOptions; - /** Specifies the data source field that provides values for one end of a range series. To set the data source field for the other end of the range series, use the rangeValue2Field property. */ - rangeValue1Field?: string; - /** Specifies the data source field that provides values for the second end of a range series. To set the data source field for the other end of the range series, use the rangeValue1Field property. */ - rangeValue2Field?: string; - /** Specifies reduction options for the stock or candleStick series. */ - reduction?: { - /** Specifies a color for the points whose reduction level price is lower in comparison to the value in the previous point. */ - color?: string; - /** Specifies for which price level (open, high, low or close) to enable reduction options in the series. */ - level?: string; - }; - /** Specifies the data source field that defines the size of bubbles. */ - sizeField?: string; - } - export interface CommonSeriesSettings extends CommonSeriesConfig { - /**

An object that specifies configuration options for all series of the area type in the chart.

*/ - area?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _bar_ type in the chart. */ - bar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the bubble type in the chart. */ - bubble?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _candleStick_ type in the chart. */ - candlestick?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _fullStackedArea_ type in the chart. */ - fullstackedarea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Full-Stacked Spline Area type in the chart. */ - fullstackedsplinearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _fullStackedBar_ type in the chart. */ - fullstackedbar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _fullStackedLine_ type in the chart. */ - fullstackedline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Full-Stacked Spline type in the chart. */ - fullstackedspline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _line_ type in the chart. */ - line?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _rangeArea_ type in the chart. */ - rangearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _rangeBar_ type in the chart. */ - rangebar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _scatter_ type in the chart. */ - scatter?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _spline_ type in the chart. */ - spline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _splineArea_ type in the chart. */ - splinearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedArea_ type in the chart. */ - stackedarea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Stacked Spline Area type in the chart. */ - stackedsplinearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedBar_ type in the chart. */ - stackedbar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedLine_ type in the chart. */ - stackedline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Stacked Spline type in the chart. */ - stackedspline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stepArea_ type in the chart. */ - steparea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stepLine_ type in the chart. */ - stepline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stock_ type in the chart. */ - stock?: CommonSeriesConfig; - /** Sets a series type. */ - type?: string; - } - export interface SeriesConfig extends CommonSeriesConfig { - /** Specifies the name that identifies the series. */ - name?: string; - /** Specifies data about a series. */ - tag?: any; - /** Sets the series type. */ - type?: string; - } - /** An object that defines configuration options for polar chart series. */ - export interface CommonPolarSeriesConfig extends BaseCommonSeriesConfig { - /** Specifies whether or not to close the chart by joining the end point with the first point. */ - closed?: boolean; - label?: SeriesConfigLabel; - point?: PolarCommonPointOptions; - } - export interface CommonPolarSeriesSettings extends CommonPolarSeriesConfig { - /** An object that specifies configuration options for all series of the area type in the chart. */ - area?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _bar_ type in the chart. */ - bar?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _line_ type in the chart. */ - line?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _scatter_ type in the chart. */ - scatter?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedBar_ type in the chart. */ - stackedbar?: CommonPolarSeriesConfig; - /** Sets a series type. */ - type?: string; - } - export interface PolarSeriesConfig extends CommonPolarSeriesConfig { - /** Specifies the name that identifies the series. */ - name?: string; - /** Specifies data about a series. */ - tag?: any; - /** Sets the series type. */ - type?: string; - } - export interface PieSeriesConfigLabel extends BaseSeriesConfigLabel { - /** Specifies how to shift labels from their initial position in a radial direction in pixels. */ - radialOffset?: number; - /** Specifies a precision for the percentage values displayed in labels. */ - percentPrecision?: number; - } - /** An object that defines configuration options for chart series. */ - export interface CommonPieSeriesConfig { - /** Specifies the data source field that provides arguments for series points. */ - argumentField?: string; - /** Specifies the required type for series arguments. */ - argumentType?: string; - /** An object defining the series border configuration options. */ - border?: viz.core.DashedBorder; - /** Specifies a series color. */ - color?: string; - /** Specifies the chart elements to highlight when a series is hovered over. */ - hoverMode?: string; - /** An object defining configuration options for a hovered series. */ - hoverStyle?: { - /** An object defining the border options for a hovered series. */ - border?: viz.core.DashedBorder; - /** Sets a color for the series when it is hovered over. */ - color?: string; - /** Specifies the hatching options to be applied when a point is hovered over. */ - hatching?: viz.core.Hatching; - }; - /** Specifies the fraction of the inner radius relative to the total radius in the series of the 'doughnut' type. */ - innerRadius?: number; - /** An object defining the label configuration options. */ - label?: PieSeriesConfigLabel; - /** Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed. */ - maxLabelCount?: number; - /** Specifies a minimal size of a displayed pie segment. */ - minSegmentSize?: number; - /** Specifies the direction in which the dxPieChart's series points are located. */ - segmentsDirection?: string; - /**

Specifies the chart elements to highlight when the series is selected.

*/ - selectionMode?: string; - /** An object defining configuration options for the series when it is selected. */ - selectionStyle?: { - /** An object defining the border options for a selected series. */ - border?: viz.core.DashedBorder; - /** Sets a color for a series when it is selected. */ - color?: string; - /** Specifies the hatching options to be applied when a point is selected. */ - hatching?: viz.core.Hatching; - }; - /** Specifies chart segment grouping options. */ - smallValuesGrouping?: { - /** Specifies the name of the grouped chart segment. This name represents the segment in the chart legend. */ - groupName?: string; - /** Specifies the segment grouping mode. */ - mode?: string; - /** Specifies a threshold for segment values. */ - threshold?: number; - /** Specifies how many segments must not be grouped. */ - topCount?: number; - }; - /** Specifies a start angle for a pie chart in arc degrees. */ - startAngle?: number; - /**

Specifies the name of the data source field that provides data about a point.

*/ - tagField?: string; - /** Specifies the data source field that provides values for series points. */ - valueField?: string; - } - export interface PieSeriesConfig extends CommonPieSeriesConfig { - /** Sets the series type. */ - type?: string; - } - export interface SeriesTemplate { - /** Specifies a callback function that returns a series object with individual series settings. */ - customizeSeries?: (seriesName: string) => SeriesConfig; - /** Specifies a data source field that represents the series name. */ - nameField?: string; - } - export interface PolarSeriesTemplate { - /** Specifies a callback function that returns a series object with individual series settings. */ - customizeSeries?: (seriesName: string) => PolarSeriesConfig; - /** Specifies a data source field that represents the series name. */ - nameField?: string; - } - export interface ChartCommonConstantLineLabel { - /** Specifies font options for a constant line label. */ - font?: viz.core.Font; - /** Specifies the position of the constant line label relative to the chart plot. */ - position?: string; - /** Indicates whether or not to display labels for the axis constant lines. */ - visible?: boolean; - } - export interface PolarCommonConstantLineLabel { - /** Indicates whether or not to display labels for the axis constant lines. */ - visible?: boolean; - /** Specifies font options for a constant line label. */ - font?: viz.core.Font; - } - export interface ConstantLineStyle { - /** Specifies a color for a constant line. */ - color?: string; - /** Specifies a dash style for a constant line. */ - dashStyle?: string; - /** Specifies a constant line width in pixels. */ - width?: number; - } - export interface ChartCommonConstantLineStyle extends ConstantLineStyle { - /** An object defining constant line label options. */ - label?: ChartCommonConstantLineLabel; - /** Specifies the space between the constant line label and the left/right side of the constant line. */ - paddingLeftRight?: number; - /** Specifies the space between the constant line label and the top/bottom side of the constant line. */ - paddingTopBottom?: number; - } - export interface PolarCommonConstantLineStyle extends ConstantLineStyle { - /** An object defining constant line label options. */ - label?: PolarCommonConstantLineLabel; - } - export interface CommonAxisLabel { - /** Specifies font options for axis labels. */ - font?: viz.core.Font; - /** Specifies the spacing between an axis and its labels in pixels. */ - indentFromAxis?: number; - /** Indicates whether or not axis labels are visible. */ - visible?: boolean; - } - export interface ChartCommonAxisLabel extends CommonAxisLabel { - /** Specifies the label's position relative to the tick (grid line). */ - alignment?: string; - /** Specifies the overlap resolving algorithm to be applied to axis labels. */ - overlappingBehavior?: { - /** Specifies how to arrange axis labels. */ - mode?: string; - /** Specifies the angle used to rotate axis labels. */ - rotationAngle?: number; - /** Specifies the spacing that must be set between staggered rows when the 'stagger' algorithm is applied. */ - staggeringSpacing?: number; - }; - } - export interface PolarCommonAxisLabel extends CommonAxisLabel { - /** Specifies the overlap resolving algorithm to be applied to axis labels. */ - overlappingBehavior?: string; - } - export interface CommonAxisTitle { - /** Specifies font options for an axis title. */ - font?: viz.core.Font; - /** Specifies a margin for an axis title in pixels. */ - margin?: number; - } - export interface BaseCommonAxisSettings { - /** Specifies the color of the line that represents an axis. */ - color?: string; - /** Specifies whether ticks/grid lines of a discrete axis are located between labels or cross the labels. */ - discreteAxisDivisionMode?: string; - /** An object defining the configuration options for the grid lines of an axis in the dxPolarChart widget. */ - grid?: { - /** Specifies a color for grid lines. */ - color?: string; - /** Specifies an opacity for grid lines. */ - opacity?: number; - /** Indicates whether or not the grid lines of an axis are visible. */ - visible?: boolean; - /** Specifies the width of grid lines. */ - width?: number; - }; - /** Specifies the options of the minor grid. */ - minorGrid?: { - /** Specifies a color for the lines of the minor grid. */ - color?: string; - /** Specifies an opacity for the lines of the minor grid. */ - opacity?: number; - /** Indicates whether the minor grid is visible or not. */ - visible?: boolean; - /** Specifies a width for the lines of the minor grid. */ - width?: number; - }; - /** Indicates whether or not an axis is inverted. */ - inverted?: boolean; - /** Specifies the opacity of the line that represents an axis. */ - opacity?: number; - /** Indicates whether or not to set ticks/grid lines of a continuous axis of the 'date-time' type at the beginning of each date-time interval. */ - setTicksAtUnitBeginning?: boolean; - /** An object defining the configuration options for axis ticks. */ - tick?: { - /** Specifies ticks color. */ - color?: string; - /** Specifies tick opacity. */ - opacity?: number; - /** Indicates whether or not ticks are visible on an axis. */ - visible?: boolean; - }; - /** Specifies the options of the minor ticks. */ - minorTick?: { - /** Specifies a color for the minor ticks. */ - color?: string; - /** Specifies an opacity for the minor ticks. */ - opacity?: number; - /** Indicates whether or not the minor ticks are displayed on an axis. */ - visible?: boolean; - }; - /** Indicates whether or not the line that represents an axis in a chart is visible. */ - visible?: boolean; - /** Specifies the width of the line that represents an axis in the chart. */ - width?: number; - } - export interface ChartCommonAxisSettings extends BaseCommonAxisSettings { - /** Specifies the appearance of all the widget's constant lines. */ - constantLineStyle?: ChartCommonConstantLineStyle; - /** An object defining the label configuration options that are common for all axes in the dxChart widget. */ - label?: ChartCommonAxisLabel; - /** Specifies a coefficient that determines the spacing between the maximum series point and the axis. */ - maxValueMargin?: number; - /** Specifies a coefficient that determines the spacing between the minimum series point and the axis. */ - minValueMargin?: number; - /** Specifies, in pixels, the space reserved for an axis. */ - placeholderSize?: number; - /** An object defining configuration options for strip style. */ - stripStyle?: { - /** An object defining the configuration options for a strip label style. */ - label?: { - /** Specifies font options for a strip label. */ - font?: viz.core.Font; - /** Specifies the label's position on a strip. */ - horizontalAlignment?: string; - /** Specifies a label's position on a strip. */ - verticalAlignment?: string; - }; - /** Specifies the spacing, in pixels, between the left/right strip border and the strip label. */ - paddingLeftRight?: number; - /** Specifies the spacing, in pixels, between the top/bottom strip borders and the strip label. */ - paddingTopBottom?: number; - }; - /** An object defining the title configuration options that are common for all axes in the dxChart widget. */ - title?: CommonAxisTitle; - /** Indicates whether or not to display series with indents from axis boundaries. */ - valueMarginsEnabled?: boolean; - } - export interface PolarCommonAxisSettings extends BaseCommonAxisSettings { - /** Specifies the appearance of all the widget's constant lines. */ - constantLineStyle?: PolarCommonConstantLineStyle; - /** An object defining the label configuration options that are common for all axes in the dxPolarChart widget. */ - label?: PolarCommonAxisLabel; - /** An object defining configuration options for strip style. */ - stripStyle?: { - /** An object defining the configuration options for a strip label style. */ - label?: { - /** Specifies font options for a strip label. */ - font?: viz.core.Font; - }; - }; - } - export interface ChartConstantLineLabel extends ChartCommonConstantLineLabel { - /** Specifies the horizontal alignment of a constant line label. */ - horizontalAlignment?: string; - /** Specifies the vertical alignment of a constant line label. */ - verticalAlignment?: string; - /** Specifies the text to be displayed in a constant line label. */ - text?: string; - } - export interface PolarConstantLineLabel extends PolarCommonConstantLineLabel { - /** Specifies the text to be displayed in a constant line label. */ - text?: string; - } - export interface AxisLabel { - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a label on the value axis. */ - customizeHint?: (argument: { value: any; valueText: string }) => string; - /** Specifies a callback function that returns the text to be displayed in value axis labels. */ - customizeText?: (argument: { value: any; valueText: string }) => string; - /** Specifies a format for the text displayed by axis labels. */ - format?: string; - /** Specifies a precision for the formatted value displayed in the axis labels. */ - precision?: number; - } - export interface ChartAxisLabel extends ChartCommonAxisLabel, AxisLabel { } - export interface PolarAxisLabel extends PolarCommonAxisLabel, AxisLabel { } - export interface AxisTitle extends CommonAxisTitle { - /** Specifies the text for the value axis title. */ - text?: string; - } - export interface ChartConstantLineStyle extends ChartCommonConstantLineStyle { - /** An object defining constant line label options. */ - label?: ChartConstantLineLabel; - } - export interface ChartConstantLine extends ChartConstantLineStyle { - /** An object defining constant line label options. */ - label?: ChartConstantLineLabel; - /** Specifies a value to be displayed by a constant line. */ - value?: any; - } - export interface PolarConstantLine extends PolarCommonConstantLineStyle { - /** An object defining constant line label options. */ - label?: PolarConstantLineLabel; - /** Specifies a value to be displayed by a constant line. */ - value?: any; - } - export interface Axis { - /** Specifies a coefficient for dividing the value axis. */ - axisDivisionFactor?: number; - /** Specifies the order in which discrete values are arranged on the value axis. */ - categories?: Array; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic axis. */ - logarithmBase?: number; - /** Specifies an interval between axis ticks/grid lines. */ - tickInterval?: any; - /** Specifies the interval between minor ticks. */ - minorTickInterval?: any; - /** Specifies the number of minor ticks between two neighboring major ticks. */ - minorTickCount?: number; - /** Specifies the required type of the value axis. */ - type?: string; - /** Specifies the pane on which the current value axis will be displayed. */ - pane?: string; - /** Specifies options for value axis strips. */ - strips?: Array; - } - export interface ChartAxis extends ChartCommonAxisSettings, Axis { - /** Defines an array of the value axis constant lines. */ - constantLines?: Array; - /** Specifies the appearance options for the constant lines of the value axis. */ - constantLineStyle?: ChartCommonConstantLineStyle; - /** Specifies options for value axis labels. */ - label?: ChartAxisLabel; - /** Specifies the maximum value on the value axis. */ - max?: any; - /** Specifies the minimum value on the value axis. */ - min?: any; - /** Specifies the position of the value axis on a chart. */ - position?: string; - /** Specifies the title for a value axis. */ - title?: AxisTitle; - } - export interface PolarAxis extends PolarCommonAxisSettings, Axis { - /** Defines an array of the value axis constant lines. */ - constantLines?: Array; - /** Specifies options for value axis labels. */ - label?: PolarAxisLabel; - } - export interface ArgumentAxis { - /** Specifies the desired type of axis values. */ - argumentType?: string; - /** Specifies the elements that will be highlighted when the argument axis is hovered over. */ - hoverMode?: string; - } - export interface ChartArgumentAxis extends ChartAxis, ArgumentAxis { } - export interface PolarArgumentAxis extends PolarAxis, ArgumentAxis { - /** Specifies a start angle for the argument axis in degrees. */ - startAngle?: number; - /** Specifies whether or not to display the first point at the angle specified by the startAngle option. */ - firstPointOnStartAngle?: boolean; - /** Specifies the period of the argument values in the data source. */ - period?: number; - } - export interface ValueAxis { - /** Specifies the name of the value axis. */ - name?: string; - /** Specifies whether or not to indicate a zero value on the value axis. */ - showZero?: boolean; - /** Specifies the desired type of axis values. */ - valueType?: string; - } - export interface ChartValueAxis extends ChartAxis, ValueAxis { - /** Specifies the spacing, in pixels, between multiple value axes in a chart. */ - multipleAxesSpacing?: number; - /** Specifies the value by which the chart's value axes are synchronized. */ - synchronizedValue?: number; - } - export interface PolarValueAxis extends PolarAxis, ValueAxis { - /** Indicates whether to display series with indents from axis boundaries. */ - valueMarginsEnabled?: boolean; - /** Specifies a coefficient that determines the spacing between the maximum series point and the axis. */ - maxValueMargin?: number; - /** Specifies a coefficient that determines the spacing between the minimum series point and the axis. */ - minValueMargin?: number; - tick?: { - visible?: boolean; - } - } - export interface CommonPane { - /** Specifies a background color in a pane. */ - backgroundColor?: string; - /** Specifies the border options of a chart's pane. */ - border?: PaneBorder; - } - export interface Pane extends CommonPane { - /** Specifies the name of a pane. */ - name?: string; - } - export interface PaneBorder extends viz.core.DashedBorderWithOpacity { - /** Specifies the bottom border's visibility state in a pane. */ - bottom?: boolean; - /** Specifies the left border's visibility state in a pane. */ - left?: boolean; - /** Specifies the right border's visibility state in a pane. */ - right?: boolean; - /** Specifies the top border's visibility state in a pane. */ - top?: boolean; - } - export interface ChartAnimation extends viz.core.Animation { - /** Specifies the maximum series point count in the chart that the animation supports. */ - maxPointCountSupported?: number; - } - export interface BaseChartTooltip extends viz.core.Tooltip { - /** Specifies a format for arguments of the chart's series points. */ - argumentFormat?: string; - /** Specifies a precision for formatted arguments displayed in tooltips. */ - argumentPrecision?: number; - /** Specifies a precision for a percent value displayed in tooltips for stacked series and dxPieChart series. */ - percentPrecision?: number; - } - export interface BaseChartOptions extends viz.core.BaseWidgetOptions { - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - /** Specifies the width of the widget that is small enough for the layout to begin adapting. */ - width?: number; - /** Specifies the height of the widget that is small enough for the layout to begin adapting. */ - height?: number; - /** Specifies whether or not point labels can be hidden when the layout is adapting. */ - keepLabels?: boolean; - }; - /** Specifies animation options. */ - animation?: ChartAnimation; - /** Specifies a callback function that returns an object with options for a specific point label. */ - customizeLabel?: (labelInfo: Object) => Object; - /** Specifies a callback function that returns an object with options for a specific point. */ - customizePoint?: (pointInfo: Object) => Object; - /** Specifies a data source for the chart. */ - dataSource?: any; - done?: Function; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies options of a dxChart's (dxPieChart's) legend. */ - legend?: core.BaseLegend; - /** Specifies the blank space between the chart's extreme elements and the boundaries of the area provided for the widget (see size) in pixels. */ - margin?: viz.core.Margins; - /** Sets the name of the palette to be used in the chart. Alternatively, an array of colors can be set as a custom palette to be used within this chart. */ - palette?: any; - /** A handler for the done event. */ - onDone?: (e: { - component: BaseChart; - element: Element; - }) => void; - /** A handler for the pointClick event. */ - onPointClick?: any; - pointClick?: any; - /** A handler for the pointHoverChanged event. */ - onPointHoverChanged?: (e: { - component: BaseChart; - element: Element; - target: TPoint; - }) => void; - pointHoverChanged?: (point: TPoint) => void; - /** A handler for the pointSelectionChanged event. */ - onPointSelectionChanged?: (e: { - component: BaseChart; - element: Element; - target: TPoint; - }) => void; - pointSelectionChanged?: (point: TPoint) => void; - /** Specifies whether a single point or multiple points can be selected in the chart. */ - pointSelectionMode?: string; - /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */ - redrawOnResize?: boolean; - /** Specifies options for the dxChart and dxPieChart widget series. */ - series?: any; - /** Specifies the size of the widget in pixels. */ - size?: viz.core.Size; - /** Specifies a title for the chart. */ - title?: { - /** Specifies font options for the title. */ - font?: viz.core.Font; - /** Specifies the title's horizontal position in the chart. */ - horizontalAlignment?: string; - /** Specifies a title's position on the chart in the vertical direction. */ - verticalAlignment?: string; - /** Specifies the distance between the title and surrounding chart elements in pixels. */ - margin?: viz.core.Margins; - /** Specifies the height of the space reserved for the title. */ - placeholderSize?: number; - /** Specifies a text for the chart's title. */ - text?: string; - }; - /** Specifies tooltip options. */ - tooltip?: BaseChartTooltip; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: BaseChart; - element: Element; - target: BasePoint; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: BaseChart; - element: Element; - target: BasePoint; - }) => void; - tooltipHidden?: (point: TPoint) => void; - tooltipShown?: (point: TPoint) => void; - } - /** A base class for all chart widgets included in the ChartJS library. */ - export class BaseChart extends viz.core.BaseWidget { - /** Deselects the chart's selected series. The series is displayed in an initial style. */ - clearSelection(): void; - /** Gets the current size of the widget. */ - getSize(): { width: number; height: number }; - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Hides all widget tooltips. */ - hideTooltip(): void; - /** Redraws a widget. */ - render(renderOptions?: { - force?: boolean; - animate?: boolean; - asyncSeriesRendering?: boolean; - }): void; - } - export interface AdvancedLegend extends core.BaseLegend { - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item. */ - customizeHint?: (seriesInfo: { seriesName: string; seriesIndex: number; seriesColor: string; }) => string; - /**

Specifies a callback function that returns the text to be displayed by legend items.

*/ - customizeText?: (seriesInfo: { seriesName: string; seriesIndex: number; seriesColor: string; }) => string; - /** Specifies what series elements to highlight when a corresponding item in the legend is hovered over. */ - hoverMode?: string; - } - export interface AdvancedOptions extends BaseChartOptions { - /** A handler for the argumentAxisClick event. */ - onArgumentAxisClick?: any; - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** An object providing options for managing data from a data source. */ - dataPrepareSettings?: { - /** Specifies whether or not to validate the values from a data source. */ - checkTypeForAllData?: boolean; - /** Specifies whether or not to convert the values from a data source into the data type of an axis. */ - convertToAxisDataType?: boolean; - /** Specifies how to sort the series points. */ - sortingMethod?: any; - }; - /** A handler for the legendClick event. */ - onLegendClick?: any; - /** A handler for the seriesClick event. */ - onSeriesClick?: any; - /** A handler for the seriesHoverChanged event. */ - onSeriesHoverChanged?: (e: { - component: BaseChart; - element: Element; - target: TSeries; - }) => void; - /** A handler for the seriesSelectionChanged event. */ - onSeriesSelectionChanged?: (e: { - component: BaseChart; - element: Element; - target: TSeries; - }) => void; - /** Specifies whether a single series or multiple series can be selected in the chart. */ - seriesSelectionMode?: string; - /** Specifies how the chart must behave when series point labels overlap. */ - resolveLabelOverlapping?: string; - } - export interface Legend extends AdvancedLegend { - /** Specifies whether the legend is located outside or inside the chart's plot. */ - position?: string; - } - export interface ChartTooltip extends BaseChartTooltip { - /** Specifies whether the tooltip must be located in the center of a bar or on its edge. Applies to the Bar and Bubble series. */ - location?: string; - /** Specifies the kind of information to display in a tooltip. */ - shared?: boolean; - } - export interface dxChartOptions extends AdvancedOptions { - /** Specifies a value indicating whether all bars in a series must have the same width, or may have different widths if any points in other series are missing. */ - equalBarWidth?: any; - adaptiveLayout?: { - keepLabels?: boolean; - }; - /** Indicates whether or not to synchronize value axes when they are displayed on a single pane. */ - synchronizeMultiAxes?: boolean; - /** Specifies whether or not to filter the series points depending on their quantity. */ - useAggregation?: boolean; - /** Indicates whether or not to adjust a value axis to the current minimum and maximum values of a zoomed chart. */ - adjustOnZoom?: boolean; - /** Specifies argument axis options for the dxChart widget. */ - argumentAxis?: ChartArgumentAxis; - argumentAxisClick?: any; - /** An object defining the configuration options that are common for all axes of the dxChart widget. */ - commonAxisSettings?: ChartCommonAxisSettings; - /** An object defining the configuration options that are common for all panes in the dxChart widget. */ - commonPaneSettings?: CommonPane; - /** An object defining the configuration options that are common for all series of the dxChart widget. */ - commonSeriesSettings?: CommonSeriesSettings; - /** An object that specifies the appearance options of the chart crosshair. */ - crosshair?: { - /** Specifies a color for the crosshair lines. */ - color?: string; - /** Specifies a dash style for the crosshair lines. */ - dashStyle?: string; - /** Specifies whether to enable the crosshair or not. */ - enabled?: boolean; - /** Specifies the opacity of the crosshair lines. */ - opacity?: number; - /** Specifies the width of the crosshair lines. */ - width?: number; - /** Specifies the appearance of the horizontal crosshair line. */ - horizontalLine?: CrosshaierWithLabel; - /** Specifies the appearance of the vertical crosshair line. */ - verticalLine?: CrosshaierWithLabel; - /** Specifies the options of the crosshair labels. */ - label?: { - /** Specifies a color for the background of the crosshair labels. */ - backgroundColor?: string; - /** Specifies whether the crosshair labels are visible or not. */ - visible?: boolean; - /** Specifies font options for the text of the crosshair labels. */ - font?: viz.core.Font; - } - }; - /** Specifies a default pane for the chart's series. */ - defaultPane?: string; - /** Specifies a coefficient determining the diameter of the largest bubble. */ - maxBubbleSize?: number; - /** Specifies the diameter of the smallest bubble measured in pixels. */ - minBubbleSize?: number; - /** Defines the dxChart widget's pane(s). */ - panes?: Array; - /** Swaps the axes round so that the value axis becomes horizontal and the argument axes becomes vertical. */ - rotated?: boolean; - /** Specifies the options of a chart's legend. */ - legend?: Legend; - /** Specifies options for dxChart widget series. */ - series?: Array; - legendClick?: any; - seriesClick?: any; - seriesHoverChanged?: (series: ChartSeries) => void; - seriesSelectionChanged?: (series: ChartSeries) => void; - /** Defines options for the series template. */ - seriesTemplate?: SeriesTemplate; - /** Specifies tooltip options. */ - tooltip?: ChartTooltip; - /** Specifies value axis options for the dxChart widget. */ - valueAxis?: Array; - /** Enables scrolling in your chart. */ - scrollingMode?: string; - /** Enables zooming in your chart. */ - zoomingMode?: string; - /** Specifies the settings of the scroll bar. */ - scrollBar?: { - /** Specifies whether the scroll bar is visible or not. */ - visible?: boolean; - /** Specifies the spacing between the scroll bar and the chart's plot in pixels. */ - offset?: number; - /** Specifies the color of the scroll bar. */ - color?: string; - /** Specifies the width of the scroll bar in pixels. */ - width?: number; - /** Specifies the opacity of the scroll bar. */ - opacity?: number; - /** Specifies the position of the scroll bar in the chart. */ - position?: string; - }; - } - /** A widget used to embed charts into HTML JS applications. */ - export class dxChart extends BaseChart { - constructor(element: JQuery, options?: dxChartOptions); - constructor(element: Element, options?: dxChartOptions); - /** Returns an array of all series in the chart. */ - getAllSeries(): Array; - /** Gets a series within the chart's series collection by the specified name (see the name option). */ - getSeriesByName(seriesName: string): ChartSeries; - /** Gets a series within the chart's series collection by its position number. */ - getSeriesByPos(seriesIndex: number): ChartSeries; - /** Sets the specified start and end values for the chart's argument axis. */ - zoomArgument(startValue: any, endValue: any): void; - } - interface CrosshaierWithLabel extends viz.core.DashedBorderWithOpacity { - /** Configures the label that belongs to the horizontal crosshair line. */ - label?: { - /** Specifies a color for the background of the label that belongs to the horizontal crosshair line. */ - backgroundColor?: string; - /** Specifies whether the label of the horizontal crosshair line is visible or not. */ - visible?: boolean; - /** Specifies font options for the text of the label that belongs to the horizontal crosshair line. */ - font?: viz.core.Font; - } - } - export interface PolarChartTooltip extends BaseChartTooltip { - /** Specifies the kind of information to display in a tooltip. */ - shared?: boolean; - } - export interface dxPolarChartOptions extends AdvancedOptions { - /** Specifies a value indicating whether all bars in a series must have the same angle, or may have different angles if any points in other series are missing. */ - equalBarWidth?: boolean; - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - width?: number; - height?: number; - /** Specifies whether or not point labels can be hidden when the layout is adapting. */ - keepLabels?: boolean; - }; - /** Indicates whether or not to display a "spider web". */ - useSpiderWeb?: boolean; - /** Specifies argument axis options for the dxPolarChart widget. */ - argumentAxis?: PolarArgumentAxis; - /** An object defining the configuration options that are common for all axes of the dxPolarChart widget. */ - commonAxisSettings?: PolarCommonAxisSettings; - /** An object defining the configuration options that are common for all series of the dxPolarChart widget. */ - commonSeriesSettings?: CommonPolarSeriesSettings; - /** Specifies the options of a chart's legend. */ - legend?: AdvancedLegend; - /** Specifies options for dxPolarChart widget series. */ - series?: Array; - /** Defines options for the series template. */ - seriesTemplate?: PolarSeriesTemplate; - /** Specifies tooltip options. */ - tooltip?: PolarChartTooltip; - /** Specifies value axis options for the dxPolarChart widget. */ - valueAxis?: PolarValueAxis; - } - /** A chart widget displaying data in a polar coordinate system. */ - export class dxPolarChart extends BaseChart { - constructor(element: JQuery, options?: dxPolarChartOptions); - constructor(element: Element, options?: dxPolarChartOptions); - /** Returns an array of all series in the chart. */ - getAllSeries(): Array; - /** Gets a series within the chart's series collection by the specified name (see the name option). */ - getSeriesByName(seriesName: string): PolarSeries; - /** Gets a series within the chart's series collection by its position number. */ - getSeriesByPos(seriesIndex: number): PolarSeries; - } - export interface PieLegend extends core.BaseLegend { - /** Specifies what chart elements to highlight when a corresponding item in the legend is hovered over. */ - hoverMode?: string; - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item. */ - customizeHint?: (pointInfo: { pointName: string; pointIndex: number; pointColor: string; }) => string; - /** Specifies a callback function that returns the text to be displayed by a legend item. */ - customizeText?: (pointInfo: { pointName: string; pointIndex: number; pointColor: string; }) => string; - } - export interface dxPieChartOptions extends BaseChartOptions { - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - /** Specifies whether or not point labels can be hidden when the layout is adapting. */ - keepLabels?: boolean; - }; - /** Specifies dxPieChart legend options. */ - legend?: PieLegend; - /** Specifies options for the series of the dxPieChart widget. */ - series?: Array; - /** Specifies the diameter of the pie. */ - diameter?: number; - /** A handler for the legendClick event. */ - onLegendClick?: any; - legendClick?: any; - /** Specifies how a chart must behave when series point labels overlap. */ - resolveLabelOverlapping?: string; - } - /** A circular chart widget for HTML JS applications. */ - export class dxPieChart extends BaseChart { - constructor(element: JQuery, options?: dxPieChartOptions); - constructor(element: Element, options?: dxPieChartOptions); - /** Provides access to the dxPieChart series. */ - getSeries(): PieSeries; - } -} -interface JQuery { - dxChart(options?: DevExpress.viz.charts.dxChartOptions): JQuery; - dxChart(methodName: string, ...params: any[]): any; - dxChart(methodName: "instance"): DevExpress.viz.charts.dxChart; - dxPieChart(options?: DevExpress.viz.charts.dxPieChartOptions): JQuery; - dxPieChart(methodName: string, ...params: any[]): any; - dxPieChart(methodName: "instance"): DevExpress.viz.charts.dxPieChart; - dxPolarChart(options?: DevExpress.viz.charts.dxPolarChartOptions): JQuery; - dxPolarChart(methodName: string, ...params: any[]): any; - dxPolarChart(methodName: "instance"): DevExpress.viz.charts.dxPolarChart; -} -declare namespace DevExpress.viz.gauges { - export interface BaseRangeContainer { - /** Specifies a range container's background color. */ - backgroundColor?: string; - /** Specifies the offset of the range container from an invisible scale line in pixels. */ - offset?: number; - /** Sets the name of the palette or an array of colors to be used for coloring the gauge range container. */ - palette?: any; - /** An array of objects representing ranges contained in the range container. */ - ranges?: Array<{ startValue: number; endValue: number; color: string }>; - /** Specifies a color of a range. */ - color?: string; - /** Specifies an end value of a range. */ - endValue?: number; - /** Specifies a start value of a range. */ - startValue?: number; - } - export interface ScaleTick { - /** Specifies the color of the scale's minor ticks. */ - color?: string; - /** Specifies an array of custom minor ticks. */ - customTickValues?: Array; - /** Specifies the length of the scale's minor ticks. */ - length?: number; - /** Indicates whether automatically calculated minor ticks are visible or not. */ - showCalculatedTicks?: boolean; - /** Specifies an interval between minor ticks. */ - tickInterval?: number; - /** Indicates whether scale minor ticks are visible or not. */ - visible?: boolean; - /** Specifies the width of the scale's minor ticks. */ - width?: number; - } - export interface ScaleMajorTick extends ScaleTick { - /** Specifies whether or not to expand the current major tick interval if labels overlap each other. */ - useTicksAutoArrangement?: boolean; - } - export interface BaseScaleLabel { - /** Specifies whether or not scale labels should be colored similarly to their corresponding ranges in the range container. */ - useRangeColors?: boolean; - /** Specifies a callback function that returns the text to be displayed in scale labels. */ - customizeText?: (scaleValue: { value: number; valueText: string }) => string; - /** Specifies font options for the text displayed in the scale labels of the gauge. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in scale labels. */ - format?: string; - /** Specifies a precision for the formatted value displayed in the scale labels. */ - precision?: number; - /** Specifies whether or not scale labels are visible on the gauge. */ - visible?: boolean; - } - export interface BaseScale { - /** Specifies the end value for the scale of the gauge. */ - endValue?: number; - /** Specifies whether or not to hide the first scale label. */ - hideFirstLabel?: boolean; - /** Specifies whether or not to hide the first major tick on the scale. */ - hideFirstTick?: boolean; - /** Specifies whether or not to hide the last scale label. */ - hideLastLabel?: boolean; - /** Specifies whether or not to hide the last major tick on the scale. */ - hideLastTick?: boolean; - /** Specifies common options for scale labels. */ - label?: BaseScaleLabel; - /** Specifies options of the gauge's major ticks. */ - majorTick?: ScaleMajorTick; - /** Specifies options of the gauge's minor ticks. */ - minorTick?: ScaleTick; - /** Specifies the start value for the scale of the gauge. */ - startValue?: number; - } - export interface BaseValueIndicator { - /** Specifies the type of subvalue indicators. */ - type?: string; - /** Specifies the background color for the indicator of the rangeBar type. */ - backgroundColor?: string; - /** Specifies the base value for the indicator of the rangeBar type. */ - baseValue?: number; - /** Specifies a color of the indicator. */ - color?: string; - /** Specifies the range bar size for an indicator of the rangeBar type. */ - size?: number; - text?: { - /** Specifies a callback function that returns the text to be displayed in an indicator. */ - customizeText?: (indicatedValue: { value: number; valueText: string }) => string; - font?: viz.core.Font; - /** Specifies a format for the text displayed in an indicator. */ - format?: string; - /** Specifies the range bar's label indent in pixels. */ - indent?: number; - /** Specifies a precision for the formatted value displayed by an indicator. */ - precision?: number; - }; - offset?: number; - length?: number; - width?: number; - /** Specifies the length of an arrow for the indicator of the textCloud type in pixels. */ - arrowLength?: number; - /** Sets the array of colors to be used for coloring subvalue indicators. */ - palette?: Array; - /** Specifies the distance between the needle and the center of a gauge for the indicator of a needle-like type. */ - indentFromCenter?: number; - /** Specifies the second color for the indicator of the twoColorNeedle type. */ - secondColor?: string; - /** Specifies the length of a twoNeedleColor type indicator tip as a percentage. */ - secondFraction?: number; - /** Specifies the spindle's diameter in pixels for the indicator of a needle-like type. */ - spindleSize?: number; - /** Specifies the inner diameter in pixels, so that the spindle has the shape of a ring. */ - spindleGapSize?: number; - /** Specifies the orientation of the rangeBar indicator on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - /** Specifies the orientation of the rangeBar indicator on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - } - export interface SharedGaugeOptions { - /** Specifies animation options. */ - animation?: viz.core.Animation; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */ - redrawOnResize?: boolean; - /** Specifies the size of the widget in pixels. */ - size?: viz.core.Size; - /** Specifies a subtitle for a gauge. */ - subtitle?: { - /** Specifies font options for the subtitle. */ - font?: viz.core.Font; - /** Specifies a text for the subtitle. */ - text?: string; - }; - /** Specifies a title for a gauge. */ - title?: { - /** Specifies font options for the title. */ - font?: viz.core.Font; - /** Specifies a title's position on the gauge. */ - position?: string; - /** Specifies a text for the title. */ - text?: string; - }; - /** Specifies options for gauge tooltips. */ - tooltip?: viz.core.Tooltip; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: dxBaseGauge; - element: Element; - target: {}; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: dxBaseGauge; - element: Element; - target: {}; - }) => void; - } - export interface BaseGaugeOptions extends viz.core.BaseWidgetOptions, SharedGaugeOptions { - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** Specifies the blank space in pixels between the widget's extreme elements and the boundaries of the area provided for the widget (see the size option). */ - margin?: viz.core.Margins; - /** Specifies options of the gauge's range container. */ - rangeContainer?: BaseRangeContainer; - /** Specifies a gauge's scale options. */ - scale?: BaseScale; - /** Specifies the appearance options of subvalue indicators. */ - subvalueIndicator?: BaseValueIndicator; - /** Specifies a set of subvalues to be designated by the subvalue indicators. */ - subvalues?: Array; - /** Specifies the main value on a gauge. */ - value?: number; - /** Specifies the appearance options of the value indicator. */ - valueIndicator?: BaseValueIndicator; - } - /** A gauge widget. */ - export class dxBaseGauge extends viz.core.BaseWidget { - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(): void; - /** Returns the main gauge value. */ - value(): number; - /** Updates a gauge value. */ - value(value: number): void; - /** Returns an array of gauge subvalues. */ - subvalues(): Array; - /** Updates gauge subvalues. */ - subvalues(subvalues: Array): void; - } - export interface LinearRangeContainer extends BaseRangeContainer { - /** Specifies the orientation of the range container on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - /** Specifies the orientation of a range container on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - /** Specifies the width of the range container's start and end boundaries in the dxLinearGauge widget. */ - width?: any; - /** Specifies an end width of a range container. */ - end?: number; - /** Specifies a start width of a range container. */ - start?: number; - } - export interface LinearScaleLabel extends BaseScaleLabel { - /** Specifies the spacing between scale labels and ticks. */ - indentFromTick?: number; - } - export interface LinearScale extends BaseScale { - /** Specifies the orientation of scale ticks on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - label?: LinearScaleLabel; - /** Specifies the orientation of scale ticks on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - } - export interface dxLinearGaugeOptions extends BaseGaugeOptions { - /** Specifies the options required to set the geometry of the dxLinearGauge widget. */ - geometry?: { - /** Indicates whether to display the dxLinearGauge widget vertically or horizontally. */ - orientation?: string; - }; - /** Specifies gauge range container options. */ - rangeContainer?: LinearRangeContainer; - scale?: LinearScale; - } - /** A widget that represents a gauge with a linear scale. */ - export class dxLinearGauge extends dxBaseGauge { - constructor(element: JQuery, options?: dxLinearGaugeOptions); - constructor(element: Element, options?: dxLinearGaugeOptions); - } - export interface CircularRangeContainer extends BaseRangeContainer { - /** Specifies the orientation of the range container in the dxCircularGauge widget. */ - orientation?: string; - /** Specifies the range container's width in pixels. */ - width?: number; - } - export interface CircularScaleLabel extends BaseScaleLabel { - /** Specifies the spacing between scale labels and ticks. */ - indentFromTick?: number; - } - export interface CircularScale extends BaseScale { - label?: CircularScaleLabel; - /** Specifies the orientation of scale ticks. */ - orientation?: string; - } - export interface dxCircularGaugeOptions extends BaseGaugeOptions { - /** Specifies the options required to set the geometry of the dxCircularGauge widget. */ - geometry?: { - /** Specifies the end angle of the circular gauge's arc. */ - endAngle?: number; - /** Specifies the start angle of the circular gauge's arc. */ - startAngle?: number; - }; - /** Specifies gauge range container options. */ - rangeContainer?: CircularRangeContainer; - scale?: CircularScale; - } - /** A widget that represents a gauge with a circular scale. */ - export class dxCircularGauge extends dxBaseGauge { - constructor(element: JQuery, options?: dxCircularGaugeOptions); - constructor(element: Element, options?: dxCircularGaugeOptions); - } - export interface dxBarGaugeOptions extends viz.core.BaseWidgetOptions, SharedGaugeOptions { - /** Specifies a color for the remaining segment of the bar's track. */ - backgroundColor?: string; - /** Specifies a distance between bars in pixels. */ - barSpacing?: number; - /** Specifies a base value for bars. */ - baseValue?: number; - /** Specifies an end value for the gauge's invisible scale. */ - endValue?: number; - /** Defines the shape of the gauge's arc. */ - geometry?: { - /** Specifies the end angle of the bar gauge's arc. */ - endAngle?: number; - /** Specifies the start angle of the bar gauge's arc. */ - startAngle?: number; - }; - /** Specifies the options of the labels that accompany gauge bars. */ - label?: { - /** Specifies a color for the label connector text. */ - connectorColor?: string; - /** Specifies the width of the label connector in pixels. */ - connectorWidth?: number; - /** Specifies a callback function that returns a text for labels. */ - customizeText?: (barValue: { value: number; valueText: string }) => string; - /** Specifies font options for bar labels. */ - font?: viz.core.Font; - /** Specifies a format for bar labels. */ - format?: string; - /** Specifies the distance between the upper bar and bar labels in pixels. */ - indent?: number; - /** Specifies a precision for the formatted value displayed by labels. */ - precision?: number; - /** Specifies whether bar labels appear on a gauge or not. */ - visible?: boolean; - }; - /** Sets the name of the palette or an array of colors to be used for coloring the gauge range container. */ - palette?: string; - /** Defines the radius of the bar that is closest to the center relatively to the radius of the topmost bar. */ - relativeInnerRadius?: number; - /** Specifies a start value for the gauge's invisible scale. */ - startValue?: number; - /** Specifies the array of values to be indicated on a bar gauge. */ - values?: Array; - } - /** A circular bar widget. */ - export class dxBarGauge extends viz.core.BaseWidget { - constructor(element: JQuery, options?: dxBarGaugeOptions); - constructor(element: Element, options?: dxBarGaugeOptions); - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws the widget. */ - render(): void; - /** Returns an array of gauge values. */ - values(): Array; - /** Updates the values displayed by a gauge. */ - values(values: Array): void; - } -} -interface JQuery { - dxLinearGauge(options?: DevExpress.viz.gauges.dxLinearGaugeOptions): JQuery; - dxLinearGauge(methodName: string, ...params: any[]): any; - dxLinearGauge(methodName: "instance"): DevExpress.viz.gauges.dxLinearGauge; - dxCircularGauge(options?: DevExpress.viz.gauges.dxCircularGaugeOptions): JQuery; - dxCircularGauge(methodName: string, ...params: any[]): any; - dxCircularGauge(methodName: "instance"): DevExpress.viz.gauges.dxCircularGauge; - dxBarGauge(options?: DevExpress.viz.gauges.dxBarGaugeOptions): JQuery; - dxBarGauge(methodName: string, ...params: any[]): any; - dxBarGauge(methodName: "instance"): DevExpress.viz.gauges.dxBarGauge; -} -declare namespace DevExpress.viz.rangeSelector { - export interface dxRangeSelectorOptions extends viz.core.BaseWidgetOptions { - /** Specifies the options for the range selector's background. */ - background?: { - /** Specifies the background color for the dxRangeSelector. */ - color?: string; - /** Specifies image options. */ - image?: { - /** Specifies a location for the image in the background of a range selector. */ - location?: string; - /** Specifies the image's URL. */ - url?: string; - }; - /** Indicates whether or not the background (background color and/or image) is visible. */ - visible?: boolean; - }; - /** Specifies the dxRangeSelector's behavior options. */ - behavior?: { - /** Indicates whether or not you can swap sliders. */ - allowSlidersSwap?: boolean; - /** Indicates whether or not animation is enabled. */ - animationEnabled?: boolean; - /** Specifies when to call the onSelectedRangeChanged function. */ - callSelectedRangeChanged?: string; - /** Indicates whether or not an end user can specify the range using a mouse, without the use of sliders. */ - manualRangeSelectionEnabled?: boolean; - /** Indicates whether or not an end user can shift the selected range to the required location on a scale by clicking. */ - moveSelectedRangeByClick?: boolean; - /** Indicates whether to snap a slider to ticks. */ - snapToTicks?: boolean; - }; - /** Specifies the options required to display a chart as the range selector's background. */ - chart?: { - /** Specifies a coefficient for determining an indent from the bottom background boundary to the lowest chart point. */ - bottomIndent?: number; - /** An object defining the common configuration options for the chart’s series. */ - commonSeriesSettings?: viz.charts.CommonSeriesSettings; - /** An object providing options for managing data from a data source. */ - dataPrepareSettings?: { - /** Specifies whether or not to validate values from a data source. */ - checkTypeForAllData?: boolean; - /** Specifies whether or not to convert the values from a data source into the data type of an axis. */ - convertToAxisDataType?: boolean; - /** Specifies how to sort series points. */ - sortingMethod?: any; - }; - /** Specifies a value indicating whether all bars in a series must have the same width, or may have different widths if any points in other series are missing. */ - equalBarWidth?: any; - /** Sets the name of the palette to be used in the range selector's chart. Alternatively, an array of colors can be set as a custom palette to be used within this chart. */ - palette?: any; - /** An object defining the chart’s series. */ - series?: Array; - /** Defines options for the series template. */ - seriesTemplate?: viz.charts.SeriesTemplate; - /** Specifies a coefficient for determining an indent from the background's top boundary to the topmost chart point. */ - topIndent?: number; - /** Specifies whether or not to filter the series points depending on their quantity. */ - useAggregation?: boolean; - /** Specifies options for the chart's value axis. */ - valueAxis?: { - /** Indicates whether or not the chart's value axis must be inverted. */ - inverted?: boolean; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic value axis. */ - logarithmBase?: number; - /** Specifies the maximum value of the chart's value axis. */ - max?: number; - /** Specifies the minimum value of the chart's value axis. */ - min?: number; - /** Specifies the type of the value axis. */ - type?: string; - /** Specifies the desired type of axis values. */ - valueType?: string; - }; - }; - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** Specifies a data source for the scale values and for the chart at the background. */ - dataSource?: any; - /** Specifies the data source field that provides data for the scale. */ - dataSourceField?: string; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies the blank space in pixels between the dxRangeSelector widget's extreme elements and the boundaries of the area provided for the widget (see size). */ - margin?: viz.core.Margins; - /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */ - redrawOnResize?: boolean; - /** Specifies options of the range selector's scale. */ - scale?: { - /** Specifies the scale's end value. */ - endValue?: any; - /** Specifies common options for scale labels. */ - label?: { - /** Specifies a callback function that returns the text to be displayed in scale labels. */ - customizeText?: (scaleValue: { value: any; valueText: string; }) => string; - /** Specifies font options for the text displayed in the range selector's scale labels. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in scale labels. */ - format?: string; - /** Specifies a precision for the formatted value displayed in the scale labels. */ - precision?: number; - /** Specifies a spacing between scale labels and the background bottom edge. */ - topIndent?: number; - /** Specifies whether or not the scale's labels are visible. */ - visible?: boolean; - }; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic scale. */ - logarithmBase?: number; - /** Specifies an interval between major ticks. */ - majorTickInterval?: any; - /** Specifies options for the date-time scale's markers. */ - marker?: { - /** Defines the options that can be set for the text that is displayed by the scale markers. */ - label?: { - /** Specifies a callback function that returns the text to be displayed in scale markers. */ - customizeText?: (markerValue: { value: any; valueText: string }) => string; - /** Specifies a format for the text displayed in scale markers. */ - format?: string; - }; - /** Specifies the height of the marker's separator. */ - separatorHeight?: number; - /** Specifies the space between the marker label and the marker separator. */ - textLeftIndent?: number; - /** Specifies the space between the marker's label and the top edge of the marker's separator. */ - textTopIndent?: number; - /** Specified the indent between the marker and the scale lables. */ - topIndent?: number; - /** Indicates whether scale markers are visible. */ - visible?: boolean; - }; - /** Specifies the maximum range that can be selected. */ - maxRange?: any; - /** Specifies the number of minor ticks between neighboring major ticks. */ - minorTickCount?: number; - /** Specifies an interval between minor ticks. */ - minorTickInterval?: any; - /** Specifies the minimum range that can be selected. */ - minRange?: any; - /** Specifies the height of the space reserved for the scale in pixels. */ - placeholderHeight?: number; - /** Indicates whether or not to set ticks of a date-time scale at the beginning of each date-time interval. */ - setTicksAtUnitBeginning?: boolean; - /** Specifies whether or not to show ticks for the boundary scale values, when neither major ticks nor minor ticks are created for these values. */ - showCustomBoundaryTicks?: boolean; - /** Indicates whether or not to show minor ticks on the scale. */ - showMinorTicks?: boolean; - /** Specifies the scale's start value. */ - startValue?: any; - /** Specifies options defining the appearance of scale ticks. */ - tick?: { - /** Specifies the color of scale ticks (both major and minor ticks). */ - color?: string; - /** Specifies the opacity of scale ticks (both major and minor ticks). */ - opacity?: number; - /** Specifies the width of the scale's ticks (both major and minor ticks). */ - width?: number; - }; - /** Specifies the type of the scale. */ - type?: string; - /** Specifies whether or not to expand the current tick interval if labels overlap each other. */ - useTicksAutoArrangement?: boolean; - /** Specifies the type of values on the scale. */ - valueType?: string; - /** Specifies the order of arguments on a discrete scale. */ - categories?: Array; - }; - /** Specifies the range to be selected when displaying the dxRangeSelector. */ - selectedRange?: { - /** Specifies the start value of the range to be selected when displaying the dxRangeSelector widget on a page. */ - startValue?: any; - /** Specifies the end value of the range to be selected when displaying the dxRangeSelector widget on a page. */ - endValue?: any; - }; - /** Specifies the color of the selected range. */ - selectedRangeColor?: string; - /** Range selector's indent options. */ - indent?: { - /** Specifies range selector's left indent. */ - left?: number; - /** Specifies range selector's right indent. */ - right?: number; - }; - selectedRangeChanged?: (selectedRange: { startValue: any; endValue: any; }) => void; - /** A handler for the selectedRangeChanged event. */ - onSelectedRangeChanged?: (e: { - startValue: any; - endValue: any; - component: dxRangeSelector; - element: Element; - }) => void; - /** Specifies range selector shutter options. */ - shutter?: { - /** Specifies shutter color. */ - color?: string; - /** Specifies the opacity of the color of shutters. */ - opacity?: number; - }; - /** Specifies in pixels the size of the dxRangeSelector widget. */ - size?: viz.core.Size; - /** Specifies the appearance of the range selector's slider handles. */ - sliderHandle?: { - /** Specifies the color of the slider handles. */ - color?: string; - /** Specifies the opacity of the slider handles. */ - opacity?: number; - /** Specifies the width of the slider handles. */ - width?: number; - }; - /** Defines the options of the range selector slider markers. */ - sliderMarker?: { - /** Specifies the color of the slider markers. */ - color?: string; - /** Specifies a callback function that returns the text to be displayed by slider markers. */ - customizeText?: (scaleValue: { value: any; valueText: any; }) => string; - /** Specifies font options for the text displayed by the range selector slider markers. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in slider markers. */ - format?: string; - /** Specifies the color used for the slider marker text when the currently selected range does not match the minRange and maxRange values. */ - invalidRangeColor?: string; - /** - * Specifies the empty space between the marker's border and the marker’s text. - * @deprecated Use the 'paddingTopBottom' and 'paddingLeftRight' options instead - */ - padding?: number; - /** Specifies the empty space between the marker's top and bottom borders and the marker's text. */ - paddingTopBottom?: number; - /** Specifies the empty space between the marker's left and right borders and the marker's text. */ - paddingLeftRight?: number; - /** Specifies the placeholder height of the slider marker. */ - placeholderHeight?: number; - /** - * Specifies in pixels the height and width of the space reserved for the range selector slider markers. - * @deprecated Use the 'placeholderHeight' and 'indent' options instead - */ - placeholderSize?: { - /** Specifies the height of the placeholder for the left and right slider markers. */ - height?: number; - /** Specifies the width of the placeholder for the left and right slider markers. */ - width?: { - /** Specifies the width of the left slider marker's placeholder. */ - left?: number; - /** Specifies the width of the right slider marker's placeholder. */ - right?: number; - }; - }; - /** Specifies a precision for the formatted value displayed in slider markers. */ - precision?: number; - /** Indicates whether or not the slider markers are visible. */ - visible?: boolean; - }; - } - /** A widget that allows end users to select a range of values on a scale. */ - export class dxRangeSelector extends viz.core.BaseWidget { - constructor(element: JQuery, options?: dxRangeSelectorOptions); - constructor(element: Element, options?: dxRangeSelectorOptions); - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(skipChartAnimation?: boolean): void; - /** Returns the currently selected range. */ - getSelectedRange(): { startValue: any; endValue: any; }; - /** Sets a specified range. */ - setSelectedRange(selectedRange: { startValue: any; endValue: any; }): void; - } -} -interface JQuery { - dxRangeSelector(options?: DevExpress.viz.rangeSelector.dxRangeSelectorOptions): JQuery; - dxRangeSelector(methodName: string, ...params: any[]): any; - dxRangeSelector(methodName: "instance"): DevExpress.viz.rangeSelector.dxRangeSelector; -} -declare namespace DevExpress.viz.map { - /** This section describes the fields and methods that can be used in code to manipulate the Area object. */ - export interface Area { - /** Contains the element type. */ - type: string; - /** Return the value of an attribute. */ - attribute(name: string): any; - /** Provides information about the selection state of an area. */ - selected(): boolean; - /** Sets a new selection state for an area. */ - selected(state: boolean): void; - /** Applies the area settings specified as a parameter and updates the area appearance. */ - applySettings(settings: any): void; - } - /** This section describes the fields and methods that can be used in code to manipulate the Markers object. */ - export interface Marker { - /** Contains the descriptive text accompanying the map marker. */ - text: string; - /** Contains the type of the element. */ - type: string; - /** Contains the URL of an image map marker. */ - url: string; - /** Contains the value of a bubble map marker. */ - value: number; - /** Contains the values of a pie map marker. */ - values: Array; - /** Returns the value of an attribute. */ - attribute(name: string): any; - /** Returns the coordinates of a specific marker. */ - coordinates(): Array; - /** Provides information about the selection state of a marker. */ - selected(): boolean; - /** Sets a new selection state for a marker. */ - selected(state: boolean): void; - /** Applies the marker settings specified as a parameter and updates the marker appearance. */ - applySettings(settings: any): void; - } - export interface AreaSettings { - /** Specifies the width of the area border in pixels. */ - borderWidth?: number; - /** Specifies a color for the area border. */ - borderColor?: string; - click?: any; - /** Specifies a color for an area. */ - color?: string; - /** Specifies the function that customizes each area individually. */ - customize?: (areaInfo: Area) => AreaSettings; - /** Specifies a color for the area border when the area is hovered over. */ - hoveredBorderColor?: string; - /** Specifies the pixel-measured width of the area border when the area is hovered over. */ - hoveredBorderWidth?: number; - /** Specifies a color for an area when this area is hovered over. */ - hoveredColor?: string; - /** Specifies whether or not to change the appearance of an area when it is hovered over. */ - hoverEnabled?: boolean; - /** Configures area labels. */ - label?: { - /** Specifies the data field that provides data for area labels. */ - dataField?: string; - /** Enables area labels. */ - enabled?: boolean; - /** Specifies font options for area labels. */ - font?: viz.core.Font; - }; - /** Specifies the name of the palette or a custom range of colors to be used for coloring a map. */ - palette?: any; - /** Specifies the number of colors in a palette. */ - paletteSize?: number; - /** Allows you to paint areas with similar attributes in the same color. */ - colorGroups?: Array; - /** Specifies the field that provides data to be used for coloring areas. */ - colorGroupingField?: string; - /** Specifies a color for the area border when the area is selected. */ - selectedBorderColor?: string; - /** Specifies a color for an area when this area is selected. */ - selectedColor?: string; - /** Specifies the pixel-measured width of the area border when the area is selected. */ - selectedBorderWidth?: number; - selectionChanged?: (area: Area) => void; - /** Specifies whether single or multiple areas can be selected on a vector map. */ - selectionMode?: string; - } - export interface MarkerSettings { - /** Specifies a color for the marker border. */ - borderColor?: string; - /** Specifies the width of the marker border in pixels. */ - borderWidth?: number; - click?: any; - /** Specifies a color for a marker of the dot or bubble type. */ - color?: string; - /** Specifies the function that customizes each marker individually. */ - customize?: (markerInfo: Marker) => MarkerSettings; - font?: Object; - /** Specifies the pixel-measured width of the marker border when the marker is hovered over. */ - hoveredBorderWidth?: number; - /** Specifies a color for the marker border when the marker is hovered over. */ - hoveredBorderColor?: string; - /** Specifies a color for a marker of the dot or bubble type when this marker is hovered over. */ - hoveredColor?: string; - /** Specifies whether or not to change the appearance of a marker when it is hovered over. */ - hoverEnabled?: boolean; - /** Specifies marker label options. */ - label?: { - /** Enables marker labels. */ - enabled?: boolean; - /** Specifies font options for marker labels. */ - font?: viz.core.Font; - }; - /** Specifies the pixel-measured diameter of the marker that represents the biggest value. Setting this option makes sense only if you use markers of the bubble type. */ - maxSize?: number; - /** Specifies the pixel-measured diameter of the marker that represents the smallest value. Setting this option makes sense only if you use markers of the bubble type. */ - minSize?: number; - /** Specifies the opacity of markers. Setting this option makes sense only if you use markers of the bubble type. */ - opacity?: number; - /** Specifies the pixel-measured width of the marker border when the marker is selected. */ - selectedBorderWidth?: number; - /** Specifies a color for the marker border when the marker is selected. */ - selectedBorderColor?: string; - /** Specifies a color for a marker of the dot or bubble type when this marker is selected. */ - selectedColor?: string; - selectionChanged?: (marker: Marker) => void; - /** Specifies whether a single or multiple markers can be selected on a vector map. */ - selectionMode?: string; - /** Specifies the size of markers. Setting this option makes sense for any type of marker except bubble. */ - size?: number; - /** Specifies the type of markers to be used on the map. */ - type?: string; - /** Specifies the name of a palette or a custom set of colors to be used for coloring markers of the pie type. */ - palette?: any; - /** Allows you to paint markers with similar attributes in the same color. */ - colorGroups?: Array; - /** Specifies the field that provides data to be used for coloring markers. */ - colorGroupingField?: string; - /** Allows you to display bubbles with similar attributes in the same size. */ - sizeGroups?: Array; - /** Specifies the field that provides data to be used for sizing bubble markers. */ - sizeGroupingField?: string; - } - export interface dxVectorMapOptions extends viz.core.BaseWidgetOptions { - /** An object specifying options for the map areas. */ - areaSettings?: AreaSettings; - /** Specifies the options for the map background. */ - background?: { - /** Specifies a color for the background border. */ - borderColor?: string; - /** Specifies a color for the background. */ - color?: string; - }; - /** Specifies the positioning of a map in geographical coordinates. */ - bounds?: Array; - /** Specifies the options of the control bar. */ - controlBar?: { - /** Specifies a color for the outline of the control bar elements. */ - borderColor?: string; - /** Specifies a color for the inner area of the control bar elements. */ - color?: string; - /** Specifies whether or not to display the control bar. */ - enabled?: boolean; - /** Specifies the margin of the control bar in pixels. */ - margin?: number; - /** Specifies the position of the control bar. */ - horizontalAlignment?: string; - /** Specifies the position of the control bar. */ - verticalAlignment?: string; - /** Specifies the opacity of the Control_Bar. */ - opacity?: number; - }; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies a data source for the map area. */ - mapData?: any; - /** Specifies a data source for the map markers. */ - markers?: any; - /** An object specifying options for the map markers. */ - markerSettings?: MarkerSettings; - /** Specifies the size of the dxVectorMap widget. */ - size?: viz.core.Size; - /** Specifies tooltip options. */ - tooltip?: viz.core.Tooltip; - /** Configures map legends. */ - legends?: Array; - /** Specifies whether or not the map should respond when a user rolls the mouse wheel. */ - wheelEnabled?: boolean; - /** Specifies whether the map should respond to touch gestures. */ - touchEnabled?: boolean; - /** Disables the zooming capability. */ - zoomingEnabled?: boolean; - /** Specifies the geographical coordinates of the center for a map. */ - center?: Array; - centerChanged?: (center: Array) => void; - /** A handler for the centerChanged event. */ - onCenterChanged?: (e: { - center: Array; - component: dxVectorMap; - element: Element; - }) => void; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: dxVectorMap; - element: Element; - target: {}; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: dxVectorMap; - element: Element; - target: {}; - }) => void; - /** Specifies a number that is used to zoom a map initially. */ - zoomFactor?: number; - /** Specifies a map's maximum zoom factor. */ - maxZoomFactor?: number; - zoomFactorChanged?: (zoomFactor: number) => void; - /** A handler for the zoomFactorChanged event. */ - onZoomFactorChanged?: (e: { - zoomFactor: number; - component: dxVectorMap; - element: Element; - }) => void; - click?: any; - /** A handler for the click event. */ - onClick?: any; - /** A handler for the areaClick event. */ - onAreaClick?: any; - /** A handler for the areaSelectionChanged event. */ - onAreaSelectionChanged?: (e: { - target: Area; - component: dxVectorMap; - element: Element; - }) => void; - /** A handler for the markerClick event. */ - onMarkerClick?: any; - /** A handler for the markerSelectionChanged event. */ - onMarkerSelectionChanged?: (e: { - target: Marker; - component: dxVectorMap; - element: Element; - }) => void; - /** Disables the panning capability. */ - panningEnabled?: boolean; - } - export interface Legend extends viz.core.BaseLegend { - /** Specifies text for legend items. */ - customizeText?: (itemInfo: { start: number; end: number; index: number; color: string; size: number; }) => string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the text of a legend item. */ - customizeHint?: (itemInfo: { start: number; end: number; index: number; color: string; size: number }) => string; - /** Specifies the source of data for the legend. */ - source?: string; - } - /** A vector map widget. */ - export class dxVectorMap extends viz.core.BaseWidget { - constructor(element: JQuery, options?: dxVectorMapOptions); - constructor(element: Element, options?: dxVectorMapOptions); - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(): void; - /** Gets the current coordinates of the map center. */ - center(): Array; - /** Sets the coordinates of the map center. */ - center(centerCoordinates: Array): void; - /** Deselects all the selected areas on a map. The areas are displayed in their initial style after. */ - clearAreaSelection(): void; - /** Deselects all the selected markers on a map. The markers are displayed in their initial style after. */ - clearMarkerSelection(): void; - /** Deselects all the selected area and markers on a map at once. The areas and markers are displayed in their initial style after. */ - clearSelection(): void; - /** Converts client area coordinates into map coordinates. */ - convertCoordinates(x: number, y: number): Array; - /** Returns an array with all the map areas. */ - getAreas(): Array; - /** Returns an array with all the map markers. */ - getMarkers(): Array; - /** Gets the current coordinates of the map viewport. */ - viewport(): Array; - /** Sets the coordinates of the map viewport. */ - viewport(viewportCoordinates: Array): void; - /** Gets the current value of the map zoom factor. */ - zoomFactor(): number; - /** Sets the value of the map zoom factor. */ - zoomFactor(zoomFactor: number): void; - } -} -interface JQuery { - dxVectorMap(options?: DevExpress.viz.map.dxVectorMapOptions): JQuery; - dxVectorMap(methodName: string, ...params: any[]): any; - dxVectorMap(methodName: "instance"): DevExpress.viz.map.dxVectorMap; -} -declare namespace DevExpress.viz.sparklines { - export interface SparklineTooltip extends viz.core.Tooltip { - /** - * Specifies how a tooltip is horizontally aligned relative to the graph. - * @deprecated Tooltip alignment is no more available. - */ - horizontalAlignment?: string; - /** - * Specifies how a tooltip is vertically aligned relative to the graph. - * @deprecated Tooltip alignment is no more available. - */ - verticalAlignment?: string; - } - export interface BaseSparklineOptions extends viz.core.BaseWidgetOptions { - /** Specifies the blank space between the widget's extreme elements and the boundaries of the area provided for the widget in pixels. */ - margin?: viz.core.Margins; - /** Specifies the size of the widget. */ - size?: viz.core.Size; - /** Specifies tooltip options. */ - tooltip?: SparklineTooltip; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: BaseSparkline; - element: Element; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: BaseSparkline; - element: Element; - }) => void; - } - /** Overridden by descriptions for particular widgets. */ - export class BaseSparkline extends viz.core.BaseWidget { - /** Redraws a widget. */ - render(): void; - } - export interface dxBulletOptions extends BaseSparkline { - /** Specifies a color for the bullet bar. */ - color?: string; - /** Specifies an end value for the invisible scale. */ - endScaleValue?: number; - /** Specifies whether or not to show the target line. */ - showTarget?: boolean; - /** Specifies whether or not to show the line indicating zero on the invisible scale. */ - showZeroLevel?: boolean; - /** Specifies a start value for the invisible scale. */ - startScaleValue?: number; - /** Specifies the value indicated by the target line. */ - target?: number; - /** Specifies a color for both the target and zero level lines. */ - targetColor?: string; - /** Specifies the width of the target line. */ - targetWidth?: number; - /** Specifies the primary value indicated by the bullet bar. */ - value?: number; - } - /** A bullet graph widget. */ - export class dxBullet extends BaseSparkline { - constructor(element: JQuery, options?: dxBulletOptions); - constructor(element: Element, options?: dxBulletOptions); - } - export interface dxSparklineOptions extends BaseSparklineOptions { - /** Specifies the data source field that provides arguments for a sparkline. */ - argumentField?: string; - /** Sets a color for the bars indicating negative values. Available for a sparkline of the bar type only. */ - barNegativeColor?: string; - /** Sets a color for the bars indicating positive values. Available for a sparkline of the bar type only. */ - barPositiveColor?: string; - /** Specifies a data source for the sparkline. */ - dataSource?: Array; - /** Sets a color for the boundary of both the first and last points on a sparkline. */ - firstLastColor?: string; - /** Specifies whether a sparkline ignores null data points or not. */ - ignoreEmptyPoints?: boolean; - /** Sets a color for a line on a sparkline. Available for the sparklines of the line- and area-like types. */ - lineColor?: string; - /** Specifies a width for a line on a sparkline. Available for the sparklines of the line- and area-like types. */ - lineWidth?: number; - /** Sets a color for the bars indicating the values that are less than the winloss threshold. Available for a sparkline of the winloss type only. */ - lossColor?: string; - /** Sets a color for the boundary of the maximum point on a sparkline. */ - maxColor?: string; - /** Sets a color for the boundary of the minimum point on a sparkline. */ - minColor?: string; - /** Sets a color for points on a sparkline. Available for the sparklines of the line- and area-like types. */ - pointColor?: string; - /** Specifies the diameter of sparkline points in pixels. Available for the sparklines of line- and area-like types. */ - pointSize?: number; - /** Specifies a symbol to use as a point marker on a sparkline. Available for the sparklines of the line- and area-like types. */ - pointSymbol?: string; - /** Specifies whether or not to indicate both the first and last values on a sparkline. */ - showFirstLast?: boolean; - /** Specifies whether or not to indicate both the minimum and maximum values on a sparkline. */ - showMinMax?: boolean; - /** Determines the type of a sparkline. */ - type?: string; - /** Specifies the data source field that provides values for a sparkline. */ - valueField?: string; - /** Sets a color for the bars indicating the values greater than a winloss threshold. Available for a sparkline of the winloss type only. */ - winColor?: string; - /** Specifies a value that serves as a threshold for the sparkline of the winloss type. */ - winlossThreshold?: number; - /** Specifies the minimum value of the sparkline value axis. */ - minValue?: number; - /** Specifies the maximum value of the sparkline's value axis. */ - maxValue?: number; - } - /** A sparkline widget. */ - export class dxSparkline extends BaseSparkline { - constructor(element: JQuery, options?: dxSparklineOptions); - constructor(element: Element, options?: dxSparklineOptions); - } -} -interface JQuery { - dxBullet(options?: DevExpress.viz.sparklines.dxBulletOptions): JQuery; - dxBullet(methodName: string, ...params: any[]): any; - dxBullet(methodName: "instance"): DevExpress.viz.sparklines.dxBullet; - dxSparkline(options?: DevExpress.viz.sparklines.dxSparklineOptions): JQuery; - dxSparkline(methodName: string, ...params: any[]): any; - dxSparkline(methodName: "instance"): DevExpress.viz.sparklines.dxSparkline; -} diff --git a/devextreme/devextreme-15.2.10.d.ts b/devextreme/devextreme-15.2.10.d.ts deleted file mode 100644 index d8b1149efd..0000000000 --- a/devextreme/devextreme-15.2.10.d.ts +++ /dev/null @@ -1,7504 +0,0 @@ -// Type definitions for DevExtreme 15.2.10 -// Project: http://js.devexpress.com/ -// Definitions by: DevExpress Inc. -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -/// - -declare module DevExpress { - /** A mixin that provides a capability to fire and subscribe to events. */ - export interface EventsMixin { - /** Subscribes to a specified event. */ - on(eventName: string, eventHandler: Function): T; - /** Subscribes to the specified events. */ - on(events: { [eventName: string]: Function; }): T; - /** Detaches all event handlers from the specified event. */ - off(eventName: string): Object; - /** Detaches a particular event handler from the specified event. */ - off(eventName: string, eventHandler: Function): T; - } - /** An object that serves as a namespace for the methods required to perform validation. */ - export module validationEngine { - export interface IValidator { - validate(): ValidatorValidationResult; - reset(): void; - } - export interface ValidatorValidationResult { - isValid: boolean; - name?: string; - value: any; - brokenRule: any; - validationRules: any[]; - } - export interface ValidationGroupValidationResult { - isValid: boolean; - brokenRules: any[]; - validators: IValidator[]; - } - export interface GroupConfig extends EventsMixin { - group: any; - validators: IValidator[]; - validate(): ValidationGroupValidationResult; - reset(): void; - } - /** Provides access to the object that represents the specified validation group. */ - export function getGroupConfig(group: any): GroupConfig - /** Provides access to the object that represents the default validation group. */ - export function getGroupConfig(): GroupConfig - /** Validates rules of the validators that belong to the specified validation group. */ - export function validateGroup(group: any): ValidationGroupValidationResult; - /** Validates rules of the validators that belong to the default validation group. */ - export function validateGroup(): ValidationGroupValidationResult; - /** Resets the values and validation result of the editors that belong to the specified validation group. */ - export function resetGroup(group: any): void; - /** Resets the values and validation result of the editors that belong to the default validation group. */ - export function resetGroup(): void; - /** Validates the rules that are defined within the dxValidator objects that are registered for the specified ViewModel. */ - export function validateModel(model: Object): ValidationGroupValidationResult; - /** Registers all the dxValidator objects by which the fields of the specified ViewModel are extended. */ - export function registerModelForValidation(model: Object) : void; - } - export var hardwareBackButton: JQueryCallback; - /** Processes the hardware back button click. */ - export function processHardwareBackButton(): void; - /** Hides the last displayed overlay widget. */ - export function hideTopOverlay(): boolean; - /** Specifies whether or not the entire application/site supports right-to-left representation. */ - export var rtlEnabled: boolean; - /** Registers a new component in the DevExpress.ui namespace as a jQuery plugin, Angular directive and Knockout binding. */ - export function registerComponent(name: string, componentClass: Object): void; - /** Registers a new component in the specified namespace as a jQuery plugin, Angular directive and Knockout binding. */ - export function registerComponent(name: string, namespace: Object, componentClass: Object): void; - export function requestAnimationFrame(callback: Function): number; - export function cancelAnimationFrame(requestID: number): void; - /** Custom Knockout binding that links an HTML element with a specific action. */ - export class Action { } - /** Used to get URLs that vary in a locally running application and the application running on production. */ - export class EndpointSelector { - constructor(options: { - [key: string]: { - local?: string; - production?: string; - } - }); - /** Returns a local or a productional URL depending on how the application is currently running. */ - urlFor(key: string): string; - } - /** An object that serves as a namespace for the methods that are used to animate UI elements. */ - export module fx { - /** Defines animation options. */ - export interface AnimationOptions { - /** A function called after animation is completed. */ - complete?: (element: JQuery, config: AnimationOptions) => void; - /** A number specifying wait time before animation execution. */ - delay?: number; - /** A number specifying the time period to wait before the animation of the next stagger item starts. */ - staggerDelay?: number; - /** A number specifying the time in milliseconds spent on animation. */ - duration?: number; - /** A string specifying the type of an easing function used for animation. */ - easing?: string; - /** Specifies the initial animation state. */ - from?: any; - /** A function called before animation is started. */ - start?: (element: JQuery, config: AnimationOptions) => void; - /** Specifies a final animation state. */ - to?: any; - /** A string value specifying the animation type. */ - type?: string; - /** Specifies the animation direction for the "slideIn" and "slideOut" animation types. */ - direction?: string; - } - /** Animates the specified element. */ - export function animate(element: HTMLElement, config: AnimationOptions): Object; - /** Returns a value indicating whether the specified element is being animated. */ - export function isAnimating(element: HTMLElement): boolean; - /** Stops the animation. */ - export function stop(element: HTMLElement, jumpToEnd: boolean): void; - } - /** The manager that performs several specified animations at a time. */ - export class TransitionExecutor { - /** Deletes all the animations registered in the Transition Executor by using the enter(elements, animation) and leave(elements, animation) methods. */ - reset(): void; - /** Registers a set of elements that should be animated as "entering" using the specified animation configuration. */ - enter(elements: JQuery, animation: any): void; - /** Registers a set of elements that should be animated as "leaving" using the specified animation configuration. */ - leave(elements: JQuery, animation: any): void; - /** Starts all the animations registered using the enter(elements, animation) and leave(elements, animation) methods beforehand. */ - start(config: Object): JQueryPromise; - /** Stops all started animations. */ - stop(): void; - } - export class AnimationPresetCollection { - /** Resets all the changes made in the animation repository. */ - resetToDefaults(): void; - /** Deletes the specified animation or clears all the animation repository, if an animation name is not passed. */ - clear(name: string): void; - /** Adds the specified animation preset to the animation repository by the specified name. */ - registerPreset(name: string, config: any): void; - /** Applies the changes made in the animation repository. */ - applyChanges(): void; - /** Returns the configuration of the animation found in the animation repository by the specified name for the current device. */ - getPreset(name: string): void; - /** Registers predefined animations in the animation repository. */ - registerDefaultPresets(): void; - } - /** A repository of animations. */ - export var animationPresets: AnimationPresetCollection; - /** The device object defines the device on which the application is running. */ - export interface Device { - /** Indicates whether or not the device platform is Android. */ - android?: boolean; - /** Specifies the type of the device on which the application is running. */ - deviceType?: string; - /** Indicates whether or not the device platform is generic, which means that the application will look and behave according to a generic "light" or "dark" theme. */ - generic?: boolean; - /** Indicates whether or not the device platform is iOS. */ - ios?: boolean; - /** Indicates whether or not the device type is 'phone'. */ - phone?: boolean; - /** Specifies the platform of the device on which the application is running. */ - platform?: string; - /** Indicates whether or not the device type is 'tablet'. */ - tablet?: boolean; - /** Specifies an array with the major and minor versions of the device platform. */ - version?: Array; - /** Indicates whether or not the device platform is Windows. */ - win?: boolean; - /** Specifies a performance grade of the current device. */ - grade?: string; - } - export class Devices implements EventsMixin { - constructor(options: { window: Window }); - /** Overrides actual device information to force the application to operate as if it was running on the specified device. */ - current(deviceName: any): void; - /** Returns information about the current device. */ - current(): Device; - orientationChanged: JQueryCallback; - /** Returns the current device orientation. */ - orientation(): string; - /** Returns real information about the current device regardless of the value passed to the devices.current(deviceName) method. */ - real(): Device; - on(eventName: "orientationChanged", eventHandler: (e: { orientation: string }) => void): Devices; - on(eventName: string, eventHandler: Function): Devices; - on(events: { [eventName: string]: Function; }): Devices; - off(eventName: "orientationChanged"): Devices; - off(eventName: string): Devices; - off(eventName: "orientationChanged", eventHandler: (e: { orientation: string }) => void): Devices; - off(eventName: string, eventHandler: Function): Devices; - } - /** An object that serves as a namespace for the methods and events specifying information on the current device. */ - export var devices: Devices; - /** The position object specifies the widget positioning options. */ - export interface PositionOptions { - /** The target element position that the widget is positioned against. */ - at?: any; - /** The element within which the widget is positioned. */ - boundary?: Object; - /** Specifies the horizontal and vertical offset from the window's boundaries. */ - boundaryOffset?: any; - /** Specifies how to move the widget if it overflows the screen. */ - collision?: any; - /** The position of the widget to align against the target element. */ - my?: any; - /** The target element that the widget is positioned against. */ - of?: Object; - /** Specifies horizontal and vertical offset in pixels. */ - offset?: any; - } - export interface ComponentOptions { - /** A handler for the initialized event. */ - onInitialized?: Function; - /** A handler for the optionChanged event. */ - onOptionChanged?: Function; - /** A handler for the disposing event. */ - onDisposing?: Function; - } - /** A base class for all components and widgets. */ - export class Component { - constructor(options?: ComponentOptions) - /** Prevents the component from refreshing until the endUpdate method is called. */ - beginUpdate(): void; - /** Enables the component to refresh after the beginUpdate method call. */ - endUpdate(): void; - /** Returns an instance of this component class. */ - instance(): Component; - /** Returns the configuration options of this component. */ - option(): { - [optionKey: string]: any; - }; - /** Sets one or more options of this component. */ - option(options: { - [optionKey: string]: any; - }): void; - /** Gets the value of the specified configuration option of this component. */ - option(optionName: string): any; - /** Sets a value to the specified configuration option of this component. */ - option(optionName: string, optionValue: any): void; - } - export interface DOMComponentOptions extends ComponentOptions { - /** Specifies whether or not the current component supports a right-to-left representation. */ - rtlEnabled?: boolean; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies the width of the widget. */ - width?: any; - /** A bag for holding any options that require two-way binding (Angular approach specific) */ - bindingOptions?: { [key: string]: any; }; - } - /** A base class for all components. */ - export class DOMComponent extends Component { - constructor(element: JQuery, options?: DOMComponentOptions); - constructor(element: HTMLElement, options?: DOMComponentOptions); - /** Returns the root HTML element of the widget. */ - element(): JQuery; - /** Specifies the device-dependent default configuration options for this component. */ - static defaultOptions(rule: { - device?: any; - options?: any; - }): void; - } - export module data { - export interface ODataError extends Error { - httpStatus?: number; - errorDetails?: any; - } - export interface StoreOptions { - /** A handler for the modified event. */ - onModified?: () => void; - /** A handler for the modifying event. */ - onModifying?: () => void; - /** A handler for the removed event. */ - onRemoved?: (key: any) => void; - /** A handler for the removing event. */ - onRemoving?: (key: any) => void; - /** A handler for the updated event. */ - onUpdated?: (key: any, values: Object) => void; - /** A handler for the updating event. */ - onUpdating?: (key: any, values: Object) => void; - /** A handler for the loaded event. */ - onLoaded?: (result: Array) => void; - /** A handler for the loading event. */ - onLoading?: (loadOptions: LoadOptions) => void; - /** A handler for the inserted event. */ - onInserted?: (values: Object, key: any) => void; - /** A handler for the inserting event. */ - onInserting?: (values: Object) => void; - /** Specifies the function called when the Store causes an error. */ - errorHandler?: (e: Error) => void; - /** Specifies the key properties within the data associated with the Store. */ - key?: any; - } - export interface LoadOptions { - filter?: Object; - sort?: Object; - select?: Object; - expand?: Object; - group?: Object; - skip?: number; - take?: number; - userData?: Object; - requireTotalCount?: boolean; - } - /** The base class for all Stores. */ - export class Store implements EventsMixin { - constructor(options?: StoreOptions); - /** Returns the data item specified by the key. */ - byKey(key: any): JQueryPromise; - /** Adds an item to the data associated with this Store. */ - insert(values: Object): JQueryPromise; - /** Returns the key expression specified via the key configuration option. */ - key(): any; - /** Returns the key of the Store item that matches the specified object. */ - keyOf(obj: Object): any; - /** Starts loading data. */ - load(obj?: LoadOptions): JQueryPromise; - /** Removes the data item specified by the key. */ - remove(key: any): JQueryPromise; - /** Obtains the total count of items that will be returned by the load() function. */ - totalCount(options?: { - filter?: Object; - group?: Object; - }): JQueryPromise; - /** Updates the data item specified by the key. */ - update(key: any, values: Object): JQueryPromise; - on(eventName: "removing", eventHandler: (key: any) => void): Store; - on(eventName: "removed", eventHandler: (key: any) => void): Store; - on(eventName: "updating", eventHandler: (key: any, values: Object) => void): Store; - on(eventName: "updated", eventHandler: (key: any, values: Object) => void): Store; - on(eventName: "inserting", eventHandler: (values: Object) => void): Store; - on(eventName: "inserted", eventHandler: (values: Object, key: any) => void): Store; - on(eventName: "modifying", eventHandler: () => void): Store; - on(eventName: "modified", eventHandler: () => void): Store; - on(eventName: "loading", eventHandler: (loadOptions: LoadOptions) => void): Store; - on(eventName: "loaded", eventHandler: (result: Array) => void): Store; - on(eventName: string, eventHandler: Function): Store; - on(events: { [eventName: string]: Function; }): Store; - off(eventName: "removing"): Store; - off(eventName: "removed"): Store; - off(eventName: "updating"): Store; - off(eventName: "updated"): Store; - off(eventName: "inserting"): Store; - off(eventName: "inserted"): Store; - off(eventName: "modifying"): Store; - off(eventName: "modified"): Store; - off(eventName: "loading"): Store; - off(eventName: "loaded"): Store; - off(eventName: string): Store; - off(eventName: "removing", eventHandler: (key: any) => void): Store; - off(eventName: "removed", eventHandler: (key: any) => void): Store; - off(eventName: "updating", eventHandler: (key: any, values: Object) => void): Store; - off(eventName: "updated", eventHandler: (key: any, values: Object) => void): Store; - off(eventName: "inserting", eventHandler: (values: Object) => void): Store; - off(eventName: "inserted", eventHandler: (values: Object, key: any) => void): Store; - off(eventName: "modifying", eventHandler: () => void): Store; - off(eventName: "modified", eventHandler: () => void): Store; - off(eventName: "loading", eventHandler: (loadOptions: LoadOptions) => void): Store; - off(eventName: "loaded", eventHandler: (result: Array) => void): Store; - off(eventName: string, eventHandler: Function): Store; - } - export interface ArrayStoreOptions extends StoreOptions { - /** Specifies the array associated with this Store. */ - data?: Array; - } - /** A Store accessing an in-memory array. */ - export class ArrayStore extends Store { - constructor(options?: ArrayStoreOptions); - /** Clears all data associated with the current ArrayStore. */ - clear(): void; - /** Creates the Query object for the underlying array. */ - createQuery(): Query; - } - interface Promise { - then(doneFn?: Function, failFn?: Function, progressFn?: Function): Promise; - } - export interface CustomStoreOptions extends StoreOptions { - /** Specifies whether or not the store combines the search expression with the filter expression. */ - useDefaultSearch?: boolean; - /** The user implementation of the byKey(key, extraOptions) method. */ - byKey?: (key: any) => Promise; - /** The user implementation of the insert(values) method. */ - insert?: (values: Object) => Promise; - /** The user implementation of the load(options) method. */ - load?: (options?: LoadOptions) => Promise; - /** The user implementation of the remove(key) method. */ - remove?: (key: any) => Promise; - /** The user implementation of the totalCount(options) method. */ - totalCount?: (options?: { - filter?: Object; - group?: Object; - }) => Promise; - /** The user implementation of the update(key, values) method. */ - update?: (key: any, values: Object) => Promise; - } - /** A Store object that enables you to implement your own data access logic. */ - export class CustomStore extends Store { - constructor(options: CustomStoreOptions); - } - export interface DataSourceOptions { - /** Specifies data filtering conditions. */ - filter?: Object; - /** Specifies data grouping conditions. */ - group?: Object; - /** The item mapping function. */ - map?: (record: any) => any; - /** Specifies the maximum number of items the page can contain. */ - pageSize?: number; - /** Specifies whether a DataSource loads data by pages, or all items at once. */ - paginate?: boolean; - /** The data post processing function. */ - postProcess?: (data: any[]) => any[]; - /** Specifies a value by which the required items are searched. */ - searchExpr?: Object; - /** Specifies the comparison operation used to search for the required items. */ - searchOperation?: string; - /** Specifies the value to which the search expression is compared. */ - searchValue?: Object; - /** Specifies the initial select option value. */ - select?: Object; - /** An array of the strings that represent the names of the navigation properties to be loaded simultaneously with the OData store's entity. */ - expand?: Object; - /** The bag of custom parameters passed to the query executed when the DataSource load operation is invoked. */ - customQueryParams?: Object; - /** Specifies whether or not the DataSource instance requests the total count of items available in the storage. */ - requireTotalCount?: boolean; - /** Specifies the initial sort option value. */ - sort?: Object; - /** Specifies the underlying Store instance used to access data. */ - store?: any; - /** A handler for the changed event. */ - onChanged?: () => void; - /** A handler for the loadingChanged event. */ - onLoadingChanged?: (isLoading: boolean) => void; - /** A handler for the loadError event. */ - onLoadError?: (e?: Error) => void; - } - export interface OperationPromise extends JQueryPromise { - operationId: number; - } - /** An object that provides access to a data web service or local data storage for collection container widgets. */ - export class DataSource implements EventsMixin { - constructor(url: string); - constructor(data: Array); - constructor(options: CustomStoreOptions); - constructor(options: DataSourceOptions); - /** Disposes all resources associated with this DataSource. */ - dispose(): void; - /** Returns the current filter option value. */ - filter(): Object; - /** Sets the filter option value. */ - filter(filterExpr: Object): void; - /** Returns the current group option value. */ - group(): Object; - /** Sets the group option value. */ - group(groupExpr: Object): void; - /** Indicates whether or not the current page contains fewer items than the number of items specified by the pageSize configuration option. */ - isLastPage(): boolean; - /** Indicates whether or not at least one load() method execution has successfully finished. */ - isLoaded(): boolean; - /** Indicates whether or not the DataSource is currently being loaded. */ - isLoading(): boolean; - /** Returns the array of items currently operated by the DataSource. */ - items(): Array; - /** Returns the key expression. */ - key(): any; - /** Starts loading data. */ - load(): OperationPromise>; - /** Clears currently loaded DataSource items and calls the load() method. */ - reload(): OperationPromise>; - /** Returns an object that would be passed to the load() method of the underlying Store according to the current data shaping option values of the current DataSource instance. */ - loadOptions(): Object; - /** Returns the current pageSize option value. */ - pageSize(): number; - /** Sets the pageSize option value. */ - pageSize(value: number): void; - /** Specifies the index of the currently loaded page. */ - pageIndex(): number; - /** Specifies the index of the page to be loaded during the next load() method execution. */ - pageIndex(newIndex: number): void; - /** Returns the current paginate option value. */ - paginate(): boolean; - /** Sets the paginate option value. */ - paginate(value: boolean): void; - /** Returns the searchExpr option value. */ - searchExpr(): Object; - /** Sets the searchExpr option value. */ - searchExpr(...expr: Object[]): void; - /** Returns the currently specified search operation. */ - searchOperation(): string; - /** Sets the current search operation. */ - searchOperation(op: string): void; - /** Returns the searchValue option value. */ - searchValue(): Object; - /** Sets the searchValue option value. */ - searchValue(value: Object): void; - /** Returns the current select option value. */ - select(): Object; - /** Sets the select option value. */ - select(expr: Object): void; - /** Returns the current requireTotalCount option value. */ - requireTotalCount(): boolean; - /** Sets the requireTotalCount option value. */ - requireTotalCount(value: boolean): void; - /** Returns the current sort option value. */ - sort(): Object; - /** Sets the sort option value. */ - sort(sortExpr: Object): void; - /** Returns the underlying Store instance. */ - store(): Store; - /** Returns the number of data items available in an underlying Store after the last load() operation without paging. */ - totalCount(): number; - /** Cancels the load operation associated with the specified identifier. */ - cancel(operationId: number): boolean; - on(eventName: "loadingChanged", eventHandler: (isLoading: boolean) => void): DataSource; - on(eventName: "loadError", eventHandler: (e?: Error) => void): DataSource; - on(eventName: "changed", eventHandler: () => void): DataSource; - on(eventName: string, eventHandler: Function): DataSource; - on(events: { [eventName: string]: Function; }): DataSource; - off(eventName: "loadingChanged"): DataSource; - off(eventName: "loadError"): DataSource; - off(eventName: "changed"): DataSource; - off(eventName: string): DataSource; - off(eventName: "loadingChanged", eventHandler: (isLoading: boolean) => void): DataSource; - off(eventName: "loadError", eventHandler: (e?: Error) => void): DataSource; - off(eventName: "changed", eventHandler: () => void): DataSource; - off(eventName: string, eventHandler: Function): DataSource; - } - /** An object used to work with primitive data types not supported by JavaScript when accessing an OData web service. */ - export class EdmLiteral { - /** Creates an EdmLiteral instance and assigns the specified value to it. */ - constructor(value: string); - /** Returns a string representation of the value associated with this EdmLiteral object. */ - valueOf(): string; - } - /** An object used to generate and hold the GUID. */ - export class Guid { - /** Creates a new Guid instance that holds the specified GUID. */ - constructor(value: string); - /** Creates a new Guid instance holding the generated GUID. */ - constructor(); - /** Returns a string representation of the Guid instance. */ - toString(): string; - /** Returns a string representation of the Guid instance. */ - valueOf(): string; - } - export interface LocalStoreOptions extends ArrayStoreOptions { - /** Specifies the time (in miliseconds) after the change operation, before the data is flushed. */ - flushInterval?: number; - /** Specifies whether the data is flushed immediatelly after each change operation, or after the delay specified via the flushInterval option. */ - immediate?: boolean; - /** The unique identifier used to distinguish the data within the HTML5 Web Storage. */ - name?: string; - } - /** A Store providing access to the HTML5 Web Storage. */ - export class LocalStore extends ArrayStore { - constructor(options?: LocalStoreOptions); - /** Removes all data associated with this Store. */ - clear(): void; - } - export interface ODataContextOptions extends ODataStoreOptions { - /** Specifies the list of entities to be accessed via the ODataContext. */ - entities?: Object; - /** Specifies the function called if the ODataContext causes an error. */ - errorHandler?: (e: Error) => void; - } - /** Provides access to the entire OData service. */ - export class ODataContext { - constructor(options?: ODataContextOptions); - /** Initiates the specified WebGet service operation that returns a value. For the information on service operations, refer to the OData documentation. */ - get(operationName: string, params: Object): JQueryPromise; - /** Initiates the specified WebGet service operation that returns nothing. For the information on service operations, refer to the OData documentation. */ - invoke(operationName: string, params: Object, httpMethod: Object): JQueryPromise; - /** Return a special proxy object to describe the entity link. */ - objectLink(entityAlias: string, key: any): Object; - } - export interface ODataStoreOptions extends StoreOptions { - /** A function used to customize a web request before it is sent. */ - beforeSend?: (request: { - url: string; - async: boolean; - method: string; - timeout: number; - params: Object; - payload: Object; - headers: Object; - }) => void; - /** Specifies whether the ODataStore uses the JSONP approach to access non-CORS-compatible remote services. */ - jsonp?: boolean; - /** Specifies the type of the ODataStore key property. The following key types are supported out of the box: String, Int32, Int64, and Guid. */ - keyType?: any; - /** Specifies whether or not dates found in the response are deserialized. */ - deserializeDates?: boolean; - /** Specifies the URL of the data service being accessed via the current ODataContext. */ - url?: string; - /** Specifies the version of the OData protocol used to interact with the data service. */ - version?: number; - /** Specifies the value of the withCredentials field of the underlying jqXHR object. */ - withCredentials?: boolean; - } - /** A Store providing access to a separate OData web service entity. */ - export class ODataStore extends Store { - constructor(options?: ODataStoreOptions); - /** Creates the Query object for the OData endpoint. */ - createQuery(loadOptions: Object): Object; - /** Returns the data item specified by the key. */ - byKey(key: any, extraOptions?: { expand?: Object }): JQueryPromise; - } - /** An universal chainable data query interface object. */ - export interface Query { - /** Calculates a custom summary for the items in the current Query. */ - aggregate(step: (accumulator: any, value: any) => any): JQueryPromise; - /** Calculates a custom summary for the items in the current Query. */ - aggregate(seed: any, step: (accumulator: any, value: any) => any, finalize: (result: any) => any): JQueryPromise; - /** Calculates the average item value for the current Query. */ - avg(getter: Object): JQueryPromise; - /** Finds the item with the maximum getter value. */ - max(getter: Object): JQueryPromise; - /** Finds the item with the maximum value in the Query. */ - max(): JQueryPromise; - /** Finds the item with the minimum value in the Query. */ - min(): JQueryPromise; - /** Finds the item with the minimum getter value. */ - min(getter: Object): JQueryPromise; - /** Calculates the average item value for the current Query, if each Query item has a numeric type. */ - avg(): JQueryPromise; - /** Returns the total count of items in the current Query. */ - count(): JQueryPromise; - /** Executes the Query. */ - enumerate(): JQueryPromise; - /** Filters the current Query data. */ - filter(criteria: Array): Query; - /** Filters the current Query data. */ - filter(predicate: (item: any) => boolean): Query; - /** Groups the current Query data. */ - groupBy(getter: Object): Query; - /** Applies the specified transformation to each item. */ - select(getter: Object): Query; - /** Limits the data item count. */ - slice(skip: number, take?: number): Query; - /** Sorts current Query data. */ - sortBy(getter: Object, desc: boolean): Query; - /** Sorts current Query data. */ - sortBy(getter: Object): Query; - /** Calculates the sum of item getter values in the current Query. */ - sum(getter: Object): JQueryPromise; - /** Calculates the sum of item values in the current Query. */ - sum(): JQueryPromise; - /** Adds one more sorting condition to the current Query. */ - thenBy(getter: Object): Query; - /** Adds one more sorting condition to the current Query. */ - thenBy(getter: Object, desc: boolean): Query; - /** Returns the array of current Query items. */ - toArray(): Array; - } - /** The global data layer error handler. */ - export var errorHandler: (e: Error) => void; - /** Encodes the specified string or array of bytes to base64 encoding. */ - export function base64_encode(input: any): string; - /** Creates a Query instance. */ - export function query(array: Array): Query; - /** Creates a Query instance for accessing the remote service specified by a URL. */ - export function query(url: string, queryOptions: Object): Query; - /** This section describes the utility objects provided by the DevExtreme data layer. */ - export var utils: { - /** Compiles a getter function from the getter expression. */ - compileGetter(expr: any): Function; - /** Compiles a setter function from the setter expression. */ - compileSetter(expr: any): Function; - odata: { - /** Holds key value converters for OData. */ - keyConverters: { - String(value: any): string; - Int32(value: any): number; - Int64(value: any): EdmLiteral; - Guid(value: any): Guid; - Boolean(value: any): boolean; - Single(value: any): EdmLiteral; - Decimal(value: any): EdmLiteral; - }; - } - } - } - /** An object that serves as a namespace for DevExtreme UI widgets as well as for methods implementing UI logic in DevExtreme sites/applications. */ - export module ui { - export interface WidgetOptions extends DOMComponentOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A Boolean value specifying whether or not the widget can respond to user interaction. */ - disabled?: boolean; - /** A Boolean value specifying whether or not the widget changes its state when being hovered by an end user. */ - hoverStateEnabled?: boolean; - /** Specifies whether or not the widget can be focused. */ - focusStateEnabled?: boolean; - /** Specifies a shortcut key that sets focus on the widget element. */ - accessKey?: string; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - /** Specifies the widget tab index. */ - tabIndex?: number; - /** Specifies the text of the hint displayed for the widget. */ - hint?: string; - } - /** The base class for widgets. */ - export class Widget extends DOMComponent { - constructor(options?: WidgetOptions); - /** Redraws the widget. */ - repaint(): void; - /** Sets focus on the widget. */ - focus(): void; - /** Registers a handler when a specified key is pressed. */ - registerKeyHandler(key: string, handler: Function): void; - } - export interface CollectionWidgetOptions extends WidgetOptions { - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** The time period in milliseconds before the onItemHold event is raised. */ - itemHoldTimeout?: number; - /** An array of items displayed by the widget. */ - items?: Array; - /** The template to be used for rendering items. */ - itemTemplate?: any; - loopItemFocus?: boolean; - /** The text or HTML markup displayed by the widget if the item collection is empty. */ - noDataText?: string; - onContentReady?: any; - /** A handler for the itemClick event. */ - onItemClick?: any; - /** A handler for the itemContextMenu event. */ - onItemContextMenu?: Function; - /** A handler for the itemHold event. */ - onItemHold?: Function; - /** A handler for the itemRendered event. */ - onItemRendered?: Function; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: Function; - /** The index of the currently selected widget item. */ - selectedIndex?: number; - /** The selected item object. */ - selectedItem?: Object; - /** An array of currently selected item objects. */ - selectedItems?: Array; - /** A handler for the itemDeleting event. */ - onItemDeleting?: Function; - /** A handler for the itemDeleted event. */ - onItemDeleted?: Function; - /** A handler for the itemReordered event. */ - onItemReordered?: Function; - } - /** The base class for widgets containing an item collection. */ - export class CollectionWidget extends Widget { - constructor(element: JQuery, options?: CollectionWidgetOptions); - constructor(element: HTMLElement, options?: CollectionWidgetOptions); - selectItem(itemElement: any): void; - unselectItem(itemElement: any): void; - deleteItem(itemElement: any): JQueryPromise; - isItemSelected(itemElement: any): boolean; - reorderItem(itemElement: any, toItemElement: any): JQueryPromise; - } - export interface DataExpressionMixinOptions { - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** Specifies the name of the data source item field whose value is displayed by the widget. */ - displayExpr?: any; - /** Specifies the name of a data source item field whose value is held in the value configuration option. */ - valueExpr?: any; - /** An array of items displayed by the widget. */ - items?: Array; - /** The template to be used for rendering items. */ - itemTemplate?: any; - /** The currently selected value in the widget. */ - value?: Object; - } - export interface EditorOptions extends WidgetOptions { - /** The currently specified value. */ - value?: Object; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - /** A Boolean value specifying whether or not the widget is read-only. */ - readOnly?: boolean; - /** Holds the object that defines the error that occurred during validation. */ - validationError?: Object; - /** Specifies whether the editor's value is valid. */ - isValid?: boolean; - /** Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed. */ - validationMessageMode?: string; - } - /** A base class for editors. */ - export class Editor extends Widget { - /** Resets the editor's value to undefined. */ - reset(): void; - } - /** An object that serves as a namespace for methods displaying a message in an application/site. */ - export var dialog: { - /** Creates an alert dialog message containing a single "OK" button. */ - alert(message: string, title: string): JQueryPromise; - /** Creates a confirm dialog that contains "Yes" and "No" buttons. */ - confirm(message: string, title: string): JQueryPromise; - /** Creates a custom dialog using the options specified by the passed configuration object. */ - custom(options: { title?: string; message?: string; buttons?: Array; }): { - show(): JQueryPromise; - hide(): void; - hide(value: any): void; - }; - }; - /** Creates a toast message. */ - export function notify(message: any, type: string, displayTime: number): void; - /** Creates a toast message. */ - export function notify(options: Object): void; - /** An object that serves as a namespace for the methods that work with DevExtreme CSS Themes. */ - export var themes: { - /** Returns the name of the currently applied theme. */ - current(): string; - /** Changes the current theme to the specified one. */ - current(themeName: string): void; - }; - /** Sets a specified template engine. */ - export function setTemplateEngine(name: string): void; - /** Sets a custom template engine defined via custom compile and render functions. */ - export function setTemplateEngine(options: Object): void; - } - /** An object that serves as a namespace for utility methods that can be helpful when working with the DevExtreme framework and UI widgets. */ - export var utils: { - /** Sets parameters for the viewport meta tag. */ - initMobileViewport(options: { allowZoom?: boolean; allowPan?: boolean; allowSelection?: boolean }): void; - /** Requests that the browser call a specified function to update animation before the next repaint. */ - requestAnimationFrame(callback: Function): number; - /** Cancels an animation frame request scheduled with the requestAnimationFrame method. */ - cancelAnimationFrame(requestID: number): void; - }; - /** An object that serves as a namespace for DevExtreme Data Visualization Widgets. */ - export module viz { - /** Applies a theme for the entire page with several DevExtreme visualization widgets. */ - export function currentTheme(theme: string): void; - /** Applies a new theme (with the color scheme defined separately) for the entire page with several DevExtreme visualization widgets. */ - export function currentTheme(platform: string, colorScheme: string): void; - /** Registers a new theme based on the existing one. */ - export function registerTheme(customTheme: Object, baseTheme: string): void; - /** Applies a predefined or registered custom palette to all visualization widgets at once. */ - export function currentPalette(paletteName: string): void; - /** Obtains the color sets of a predefined or registered palette. */ - export function getPalette(paletteName: string): Object; - /** Registers a new palette. */ - export function registerPalette(paletteName: string, palette: Object): void; - } -} -declare module DevExpress.ui { - export interface dxValidatorOptions extends DOMComponentOptions { - /** An array of validation rules to be checked for the editor with which the dxValidator object is associated. */ - validationRules?: Array; - /** Specifies the editor name to be used in the validation default messages. */ - name?: string; - /** An object that specifies what and when to validate and how to apply the validation result. */ - adapter?: Object; - /** Specifies the validation group the editor will be related to. */ - validationGroup?: string; - /** A handler for the validated event. */ - onValidated?: (params: validationEngine.ValidatorValidationResult) => void; - } - /** A widget that is used to validate the associated DevExtreme editors against the defined validation rules. */ - export class dxValidator extends DOMComponent implements validationEngine.IValidator { - constructor(element: JQuery, options?: dxValidatorOptions); - constructor(element: Element, options?: dxValidatorOptions); - /** Validates the value of the editor that is controlled by the current dxValidator object against the list of the specified validation rules. */ - validate(): validationEngine.ValidatorValidationResult; - /** Resets the value and validation result of the editor associated with the current dxValidator object. */ - reset(): void; - } - /** The widget that is used in the Knockout and Angular approaches to combine the editors to be validated. */ - export class dxValidationGroup extends DOMComponent { - constructor(element: JQuery); - constructor(element: Element); - /** Validates rules of the validators that belong to the current validation group. */ - validate(): validationEngine.ValidationGroupValidationResult; - /** Resets the value and validation result of the editors that are included to the current validation group. */ - reset(): void; - } - export interface dxValidationSummaryOptions extends CollectionWidgetOptions { - /** Specifies the validation group for which summary should be generated. */ - validationGroup?: string; - } - /** A widget for displaying the result of checking validation rules for editors. */ - export class dxValidationSummary extends CollectionWidget { - constructor(element: JQuery, options?: dxValidationSummaryOptions); - constructor(element: Element, options?: dxValidationSummaryOptions); - } - export interface dxResizableOptions extends DOMComponentOptions { - /** Specifies which borders of the widget element are used as a handle. */ - handles?: string; - /** Specifies the lower width boundary for resizing. */ - minWidth?: number; - /** Specifies the upper width boundary for resizing. */ - maxWidth?: number; - /** Specifies the lower height boundary for resizing. */ - minHeight?: number; - /** Specifies the upper height boundary for resizing. */ - maxHeight?: number; - /** A handler for the resizeStart event. */ - onResizeStart?: Function; - /** A handler for the resize event. */ - onResize?: Function; - /** A handler for the resizeEnd event. */ - onResizeEnd?: Function; - } - /** A widget that displays required content in a resizable element. */ - export class dxResizable extends DOMComponent { - constructor(element: JQuery, options?: dxResizableOptions); - constructor(element: Element, options?: dxResizableOptions); - } - export interface dxTooltipOptions extends dxPopoverOptions { - } - /** A tooltip widget. */ - export class dxTooltip extends dxPopover { - constructor(element: JQuery, options?: dxTooltipOptions); - constructor(element: Element, options?: dxTooltipOptions); - } - export interface dxDropDownListOptions extends dxDropDownEditorOptions, DataExpressionMixinOptions { - /** Returns the value currently displayed by the widget. */ - displayValue?: string; - /** The minimum number of characters that must be entered into the text box to begin a search. */ - minSearchLength?: number; - /** Specifies whether or not the widget displays unfiltered values until a user types a number of characters exceeding the minSearchLength option value. */ - showDataBeforeSearch?: boolean; - /** Specifies the name of a data source item field or an expression whose value is compared to the search criterion. */ - searchExpr?: any; - /** Specifies the binary operation used to filter data. */ - searchMode?: string; - /** Specifies the time delay, in milliseconds, after the last character has been typed in, before a search is executed. */ - searchTimeout?: number; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - /** Specifies DOM event names that update a widget's value. */ - valueChangeEvent?: string; - /** Specifies whether or not the widget supports searching. */ - searchEnabled?: boolean; - /** - * Specifies whether or not the widget displays items by pages. - * @deprecated Use the DataSource paging opportunities instead. - */ - pagingEnabled?: boolean; - /** The text or HTML markup displayed by the widget if the item collection is empty. */ - noDataText?: string; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: Function; - /** A handler for the itemClick event. */ - onItemClick?: Function; - onContentReady?: Function; - } - /** A base class for drop-down list widgets. */ - export class dxDropDownList extends dxDropDownEditor { - constructor(element: JQuery, options?: dxDropDownListOptions); - constructor(element: Element, options?: dxDropDownListOptions); - } - export interface dxToolbarOptions extends CollectionWidgetOptions { - /** The template used to render menu items. */ - menuItemTemplate?: any; - /** Informs the widget about its location in a view HTML markup. */ - renderAs?: string; - } - /** A toolbar widget. */ - export class dxToolbar extends CollectionWidget { - constructor(element: JQuery, options?: dxToolbarOptions); - constructor(element: Element, options?: dxToolbarOptions); - } - export interface dxToastOptions extends dxOverlayOptions { - animation?: { - /** An object that defines the animation options used when the widget is being shown. */ - show?: fx.AnimationOptions; - /** An object that defines the animation options used when the widget is being hidden. */ - hide?: fx.AnimationOptions; - }; - /** The time span in milliseconds during which the dxToast widget is visible. */ - displayTime?: number; - height?: any; - /** The dxToast message text. */ - message?: string; - position?: PositionOptions; - shading?: boolean; - /** Specifies the dxToast widget type. */ - type?: string; - width?: any; - closeOnBackButton?: boolean; - /** A Boolean value specifying whether or not the toast is closed if a user swipes it out of the screen boundaries. */ - closeOnSwipe?: boolean; - /** A Boolean value specifying whether or not the toast is closed if a user clicks it. */ - closeOnClick?: boolean; - } - /** The toast message widget. */ - export class dxToast extends dxOverlay { - constructor(element: JQuery, options?: dxToastOptions); - constructor(element: Element, options?: dxToastOptions); - } - export interface dxTextEditorOptions extends EditorOptions { - /** A handler for the change event. */ - onChange?: Function; - /** A handler for the copy event. */ - onCopy?: Function; - /** A handler for the cut event. */ - onCut?: Function; - /** A handler for the enterKey event. */ - onEnterKey?: Function; - /** A handler for the focusIn event. */ - onFocusIn?: Function; - /** A handler for the focusOut event. */ - onFocusOut?: Function; - /** A handler for the input event. */ - onInput?: Function; - /** A handler for the keyDown event. */ - onKeyDown?: Function; - /** A handler for the keyPress event. */ - onKeyPress?: Function; - /** A handler for the keyUp event. */ - onKeyUp?: Function; - /** A handler for the paste event. */ - onPaste?: Function; - /** The text displayed by the widget when the widget value is empty. */ - placeholder?: string; - /** Specifies whether to display the Clear button in the widget. */ - showClearButton?: boolean; - /** Specifies the current value displayed by the widget. */ - value?: any; - /** Specifies DOM event names that update a widget's value. */ - valueChangeEvent?: string; - /** Specifies whether or not the widget checks the inner text for spelling mistakes. */ - spellcheck?: boolean; - /** Specifies HTML attributes applied to the inner input element of the widget. */ - attr?: Object; - /** The read-only option that holds the text displayed by the widget input element. */ - text?: string; - focusStateEnabled?: boolean; - hoverStateEnabled?: boolean; - /** The editor mask that specifies the format of the entered string. */ - mask?: string; - /** Specifies a mask placeholder character. */ - maskChar?: string; - /** Specifies custom mask rules. */ - maskRules?: Object; - /** A message displayed when the entered text does not match the specified pattern. */ - maskInvalidMessage?: string; - /** Specifies whether the value option holds only characters entered by a user or prompt characters as well. */ - useMaskedValue?: boolean; - } - /** A base class for text editing widgets. */ - export class dxTextEditor extends Editor { - constructor(element: JQuery, options?: dxTextEditorOptions); - constructor(element: Element, options?: dxTextEditorOptions); - /** Removes focus from the input element. */ - blur(): void; - /** Sets focus to the input element representing the widget. */ - focus(): void; - } - export interface dxTextBoxOptions extends dxTextEditorOptions { - /** Specifies the maximum number of characters you can enter into the textbox. */ - maxLength?: any; - /** The "mode" attribute value of the actual HTML input element representing the text box. */ - mode?: string; - } - /** A single-line text box widget. */ - export class dxTextBox extends dxTextEditor { - constructor(element: JQuery, options?: dxTextBoxOptions); - constructor(element: Element, options?: dxTextBoxOptions); - } - export interface dxTextAreaOptions extends dxTextBoxOptions { - /** Specifies whether or not the widget checks the inner text for spelling mistakes. */ - spellcheck?: boolean; - } - /** A widget used to display and edit multi-line text. */ - export class dxTextArea extends dxTextBox { - constructor(element: JQuery, options?: dxTextAreaOptions); - constructor(element: Element, options?: dxTextAreaOptions); - } - export interface dxTabsOptions extends CollectionWidgetOptions { - /** Specifies whether the widget enables an end-user to select only a single item or multiple items. */ - selectionMode?: string; - /** Specifies whether or not an end-user can scroll tabs by swiping. */ - scrollByContent?: boolean; - /** Specifies whether or not an end-user can scroll tabs. */ - scrollingEnabled?: boolean; - /** A Boolean value that specifies the availability of navigation buttons. */ - showNavButtons?: boolean; - } - /** A tab strip used to switch between pages. */ - export class dxTabs extends CollectionWidget { - constructor(element: JQuery, options?: dxTabsOptions); - constructor(element: Element, options?: dxTabsOptions); - } - export interface dxTabPanelOptions extends dxMultiViewOptions { - /** A handler for the titleClick event. */ - onTitleClick?: any; - /** A handler for the titleHold event. */ - onTitleHold?: Function; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - /** The template to be used for rendering an item title. */ - itemTitleTemplate?: any; - /** A Boolean value specifying if the list is scrolled by content. */ - scrollByContent?: boolean; - /** A Boolean value specifying whether to enable or disable scrolling. */ - scrollingEnabled?: boolean; - /** A Boolean value that specifies the availability of navigation buttons. */ - showNavButtons?: boolean; - } - /** A widget used to display a view and to switch between several views by clicking the appropriate tabs. */ - export class dxTabPanel extends dxMultiView { - constructor(element: JQuery, options?: dxTabPanelOptions); - constructor(element: Element, options?: dxTabPanelOptions); - } - export interface dxSelectBoxOptions extends dxDropDownListOptions { - /** Specifies DOM event names that update a widget's value. */ - valueChangeEvent?: string; - /** The template to be used for rendering the widget text field. */ - fieldTemplate?: any; - /** The text that is provided as a hint in the select box editor. */ - placeholder?: string; - /** Specifies whether or not the widget allows an end-user to enter a custom value. */ - fieldEditEnabled?: boolean; - } - /** A widget that allows you to select an item in a dropdown list. */ - export class dxSelectBox extends dxDropDownList { - constructor(element: JQuery, options?: dxSelectBoxOptions); - constructor(element: Element, options?: dxSelectBoxOptions); - } - export interface dxTagBoxOptions extends dxSelectBoxOptions { - /** Holds the list of selected values. */ - values?: Array; - /** A read-only option that holds the last selected value. */ - value?: Object; - } - /** A widget that allows you to select multiple items from a dropdown list. */ - export class dxTagBox extends dxSelectBox { - constructor(element: JQuery, options?: dxTagBoxOptions); - constructor(element: Element, options?: dxTagBoxOptions); - } - export interface dxScrollViewOptions extends dxScrollableOptions { - /** A handler for the pullDown event. */ - onPullDown?: Function; - /** Specifies the text shown in the pullDown panel when pulling the content down lowers the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while pulling the content down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the reachBottom event. */ - onReachBottom?: Function; - /** Specifies the text shown in the pullDown panel displayed when content is scrolled to the bottom. */ - reachBottomText?: string; - /** Specifies the text shown in the pullDown panel displayed when the content is being refreshed. */ - refreshingText?: string; - } - /** A widget used to display scrollable content. */ - export class dxScrollView extends dxScrollable { - constructor(element: JQuery, options?: dxScrollViewOptions); - constructor(element: Element, options?: dxScrollViewOptions); - /** Returns a value indicating if the scrollView content is larger then the widget container. */ - isFull(): boolean; - /** Locks the widget until the release(preventScrollBottom) method is called and executes the function passed to the onPullDown option and the handler assigned to the pullDown event. */ - refresh(): void; - /** Notifies the scroll view that data loading is finished. */ - release(preventScrollBottom: boolean): JQueryPromise; - /** Toggles the loading state of the widget. */ - toggleLoading(showOrHide: boolean): void; - } - export interface dxScrollableLocation { - top?: number; - left?: number; - } - export interface dxScrollableOptions extends DOMComponentOptions { - /** A string value specifying the available scrolling directions. */ - direction?: string; - /** A Boolean value specifying whether or not the widget can respond to user interaction. */ - disabled?: boolean; - /** A handler for the scroll event. */ - onScroll?: Function; - /** Specifies when the widget shows the scrollbar. */ - showScrollbar?: string; - /** A handler for the update event. */ - onUpdated?: Function; - /** Indicates whether to use native or simulated scrolling. */ - useNative?: boolean; - /** A Boolean value specifying whether to enable or disable the bounce-back effect. */ - bounceEnabled?: boolean; - /** A Boolean value specifying whether or not an end-user can scroll the widget content swiping it up or down. */ - scrollByContent?: boolean; - /** A Boolean value specifying whether or not an end-user can scroll the widget content using the scrollbar. */ - scrollByThumb?: boolean; - } - /** A widget used to display scrollable content. */ - export class dxScrollable extends DOMComponent { - constructor(element: JQuery, options?: dxScrollableOptions); - constructor(element: Element, options?: dxScrollableOptions); - /** Returns the height of the scrollable widget in pixels. */ - clientHeight(): number; - /** Returns the width of the scrollable widget in pixels. */ - clientWidth(): number; - /** Returns an HTML element of the widget. */ - content(): JQuery; - /** Scrolls the widget content by the specified number of pixels. */ - scrollBy(distance: number): void; - /** Scrolls widget content by the specified number of pixels in horizontal and vertical directions. */ - scrollBy(distanceObject: dxScrollableLocation): void; - /** Returns the height of the scrollable content in pixels. */ - scrollHeight(): number; - /** Returns the current scroll position against the leftmost position. */ - scrollLeft(): number; - /** Returns how far the scrollable content is scrolled from the top and from the left. */ - scrollOffset(): dxScrollableLocation; - /** Scrolls widget content to the specified position. */ - scrollTo(targetLocation: number): void; - /** Scrolls widget content to a specified position. */ - scrollTo(targetLocation: dxScrollableLocation): void; - /** Scrolls widget content to the specified element. */ - scrollToElement(element: Element): void; - /** Returns the current scroll position against the topmost position. */ - scrollTop(): number; - /** Returns the width of the scrollable content in pixels. */ - scrollWidth(): number; - /** Updates the dimensions of the scrollable contents. */ - update(): void; - } - export interface dxRadioGroupOptions extends EditorOptions, DataExpressionMixinOptions { - activeStateEnabled?: boolean; - /** Specifies the radio group layout. */ - layout?: string; - } - /** A widget that enables a user to select one item within a list of items represented by radio buttons. */ - export class dxRadioGroup extends CollectionWidget { - constructor(element: JQuery, options?: dxRadioGroupOptions); - constructor(element: Element, options?: dxRadioGroupOptions); - } - export interface dxPopupButtonOptions { - /** Specifies whether or not a toolbar item must be displayed disabled. */ - disabled?: boolean; - /** Specifies html code inserted into the toolbar item element. */ - html?: string; - /** Specifies a location for the item on the toolbar. */ - location?: string; - /** Specifies a configuration object for the widget that presents a toolbar item. */ - options?: Object; - /** Specifies an item template that should be used to render this item only. */ - template?: any; - /** Specifies text displayed for the toolbar item. */ - text?: string; - /** Specifies whether the item is displayed on a top or bottom toolbar. */ - toolbar?: string; - /** Specifies whether or not a widget item must be displayed. */ - visible?: boolean; - /** A widget that presents a toolbar item. */ - widget?: string; - } - export interface dxPopupOptions extends dxOverlayOptions { - /** Specifies whether or not to allow a user to drag the popup window. */ - dragEnabled?: boolean; - /** A Boolean value specifying whether or not to display the widget in full-screen mode. */ - fullScreen?: boolean; - position?: PositionOptions; - /** A Boolean value specifying whether or not to display the title in the popup window. */ - showTitle?: boolean; - /** The title in the overlay window. */ - title?: string; - /** A template to be used for rendering the widget title. */ - titleTemplate?: any; - width?: any; - /** Specifies items displayed on the top or bottom toolbar of the popup window. */ - buttons?: Array; - /** Specifies whether or not the widget displays the Close button. */ - showCloseButton?: boolean; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - } - /** A widget that displays required content in a popup window. */ - export class dxPopup extends dxOverlay { - constructor(element: JQuery, options?: dxPopupOptions); - constructor(element: Element, options?: dxPopupOptions); - } - export interface dxPopoverOptions extends dxPopupOptions { - /** An object that defines the animation options of the widget. */ - animation?: { - /** An object that defines the animation options used when the widget is being shown. */ - show?: fx.AnimationOptions; - /** An object that defines the animation options used when the widget is being hidden. */ - hide?: fx.AnimationOptions; - }; - /** Specifies the height of the widget. */ - height?: any; - /** An object defining widget positioning options. */ - position?: PositionOptions; - shading?: boolean; - /** A Boolean value specifying whether or not to display the title in the overlay window. */ - showTitle?: boolean; - /** The target element associated with a popover. */ - target?: any; - /** Specifies the width of the widget. */ - width?: any; - } - /** A widget that displays the required content in a popup window. */ - export class dxPopover extends dxPopup { - constructor(element: JQuery, options?: dxPopoverOptions); - constructor(element: Element, options?: dxPopoverOptions); - /** Displays the widget for the specified target element. */ - show(target?: any): JQueryPromise; - } - export interface dxOverlayOptions extends WidgetOptions { - /** An object that defines the animation options of the widget. */ - animation?: { - /** An object that defines the animation options used when the widget is being shown. */ - show?: fx.AnimationOptions; - /** An object that defines the animation options used when the widget is being hidden. */ - hide?: fx.AnimationOptions; - }; - /** A Boolean value specifying whether or not the widget is closed if a user presses the Back hardware button. */ - closeOnBackButton?: boolean; - /** A Boolean value specifying whether or not the widget is closed if a user clicks outside of the overlapping window. */ - closeOnOutsideClick?: any; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - /** Specifies whether or not an end-user can drag the widget. */ - dragEnabled?: boolean; - /** Specifies whether or not an end user can resize the widget. */ - resizeEnabled?: boolean; - /** The height of the widget in pixels. */ - height?: any; - /** Specifies the maximum height the widget can reach while resizing. */ - maxHeight?: any; - /** Specifies the maximum width the widget can reach while resizing. */ - maxWidth?: any; - /** Specifies the minimum height the widget can reach while resizing. */ - minHeight?: any; - /** Specifies the minimum width the widget can reach while resizing. */ - minWidth?: any; - /** A handler for the hidden event. */ - onHidden?: Function; - /** A handler for the resizeStart event. */ - onResizeStart?: Function; - /** A handler for the resize event. */ - onResize?: Function; - /** A handler for the resizeEnd event. */ - onResizeEnd?: Function; - /** A handler for the hiding event. */ - onHiding?: Function; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** A Boolean value specifying whether or not the main screen is inactive while the widget is active. */ - shading?: boolean; - /** Specifies the shading color. */ - shadingColor?: string; - /** A handler for the showing event. */ - onShowing?: Function; - /** A handler for the shown event. */ - onShown?: Function; - onContentReady?: Function; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - /** The widget width in pixels. */ - width?: any; - } - /** A widget displaying the required content in an overlay window. */ - export class dxOverlay extends Widget { - constructor(element: JQuery, options?: dxOverlayOptions); - constructor(element: Element, options?: dxOverlayOptions); - /** An HTML element of the widget. */ - content(): JQuery; - /** Hides the widget. */ - hide(): JQueryPromise; - /** Recalculates the overlay's size and position. */ - repaint(): void; - /** Shows the widget. */ - show(): JQueryPromise; - /** Toggles the visibility of the widget. */ - toggle(showing: boolean): JQueryPromise; - /** A static method that specifies the base z-index for all overlay widgets. */ - static baseZIndex(zIndex: number): void; - } - export interface dxNumberBoxOptions extends dxTextEditorOptions { - /** The maximum value accepted by the number box. */ - max?: number; - /** The minimum value accepted by the number box. */ - min?: number; - /** Specifies whether or not to show spin buttons. */ - showSpinButtons?: boolean; - useTouchSpinButtons?: boolean; - /** Specifies by which value the widget value changes when a spin button is clicked. */ - step?: number; - /** The current number box value. */ - value?: number; - /** The "mode" attribute value of the actual HTML input element representing the widget. */ - mode?: string; - } - /** A textbox widget that enables a user to enter numeric values. */ - export class dxNumberBox extends dxTextEditor { - constructor(element: JQuery, options?: dxNumberBoxOptions); - constructor(element: Element, options?: dxNumberBoxOptions); - } - export interface dxNavBarOptions extends dxTabsOptions { - scrollingEnabled?: boolean; - } - /** A widget that contains items used to navigate through application views. */ - export class dxNavBar extends dxTabs { - constructor(element: JQuery, options?: dxNavBarOptions); - constructor(element: Element, options?: dxNavBarOptions); - } - export interface dxMultiViewOptions extends CollectionWidgetOptions { - /** Specifies whether or not to animate the displayed item change. */ - animationEnabled?: boolean; - /** A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped. */ - loop?: boolean; - /** The index of the currently displayed item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to allow users to change the selected index by swiping. */ - swipeEnabled?: boolean; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - } - /** A widget used to display a view and to switch between several views. */ - export class dxMultiView extends CollectionWidget { - constructor(element: JQuery, options?: dxMultiViewOptions); - constructor(element: Element, options?: dxMultiViewOptions); - } - export interface dxMapOptions extends WidgetOptions { - /** Specifies whether or not the widget automatically adjusts center and zoom option values when adding a new marker or route, or when creating a widget if it initially contains markers or routes. */ - autoAdjust?: boolean; - center?: { - /** The latitude location displayed in the center of the widget. */ - lat?: number; - /** The longitude location displayed in the center of the widget. */ - lng?: number; - }; - /** A handler for the click event. */ - onClick?: any; - /** Specifies whether or not map widget controls are available. */ - controls?: boolean; - /** Specifies the height of the widget. */ - height?: any; - /** A key used to authenticate the application within the required map provider. */ - key?: { - /** A key used to authenticate the application within the "Bing" map provider. */ - bing?: string; - /** A key used to authenticate the application within the "Google" map provider. */ - google?: string; - /** A key used to authenticate the application within the "Google Static" map provider. */ - googleStatic?: string; - } - /** A handler for the markerAdded event. */ - onMarkerAdded?: Function; - /** A URL pointing to the custom icon to be used for map markers. */ - markerIconSrc?: string; - /** A handler for the markerRemoved event. */ - onMarkerRemoved?: Function; - /** An array of markers displayed on a map. */ - markers?: Array; - /** The name of the current map data provider. */ - provider?: string; - /** A handler for the ready event. */ - onReady?: Function; - /** A handler for the routeAdded event. */ - onRouteAdded?: Function; - /** A handler for the routeRemoved event. */ - onRouteRemoved?: Function; - /** An array of routes shown on the map. */ - routes?: Array; - /** The type of a map to display. */ - type?: string; - /** Specifies the width of the widget. */ - width?: any; - /** The zoom level of the map. */ - zoom?: number; - } - /** An interactive map widget. */ - export class dxMap extends Widget { - constructor(element: JQuery, options?: dxMapOptions); - constructor(element: Element, options?: dxMapOptions); - /** Adds a marker to the map. */ - addMarker(markerOptions: Object): JQueryPromise; - /** Adds a route to the map. */ - addRoute(routeOptions: Object): JQueryPromise; - /** Removes a marker from the map. */ - removeMarker(marker: Object): JQueryPromise; - /** Removes a route from the map. */ - removeRoute(route: any): JQueryPromise; - } - export interface dxLookupOptions extends dxDropDownListOptions { - applyValueMode?: string; - /** An object that defines widget animation options. */ - animation?: { - /** An object that defines the animation options used when the widget is being shown. */ - show?: fx.AnimationOptions; - /** An object that defines the animation options used when the widget is being hidden. */ - hide?: fx.AnimationOptions; - }; - /** The text displayed on the Cancel button. */ - cancelButtonText?: string; - /** The text displayed on the Clear button. */ - clearButtonText?: string; - /** Specifies whether or not the widget cleans the search box when the popup window is displayed. */ - cleanSearchOnOpening?: boolean; - /** A Boolean value specifying whether or not a widget is closed if a user clicks outside of the overlaying window. */ - closeOnOutsideClick?: any; - /** The text displayed on the Apply button. */ - applyButtonText?: string; - /** A Boolean value specifying whether or not to display the lookup in full-screen mode. */ - fullScreen?: boolean; - focusStateEnabled?: boolean; - /** A Boolean value specifying whether or not to group widget items. */ - grouped?: boolean; - /** The name of the template used to display a group header. */ - groupTemplate?: any; - /** The text displayed on the button used to load the next page from the data source. */ - nextButtonText?: string; - /** A handler for the pageLoading event. */ - onPageLoading?: Function; - /** Specifies whether the next page is loaded when a user scrolls the widget to the bottom or when the "next" button is clicked. */ - pageLoadMode?: string; - /** Specifies the text shown in the pullDown panel, which is displayed when the widget is scrolled to the bottom. */ - pageLoadingText?: string; - /** The text displayed by the widget when nothing is selected. */ - placeholder?: string; - /** The height of the widget popup element. */ - popupHeight?: any; - /** The width of the widget popup element. */ - popupWidth?: any; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** Specifies the text displayed in the pullDown panel when the widget is pulled below the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the pullRefresh event. */ - onPullRefresh?: Function; - /** A Boolean value specifying whether or not the widget supports the "pull down to refresh" gesture. */ - pullRefreshEnabled?: boolean; - /** Specifies the text displayed in the pullDown panel while the widget is being refreshed. */ - refreshingText?: string; - /** A handler for the scroll event. */ - onScroll?: Function; - /** A Boolean value specifying whether or not the search bar is visible. */ - searchEnabled?: boolean; - /** The text that is provided as a hint in the lookup's search bar. */ - searchPlaceholder?: string; - /** A Boolean value specifying whether or not the main screen is inactive while the lookup is active. */ - shading?: boolean; - /** Specifies whether to display the Cancel button in the lookup window. */ - showCancelButton?: boolean; - /** - * A Boolean value specifying whether the widget loads the next page automatically when you reach the bottom of the list or when a button is clicked. - * @deprecated Use the pageLoadMode option instead. - */ - showNextButton?: boolean; - /** The title of the lookup window. */ - title?: string; - /** A template to be used for rendering the widget title. */ - titleTemplate?: any; - /** Specifies whether or not the widget uses native scrolling. */ - useNativeScrolling?: boolean; - /** Specifies whether or not to show lookup contents in a dxPopover widget. */ - usePopover?: boolean; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - /** A Boolean value specifying whether or not to display the title in the popup window. */ - showPopupTitle?: boolean; - /** The template to be used for rendering the widget text field. */ - fieldTemplate?: any; - } - /** A widget that allows a user to select predefined values from a lookup window. */ - export class dxLookup extends dxDropDownList { - constructor(element: JQuery, options?: dxLookupOptions); - constructor(element: Element, options?: dxLookupOptions); - } - export interface dxLoadPanelOptions extends dxOverlayOptions { - /** An object defining the animation options of the widget. */ - animation?: fx.AnimationOptions; - /** The delay in milliseconds after which the load panel is displayed. */ - delay?: number; - /** The height of the widget. */ - height?: number; - /** A URL pointing to an image to be used as a load indicator. */ - indicatorSrc?: string; - /** The text displayed in the load panel. */ - message?: string; - /** A Boolean value specifying whether or not to show a load indicator. */ - showIndicator?: boolean; - /** A Boolean value specifying whether or not to show the pane behind the load indicator. */ - showPane?: boolean; - /** The width of the widget. */ - width?: number; - } - /** A widget used to indicate whether or not an element is loading. */ - export class dxLoadPanel extends dxOverlay { - constructor(element: JQuery, options?: dxLoadPanelOptions); - constructor(element: Element, options?: dxLoadPanelOptions); - } - export interface dxLoadIndicatorOptions extends WidgetOptions { - /** Specifies the path to an image used as the indicator. */ - indicatorSrc?: string; - } - /** The widget used to indicate the loading process. */ - export class dxLoadIndicator extends Widget { - constructor(element: JQuery, options?: dxLoadIndicatorOptions); - constructor(element: Element, options?: dxLoadIndicatorOptions); - } - /** An object containing items for a context menu called for a list item. */ - export interface ListOptionsMenuItem { - /** Specifies the menu item text. */ - text?: string; - /** Specifies the function called when the menu item is clicked. */ - action?: (itemElement: Element, itemData: any) => void; - } - export interface dxListOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not to display a grouped list. */ - grouped?: boolean; - /** The template to be used for rendering item groups. */ - groupTemplate?: any; - onItemDeleting?: Function; - /** A handler for the itemDeleted event. */ - onItemDeleted?: Function; - /** A handler for the groupRendered event. */ - onGroupRendered?: Function; - /** A handler for the itemReordered event. */ - onItemReordered?: Function; - /** A handler for the itemClick event. */ - onItemClick?: any; - /** A handler for the itemSwipe event. */ - onItemSwipe?: Function; - /** The text displayed on the button used to load the next page from the data source. */ - nextButtonText?: string; - /** A handler for the pageLoading event. */ - onPageLoading?: Function; - /** Specifies the text shown in the pullDown panel, which is displayed when the list is scrolled to the bottom. */ - pageLoadingText?: string; - /** Specifies the text displayed in the pullDown panel when the list is pulled below the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the pullRefresh event. */ - onPullRefresh?: Function; - /** A Boolean value specifying whether or not the widget supports the "pull down to refresh" gesture. */ - pullRefreshEnabled?: boolean; - /** Specifies the text displayed in the pullDown panel while the list is being refreshed. */ - refreshingText?: string; - /** A handler for the scroll event. */ - onScroll?: Function; - /** A Boolean value specifying whether to enable or disable list scrolling. */ - scrollingEnabled?: boolean; - /** Specifies when the widget shows the scrollbar. */ - showScrollbar?: string; - /** Specifies whether or not the widget uses native scrolling. */ - useNativeScrolling?: boolean; - /** A Boolean value specifying whether to enable or disable the bounce-back effect. */ - bounceEnabled?: boolean; - /** A Boolean value specifying if the list is scrolled by content. */ - scrollByContent?: boolean; - /** A Boolean value specifying if the list is scrolled using the scrollbar. */ - scrollByThumb?: boolean; - onItemContextMenu?: Function; - onItemHold?: Function; - /** Specifies whether or not an end-user can collapse groups. */ - collapsibleGroups?: boolean; - /** Specifies whether the next page is loaded when a user scrolls the widget to the bottom or when the "next" button is clicked. */ - pageLoadMode?: string; - /** Specifies whether or not to display controls used to select list items. */ - showSelectionControls?: boolean; - /** Specifies item selection mode. */ - selectionMode?: string; - selectAllText?: string; - onSelectAllChanged?: Function; - /** Specifies the array of items for a context menu called for a list item. */ - menuItems?: Array; - /** Specifies whether an item context menu is shown when a user holds or swipes an item. */ - menuMode?: string; - /** Specifies whether or not an end user can delete list items. */ - allowItemDeleting?: boolean; - /** Specifies the way a user can delete items from the list. */ - itemDeleteMode?: string; - /** Specifies whether or not an end user can reorder list items. */ - allowItemReordering?: boolean; - /** Specifies whether or not to show the loading panel when the DataSource bound to the widget is loading data. */ - indicateLoading?: boolean; - activeStateEnabled?: boolean; - } - /** A list widget. */ - export class dxList extends CollectionWidget { - constructor(element: JQuery, options?: dxListOptions); - constructor(element: Element, options?: dxListOptions); - /** Returns the height of the widget in pixels. */ - clientHeight(): number; - /** Removes the specified item from the list. */ - deleteItem(itemIndex: any): JQueryPromise; - /** Removes the specified item from the list. */ - deleteItem(itemElement: Element): JQueryPromise; - /** Returns a Boolean value that indicates whether or not the specified item is selected. */ - isItemSelected(itemIndex: any): boolean; - /** Returns a Boolean value that indicates whether or not the specified item is selected. */ - isItemSelected(itemElement: Element): boolean; - /** Reloads list data. */ - reload(): void; - /** Moves the specified item to the specified position in the list. */ - reorderItem(itemElement: Element, toItemElement: Element): JQueryPromise; - /** Moves the specified item to the specified position in the list. */ - reorderItem(itemIndex: any, toItemIndex: any): JQueryPromise; - /** Scrolls the list content by the specified number of pixels. */ - scrollBy(distance: number): void; - /** Returns the height of the list content in pixels. */ - scrollHeight(): number; - /** Scrolls list content to the specified position. */ - scrollTo(location: number): void; - /** Scrolls the list to the specified item. */ - scrollToItem(itemElement: Element): void; - /** Scrolls the list to the specified item. */ - scrollToItem(itemIndex: any): void; - /** Returns how far the list content is scrolled from the top. */ - scrollTop(): number; - /** Selects the specified item from the list. */ - selectItem(itemElement: Element): void; - /** Selects the specified item from the list. */ - selectItem(itemIndex: any): void; - /** Deselects the specified item from the list. */ - unselectItem(itemElement: Element): void; - /** Unselects the specified item from the list. */ - unselectItem(itemIndex: any): void; - /** Updates the widget scrollbar according to widget content size. */ - updateDimensions(): JQueryPromise; - /** Expands the specified group. */ - expandGroup(groupIndex: number): JQueryPromise; - /** Collapses the specified group. */ - collapseGroup(groupIndex: number): JQueryPromise; - } - export interface dxGalleryOptions extends CollectionWidgetOptions { - /** The time, in milliseconds, spent on slide animation. */ - animationDuration?: number; - /** Specifies whether or not to animate the displayed item change. */ - animationEnabled?: boolean; - /** A Boolean value specifying whether or not to allow users to switch between items by clicking an indicator. */ - indicatorEnabled?: boolean; - /** A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped. */ - loop?: boolean; - /** The index of the currently active gallery item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to display an indicator that points to the selected gallery item. */ - showIndicator?: boolean; - /** A Boolean value that specifies the availability of the "Forward" and "Back" navigation buttons. */ - showNavButtons?: boolean; - /** The time interval in milliseconds, after which the gallery switches to the next item. */ - slideshowDelay?: number; - /** A Boolean value specifying whether or not to allow users to switch between items by swiping. */ - swipeEnabled?: boolean; - /** Specifies whether or not to display parts of previous and next images along the sides of the current image. */ - wrapAround?: boolean; - /** Specifies if the widget stretches images to fit the total gallery width. */ - stretchImages?: boolean; - /** Specifies the width of an area used to display a single image. */ - initialItemWidth?: number; - } - /** An image gallery widget. */ - export class dxGallery extends CollectionWidget { - constructor(element: JQuery, options?: dxGalleryOptions); - constructor(element: Element, options?: dxGalleryOptions); - /** Shows the specified gallery item. */ - goToItem(itemIndex: number, animation: boolean): JQueryPromise; - /** Shows the next gallery item. */ - nextItem(animation: boolean): JQueryPromise; - /** Shows the previous gallery item. */ - prevItem(animation: boolean): JQueryPromise; - } - export interface dxDropDownEditorOptions extends dxTextBoxOptions { - /** Specifies the current value displayed by the widget. */ - value?: Object; - /** A handler for the closed event. */ - onClosed?: Function; - /** A handler for the opened event. */ - onOpened?: Function; - /** Specifies whether or not the drop-down editor is displayed. */ - opened?: boolean; - /** Specifies whether or not the widget allows an end-user to enter a custom value. */ - fieldEditEnabled?: boolean; - /** Specifies the way an end-user applies the selected value. */ - applyValueMode?: string; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - activeStateEnabled?: boolean; - } - /** A drop-down editor widget. */ - export class dxDropDownEditor extends dxTextBox { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - /** Closes the drop-down editor. */ - close(): void; - /** Opens the drop-down editor. */ - open(): void; - /** Resets the widget's value to null. */ - reset(): void; - /** Returns an <input> element of the widget. */ - field(): JQuery; - /** Returns an HTML element of the popup window content. */ - content(): JQuery; - } - export interface dxDateBoxOptions extends dxTextEditorOptions { - /** A format used to display date/time information. */ - format?: string; - /** A Globalize format string specifying the date display format. */ - formatString?: string; - /** The last date that can be selected within the widget. */ - max?: any; - /** The minimum date that can be selected within the widget. */ - min?: any; - /** The text displayed by the widget when the widget value is not yet specified. This text is also used as a title of the date picker. */ - placeholder?: string; - /** - * Specifies whether or not a user can pick out a date using the drop-down calendar. - * @deprecated Use the pickerType option instead. - */ - useCalendar?: boolean; - /** An object or a value, specifying the date and time currently selected using the date box. */ - value?: any; - /** - * Specifies whether or not the widget uses the native HTML input element. - * @deprecated Use the pickerType option instead. - */ - useNative?: boolean; - /** Specifies the interval between neighboring values in the popup list in minutes. */ - interval?: number; - /** Specifies the maximum zoom level of a calendar, which is used to pick the date. */ - maxZoomLevel?: string; - /** Specifies the minimal zoom level of a calendar, which is used to pick the date. */ - minZoomLevel?: string; - /** Specifies the type of date/time picker. */ - pickerType?: string; - /** Specifies the message displayed if the typed value is not a valid date or time. */ - invalidDateMessage?: string; - /** Specifies the message displayed if the specified date is later than the max value or earlier than the min value. */ - dateOutOfRangeMessage?: string; - /** The text displayed on the Apply button. */ - applyButtonText?: string; - /** The text displayed on the Cancel button. */ - cancelButtonText?: string; - } - /** A date box widget. */ - export class dxDateBox extends dxDropDownEditor { - constructor(element: JQuery, options?: dxDateBoxOptions); - constructor(element: Element, options?: dxDateBoxOptions); - } - export interface dxCheckBoxOptions extends EditorOptions { - activeStateEnabled?: boolean; - /** Specifies the widget state. */ - value?: boolean; - /** Specifies the text displayed by the check box. */ - text?: string; - } - /** A check box widget. */ - export class dxCheckBox extends Editor { - constructor(element: JQuery, options?: dxCheckBoxOptions); - constructor(element: Element, options?: dxCheckBoxOptions); - } - export interface dxCalendarOptions extends EditorOptions { - activeStateEnabled?: boolean; - /** Specifies a date displayed on the current calendar page. */ - currentDate?: Date; - /** Specifies the first day of a week. */ - firstDayOfWeek?: number; - /** An object or a value, specifying the date and time currently selected in the calendar. */ - value?: any; - /** The latest date the widget allows to select. */ - max?: any; - /** The earliest date the widget allows to select. */ - min?: any; - /** Specifies whether or not the widget displays a button that selects the current date. */ - showTodayButton?: boolean; - /** Specifies the current calendar zoom level. */ - zoomLevel?: string; - /** Specifies the maximum zoom level of the calendar. */ - maxZoomLevel?: string; - /** Specifies the minimum zoom level of the calendar. */ - minZoomLevel?: string; - /** The template to be used for rendering calendar cells. */ - cellTemplate?: any; - } - /** A calendar widget. */ - export class dxCalendar extends Editor { - constructor(element: JQuery, options?: dxCalendarOptions); - constructor(element: Element, options?: dxCalendarOptions); - } - export interface dxButtonOptions extends WidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A handler for the click event. */ - onClick?: any; - /** Specifies the icon to be displayed on the button. */ - icon?: string; - iconSrc?: string; - /** A template to be used for rendering the dxButton widget. */ - template?: any; - /** The text displayed on the button. */ - text?: string; - /** Specifies the button type. */ - type?: string; - /** Specifies the name of the validation group to be accessed in the click event handler. */ - validationGroup?: string; - } - /** A button widget. */ - export class dxButton extends Widget { - constructor(element: JQuery, options?: dxButtonOptions); - constructor(element: Element, options?: dxButtonOptions); - } - export interface dxBoxOptions extends CollectionWidgetOptions { - /** Specifies how widget items are aligned along the main direction. */ - align?: string; - /** Specifies the direction of item positioning in the widget. */ - direction?: string; - /** Specifies how widget items are aligned cross-wise. */ - crossAlign?: string; - } - /** A container widget used to arrange inner elements. */ - export class dxBox extends CollectionWidget { - constructor(element: JQuery, options?: dxBoxOptions); - constructor(element: Element, options?: dxBoxOptions); - } - export interface dxResponsiveBoxOptions extends CollectionWidgetOptions { - /** Specifies the collection of rows for the grid used to position layout elements. */ - rows?: Array; - /** Specifies the collection of columns for the grid used to position layout elements. */ - cols?: Array; - /** Specifies the function returning the screen factor depending on the screen width. */ - screenByWidth?: (width: number) => string; - /** Specifies the screen factor with which all elements are located in a single column. */ - singleColumnScreen?: string; - } - /** A widget used to build an adaptive markup that is dependent on screen resolution. */ - export class dxResponsiveBox extends CollectionWidget { - constructor(element: JQuery, options?: dxBoxOptions); - constructor(element: Element, options?: dxBoxOptions); - } - export interface dxAutocompleteOptions extends dxDropDownListOptions { - /** Specifies the current value displayed by the widget. */ - value?: string; - /** The minimum number of characters that must be entered into the text box to begin a search. */ - minSearchLength?: number; - /** Specifies the maximum count of items displayed by the widget. */ - maxItemCount?: number; - /** Gets the currently selected item. */ - selectedItem?: Object; - } - /** A textbox widget that supports autocompletion. */ - export class dxAutocomplete extends dxDropDownList { - constructor(element: JQuery, options?: dxAutocompleteOptions); - constructor(element: Element, options?: dxAutocompleteOptions); - /** Opens the drop-down editor. */ - open(): void; - /** Closes the drop-down editor. */ - close(): void; - } - export interface dxAccordionOptions extends CollectionWidgetOptions { - /** A number specifying the time in milliseconds spent on the animation of the expanding or collapsing of a panel. */ - animationDuration?: number; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies whether all items can be collapsed or whether at least one item must always be expanded. */ - collapsible?: boolean; - /** Specifies whether the widget can expand several items or only a single item at once. */ - multiple?: boolean; - /** The template to be used for rendering dxAccordion items. */ - itemTemplate?: any; - /** A handler for the itemTitleClick event. */ - onItemTitleClick?: any; - /** A handler for the itemTitleHold event. */ - onItemTitleHold?: Function; - /** The template to be used for rendering an item title. */ - itemTitleTemplate?: any; - /** The index number of the currently selected item. */ - selectedIndex?: number; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - } - /** A widget that displays data source items on collapsible panels. */ - export class dxAccordion extends CollectionWidget { - constructor(element: JQuery, options?: dxAccordionOptions); - constructor(element: Element, options?: dxAccordionOptions); - /** Collapses the specified item. */ - collapseItem(index: number): JQueryPromise; - /** Expands the specified item. */ - expandItem(index: number): JQueryPromise; - /** Updates the dimensions of the widget contents. */ - updateDimensions(): JQueryPromise; - } - export interface dxFileUploaderOptions extends EditorOptions { - /** A read-only option that holds a File instance representing the selected file. */ - value?: File; - /** Holds the File instances representing files selected in the widget. */ - values?: Array; - buttonText?: string; - /** The text displayed on the button that opens the file browser. */ - selectButtonText?: string; - /** The text displayed on the button that starts uploading. */ - uploadButtonText?: string; - /** Specifies the text displayed on the area to which an end-user can drop a file. */ - labelText?: string; - /** Specifies the value passed to the name attribute of the underlying input element. */ - name?: string; - /** Specifies whether the widget enables an end-user to select a single file or multiple files. */ - multiple?: boolean; - /** Specifies a file type or several types accepted by the widget. */ - accept?: string; - /** Specifies a target Url for the upload request. */ - uploadUrl?: string; - /** Specifies if an end user can remove a file from the selection and interrupt uploading. */ - allowCanceling?: boolean; - /** Specifies whether or not the widget displays the list of selected files. */ - showFileList?: boolean; - /** Gets the current progress in percentages. */ - progress?: number; - /** The message displayed by the widget when it is ready to upload the specified files. */ - readyToUploadMessage?: string; - /** The message displayed by the widget when uploading is finished. */ - uploadedMessage?: string; - /** The message displayed by the widget on uploading failure. */ - uploadFailedMessage?: string; - /** Specifies how the widget uploads files. */ - uploadMode?: string; - /** A handler for the uploaded event. */ - onUploaded?: Function; - /** A handler for the uploaded event. */ - onProgress?: Function; - /** A handler for the uploadError event. */ - onUploadError?: Function; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - } - /** A widget used to select and upload a file or multiple files. */ - export class dxFileUploader extends Editor { - constructor(element: JQuery, options?: dxFileUploaderOptions); - constructor(element: Element, options?: dxFileUploaderOptions); - } - export interface dxTrackBarOptions extends EditorOptions { - /** The minimum value the widget can accept. */ - min?: number; - /** The maximum value the widget can accept. */ - max?: number; - /** The current widget value. */ - value?: number; - } - /** A base class for track bar widgets. */ - export class dxTrackBar extends Editor { - constructor(element: JQuery, options?: dxTrackBarOptions); - constructor(element: Element, options?: dxTrackBarOptions); - } - export interface dxProgressBarOptions extends dxTrackBarOptions { - /** Specifies a format for the progress status. */ - statusFormat?: any; - /** Specifies whether or not the widget displays a progress status. */ - showStatus?: boolean; - /** A handler for the complete event. */ - onComplete?: Function; - } - /** A widget used to indicate progress. */ - export class dxProgressBar extends dxTrackBar { - constructor(element: JQuery, options?: dxProgressBarOptions); - constructor(element: Element, options?: dxProgressBarOptions); - } - export interface dxSliderOptions extends dxTrackBarOptions { - activeStateEnabled?: boolean; - /** The slider step size. */ - step?: number; - /** The current slider value. */ - value?: number; - /** Specifies whether or not to highlight a range selected within the widget. */ - showRange?: boolean; - /** Specifies the size of a step by which a slider handle is moved when a user uses the Page up or Page down keyboard shortcuts. */ - keyStep?: number; - /** Specifies options for the slider tooltip. */ - tooltip?: { - /** Specifies whether or not the tooltip is enabled. */ - enabled?: boolean; - /** Specifies format for the tooltip. */ - format?: any; - /** Specifies whether the tooltip is located over or under the slider. */ - position?: string; - /** Specifies whether the widget always shows a tooltip or only when a pointer is over the slider. */ - showMode?: string; - }; - /** Specifies options for labels displayed at the min and max values. */ - label?: { - /** Specifies whether or not slider labels are visible. */ - visible?: boolean; - /** Specifies whether labels are located over or under the scale. */ - position?: string; - /** Specifies a format for labels. */ - format?: any; - }; - } - /** A widget that allows a user to select a numeric value within a given range. */ - export class dxSlider extends dxTrackBar { - constructor(element: JQuery, options?: dxSliderOptions); - constructor(element: Element, options?: dxSliderOptions); - } - export interface dxRangeSliderOptions extends dxSliderOptions { - /** The left edge of the interval currently selected using the range slider. */ - start?: number; - /** The right edge of the interval currently selected using the range slider. */ - end?: number; - } - /** A widget that enables a user to select a range of numeric values. */ - export class dxRangeSlider extends dxSlider { - constructor(element: JQuery, options?: dxRangeSliderOptions); - constructor(element: Element, options?: dxRangeSliderOptions); - } - export interface dxFormItemLabel { - /** Specifies the label text. */ - text?: string; - /** Specifies whether or not the label is visible. */ - visible?: boolean; - /** Specifies whether or not a colon is displayed at the end of the current label. */ - showColon?: boolean; - /** Specifies the location of a label against the editor. */ - location?: string; - /** Specifies the label horizontal alignment. */ - alignment?: string; - } - export interface dxFormItem { - /** Specifies the type of the current item. */ - itemType?: string; - /** Specifies whether or not the current form item is visible. */ - visible?: boolean; - /** Specifies the sequence number of the item in a form, group or tab. */ - visibleIndex?: number; - /** Specifies a CSS class to be applied to the form item. */ - cssClass?: string; - /** Specifies the number of columns spanned by the item. */ - colSpan?: number; - } - export interface dxFormEmptyItem extends dxFormItem { - /** Specifies the form item name. */ - name?: string; - } - export interface dxFormSimpleItem extends dxFormItem { - /** Specifies the path to the formData object field bound to the current form item. */ - dataField?: string; - /** Specifies the form item name. */ - name?: string; - /** Specifies which editor widget is used to display and edit the form item value. */ - editorType?: string; - /** Specifies configuration options for the editor widget of the current form item. */ - editorOptions?: Object; - /** A template to be used for rendering the form item. */ - template?: any; - /** Specifies the help text displayed for the current form item. */ - helpText?: string; - /** Specifies whether the current form item is required. */ - isRequired?: boolean; - /** Specifies options for the form item label. */ - label?: dxFormItemLabel; - /** An array of validation rules to be checked for the form item editor. */ - validationRules?: Array; - } - export interface dxFormGroupItem extends dxFormItem { - /** Specifies the group caption. */ - caption?: string; - /** A template to be used for rendering the group item. */ - template?: any; - /** The count of columns in the group layout. */ - colCount?: number; - /** Specifies whether or not all group item labels are aligned. */ - alignItemLabels?: boolean; - /** Holds an array of form items displayed within the group. */ - items?: Array; - } - export interface dxFormTab { - /** Specifies the tab title. */ - title?: string; - /** The count of columns in the tab layout. */ - colCount?: number; - /** Specifies whether or not labels of items displayed within the current tab are aligned. */ - alignItemLabels?: boolean; - /** Holds an array of form items displayed within the tab. */ - items?: Array; - /** Specifies a badge text for the tab. */ - badge?: string; - /** A Boolean value specifying whether or not the tab can respond to user interaction. */ - disabled?: boolean; - /** Specifies the icon to be displayed on the tab. */ - icon?: string; - /** The template to be used for rendering the tab. */ - tabTemplate?: any; - /** The template to be used for rendering the tab content. */ - template?: any; - } - export interface dxFormTabbedItem extends dxFormItem { - /** Holds a configuration object for the dxTabPanel widget used to display the current form item. */ - tabPanelOptions?: Object; - /** An array of tab configuration objects. */ - tabs?: Array; - } - export interface dxFormOptions extends WidgetOptions { - /** An object providing data for the form. */ - formData?: Object; - /** The count of columns in the form layout. */ - colCount?: any; - /** Specifies the location of a label against the editor. */ - labelLocation?: string; - /** Specifies whether or not all editors on the form are read-only. */ - readOnly?: boolean; - /** A handler for the fieldDataChanged event. */ - onFieldDataChanged?: (e: Object) => void; - /** A handler for the editorEnterKey event. */ - onEditorEnterKey?: (e: Object) => void; - /** Specifies a function that customizes a form item after it has been created. */ - customizeItem?: Function; - /** The minimum column width used for calculating column count in the form layout. */ - minColWidth?: number; - /** Specifies whether or not all root item labels are aligned. */ - alignItemLabels?: boolean; - /** Specifies whether or not item labels in all groups are aligned. */ - alignItemLabelsInAllGroups?: boolean; - /** Specifies whether or not a colon is displayed at the end of form labels. */ - showColonAfterLabel?: boolean; - /** Specifies whether or not the required mark is displayed for required fields. */ - showRequiredMark?: boolean; - /** Specifies whether or not the optional mark is displayed for optional fields. */ - showOptionalMark?: boolean; - /** The text displayed for required fields. */ - requiredMark?: string; - /** The text displayed for optional fields. */ - optionalMark?: string; - /** Specifies the message that is shown for end-users if a required field value is not specified. */ - requiredMessage?: string; - /** Specifies whether or not the total validation summary is displayed on the form. */ - showValidationSummary?: boolean; - /** Holds an array of form items. */ - items?: Array; - /** A Boolean value specifying whether to enable or disable form scrolling. */ - scrollingEnabled?: boolean; - onContentReady?: Function; - } - /** A form widget used to display and edit values of object fields. */ - export class dxForm extends Widget { - constructor(element: JQuery, options?: dxFormOptions); - constructor(element: Element, options?: dxFormOptions); - /** Updates the specified field of the formData object and the corresponding editor on the form. */ - updateData(dataField: string, value: any): void; - /** Updates the specified fields of the formData object and the corresponding editors on the form. */ - updateData(data: Object): void; - /** Updates the value of a form item option. */ - itemOption(field: string, option: string, value: any): void; - /** Updates the values of form item options. */ - itemOption(field: string, options: Object): void; - /** Returns an editor instance associated with the specified formData field. */ - getEditor(field: string): Object; - /** Updates the dimensions of the widget contents. */ - updateDimensions(): JQueryPromise; - /** Validates the values of all editors on the form against the list of the validation rules specified for each form item. */ - validate(): Object; - /** Resets the editor's value to undefined. */ - resetValues(): void; - } -} -interface JQuery { - dxProgressBar(): JQuery; - dxProgressBar(options: "instance"): DevExpress.ui.dxProgressBar; - dxProgressBar(options: string): any; - dxProgressBar(options: string, ...params: any[]): any; - dxProgressBar(options: DevExpress.ui.dxProgressBarOptions): JQuery; - dxSlider(): JQuery; - dxSlider(options: "instance"): DevExpress.ui.dxSlider; - dxSlider(options: string): any; - dxSlider(options: string, ...params: any[]): any; - dxSlider(options: DevExpress.ui.dxSliderOptions): JQuery; - dxRangeSlider(): JQuery; - dxRangeSlider(options: "instance"): DevExpress.ui.dxRangeSlider; - dxRangeSlider(options: string): any; - dxRangeSlider(options: string, ...params: any[]): any; - dxRangeSlider(options: DevExpress.ui.dxRangeSliderOptions): JQuery; - dxFileUploader(): JQuery; - dxFileUploader(options: "instance"): DevExpress.ui.dxFileUploader; - dxFileUploader(options: string): any; - dxFileUploader(options: string, ...params: any[]): any; - dxFileUploader(options: DevExpress.ui.dxFileUploaderOptions): JQuery; - dxValidator(): JQuery; - dxValidator(options: "instance"): DevExpress.ui.dxValidator; - dxValidator(options: string): any; - dxValidator(options: string, ...params: any[]): any; - dxValidator(options: DevExpress.ui.dxValidatorOptions): JQuery; - dxValidationGroup(): JQuery; - dxValidationGroup(options: "instance"): DevExpress.ui.dxValidationGroup; - dxValidationGroup(options: string): any; - dxValidationGroup(options: string, ...params: any[]): any; - dxValidationSummary(): JQuery; - dxValidationSummary(options: "instance"): DevExpress.ui.dxValidationSummary; - dxValidationSummary(options: string): any; - dxValidationSummary(options: string, ...params: any[]): any; - dxValidationSummary(options: DevExpress.ui.dxValidationSummaryOptions): JQuery; - dxTooltip(): JQuery; - dxTooltip(options: "instance"): DevExpress.ui.dxTooltip; - dxTooltip(options: string): any; - dxTooltip(options: string, ...params: any[]): any; - dxTooltip(options: DevExpress.ui.dxTooltipOptions): JQuery; - dxResizable(): JQuery; - dxResizable(options: "instance"): DevExpress.ui.dxResizable; - dxResizable(options: string): any; - dxResizable(options: string, ...params: any[]): any; - dxResizable(options: DevExpress.ui.dxResizableOptions): JQuery; - dxDropDownList(): JQuery; - dxDropDownList(options: "instance"): DevExpress.ui.dxDropDownList; - dxDropDownList(options: string): any; - dxDropDownList(options: string, ...params: any[]): any; - dxDropDownList(options: DevExpress.ui.dxDropDownListOptions): JQuery; - dxToolbar(): JQuery; - dxToolbar(options: "instance"): DevExpress.ui.dxToolbar; - dxToolbar(options: string): any; - dxToolbar(options: string, ...params: any[]): any; - dxToolbar(options: DevExpress.ui.dxToolbarOptions): JQuery; - dxToast(): JQuery; - dxToast(options: "instance"): DevExpress.ui.dxToast; - dxToast(options: string): any; - dxToast(options: string, ...params: any[]): any; - dxToast(options: DevExpress.ui.dxToastOptions): JQuery; - dxTextEditor(): JQuery; - dxTextEditor(options: "instance"): DevExpress.ui.dxTextEditor; - dxTextEditor(options: string): any; - dxTextEditor(options: string, ...params: any[]): any; - dxTextEditor(options: DevExpress.ui.dxTextEditorOptions): JQuery; - dxTextBox(): JQuery; - dxTextBox(options: "instance"): DevExpress.ui.dxTextBox; - dxTextBox(options: string): any; - dxTextBox(options: string, ...params: any[]): any; - dxTextBox(options: DevExpress.ui.dxTextBoxOptions): JQuery; - dxTextArea(): JQuery; - dxTextArea(options: "instance"): DevExpress.ui.dxTextArea; - dxTextArea(options: string): any; - dxTextArea(options: string, ...params: any[]): any; - dxTextArea(options: DevExpress.ui.dxTextAreaOptions): JQuery; - dxTabs(): JQuery; - dxTabs(options: "instance"): DevExpress.ui.dxTabs; - dxTabs(options: string): any; - dxTabs(options: string, ...params: any[]): any; - dxTabs(options: DevExpress.ui.dxTabsOptions): JQuery; - dxTabPanel(): JQuery; - dxTabPanel(options: "instance"): DevExpress.ui.dxTabPanel; - dxTabPanel(options: string): any; - dxTabPanel(options: string, ...params: any[]): any; - dxTabPanel(options: DevExpress.ui.dxTabPanelOptions): JQuery; - dxSelectBox(): JQuery; - dxSelectBox(options: "instance"): DevExpress.ui.dxSelectBox; - dxSelectBox(options: string): any; - dxSelectBox(options: string, ...params: any[]): any; - dxSelectBox(options: DevExpress.ui.dxSelectBoxOptions): JQuery; - dxTagBox(): JQuery; - dxTagBox(options: "instance"): DevExpress.ui.dxTagBox; - dxTagBox(options: string): any; - dxTagBox(options: string, ...params: any[]): any; - dxTagBox(options: DevExpress.ui.dxTagBoxOptions): JQuery; - dxScrollView(): JQuery; - dxScrollView(options: "instance"): DevExpress.ui.dxScrollView; - dxScrollView(options: string): any; - dxScrollView(options: string, ...params: any[]): any; - dxScrollView(options: DevExpress.ui.dxScrollViewOptions): JQuery; - dxScrollable(): JQuery; - dxScrollable(options: "instance"): DevExpress.ui.dxScrollable; - dxScrollable(options: string): any; - dxScrollable(options: string, ...params: any[]): any; - dxScrollable(options: DevExpress.ui.dxScrollableOptions): JQuery; - dxRadioGroup(): JQuery; - dxRadioGroup(options: "instance"): DevExpress.ui.dxRadioGroup; - dxRadioGroup(options: string): any; - dxRadioGroup(options: string, ...params: any[]): any; - dxRadioGroup(options: DevExpress.ui.dxRadioGroupOptions): JQuery; - dxPopup(): JQuery; - dxPopup(options: "instance"): DevExpress.ui.dxPopup; - dxPopup(options: string): any; - dxPopup(options: string, ...params: any[]): any; - dxPopup(options: DevExpress.ui.dxPopupOptions): JQuery; - dxPopover(): JQuery; - dxPopover(options: "instance"): DevExpress.ui.dxPopover; - dxPopover(options: string): any; - dxPopover(options: string, ...params: any[]): any; - dxPopover(options: DevExpress.ui.dxPopoverOptions): JQuery; - dxOverlay(): JQuery; - dxOverlay(options: "instance"): DevExpress.ui.dxOverlay; - dxOverlay(options: string): any; - dxOverlay(options: string, ...params: any[]): any; - dxOverlay(options: DevExpress.ui.dxOverlayOptions): JQuery; - dxNumberBox(): JQuery; - dxNumberBox(options: "instance"): DevExpress.ui.dxNumberBox; - dxNumberBox(options: string): any; - dxNumberBox(options: string, ...params: any[]): any; - dxNumberBox(options: DevExpress.ui.dxNumberBoxOptions): JQuery; - dxNavBar(): JQuery; - dxNavBar(options: "instance"): DevExpress.ui.dxNavBar; - dxNavBar(options: string): any; - dxNavBar(options: string, ...params: any[]): any; - dxNavBar(options: DevExpress.ui.dxNavBarOptions): JQuery; - dxMultiView(): JQuery; - dxMultiView(options: "instance"): DevExpress.ui.dxMultiView; - dxMultiView(options: string): any; - dxMultiView(options: string, ...params: any[]): any; - dxMultiView(options: DevExpress.ui.dxMultiViewOptions): JQuery; - dxMap(): JQuery; - dxMap(options: "instance"): DevExpress.ui.dxMap; - dxMap(options: string): any; - dxMap(options: string, ...params: any[]): any; - dxMap(options: DevExpress.ui.dxMapOptions): JQuery; - dxLookup(): JQuery; - dxLookup(options: "instance"): DevExpress.ui.dxLookup; - dxLookup(options: string): any; - dxLookup(options: string, ...params: any[]): any; - dxLookup(options: DevExpress.ui.dxLookupOptions): JQuery; - dxLoadPanel(): JQuery; - dxLoadPanel(options: "instance"): DevExpress.ui.dxLoadPanel; - dxLoadPanel(options: string): any; - dxLoadPanel(options: string, ...params: any[]): any; - dxLoadPanel(options: DevExpress.ui.dxLoadPanelOptions): JQuery; - dxLoadIndicator(): JQuery; - dxLoadIndicator(options: "instance"): DevExpress.ui.dxLoadIndicator; - dxLoadIndicator(options: string): any; - dxLoadIndicator(options: string, ...params: any[]): any; - dxLoadIndicator(options: DevExpress.ui.dxLoadIndicatorOptions): JQuery; - dxList(): JQuery; - dxList(options: "instance"): DevExpress.ui.dxList; - dxList(options: string): any; - dxList(options: string, ...params: any[]): any; - dxList(options: DevExpress.ui.dxListOptions): JQuery; - dxGallery(): JQuery; - dxGallery(options: "instance"): DevExpress.ui.dxGallery; - dxGallery(options: string): any; - dxGallery(options: string, ...params: any[]): any; - dxGallery(options: DevExpress.ui.dxGalleryOptions): JQuery; - dxDropDownEditor(): JQuery; - dxDropDownEditor(options: "instance"): DevExpress.ui.dxDropDownEditor; - dxDropDownEditor(options: string): any; - dxDropDownEditor(options: string, ...params: any[]): any; - dxDropDownEditor(options: DevExpress.ui.dxDropDownEditorOptions): JQuery; - dxDateBox(): JQuery; - dxDateBox(options: "instance"): DevExpress.ui.dxDateBox; - dxDateBox(options: string): any; - dxDateBox(options: string, ...params: any[]): any; - dxDateBox(options: DevExpress.ui.dxDateBoxOptions): JQuery; - dxCheckBox(): JQuery; - dxCheckBox(options: "instance"): DevExpress.ui.dxCheckBox; - dxCheckBox(options: string): any; - dxCheckBox(options: string, ...params: any[]): any; - dxCheckBox(options: DevExpress.ui.dxCheckBoxOptions): JQuery; - dxBox(): JQuery; - dxBox(options: "instance"): DevExpress.ui.dxBox; - dxBox(options: string): any; - dxBox(options: string, ...params: any[]): any; - dxBox(options: DevExpress.ui.dxBoxOptions): JQuery; - dxButton(): JQuery; - dxButton(options: "instance"): DevExpress.ui.dxButton; - dxButton(options: string): any; - dxButton(options: string, ...params: any[]): any; - dxButton(options: DevExpress.ui.dxButtonOptions): JQuery; - dxCalendar(): JQuery; - dxCalendar(options: "instance"): DevExpress.ui.dxCalendar; - dxCalendar(options: string): any; - dxCalendar(options: string, ...params: any[]): any; - dxCalendar(options: DevExpress.ui.dxCalendarOptions): JQuery; - dxAccordion(): JQuery; - dxAccordion(options: "instance"): DevExpress.ui.dxAccordion; - dxAccordion(options: string): any; - dxAccordion(options: string, ...params: any[]): any; - dxAccordion(options: DevExpress.ui.dxAccordionOptions): JQuery; - dxResponsiveBox(): JQuery; - dxResponsiveBox(options: "instance"): DevExpress.ui.dxResponsiveBox; - dxResponsiveBox(options: string): any; - dxResponsiveBox(options: string, ...params: any[]): any; - dxResponsiveBox(options: DevExpress.ui.dxResponsiveBoxOptions): JQuery; - dxAutocomplete(): JQuery; - dxAutocomplete(options: "instance"): DevExpress.ui.dxAutocomplete; - dxAutocomplete(options: string): any; - dxAutocomplete(options: string, ...params: any[]): any; - dxAutocomplete(options: DevExpress.ui.dxAutocompleteOptions): JQuery; - dxForm(): JQuery; - dxForm(options: "instance"): DevExpress.ui.dxForm; - dxForm(options: string): any; - dxForm(options: string, ...params: any[]): any; - dxForm(options: DevExpress.ui.dxFormOptions): JQuery; -} - -declare module DevExpress.ui { - export interface dxTileViewOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** Specifies the height of the base tile view item. */ - baseItemHeight?: number; - /** Specifies the width of the base tile view item. */ - baseItemWidth?: number; - /** Specifies whether tiles are placed horizontally or vertically. */ - direction?: string; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies the distance in pixels between adjacent tiles. */ - itemMargin?: number; - /** A Boolean value specifying whether or not to display a scrollbar. */ - showScrollbar?: boolean; - } - /** A widget displaying several blocks of data as tiles. */ - export class dxTileView extends CollectionWidget { - constructor(element: JQuery, options?: dxTileViewOptions); - constructor(element: Element, options?: dxTileViewOptions); - /** Returns the current scroll position of the widget content. */ - scrollPosition(): number; - } - export interface dxSwitchOptions extends EditorOptions { - activeStateEnabled?: boolean; - /** Text displayed when the widget is in a disabled state. */ - offText?: string; - /** Text displayed when the widget is in an enabled state. */ - onText?: string; - /** A Boolean value specifying whether the current switch state is "On" or "Off". */ - value?: boolean; - } - /** A switch widget. */ - export class dxSwitch extends Editor { - constructor(element: JQuery, options?: dxSwitchOptions); - constructor(element: Element, options?: dxSwitchOptions); - } - export interface dxSlideOutViewOptions extends WidgetOptions { - /** Specifies the current menu position. */ - menuPosition?: string; - /** Specifies whether or not the menu panel is visible. */ - menuVisible?: boolean; - /** Specifies whether or not the menu is shown when a user swipes the widget content. */ - swipeEnabled?: boolean; - /** A template to be used for rendering menu panel content. */ - menuTemplate?: any; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - } - /** The widget that allows you to slide-out the current view to reveal a custom menu. */ - export class dxSlideOutView extends Widget { - constructor(element: JQuery, options?: dxSlideOutViewOptions); - constructor(element: Element, options?: dxSlideOutViewOptions); - /** Returns an HTML element of the widget menu block. */ - menuContent(): JQuery; - /** Returns an HTML element of the widget content block. */ - content(): JQuery; - /** Displays the widget's menu block. */ - showMenu(): JQueryPromise; - /** Hides the widget's menu block. */ - hideMenu(): JQueryPromise; - /** Toggles the visibility of the widget's menu block. */ - toggleMenuVisibility(): JQueryPromise; - } - export interface dxSlideOutOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A Boolean value specifying whether or not to display a grouped menu. */ - menuGrouped?: boolean; - /** Specifies the current menu position. */ - menuPosition?: string; - /** The name of the template used to display a group header. */ - menuGroupTemplate?: any; - /** The template used to render menu items. */ - menuItemTemplate?: any; - /** A handler for the menuGroupRendered event. */ - onMenuGroupRendered?: Function; - /** A handler for the menuItemRendered event. */ - onMenuItemRendered?: Function; - /** Specifies whether or not the slide-out menu is displayed. */ - menuVisible?: boolean; - /** Indicates whether the menu can be shown/hidden by swiping the widget's main panel. */ - swipeEnabled?: boolean; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - } - /** The widget that allows you to slide-out the current view to reveal an item list. */ - export class dxSlideOut extends CollectionWidget { - constructor(element: JQuery, options?: dxSlideOutOptions); - constructor(element: Element, options?: dxSlideOutOptions); - /** Hides the widget's slide-out menu. */ - hideMenu(): JQueryPromise; - /** Displays the widget's slide-out menu. */ - showMenu(): JQueryPromise; - /** Toggles the visibility of the widget's slide-out menu. */ - toggleMenuVisibility(showing: boolean): JQueryPromise; - } - export interface dxPivotOptions extends CollectionWidgetOptions { - /** The index of the currently active pivot item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to allow users to switch between items by swiping. */ - swipeEnabled?: boolean; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - /** The template to be used for rendering an item title. */ - itemTitleTemplate?: any; - } - /** A widget that is similar to a traditional tab control, but optimized for the phone with simplified end-user interaction. */ - export class dxPivot extends CollectionWidget { - constructor(element: JQuery, options?: dxPivotOptions); - constructor(element: Element, options?: dxPivotOptions); - } - export interface dxPanoramaOptions extends CollectionWidgetOptions { - /** An object exposing options for setting a background image for the panorama. */ - backgroundImage?: { - /** Specifies the height of the panorama's background image. */ - height?: number; - /** Specifies the URL of the image that is used as the panorama's background image. */ - url?: string; - /** Specifies the width of the panorama's background image. */ - width?: number; - }; - /** The index of the currently active panorama item. */ - selectedIndex?: number; - /** Specifies the widget content title. */ - title?: string; - } - /** A widget displaying the required content in a long horizontal canvas that extends beyond the frames of the screen. */ - export class dxPanorama extends CollectionWidget { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - } - export interface dxDropDownMenuOptions extends WidgetOptions { - /** A handler for the buttonClick event. */ - onButtonClick?: any; - /** The name of the icon to be displayed by the DropDownMenu button. */ - buttonIcon?: string; - /** The text displayed in the DropDownMenu button. */ - buttonText?: string; - buttonIconSrc?: string; - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** A handler for the itemClick event. */ - onItemClick?: any; - /** An array of items displayed by the widget. */ - items?: Array; - /** The template to be used for rendering items. */ - itemTemplate?: any; - /** Specifies whether or not to show the drop down menu within a dxPopover widget. */ - usePopover?: boolean; - /** The width of the menu popup in pixels. */ - popupWidth?: any; - /** The height of the menu popup in pixels. */ - popupHeight?: any; - /** Specifies whether or not the drop-down menu is displayed. */ - opened?: boolean; - hoverStateEnabled?: boolean; - activeStateEnabled?: boolean; - } - /** A drop-down menu widget. */ - export class dxDropDownMenu extends Widget { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - /** Opens the drop-down menu. */ - open(): void; - /** Closes the drop-down menu. */ - close(): void; - } - export interface dxActionSheetOptions extends CollectionWidgetOptions { - /** A handler for the cancelClick event. */ - onCancelClick?: any; - /** The text displayed in the button that closes the action sheet. */ - cancelText?: string; - /** Specifies whether or not to display the Cancel button in action sheet. */ - showCancelButton?: boolean; - /** A Boolean value specifying whether or not the title of the action sheet is visible. */ - showTitle?: boolean; - /** Specifies the element the action sheet popover points at. */ - target?: any; - /** The title of the action sheet. */ - title?: string; - /** Specifies whether or not to show the action sheet within a dxPopover widget. */ - usePopover?: boolean; - /** A Boolean value specifying whether or not the dxActionSheet widget is visible. */ - visible?: boolean; - } - /** A widget consisting of a set of choices related to a certain task. */ - export class dxActionSheet extends CollectionWidget { - constructor(element: JQuery, options?: dxActionSheetOptions); - constructor(element: Element, options?: dxActionSheetOptions); - /** Hides the widget. */ - hide(): JQueryPromise; - /** Shows the widget. */ - show(): JQueryPromise; - /** Shows or hides the widget depending on the Boolean value passed as the parameter. */ - toggle(showing: boolean): JQueryPromise; - } -} -interface JQuery { - dxTileView(): JQuery; - dxTileView(options: "instance"): DevExpress.ui.dxTileView; - dxTileView(options: string): any; - dxTileView(options: string, ...params: any[]): any; - dxTileView(options: DevExpress.ui.dxTileViewOptions): JQuery; - dxSwitch(): JQuery; - dxSwitch(options: "instance"): DevExpress.ui.dxSwitch; - dxSwitch(options: string): any; - dxSwitch(options: string, ...params: any[]): any; - dxSwitch(options: DevExpress.ui.dxSwitchOptions): JQuery; - dxSlideOut(): JQuery; - dxSlideOut(options: "instance"): DevExpress.ui.dxSlideOut; - dxSlideOut(options: string): any; - dxSlideOut(options: string, ...params: any[]): any; - dxSlideOut(options: DevExpress.ui.dxSlideOutOptions): JQuery; - dxPivot(): JQuery; - dxPivot(options: "instance"): DevExpress.ui.dxPivot; - dxPivot(options: string): any; - dxPivot(options: string, ...params: any[]): any; - dxPivot(options: DevExpress.ui.dxPivotOptions): JQuery; - dxPanorama(): JQuery; - dxPanorama(options: "instance"): DevExpress.ui.dxPanorama; - dxPanorama(options: string): any; - dxPanorama(options: string, ...params: any[]): any; - dxPanorama(options: DevExpress.ui.dxPanoramaOptions): JQuery; - dxActionSheet(): JQuery; - dxActionSheet(options: "instance"): DevExpress.ui.dxActionSheet; - dxActionSheet(options: string): any; - dxActionSheet(options: string, ...params: any[]): any; - dxActionSheet(options: DevExpress.ui.dxActionSheetOptions): JQuery; - dxDropDownMenu(): JQuery; - dxDropDownMenu(options: "instance"): DevExpress.ui.dxDropDownMenu; - dxDropDownMenu(options: string): any; - dxDropDownMenu(options: string, ...params: any[]): any; - dxDropDownMenu(options: DevExpress.ui.dxDropDownMenuOptions): JQuery; -} -declare module DevExpress.data { - export interface XmlaStoreOptions { - /** The HTTP address to an XMLA OLAP server. */ - url?: string; - /** The name of the database associated with the Store. */ - catalog?: string; - /** The cube name. */ - cube?: string; - /** A function used to customize a web request before it is sent. */ - beforeSend?: (request: Object) => void; - } - /** A Store that provides access to an OLAP cube using the XMLA standard. */ - export class XmlaStore { - constructor(options: XmlaStoreOptions); - } - export interface PivotGridField { - index?: number; - /** A boolean value specifying whether or not the field is visible in the pivot grid and the Field Chooser. */ - visible?: boolean; - /** Name of the data source field containing data for the pivot grid field. */ - dataField?: string; - /** A caption that will be displayed in the pivot grid's field chooser to identify the field. */ - caption?: string; - /** Specifies a type of field values. */ - dataType?: string; - /** Specifies how the values of the current field are combined into groups. Cannot be used for the XmlaStore store type. */ - groupInterval?: any; - /** Specifies how to aggregate field data. Cannot be used for the XmlaStore store type. */ - summaryType?: string; - /** Allows you to use a custom aggregate function to calculate the summary values. Cannot be used for the XmlaStore store type. */ - calculateCustomSummary?: (options: { - summaryProcess?: string; - value?: any; - totalValue?: any; - }) => void; - /** Specifies the function that determines how to split data from the data source into ranges for header items. Cannot be used for the XmlaStore store type. */ - selector?: (data: Object) => any; - /** Type of the area where the field is located. */ - area?: string; - /** Index among the other fields displayed within the same area. */ - areaIndex?: number; - /** The name of the folder in which the field is located. */ - displayFolder?: string; - /** The name of the group to which the field belongs. */ - groupName?: string; - /** The index of the field within a group. */ - groupIndex?: number; - /** Specifies the sort order of field values. */ - sortOrder?: string; - /** Specifies how field data should be sorted. Can be used for the XmlaStore store type only. */ - sortBy?: string; - /** Sorts the header items of this field by the summary values of another field. */ - sortBySummaryField?: string; - /** The array of field names that specify a path to column/row whose summary field is used for sorting of this field's header items. */ - sortBySummaryPath?: Array; - /** The filter values for the current field. */ - filterValues?: Array; - /** The filter type for the current field. */ - filterType?: string; - /** Indicates whether all header items of the field's header level are expanded. */ - expanded?: boolean; - /** Specifies whether the field should be treated as a Data Field. */ - isMeasure?: boolean; - /** Specifies a display format for field values. */ - format?: string; - /** Specifies a callback function that returns the text to be displayed in the cells of a field. */ - customizeText?: (cellInfo: { value: any; valueText: string }) => string; - /** Specifies a precision for formatted field values. */ - precision?: number; - /** Specifies how to sort the header items. */ - sortingMethod?: (a: Object, b: Object) => number; - /** Allows an end-user to change sorting options. */ - allowSorting?: boolean; - /** Allows an end-user to sort columns by summary values. */ - allowSortingBySummary?: boolean; - /** Allows an end-user to change filtering options. */ - allowFiltering?: boolean; - /** Allows an end-user to expand/collapse all header items within a header level. */ - allowExpandAll?: boolean; - /** Specifies the absolute width of the field in the pivot grid. */ - width?: number; - /** Specifies the summary post-processing algorithm. */ - summaryDisplayMode?: string; - /** Specifies whether to summarize each next summary value with the previous one by rows or columns. */ - runningTotal?: string; - /** Specifies whether to allow the predefined summary post-processing functions ('absoluteVariation' and 'percentVariation') and runningTotal to take values of different groups into account. */ - allowCrossGroupCalculation?: boolean; - /** Specifies a callback function that allows you to modify summary values after they are calculated. */ - calculateSummaryValue?: (e: Object) => number; - /** Specifies whether or not to display Total values for the field. */ - showTotals?: boolean; - /** Specifies whether or not to display Grand Total values for the field. */ - showGrandTotals?: boolean; - } - export class SummaryCell { - /** Gets the parent cell in a specified direction. */ - parent(direction: string): SummaryCell; - /** Gets all children cells in a specified direction. */ - children(direction: string): Array; - /** Gets a partial Grand Total cell of a row or column. */ - grandTotal(direction: string): SummaryCell; - /** Gets the Grand Total of the entire pivot grid. */ - grandTotal(): SummaryCell; - /** Gets the cell next to the current one in a specified direction. */ - next(direction: string): SummaryCell; - /** Gets the cell next to current in a specified direction. */ - next(direction: string, allowCrossGroup: boolean): SummaryCell; - /** Gets the cell prior to the current one in a specified direction. */ - prev(direction: string): SummaryCell; - /** Gets the cell previous to current in a specified direction. */ - prev(direction: string, allowCrossGroup: boolean): SummaryCell; - /** Gets the child cell in a specified direction. */ - child(direction: string, fieldValue: any): SummaryCell; - /** Gets the cell located by the path of the source cell with one field value changed. */ - slice(field: PivotGridField, value: any): SummaryCell; - /** Gets the header cell of a row or column field to which the current cell belongs. */ - field(area: string): PivotGridField; - /** Gets the value of the current cell. */ - value(): any; - /** Gets the value of the current cell. */ - value(isCalculatedValue: boolean): any; - /** Gets the value of any field linked with the current cell. */ - value(field: PivotGridField): any; - /** Gets the value of any field linked with the current cell. */ - value(field: PivotGridField, isCalculatedValue: boolean): any; - } - export interface PivotGridDataSourceOptions { - /** Specifies the underlying Store instance used to access data. */ - store?: any; - /** Indicates whether or not the automatic field generation from data in the Store is enabled. */ - retrieveFields?: boolean; - /** Specifies data filtering conditions. Cannot be used for the XmlaStore store type. */ - filter?: Object; - /** An array of pivot grid fields. */ - fields?: Array; - /** A handler for the changed event. */ - onChanged?: () => void; - /** A handler for the loadingChanged event. */ - onLoadingChanged?: (isLoading: boolean) => void; - /** A handler for the loadError event. */ - onLoadError?: (e?: Object) => void; - /** A handler for the fieldsPrepared event. */ - onFieldsPrepared?: (e?: Array) => void; - } - /** An object that provides access to data for the dxPivotGrid widget. */ - export class PivotGridDataSource implements EventsMixin { - constructor(options?: PivotGridDataSource); - /** Starts reloading data from any store and updating the data source. */ - reload(): JQueryPromise; - /** Starts updating the data source. Reloads data from the XMLA store only. */ - load(): JQueryPromise; - /** Indicates whether or not the PivotGridDataSource is currently being loaded. */ - isLoading(): boolean; - /** Gets data displayed in a PivotGrid. */ - getData(): Object; - /** Gets all fields within a specified area. */ - getAreaFields(area: string, collectGroups: boolean): Array; - /** Gets all fields from the data source. */ - fields(): Array; - /** Sets the fields option. */ - fields(fields: Array): void; - /** Gets current options of a specified field. */ - field(id: any): PivotGridField; - /** Sets one or more options of a specified field. */ - field(id: any, field: PivotGridField): void; - /** Collapses a specified header item. */ - collapseHeaderItem(area: string, path: Array): void; - /** Expands a specified header item. */ - expandHeaderItem(area: string, path: Array): void; - /** Expands all header items of a field. */ - expandAll(id: any): void; - /** Collapses all header items of a field. */ - collapseAll(id: any): void; - /** Disposes of all resources associated with this PivotGridDataSource. */ - dispose(): void; - /** Gets the current filter expression. Cannot be used for the XmlaStore store type. */ - filter(): Object; - /** Applies a new filter expression. Cannot be used for the XmlaStore store type. */ - filter(filterExpr: Object): void; - /** Provides access to a list of records (facts) that were used to calculate a specific summary. */ - createDrillDownDataSource(options: { - columnPath?: Array; - rowPath?: Array; - dataIndex?: number; - maxRowCount?: number; - customColumns?: Array; - }): DevExpress.data.DataSource; - /** Gets the current PivotGridDataSource state (fields configuration, sorting, filters, expanded headers, etc.) */ - state(): Object; - /** Sets the PivotGridDataSource state. */ - state(state: Object): void; - on(eventName: string, eventHandler: Function): PivotGridDataSource; - on(events: { [eventName: string]: Function; }): PivotGridDataSource; - off(eventName: string): PivotGridDataSource; - off(eventName: string, eventHandler: Function): PivotGridDataSource; - } -} -declare module DevExpress.ui { - export interface dxSchedulerOptions extends WidgetOptions { - /** Specifies a date displayed on the current scheduler view by default. */ - currentDate?: any; - /** The earliest date the widget allows you to select. */ - min?: Date; - /** The latest date the widget allows you to select. */ - max?: Date; - /** Specifies the view used in the scheduler by default. */ - currentView?: string; - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** Specifies the first day of a week. */ - firstDayOfWeek?: number; - /** The template to be used for rendering appointments. */ - appointmentTemplate?: any; - /** The template to be used for rendering an appointment tooltip. */ - appointmentTooltipTemplate?: any; - /** Lists the views to be available within the scheduler's View Selector. */ - views?: Array; - /** Specifies the resource kinds by which the scheduler's appointments are grouped in a timetable. */ - groups?: Array; - /** Specifies a start hour in the scheduler view's time interval. */ - startDayHour?: number; - /** Specifies an end hour in the scheduler view's time interval. */ - endDayHour?: number; - /** Specifies whether or not the "All-day" panel is visible. */ - showAllDayPanel?: boolean; - /** Specifies cell duration in minutes. */ - cellDuration?: number; - /** Specifies the edit mode for recurring appointments. */ - recurrenceEditMode?: string; - /** Specifies which editing operations an end-user can perform on appointments. */ - editing?: { - /** Specifies whether or not an end-user can add appointments. */ - allowAdding?: boolean; - /** Specifies whether or not an end-user can change appointment options. */ - allowUpdating?: boolean; - /** Specifies whether or not an end-user can delete appointments. */ - allowDeleting?: boolean; - /** Specifies whether or not an end-user can change an appointment duration. */ - allowResizing?: boolean; - /** Specifies whether or not an end-user can drag appointments. */ - allowDragging?: boolean; - } - /** Specifies an array of resources available in the scheduler. */ - resources?: Array<{ - /** Indicates whether or not several resources of this kind can be assigned to an appointment. */ - allowMultiple?: boolean; - /** - * Indicates whether or not resources of this kind have priority in the color identification of the appointments that have resources of different kinds assigned. - * @deprecated Use the useColorAsDefault option instead. - */ - mainColor?: boolean; - /** Indicates whether or not resources of this kind have priority in the color identification of the appointments that have resources of different kinds assigned. */ - useColorAsDefault?: boolean; - /** A data source used to fetch resources to be available in the scheduler. */ - dataSource?: any; - /** Specifies the resource object field whose value is displayed by the Resource editor in the Appointment popup window. */ - displayExpr?: any; - /** Specifies the resource object field that is used as a value of the Resource editor in the Appointment popup window. */ - valueExpr?: any; - /** The name of the appointment object field that specifies a resource of this kind. */ - field?: string; - /** Specifies the label of the Appointment popup window field that allows end users to assign a resource of this kind. */ - label?: string; - }>; - /** A handler for the AppointmentAdding event. */ - onAppointmentAdding?: Function; - /** A handler for the appointmentAdded event. */ - onAppointmentAdded?: Function; - /** A handler for the AppointmentUpdating event. */ - onAppointmentUpdating?: Function; - /** A handler for the appointmentUpdated event. */ - onAppointmentUpdated?: Function; - /** A handler for the AppointmentDeleting event. */ - onAppointmentDeleting?: Function; - /** A handler for the appointmentDeleted event. */ - onAppointmentDeleted?: Function; - /** A handler for the appointmentRendered event. */ - onAppointmentRendered?: Function; - /** A handler for the appointmentClick event. */ - onAppointmentClick?: any; - /** A handler for the appointmentDblClick event. */ - onAppointmentDblClick?: any; - /** A handler for the cellClick event. */ - onCellClick?: any; - /** A handler for the appointmentFormCreated event. */ - onAppointmentFormCreated?: Function; - /** Specifies whether or not an end-user can scroll the view horizontally. */ - horizontalScrollingEnabled?: boolean; - /** Specifies whether a user can switch views using tabs or a drop-down menu. */ - useDropDownViewSwitcher?: boolean; - /** Specifies the name of the data source item field that defines the start of an appointment. */ - startDateExpr?: string; - /** Specifies the name of the data source item field that defines the ending of an appointment. */ - endDateExpr?: string; - /** Specifies the name of the data source item field that holds the subject of an appointment. */ - textExpr?: string; - /** Specifies the name of the data source item field whose value holds the description of the corresponding appointment. */ - descriptionExpr?: string; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding appointment is an all-day appointment. */ - allDayExpr?: string; - /** Specifies the name of the data source item field that defines a recurrence rule for generating recurring appointments. */ - recurrenceRuleExpr?: string; - /** Specifies the name of the data source item field that defines exceptions for the current recurring appointment. */ - recurrenceExceptionExpr?: string; - /** Specifies whether filtering is performed on the server or client side. */ - remoteFiltering?: boolean; - } - /** A widget that displays scheduled data using different views and provides the capability to load, add and edit appointments. */ - export class dxScheduler extends Widget { - constructor(element: JQuery, options?: dxSchedulerOptions); - constructor(element: Element, options?: dxSchedulerOptions); - /** Add the appointment defined by the object passed as a parameter to the data associated with the widget. */ - addAppointment(appointment: Object): void; - /** Updates the appointment specified by the first method parameter by the appointment object specified by the second method parameter in the the data associated with the widget. */ - updateAppointment(target: Object, appointment: Object): void; - /** Deletes the appointment defined by the parameter from the the data associated with the widget. */ - deleteAppointment(appointment: Object): void; - /** Scrolls the scheduler work space to the specified time of the specified day. */ - scrollToTime(hours: number, minutes: number, date: Date): void; - /** Displayes the Appointment Details popup. */ - showAppointmentPopup(appointmentData: Object, createNewAppointment?: boolean, currentAppointmentData?: Object): void; - } - export interface dxColorBoxOptions extends dxDropDownEditorOptions { - /** Specifies the text displayed on the button that applies changes and closes the drop-down editor. */ - applyButtonText?: string; - applyValueMode?: string; - /** Specifies the text displayed on the button that cancels changes and closes the drop-down editor. */ - cancelButtonText?: string; - /** Specifies whether or not the widget value includes the alpha channel component. */ - editAlphaChannel?: boolean; - /** Specifies the size of a step by which a handle is moved using a keyboard shortcut. */ - keyStep?: number; - } - /** A widget used to specify a color value. */ - export class dxColorBox extends dxDropDownEditor { - constructor(element: JQuery, options?: dxColorBoxOptions); - constructor(element: Element, options?: dxColorBoxOptions); - } - export interface HierarchicalCollectionWidgetOptions extends CollectionWidgetOptions { - /** Specifies the name of the data source item field whose value is displayed by the widget. */ - displayExpr?: any; - /** Specifies the name of the data source item field used as a key. */ - keyExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding widget items is selected. */ - selectedExpr?: any; - /** Specifies the name of the data source item field that contains an array of nested items. */ - itemsExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding widget item is disabled. */ - disabledExpr?: any; - /** Specifies the name of the data source item field that holds the key of the parent item. */ - parentIdExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding widget items is expanded. */ - expandedExpr?: any; - hoverStateEnabled?: boolean; - focusStateEnabled?: boolean; - } - export class HierarchicalCollectionWidget extends CollectionWidget { - } - export interface dxTreeViewOptions extends HierarchicalCollectionWidgetOptions { - /** Specifies whether or not to animate item collapsing and expanding. */ - animationEnabled?: boolean; - /** Specifies whether a nested or plain array is used as a data source. */ - dataStructure?: string; - /** Specifies whether or not a user can expand all tree view items by the "*" hot key. */ - expandAllEnabled?: boolean; - /** - * Specifies whether or not a check box is displayed at each tree view item. - * @deprecated Use the showCheckBoxesMode options instead. - */ - showCheckBoxes?: boolean; - /** Specifies the current check boxes display mode. */ - showCheckBoxesMode?: string; - /** Specifies whether or not to select nodes recursively. */ - selectNodesRecursive?: boolean; - /** Specifies whether or not all parent nodes of an initially expanded node are displayed expanded. */ - expandNodesRecursive?: boolean; - /** - * Specifies whether the "Select All" check box is displayed over the tree view. - * @deprecated Use the showCheckBoxesMode options instead. - */ - selectAllEnabled?: boolean; - /** Specifies the text displayed at the "Select All" check box. */ - selectAllText?: string; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding node includes child nodes. */ - hasItemsExpr?: any; - /** Specifies if the virtual mode is enabled. */ - virtualModeEnabled?: boolean; - /** Specifies the parent ID value of the root item. */ - rootValue?: any; - /** Specifies the current value used to filter tree view items. */ - searchValue?: string; - /** A string value specifying available scrolling directions. */ - scrollDirection?: string; - /** A handler for the itemSelected event. */ - onItemSelected?: Function; - /** A handler for the itemExpanded event. */ - onItemExpanded?: Function; - /** A handler for the itemCollapsed event. */ - onItemCollapsed?: Function; - onItemClick?: Function; - onItemContextMenu?: Function; - onItemRendered?: Function; - onItemHold?: Function; - } - /** A widget displaying specified data items as a tree. */ - export class dxTreeView extends HierarchicalCollectionWidget { - constructor(element: JQuery, options?: dxTreeViewOptions); - constructor(element: Element, options?: dxTreeViewOptions); - /** Updates the tree view scrollbars according to the current size of the widget content. */ - updateDimensions(): JQueryPromise; - /** Selects the specified item. */ - selectItem(itemElement: any): void; - /** Unselects the specified item. */ - unselectItem(itemElement: any): void; - /** Expands the specified item. */ - expandItem(itemElement: any): void; - /** Collapses the specified item. */ - collapseItem(itemElement: any): void; - /** Returns all nodes of the tree view. */ - getNodes(): Array; - /** Selects all widget items. */ - selectAll(): void; - /** Unselects all widget items. */ - unselectAll(): void; - } - export interface dxMenuBaseOptions extends HierarchicalCollectionWidgetOptions { - /** An object that defines the animation options of the widget. */ - animation?: { - /** An object that defines the animation options used when the widget is being shown. */ - show?: fx.AnimationOptions; - /** An object that defines the animation options used when the widget is being hidden. */ - hide?: fx.AnimationOptions; - }; - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** Specifies the name of the CSS class associated with the menu. */ - cssClass?: string; - /** Holds an array of menu items. */ - items?: Array; - /** Specifies whether or not an item becomes selected if an end-user clicks it. */ - selectionByClick?: boolean; - /** Specifies the selection mode supported by the menu. */ - selectionMode?: string; - /** Specifies options of submenu showing and hiding. */ - showSubmenuMode?: { - /** Specifies the mode name. */ - name?: string; - /** Specifies the delay of submenu show and hiding. */ - delay?: { - /** The time span after which the submenu is shown. */ - show?: number; - /** The time span after which the submenu is hidden. */ - hide?: number; - }; - }; - } - export class dxMenuBase extends HierarchicalCollectionWidget { - constructor(element: JQuery, options?: dxMenuBaseOptions); - constructor(element: Element, options?: dxMenuBaseOptions); - /** Selects the specified item. */ - selectItem(itemElement: any): void; - /** Unselects the specified item. */ - unselectItem(itemElement: any): void; - } - export interface dxMenuOptions extends dxMenuBaseOptions { - /** Specifies whether or not the submenu is hidden when the mouse pointer leaves it. */ - hideSubmenuOnMouseLeave?: boolean; - /** Specifies whether the menu has horizontal or vertical orientation. */ - orientation?: string; - /** Specifies options for showing and hiding the first level submenu. */ - showFirstSubmenuMode?: { - /** Specifies the mode name. */ - name?: string; - /** Specifies the delay in submenu showing and hiding. */ - delay?: { - /** The time span after which the submenu is shown. */ - show?: number; - /** The time span after which the submenu is hidden. */ - hide?: number; - }; - }; - /** Specifies the direction at which the submenus are displayed. */ - submenuDirection?: string; - /** A handler for the submenuHidden event. */ - onSubmenuHidden?: Function; - /** A handler for the submenuHiding event. */ - onSubmenuHiding?: Function; - /** A handler for the submenuShowing event. */ - onSubmenuShowing?: Function; - /** A handler for the submenuShown event. */ - onSubmenuShown?: Function; - } - /** A menu widget. */ - export class dxMenu extends dxMenuBase { - constructor(element: JQuery, options?: dxMenuOptions); - constructor(element: Element, options?: dxMenuOptions); - } - export interface dxContextMenuOptions extends dxMenuBaseOptions { - /** Holds an object that specifies options of alternative menu invocation. */ - alternativeInvocationMode?: { - /** Specifies whether or not the standard context menu invocation (on a right mouse click or on a long tap) is disabled. */ - enabled?: Boolean; - /** Specifies the element used to invoke the context menu. */ - invokingElement?: any; - }; - /** A handler for the hidden event. */ - onHidden?: Function; - /** A handler for the hiding event. */ - onHiding?: Function; - /** A handler for the positioning event. */ - onPositioning?: Function; - /** A handler for the showing event. */ - onShowing?: Function; - /** A handler for the shown event. */ - onShown?: Function; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** Specifies the direction at which submenus are displayed. */ - submenuDirection?: string; - /** The target element associated with a popover. */ - target?: any; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - } - /** A context menu widget. */ - export class dxContextMenu extends dxMenuBase { - constructor(element: JQuery, options?: dxContextMenuOptions); - constructor(element: Element, options?: dxContextMenuOptions); - /** Toggles the visibility of the widget. */ - toggle(showing: boolean): JQueryPromise; - /** Shows the widget. */ - show(): JQueryPromise; - /** Hides the widget. */ - hide(): JQueryPromise; - } - export interface dxRemoteOperations { - /** Specifies whether or not filtering must be performed on the server side. */ - filtering?: boolean; - /** Specifies whether or not paging must be performed on the server side. */ - paging?: boolean; - /** Specifies whether or not sorting must be performed on the server side. */ - sorting?: boolean; - /** Specifies whether or not grouping must be performed on the server side. */ - grouping?: boolean; - /** Specifies whether or not summaries calculation must be performed on the server side. */ - summary?: boolean; - } - export interface dxDataGridRow { - /** The data object represented by the row. */ - data: Object; - /** The key of the data object represented by the row. */ - key: any; - /** The visible index of the row. */ - rowIndex: number; - /** The type of the row. */ - rowType: string; - } - export interface dxDataGridColumn { - /** Specifies the content alignment within column cells. */ - alignment?: string; - /** Specifies whether the values in a column can be edited at runtime. Setting this option makes sense only when editing is enabled for a grid. */ - allowEditing?: boolean; - /** Specifies whether or not a column can be used for filtering grid records. Setting this option makes sense only when the filter row and column header filtering are visible. */ - allowFiltering?: boolean; - /** Specifies whether or not to allow filtering by this column using its header. */ - allowHeaderFiltering?: boolean; - /** Specifies whether or not the column can be anchored to a grid edge by end users. Setting this option makes sense only when the columnFixing | enabled option is set to true. */ - allowFixing?: boolean; - /** Specifies if a column can be used for searching grid records. Setting this option makes sense only when the search panel is visible. */ - allowSearch?: boolean; - /** Specifies whether a column can be used for grouping grid records at runtime. Setting this option makes sense only when the group panel is visible. */ - allowGrouping?: boolean; - /** Specifies whether or not a column can be hidden by a user. Setting this option makes sense only when the column chooser is visible. */ - allowHiding?: boolean; - /** Specifies whether or not a particular column can be used in column reordering. Setting this option makes sense only when the allowColumnReordering option is set to true. */ - allowReordering?: boolean; - /** Specifies whether or not a particular column can be resized by a user. Setting this option makes sense only when the allowColumnResizing option is true. */ - allowResizing?: boolean; - /** Specifies whether grid records can be sorted by a specific column at runtime. Setting this option makes sense only when the sorting mode differs from none. */ - allowSorting?: boolean; - /** Specifies whether groups appear expanded or not when records are grouped by a specific column. Setting this option makes sense only when grouping is allowed for this column. */ - autoExpandGroup?: boolean; - /** Specifies a callback function that returns a value to be displayed in a column cell. */ - calculateCellValue?: (rowData: Object) => string; - /** Specifies a callback function to be invoked after the cell value is edited by an end-user and before the new value is saved to the data source. */ - setCellValue?: (rowData: Object, value: any) => void; - /** Specifies a callback function that defines filters for customary calculated grid cells. */ - calculateFilterExpression?: (filterValue: any, selectedFilterOperation: string, target: string) => Array; - /** Specifies a caption for a column. */ - caption?: string; - /** Specifies a custom template for grid column cells. */ - cellTemplate?: any; - /** Specifies a CSS class to be applied to a column. */ - cssClass?: string; - /** Specifies how to get a value to be displayed in a cell when it is not in an editing state. */ - calculateDisplayValue?: any; - /** Specifies a field name or a function that returns a field name or a value to be used for grouping column cells. */ - calculateGroupValue?: any; - /** Specifies a field name or a function that returns a field name or a value to be used for sorting column cells. */ - calculateSortValue?: any; - /** Specifies a callback function that returns the text to be displayed in the cells of a column. */ - customizeText?: (cellInfo: { value: any; valueText: string }) => string; - /** Specifies the field of a data source that provides data for a column. */ - dataField?: string; - /** Specifies the required type of column values. */ - dataType?: string; - /** Specifies a custom template for the cell of a grid column when it is in an editing state. */ - editCellTemplate?: any; - /** Specifies configuration options for the editor widget of the current column. */ - editorOptions?: Object; - /** Specifies whether HTML tags are displayed as plain text or applied to the values of the column. */ - encodeHtml?: boolean; - /** In a boolean column, replaces all false items with a specified text. */ - falseText?: string; - /** Specifies the set of available filter operations. */ - filterOperations?: Array; - /** Specifies a filter value for a column. */ - filterValue?: any; - /** Specifies initial filter values for the column's header filter. */ - filterValues?: Array; - /** Specifies whether to include or exclude the records with the values selected in the column's header filter. */ - filterType?: string; - /** Indicates whether the column takes part in horizontal grid scrolling or is anchored to a grid edge. */ - fixed?: boolean; - /** Specifies the grid edge to which the column is anchored. */ - fixedPosition?: string; - /** Specifies a format for the values displayed in a column. */ - format?: string; - /** Specifies a custom template for the group cell of a grid column. */ - groupCellTemplate?: any; - /** Specifies the index of a column when grid records are grouped by the values of this column. */ - groupIndex?: number; - /** Specifies a custom template for the header of a grid column. */ - headerCellTemplate?: any; - /** Specifies options of a lookup column. */ - lookup?: { - /** Specifies whether or not a user can nullify values of a lookup column. */ - allowClearing?: boolean; - /** Specifies the data source providing data for a lookup column. */ - dataSource?: any; - /** Specifies the expression defining the data source field whose values must be displayed. */ - displayExpr?: any; - /** Specifies the expression defining the data source field whose values must be replaced. */ - valueExpr?: string; - }; - /** Specifies column-level options for filtering using a column header filter. */ - headerFilter?: { - /** Specifies the data source to be used for the header filter. */ - dataSource?: any; - /** Specifies how header filter values should be combined into groups. */ - groupInterval?: any; - }; - /** Specifies a precision for formatted values displayed in a column. */ - precision?: number; - /** Specifies a filter operation applied to a column. */ - selectedFilterOperation?: string; - /** Specifies whether or not the column displays its values by using editors. */ - showEditorAlways?: boolean; - /** Specifies whether or not to display the column when grid records are grouped by it. */ - showWhenGrouped?: boolean; - /** Specifies the index of a column when grid records are sorted by the values of this column. */ - sortIndex?: number; - /** Specifies the initial sort order of column values. */ - sortOrder?: string; - /** In a boolean column, replaces all true items with a specified text. */ - trueText?: string; - /** Specifies whether a column is visible or not. */ - visible?: boolean; - /** Specifies the sequence number of the column in the grid. */ - visibleIndex?: number; - /** Specifies a column width in pixels or percentages. */ - width?: any; - /** Specifies an array of validation rules to be checked when updating column cell values. */ - validationRules?: Array; - /** Specifies whether or not to display the header of a hidden column in the column chooser. */ - showInColumnChooser?: boolean; - /** Specifies the identifier of the column. */ - name?: string; - /** The form item configuration object. Used only when the editing mode is "form". */ - formItem?: DevExpress.ui.dxFormItem; - } - export interface dxDataGridOptions extends WidgetOptions { - /** Specifies whether the outer borders of the grid are visible or not. */ - showBorders?: boolean; - /** Indicates whether to show the error row for the grid. */ - errorRowEnabled?: boolean; - /** A handler for the rowValidating event. */ - onRowValidating?: (e: Object) => void; - /** A handler for the contextMenuPreparing event. */ - onContextMenuPreparing?: (e: Object) => void; - /** A handler for the initNewRow event. */ - onInitNewRow?: (e: { data: Object }) => void; - /** A handler for the rowInserted event. */ - onRowInserted?: (e: { data: Object; key: any }) => void; - /** A handler for the rowInserting event. */ - onRowInserting?: (e: { data: Object; cancel: any }) => void; - /** A handler for the rowRemoved event. */ - onRowRemoved?: (e: { data: Object; key: any }) => void; - /** A handler for the rowRemoving event. */ - onRowRemoving?: (e: { data: Object; key: any; cancel: any }) => void; - /** A handler for the rowUpdated event. */ - onRowUpdated?: (e: { data: Object; key: any }) => void; - /** A handler for the rowUpdating event. */ - onRowUpdating?: (e: { oldData: Object; newData: Object; key: any; cancel: any }) => void; - /** Enables a hint that appears when a user hovers the mouse pointer over a cell with truncated content. */ - cellHintEnabled?: boolean; - /** Specifies whether or not grid columns can be reordered by a user. */ - allowColumnReordering?: boolean; - /** Specifies whether or not grid columns can be resized by a user. */ - allowColumnResizing?: boolean; - /** A handler for the cellClick event. */ - onCellClick?: any; - /** A handler for the cellHoverChanged event. */ - onCellHoverChanged?: (e: Object) => void; - /** A handler for the cellPrepared event. */ - onCellPrepared?: (e: Object) => void; - /** Specifies whether or not the width of grid columns depends on column content. */ - columnAutoWidth?: boolean; - /** Specifies the options of a column chooser. */ - columnChooser?: { - /** Specifies text displayed by the column chooser panel when it does not contain any columns. */ - emptyPanelText?: string; - /** Specifies whether a user can invoke the column chooser or not. */ - enabled?: boolean; - /** Specifies the height of the column chooser panel. */ - height?: number; - /** Specifies text displayed in the title of the column chooser panel. */ - title?: string; - /** Specifies the width of the column chooser panel. */ - width?: number; - }; - /** Specifies options for column fixing. */ - columnFixing?: { - /** Indicates if column fixing is enabled. */ - enabled?: boolean; - /** Contains options that specify texts for column-fixing related commands in the column header's context menu. */ - texts?: { - /** Specifies text for a context menu item that fixes the column for which the context menu is invoked. */ - fix?: string; - /** Specifies text for a context menu item that unfixes the column for which the context menu is invoked. */ - unfix?: string; - /** Specifies text for a context menu subitem that fixes a column, for which the context menu is invoked, to the left grid edge. */ - leftPosition?: string; - /** Specifies text for a context menu subitem that fixes a column, for which the context menu is invoked, to the right grid edge. */ - rightPosition?: string; - }; - }; - /** Specifies options for filtering using a column header filter. */ - headerFilter?: { - /** Indicates whether or not the column header filter button is visible. */ - visible?: boolean; - /** Specifies the height of the dropdown menu invoked when using a column header filter. */ - height?: number; - /** Specifies the width of the dropdown menu invoked when using a column header filter. */ - width?: number; - /** Contains options that specify texts for the dropdown menu invoked when you use a column header filter. */ - texts?: { - /** Specifies text for the item specifying an empty value in the column header filter's dropdown menu. */ - emptyValue?: string; - /** Specifies text for a button that closes the column header filter's dropdown menu and applies specified filtering. */ - ok?: string; - /** Specifies text for a button that closes the column header filter's dropdown menu without applying performed selection. */ - cancel?: string; - } - }; - /** An array of grid columns. */ - columns?: Array; - onContentReady?: Function; - /** Specifies a function that customizes grid columns after they are created. */ - customizeColumns?: (columns: Array) => void; - /** Specifies a data source for the grid. */ - dataSource?: any; - /** Specifies whether or not to enable data caching. */ - cacheEnabled?: boolean; - /** A handler for the editingStart event. */ - onEditingStart?: (e: { - data: Object; - key: any; - cancel: boolean; - column: dxDataGridColumn - }) => void; - /** A handler for the editorPrepared event. */ - onEditorPrepared?: (e: Object) => void; - /** A handler for the editorPreparing event. */ - onEditorPreparing?: (e: Object) => void; - /** Contains options that specify how grid content can be changed. */ - editing?: { - editMode?: string; - editEnabled?: boolean; - insertEnabled?: boolean; - removeEnabled?: boolean; - /** Specifies how grid values can be edited manually. */ - mode?: string; - /** Specifies whether or not grid records can be edited at runtime. */ - allowUpdating?: boolean; - /** Specifies whether or not new grid records can be added at runtime. */ - allowAdding?: boolean; - /** Specifies whether or not grid records can be deleted at runtime. */ - allowDeleting?: boolean; - /** The form configuration object. Used only when the editing mode is "form". */ - form?: DevExpress.ui.dxFormOptions; - /** Contains options that specify texts for editing-related grid controls. */ - texts?: { - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Save" button. Setting this option makes sense only when the editMode option is set to batch. */ - saveAllChanges?: string; - /** Specifies text for a cancel button displayed when a row is in the editing state. Setting this option makes sense only when the allowUpdating option is set to true. */ - cancelRowChanges?: string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Revert" button. Setting this option makes sense only when the editMode option is set to batch. */ - cancelAllChanges?: string; - /** Specifies a message to be displayed by a confirmation window. Setting this option makes sense only when the edit mode is "row". */ - confirmDeleteMessage?: string; - /** Specifies text to be displayed in the title of a confirmation window. Setting this option makes sense only when the edit mode is "row". */ - confirmDeleteTitle?: string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Cancel changes" button. Setting this option makes sense only when the editMode option is set to cell and the validation capabilities are enabled. */ - validationCancelChanges?: string; - /** Specifies text for a button that deletes a row from a grid. Setting this option makes sense only when the allowDeleting option is set to true. */ - deleteRow?: string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Add" button. Setting this option makes sense only when the allowAdding option is true. */ - addRow?: string; - /** Specifies text for a button that turns a row into the editing state. Setting this option makes sense only when the allowUpdating option is set to true. */ - editRow?: string; - /** Specifies text for a save button displayed when a row is in the editing state. Setting this option makes sense only when the allowUpdating option is set to true. */ - saveRowChanges?: string; - /** Specifies text for a button that recovers a deleted row. Setting this option makes sense only if the grid uses the batch edit mode and the allowDeleting option is set to true. */ - undeleteRow?: string; - }; - }; - /** Specifies filter row options. */ - filterRow?: { - /** Specifies when to apply a filter. */ - applyFilter?: string; - /** Specifies text for the hint that pops up when a user hovers the mouse pointer over the "Apply Filter" button. */ - applyFilterText?: string; - /** Specifies descriptions for filter operations. */ - operationDescriptions?: { - "=": string; - "<>": string; - "<": string; - "<=": string; - ">": string; - ">=": string; - "startswith": string; - "contains": string; - "notcontains": string; - "endswith": string; - }; - /** Specifies text for the reset operation in a filter list. */ - resetOperationText?: string; - /** Specifies text for the operation of clearing the applied filter when a select box is used. */ - showAllText?: string; - /** Specifies text for the range start in the 'between' filter type. */ - betweenStartText?: string; - /** Specifies text for the range end in the 'between' filter type. */ - betweenEndText?: string; - /** Specifies whether or not an icon that allows the user to choose a filter operation is visible. */ - showOperationChooser?: boolean; - /** Specifies whether the filter row is visible or not. */ - visible?: boolean; - }; - /** Specifies the behavior of grouped grid records. */ - grouping?: { - /** Specifies whether the user can collapse grouped records in a grid or not. */ - allowCollapsing?: boolean; - /** Specifies whether groups appear expanded or not. */ - autoExpandAll?: boolean; - /** Specifies the message displayed in a group row when the corresponding group is continued from the previous page. */ - groupContinuedMessage?: string; - /** Specifies the message displayed in a group row when the corresponding group continues on the next page. */ - groupContinuesMessage?: string; - }; - /** Specifies options that configure the group panel. */ - groupPanel?: { - /** Specifies whether columns can be dragged onto or from the group panel. */ - allowColumnDragging?: boolean; - /** Specifies text displayed by the group panel when it does not contain any columns. */ - emptyPanelText?: string; - /** Specifies whether the group panel is visible or not. */ - visible?: boolean; - }; - /** Specifies options configuring the load panel. */ - loadPanel?: { - /** Specifies whether to show the load panel or not. */ - enabled?: boolean; - /** Specifies the height of the load panel in pixels. */ - height?: number; - /** Specifies a URL pointing to an image to be used as a loading indicator. */ - indicatorSrc?: string; - /** Specifies whether or not a loading indicator must be displayed on the load panel. */ - showIndicator?: boolean; - /** Specifies whether or not the pane of the load panel must be displayed. */ - showPane?: boolean; - /** Specifies text displayed by the load panel. */ - text?: string; - /** Specifies the width of the load panel in pixels. */ - width?: number; - }; - /** Specifies text displayed when a grid does not contain any records. */ - noDataText?: string; - /** Specifies the options of a grid pager. */ - pager?: { - /** Specifies the page sizes that can be selected at runtime. */ - allowedPageSizes?: any; - /** Specifies whether to show the page size selector or not. */ - showPageSizeSelector?: boolean; - /** Specifies whether to show the pager or not. */ - visible?: any; - /** Specifies the text accompanying the page navigator. */ - infoText?: string; - /** Specifies whether or not to display the text accompanying the page navigator. This text is specified by the infoText option. */ - showInfo?: boolean; - /** Specifies whether or not to display buttons that switch the grid to the previous or next page. */ - showNavigationButtons?: boolean; - }; - /** Specifies paging options. */ - paging?: { - /** Specifies whether dxDataGrid loads data page by page or all at once. */ - enabled?: boolean; - /** Specifies the grid page that should be displayed by default. */ - pageIndex?: number; - /** Specifies the size of grid pages. */ - pageSize?: number; - }; - /** Specifies whether or not grid rows must be shaded in a different way. */ - rowAlternationEnabled?: boolean; - /** Specifies whether to enable two-way data binding. */ - twoWayBindingEnabled?: boolean; - /** A handler for the rowClick event. */ - onRowClick?: any; - /** A handler for the rowPrepared event. */ - onRowPrepared?: (e: Object) => void; - /** Specifies a custom template for grid rows. */ - rowTemplate?: any; - /** A configuration object specifying scrolling options. */ - scrolling?: { - /** Specifies the scrolling mode. */ - mode?: string; - /** Specifies whether or not a grid must preload pages adjacent to the current page when using virtual scrolling. */ - preloadEnabled?: boolean; - /** Specifies whether or not the widget uses native scrolling. */ - useNative?: any; - /** Specifies the scrollbar display policy. */ - showScrollbar?: string; - /** Specifies whether or not the scrolling by content is enabled. */ - scrollByContent?: boolean; - /** Specifies whether or not the scrollbar thumb scrolling enabled. */ - scrollByThumb?: boolean; - }; - /** Specifies options of the search panel. */ - searchPanel?: { - /** Specifies whether or not search strings in the located grid records should be highlighted. */ - highlightSearchText?: boolean; - /** Specifies text displayed by the search panel when no search string was typed. */ - placeholder?: string; - /** Specifies whether the search panel is visible or not. */ - visible?: boolean; - /** Specifies the width of the search panel in pixels. */ - width?: number; - /** Sets a search string for the search panel. */ - text?: string; - }; - /** Specifies the operations that must be performed on the server side. */ - remoteOperations?: any; - /** Allows you to sort groups according to the values of group summary items. */ - sortByGroupSummaryInfo?: Array<{ - /** Specifies the group summary item whose values must be used to sort groups. */ - summaryItem?: string; - /** Specifies the identifier of the column that must be used in grouping so that sorting by group summary item values be applied. */ - groupColumn?: string; - /** Specifies the sort order of group summary item values. */ - sortOrder?: string; - }>; - /** Allows you to build a master-detail interface in the grid. */ - masterDetail?: { - /** Enables an end-user to expand/collapse detail sections. */ - enabled?: boolean; - /** Specifies whether detail sections appear expanded or collapsed. */ - autoExpandAll?: boolean; - /** Specifies the template for detail sections. */ - template?: any; - }; - /** Specifies options for exporting grid data. */ - export?: { - /** Indicates if the export feature is enabled in the grid. */ - enabled?: boolean; - /** Specifies a default name for the file to which grid data is exported. */ - fileName?: string; - /** Specifies whether to enable Excel filtering for the exported data in the resulting XLSX file. */ - excelFilterEnabled?: boolean; - /** Specifies whether to enable word wrapping for the exported data in the resulting XLSX file. */ - excelWrapTextEnabled?: boolean; - /** Specifies the URL of the server-side proxy that streams the resulting file to the end user to enable export in IE8, IE9 and Safari browsers. */ - proxyUrl?: string; - /** Indicates whether to allow end users to export not only the data displayed in the grid, but the selected rows only. */ - allowExportSelectedData?: boolean; - /** Contains options that specify texts for the export-related commands and hints. */ - texts?: { - /** Specifies text for the Export button when this button invokes a dropdown menu so you can choose the required export format. */ - exportTo?: string; - /** Specifies text for the Export button's hint when this button exports to the XSLX format without invoking the drop-down menu. */ - exportToExcel?: string; - /** Specifies text for the item in the Export dropdown menu that exports grid data to Excel. */ - excelFormat?: string; - /** Specifies text for the option in the Export dropdown menu that allows you to choose whether to export all the grid data or the selected rows only. */ - selectedRows?: string; - } - }; - /** Specifies the keys of the records that must appear selected initially. */ - selectedRowKeys?: Array; - /** Specifies options of runtime selection. */ - selection?: { - /** Specifies the checkbox row display policy in the multiple mode. */ - showCheckBoxesMode?: string; - /** Specifies whether the user can select all grid records at once. */ - allowSelectAll?: boolean; - /** Specifies the selection mode. */ - mode?: string; - }; - /** A handler for the dataErrorOccured event. */ - onDataErrorOccurred?: (e: { error: Error }) => void; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: (e: { - currentSelectedRowKeys: Array; - currentDeselectedRowKeys: Array; - selectedRowKeys: Array; - selectedRowsData: Array; - }) => void; - /** A handler for the exporting event. */ - onExporting?: (e: { - fileName: string; - cancel: boolean; - }) => void; - /** A handler for the fileSaving event. */ - onFileSaving?: (e: { - fileName: string; - format: string; - data: any; - cancel: boolean; - }) => void; - /** A handler for the exported event. */ - onExported?: (e: Object) => void; - /** A handler for the keyDown event. */ - onKeyDown?: (e: Object) => void; - /** A handler for the rowExpanding event. */ - onRowExpanding?: (e: Object) => void; - /** A handler for the rowExpanded event. */ - onRowExpanded?: (e: Object) => void; - /** A handler for the rowCollapsing event. */ - onRowCollapsing?: (e: Object) => void; - /** A handler for the rowCollapsed event. */ - onRowCollapsed?: (e: Object) => void; - /** Specifies whether column headers are visible or not. */ - showColumnHeaders?: boolean; - /** Specifies whether or not vertical lines separating one grid column from another are visible. */ - showColumnLines?: boolean; - /** Specifies whether or not horizontal lines separating one grid row from another are visible. */ - showRowLines?: boolean; - /** Specifies options of runtime sorting. */ - sorting?: { - /** Specifies text for the context menu item that sets an ascending sort order in a column. */ - ascendingText?: string; - /** Specifies text for the context menu item that resets sorting settings for a column. */ - clearText?: string; - /** Specifies text for the context menu item that sets a descending sort order in a column. */ - descendingText?: string; - /** Specifies the runtime sorting mode. */ - mode?: string; - }; - /** Specifies options of state storing. */ - stateStoring?: { - /** Specifies a callback function that performs specific actions on state loading. */ - customLoad?: () => JQueryPromise; - /** Specifies a callback function that performs specific actions on state saving. */ - customSave?: (state: Object) => void; - /** Specifies whether or not a grid saves its state. */ - enabled?: boolean; - /** Specifies the delay between the last change of a grid state and the operation of saving this state in milliseconds. */ - savingTimeout?: number; - /** Specifies a unique key to be used for storing the grid state. */ - storageKey?: string; - /** Specifies the type of storage to be used for state storing. */ - type?: string; - }; - /** Specifies the options of the grid summary. */ - summary?: { - /** Contains options that specify text patterns for summary items. */ - texts?: { - /** Specifies a pattern for the 'sum' summary items when they are displayed in the parent column. */ - sum?: string; - /** Specifies a pattern for the 'sum' summary items displayed in a group row or in any other column rather than the parent one. */ - sumOtherColumn?: string; - /** Specifies a pattern for the 'min' summary items when they are displayed in the parent column. */ - min?: string; - /** Specifies a pattern for the 'min' summary items displayed in a group row or in any other column rather than the parent one. */ - minOtherColumn?: string; - /** Specifies a pattern for the 'max' summary items when they are displayed in the parent column. */ - max?: string; - /** Specifies a pattern for the 'max' summary items displayed in a group row or in any other column rather than the parent one. */ - maxOtherColumn?: string; - /** Specifies a pattern for the 'avg' summary items when they are displayed in the parent column. */ - avg?: string; - /** Specifies a pattern for the 'avg' summary items displayed in a group row or in any other column rather than the parent one. */ - avgOtherColumn?: string; - /** Specifies a pattern for the 'count' summary items. */ - count?: string; - }; - /** Specifies items of the group summary. */ - groupItems?: Array<{ - /** Specifies the identifier of a summary item. */ - name?: string; - /** Specifies the column that provides data for a group summary item. */ - column?: string; - /** Customizes the text to be displayed in the summary item. */ - customizeText?: (itemInfo: { - value: any; - valueText: string; - }) => string; - /** Specifies a pattern for the summary item text. */ - displayFormat?: string; - /** Specifies a precision for the summary item value of a numeric format. */ - precision?: number; - /** Specifies whether or not a summary item must be displayed in the group footer. */ - showInGroupFooter?: boolean; - /** Indicates whether to display group summary items in parentheses after the group row header or to align them by the corresponding columns within the group row. */ - alignByColumn?: boolean; - /** Specifies the column that must hold the summary item when this item is displayed in the group footer or aligned by a column in the group row. */ - showInColumn?: string; - /** Specifies how to aggregate data for a summary item. */ - summaryType?: string; - /** Specifies a format for the summary item value. */ - valueFormat?: string; - /** Specifies whether or not to skip empty strings, null and undefined values when calculating a summary. */ - skipEmptyValues?: boolean; - }>; - /** Specifies items of the total summary. */ - totalItems?: Array<{ - /** Specifies the identifier of a summary item. */ - name?: string; - /** Specifies the alignment of a summary item. */ - alignment?: string; - /** Specifies the column that provides data for a summary item. */ - column?: string; - /** Specifies a CSS class to be applied to a summary item. */ - cssClass?: string; - /** Customizes the text to be displayed in the summary item. */ - customizeText?: (itemInfo: { - value: any; - valueText: string; - }) => string; - /** Specifies a pattern for the summary item text. */ - displayFormat?: string; - /** Specifies a precision for the summary item value of a numeric format. */ - precision?: number; - /** Specifies the column that must hold the summary item. */ - showInColumn?: string; - /** Specifies how to aggregate data for a summary item. */ - summaryType?: string; - /** Specifies a format for the summary item value. */ - valueFormat?: string; - /** Specifies whether or not to skip empty strings, null and undefined values when calculating a summary. */ - skipEmptyValues?: boolean; - }>; - /** Specifies whether or not to skip empty strings, null and undefined values when calculating a summary. */ - skipEmptyValues?: boolean; - /** Allows you to use a custom aggregate function to calculate the value of a summary item. */ - calculateCustomSummary?: (options: { - component: dxDataGrid; - name?: string; - value: any; - totalValue: any; - summaryProcess: string - }) => void; - }; - /** Specifies whether text that does not fit into a column should be wrapped. */ - wordWrapEnabled?: boolean; - } - /** A data grid widget. */ - export class dxDataGrid extends Widget { - constructor(element: JQuery, options?: dxDataGridOptions); - constructor(element: Element, options?: dxDataGridOptions); - /** Ungroups grid records. */ - clearGrouping(): void; - /** Clears sorting settings of all grid columns at once. */ - clearSorting(): void; - /** Allows you to obtain a cell by its row index and the data field of its column. */ - getCellElement(rowIndex: number, dataField: string): any; - /** Allows you to obtain a cell by its row index and the visible index of its column. */ - getCellElement(rowIndex: number, visibleColumnIndex: number): any; - /** Returns the current state of the grid. */ - state(): Object; - /** Sets the grid state. */ - state(state: Object): void; - /** Allows you to obtain the row index by a data key. */ - getRowIndexByKey(key: any): number; - /** Allows you to obtain the data key by a row index. */ - getKeyByRowIndex(rowIndex: number): any; - /** Adds a new column to a grid. */ - addColumn(columnOptions: dxDataGridColumn): void; - /** Removes the column from the grid. */ - deleteColumn(id: any): void; - /** Displays the load panel. */ - beginCustomLoading(messageText: string): void; - /** Discards changes made in a grid. */ - cancelEditData(): void; - /** Checks whether or not the grid contains unsaved changes. */ - hasEditData(): boolean; - /** Clears all the filters of a specific type applied to grid records. */ - clearFilter(): void; - /** Deselects all grid records. */ - clearSelection(): void; - /** Draws the cell being edited from the editing state. Use this method when the edit mode is batch. */ - closeEditCell(): void; - /** Collapses groups or master rows in a grid. */ - collapseAll(groupIndex?: number): void; - /** Returns the number of data columns in a grid. */ - columnCount(): number; - /** Returns the value of a specific column option. */ - columnOption(id: any, optionName: string): any; - /** Sets an option of a specific column. */ - columnOption(id: any, optionName: string, optionValue: any): void; - /** Returns the options of a column by an identifier. */ - columnOption(id: any): Object; - /** Sets several options of a column at once. */ - columnOption(id: any, options: Object): void; - /** Sets a specific cell into the editing state. */ - editCell(rowIndex: number, visibleColumnIndex: number): void; - /** Sets a specific cell into the editing state. */ - editCell(rowIndex: number, dataField: string): void; - /** Sets a specific row into the editing state. */ - editRow(rowIndex: number): void; - /** Gets the cell value. */ - cellValue(rowIndex: number, dataField: string): any; - /** Gets the cell value. */ - cellValue(rowIndex: number, visibleColumnIndex: number): any; - /** Sets the cell value. */ - cellValue(rowIndex: number, dataField: string, value: any): void; - /** Sets the cell value. */ - cellValue(rowIndex: number, visibleColumnIndex: number, value: any): void; - /** Hides the load panel. */ - endCustomLoading(): void; - /** Expands groups or master rows in a grid. */ - expandAll(groupIndex: number): void; - /** Allows you to find out whether a specific group or master row is expanded or collapsed. */ - isRowExpanded(key: any): boolean; - /** Allows you to expand a specific group or master row by its key. */ - expandRow(key: any): void; - /** Allows you to collapse a specific group or master row by its key. */ - collapseRow(key: any): void; - /** Applies a filter to the grid's data source. */ - filter(filterExpr?: any): void; - /** Returns a filter expression applied to the grid's data source using the filter(filterExpr) method. */ - filter(): any; - /** Returns a filter expression applied to the grid using all possible scenarious. */ - getCombinedFilter(): any; - /** Gets the keys of currently selected grid records. */ - getSelectedRowKeys(): Array; - /** Gets the data objects of currently selected grid records. */ - getSelectedRowsData(): Array; - /** Hides the column chooser panel. */ - hideColumnChooser(): void; - /** Adds a new data row to a grid. */ - addRow(): void; - /** - * Adds a new data row to a grid. - * @deprecated Use the addRow() method instead. - */ - insertRow(): void; - /** Returns the key corresponding to the passed data object. */ - keyOf(obj: Object): any; - /** Switches a grid to a specified page. */ - pageIndex(newIndex: number): void; - /** Gets the index of the current page. */ - pageIndex(): number; - /** Sets the page size. */ - pageSize(value: number): void; - /** Gets the current page size. */ - pageSize(): number; - /** Refreshes grid data. */ - refresh(): void; - /** Removes a specific row from a grid. */ - deleteRow(rowIndex: number): void; - /** - * Removes a specific row from a grid. - * @deprecated Use the deleteRow(rowIndex) method instead. - */ - removeRow(rowIndex: number): void; - /** Saves changes made in a grid. */ - saveEditData(): void; - /** Searches grid records by a search string. */ - searchByText(text: string): void; - /** Selects all grid records. */ - selectAll(): void; - /** Deselects the rows that are currently selected within the applied filter. */ - deselectAll(): void; - /** Selects specific grid records. */ - selectRows(keys: Array, preserve: boolean): void; - /** Deselects specific grid records. */ - deselectRows(keys: Array): void; - /** Selects grid rows by indexes. */ - selectRowsByIndexes(indexes: Array): void; - /** Allows you to find out whether a row is selected or not. */ - isRowSelected(key: any): boolean; - /** Invokes the column chooser panel. */ - showColumnChooser(): void; - startSelectionWithCheckboxes(): boolean; - /** Returns the number of records currently held by a grid. */ - totalCount(): number; - /** Recovers a row deleted in the batch edit mode. */ - undeleteRow(rowIndex: number): void; - /** Allows you to obtain a data object by its key. */ - byKey(key: any): JQueryPromise; - /** Gets the value of a total summary item. */ - getTotalSummaryValue(summaryItemName: string): any; - /** Exports grid data to Excel. */ - exportToExcel(selectionOnly: boolean): void; - /** Updates the grid to the size of its content. */ - updateDimensions(): void; - /** Focuses the specified cell element in the grid. */ - focus(element?: JQuery): void; - } - export interface dxPivotGridOptions extends WidgetOptions { - onContentReady?: Function; - /** Specifies a data source for the pivot grid. */ - dataSource?: any; - useNativeScrolling?: any; - /** A configuration object specifying scrolling options. */ - scrolling?: { - /** Specifies the scrolling mode. */ - mode?: string; - /** Specifies whether or not the widget uses native scrolling. */ - useNative?: any; - }; - /** Allows an end-user to change sorting options. */ - allowSorting?: boolean; - /** Allows an end-user to sort columns by summary values. */ - allowSortingBySummary?: boolean; - /** Allows an end-user to change filtering options. */ - allowFiltering?: boolean; - /** Allows an end-user to expand/collapse all header items within a header level. */ - allowExpandAll?: boolean; - /** Specifies whether to display the Total rows. */ - showRowTotals?: boolean; - /** Specifies whether to display the Grand Total row. */ - showRowGrandTotals?: boolean; - /** Specifies whether to display the Total columns. */ - showColumnTotals?: boolean; - /** Specifies whether to display the Grand Total column. */ - showColumnGrandTotals?: boolean; - /** Specifies whether or not to hide rows and columns with no data. */ - hideEmptySummaryCells?: boolean; - /** Specifies where to show the total rows or columns. */ - showTotalsPrior?: string; - /** Specifies whether the outer borders of the grid are visible or not. */ - showBorders?: boolean; - /** The Field Chooser configuration options. */ - fieldChooser?: { - /** Enables or disables the field chooser. */ - enabled?: boolean; - /** Specifies the field chooser layout. */ - layout?: number; - /** Specifies the text to display as a title of the field chooser popup window. */ - title?: string; - /** Specifies the field chooser width. */ - width?: number; - /** Specifies the field chooser height. */ - height?: number; - /** Strings that can be changed or localized in the pivot grid's integrated Field Chooser. */ - texts?: { - /** The string to display instead of Row Fields. */ - rowFields?: string; - /** The string to display instead of Column Fields. */ - columnFields?: string; - /** The string to display instead of Data Fields. */ - dataFields?: string; - /** The string to display instead of Filter Fields. */ - filterFields?: string; - /** The string to display instead of All Fields. */ - allFields?: string; - }; - } - /** Strings that can be changed or localized in the dxPivotGrid widget. */ - texts?: { - /** The string to display as a header of the Grand Total row and column. */ - grandTotal?: string; - /** The string to display as a header of the Total row and column. */ - total?: string; - /** Specifies the text displayed when a pivot grid does not contain any fields. */ - noData?: string; - /** The string to display as a Show Field Chooser context menu item. */ - showFieldChooser?: string; - /** The string to display as an Expand All context menu item. */ - expandAll?: string; - /** The string to display as a Collapse All context menu item. */ - collapseAll?: string; - /** The string to display as a Sort Column by Summary Value context menu item. */ - sortColumnBySummary?: string; - /** The string to display as a Sort Row by Summary Value context menu item. */ - sortRowBySummary?: string; - /** The string to display as a Remove All Sorting context menu item. */ - removeAllSorting?: string; - /** The string to display as an Export to Excel file context menu item. */ - exportToExcel?: string; - }; - /** Specifies options configuring the load panel. */ - loadPanel?: { - /** Enables or disables the load panel. */ - enabled?: boolean; - /** Specifies the height of the load panel. */ - height?: number; - /** Specifies the URL pointing to an image that will be used as a load indicator. */ - indicatorSrc?: string; - /** Specifies whether or not to show a load indicator. */ - showIndicator?: boolean; - /** Specifies whether or not to show load panel background. */ - showPane?: boolean; - /** Specifies the text to display inside a load panel. */ - text?: string; - /** Specifies the width of the load panel. */ - width?: number; - }; - /** A handler for the cellClick event. */ - onCellClick?: (e: any) => void; - /** A handler for the cellPrepared event. */ - onCellPrepared?: (e: any) => void; - /** A handler for the contextMenuPreparing event. */ - onContextMenuPreparing?: (e: Object) => void; - /** Specifies options for exporting pivot grid data. */ - export?: { - /** Indicates whether the export feature is enabled for the pivot grid. */ - enabled?: boolean; - /** Specifies a default name for the file to which grid data is exported. */ - fileName?: string; - /** Specifies the URL of the server-side proxy that streams the resulting file to the end user to enable export in IE8, IE9 and Safari browsers. */ - proxyUrl?: string; - }; - /** A handler for the exporting event. */ - onExporting?: (e: { - fileName: string; - cancel: boolean; - }) => void; - /** A handler for the fileSaving event. */ - onFileSaving?: (e: { - fileName: string; - format: string; - data: any; - cancel: boolean; - }) => void; - /** A handler for the exported event. */ - onExported?: (e: Object) => void; - /** A configuration object specifying options related to state storing. */ - stateStoring?: { - /** Specifies a callback function that performs specific actions on state loading. */ - customLoad?: () => JQueryPromise; - /** Specifies a callback function that performs specific actions on state saving. */ - customSave?: (gridState: Object) => void; - /** Specifies whether or not a grid saves its state. */ - enabled?: boolean; - /** Specifies the delay between the last change of a grid state and the operation of saving this state in milliseconds. */ - savingTimeout?: number; - /** Specifies a unique key to be used for storing the grid state. */ - storageKey?: string; - /** Specifies the type of storage to be used for state storing. */ - type?: string; - }; - } - /** A data summarization widget for multi-dimensional data analysis and data mining. */ - export class dxPivotGrid extends Widget { - constructor(element: JQuery, options?: dxPivotGridOptions); - constructor(element: Element, options?: dxPivotGridOptions); - /** Gets the PivotGridDataSource instance. */ - getDataSource(): DevExpress.data.PivotGridDataSource; - /** Gets the dxPopup instance of the field chooser window. */ - getFieldChooserPopup(): DevExpress.ui.dxPopup; - /** Updates the widget to the size of its content. */ - updateDimensions(): void; - /** Exports pivot grid data to the Excel file. */ - exportToExcel(): void; - } - export interface dxPivotGridFieldChooserOptions extends WidgetOptions { - /** Specifies the height of the widget. */ - height?: any; - /** Specifies the field chooser layout. */ - layout?: number; - /** The data source of a dxPivotGrid widget. */ - dataSource?: DevExpress.data.PivotGridDataSource; - onContentReady?: Function; - /** Strings that can be changed or localized in the dxPivotGridFieldChooser widget. */ - texts?: { - /** The string to display instead of Row Fields. */ - rowFields?: string; - /** The string to display instead of Column Fields. */ - columnFields?: string; - /** The string to display instead of Data Fields. */ - dataFields?: string; - /** The string to display instead of Filter Fields. */ - filterFields?: string; - /** The string to display instead of All Fields. */ - allFields?: string; - }; - } - /** A complementary widget for dxPivotGrid that allows you to manage data displayed in the dxPivotGrid. */ - export class dxPivotGridFieldChooser extends Widget { - constructor(element: JQuery, options?: dxPivotGridFieldChooserOptions); - constructor(element: Element, options?: dxPivotGridFieldChooserOptions); - /** Updates the widget to the size of its content. */ - updateDimensions(): void; - } -} -interface JQuery { - dxTreeView(): JQuery; - dxTreeView(options: "instance"): DevExpress.ui.dxTreeView; - dxTreeView(options: string): any; - dxTreeView(options: string, ...params: any[]): any; - dxTreeView(options: DevExpress.ui.dxTreeViewOptions): JQuery; - dxMenuBase(): JQuery; - dxMenuBase(options: "instance"): DevExpress.ui.dxMenuBase; - dxMenuBase(options: string): any; - dxMenuBase(options: string, ...params: any[]): any; - dxMenuBase(options: DevExpress.ui.dxMenuBaseOptions): JQuery; - dxMenu(): JQuery; - dxMenu(options: "instance"): DevExpress.ui.dxMenu; - dxMenu(options: string): any; - dxMenu(options: string, ...params: any[]): any; - dxMenu(options: DevExpress.ui.dxMenuOptions): JQuery; - dxContextMenu(): JQuery; - dxContextMenu(options: "instance"): DevExpress.ui.dxContextMenu; - dxContextMenu(options: string): any; - dxContextMenu(options: string, ...params: any[]): any; - dxContextMenu(options: DevExpress.ui.dxContextMenuOptions): JQuery; - dxColorBox(): JQuery; - dxColorBox(options: "instance"): DevExpress.ui.dxColorBox; - dxColorBox(options: string): any; - dxColorBox(options: string, ...params: any[]): any; - dxColorBox(options: DevExpress.ui.dxColorBoxOptions): JQuery; - dxDataGrid(): JQuery; - dxDataGrid(options: "instance"): DevExpress.ui.dxDataGrid; - dxDataGrid(options: string): any; - dxDataGrid(options: string, ...params: any[]): any; - dxDataGrid(options: DevExpress.ui.dxDataGridOptions): JQuery; - dxPivotGrid(): JQuery; - dxPivotGrid(options: "instance"): DevExpress.ui.dxPivotGrid; - dxPivotGrid(options: string): any; - dxPivotGrid(options: string, ...params: any[]): any; - dxPivotGrid(options: DevExpress.ui.dxPivotGridOptions): JQuery; - dxPivotGridFieldChooser(): JQuery; - dxPivotGridFieldChooser(options: "instance"): DevExpress.ui.dxPivotGridFieldChooser; - dxPivotGridFieldChooser(options: string): any; - dxPivotGridFieldChooser(options: string, ...params: any[]): any; - dxPivotGridFieldChooser(options: DevExpress.ui.dxPivotGridFieldChooserOptions): JQuery; - dxScheduler(): JQuery; - dxScheduler(options: "instance"): DevExpress.ui.dxScheduler; - dxScheduler(options: string): any; - dxScheduler(options: string, ...params: any[]): any; - dxScheduler(options: DevExpress.ui.dxSchedulerOptions): JQuery; -} -declare module DevExpress.framework { - /** An object used to store information on the views displayed in an application. */ - export class ViewCache { - viewRemoved: JQueryCallback; - /** Removes all the viewInfo objects from the cache. */ - clear(): void; - /** Obtains a viewInfo object from the cache by the specified key. */ - getView(key: string): Object; - /** Checks whether or not a viewInfo object is contained in the view cache under the specified key. */ - hasView(key: string): boolean; - /** Removes a viewInfo object from the cache by the specified key. */ - removeView(key: string): Object; - /** Adds the specified viewInfo object to the cache under the specified key. */ - setView(key: string, viewInfo: Object): void; - } - export interface dxCommandOptions extends DOMComponentOptions { - /** Specifies an action performed when the execute() method of the command is called. */ - onExecute?: any; - /** Indicates whether or not the widget that displays this command is disabled. */ - disabled?: boolean; - /** Specifies whether the current command is rendered when a view is being rendered or after a view is shown. */ - renderStage?: string; - /** Specifies the name of the icon shown inside the widget associated with this command. */ - icon?: string; - iconSrc?: string; - /** The identifier of the command. */ - id?: string; - /** Specifies the title of the widget associated with this command. */ - title?: string; - /** Specifies the type of the button, if the command is rendered as a dxButton widget. */ - type?: string; - /** A Boolean value specifying whether or not the widget associated with this command is visible. */ - visible?: boolean; - } - /** A markup component used to define markup options for a command. */ - export class dxCommand extends DOMComponent { - constructor(element: JQuery, options: dxCommandOptions); - constructor(options: dxCommandOptions); - /** Executes the action associated with this command. */ - execute(): void; - } - /** An object responsible for routing. */ - export class Router { - /** Adds a routing rule to the list of registered rules. */ - register(pattern: string, defaults?: Object, constraints?: Object): void; - /** Decodes the specified URI to an object using the registered routing rules. */ - parse(uri: string): Object; - /** Formats an object to a URI. */ - format(obj: Object): string; - } - export interface StateManagerOptions { - /** A storage to which the state manager saves the application state. */ - storage?: Object; - } - /** An object used to store the current application state. */ - export class StateManager { - constructor(options?: StateManagerOptions); - /** Adds an object that implements an interface of a state source to the state manager's collection of state sources. */ - addStateSource(stateSource: Object): void; - /** Removes a specified state source from the state manager's collection of state sources. */ - removeStateSource(stateSource: Object): void; - /** Saves the current application state. */ - saveState(): void; - /** Restores the application state that has been saved by the saveState() method to the state storage. */ - restoreState(): void; - /** Removes the application state that has been saved by the saveState() method to the state storage. */ - clearState(): void; - } - export module html { - export var layoutSets: Array; - export var animationSets: { [animationSetName: string]: AnimationSet }; - export interface AnimationSet { - [animationName: string]: any - } - export interface HtmlApplicationOptions { - /** Specifies where the commands that are defined in the application's views must be displayed. */ - commandMapping?: Object; - /** Specifies whether or not view caching is disabled. */ - disableViewCache?: boolean; - /** An array of layout controllers that should be used to show application views in the current navigation context. */ - layoutSet?: any; - /** Specifies the animation presets that are used to animate different UI elements in the current application. */ - animationSet?: AnimationSet; - /** Specifies whether the current application must behave as a mobile or web application. */ - mode?: string; - /** Specifies the object that represents a root namespace of the application. */ - namespace?: Object; - /** Specifies application behavior when the user navigates to a root view. */ - navigateToRootViewMode?: string; - /** An array of dxCommand configuration objects used to define commands available from the application's global navigation. */ - navigation?: Array; - /** A state manager to be used in the application. */ - stateManager?: StateManager; - /** Specifies the storage to be used by the application's state manager to store the application state. */ - stateStorage?: Object; - /** Indicates whether on not to use the title of the previously displayed view as text on the Back button. */ - useViewTitleAsBackText?: boolean; - /** A custom view cache to be used in the application. */ - viewCache?: Object; - /** Specifies a limit for the views that can be cached. */ - viewCacheSize?: number; - /** Specifies the current version of application templates. */ - templatesVersion?: string; - /** Specifies options for the viewport meta tag of a mobile browser. */ - viewPort?: JQuery; - /** A custom router to be used in the application. */ - router?: Router; - } - /** An object used to manage views, as well as control the application life cycle. */ - export class HtmlApplication implements EventsMixin { - constructor(options: HtmlApplicationOptions); - afterViewSetup: JQueryCallback; - beforeViewSetup: JQueryCallback; - initialized: JQueryCallback; - navigating: JQueryCallback; - navigatingBack: JQueryCallback; - resolveLayoutController: JQueryCallback; - resolveViewCacheKey: JQueryCallback; - viewDisposed: JQueryCallback; - viewDisposing: JQueryCallback; - viewHidden: JQueryCallback; - viewRendered: JQueryCallback; - viewShowing: JQueryCallback; - viewShown: JQueryCallback; - /** Provides access to the ViewCache object. */ - viewCache: ViewCache; - /** An array of dxCommand components that are created based on the application's navigation option value. */ - navigation: Array; - /** Provides access to the StateManager object. */ - stateManager: StateManager; - /** Provides access to the Router object. */ - router: Router; - /** Navigates to the URI preceding the current one in the navigation history. */ - back(): void; - /** Returns a Boolean value indicating whether or not backwards navigation is currently possible. */ - canBack(): boolean; - /** Calls the clearState() method of the application's StateManager object. */ - clearState(): void; - /** Creates global navigation commands. */ - createNavigation(navigationConfig: Array): void; - /** Returns an HTML template of the specified view. */ - getViewTemplate(viewName: string): JQuery; - /** Returns a configuration object used to create a dxView component for a specified view. */ - getViewTemplateInfo(viewName: string): Object; - /** Adds a specified HTML template to a collection of view or layout templates. */ - loadTemplates(source: any): JQueryPromise; - /** Navigates to the specified URI. */ - navigate(uri?: any, options?: Object): void; - /** Renders navigation commands to the navigation command containers that are located in the layouts used in the application. */ - renderNavigation(): void; - /** Calls the restoreState() method of the application's StateManager object. */ - restoreState(): void; - /** Calls the saveState method of the application's StateManager object. */ - saveState(): void; - /** Provides access to the object that defines the current context to be considered when choosing an appropriate template for a view. */ - templateContext(): Object; - on(eventName: "initialized", eventHandler: () => void): HtmlApplication; - on(eventName: "afterViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "beforeViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "navigating", eventHandler: (e: { - currentUri: string; - uri: string; - cancel: boolean; - options: { - root: boolean; - target: string; - direction: string; - rootInDetailPane: boolean; - modal: boolean; - }; - }) => void): HtmlApplication; - on(eventName: "navigatingBack", eventHandler: (e: { - cancel: boolean; - isHardwareButton: boolean; - }) => void): HtmlApplication; - on(eventName: "resolveLayoutController", eventHandler: (e: { - viewInfo: Object; - layoutController: Object; - availableLayoutControllers: Array; - }) => void): HtmlApplication; - on(eventName: "resolveViewCacheKey", eventHandler: (e: { - key: string; - navigationItem: Object; - routeData: Object; - }) => void): HtmlApplication; - on(eventName: "viewDisposed", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewDisposing", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewHidden", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewRendered", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewShowing", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - on(eventName: "viewShown", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - on(eventName: string, eventHandler: Function): HtmlApplication; - on(events: { [eventName: string]: Function; }): HtmlApplication; - off(eventName: "initialized"): HtmlApplication; - off(eventName: "afterViewSetup"): HtmlApplication; - off(eventName: "beforeViewSetup"): HtmlApplication; - off(eventName: "navigating"): HtmlApplication; - off(eventName: "navigatingBack"): HtmlApplication; - off(eventName: "resolveLayoutController"): HtmlApplication; - off(eventName: "resolveViewCacheKey"): HtmlApplication; - off(eventName: "viewDisposed"): HtmlApplication; - off(eventName: "viewDisposing"): HtmlApplication; - off(eventName: "viewHidden"): HtmlApplication; - off(eventName: "viewRendered"): HtmlApplication; - off(eventName: "viewShowing"): HtmlApplication; - off(eventName: "viewShown"): HtmlApplication; - off(eventName: string): HtmlApplication; - off(eventName: "initialized", eventHandler: () => void): HtmlApplication; - off(eventName: "afterViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "beforeViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "navigating", eventHandler: (e: { - currentUri: string; - uri: string; - cancel: boolean; - options: { - root: boolean; - target: string; - direction: string; - rootInDetailPane: boolean; - modal: boolean; - }; - }) => void): HtmlApplication; - off(eventName: "navigatingBack", eventHandler: (e: { - cancel: boolean; - isHardwareButton: boolean; - }) => void): HtmlApplication; - off(eventName: "resolveLayoutController", eventHandler: (e: { - viewInfo: Object; - layoutController: Object; - availableLayoutControllers: Array; - }) => void): HtmlApplication; - off(eventName: "resolveViewCacheKey", eventHandler: (e: { - key: string; - navigationItem: Object; - routeData: Object; - }) => void): HtmlApplication; - off(eventName: "viewDisposed", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewDisposing", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewHidden", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewRendered", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewShowing", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - off(eventName: "viewShown", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - off(eventName: string, eventHandler: Function): HtmlApplication; - } - } -} -declare module DevExpress.viz.core { - /** - * Applies a theme for the entire page with several DevExtreme visualization widgets. - * @deprecated Use the DevExpress.viz.currentTheme(theme) method instead. - */ - export function currentTheme(theme: string): void; - /** - * Applies a new theme (with the color scheme defined separately) for the entire page with several DevExtreme visualization widgets. - * @deprecated Use the DevExpress.viz.currentTheme(platform, colorScheme) method instead. - */ - export function currentTheme(platform: string, colorScheme: string): void; - /** - * Registers a new theme based on the existing one. - * @deprecated Use the DevExpress.viz.registerTheme(customTheme, baseTheme) method instead. - */ - export function registerTheme(customTheme: Object, baseTheme: string): void; - /** - * Applies a predefined or registered custom palette to all visualization widgets at once. - * @deprecated Use the DevExpress.viz.currentPalette(paletteName) method instead. - */ - export function currentPalette(paletteName: string): void; - /** - * Obtains the color sets of a predefined or registered palette. - * @deprecated Use the DevExpress.viz.getPalette(paletteName) method instead. - */ - export function getPalette(paletteName: string): Object; - /** - * Registers a new palette. - * @deprecated Use the DevExpress.viz.registerPalette(paletteName, palette) method instead. - */ - export function registerPalette(paletteName: string, palette: Object): void; - export interface Border { - /** Sets a border color for a selected series. */ - color?: string; - /** Sets border visibility for a selected series. */ - visible?: boolean; - /** Sets a border width for a selected series. */ - width?: number; - } - export interface DashedBorder extends Border { - /** Specifies a dash style for the border of a selected series point. */ - dashStyle?: string; - } - export interface DashedBorderWithOpacity extends DashedBorder { - /** Specifies the opacity of the tooltip's border. */ - opacity?: number; - } - export interface Font { - /** Specifies the font color for a strip label. */ - color?: string; - /** Specifies the font family for a strip label. */ - family?: string; - /** Specifies the font opacity for a strip label. */ - opacity?: number; - /** Specifies the font size for a strip label. */ - size?: any; - /** Specifies the font weight for the text displayed in strips. */ - weight?: number; - } - export interface Hatching { - direction?: string; - /** Specifies the opacity of hatching lines. */ - opacity?: number; - /** Specifies the distance between hatching lines in pixels. */ - step?: number; - /** Specifies the width of hatching lines in pixels. */ - width?: number; - } - export interface Margins { - /** Specifies the distance in pixels between the bottom side of the title and the surrounding widget elements. */ - bottom?: number; - /** Specifies the distance in pixels between the left side of the title and the surrounding widget elements. */ - left?: number; - /** Specifies the distance between the right side of the title and surrounding widget elements in pixels. */ - right?: number; - /** Specifies the distance between the top side of the title and surrounding widget elements in pixels. */ - top?: number; - } - export interface Size { - /** Specifies the width of the widget. */ - width?: number; - /** Specifies the height of the widget. */ - height?: number; - } - export interface Title { - /** Specifies font options for the title. */ - font?: viz.core.Font; - /** Specifies the widget title's horizontal position. */ - horizontalAlignment?: string; - /** Specifies the widget title's position in the vertical direction. */ - verticalAlignment?: string; - /** Specifies the distance between the title and surrounding widget elements in pixels. */ - margin?: viz.core.Margins; - /** Specifies the height of the space reserved for the title. */ - placeholderSize?: number; - /** Specifies text for the title. */ - text?: string; - /** Specifies a subtitle for the widget. */ - subtitle?: { - /** Specifies font options for the subtitle. */ - font?: viz.core.Font; - /** Specifies text for the subtitle. */ - text?: string; - } - } - export interface Tooltip { - /** Specifies the length of the tooltip's arrow in pixels. */ - arrowLength?: number; - /** Specifies the appearance of the tooltip's border. */ - border?: viz.core.DashedBorderWithOpacity; - /** Specifies a color for the tooltip. */ - color?: string; - /** Specifies the z-index for tooltips. */ - zIndex?: number; - /** Specifies the container to draw tooltips inside of it. */ - container?: any; - /** Specifies text and appearance of a set of tooltips. */ - customizeTooltip?: (arg: Object) => { color?: string; text?: string }; - /** Specifies whether or not the tooltip is enabled. */ - enabled?: boolean; - /** Specifies font options for the text displayed by the tooltip. */ - font?: Font; - /** Specifies a format for the text displayed by the tooltip. */ - format?: string; - /** Specifies the opacity of a tooltip. */ - opacity?: number; - /** Specifies a distance from the tooltip's left/right boundaries to the inner text in pixels. */ - paddingLeftRight?: number; - /** Specifies a distance from the tooltip's top/bottom boundaries to the inner text in pixels. */ - paddingTopBottom?: number; - /** Specifies a precision for formatted values displayed by the tooltip. */ - precision?: number; - /** Specifies options of the tooltip's shadow. */ - shadow?: { - /** Specifies the blur distance of the tooltip's shadow. */ - blur?: number; - /** Specifies the color of the tooltip's shadow. */ - color?: string; - /** Specifies the horizontal offset of the tooltip's shadow relative to the tooltip in pixels. */ - offsetX?: number; - /** Specifies the vertical offset of the tooltip's shadow relative to the tooltip in pixels. */ - offsetY?: number; - /** Specifies the opacity of the tooltip's shadow. */ - opacity?: number; - }; - } - export interface Animation { - /** Determines how long animation runs. */ - duration?: number; - /** Specifies the animation easing mode. */ - easing?: string; - /** Indicates whether or not animation is enabled. */ - enabled?: boolean; - } - export interface LoadingIndicator { - /** Specifies a color for the loading indicator background. */ - backgroundColor?: string; - /** Specifies font options for the loading indicator text. */ - font?: viz.core.Font; - /** Specifies whether to show the loading indicator or not. */ - show?: boolean; - /** Specifies a text to be displayed by the loading indicator. */ - text?: string; - } - export interface LegendBorder extends viz.core.DashedBorderWithOpacity { - /** Specifies a radius for the corners of the legend border. */ - cornerRadius?: number; - } - export interface BaseLegend { - /** Specifies the color of the legend's background. */ - backgroundColor?: string; - /** Specifies legend border settings. */ - border?: viz.core.LegendBorder; - /** Specifies how many columns must be taken to arrange legend items. */ - columnCount?: number; - /** Specifies the spacing between a pair of neighboring legend columns in pixels. */ - columnItemSpacing?: number; - /** Specifies font options for legend items. */ - font?: viz.core.Font; - /** Specifies the legend's position on the map. */ - horizontalAlignment?: string; - /** Specifies the alignment of legend items. */ - itemsAlignment?: string; - /** Specifies the position of text relative to the item marker. */ - itemTextPosition?: string; - /** Specifies the distance between the legend and the container borders in pixels. */ - margin?: viz.core.Margins; - /** Specifies the size of item markers in the legend in pixels. */ - markerSize?: number; - /** Specifies whether to arrange legend items horizontally or vertically. */ - orientation?: string; - /** Specifies the spacing between the legend left/right border and legend items in pixels. */ - paddingLeftRight?: number; - /** Specifies the spacing between the legend top/bottom border and legend items in pixels. */ - paddingTopBottom?: number; - /** Specifies how many rows must be taken to arrange legend items. */ - rowCount?: number; - /** Specifies the spacing between a pair of neighboring legend rows in pixels. */ - rowItemSpacing?: number; - /** Specifies the legend's position on the map. */ - verticalAlignment?: string; - /** Specifies whether or not the legend is visible on the map. */ - visible?: boolean; - } - export interface BaseWidgetOptions extends DOMComponentOptions { - /** A handler for the drawn event. */ - onDrawn?: (e: { - component: BaseWidget; - element: Element; - }) => void; - /** A handler for the incidentOccurred event. */ - onIncidentOccurred?: ( - component: BaseWidget, - element: Element, - target: { - id: string; - type: string; - args: any; - text: string; - widget: string; - version: string; - } - ) => void; - /** Notifies a widget that it is embedded into an HTML page that uses a path modifier. */ - pathModified?: boolean; - /** Specifies whether or not the widget supports right-to-left representation. */ - rtlEnabled?: boolean; - /** Sets the name of the theme to be used in the widget. */ - theme?: string; - } - /** This section describes options and methods that are common to all widgets. */ - export class BaseWidget extends DOMComponent { - /** Returns the widget's SVG markup. */ - svg(): string; - } -} -declare module DevExpress.viz.charts { - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface BaseSeries { - /** Provides information about the state of the series object. */ - fullState: number; - /** Returns the type of the series. */ - type: string; - /** Unselects all the selected points of the series. The points are displayed in an initial style. */ - clearSelection(): void; - /** Gets the color of a particular series. */ - getColor(): string; - /** Gets points from the series point collection based on the specified argument. */ - getPointsByArg(pointArg: any): Array; - /** Gets a point from the series point collection based on the specified point position. */ - getPointByPos(positionIndex: number): Object; - /** Selects the series. The series is displayed in a 'selected' style until another series is selected or the current series is deselected programmatically. */ - select(): void; - /** Selects the specified point. The point is displayed in a 'selected' style. */ - selectPoint(point: BasePoint): void; - /** Deselects the specified point. The point is displayed in an initial style. */ - deselectPoint(point: BasePoint): void; - /** Returns an array of all points in the series. */ - getAllPoints(): Array; - /** Returns visible series points. */ - getVisiblePoints(): Array; - /** Returns the name of the series. */ - name: string; - /** Returns the tag of the series. */ - tag: string; - /** Hides a series. */ - hide(): void; - /** Provides information about the hover state of a series. */ - isHovered(): boolean; - /** Provides information about the selection state of a series. */ - isSelected(): boolean; - /** Provides information about the visibility state of a series. */ - isVisible(): boolean; - /** Makes a particular series visible. */ - show(): void; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface BasePoint { - /** Provides information about the state of the point object. */ - fullState: number; - /** Returns the point's argument value that was set in the data source. */ - originalArgument: any; - /** Returns the point's value that was set in the data source. */ - originalValue: any; - /** Returns the tag of the point. */ - tag: string; - /** Deselects the point. */ - clearSelection(): void; - /** Gets the color of a particular point. */ - getColor(): string; - /** Hides the tooltip of the point. */ - hideTooltip(): void; - /** Provides information about the hover state of a point. */ - isHovered(): boolean; - /** Provides information about the selection state of a point. */ - isSelected(): boolean; - /** Selects the point. The point is displayed in a 'selected' style until another point is selected or the current point is deselected programmatically. */ - select(): void; - /** Shows the tooltip of the point. */ - showTooltip(): void; - /** Allows you to obtain the label of a series point. */ - getLabel(): any; - /** Returns the series object to which the point belongs. */ - series: BaseSeries; - } - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface ChartSeries extends BaseSeries { - /** Returns the name of the series pane. */ - pane: string; - /** Returns the name of the value axis of the series. */ - axis: string; - selectPoint(point: ChartPoint): void; - deselectPoint(point: ChartPoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface ChartPoint extends BasePoint { - /** Contains the close value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalCloseValue: any; - /** Contains the high value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalHighValue: any; - /** Contains the low value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalLowValue: any; - /** Contains the first value of the point. This field is useful for points belonging to a series of the range area or range bar type only. */ - originalMinValue: any; - /** Contains the open value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalOpenValue: any; - /** Contains the size of the bubble as it was set in the data source. This field is useful for points belonging to a series of the bubble type only. */ - size: any; - /** Gets the parameters of the point's minimum bounding rectangle (MBR). */ - getBoundingRect(): { x: number; y: number; width: number; height: number; }; - series: ChartSeries; - } - /** This section describes the methods that can be used in code to manipulate the Label object. */ - export interface Label { - /** Gets the parameters of the label's minimum bounding rectangle (MBR). */ - getBoundingRect(): { x: number; y: number; width: number; height: number; }; - /** Hides the point label. */ - hide(): void; - /** Shows the point label. */ - show(): void; - } - export interface PieSeries extends BaseSeries { - selectPoint(point: PiePoint): void; - deselectPoint(point: PiePoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface PiePoint extends BasePoint { - /** Gets the percentage value of the specific point. */ - percent: any; - /** Provides information about the visibility state of a point. */ - isVisible(): boolean; - /** Makes a specific point visible. */ - show(): void; - /** Hides a specific point. */ - hide(): void; - series: PieSeries; - } - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface PolarSeries extends BaseSeries { - /** Returns the name of the value axis of the series. */ - axis: string; - selectPoint(point: PolarPoint): void; - deselectPoint(point: PolarPoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface PolarPoint extends BasePoint { - series: PolarSeries; - } - export interface Strip { - /** Specifies a color for a strip. */ - color?: string; - /** An object that defines the label configuration options of a strip. */ - label?: { - /** Specifies the text displayed in a strip. */ - text?: string; - }; - /** Specifies a start value for a strip. */ - startValue?: any; - /** Specifies an end value for a strip. */ - endValue?: any; - } - export interface BaseSeriesConfigLabel { - /** Specifies a format for arguments displayed by point labels. */ - argumentFormat?: string; - /** Specifies a precision for formatted point arguments displayed in point labels. */ - argumentPrecision?: number; - /** Specifies a background color for point labels. */ - backgroundColor?: string; - /** Specifies border options for point labels. */ - border?: viz.core.DashedBorder; - /** Specifies connector options for series point labels. */ - connector?: { - /** Specifies the color of label connectors. */ - color?: string; - /** Indicates whether or not label connectors are visible. */ - visible?: boolean; - /** Specifies the width of label connectors. */ - width?: number; - }; - /** Specifies a callback function that returns the text to be displayed by point labels. */ - customizeText?: (pointInfo: Object) => string; - /** Specifies font options for the text displayed in point labels. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed by point labels. */ - format?: string; - position?: string; - /** Specifies a precision for formatted point values displayed in point labels. */ - precision?: number; - /** Specifies the angle used to rotate point labels from their initial position. */ - rotationAngle?: number; - /** Specifies the visibility of point labels. */ - visible?: boolean; - } - export interface SeriesConfigLabel extends BaseSeriesConfigLabel { - /** Specifies whether or not to show a label when the point has a zero value. */ - showForZeroValues?: boolean; - } - export interface ChartSeriesConfigLabel extends SeriesConfigLabel { - /** Specifies how to align point labels relative to the corresponding data points that they represent. */ - alignment?: string; - /** Specifies how to shift point labels horizontally from their initial positions. */ - horizontalOffset?: number; - /** Specifies how to shift point labels vertically from their initial positions. */ - verticalOffset?: number; - /** Specifies a precision for the percentage values displayed in the labels of a full-stacked-like series. */ - percentPrecision?: number; - } - export interface BaseCommonSeriesConfig { - /** Specifies the data source field that provides arguments for series points. */ - argumentField?: string; - axis?: string; - /** An object defining the label configuration options for a series in the dxChart widget. */ - label?: ChartSeriesConfigLabel; - /** Specifies border options for point labels. */ - border?: viz.core.DashedBorder; - /** Specifies a series color. */ - color?: string; - /** Specifies the dash style of the series' line. */ - dashStyle?: string; - hoverMode?: string; - hoverStyle?: { - /** An object defining the border options for a hovered series. */ - border?: viz.core.DashedBorder; - /**

Sets a color for a series when it is hovered over.

*/ - color?: string; - /** Specifies the dash style for the line in a hovered series. */ - dashStyle?: string; - hatching?: viz.core.Hatching; - /** Specifies the width of a line in a hovered series. */ - width?: number; - }; - /** Specifies whether a chart ignores null data points or not. */ - ignoreEmptyPoints?: boolean; - /** Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed. */ - maxLabelCount?: number; - /** Specifies the minimal length of a displayed bar in pixels. */ - minBarSize?: number; - /** Specifies opacity for a series. */ - opacity?: number; - /** Specifies the series elements to highlight when the series is selected. */ - selectionMode?: string; - selectionStyle?: { - /** An object defining the border options for a selected series. */ - border?: viz.core.DashedBorder; - /** Sets a color for a series when it is selected. */ - color?: string; - /** Specifies the dash style for the line in a selected series. */ - dashStyle?: string; - hatching?: viz.core.Hatching; - /** Specifies the width of a line in a selected series. */ - width?: number; - }; - /** Specifies whether or not to show the series in the chart's legend. */ - showInLegend?: boolean; - /** Specifies the name of the stack where the values of the _stackedBar_ series must be located. */ - stack?: string; - /** Specifies the name of the data source field that provides data about a point. */ - tagField?: string; - /** Specifies the data source field that provides values for series points. */ - valueField?: string; - /** Specifies the visibility of a series. */ - visible?: boolean; - /** Specifies a line width. */ - width?: number; - /** Configures error bars. */ - valueErrorBar?: { - /** Specifies whether error bars must be displayed in full or partially. */ - displayMode?: string; - /** Specifies the data field that provides data for low error values. */ - lowValueField?: string; - /** Specifies the data field that provides data for high error values. */ - highValueField?: string; - /** Specifies how error bar values must be calculated. */ - type?: string; - /** Specifies the value to be used for generating error bars. */ - value?: number; - /** Specifies the color of error bars. */ - color?: string; - /** Specifies the opacity of error bars. */ - opacity?: number; - /** Specifies the length of the lines that indicate the error bar edges. */ - edgeLength?: number; - /** Specifies the width of the error bar line. */ - lineWidth?: number; - }; - } - export interface CommonPointOptions { - /** Specifies border options for points in the line and area series. */ - border?: viz.core.Border; - /** Specifies the points color. */ - color?: string; - /** Specifies what series points to highlight when a point is hovered over. */ - hoverMode?: string; - /** An object defining configuration options for a hovered point. */ - hoverStyle?: { - /** An object defining the border options for a hovered point. */ - border?: viz.core.Border; - /** Sets a color for a point when it is hovered over. */ - color?: string; - /** Specifies the diameter of a hovered point in the series that represents data points as symbols (not as bars for instance). */ - size?: number; - }; - /** Specifies what series points to highlight when a point is selected. */ - selectionMode?: string; - /** An object defining configuration options for a selected point. */ - selectionStyle?: { - /** An object defining the border options for a selected point. */ - border?: viz.core.Border; - /**

Sets a color for a point when it is selected.

*/ - color?: string; - /** Specifies the diameter of a selected point in the series that represents data points as symbols (not as bars for instance). */ - size?: number; - }; - /** Specifies the point diameter in pixels for those series that represent data points as symbols (not as bars for instance). */ - size?: number; - /** Specifies a symbol for presenting points of the line and area series. */ - symbol?: string; - visible?: boolean; - } - export interface ChartCommonPointOptions extends CommonPointOptions { - /** An object specifying the parameters of an image that is used as a point marker. */ - image?: { - /** Specifies the height of an image that is used as a point marker. */ - height?: any; - /** Specifies a URL leading to the image to be used as a point marker. */ - url?: any; - /** Specifies the width of an image that is used as a point marker. */ - width?: any; - }; - } - export interface PolarCommonPointOptions extends CommonPointOptions { - /** An object specifying the parameters of an image that is used as a point marker. */ - image?: { - /** Specifies the height of an image that is used as a point marker. */ - height?: number; - /** Specifies a URL leading to the image to be used as a point marker. */ - url?: string; - /** Specifies the width of an image that is used as a point marker. */ - width?: number; - }; - } - /** An object that defines configuration options for chart series. */ - export interface CommonSeriesConfig extends BaseCommonSeriesConfig { - /** Specifies the data source field that provides a 'close' value for a _candleStick_ or _stock_ series. */ - closeValueField?: string; - /** Specifies a radius for bar corners. */ - cornerRadius?: number; - /** Specifies the data source field that provides a 'high' value for a _candleStick_ or _stock_ series. */ - highValueField?: string; - /** Specifies the color for the body (rectangle) of a _candleStick_ series. */ - innerColor?: string; - /** Specifies the data source field that provides a 'low' value for a _candleStick_ or _stock_ series. */ - lowValueField?: string; - /** Specifies the data source field that provides an 'open' value for a _candleStick_ or _stock_ series. */ - openValueField?: string; - /** Specifies the pane that will be used to display a series. */ - pane?: string; - /** An object defining configuration options for points in line-, scatter- and area-like series. */ - point?: ChartCommonPointOptions; - /** Specifies the data source field that provides values for one end of a range series. To set the data source field for the other end of the range series, use the rangeValue2Field property. */ - rangeValue1Field?: string; - /** Specifies the data source field that provides values for the second end of a range series. To set the data source field for the other end of the range series, use the rangeValue1Field property. */ - rangeValue2Field?: string; - /** Specifies reduction options for the stock or candleStick series. */ - reduction?: { - /** Specifies a color for the points whose reduction level price is lower in comparison to the value in the previous point. */ - color?: string; - /** Specifies for which price level (open, high, low or close) to enable reduction options in the series. */ - level?: string; - }; - /** Specifies the data source field that defines the size of bubbles. */ - sizeField?: string; - } - export interface CommonSeriesSettings extends CommonSeriesConfig { - /**

An object that specifies configuration options for all series of the area type in the chart.

*/ - area?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _bar_ type in the chart. */ - bar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the bubble type in the chart. */ - bubble?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _candleStick_ type in the chart. */ - candlestick?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _fullStackedArea_ type in the chart. */ - fullstackedarea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Full-Stacked Spline Area type in the chart. */ - fullstackedsplinearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _fullStackedBar_ type in the chart. */ - fullstackedbar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _fullStackedLine_ type in the chart. */ - fullstackedline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Full-Stacked Spline type in the chart. */ - fullstackedspline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _line_ type in the chart. */ - line?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _rangeArea_ type in the chart. */ - rangearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _rangeBar_ type in the chart. */ - rangebar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _scatter_ type in the chart. */ - scatter?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _spline_ type in the chart. */ - spline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _splineArea_ type in the chart. */ - splinearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedArea_ type in the chart. */ - stackedarea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Stacked Spline Area type in the chart. */ - stackedsplinearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedBar_ type in the chart. */ - stackedbar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedLine_ type in the chart. */ - stackedline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Stacked Spline type in the chart. */ - stackedspline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stepArea_ type in the chart. */ - steparea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stepLine_ type in the chart. */ - stepline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stock_ type in the chart. */ - stock?: CommonSeriesConfig; - /** Sets a series type. */ - type?: string; - } - export interface SeriesConfig extends CommonSeriesConfig { - /** Specifies the name that identifies the series. */ - name?: string; - /** Specifies data about a series. */ - tag?: any; - /** Sets the series type. */ - type?: string; - } - /** An object that defines configuration options for polar chart series. */ - export interface CommonPolarSeriesConfig extends BaseCommonSeriesConfig { - /** Specifies whether or not to close the chart by joining the end point with the first point. */ - closed?: boolean; - label?: SeriesConfigLabel; - point?: PolarCommonPointOptions; - } - export interface CommonPolarSeriesSettings extends CommonPolarSeriesConfig { - /** An object that specifies configuration options for all series of the area type in the chart. */ - area?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _bar_ type in the chart. */ - bar?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _line_ type in the chart. */ - line?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _scatter_ type in the chart. */ - scatter?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedBar_ type in the chart. */ - stackedbar?: CommonPolarSeriesConfig; - /** Sets a series type. */ - type?: string; - } - export interface PolarSeriesConfig extends CommonPolarSeriesConfig { - /** Specifies the name that identifies the series. */ - name?: string; - /** Specifies data about a series. */ - tag?: any; - /** Sets the series type. */ - type?: string; - } - export interface PieSeriesConfigLabel extends BaseSeriesConfigLabel { - /** Specifies how to shift labels from their initial position in a radial direction in pixels. */ - radialOffset?: number; - /** Specifies a precision for the percentage values displayed in labels. */ - percentPrecision?: number; - } - /** An object that defines configuration options for chart series. */ - export interface CommonPieSeriesConfig { - /** Specifies the data source field that provides arguments for series points. */ - argumentField?: string; - /** Specifies the required type for series arguments. */ - argumentType?: string; - /** An object defining the series border configuration options. */ - border?: viz.core.DashedBorder; - /** Specifies a series color. */ - color?: string; - /** Specifies the chart elements to highlight when a series is hovered over. */ - hoverMode?: string; - /** An object defining configuration options for a hovered series. */ - hoverStyle?: { - /** An object defining the border options for a hovered series. */ - border?: viz.core.DashedBorder; - /** Sets a color for the series when it is hovered over. */ - color?: string; - /** Specifies the hatching options to be applied when a point is hovered over. */ - hatching?: viz.core.Hatching; - }; - /** - * Specifies the fraction of the inner radius relative to the total radius in the series of the 'doughnut' type. - * @deprecated Use the innerRadius option instead. - */ - innerRadius?: number; - /** An object defining the label configuration options. */ - label?: PieSeriesConfigLabel; - /** Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed. */ - maxLabelCount?: number; - /** Specifies a minimal size of a displayed pie segment. */ - minSegmentSize?: number; - /** - * Specifies the direction in which the dxPieChart series points are located. - * @deprecated Use the segmentsDirection option instead. - */ - segmentsDirection?: string; - /**

Specifies the chart elements to highlight when the series is selected.

*/ - selectionMode?: string; - /** An object defining configuration options for the series when it is selected. */ - selectionStyle?: { - /** An object defining the border options for a selected series. */ - border?: viz.core.DashedBorder; - /** Sets a color for a series when it is selected. */ - color?: string; - /** Specifies the hatching options to be applied when a point is selected. */ - hatching?: viz.core.Hatching; - }; - /** Specifies chart segment grouping options. */ - smallValuesGrouping?: { - /** Specifies the name of the grouped chart segment. This name represents the segment in the chart legend. */ - groupName?: string; - /** Specifies the segment grouping mode. */ - mode?: string; - /** Specifies a threshold for segment values. */ - threshold?: number; - /** Specifies how many segments must not be grouped. */ - topCount?: number; - }; - /** - * Specifies a start angle for a pie chart in arc degrees. - * @deprecated Use the startAngle option instead. - */ - startAngle?: number; - /**

Specifies the name of the data source field that provides data about a point.

*/ - tagField?: string; - /** Specifies the data source field that provides values for series points. */ - valueField?: string; - } - export interface CommonPieSeriesSettings extends CommonPieSeriesConfig { - /** - * Specifies the type of the pie chart series. - * @deprecated Use the type option instead. - */ - type?: string; - } - export interface PieSeriesConfig extends CommonPieSeriesConfig { - /** - * Sets the series type. - * @deprecated Use the type option instead. - */ - type?: string; - /** Specifies the name that identifies the series. */ - name?: string; - /** Specifies data about a series. */ - tag?: any; - } - export interface SeriesTemplate { - /** Specifies a callback function that returns a series object with individual series settings. */ - customizeSeries?: (seriesName: string) => SeriesConfig; - /** Specifies a data source field that represents the series name. */ - nameField?: string; - } - export interface PolarSeriesTemplate { - /** Specifies a callback function that returns a series object with individual series settings. */ - customizeSeries?: (seriesName: string) => PolarSeriesConfig; - /** Specifies a data source field that represents the series name. */ - nameField?: string; - } - export interface ChartCommonConstantLineLabel { - /** Specifies font options for a constant line label. */ - font?: viz.core.Font; - /** Specifies the position of the constant line label relative to the chart plot. */ - position?: string; - /** Indicates whether or not to display labels for the axis constant lines. */ - visible?: boolean; - } - export interface PolarCommonConstantLineLabel { - /** Indicates whether or not to display labels for the axis constant lines. */ - visible?: boolean; - /** Specifies font options for a constant line label. */ - font?: viz.core.Font; - } - export interface ConstantLineStyle { - /** Specifies a color for a constant line. */ - color?: string; - /** Specifies a dash style for a constant line. */ - dashStyle?: string; - /** Specifies a constant line width in pixels. */ - width?: number; - } - export interface ChartCommonConstantLineStyle extends ConstantLineStyle { - /** An object defining constant line label options. */ - label?: ChartCommonConstantLineLabel; - /** Specifies the space between the constant line label and the left/right side of the constant line. */ - paddingLeftRight?: number; - /** Specifies the space between the constant line label and the top/bottom side of the constant line. */ - paddingTopBottom?: number; - } - export interface PolarCommonConstantLineStyle extends ConstantLineStyle { - /** An object defining constant line label options. */ - label?: PolarCommonConstantLineLabel; - } - export interface CommonAxisLabel { - /** Specifies font options for axis labels. */ - font?: viz.core.Font; - /** Specifies the spacing between an axis and its labels in pixels. */ - indentFromAxis?: number; - /** Indicates whether or not axis labels are visible. */ - visible?: boolean; - } - export interface ChartCommonAxisLabel extends CommonAxisLabel { - /** Specifies the label's position relative to the tick (grid line). */ - alignment?: string; - /** Specifies the overlap resolving algorithm to be applied to axis labels. */ - overlappingBehavior?: { - /** Specifies how to arrange axis labels. */ - mode?: string; - /** Specifies the angle used to rotate axis labels. */ - rotationAngle?: number; - /** Specifies the spacing that must be set between staggered rows when the 'stagger' algorithm is applied. */ - staggeringSpacing?: number; - }; - } - export interface PolarCommonAxisLabel extends CommonAxisLabel { - /** Specifies the overlap resolving algorithm to be applied to axis labels. */ - overlappingBehavior?: string; - } - export interface CommonAxisTitle { - /** Specifies font options for an axis title. */ - font?: viz.core.Font; - /** Specifies a margin for an axis title in pixels. */ - margin?: number; - } - export interface BaseCommonAxisSettings { - /** Specifies the color of the line that represents an axis. */ - color?: string; - /** Specifies whether ticks/grid lines of a discrete axis are located between labels or cross the labels. */ - discreteAxisDivisionMode?: string; - /** An object defining the configuration options for the grid lines of an axis in the dxPolarChart widget. */ - grid?: { - /** Specifies a color for grid lines. */ - color?: string; - /** Specifies an opacity for grid lines. */ - opacity?: number; - /** Indicates whether or not the grid lines of an axis are visible. */ - visible?: boolean; - /** Specifies the width of grid lines. */ - width?: number; - }; - /** Specifies the options of the minor grid. */ - minorGrid?: { - /** Specifies a color for the lines of the minor grid. */ - color?: string; - /** Specifies an opacity for the lines of the minor grid. */ - opacity?: number; - /** Indicates whether the minor grid is visible or not. */ - visible?: boolean; - /** Specifies a width for the lines of the minor grid. */ - width?: number; - }; - /** Indicates whether or not an axis is inverted. */ - inverted?: boolean; - /** Specifies the opacity of the line that represents an axis. */ - opacity?: number; - /** Indicates whether or not to set ticks/grid lines of a continuous axis of the 'date-time' type at the beginning of each date-time interval. */ - setTicksAtUnitBeginning?: boolean; - /** An object defining the configuration options for axis ticks. */ - tick?: { - /** Specifies ticks color. */ - color?: string; - /** Specifies tick opacity. */ - opacity?: number; - /** Indicates whether or not ticks are visible on an axis. */ - visible?: boolean; - /** Specifies tick width. */ - width?: number; - /** Specifies tick length. */ - length?: number; - }; - /** Specifies the options of the minor ticks. */ - minorTick?: { - /** Specifies a color for the minor ticks. */ - color?: string; - /** Specifies an opacity for the minor ticks. */ - opacity?: number; - /** Indicates whether or not the minor ticks are displayed on an axis. */ - visible?: boolean; - /** Specifies minor tick width. */ - width?: number; - /** Specifies minor tick length. */ - length?: number; - }; - /** Indicates whether or not the line that represents an axis in a chart is visible. */ - visible?: boolean; - /** Specifies the width of the line that represents an axis in the chart. */ - width?: number; - } - export interface ChartCommonAxisSettings extends BaseCommonAxisSettings { - /** Specifies the appearance of all the widget's constant lines. */ - constantLineStyle?: ChartCommonConstantLineStyle; - /** An object defining the label configuration options that are common for all axes in the dxChart widget. */ - label?: ChartCommonAxisLabel; - /** Specifies a coefficient that determines the spacing between the maximum series point and the axis. */ - maxValueMargin?: number; - /** Specifies a coefficient that determines the spacing between the minimum series point and the axis. */ - minValueMargin?: number; - /** Specifies, in pixels, the space reserved for an axis. */ - placeholderSize?: number; - /** An object defining configuration options for strip style. */ - stripStyle?: { - /** An object defining the configuration options for a strip label style. */ - label?: { - /** Specifies font options for a strip label. */ - font?: viz.core.Font; - /** Specifies the label's position on a strip. */ - horizontalAlignment?: string; - /** Specifies a label's position on a strip. */ - verticalAlignment?: string; - }; - /** Specifies the spacing, in pixels, between the left/right strip border and the strip label. */ - paddingLeftRight?: number; - /** Specifies the spacing, in pixels, between the top/bottom strip borders and the strip label. */ - paddingTopBottom?: number; - }; - /** An object defining the title configuration options that are common for all axes in the dxChart widget. */ - title?: CommonAxisTitle; - /** Indicates whether or not to display series with indents from axis boundaries. */ - valueMarginsEnabled?: boolean; - } - export interface PolarCommonAxisSettings extends BaseCommonAxisSettings { - /** Specifies the appearance of all the widget's constant lines. */ - constantLineStyle?: PolarCommonConstantLineStyle; - /** An object defining the label configuration options that are common for all axes in the dxPolarChart widget. */ - label?: PolarCommonAxisLabel; - /** An object defining configuration options for strip style. */ - stripStyle?: { - /** An object defining the configuration options for a strip label style. */ - label?: { - /** Specifies font options for a strip label. */ - font?: viz.core.Font; - }; - }; - } - export interface ChartConstantLineLabel extends ChartCommonConstantLineLabel { - /** Specifies the horizontal alignment of a constant line label. */ - horizontalAlignment?: string; - /** Specifies the vertical alignment of a constant line label. */ - verticalAlignment?: string; - /** Specifies the text to be displayed in a constant line label. */ - text?: string; - } - export interface PolarConstantLineLabel extends PolarCommonConstantLineLabel { - /** Specifies the text to be displayed in a constant line label. */ - text?: string; - } - export interface AxisLabel { - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a label on the value axis. */ - customizeHint?: (argument: { value: any; valueText: string }) => string; - /** Specifies a callback function that returns the text to be displayed in value axis labels. */ - customizeText?: (argument: { value: any; valueText: string }) => string; - /** Specifies a format for the text displayed by axis labels. */ - format?: string; - /** Specifies a precision for the formatted value displayed in the axis labels. */ - precision?: number; - } - export interface ChartAxisLabel extends ChartCommonAxisLabel, AxisLabel { } - export interface PolarAxisLabel extends PolarCommonAxisLabel, AxisLabel { } - export interface AxisTitle extends CommonAxisTitle { - /** Specifies the text for the value axis title. */ - text?: string; - } - export interface ChartConstantLineStyle extends ChartCommonConstantLineStyle { - /** An object defining constant line label options. */ - label?: ChartConstantLineLabel; - } - export interface ChartConstantLine extends ChartConstantLineStyle { - /** An object defining constant line label options. */ - label?: ChartConstantLineLabel; - /** Specifies a value to be displayed by a constant line. */ - value?: any; - } - export interface PolarConstantLine extends PolarCommonConstantLineStyle { - /** An object defining constant line label options. */ - label?: PolarConstantLineLabel; - /** Specifies a value to be displayed by a constant line. */ - value?: any; - } - export interface Axis { - /** Specifies a coefficient for dividing the value axis. */ - axisDivisionFactor?: number; - /** Specifies the order in which discrete values are arranged on the value axis. */ - categories?: Array; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic axis. */ - logarithmBase?: number; - /** Specifies an interval between axis ticks/grid lines. */ - tickInterval?: any; - /** Specifies the interval between minor ticks. */ - minorTickInterval?: any; - /** Specifies the number of minor ticks between two neighboring major ticks. */ - minorTickCount?: number; - /** Specifies the required type of the value axis. */ - type?: string; - /** Specifies the pane on which the current value axis will be displayed. */ - pane?: string; - /** Specifies options for value axis strips. */ - strips?: Array; - } - export interface ChartAxis extends ChartCommonAxisSettings, Axis { - /** Defines an array of the value axis constant lines. */ - constantLines?: Array; - /** Specifies the appearance options for the constant lines of the value axis. */ - constantLineStyle?: ChartCommonConstantLineStyle; - /** Specifies options for value axis labels. */ - label?: ChartAxisLabel; - /** Specifies the maximum value on the value axis. */ - max?: any; - /** Specifies the minimum value on the value axis. */ - min?: any; - /** Specifies the position of the value axis on a chart. */ - position?: string; - /** Specifies the title for a value axis. */ - title?: any; - } - export interface PolarAxis extends PolarCommonAxisSettings, Axis { - /** Defines an array of the value axis constant lines. */ - constantLines?: Array; - /** Specifies options for value axis labels. */ - label?: PolarAxisLabel; - } - export interface ArgumentAxis { - /** Specifies the desired type of axis values. */ - argumentType?: string; - /** Specifies the elements that will be highlighted when the argument axis is hovered over. */ - hoverMode?: string; - } - export interface ChartArgumentAxis extends ChartAxis, ArgumentAxis { } - export interface PolarArgumentAxis extends PolarAxis, ArgumentAxis { - /** Specifies the angle in arc degrees to which the argument axis should be rotated. The positive values rotate the axis clockwise. */ - startAngle?: number; - /** Specifies whether or not to display the first point at the angle specified by the startAngle option. */ - firstPointOnStartAngle?: boolean; - /** Specifies the value to be used as the origin for the argument axis. */ - originValue?: number; - /** Specifies the period of the argument values in the data source. */ - period?: number; - } - export interface ValueAxis { - /** Specifies the name of the value axis. */ - name?: string; - /** Specifies whether or not to indicate a zero value on the value axis. */ - showZero?: boolean; - /** Specifies the desired type of axis values. */ - valueType?: string; - } - export interface ChartValueAxis extends ChartAxis, ValueAxis { - /** Specifies the spacing, in pixels, between multiple value axes in a chart. */ - multipleAxesSpacing?: number; - /** Specifies the value by which the chart's value axes are synchronized. */ - synchronizedValue?: number; - } - export interface PolarValueAxis extends PolarAxis, ValueAxis { - /** Indicates whether to display series with indents from axis boundaries. */ - valueMarginsEnabled?: boolean; - /** Specifies a coefficient that determines the spacing between the maximum series point and the axis. */ - maxValueMargin?: number; - /** Specifies a coefficient that determines the spacing between the minimum series point and the axis. */ - minValueMargin?: number; - tick?: { - visible?: boolean; - } - } - export interface CommonPane { - /** Specifies a background color in a pane. */ - backgroundColor?: string; - /** Specifies the border options of a chart's pane. */ - border?: PaneBorder; - } - export interface Pane extends CommonPane { - /** Specifies the name of a pane. */ - name?: string; - } - export interface PaneBorder extends viz.core.DashedBorderWithOpacity { - /** Specifies the bottom border's visibility state in a pane. */ - bottom?: boolean; - /** Specifies the left border's visibility state in a pane. */ - left?: boolean; - /** Specifies the right border's visibility state in a pane. */ - right?: boolean; - /** Specifies the top border's visibility state in a pane. */ - top?: boolean; - } - export interface ChartAnimation extends viz.core.Animation { - /** Specifies the maximum series point count in the chart that the animation supports. */ - maxPointCountSupported?: number; - } - export interface BaseChartTooltip extends viz.core.Tooltip { - /** Specifies a format for arguments of the chart's series points. */ - argumentFormat?: string; - /** Specifies a precision for formatted arguments displayed in tooltips. */ - argumentPrecision?: number; - /** Specifies a precision for a percent value displayed in tooltips for stacked series and dxPieChart series. */ - percentPrecision?: number; - } - export interface BaseChartOptions extends viz.core.BaseWidgetOptions { - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - /** Specifies the width of the widget that is small enough for the layout to begin adapting. */ - width?: number; - /** Specifies the height of the widget that is small enough for the layout to begin adapting. */ - height?: number; - /** Specifies whether or not point labels can be hidden when the layout is adapting. */ - keepLabels?: boolean; - }; - /** Specifies animation options. */ - animation?: ChartAnimation; - /** Specifies a callback function that returns an object with options for a specific point label. */ - customizeLabel?: (labelInfo: Object) => Object; - /** Specifies a callback function that returns an object with options for a specific point. */ - customizePoint?: (pointInfo: Object) => Object; - /** Specifies a data source for the chart. */ - dataSource?: any; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies options of a dxChart's (dxPieChart's) legend. */ - legend?: core.BaseLegend; - /** Specifies the blank space between the chart's extreme elements and the boundaries of the area provided for the widget (see size) in pixels. */ - margin?: viz.core.Margins; - /** Sets the name of the palette to be used in the chart. Alternatively, an array of colors can be set as a custom palette to be used within this chart. */ - palette?: any; - /** A handler for the done event. */ - onDone?: (e: { - component: BaseChart; - element: Element; - }) => void; - /** A handler for the pointClick event. */ - onPointClick?: any; - /** A handler for the pointHoverChanged event. */ - onPointHoverChanged?: (e: { - component: BaseChart; - element: Element; - target: TPoint; - }) => void; - /** A handler for the pointSelectionChanged event. */ - onPointSelectionChanged?: (e: { - component: BaseChart; - element: Element; - target: TPoint; - }) => void; - /** Specifies whether a single point or multiple points can be selected in the chart. */ - pointSelectionMode?: string; - /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */ - redrawOnResize?: boolean; - /** Specifies options for the dxChart and dxPieChart widget series. */ - series?: any; - /** Specifies the size of the widget in pixels. */ - size?: viz.core.Size; - /** Specifies a title for the chart. */ - title?: viz.core.Title; - /** Specifies tooltip options. */ - tooltip?: BaseChartTooltip; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: BaseChart; - element: Element; - target: BasePoint; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: BaseChart; - element: Element; - target: BasePoint; - }) => void; - } - /** A base class for all chart widgets included in the ChartJS library. */ - export class BaseChart extends viz.core.BaseWidget { - /** Deselects the chart's selected series. The series is displayed in an initial style. */ - clearSelection(): void; - /** Gets the current size of the widget. */ - getSize(): { width: number; height: number }; - /** Returns an array of all series in the chart. */ - getAllSeries(): Array; - /** Gets a series within the chart's series collection by the specified name (see the name option). */ - getSeriesByName(seriesName: string): BaseSeries; - /** Gets a series within the chart's series collection by its position number. */ - getSeriesByPos(seriesIndex: number): BaseSeries; - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Hides all widget tooltips. */ - hideTooltip(): void; - /** Redraws a widget. */ - render(renderOptions?: { - force?: boolean; - animate?: boolean; - asyncSeriesRendering?: boolean; - }): void; - } - export interface AdvancedLegend extends core.BaseLegend { - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item. */ - customizeHint?: (seriesInfo: { seriesName: string; seriesIndex: number; seriesColor: string; }) => string; - /**

Specifies a callback function that returns the text to be displayed by legend items.

*/ - customizeText?: (seriesInfo: { seriesName: string; seriesIndex: number; seriesColor: string; }) => string; - /** Specifies what series elements to highlight when a corresponding item in the legend is hovered over. */ - hoverMode?: string; - } - export interface AdvancedOptions extends BaseChartOptions { - /** A handler for the argumentAxisClick event. */ - onArgumentAxisClick?: any; - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** An object providing options for managing data from a data source. */ - dataPrepareSettings?: { - /** Specifies whether or not to validate the values from a data source. */ - checkTypeForAllData?: boolean; - /** Specifies whether or not to convert the values from a data source into the data type of an axis. */ - convertToAxisDataType?: boolean; - /** Specifies how to sort the series points. */ - sortingMethod?: any; - }; - /** A handler for the legendClick event. */ - onLegendClick?: any; - /** A handler for the seriesClick event. */ - onSeriesClick?: any; - /** A handler for the seriesHoverChanged event. */ - onSeriesHoverChanged?: (e: { - component: BaseChart; - element: Element; - target: TSeries; - }) => void; - /** A handler for the seriesSelectionChanged event. */ - onSeriesSelectionChanged?: (e: { - component: BaseChart; - element: Element; - target: TSeries; - }) => void; - /** Specifies whether a single series or multiple series can be selected in the chart. */ - seriesSelectionMode?: string; - /** Specifies how the chart must behave when series point labels overlap. */ - resolveLabelOverlapping?: string; - /** Specifies whether or not all bars in a series must have the same angle, or may have different angles if any points in other series are missing. */ - equalBarWidth?: boolean; - /** Specifies a common bar width as a percentage from 0 to 1. */ - barWidth?: number; - /** Forces the widget to treat negative values as zeroes. Applies to stacked-like series only. */ - negativesAsZeroes?: boolean; - } - export interface Legend extends AdvancedLegend { - /** Specifies whether the legend is located outside or inside the chart's plot. */ - position?: string; - } - export interface ChartTooltip extends BaseChartTooltip { - /** Specifies whether the tooltip must be located in the center of a bar or on its edge. Applies to the Bar and Bubble series. */ - location?: string; - /** Specifies the kind of information to display in a tooltip. */ - shared?: boolean; - } - export interface dxChartOptions extends AdvancedOptions { - adaptiveLayout?: { - keepLabels?: boolean; - }; - /** Indicates whether or not to synchronize value axes when they are displayed on a single pane. */ - synchronizeMultiAxes?: boolean; - /** Specifies whether or not to filter the series points depending on their quantity. */ - useAggregation?: boolean; - /** Indicates whether or not to adjust a value axis to the current minimum and maximum values of a zoomed chart. */ - adjustOnZoom?: boolean; - /** Specifies argument axis options for the dxChart widget. */ - argumentAxis?: ChartArgumentAxis; - /** An object defining the configuration options that are common for all axes of the dxChart widget. */ - commonAxisSettings?: ChartCommonAxisSettings; - /** An object defining the configuration options that are common for all panes in the dxChart widget. */ - commonPaneSettings?: CommonPane; - /** An object defining the configuration options that are common for all series of the dxChart widget. */ - commonSeriesSettings?: CommonSeriesSettings; - /** An object that specifies the appearance options of the chart crosshair. */ - crosshair?: { - /** Specifies a color for the crosshair lines. */ - color?: string; - /** Specifies a dash style for the crosshair lines. */ - dashStyle?: string; - /** Specifies whether to enable the crosshair or not. */ - enabled?: boolean; - /** Specifies the opacity of the crosshair lines. */ - opacity?: number; - /** Specifies the width of the crosshair lines. */ - width?: number; - /** Specifies the appearance of the horizontal crosshair line. */ - horizontalLine?: CrosshaierWithLabel; - /** Specifies the appearance of the vertical crosshair line. */ - verticalLine?: CrosshaierWithLabel; - /** Specifies the options of the crosshair labels. */ - label?: { - /** Specifies a color for the background of the crosshair labels. */ - backgroundColor?: string; - /** Specifies whether the crosshair labels are visible or not. */ - visible?: boolean; - /** Specifies font options for the text of the crosshair labels. */ - font?: viz.core.Font; - /** Specifies the format of the values displayed by crosshair labels. */ - format?: string; - /** Specifies a precision for formatted values. */ - precision?: number; - /** Customizes the text displayed by the crosshair labels. */ - customizeText?: (info: { value: any; valueText: string; point: ChartPoint; }) => string; - } - }; - /** Specifies a default pane for the chart series. */ - defaultPane?: string; - /** Specifies a coefficient determining the diameter of the largest bubble. */ - maxBubbleSize?: number; - /** Specifies the diameter of the smallest bubble measured in pixels. */ - minBubbleSize?: number; - /** Defines the dxChart widget's pane(s). */ - panes?: Array; - /** Swaps the axes round so that the value axis becomes horizontal and the argument axes becomes vertical. */ - rotated?: boolean; - /** Specifies the options of a chart's legend. */ - legend?: Legend; - /** Specifies options for dxChart widget series. */ - series?: Array; - /** Defines options for the series template. */ - seriesTemplate?: SeriesTemplate; - /** Specifies tooltip options. */ - tooltip?: ChartTooltip; - /** Specifies value axis options for the dxChart widget. */ - valueAxis?: Array; - /** Enables scrolling in your chart. */ - scrollingMode?: string; - /** Enables zooming in your chart. */ - zoomingMode?: string; - /** Specifies the settings of the scroll bar. */ - scrollBar?: { - /** Specifies whether the scroll bar is visible or not. */ - visible?: boolean; - /** Specifies the spacing between the scroll bar and the chart's plot in pixels. */ - offset?: number; - /** Specifies the color of the scroll bar. */ - color?: string; - /** Specifies the width of the scroll bar in pixels. */ - width?: number; - /** Specifies the opacity of the scroll bar. */ - opacity?: number; - /** Specifies the position of the scroll bar in the chart. */ - position?: string; - }; - } - /** A widget used to embed charts into HTML JS applications. */ - export class dxChart extends BaseChart { - constructor(element: JQuery, options?: dxChartOptions); - constructor(element: Element, options?: dxChartOptions); - /** Sets the specified start and end values for the chart's argument axis. */ - zoomArgument(startValue: any, endValue: any): void; - } - interface CrosshaierWithLabel extends viz.core.DashedBorderWithOpacity { - /** Configures the label that belongs to the horizontal crosshair line. */ - label?: { - /** Specifies a color for the background of the label that belongs to the horizontal crosshair line. */ - backgroundColor?: string; - /** Specifies whether the label of the horizontal crosshair line is visible or not. */ - visible?: boolean; - /** Specifies font options for the text of the label that belongs to the horizontal crosshair line. */ - font?: viz.core.Font; - /** Specifies the format of the values displayed by crosshair labels. */ - format?: string; - /** Specifies a precision for formatted values. */ - precision?: number; - /** Customizes the text displayed by the crosshair label that accompany the horizontal line. */ - customizeText?: (info: { value: any; valueText: string; point: ChartPoint; }) => string; - } - } - export interface PolarChartTooltip extends BaseChartTooltip { - /** Specifies the kind of information to display in a tooltip. */ - shared?: boolean; - } - export interface dxPolarChartOptions extends AdvancedOptions { - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - width?: number; - height?: number; - /** Specifies whether or not point labels can be hidden when the layout is adapting. */ - keepLabels?: boolean; - }; - /** Indicates whether or not to display a "spider web". */ - useSpiderWeb?: boolean; - /** Specifies argument axis options for the dxPolarChart widget. */ - argumentAxis?: PolarArgumentAxis; - /** An object defining the configuration options that are common for all axes of the dxPolarChart widget. */ - commonAxisSettings?: PolarCommonAxisSettings; - /** An object defining the configuration options that are common for all series of the dxPolarChart widget. */ - commonSeriesSettings?: CommonPolarSeriesSettings; - /** Specifies the options of a chart's legend. */ - legend?: AdvancedLegend; - /** Specifies options for dxPolarChart widget series. */ - series?: Array; - /** Defines options for the series template. */ - seriesTemplate?: PolarSeriesTemplate; - /** Specifies tooltip options. */ - tooltip?: PolarChartTooltip; - /** Specifies value axis options for the dxPolarChart widget. */ - valueAxis?: PolarValueAxis; - } - /** A chart widget displaying data in a polar coordinate system. */ - export class dxPolarChart extends BaseChart { - constructor(element: JQuery, options?: dxPolarChartOptions); - constructor(element: Element, options?: dxPolarChartOptions); - } - export interface PieLegend extends core.BaseLegend { - /** Specifies what chart elements to highlight when a corresponding item in the legend is hovered over. */ - hoverMode?: string; - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item. */ - customizeHint?: (pointInfo: { pointName: string; pointIndex: number; pointColor: string; }) => string; - /** Specifies a callback function that returns the text to be displayed by a legend item. */ - customizeText?: (pointInfo: { pointName: string; pointIndex: number; pointColor: string; }) => string; - } - export interface dxPieChartOptions extends BaseChartOptions { - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - /** Specifies whether or not point labels can be hidden when the layout is adapting. */ - keepLabels?: boolean; - }; - /** Specifies dxPieChart legend options. */ - legend?: PieLegend; - /** Specifies options for the series of the dxPieChart widget. */ - series?: Array; - /** Specifies the diameter of the pie. */ - diameter?: number; - /** Specifies the direction that the pie chart segments will occupy. */ - segmentsDirection?: string; - /** Specifies the angle in arc degrees from which the first segment of a pie chart should start. */ - startAngle?: number; - /** Specifies the fraction of the inner radius relative to the total radius in the series of the 'doughnut' type. The value should be between 0 and 1. */ - innerRadius?: number; - /** A handler for the legendClick event. */ - onLegendClick?: any; - /** Specifies how a chart must behave when series point labels overlap. */ - resolveLabelOverlapping?: string; - /** An object defining the configuration options that are common for all series of the dxPieChart widget. */ - commonSeriesSettings?: CommonPieSeriesSettings; - /** Specifies the type of the pie chart series. */ - type?: string; - } - /** A circular chart widget for HTML JS applications. */ - export class dxPieChart extends BaseChart { - constructor(element: JQuery, options?: dxPieChartOptions); - constructor(element: Element, options?: dxPieChartOptions); - /** - * Provides access to the dxPieChart series. - * @deprecated Use the getAllSeries() method instead. - */ - getSeries(): PieSeries; - } -} -interface JQuery { - dxChart(options?: DevExpress.viz.charts.dxChartOptions): JQuery; - dxChart(methodName: string, ...params: any[]): any; - dxChart(methodName: "instance"): DevExpress.viz.charts.dxChart; - dxPieChart(options?: DevExpress.viz.charts.dxPieChartOptions): JQuery; - dxPieChart(methodName: string, ...params: any[]): any; - dxPieChart(methodName: "instance"): DevExpress.viz.charts.dxPieChart; - dxPolarChart(options?: DevExpress.viz.charts.dxPolarChartOptions): JQuery; - dxPolarChart(methodName: string, ...params: any[]): any; - dxPolarChart(methodName: "instance"): DevExpress.viz.charts.dxPolarChart; -} -declare module DevExpress.viz.gauges { - export interface BaseRangeContainer { - /** Specifies a range container's background color. */ - backgroundColor?: string; - /** Specifies the offset of the range container from an invisible scale line in pixels. */ - offset?: number; - /** Sets the name of the palette or an array of colors to be used for coloring the gauge range container. */ - palette?: any; - /** An array of objects representing ranges contained in the range container. */ - ranges?: Array<{ startValue: number; endValue: number; color: string }>; - /** Specifies a color of a range. */ - color?: string; - /** Specifies an end value of a range. */ - endValue?: number; - /** Specifies a start value of a range. */ - startValue?: number; - } - export interface ScaleTick { - /** Specifies the color of the scale's minor ticks. */ - color?: string; - /** - * Specifies an array of custom minor ticks. - * @deprecated Use the scale | customMinorTicks option instead. - */ - customTickValues?: Array; - /** Specifies the length of the scale's minor ticks. */ - length?: number; - /** - * Indicates whether automatically calculated minor ticks are visible or not. - * @deprecated This feature is no longer available. - */ - showCalculatedTicks?: boolean; - /** - * Specifies an interval between minor ticks. - * @deprecated Use the scale | minorTickInterval option instead. - */ - tickInterval?: number; - /** Indicates whether scale minor ticks are visible or not. */ - visible?: boolean; - /** Specifies the width of the scale's minor ticks. */ - width?: number; - } - export interface ScaleMajorTick extends ScaleTick { - /** - * Specifies whether or not to expand the current major tick interval if labels overlap each other. - * @deprecated Use the overlappingBehavior | useAutoArrangement option instead. - */ - useTicksAutoArrangement?: boolean; - } - export interface ScaleMinorTick extends ScaleTick { - /** Specifies the opacity of the scale's minor ticks. */ - opacity?: number; - } - export interface BaseScaleLabel { - /** Specifies whether or not scale labels should be colored similarly to their corresponding ranges in the range container. */ - useRangeColors?: boolean; - /** Specifies a callback function that returns the text to be displayed in scale labels. */ - customizeText?: (scaleValue: { value: number; valueText: string }) => string; - /** Specifies the overlap resolving options to be applied to scale labels. */ - overlappingBehavior?: { - /** Specifies whether or not to expand the current major tick interval if labels overlap each other. */ - useAutoArrangement?: boolean; - /** Specifies what label to hide in case of overlapping. */ - hideFirstOrLast?: string; - }; - /** Specifies font options for the text displayed in the scale labels of the gauge. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in scale labels. */ - format?: string; - /** Specifies a precision for the formatted value displayed in the scale labels. */ - precision?: number; - /** Specifies whether or not scale labels are visible on the gauge. */ - visible?: boolean; - } - export interface BaseScale { - /** Specifies the end value for the scale of the gauge. */ - endValue?: number; - /** - * Specifies whether or not to hide the first scale label. - * @deprecated This feature is no longer available. - */ - hideFirstLabel?: boolean; - /** - * Specifies whether or not to hide the first major tick on the scale. - * @deprecated This feature is no longer available. - */ - hideFirstTick?: boolean; - /** - * Specifies whether or not to hide the last scale label. - * @deprecated This feature is no longer available. - */ - hideLastLabel?: boolean; - /** - * Specifies whether or not to hide the last major tick on the scale. - * @deprecated This feature is no longer available. - */ - hideLastTick?: boolean; - /** Specifies an interval between major ticks. */ - tickInterval?: number; - /** Specifies an interval between minor ticks. */ - minorTickInterval?: number; - /** Specifies an array of custom major ticks. */ - customTicks?: Array; - /** Specifies an array of custom minor ticks. */ - customMinorTicks?: Array; - /** Specifies common options for scale labels. */ - label?: BaseScaleLabel; - /** - * Specifies options of the gauge's major ticks. - * @deprecated Use the tick option instead. - */ - majorTick?: ScaleMajorTick; - /** Specifies options of the gauge's major ticks. */ - tick?: { - /** Specifies the color of the scale's major ticks. */ - color?: string; - /** Specifies the length of the scale's major ticks. */ - length?: number; - /** Indicates whether scale major ticks are visible or not. */ - visible?: boolean; - /** Specifies the width of the scale's major ticks. */ - width?: number; - /** Specifies the opacity of the scale's major ticks. */ - opacity?: number; - }; - /** Specifies options of the gauge's minor ticks. */ - minorTick?: ScaleMinorTick; - /** Specifies the start value for the scale of the gauge. */ - startValue?: number; - } - export interface BaseValueIndicator { - /** Specifies the type of subvalue indicators. */ - type?: string; - /** Specifies the background color for the indicator of the rangeBar type. */ - backgroundColor?: string; - /** Specifies the base value for the indicator of the rangeBar type. */ - baseValue?: number; - /** Specifies a color of the indicator. */ - color?: string; - /** Specifies the range bar size for an indicator of the rangeBar type. */ - size?: number; - text?: { - /** Specifies a callback function that returns the text to be displayed in an indicator. */ - customizeText?: (indicatedValue: { value: number; valueText: string }) => string; - font?: viz.core.Font; - /** Specifies a format for the text displayed in an indicator. */ - format?: string; - /** Specifies the range bar's label indent in pixels. */ - indent?: number; - /** Specifies a precision for the formatted value displayed by an indicator. */ - precision?: number; - }; - offset?: number; - length?: number; - width?: number; - /** Specifies the length of an arrow for the indicator of the textCloud type in pixels. */ - arrowLength?: number; - /** Sets the array of colors to be used for coloring subvalue indicators. */ - palette?: Array; - /** Specifies the distance between the needle and the center of a gauge for the indicator of a needle-like type. */ - indentFromCenter?: number; - /** Specifies the second color for the indicator of the twoColorNeedle type. */ - secondColor?: string; - /** Specifies the length of a twoNeedleColor type indicator tip as a percentage. */ - secondFraction?: number; - /** Specifies the spindle's diameter in pixels for the indicator of a needle-like type. */ - spindleSize?: number; - /** Specifies the inner diameter in pixels, so that the spindle has the shape of a ring. */ - spindleGapSize?: number; - /** Specifies the orientation of the rangeBar indicator on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - /** Specifies the orientation of the rangeBar indicator on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - } - export interface SharedGaugeOptions { - /** Specifies animation options. */ - animation?: viz.core.Animation; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */ - redrawOnResize?: boolean; - /** Specifies the size of the widget in pixels. */ - size?: viz.core.Size; - /** - * Specifies a subtitle for the widget. - * @deprecated Use the title | subtitle option instead. - */ - subtitle?: { - /** - * Specifies font options for the subtitle. - * @deprecated Use the title | subtitle | font option instead. - */ - font?: viz.core.Font; - /** - * Specifies a text for the subtitle. - * @deprecated Use the title | subtitle | text option instead. - */ - text?: string; - }; - /** Specifies a title for a gauge. */ - title?: { - /** Specifies font options for the title. */ - font?: viz.core.Font; - /** - * Specifies a title's position on the gauge. - * @deprecated Use the horizontalAlignment and verticalAlignment options instead. - */ - position?: string; - /** Specifies the distance between the title and surrounding gauge elements in pixels. */ - margin?: viz.core.Margins; - /** Specifies the height of the space reserved for the title. */ - placeholderSize?: number; - /** Specifies the gauge title's position in the vertical direction. */ - verticalAlignment?: string; - /** Specifies the gauge title's horizontal position. */ - horizontalAlignment?: string; - /** Specifies text for the title. */ - text?: string; - /** Specifies a subtitle for the widget. */ - subtitle?: { - /** Specifies font options for the subtitle. */ - font?: viz.core.Font; - /** Specifies text for the subtitle. */ - text?: string; - } - }; - /** Specifies options for gauge tooltips. */ - tooltip?: viz.core.Tooltip; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: dxBaseGauge; - element: Element; - target: {}; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: dxBaseGauge; - element: Element; - target: {}; - }) => void; - } - export interface BaseGaugeOptions extends viz.core.BaseWidgetOptions, SharedGaugeOptions { - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** Specifies the blank space in pixels between the widget's extreme elements and the boundaries of the area provided for the widget (see the size option). */ - margin?: viz.core.Margins; - /** Specifies options of the gauge's range container. */ - rangeContainer?: BaseRangeContainer; - /** Specifies a gauge's scale options. */ - scale?: BaseScale; - /** Specifies the appearance options of subvalue indicators. */ - subvalueIndicator?: BaseValueIndicator; - /** Specifies a set of subvalues to be designated by the subvalue indicators. */ - subvalues?: Array; - /** Specifies the main value on a gauge. */ - value?: number; - /** Specifies the appearance options of the value indicator. */ - valueIndicator?: BaseValueIndicator; - } - /** A gauge widget. */ - export class dxBaseGauge extends viz.core.BaseWidget { - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(): void; - /** Returns the main gauge value. */ - value(): number; - /** Updates a gauge value. */ - value(value: number): void; - /** Returns an array of gauge subvalues. */ - subvalues(): Array; - /** Updates gauge subvalues. */ - subvalues(subvalues: Array): void; - } - export interface LinearRangeContainer extends BaseRangeContainer { - /** Specifies the orientation of the range container on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - /** Specifies the orientation of a range container on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - /** Specifies the width of the range container's start and end boundaries in the dxLinearGauge widget. */ - width?: any; - /** Specifies an end width of a range container. */ - end?: number; - /** Specifies a start width of a range container. */ - start?: number; - } - export interface LinearScaleLabel extends BaseScaleLabel { - /** Specifies the spacing between scale labels and ticks. */ - indentFromTick?: number; - } - export interface LinearScale extends BaseScale { - /** Specifies the orientation of scale ticks on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - label?: LinearScaleLabel; - /** Specifies the orientation of scale ticks on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - } - export interface dxLinearGaugeOptions extends BaseGaugeOptions { - /** Specifies the options required to set the geometry of the dxLinearGauge widget. */ - geometry?: { - /** Indicates whether to display the dxLinearGauge widget vertically or horizontally. */ - orientation?: string; - }; - /** Specifies gauge range container options. */ - rangeContainer?: LinearRangeContainer; - scale?: LinearScale; - } - /** A widget that represents a gauge with a linear scale. */ - export class dxLinearGauge extends dxBaseGauge { - constructor(element: JQuery, options?: dxLinearGaugeOptions); - constructor(element: Element, options?: dxLinearGaugeOptions); - } - export interface CircularRangeContainer extends BaseRangeContainer { - /** Specifies the orientation of the range container in the dxCircularGauge widget. */ - orientation?: string; - /** Specifies the range container's width in pixels. */ - width?: number; - } - export interface CircularScaleLabel extends BaseScaleLabel { - /** Specifies the spacing between scale labels and ticks. */ - indentFromTick?: number; - } - export interface CircularScale extends BaseScale { - label?: CircularScaleLabel; - /** Specifies the orientation of scale ticks. */ - orientation?: string; - } - export interface dxCircularGaugeOptions extends BaseGaugeOptions { - /** Specifies the options required to set the geometry of the dxCircularGauge widget. */ - geometry?: { - /** Specifies the end angle of the circular gauge's arc. */ - endAngle?: number; - /** Specifies the start angle of the circular gauge's arc. */ - startAngle?: number; - }; - /** Specifies gauge range container options. */ - rangeContainer?: CircularRangeContainer; - scale?: CircularScale; - } - /** A widget that represents a gauge with a circular scale. */ - export class dxCircularGauge extends dxBaseGauge { - constructor(element: JQuery, options?: dxCircularGaugeOptions); - constructor(element: Element, options?: dxCircularGaugeOptions); - } - export interface dxBarGaugeOptions extends viz.core.BaseWidgetOptions, SharedGaugeOptions { - /** Specifies a color for the remaining segment of the bar's track. */ - backgroundColor?: string; - /** Specifies a distance between bars in pixels. */ - barSpacing?: number; - /** Specifies a base value for bars. */ - baseValue?: number; - /** Specifies an end value for the gauge's invisible scale. */ - endValue?: number; - /** Defines the shape of the gauge's arc. */ - geometry?: { - /** Specifies the end angle of the bar gauge's arc. */ - endAngle?: number; - /** Specifies the start angle of the bar gauge's arc. */ - startAngle?: number; - }; - /** Specifies the options of the labels that accompany gauge bars. */ - label?: { - /** Specifies a color for the label connector text. */ - connectorColor?: string; - /** Specifies the width of the label connector in pixels. */ - connectorWidth?: number; - /** Specifies a callback function that returns a text for labels. */ - customizeText?: (barValue: { value: number; valueText: string }) => string; - /** Specifies font options for bar labels. */ - font?: viz.core.Font; - /** Specifies a format for bar labels. */ - format?: string; - /** Specifies the distance between the upper bar and bar labels in pixels. */ - indent?: number; - /** Specifies a precision for the formatted value displayed by labels. */ - precision?: number; - /** Specifies whether bar labels appear on a gauge or not. */ - visible?: boolean; - }; - /** Sets the name of the palette or an array of colors to be used for coloring the gauge range container. */ - palette?: any; - /** Defines the radius of the bar that is closest to the center relatively to the radius of the topmost bar. */ - relativeInnerRadius?: number; - /** Specifies a start value for the gauge's invisible scale. */ - startValue?: number; - /** Specifies the array of values to be indicated on a bar gauge. */ - values?: Array; - } - /** A circular bar widget. */ - export class dxBarGauge extends viz.core.BaseWidget { - constructor(element: JQuery, options?: dxBarGaugeOptions); - constructor(element: Element, options?: dxBarGaugeOptions); - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws the widget. */ - render(): void; - /** Returns an array of gauge values. */ - values(): Array; - /** Updates the values displayed by a gauge. */ - values(values: Array): void; - } -} -interface JQuery { - dxLinearGauge(options?: DevExpress.viz.gauges.dxLinearGaugeOptions): JQuery; - dxLinearGauge(methodName: string, ...params: any[]): any; - dxLinearGauge(methodName: "instance"): DevExpress.viz.gauges.dxLinearGauge; - dxCircularGauge(options?: DevExpress.viz.gauges.dxCircularGaugeOptions): JQuery; - dxCircularGauge(methodName: string, ...params: any[]): any; - dxCircularGauge(methodName: "instance"): DevExpress.viz.gauges.dxCircularGauge; - dxBarGauge(options?: DevExpress.viz.gauges.dxBarGaugeOptions): JQuery; - dxBarGauge(methodName: string, ...params: any[]): any; - dxBarGauge(methodName: "instance"): DevExpress.viz.gauges.dxBarGauge; -} -declare module DevExpress.viz.rangeSelector { - export interface dxRangeSelectorOptions extends viz.core.BaseWidgetOptions { - /** Specifies the options for the range selector's background. */ - background?: { - /** Specifies the background color for the dxRangeSelector. */ - color?: string; - /** Specifies image options. */ - image?: { - /** Specifies a location for the image in the background of a range selector. */ - location?: string; - /** Specifies the image's URL. */ - url?: string; - }; - /** Indicates whether or not the background (background color and/or image) is visible. */ - visible?: boolean; - }; - /** Specifies a title for the range selector. */ - title?: viz.core.Title; - /** Specifies the dxRangeSelector's behavior options. */ - behavior?: { - /** Indicates whether or not you can swap sliders. */ - allowSlidersSwap?: boolean; - /** Indicates whether or not animation is enabled. */ - animationEnabled?: boolean; - /** Specifies when to call the onSelectedRangeChanged function. */ - callSelectedRangeChanged?: string; - /** Indicates whether or not an end user can specify the range using a mouse, without the use of sliders. */ - manualRangeSelectionEnabled?: boolean; - /** Indicates whether or not an end user can shift the selected range to the required location on a scale by clicking. */ - moveSelectedRangeByClick?: boolean; - /** Indicates whether to snap a slider to ticks. */ - snapToTicks?: boolean; - }; - /** Specifies the options required to display a chart as the range selector's background. */ - chart?: { - /** Specifies a coefficient for determining an indent from the bottom background boundary to the lowest chart point. */ - bottomIndent?: number; - /** An object defining the common configuration options for the chart’s series. */ - commonSeriesSettings?: viz.charts.CommonSeriesSettings; - /** An object providing options for managing data from a data source. */ - dataPrepareSettings?: { - /** Specifies whether or not to validate values from a data source. */ - checkTypeForAllData?: boolean; - /** Specifies whether or not to convert the values from a data source into the data type of an axis. */ - convertToAxisDataType?: boolean; - /** Specifies how to sort series points. */ - sortingMethod?: any; - }; - /** Specifies whether all bars in a series must have the same width, or may have different widths if any points in other series are missing. */ - equalBarWidth?: boolean; - /** Specifies a common bar width as a percentage from 0 to 1. */ - barWidth?: number; - /** Forces the widget to treat negative values as zeroes. Applies to stacked-like series only. */ - negativesAsZeroes?: boolean; - /** Sets the name of the palette to be used in the range selector's chart. Alternatively, an array of colors can be set as a custom palette to be used within this chart. */ - palette?: any; - /** An object defining the chart’s series. */ - series?: Array; - /** Defines options for the series template. */ - seriesTemplate?: viz.charts.SeriesTemplate; - /** Specifies a coefficient for determining an indent from the background's top boundary to the topmost chart point. */ - topIndent?: number; - /** Specifies whether or not to filter the series points depending on their quantity. */ - useAggregation?: boolean; - /** Specifies options for the chart's value axis. */ - valueAxis?: { - /** Indicates whether or not the chart's value axis must be inverted. */ - inverted?: boolean; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic value axis. */ - logarithmBase?: number; - /** Specifies the maximum value of the chart's value axis. */ - max?: number; - /** Specifies the minimum value of the chart's value axis. */ - min?: number; - /** Specifies the type of the value axis. */ - type?: string; - /** Specifies the desired type of axis values. */ - valueType?: string; - }; - }; - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** Specifies a data source for the scale values and for the chart at the background. */ - dataSource?: any; - /** Specifies the data source field that provides data for the scale. */ - dataSourceField?: string; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies the blank space in pixels between the dxRangeSelector widget's extreme elements and the boundaries of the area provided for the widget (see size). */ - margin?: viz.core.Margins; - /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */ - redrawOnResize?: boolean; - /** Specifies options of the range selector's scale. */ - scale?: { - /** Specifies the scale's end value. */ - endValue?: any; - /** Specifies common options for scale labels. */ - label?: { - /** Specifies a callback function that returns the text to be displayed in scale labels. */ - customizeText?: (scaleValue: { value: any; valueText: string; }) => string; - /** Specifies font options for the text displayed in the range selector's scale labels. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in scale labels. */ - format?: string; - /** Specifies a precision for the formatted value displayed in the scale labels. */ - precision?: number; - /** Specifies a spacing between scale labels and the background bottom edge. */ - topIndent?: number; - /** Specifies whether or not the scale's labels are visible. */ - visible?: boolean; - }; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic scale. */ - logarithmBase?: number; - /** - * Specifies an interval between major ticks. - * @deprecated Use the tickInterval option instead. - */ - majorTickInterval?: any; - /** Specifies an interval between axis ticks. */ - tickInterval?: any; - /** Specifies options for the date-time scale's markers. */ - marker?: { - /** Defines the options that can be set for the text that is displayed by the scale markers. */ - label?: { - /** Specifies a callback function that returns the text to be displayed in scale markers. */ - customizeText?: (markerValue: { value: any; valueText: string }) => string; - /** Specifies a format for the text displayed in scale markers. */ - format?: string; - }; - /** Specifies the height of the marker's separator. */ - separatorHeight?: number; - /** Specifies the space between the marker label and the marker separator. */ - textLeftIndent?: number; - /** Specifies the space between the marker's label and the top edge of the marker's separator. */ - textTopIndent?: number; - /** Specified the indent between the marker and the scale lables. */ - topIndent?: number; - /** Indicates whether scale markers are visible. */ - visible?: boolean; - }; - /** Specifies the maximum range that can be selected. */ - maxRange?: any; - /** Specifies the number of minor ticks between neighboring major ticks. */ - minorTickCount?: number; - /** Specifies an interval between minor ticks. */ - minorTickInterval?: any; - /** Specifies the minimum range that can be selected. */ - minRange?: any; - /** Specifies the height of the space reserved for the scale in pixels. */ - placeholderHeight?: number; - /** Indicates whether or not to set ticks of a date-time scale at the beginning of each date-time interval. */ - setTicksAtUnitBeginning?: boolean; - /** Specifies whether or not to show ticks for the boundary scale values, when neither major ticks nor minor ticks are created for these values. */ - showCustomBoundaryTicks?: boolean; - /** - * Indicates whether or not to show minor ticks on the scale. - * @deprecated Use the minorTick | visible option instead. - */ - showMinorTicks?: boolean; - /** Specifies the scale's start value. */ - startValue?: any; - /** Specifies options defining the appearance of scale ticks. */ - tick?: { - /** Specifies the color of scale ticks (both major and minor ticks). */ - color?: string; - /** Specifies the opacity of scale ticks (both major and minor ticks). */ - opacity?: number; - /** Specifies the width of the scale's ticks (both major and minor ticks). */ - width?: number; - }; - /** Specifies options of the range selector's minor ticks. */ - minorTick?: { - /** Specifies the color of the scale's minor ticks. */ - color?: string; - /** Specifies the opacity of the scale's minor ticks. */ - opacity?: number; - /** Specifies the width of the scale's minor ticks. */ - width?: number; - /** Indicates whether scale minor ticks are visible or not. */ - visible?: boolean; - }; - /** Specifies the type of the scale. */ - type?: string; - /** Specifies whether or not to expand the current tick interval if labels overlap each other. */ - useTicksAutoArrangement?: boolean; - /** Specifies the type of values on the scale. */ - valueType?: string; - /** Specifies the order of arguments on a discrete scale. */ - categories?: Array; - }; - /** Specifies the range to be selected when displaying the dxRangeSelector. */ - selectedRange?: { - /** Specifies the start value of the range to be selected when displaying the dxRangeSelector widget on a page. */ - startValue?: any; - /** Specifies the end value of the range to be selected when displaying the dxRangeSelector widget on a page. */ - endValue?: any; - }; - /** Specifies the color of the selected range. */ - selectedRangeColor?: string; - /** Range selector's indent options. */ - indent?: { - /** Specifies range selector's left indent. */ - left?: number; - /** Specifies range selector's right indent. */ - right?: number; - }; - /** A handler for the selectedRangeChanged event. */ - onSelectedRangeChanged?: (e: { - startValue: any; - endValue: any; - component: dxRangeSelector; - element: Element; - }) => void; - /** Specifies range selector shutter options. */ - shutter?: { - /** Specifies shutter color. */ - color?: string; - /** Specifies the opacity of the color of shutters. */ - opacity?: number; - }; - /** Specifies in pixels the size of the dxRangeSelector widget. */ - size?: viz.core.Size; - /** Specifies the appearance of the range selector's slider handles. */ - sliderHandle?: { - /** Specifies the color of the slider handles. */ - color?: string; - /** Specifies the opacity of the slider handles. */ - opacity?: number; - /** Specifies the width of the slider handles. */ - width?: number; - }; - /** Defines the options of the range selector slider markers. */ - sliderMarker?: { - /** Specifies the color of the slider markers. */ - color?: string; - /** Specifies a callback function that returns the text to be displayed by slider markers. */ - customizeText?: (scaleValue: { value: any; valueText: any; }) => string; - /** Specifies font options for the text displayed by the range selector slider markers. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in slider markers. */ - format?: string; - /** Specifies the color used for the slider marker text when the currently selected range does not match the minRange and maxRange values. */ - invalidRangeColor?: string; - /** - * Specifies the empty space between the marker's border and the marker’s text. - * @deprecated Use the paddingTopBottom and paddingLeftRight options instead. - */ - padding?: number; - /** Specifies the empty space between the marker's top and bottom borders and the marker's text. */ - paddingTopBottom?: number; - /** Specifies the empty space between the marker's left and right borders and the marker's text. */ - paddingLeftRight?: number; - /** Specifies the placeholder height of the slider marker. */ - placeholderHeight?: number; - /** - * Specifies in pixels the height and width of the space reserved for the range selector slider markers. - * @deprecated Use the placeholderHeight and indent options instead. - */ - placeholderSize?: { - /** Specifies the height of the placeholder for the left and right slider markers. */ - height?: number; - /** Specifies the width of the placeholder for the left and right slider markers. */ - width?: { - /** Specifies the width of the left slider marker's placeholder. */ - left?: number; - /** Specifies the width of the right slider marker's placeholder. */ - right?: number; - }; - }; - /** Specifies a precision for the formatted value displayed in slider markers. */ - precision?: number; - /** Indicates whether or not the slider markers are visible. */ - visible?: boolean; - }; - } - /** A widget that allows end users to select a range of values on a scale. */ - export class dxRangeSelector extends viz.core.BaseWidget { - constructor(element: JQuery, options?: dxRangeSelectorOptions); - constructor(element: Element, options?: dxRangeSelectorOptions); - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(skipChartAnimation?: boolean): void; - /** Returns the currently selected range. */ - getSelectedRange(): { startValue: any; endValue: any; }; - /** Sets a specified range. */ - setSelectedRange(selectedRange: { startValue: any; endValue: any; }): void; - } -} -interface JQuery { - dxRangeSelector(options?: DevExpress.viz.rangeSelector.dxRangeSelectorOptions): JQuery; - dxRangeSelector(methodName: string, ...params: any[]): any; - dxRangeSelector(methodName: "instance"): DevExpress.viz.rangeSelector.dxRangeSelector; -} -declare module DevExpress.viz.map { - /** This section describes the fields and methods that can be used in code to manipulate the Layer object. */ - export interface MapLayer { - /** The name of the layer. */ - name: string; - /** The layer index in the layers array. */ - index: number; - /** The layer type. Can be "area", "line" or "marker". */ - type: string; - /** The type of the layer elements. */ - elementType: string; - /** Gets all layer elements. */ - getElements(): Array; - /** Deselects all layer elements. */ - clearSelection(): void; - } - /** This section describes the fields and methods that can be used in code to manipulate the Layer Element object. */ - export interface MapLayerElement { - /** The parent layer of the layer element. */ - layer: MapLayer; - /** Gets the layer element coordinates. */ - coordinates(): Object; - /** Sets the value of an attribute. */ - attribute(name: string, value: any): void; - /** Gets the value of an attribute. */ - attribute(name: string): any; - /** Gets the selection state of the layer element. */ - selected(): boolean; - /** Sets the selection state of the layer element. */ - selected(state: boolean): void; - /** Applies the layer element settings and updates element appearance. */ - applySettings(settings: any): void; - } - /** - * This section describes the fields and methods that can be used in code to manipulate the Area object. - * @deprecated Use the Layer Element instead. - */ - export interface Area { - /** - * Contains the element type. - * @deprecated Use the Layer | type instead. - */ - type: string; - /** - * Return the value of an attribute. - * @deprecated Use the Layer Element | attribute(name, value) method instead. - */ - attribute(name: string): any; - /** - * Provides information about the selection state of an area. - * @deprecated Use the Layer Element | selected() method instead. - */ - selected(): boolean; - /** - * Sets a new selection state for an area. - * @deprecated Use the Layer Element | selected(state) method instead. - */ - selected(state: boolean): void; - /** - * Applies the area settings specified as a parameter and updates the area appearance. - * @deprecated Use the Layer Element | applySettings(settings) method instead. - */ - applySettings(settings: any): void; - } - /** - * This section describes the fields and methods that can be used in code to manipulate the Markers object. - * @deprecated Use the Layer Element instead. - */ - export interface Marker { - /** - * Contains the descriptive text accompanying the map marker. - * @deprecated Get the text using the Layer Element | attribute(name) method. The name parameter value for text is set at the dataField option. - */ - text: string; - /** - * Contains the type of the element. - * @deprecated Use the Layer | type instead. - */ - type: string; - /** - * Contains the URL of an image map marker. - * @deprecated Get the image URL using the Layer Element | attribute(name) method. The name parameter value for the image URL is set at the dataField option. - */ - url: string; - /** - * Contains the value of a bubble map marker. - * @deprecated Get the bubble value using the Layer Element | attribute(name) method. The name parameter for the bubble value is set at the dataField option. - */ - value: number; - /** - * Contains the values of a pie map marker. - * @deprecated Get the pie values using the Layer Element | attribute(name) method. The name parameter for pie values is set at the dataField option. - */ - values: Array; - /** - * Returns the value of an attribute. - * @deprecated Use the Layer Element | attribute(name, value) method instead. - */ - attribute(name: string): any; - /** - * Returns the coordinates of a specific marker. - * @deprecated Use the Layer Element | coordinates() method instead. - */ - coordinates(): Array; - /** - * Provides information about the selection state of a marker. - * @deprecated Use the Layer Element | selected() method instead. - */ - selected(): boolean; - /** - * Sets a new selection state for a marker. - * @deprecated Use the Layer Element | selected(state) method instead. - */ - selected(state: boolean): void; - /** - * Applies the marker settings specified as a parameter and updates marker appearance. - * @deprecated Use the Layer Element | applySettings(settings) method instead. - */ - applySettings(settings: any): void; - } - export interface MapLayerSettings { - /** Specifies the layer name. */ - name?: string; - /** Specifies layer type. */ - type?: string; - /** Specifies the type of a marker element. Setting this option makes sense only if the layer type is "marker". */ - elementType?: string; - /** Specifies a data source for the layer. */ - dataSource?: any; - /** Specifies the line width (for layers of a line type) or width of the layer elements border in pixels. */ - borderWidth?: number; - /** Specifies a color for the border of the layer elements. */ - borderColor?: string; - /** Specifies a color for layer elements. */ - color?: string; - /** Specifies a color for the border of the layer element when it is hovered over. */ - hoveredBorderColor?: string; - /** Specifies the pixel-measured line width (for layers of a line type) or width for the border of the layer element when it is hovered over. */ - hoveredBorderWidth?: number; - /** Specifies a color for a layer element when it is hovered over. */ - hoveredColor?: string; - /** Specifies a pixel-measured line width (for layers of a line type) or width for the border of the layer element when it is selected. */ - selectedBorderWidth?: number; - /** Specifies a color for the border of the layer element when it is selected. */ - selectedBorderColor?: string; - /** Specifies a color for the layer element when it is selected. */ - selectedColor?: string; - /** Specifies the layer opacity (from 0 to 1). */ - opacity?: number; - /** Specifies the size of markers. Setting this option makes sense only if the layer type is "marker" and the elementType is "dot", "pie" or "image". */ - size?: number; - /** Specifies the pixel-measured diameter of the marker that represents the smallest value. Setting this option makes sense only if the layer type is "marker". */ - minSize?: number; - /** Specifies the pixel-measured diameter of the marker that represents the biggest value. Setting this option makes sense only if the layer type is "marker". */ - maxSize?: number; - /** Specifies whether or not to change the appearance of a layer element when it is hovered over. */ - hoverEnabled?: boolean; - /** Specifies whether single or multiple map elements can be selected on a vector map. */ - selectionMode?: string; - /** Specifies the name of the palette or a custom range of colors to be used for coloring a layer. */ - palette?: any; - /** Specifies the number of colors in a palette. */ - paletteSize?: number; - /** Allows you to paint layer elements with similar attributes in the same color. */ - colorGroups?: Array; - /** Specifies the field that provides data to be used for coloring of layer elements. */ - colorGroupingField?: string; - /** Allows you to display bubbles with similar attributes in the same size. Setting this option makes sense only if the layer type is "marker" and the elementType is "bubble". */ - sizeGroups?: Array; - /** Specifies the field that provides data to be used for sizing bubble markers. Setting this option makes sense only if the layer type is "marker" and the elementType is "bubble". */ - sizeGroupingField?: string; - /** Specifies the name of the attribute containing marker data. Setting this option makes sense only if the layer type is "marker" and the elementType is "bubble", "pie" or "image". */ - dataField?: string; - /** Specifies the function that customizes each layer element individually. */ - customize?: (eleemnts: Array) => void; - /** Specifies marker label options. */ - label?: { - /** The name of the dataSource attribute containing marker texts. */ - dataField?: string; - /** Enables marker labels. */ - enabled?: boolean; - /** Specifies font options for marker labels. */ - font?: viz.core.Font; - }; - } - export interface AreaSettings { - /** - * Specifies the width of the area border in pixels. - * @deprecated Use the layers | borderWidth option instead. - */ - borderWidth?: number; - /** - * Specifies a color for the area border. - * @deprecated Use the layers | borderColor option instead. - */ - borderColor?: string; - /** - * Specifies a color for an area. - * @deprecated Use the layers | color option instead. - */ - color?: string; - /** - * Specifies the function that customizes each area individually. - * @deprecated Use the layers | customize option instead. - */ - customize?: (areaInfo: Area) => AreaSettings; - /** - * Specifies a color for the area border when the area is hovered over. - * @deprecated Use the layers | hoveredBorderColor option instead. - */ - hoveredBorderColor?: string; - /** - * Specifies the pixel-measured width of the area border when the area is hovered over. - * @deprecated Use the layers | hoveredBorderWidth option instead. - */ - hoveredBorderWidth?: number; - /** - * Specifies a color for an area when this area is hovered over. - * @deprecated Use the layers | hoveredColor option instead. - */ - hoveredColor?: string; - /** - * Specifies whether or not to change the appearance of an area when it is hovered over. - * @deprecated Use the layers | hoverEnabled option instead. - */ - hoverEnabled?: boolean; - /** - * Configures area labels. - * @deprecated Use the layers | label option instead. - */ - label?: { - /** - * Specifies the data field that provides data for area labels. - * @deprecated Use the layers | label | dataField option instead. - */ - dataField?: string; - /** - * Enables area labels. - * @deprecated Use the layers | label | enabled option instead. - */ - enabled?: boolean; - /** - * Specifies font options for area labels. - * @deprecated Use the layers | label | font option instead. - */ - font?: viz.core.Font; - }; - /** - * Specifies the name of the palette or a custom range of colors to be used for coloring a map. - * @deprecated Use the layers | palette option instead. - */ - palette?: any; - /** - * Specifies the number of colors in a palette. - * @deprecated Use the layers | paletteSize option instead. - */ - paletteSize?: number; - /** - * Allows you to paint areas with similar attributes in the same color. - * @deprecated Use the layers | colorGroups option instead. - */ - colorGroups?: Array; - /** - * Specifies the field that provides data to be used for coloring areas. - * @deprecated Use the layers | colorGroupingField option instead. - */ - colorGroupingField?: string; - /** - * Specifies a color for the area border when the area is selected. - * @deprecated Use the layers | selectedBorderColor option instead. - */ - selectedBorderColor?: string; - /** - * Specifies a color for an area when this area is selected. - * @deprecated Use the layers | selectedColor option instead. - */ - selectedColor?: string; - /** - * Specifies the pixel-measured width of the area border when the area is selected. - * @deprecated Use the layers | selectedBorderWidth option instead. - */ - selectedBorderWidth?: number; - /** - * Specifies whether single or multiple areas can be selected on a vector map. - * @deprecated Use the layers | selectionMode option instead. - */ - selectionMode?: string; - } - export interface MarkerSettings { - /** - * Specifies a color for the marker border. - * @deprecated Use the layers | borderColor option instead. - */ - borderColor?: string; - /** - * Specifies the width of the marker border in pixels. - * @deprecated Use the layers | borderWidth option instead. - */ - borderWidth?: number; - /** - * Specifies a color for a marker of the dot or bubble type. - * @deprecated Use the layers | color option instead. - */ - color?: string; - /** - * Specifies the function that customizes each marker individually. - * @deprecated Use the layers | customize option instead. - */ - customize?: (markerInfo: Marker) => MarkerSettings; - /** - * Specifies the pixel-measured width of the marker border when the marker is hovered over. - * @deprecated Use the layers | hoveredBorderWidth option instead. - */ - hoveredBorderWidth?: number; - /** - * Specifies a color for the marker border when the marker is hovered over. - * @deprecated Use the layers | hoveredBorderColor option instead. - */ - hoveredBorderColor?: string; - /** - * Specifies a color for a marker of the dot or bubble type when this marker is hovered over. - * @deprecated Use the layers | hoveredColor option instead. - */ - hoveredColor?: string; - /** - * Specifies whether or not to change the appearance of a marker when it is hovered over. - * @deprecated Use the layers | hoverEnabled option instead. - */ - hoverEnabled?: boolean; - /** - * Specifies marker label options. - * @deprecated Use the layers | label option instead. - */ - label?: { - /** - * Enables marker labels. - * @deprecated Use the layers | label | enabled option instead. - */ - enabled?: boolean; - /** - * Specifies font options for marker labels. - * @deprecated Use the layers | label | font option instead. - */ - font?: viz.core.Font; - }; - /** - * Specifies the pixel-measured diameter of the marker that represents the biggest value. Setting this option makes sense only if you use markers of the bubble type. - * @deprecated Use the layers | maxSize option instead. - */ - maxSize?: number; - /** - * Specifies the pixel-measured diameter of the marker that represents the smallest value. Setting this option makes sense only if you use markers of the bubble type. - * @deprecated Use the layers | minSize option instead. - */ - minSize?: number; - /** - * Specifies the opacity of markers. Setting this option makes sense only if you use markers of the bubble type. - * @deprecated Use the layers | opacity option instead. - */ - opacity?: number; - /** - * Specifies the pixel-measured width of the marker border when the marker is selected. - * @deprecated Use the layers | selectedBorderWidth option instead. - */ - selectedBorderWidth?: number; - /** - * Specifies a color for the marker border when the marker is selected. - * @deprecated Use the layers | selectedBorderColor option instead. - */ - selectedBorderColor?: string; - /** - * Specifies a color for a marker of the dot or bubble type when this marker is selected. - * @deprecated Use the layers | selectedColor option instead. - */ - selectedColor?: string; - /** - * Specifies whether a single or multiple markers can be selected on a vector map. - * @deprecated Use the layers | selectionMode option instead. - */ - selectionMode?: string; - /** - * Specifies the size of markers. Setting this option makes sense for any type of marker except bubble. - * @deprecated Use the layers | size option instead. - */ - size?: number; - /** - * Specifies the type of markers to be used on the map. - * @deprecated Use the layers | elementType option instead. - */ - type?: string; - /** - * Specifies the name of a palette or a custom set of colors to be used for coloring markers of the pie type. - * @deprecated Use the layers | palette option instead. - */ - palette?: any; - /** - * Allows you to paint markers with similar attributes in the same color. - * @deprecated Use the layers | colorGroups option instead. - */ - colorGroups?: Array; - /** - * Specifies the field that provides data to be used for coloring markers. - * @deprecated Use the layers | colorGroupingField option instead. - */ - colorGroupingField?: string; - /** - * Allows you to display bubbles with similar attributes in the same size. - * @deprecated Use the layers | sizeGroups option instead. - */ - sizeGroups?: Array; - /** - * Specifies the field that provides data to be used for sizing bubble markers. - * @deprecated Use the layers | sizeGroupingField option instead. - */ - sizeGroupingField?: string; - } - export interface dxVectorMapOptions extends viz.core.BaseWidgetOptions { - /** - * An object specifying options for the map areas. - * @deprecated Use the "area" type element of the layers array. - */ - areaSettings?: AreaSettings; - /** Specifies the options for the map background. */ - background?: { - /** Specifies a color for the background border. */ - borderColor?: string; - /** Specifies a color for the background. */ - color?: string; - }; - /** Specifies options for dxVectorMap widget layers. */ - layers?: Array; - /** Specifies the map projection. */ - projection?: Object; - /** Specifies the positioning of a map in geographical coordinates. */ - bounds?: Array; - /** Specifies the options of the control bar. */ - controlBar?: { - /** Specifies a color for the outline of the control bar elements. */ - borderColor?: string; - /** Specifies a color for the inner area of the control bar elements. */ - color?: string; - /** Specifies whether or not to display the control bar. */ - enabled?: boolean; - /** Specifies the margin of the control bar in pixels. */ - margin?: number; - /** Specifies the position of the control bar. */ - horizontalAlignment?: string; - /** Specifies the position of the control bar. */ - verticalAlignment?: string; - /** Specifies the opacity of the control bar. */ - opacity?: number; - }; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** - * Specifies a data source for the map area. - * @deprecated Use the layers | dataSource option instead. - */ - mapData?: any; - /** - * Specifies a data source for the map markers. - * @deprecated Use the layers | dataSource option instead. - */ - markers?: any; - /** - * An object specifying options for the map markers. - * @deprecated Use the "marker" type element of the layers array. - */ - markerSettings?: MarkerSettings; - /** Specifies the size of the dxVectorMap widget. */ - size?: viz.core.Size; - /** Specifies a title for the vector map. */ - title?: viz.core.Title; - /** Specifies tooltip options. */ - tooltip?: viz.core.Tooltip; - /** Configures map legends. */ - legends?: Array; - /** Specifies whether or not the map should respond when a user rolls the mouse wheel. */ - wheelEnabled?: boolean; - /** Specifies whether the map should respond to touch gestures. */ - touchEnabled?: boolean; - /** Disables the zooming capability. */ - zoomingEnabled?: boolean; - /** Specifies the geographical coordinates of the center for a map. */ - center?: Array; - /** A handler for the centerChanged event. */ - onCenterChanged?: (e: { - center: Array; - component: dxVectorMap; - element: Element; - }) => void; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: dxVectorMap; - element: Element; - target: {}; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: dxVectorMap; - element: Element; - target: {}; - }) => void; - /** Specifies a number that is used to zoom a map initially. */ - zoomFactor?: number; - /** Specifies a map's maximum zoom factor. */ - maxZoomFactor?: number; - /** A handler for the zoomFactorChanged event. */ - onZoomFactorChanged?: (e: { - component: dxVectorMap; - element: Element; - zoomFactor: number; - }) => void; - /** A handler for the click event. */ - onClick?: any; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: (e: { - component: dxVectorMap; - element: Element; - target: MapLayerElement; - }) => void; - /** - * A handler for the areaClick event. - * @deprecated Use the onClick option instead. - */ - onAreaClick?: any; - /** - * A handler for the areaSelectionChanged event. - * @deprecated Use the onSelectionChanged option instead. - */ - onAreaSelectionChanged?: (e: { - target: Area; - component: dxVectorMap; - element: Element; - }) => void; - /** - * A handler for the markerClick event. - * @deprecated Use the onClick option instead. - */ - onMarkerClick?: any; - /** - * A handler for the markerSelectionChanged event. - * @deprecated Use the onSelecitonChanged option instead. - */ - onMarkerSelectionChanged?: (e: { - target: Marker; - component: dxVectorMap; - element: Element; - }) => void; - /** Disables the panning capability. */ - panningEnabled?: boolean; - } - export interface Legend extends viz.core.BaseLegend { - /** Specifies the color of item markers in the legend. The specified color applied only when the legend uses 'size' source. */ - markerColor?: string; - /** Specifies text for legend items. */ - customizeText?: (itemInfo: { start: number; end: number; index: number; color: string; size: number; }) => string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the text of a legend item. */ - customizeHint?: (itemInfo: { start: number; end: number; index: number; color: string; size: number }) => string; - /** Specifies the source of data for the legend. */ - source?: { - /** Specifies a layer to which the legend belongs. */ - layer?: string; - /** Specifies the type of the legend grouping. */ - grouping?: string; - } - } - /** A vector map widget. */ - export class dxVectorMap extends viz.core.BaseWidget { - constructor(element: JQuery, options?: dxVectorMapOptions); - constructor(element: Element, options?: dxVectorMapOptions); - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(): void; - /** Gets the current coordinates of the map center. */ - center(): Array; - /** Sets the coordinates of the map center. */ - center(centerCoordinates: Array): void; - /** - * Deselects all the selected areas on a map. The areas are displayed in their initial style after. - * @deprecated Use the layer's clearSelection() method instead. - */ - clearAreaSelection(): void; - /** - * Deselects all the selected markers on a map. The markers are displayed in their initial style after. - * @deprecated Use the layer's clearSelection() method instead. - */ - clearMarkerSelection(): void; - /** Deselects all the selected area and markers on a map at once. The areas and markers are displayed in their initial style after. */ - clearSelection(): void; - /** Converts client area coordinates into map coordinates. */ - convertCoordinates(x: number, y: number): Array; - /** Gets all map layers. */ - getLayers(): Array; - /** Gets the layer by its index. */ - getLayerByIndex(index: number): MapLayer; - /** Gets the layer by its name. */ - getLayerByName(name: string): MapLayer; - /** - * Returns an array with all the map areas. - * @deprecated Use the layer's getElements() method instead. - */ - getAreas(): Array; - /** - * Returns an array with all the map markers. - * @deprecated Use the layer's getElements() method instead. - */ - getMarkers(): Array; - /** Gets the current coordinates of the map viewport. */ - viewport(): Array; - /** Sets the coordinates of the map viewport. */ - viewport(viewportCoordinates: Array): void; - /** Gets the current value of the map zoom factor. */ - zoomFactor(): number; - /** Sets the value of the map zoom factor. */ - zoomFactor(zoomFactor: number): void; - } - export var projection: ProjectionCreator; - export interface ProjectionCreator { - /** Creates a new projection. */ - (data: { - to?: (coordinates: Array) => Array; - from?: (coordinates: Array) => Array; - aspectRatio?: number; - }): Object; - /** Gets the default or custom projection from the projection storage. */ - get(name: string): Object; - /** Adds a new projection to the internal projections storage. */ - add(name: string, projection: Object): void; - } -} -interface JQuery { - dxVectorMap(options?: DevExpress.viz.map.dxVectorMapOptions): JQuery; - dxVectorMap(methodName: string, ...params: any[]): any; - dxVectorMap(methodName: "instance"): DevExpress.viz.map.dxVectorMap; -} -declare module DevExpress.viz.sparklines { - export interface SparklineTooltip extends viz.core.Tooltip { - /** - * Specifies how a tooltip is horizontally aligned relative to the graph. - * @deprecated Tooltip alignment is no longer useful because the tooltips are aligned automatically. - */ - horizontalAlignment?: string; - /** - * Specifies how a tooltip is vertically aligned relative to the graph. - * @deprecated Tooltip alignment is no longer useful because the tooltips are aligned automatically. - */ - verticalAlignment?: string; - } - export interface BaseSparklineOptions extends viz.core.BaseWidgetOptions { - /** Specifies the blank space between the widget's extreme elements and the boundaries of the area provided for the widget in pixels. */ - margin?: viz.core.Margins; - /** Specifies the size of the widget. */ - size?: viz.core.Size; - /** Specifies tooltip options. */ - tooltip?: SparklineTooltip; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: BaseSparkline; - element: Element; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: BaseSparkline; - element: Element; - }) => void; - } - /** Overridden by descriptions for particular widgets. */ - export class BaseSparkline extends viz.core.BaseWidget { - /** Redraws a widget. */ - render(): void; - } - export interface dxBulletOptions extends BaseSparkline { - /** Specifies a color for the bullet bar. */ - color?: string; - /** Specifies an end value for the invisible scale. */ - endScaleValue?: number; - /** Specifies whether or not to show the target line. */ - showTarget?: boolean; - /** Specifies whether or not to show the line indicating zero on the invisible scale. */ - showZeroLevel?: boolean; - /** Specifies a start value for the invisible scale. */ - startScaleValue?: number; - /** Specifies the value indicated by the target line. */ - target?: number; - /** Specifies a color for both the target and zero level lines. */ - targetColor?: string; - /** Specifies the width of the target line. */ - targetWidth?: number; - /** Specifies the primary value indicated by the bullet bar. */ - value?: number; - } - /** A bullet graph widget. */ - export class dxBullet extends BaseSparkline { - constructor(element: JQuery, options?: dxBulletOptions); - constructor(element: Element, options?: dxBulletOptions); - } - export interface dxSparklineOptions extends BaseSparklineOptions { - /** Specifies the data source field that provides arguments for a sparkline. */ - argumentField?: string; - /** Sets a color for the bars indicating negative values. Available for a sparkline of the bar type only. */ - barNegativeColor?: string; - /** Sets a color for the bars indicating positive values. Available for a sparkline of the bar type only. */ - barPositiveColor?: string; - /** Specifies a data source for the sparkline. */ - dataSource?: any; - /** Sets a color for the boundary of both the first and last points on a sparkline. */ - firstLastColor?: string; - /** Specifies whether a sparkline ignores null data points or not. */ - ignoreEmptyPoints?: boolean; - /** Sets a color for a line on a sparkline. Available for the sparklines of the line- and area-like types. */ - lineColor?: string; - /** Specifies a width for a line on a sparkline. Available for the sparklines of the line- and area-like types. */ - lineWidth?: number; - /** Sets a color for the bars indicating the values that are less than the winloss threshold. Available for a sparkline of the winloss type only. */ - lossColor?: string; - /** Sets a color for the boundary of the maximum point on a sparkline. */ - maxColor?: string; - /** Sets a color for the boundary of the minimum point on a sparkline. */ - minColor?: string; - /** Sets a color for points on a sparkline. Available for the sparklines of the line- and area-like types. */ - pointColor?: string; - /** Specifies the diameter of sparkline points in pixels. Available for the sparklines of line- and area-like types. */ - pointSize?: number; - /** Specifies a symbol to use as a point marker on a sparkline. Available for the sparklines of the line- and area-like types. */ - pointSymbol?: string; - /** Specifies whether or not to indicate both the first and last values on a sparkline. */ - showFirstLast?: boolean; - /** Specifies whether or not to indicate both the minimum and maximum values on a sparkline. */ - showMinMax?: boolean; - /** Determines the type of a sparkline. */ - type?: string; - /** Specifies the data source field that provides values for a sparkline. */ - valueField?: string; - /** Sets a color for the bars indicating the values greater than a winloss threshold. Available for a sparkline of the winloss type only. */ - winColor?: string; - /** Specifies a value that serves as a threshold for the sparkline of the winloss type. */ - winlossThreshold?: number; - /** Specifies the minimum value of the sparkline value axis. */ - minValue?: number; - /** Specifies the maximum value of the sparkline's value axis. */ - maxValue?: number; - } - /** A sparkline widget. */ - export class dxSparkline extends BaseSparkline { - constructor(element: JQuery, options?: dxSparklineOptions); - constructor(element: Element, options?: dxSparklineOptions); - } -} -interface JQuery { - dxBullet(options?: DevExpress.viz.sparklines.dxBulletOptions): JQuery; - dxBullet(methodName: string, ...params: any[]): any; - dxBullet(methodName: "instance"): DevExpress.viz.sparklines.dxBullet; - dxSparkline(options?: DevExpress.viz.sparklines.dxSparklineOptions): JQuery; - dxSparkline(methodName: string, ...params: any[]): any; - dxSparkline(methodName: "instance"): DevExpress.viz.sparklines.dxSparkline; -} \ No newline at end of file diff --git a/devextreme/devextreme-15.2.12.d.ts b/devextreme/devextreme-15.2.12.d.ts deleted file mode 100644 index bdba712122..0000000000 --- a/devextreme/devextreme-15.2.12.d.ts +++ /dev/null @@ -1,7531 +0,0 @@ -// Type definitions for DevExtreme 15.2.12 -// Project: http://js.devexpress.com/ -// Definitions by: DevExpress Inc. -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -/// - -declare module DevExpress { - /** A mixin that provides a capability to fire and subscribe to events. */ - export interface EventsMixin { - /** Subscribes to a specified event. */ - on(eventName: string, eventHandler: Function): T; - /** Subscribes to the specified events. */ - on(events: { [eventName: string]: Function; }): T; - /** Detaches all event handlers from the specified event. */ - off(eventName: string): Object; - /** Detaches a particular event handler from the specified event. */ - off(eventName: string, eventHandler: Function): T; - } - /** An object that serves as a namespace for the methods required to perform validation. */ - export module validationEngine { - export interface IValidator { - validate(): ValidatorValidationResult; - reset(): void; - } - export interface ValidatorValidationResult { - isValid: boolean; - name?: string; - value: any; - brokenRule: any; - validationRules: any[]; - } - export interface ValidationGroupValidationResult { - isValid: boolean; - brokenRules: any[]; - validators: IValidator[]; - } - export interface GroupConfig extends EventsMixin { - group: any; - validators: IValidator[]; - validate(): ValidationGroupValidationResult; - reset(): void; - } - /** Provides access to the object that represents the specified validation group. */ - export function getGroupConfig(group: any): GroupConfig - /** Provides access to the object that represents the default validation group. */ - export function getGroupConfig(): GroupConfig - /** Validates rules of the validators that belong to the specified validation group. */ - export function validateGroup(group: any): ValidationGroupValidationResult; - /** Validates rules of the validators that belong to the default validation group. */ - export function validateGroup(): ValidationGroupValidationResult; - /** Resets the values and validation result of the editors that belong to the specified validation group. */ - export function resetGroup(group: any): void; - /** Resets the values and validation result of the editors that belong to the default validation group. */ - export function resetGroup(): void; - /** Validates the rules that are defined within the dxValidator objects that are registered for the specified ViewModel. */ - export function validateModel(model: Object): ValidationGroupValidationResult; - /** Registers all the dxValidator objects by which the fields of the specified ViewModel are extended. */ - export function registerModelForValidation(model: Object) : void; - } - export var hardwareBackButton: JQueryCallback; - /** Processes the hardware back button click. */ - export function processHardwareBackButton(): void; - /** Hides the last displayed overlay widget. */ - export function hideTopOverlay(): boolean; - /** Specifies whether or not the entire application/site supports right-to-left representation. */ - export var rtlEnabled: boolean; - /** Registers a new component in the DevExpress.ui namespace as a jQuery plugin, Angular directive and Knockout binding. */ - export function registerComponent(name: string, componentClass: Object): void; - /** Registers a new component in the specified namespace as a jQuery plugin, Angular directive and Knockout binding. */ - export function registerComponent(name: string, namespace: Object, componentClass: Object): void; - export function requestAnimationFrame(callback: Function): number; - export function cancelAnimationFrame(requestID: number): void; - /** Custom Knockout binding that links an HTML element with a specific action. */ - export class Action { } - /** Used to get URLs that vary in a locally running application and the application running on production. */ - export class EndpointSelector { - constructor(options: { - [key: string]: { - local?: string; - production?: string; - } - }); - /** Returns a local or a productional URL depending on how the application is currently running. */ - urlFor(key: string): string; - } - /** An object that serves as a namespace for the methods that are used to animate UI elements. */ - export module fx { - /** Defines animation options. */ - export interface AnimationOptions { - /** A function called after animation is completed. */ - complete?: (element: JQuery, config: AnimationOptions) => void; - /** A number specifying wait time before animation execution. */ - delay?: number; - /** A number specifying the time period to wait before the animation of the next stagger item starts. */ - staggerDelay?: number; - /** A number specifying the time in milliseconds spent on animation. */ - duration?: number; - /** A string specifying the type of an easing function used for animation. */ - easing?: string; - /** Specifies the initial animation state. */ - from?: any; - /** A function called before animation is started. */ - start?: (element: JQuery, config: AnimationOptions) => void; - /** Specifies a final animation state. */ - to?: any; - /** A string value specifying the animation type. */ - type?: string; - /** Specifies the animation direction for the "slideIn" and "slideOut" animation types. */ - direction?: string; - } - /** Animates the specified element. */ - export function animate(element: HTMLElement, config: AnimationOptions): Object; - /** Returns a value indicating whether the specified element is being animated. */ - export function isAnimating(element: HTMLElement): boolean; - /** Stops the animation. */ - export function stop(element: HTMLElement, jumpToEnd: boolean): void; - } - /** The manager that performs several specified animations at a time. */ - export class TransitionExecutor { - /** Deletes all the animations registered in the Transition Executor by using the enter(elements, animation) and leave(elements, animation) methods. */ - reset(): void; - /** Registers a set of elements that should be animated as "entering" using the specified animation configuration. */ - enter(elements: JQuery, animation: any): void; - /** Registers a set of elements that should be animated as "leaving" using the specified animation configuration. */ - leave(elements: JQuery, animation: any): void; - /** Starts all the animations registered using the enter(elements, animation) and leave(elements, animation) methods beforehand. */ - start(config: Object): JQueryPromise; - /** Stops all started animations. */ - stop(): void; - } - export class AnimationPresetCollection { - /** Resets all the changes made in the animation repository. */ - resetToDefaults(): void; - /** Deletes the specified animation or clears all the animation repository, if an animation name is not passed. */ - clear(name: string): void; - /** Adds the specified animation preset to the animation repository by the specified name. */ - registerPreset(name: string, config: any): void; - /** Applies the changes made in the animation repository. */ - applyChanges(): void; - /** Returns the configuration of the animation found in the animation repository by the specified name for the current device. */ - getPreset(name: string): void; - /** Registers predefined animations in the animation repository. */ - registerDefaultPresets(): void; - } - /** A repository of animations. */ - export var animationPresets: AnimationPresetCollection; - /** The device object defines the device on which the application is running. */ - export interface Device { - /** Indicates whether or not the device platform is Android. */ - android?: boolean; - /** Specifies the type of the device on which the application is running. */ - deviceType?: string; - /** Indicates whether or not the device platform is generic, which means that the application will look and behave according to a generic "light" or "dark" theme. */ - generic?: boolean; - /** Indicates whether or not the device platform is iOS. */ - ios?: boolean; - /** Indicates whether or not the device type is 'phone'. */ - phone?: boolean; - /** Specifies the platform of the device on which the application is running. */ - platform?: string; - /** Indicates whether or not the device type is 'tablet'. */ - tablet?: boolean; - /** Specifies an array with the major and minor versions of the device platform. */ - version?: Array; - /** Indicates whether or not the device platform is Windows. */ - win?: boolean; - /** Specifies a performance grade of the current device. */ - grade?: string; - } - export class Devices implements EventsMixin { - constructor(options: { window: Window }); - /** Overrides actual device information to force the application to operate as if it was running on the specified device. */ - current(deviceName: any): void; - /** Returns information about the current device. */ - current(): Device; - orientationChanged: JQueryCallback; - /** Returns the current device orientation. */ - orientation(): string; - /** Returns real information about the current device regardless of the value passed to the devices.current(deviceName) method. */ - real(): Device; - on(eventName: "orientationChanged", eventHandler: (e: { orientation: string }) => void): Devices; - on(eventName: string, eventHandler: Function): Devices; - on(events: { [eventName: string]: Function; }): Devices; - off(eventName: "orientationChanged"): Devices; - off(eventName: string): Devices; - off(eventName: "orientationChanged", eventHandler: (e: { orientation: string }) => void): Devices; - off(eventName: string, eventHandler: Function): Devices; - } - /** An object that serves as a namespace for the methods and events specifying information on the current device. */ - export var devices: Devices; - /** The position object specifies the widget positioning options. */ - export interface PositionOptions { - /** The target element position that the widget is positioned against. */ - at?: any; - /** The element within which the widget is positioned. */ - boundary?: Object; - /** Specifies the horizontal and vertical offset from the window's boundaries. */ - boundaryOffset?: any; - /** Specifies how to move the widget if it overflows the screen. */ - collision?: any; - /** The position of the widget to align against the target element. */ - my?: any; - /** The target element that the widget is positioned against. */ - of?: Object; - /** Specifies horizontal and vertical offset in pixels. */ - offset?: any; - } - export interface ComponentOptions { - /** A handler for the initialized event. */ - onInitialized?: Function; - /** A handler for the optionChanged event. */ - onOptionChanged?: Function; - /** A handler for the disposing event. */ - onDisposing?: Function; - } - /** A base class for all components and widgets. */ - export class Component { - constructor(options?: ComponentOptions) - /** Prevents the component from refreshing until the endUpdate method is called. */ - beginUpdate(): void; - /** Enables the component to refresh after the beginUpdate method call. */ - endUpdate(): void; - /** Returns an instance of this component class. */ - instance(): Component; - /** Returns the configuration options of this component. */ - option(): { - [optionKey: string]: any; - }; - /** Sets one or more options of this component. */ - option(options: { - [optionKey: string]: any; - }): void; - /** Gets the value of the specified configuration option of this component. */ - option(optionName: string): any; - /** Sets a value to the specified configuration option of this component. */ - option(optionName: string, optionValue: any): void; - } - export interface DOMComponentOptions extends ComponentOptions { - /** Specifies whether or not the current component supports a right-to-left representation. */ - rtlEnabled?: boolean; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies the width of the widget. */ - width?: any; - /** A bag for holding any options that require two-way binding (Angular approach specific) */ - bindingOptions?: { [key: string]: any; }; - } - /** A base class for all components. */ - export class DOMComponent extends Component { - constructor(element: JQuery, options?: DOMComponentOptions); - constructor(element: HTMLElement, options?: DOMComponentOptions); - /** Returns the root HTML element of the widget. */ - element(): JQuery; - /** Specifies the device-dependent default configuration options for this component. */ - static defaultOptions(rule: { - device?: any; - options?: any; - }): void; - } - export module data { - export interface ODataError extends Error { - httpStatus?: number; - errorDetails?: any; - } - export interface StoreOptions { - /** A handler for the modified event. */ - onModified?: () => void; - /** A handler for the modifying event. */ - onModifying?: () => void; - /** A handler for the removed event. */ - onRemoved?: (key: any) => void; - /** A handler for the removing event. */ - onRemoving?: (key: any) => void; - /** A handler for the updated event. */ - onUpdated?: (key: any, values: Object) => void; - /** A handler for the updating event. */ - onUpdating?: (key: any, values: Object) => void; - /** A handler for the loaded event. */ - onLoaded?: (result: Array) => void; - /** A handler for the loading event. */ - onLoading?: (loadOptions: LoadOptions) => void; - /** A handler for the inserted event. */ - onInserted?: (values: Object, key: any) => void; - /** A handler for the inserting event. */ - onInserting?: (values: Object) => void; - /** Specifies the function called when the Store causes an error. */ - errorHandler?: (e: Error) => void; - /** Specifies the key properties within the data associated with the Store. */ - key?: any; - } - export interface LoadOptions { - filter?: Object; - sort?: Object; - select?: Object; - expand?: Object; - group?: Object; - skip?: number; - take?: number; - userData?: Object; - requireTotalCount?: boolean; - } - /** The base class for all Stores. */ - export class Store implements EventsMixin { - constructor(options?: StoreOptions); - /** Returns the data item specified by the key. */ - byKey(key: any): JQueryPromise; - /** Adds an item to the data associated with this Store. */ - insert(values: Object): JQueryPromise; - /** Returns the key expression specified via the key configuration option. */ - key(): any; - /** Returns the key of the Store item that matches the specified object. */ - keyOf(obj: Object): any; - /** Starts loading data. */ - load(obj?: LoadOptions): JQueryPromise; - /** Removes the data item specified by the key. */ - remove(key: any): JQueryPromise; - /** Obtains the total count of items that will be returned by the load() function. */ - totalCount(options?: { - filter?: Object; - group?: Object; - }): JQueryPromise; - /** Updates the data item specified by the key. */ - update(key: any, values: Object): JQueryPromise; - on(eventName: "removing", eventHandler: (key: any) => void): Store; - on(eventName: "removed", eventHandler: (key: any) => void): Store; - on(eventName: "updating", eventHandler: (key: any, values: Object) => void): Store; - on(eventName: "updated", eventHandler: (key: any, values: Object) => void): Store; - on(eventName: "inserting", eventHandler: (values: Object) => void): Store; - on(eventName: "inserted", eventHandler: (values: Object, key: any) => void): Store; - on(eventName: "modifying", eventHandler: () => void): Store; - on(eventName: "modified", eventHandler: () => void): Store; - on(eventName: "loading", eventHandler: (loadOptions: LoadOptions) => void): Store; - on(eventName: "loaded", eventHandler: (result: Array) => void): Store; - on(eventName: string, eventHandler: Function): Store; - on(events: { [eventName: string]: Function; }): Store; - off(eventName: "removing"): Store; - off(eventName: "removed"): Store; - off(eventName: "updating"): Store; - off(eventName: "updated"): Store; - off(eventName: "inserting"): Store; - off(eventName: "inserted"): Store; - off(eventName: "modifying"): Store; - off(eventName: "modified"): Store; - off(eventName: "loading"): Store; - off(eventName: "loaded"): Store; - off(eventName: string): Store; - off(eventName: "removing", eventHandler: (key: any) => void): Store; - off(eventName: "removed", eventHandler: (key: any) => void): Store; - off(eventName: "updating", eventHandler: (key: any, values: Object) => void): Store; - off(eventName: "updated", eventHandler: (key: any, values: Object) => void): Store; - off(eventName: "inserting", eventHandler: (values: Object) => void): Store; - off(eventName: "inserted", eventHandler: (values: Object, key: any) => void): Store; - off(eventName: "modifying", eventHandler: () => void): Store; - off(eventName: "modified", eventHandler: () => void): Store; - off(eventName: "loading", eventHandler: (loadOptions: LoadOptions) => void): Store; - off(eventName: "loaded", eventHandler: (result: Array) => void): Store; - off(eventName: string, eventHandler: Function): Store; - } - export interface ArrayStoreOptions extends StoreOptions { - /** Specifies the array associated with this Store. */ - data?: Array; - } - /** A Store accessing an in-memory array. */ - export class ArrayStore extends Store { - constructor(options?: ArrayStoreOptions); - /** Clears all data associated with the current ArrayStore. */ - clear(): void; - /** Creates the Query object for the underlying array. */ - createQuery(): Query; - } - interface Promise { - then(doneFn?: Function, failFn?: Function, progressFn?: Function): Promise; - } - export interface CustomStoreOptions extends StoreOptions { - /** Specifies whether or not the store combines the search expression with the filter expression. */ - useDefaultSearch?: boolean; - /** The user implementation of the byKey(key, extraOptions) method. */ - byKey?: (key: any) => Promise; - /** The user implementation of the insert(values) method. */ - insert?: (values: Object) => Promise; - /** The user implementation of the load(options) method. */ - load?: (options?: LoadOptions) => Promise; - /** The user implementation of the remove(key) method. */ - remove?: (key: any) => Promise; - /** The user implementation of the totalCount(options) method. */ - totalCount?: (options?: { - filter?: Object; - group?: Object; - }) => Promise; - /** The user implementation of the update(key, values) method. */ - update?: (key: any, values: Object) => Promise; - } - /** A Store object that enables you to implement your own data access logic. */ - export class CustomStore extends Store { - constructor(options: CustomStoreOptions); - } - export interface DataSourceOptions { - /** Specifies data filtering conditions. */ - filter?: Object; - /** Specifies data grouping conditions. */ - group?: Object; - /** The item mapping function. */ - map?: (record: any) => any; - /** Specifies the maximum number of items the page can contain. */ - pageSize?: number; - /** Specifies whether a DataSource loads data by pages, or all items at once. */ - paginate?: boolean; - /** The data post processing function. */ - postProcess?: (data: any[]) => any[]; - /** Specifies a value by which the required items are searched. */ - searchExpr?: Object; - /** Specifies the comparison operation used to search for the required items. */ - searchOperation?: string; - /** Specifies the value to which the search expression is compared. */ - searchValue?: Object; - /** Specifies the initial select option value. */ - select?: Object; - /** An array of the strings that represent the names of the navigation properties to be loaded simultaneously with the OData store's entity. */ - expand?: Object; - /** The bag of custom parameters passed to the query executed when the DataSource load operation is invoked. */ - customQueryParams?: Object; - /** Specifies whether or not the DataSource instance requests the total count of items available in the storage. */ - requireTotalCount?: boolean; - /** Specifies the initial sort option value. */ - sort?: Object; - /** Specifies the underlying Store instance used to access data. */ - store?: any; - /** A handler for the changed event. */ - onChanged?: () => void; - /** A handler for the loadingChanged event. */ - onLoadingChanged?: (isLoading: boolean) => void; - /** A handler for the loadError event. */ - onLoadError?: (e?: Error) => void; - } - export interface OperationPromise extends JQueryPromise { - operationId: number; - } - /** An object that provides access to a data web service or local data storage for collection container widgets. */ - export class DataSource implements EventsMixin { - constructor(url: string); - constructor(data: Array); - constructor(options: CustomStoreOptions); - constructor(options: DataSourceOptions); - /** Disposes all resources associated with this DataSource. */ - dispose(): void; - /** Returns the current filter option value. */ - filter(): Object; - /** Sets the filter option value. */ - filter(filterExpr: Object): void; - /** Returns the current group option value. */ - group(): Object; - /** Sets the group option value. */ - group(groupExpr: Object): void; - /** Indicates whether or not the current page contains fewer items than the number of items specified by the pageSize configuration option. */ - isLastPage(): boolean; - /** Indicates whether or not at least one load() method execution has successfully finished. */ - isLoaded(): boolean; - /** Indicates whether or not the DataSource is currently being loaded. */ - isLoading(): boolean; - /** Returns the array of items currently operated by the DataSource. */ - items(): Array; - /** Returns the key expression. */ - key(): any; - /** Starts loading data. */ - load(): OperationPromise>; - /** Clears currently loaded DataSource items and calls the load() method. */ - reload(): OperationPromise>; - /** Returns an object that would be passed to the load() method of the underlying Store according to the current data shaping option values of the current DataSource instance. */ - loadOptions(): Object; - /** Returns the current pageSize option value. */ - pageSize(): number; - /** Sets the pageSize option value. */ - pageSize(value: number): void; - /** Specifies the index of the currently loaded page. */ - pageIndex(): number; - /** Specifies the index of the page to be loaded during the next load() method execution. */ - pageIndex(newIndex: number): void; - /** Returns the current paginate option value. */ - paginate(): boolean; - /** Sets the paginate option value. */ - paginate(value: boolean): void; - /** Returns the searchExpr option value. */ - searchExpr(): Object; - /** Sets the searchExpr option value. */ - searchExpr(...expr: Object[]): void; - /** Returns the currently specified search operation. */ - searchOperation(): string; - /** Sets the current search operation. */ - searchOperation(op: string): void; - /** Returns the searchValue option value. */ - searchValue(): Object; - /** Sets the searchValue option value. */ - searchValue(value: Object): void; - /** Returns the current select option value. */ - select(): Object; - /** Sets the select option value. */ - select(expr: Object): void; - /** Returns the current requireTotalCount option value. */ - requireTotalCount(): boolean; - /** Sets the requireTotalCount option value. */ - requireTotalCount(value: boolean): void; - /** Returns the current sort option value. */ - sort(): Object; - /** Sets the sort option value. */ - sort(sortExpr: Object): void; - /** Returns the underlying Store instance. */ - store(): Store; - /** Returns the number of data items available in an underlying Store after the last load() operation without paging. */ - totalCount(): number; - /** Cancels the load operation associated with the specified identifier. */ - cancel(operationId: number): boolean; - on(eventName: "loadingChanged", eventHandler: (isLoading: boolean) => void): DataSource; - on(eventName: "loadError", eventHandler: (e?: Error) => void): DataSource; - on(eventName: "changed", eventHandler: () => void): DataSource; - on(eventName: string, eventHandler: Function): DataSource; - on(events: { [eventName: string]: Function; }): DataSource; - off(eventName: "loadingChanged"): DataSource; - off(eventName: "loadError"): DataSource; - off(eventName: "changed"): DataSource; - off(eventName: string): DataSource; - off(eventName: "loadingChanged", eventHandler: (isLoading: boolean) => void): DataSource; - off(eventName: "loadError", eventHandler: (e?: Error) => void): DataSource; - off(eventName: "changed", eventHandler: () => void): DataSource; - off(eventName: string, eventHandler: Function): DataSource; - } - /** An object used to work with primitive data types not supported by JavaScript when accessing an OData web service. */ - export class EdmLiteral { - /** Creates an EdmLiteral instance and assigns the specified value to it. */ - constructor(value: string); - /** Returns a string representation of the value associated with this EdmLiteral object. */ - valueOf(): string; - } - /** An object used to generate and hold the GUID. */ - export class Guid { - /** Creates a new Guid instance that holds the specified GUID. */ - constructor(value: string); - /** Creates a new Guid instance holding the generated GUID. */ - constructor(); - /** Returns a string representation of the Guid instance. */ - toString(): string; - /** Returns a string representation of the Guid instance. */ - valueOf(): string; - } - export interface LocalStoreOptions extends ArrayStoreOptions { - /** Specifies the time (in miliseconds) after the change operation, before the data is flushed. */ - flushInterval?: number; - /** Specifies whether the data is flushed immediatelly after each change operation, or after the delay specified via the flushInterval option. */ - immediate?: boolean; - /** The unique identifier used to distinguish the data within the HTML5 Web Storage. */ - name?: string; - } - /** A Store providing access to the HTML5 Web Storage. */ - export class LocalStore extends ArrayStore { - constructor(options?: LocalStoreOptions); - /** Removes all data associated with this Store. */ - clear(): void; - } - export interface ODataContextOptions extends ODataStoreOptions { - /** Specifies the list of entities to be accessed via the ODataContext. */ - entities?: Object; - /** Specifies the function called if the ODataContext causes an error. */ - errorHandler?: (e: Error) => void; - } - /** Provides access to the entire OData service. */ - export class ODataContext { - constructor(options?: ODataContextOptions); - /** Initiates the specified WebGet service operation that returns a value. For the information on service operations, refer to the OData documentation. */ - get(operationName: string, params: Object): JQueryPromise; - /** Initiates the specified WebGet service operation that returns nothing. For the information on service operations, refer to the OData documentation. */ - invoke(operationName: string, params: Object, httpMethod: Object): JQueryPromise; - /** Return a special proxy object to describe the entity link. */ - objectLink(entityAlias: string, key: any): Object; - } - export interface ODataStoreOptions extends StoreOptions { - /** A function used to customize a web request before it is sent. */ - beforeSend?: (request: { - url: string; - async: boolean; - method: string; - timeout: number; - params: Object; - payload: Object; - headers: Object; - }) => void; - /** Specifies whether the ODataStore uses the JSONP approach to access non-CORS-compatible remote services. */ - jsonp?: boolean; - /** Specifies the type of the ODataStore key property. The following key types are supported out of the box: String, Int32, Int64, and Guid. */ - keyType?: any; - /** Specifies whether or not dates found in the response are deserialized. */ - deserializeDates?: boolean; - /** Specifies the URL of the data service being accessed via the current ODataContext. */ - url?: string; - /** Specifies the version of the OData protocol used to interact with the data service. */ - version?: number; - /** Specifies the value of the withCredentials field of the underlying jqXHR object. */ - withCredentials?: boolean; - } - /** A Store providing access to a separate OData web service entity. */ - export class ODataStore extends Store { - constructor(options?: ODataStoreOptions); - /** Creates the Query object for the OData endpoint. */ - createQuery(loadOptions: Object): Object; - /** Returns the data item specified by the key. */ - byKey(key: any, extraOptions?: { expand?: Object }): JQueryPromise; - } - /** An universal chainable data query interface object. */ - export interface Query { - /** Calculates a custom summary for the items in the current Query. */ - aggregate(step: (accumulator: any, value: any) => any): JQueryPromise; - /** Calculates a custom summary for the items in the current Query. */ - aggregate(seed: any, step: (accumulator: any, value: any) => any, finalize: (result: any) => any): JQueryPromise; - /** Calculates the average item value for the current Query. */ - avg(getter: Object): JQueryPromise; - /** Finds the item with the maximum getter value. */ - max(getter: Object): JQueryPromise; - /** Finds the item with the maximum value in the Query. */ - max(): JQueryPromise; - /** Finds the item with the minimum value in the Query. */ - min(): JQueryPromise; - /** Finds the item with the minimum getter value. */ - min(getter: Object): JQueryPromise; - /** Calculates the average item value for the current Query, if each Query item has a numeric type. */ - avg(): JQueryPromise; - /** Returns the total count of items in the current Query. */ - count(): JQueryPromise; - /** Executes the Query. */ - enumerate(): JQueryPromise; - /** Filters the current Query data. */ - filter(criteria: Array): Query; - /** Filters the current Query data. */ - filter(predicate: (item: any) => boolean): Query; - /** Groups the current Query data. */ - groupBy(getter: Object): Query; - /** Applies the specified transformation to each item. */ - select(getter: Object): Query; - /** Limits the data item count. */ - slice(skip: number, take?: number): Query; - /** Sorts current Query data. */ - sortBy(getter: Object, desc: boolean): Query; - /** Sorts current Query data. */ - sortBy(getter: Object): Query; - /** Calculates the sum of item getter values in the current Query. */ - sum(getter: Object): JQueryPromise; - /** Calculates the sum of item values in the current Query. */ - sum(): JQueryPromise; - /** Adds one more sorting condition to the current Query. */ - thenBy(getter: Object): Query; - /** Adds one more sorting condition to the current Query. */ - thenBy(getter: Object, desc: boolean): Query; - /** Returns the array of current Query items. */ - toArray(): Array; - } - /** The global data layer error handler. */ - export var errorHandler: (e: Error) => void; - /** Encodes the specified string or array of bytes to base64 encoding. */ - export function base64_encode(input: any): string; - /** Creates a Query instance. */ - export function query(array: Array): Query; - /** Creates a Query instance for accessing the remote service specified by a URL. */ - export function query(url: string, queryOptions: Object): Query; - /** This section describes the utility objects provided by the DevExtreme data layer. */ - export var utils: { - /** Compiles a getter function from the getter expression. */ - compileGetter(expr: any): Function; - /** Compiles a setter function from the setter expression. */ - compileSetter(expr: any): Function; - odata: { - /** Holds key value converters for OData. */ - keyConverters: { - String(value: any): string; - Int32(value: any): number; - Int64(value: any): EdmLiteral; - Guid(value: any): Guid; - Boolean(value: any): boolean; - Single(value: any): EdmLiteral; - Decimal(value: any): EdmLiteral; - }; - } - } - } - /** An object that serves as a namespace for DevExtreme UI widgets as well as for methods implementing UI logic in DevExtreme sites/applications. */ - export module ui { - export interface WidgetOptions extends DOMComponentOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A Boolean value specifying whether or not the widget can respond to user interaction. */ - disabled?: boolean; - /** A Boolean value specifying whether or not the widget changes its state when being hovered by an end user. */ - hoverStateEnabled?: boolean; - /** Specifies whether or not the widget can be focused. */ - focusStateEnabled?: boolean; - /** Specifies a shortcut key that sets focus on the widget element. */ - accessKey?: string; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - /** Specifies the widget tab index. */ - tabIndex?: number; - /** Specifies the text of the hint displayed for the widget. */ - hint?: string; - } - /** The base class for widgets. */ - export class Widget extends DOMComponent { - constructor(options?: WidgetOptions); - /** Redraws the widget. */ - repaint(): void; - /** Sets focus on the widget. */ - focus(): void; - /** Registers a handler when a specified key is pressed. */ - registerKeyHandler(key: string, handler: Function): void; - } - export interface CollectionWidgetOptions extends WidgetOptions { - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** The time period in milliseconds before the onItemHold event is raised. */ - itemHoldTimeout?: number; - /** An array of items displayed by the widget. */ - items?: Array; - /** The template to be used for rendering items. */ - itemTemplate?: any; - loopItemFocus?: boolean; - /** The text or HTML markup displayed by the widget if the item collection is empty. */ - noDataText?: string; - onContentReady?: any; - /** A handler for the itemClick event. */ - onItemClick?: any; - /** A handler for the itemContextMenu event. */ - onItemContextMenu?: Function; - /** A handler for the itemHold event. */ - onItemHold?: Function; - /** A handler for the itemRendered event. */ - onItemRendered?: Function; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: Function; - /** The index of the currently selected widget item. */ - selectedIndex?: number; - /** The selected item object. */ - selectedItem?: Object; - /** An array of currently selected item objects. */ - selectedItems?: Array; - /** A handler for the itemDeleting event. */ - onItemDeleting?: Function; - /** A handler for the itemDeleted event. */ - onItemDeleted?: Function; - /** A handler for the itemReordered event. */ - onItemReordered?: Function; - } - /** The base class for widgets containing an item collection. */ - export class CollectionWidget extends Widget { - constructor(element: JQuery, options?: CollectionWidgetOptions); - constructor(element: HTMLElement, options?: CollectionWidgetOptions); - selectItem(itemElement: any): void; - unselectItem(itemElement: any): void; - deleteItem(itemElement: any): JQueryPromise; - isItemSelected(itemElement: any): boolean; - reorderItem(itemElement: any, toItemElement: any): JQueryPromise; - } - export interface DataExpressionMixinOptions { - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** Specifies the name of the data source item field whose value is displayed by the widget. */ - displayExpr?: any; - /** Specifies the name of a data source item field whose value is held in the value configuration option. */ - valueExpr?: any; - /** An array of items displayed by the widget. */ - items?: Array; - /** The template to be used for rendering items. */ - itemTemplate?: any; - /** The currently selected value in the widget. */ - value?: Object; - } - export interface EditorOptions extends WidgetOptions { - /** The currently specified value. */ - value?: Object; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - /** A Boolean value specifying whether or not the widget is read-only. */ - readOnly?: boolean; - /** Holds the object that defines the error that occurred during validation. */ - validationError?: Object; - /** Specifies whether the editor's value is valid. */ - isValid?: boolean; - /** Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed. */ - validationMessageMode?: string; - } - /** A base class for editors. */ - export class Editor extends Widget { - /** Resets the editor's value to undefined. */ - reset(): void; - } - /** An object that serves as a namespace for methods displaying a message in an application/site. */ - export var dialog: { - /** Creates an alert dialog message containing a single "OK" button. */ - alert(message: string, title: string): JQueryPromise; - /** Creates a confirm dialog that contains "Yes" and "No" buttons. */ - confirm(message: string, title: string): JQueryPromise; - /** Creates a custom dialog using the options specified by the passed configuration object. */ - custom(options: { title?: string; message?: string; buttons?: Array; }): { - show(): JQueryPromise; - hide(): void; - hide(value: any): void; - }; - }; - /** Creates a toast message. */ - export function notify(message: any, type: string, displayTime: number): void; - /** Creates a toast message. */ - export function notify(options: Object): void; - /** An object that serves as a namespace for the methods that work with DevExtreme CSS Themes. */ - export var themes: { - /** Returns the name of the currently applied theme. */ - current(): string; - /** Changes the current theme to the specified one. */ - current(themeName: string): void; - }; - /** Sets a specified template engine. */ - export function setTemplateEngine(name: string): void; - /** Sets a custom template engine defined via custom compile and render functions. */ - export function setTemplateEngine(options: Object): void; - } - /** An object that serves as a namespace for utility methods that can be helpful when working with the DevExtreme framework and UI widgets. */ - export var utils: { - /** Sets parameters for the viewport meta tag. */ - initMobileViewport(options: { allowZoom?: boolean; allowPan?: boolean; allowSelection?: boolean }): void; - /** Requests that the browser call a specified function to update animation before the next repaint. */ - requestAnimationFrame(callback: Function): number; - /** Cancels an animation frame request scheduled with the requestAnimationFrame method. */ - cancelAnimationFrame(requestID: number): void; - }; - /** An object that serves as a namespace for DevExtreme Data Visualization Widgets. */ - export module viz { - /** Applies a theme for the entire page with several DevExtreme visualization widgets. */ - export function currentTheme(theme: string): void; - /** Applies a new theme (with the color scheme defined separately) for the entire page with several DevExtreme visualization widgets. */ - export function currentTheme(platform: string, colorScheme: string): void; - /** Registers a new theme based on the existing one. */ - export function registerTheme(customTheme: Object, baseTheme: string): void; - /** Applies a predefined or registered custom palette to all visualization widgets at once. */ - export function currentPalette(paletteName: string): void; - /** Obtains the color sets of a predefined or registered palette. */ - export function getPalette(paletteName: string): Object; - /** Registers a new palette. */ - export function registerPalette(paletteName: string, palette: Object): void; - } -} -declare module DevExpress.ui { - export interface dxValidatorOptions extends DOMComponentOptions { - /** An array of validation rules to be checked for the editor with which the dxValidator object is associated. */ - validationRules?: Array; - /** Specifies the editor name to be used in the validation default messages. */ - name?: string; - /** An object that specifies what and when to validate and how to apply the validation result. */ - adapter?: Object; - /** Specifies the validation group the editor will be related to. */ - validationGroup?: string; - /** A handler for the validated event. */ - onValidated?: (params: validationEngine.ValidatorValidationResult) => void; - } - /** A widget that is used to validate the associated DevExtreme editors against the defined validation rules. */ - export class dxValidator extends DOMComponent implements validationEngine.IValidator { - constructor(element: JQuery, options?: dxValidatorOptions); - constructor(element: Element, options?: dxValidatorOptions); - /** Validates the value of the editor that is controlled by the current dxValidator object against the list of the specified validation rules. */ - validate(): validationEngine.ValidatorValidationResult; - /** Resets the value and validation result of the editor associated with the current dxValidator object. */ - reset(): void; - } - /** The widget that is used in the Knockout and Angular approaches to combine the editors to be validated. */ - export class dxValidationGroup extends DOMComponent { - constructor(element: JQuery); - constructor(element: Element); - /** Validates rules of the validators that belong to the current validation group. */ - validate(): validationEngine.ValidationGroupValidationResult; - /** Resets the value and validation result of the editors that are included to the current validation group. */ - reset(): void; - } - export interface dxValidationSummaryOptions extends CollectionWidgetOptions { - /** Specifies the validation group for which summary should be generated. */ - validationGroup?: string; - } - /** A widget for displaying the result of checking validation rules for editors. */ - export class dxValidationSummary extends CollectionWidget { - constructor(element: JQuery, options?: dxValidationSummaryOptions); - constructor(element: Element, options?: dxValidationSummaryOptions); - } - export interface dxResizableOptions extends DOMComponentOptions { - /** Specifies which borders of the widget element are used as a handle. */ - handles?: string; - /** Specifies the lower width boundary for resizing. */ - minWidth?: number; - /** Specifies the upper width boundary for resizing. */ - maxWidth?: number; - /** Specifies the lower height boundary for resizing. */ - minHeight?: number; - /** Specifies the upper height boundary for resizing. */ - maxHeight?: number; - /** A handler for the resizeStart event. */ - onResizeStart?: Function; - /** A handler for the resize event. */ - onResize?: Function; - /** A handler for the resizeEnd event. */ - onResizeEnd?: Function; - } - /** A widget that displays required content in a resizable element. */ - export class dxResizable extends DOMComponent { - constructor(element: JQuery, options?: dxResizableOptions); - constructor(element: Element, options?: dxResizableOptions); - } - export interface dxTooltipOptions extends dxPopoverOptions { - } - /** A tooltip widget. */ - export class dxTooltip extends dxPopover { - constructor(element: JQuery, options?: dxTooltipOptions); - constructor(element: Element, options?: dxTooltipOptions); - } - export interface dxDropDownListOptions extends dxDropDownEditorOptions, DataExpressionMixinOptions { - /** Returns the value currently displayed by the widget. */ - displayValue?: string; - /** The minimum number of characters that must be entered into the text box to begin a search. */ - minSearchLength?: number; - /** Specifies whether or not the widget displays unfiltered values until a user types a number of characters exceeding the minSearchLength option value. */ - showDataBeforeSearch?: boolean; - /** Specifies the name of a data source item field or an expression whose value is compared to the search criterion. */ - searchExpr?: any; - /** Specifies the binary operation used to filter data. */ - searchMode?: string; - /** Specifies the time delay, in milliseconds, after the last character has been typed in, before a search is executed. */ - searchTimeout?: number; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - /** Specifies DOM event names that update a widget's value. */ - valueChangeEvent?: string; - /** Specifies whether or not the widget supports searching. */ - searchEnabled?: boolean; - /** - * Specifies whether or not the widget displays items by pages. - * @deprecated Use the DataSource paging opportunities instead. - */ - pagingEnabled?: boolean; - /** The text or HTML markup displayed by the widget if the item collection is empty. */ - noDataText?: string; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: Function; - /** A handler for the itemClick event. */ - onItemClick?: Function; - onContentReady?: Function; - } - /** A base class for drop-down list widgets. */ - export class dxDropDownList extends dxDropDownEditor { - constructor(element: JQuery, options?: dxDropDownListOptions); - constructor(element: Element, options?: dxDropDownListOptions); - } - export interface dxToolbarOptions extends CollectionWidgetOptions { - /** The template used to render menu items. */ - menuItemTemplate?: any; - /** Informs the widget about its location in a view HTML markup. */ - renderAs?: string; - } - /** A toolbar widget. */ - export class dxToolbar extends CollectionWidget { - constructor(element: JQuery, options?: dxToolbarOptions); - constructor(element: Element, options?: dxToolbarOptions); - } - export interface dxToastOptions extends dxOverlayOptions { - animation?: { - /** An object that defines the animation options used when the widget is being shown. */ - show?: fx.AnimationOptions; - /** An object that defines the animation options used when the widget is being hidden. */ - hide?: fx.AnimationOptions; - }; - /** The time span in milliseconds during which the dxToast widget is visible. */ - displayTime?: number; - height?: any; - /** The dxToast message text. */ - message?: string; - position?: PositionOptions; - shading?: boolean; - /** Specifies the dxToast widget type. */ - type?: string; - width?: any; - closeOnBackButton?: boolean; - /** A Boolean value specifying whether or not the toast is closed if a user swipes it out of the screen boundaries. */ - closeOnSwipe?: boolean; - /** A Boolean value specifying whether or not the toast is closed if a user clicks it. */ - closeOnClick?: boolean; - } - /** The toast message widget. */ - export class dxToast extends dxOverlay { - constructor(element: JQuery, options?: dxToastOptions); - constructor(element: Element, options?: dxToastOptions); - } - export interface dxTextEditorOptions extends EditorOptions { - /** A handler for the change event. */ - onChange?: Function; - /** A handler for the copy event. */ - onCopy?: Function; - /** A handler for the cut event. */ - onCut?: Function; - /** A handler for the enterKey event. */ - onEnterKey?: Function; - /** A handler for the focusIn event. */ - onFocusIn?: Function; - /** A handler for the focusOut event. */ - onFocusOut?: Function; - /** A handler for the input event. */ - onInput?: Function; - /** A handler for the keyDown event. */ - onKeyDown?: Function; - /** A handler for the keyPress event. */ - onKeyPress?: Function; - /** A handler for the keyUp event. */ - onKeyUp?: Function; - /** A handler for the paste event. */ - onPaste?: Function; - /** The text displayed by the widget when the widget value is empty. */ - placeholder?: string; - /** Specifies whether to display the Clear button in the widget. */ - showClearButton?: boolean; - /** Specifies the current value displayed by the widget. */ - value?: any; - /** Specifies DOM event names that update a widget's value. */ - valueChangeEvent?: string; - /** Specifies whether or not the widget checks the inner text for spelling mistakes. */ - spellcheck?: boolean; - /** Specifies HTML attributes applied to the inner input element of the widget. */ - attr?: Object; - /** The read-only option that holds the text displayed by the widget input element. */ - text?: string; - focusStateEnabled?: boolean; - hoverStateEnabled?: boolean; - /** The editor mask that specifies the format of the entered string. */ - mask?: string; - /** Specifies a mask placeholder character. */ - maskChar?: string; - /** Specifies custom mask rules. */ - maskRules?: Object; - /** A message displayed when the entered text does not match the specified pattern. */ - maskInvalidMessage?: string; - /** Specifies whether the value option holds only characters entered by a user or prompt characters as well. */ - useMaskedValue?: boolean; - } - /** A base class for text editing widgets. */ - export class dxTextEditor extends Editor { - constructor(element: JQuery, options?: dxTextEditorOptions); - constructor(element: Element, options?: dxTextEditorOptions); - /** Removes focus from the input element. */ - blur(): void; - /** Sets focus to the input element representing the widget. */ - focus(): void; - } - export interface dxTextBoxOptions extends dxTextEditorOptions { - /** Specifies the maximum number of characters you can enter into the textbox. */ - maxLength?: any; - /** The "mode" attribute value of the actual HTML input element representing the text box. */ - mode?: string; - } - /** A single-line text box widget. */ - export class dxTextBox extends dxTextEditor { - constructor(element: JQuery, options?: dxTextBoxOptions); - constructor(element: Element, options?: dxTextBoxOptions); - } - export interface dxTextAreaOptions extends dxTextBoxOptions { - /** Specifies whether or not the widget checks the inner text for spelling mistakes. */ - spellcheck?: boolean; - } - /** A widget used to display and edit multi-line text. */ - export class dxTextArea extends dxTextBox { - constructor(element: JQuery, options?: dxTextAreaOptions); - constructor(element: Element, options?: dxTextAreaOptions); - } - export interface dxTabsOptions extends CollectionWidgetOptions { - /** Specifies whether the widget enables an end-user to select only a single item or multiple items. */ - selectionMode?: string; - /** Specifies whether or not an end-user can scroll tabs by swiping. */ - scrollByContent?: boolean; - /** Specifies whether or not an end-user can scroll tabs. */ - scrollingEnabled?: boolean; - /** A Boolean value that specifies the availability of navigation buttons. */ - showNavButtons?: boolean; - } - /** A tab strip used to switch between pages. */ - export class dxTabs extends CollectionWidget { - constructor(element: JQuery, options?: dxTabsOptions); - constructor(element: Element, options?: dxTabsOptions); - } - export interface dxTabPanelOptions extends dxMultiViewOptions { - /** A handler for the titleClick event. */ - onTitleClick?: any; - /** A handler for the titleHold event. */ - onTitleHold?: Function; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - /** The template to be used for rendering an item title. */ - itemTitleTemplate?: any; - /** A Boolean value specifying if tabs in the title are scrolled by content. */ - scrollByContent?: boolean; - /** A Boolean indicating whether or not to add scrolling support for tabs in the title. */ - scrollingEnabled?: boolean; - /** A Boolean value that specifies the availability of navigation buttons. */ - showNavButtons?: boolean; - } - /** A widget used to display a view and to switch between several views by clicking the appropriate tabs. */ - export class dxTabPanel extends dxMultiView { - constructor(element: JQuery, options?: dxTabPanelOptions); - constructor(element: Element, options?: dxTabPanelOptions); - } - export interface dxSelectBoxOptions extends dxDropDownListOptions { - /** Specifies DOM event names that update a widget's value. */ - valueChangeEvent?: string; - /** The template to be used for rendering the widget text field. */ - fieldTemplate?: any; - /** The text that is provided as a hint in the select box editor. */ - placeholder?: string; - /** Specifies whether or not the widget allows an end-user to enter a custom value. */ - fieldEditEnabled?: boolean; - } - /** A widget that allows you to select an item in a dropdown list. */ - export class dxSelectBox extends dxDropDownList { - constructor(element: JQuery, options?: dxSelectBoxOptions); - constructor(element: Element, options?: dxSelectBoxOptions); - } - export interface dxTagBoxOptions extends dxSelectBoxOptions { - /** Holds the list of selected values. */ - values?: Array; - /** A read-only option that holds the last selected value. */ - value?: Object; - } - /** A widget that allows you to select multiple items from a dropdown list. */ - export class dxTagBox extends dxSelectBox { - constructor(element: JQuery, options?: dxTagBoxOptions); - constructor(element: Element, options?: dxTagBoxOptions); - } - export interface dxScrollViewOptions extends dxScrollableOptions { - /** A handler for the pullDown event. */ - onPullDown?: Function; - /** Specifies the text shown in the pullDown panel when pulling the content down lowers the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while pulling the content down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the reachBottom event. */ - onReachBottom?: Function; - /** Specifies the text shown in the pullDown panel displayed when content is scrolled to the bottom. */ - reachBottomText?: string; - /** Specifies the text shown in the pullDown panel displayed when the content is being refreshed. */ - refreshingText?: string; - } - /** A widget used to display scrollable content. */ - export class dxScrollView extends dxScrollable { - constructor(element: JQuery, options?: dxScrollViewOptions); - constructor(element: Element, options?: dxScrollViewOptions); - /** Returns a value indicating if the scrollView content is larger then the widget container. */ - isFull(): boolean; - /** Locks the widget until the release(preventScrollBottom) method is called and executes the function passed to the onPullDown option and the handler assigned to the pullDown event. */ - refresh(): void; - /** Notifies the scroll view that data loading is finished. */ - release(preventScrollBottom: boolean): JQueryPromise; - /** Toggles the loading state of the widget. */ - toggleLoading(showOrHide: boolean): void; - } - export interface dxScrollableLocation { - top?: number; - left?: number; - } - export interface dxScrollableOptions extends DOMComponentOptions { - /** A string value specifying the available scrolling directions. */ - direction?: string; - /** A Boolean value specifying whether or not the widget can respond to user interaction. */ - disabled?: boolean; - /** A handler for the scroll event. */ - onScroll?: Function; - /** Specifies when the widget shows the scrollbar. */ - showScrollbar?: string; - /** A handler for the update event. */ - onUpdated?: Function; - /** Indicates whether to use native or simulated scrolling. */ - useNative?: boolean; - /** A Boolean value specifying whether to enable or disable the bounce-back effect. */ - bounceEnabled?: boolean; - /** A Boolean value specifying whether or not an end-user can scroll the widget content swiping it up or down. */ - scrollByContent?: boolean; - /** A Boolean value specifying whether or not an end-user can scroll the widget content using the scrollbar. */ - scrollByThumb?: boolean; - } - /** A widget used to display scrollable content. */ - export class dxScrollable extends DOMComponent { - constructor(element: JQuery, options?: dxScrollableOptions); - constructor(element: Element, options?: dxScrollableOptions); - /** Returns the height of the scrollable widget in pixels. */ - clientHeight(): number; - /** Returns the width of the scrollable widget in pixels. */ - clientWidth(): number; - /** Returns an HTML element of the widget. */ - content(): JQuery; - /** Scrolls the widget content by the specified number of pixels. */ - scrollBy(distance: number): void; - /** Scrolls widget content by the specified number of pixels in horizontal and vertical directions. */ - scrollBy(distanceObject: dxScrollableLocation): void; - /** Returns the height of the scrollable content in pixels. */ - scrollHeight(): number; - /** Returns the current scroll position against the leftmost position. */ - scrollLeft(): number; - /** Returns how far the scrollable content is scrolled from the top and from the left. */ - scrollOffset(): dxScrollableLocation; - /** Scrolls widget content to the specified position. */ - scrollTo(targetLocation: number): void; - /** Scrolls widget content to a specified position. */ - scrollTo(targetLocation: dxScrollableLocation): void; - /** Scrolls widget content to the specified element. */ - scrollToElement(element: Element): void; - /** Returns the current scroll position against the topmost position. */ - scrollTop(): number; - /** Returns the width of the scrollable content in pixels. */ - scrollWidth(): number; - /** Updates the dimensions of the scrollable contents. */ - update(): void; - } - export interface dxRadioGroupOptions extends EditorOptions, DataExpressionMixinOptions { - activeStateEnabled?: boolean; - /** Specifies the radio group layout. */ - layout?: string; - } - /** A widget that enables a user to select one item within a list of items represented by radio buttons. */ - export class dxRadioGroup extends CollectionWidget { - constructor(element: JQuery, options?: dxRadioGroupOptions); - constructor(element: Element, options?: dxRadioGroupOptions); - } - export interface dxPopupButtonOptions { - /** Specifies whether or not a toolbar item must be displayed disabled. */ - disabled?: boolean; - /** Specifies html code inserted into the toolbar item element. */ - html?: string; - /** Specifies a location for the item on the toolbar. */ - location?: string; - /** Specifies a configuration object for the widget that presents a toolbar item. */ - options?: Object; - /** Specifies an item template that should be used to render this item only. */ - template?: any; - /** Specifies text displayed for the toolbar item. */ - text?: string; - /** Specifies whether the item is displayed on a top or bottom toolbar. */ - toolbar?: string; - /** Specifies whether or not a widget item must be displayed. */ - visible?: boolean; - /** A widget that presents a toolbar item. */ - widget?: string; - } - export interface dxPopupOptions extends dxOverlayOptions { - /** Specifies whether or not to allow a user to drag the popup window. */ - dragEnabled?: boolean; - /** A Boolean value specifying whether or not to display the widget in full-screen mode. */ - fullScreen?: boolean; - position?: PositionOptions; - /** A Boolean value specifying whether or not to display the title in the popup window. */ - showTitle?: boolean; - /** The title in the overlay window. */ - title?: string; - /** A template to be used for rendering the widget title. */ - titleTemplate?: any; - width?: any; - /** Specifies items displayed on the top or bottom toolbar of the popup window. */ - buttons?: Array; - /** Specifies whether or not the widget displays the Close button. */ - showCloseButton?: boolean; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - } - /** A widget that displays required content in a popup window. */ - export class dxPopup extends dxOverlay { - constructor(element: JQuery, options?: dxPopupOptions); - constructor(element: Element, options?: dxPopupOptions); - } - export interface dxPopoverOptions extends dxPopupOptions { - /** An object that defines the animation options of the widget. */ - animation?: { - /** An object that defines the animation options used when the widget is being shown. */ - show?: fx.AnimationOptions; - /** An object that defines the animation options used when the widget is being hidden. */ - hide?: fx.AnimationOptions; - }; - /** Specifies the height of the widget. */ - height?: any; - /** An object defining widget positioning options. */ - position?: PositionOptions; - shading?: boolean; - /** A Boolean value specifying whether or not to display the title in the overlay window. */ - showTitle?: boolean; - /** The target element associated with a popover. */ - target?: any; - /** Specifies the width of the widget. */ - width?: any; - } - /** A widget that displays the required content in a popup window. */ - export class dxPopover extends dxPopup { - constructor(element: JQuery, options?: dxPopoverOptions); - constructor(element: Element, options?: dxPopoverOptions); - /** Displays the widget for the specified target element. */ - show(target?: any): JQueryPromise; - } - export interface dxOverlayOptions extends WidgetOptions { - /** An object that defines the animation options of the widget. */ - animation?: { - /** An object that defines the animation options used when the widget is being shown. */ - show?: fx.AnimationOptions; - /** An object that defines the animation options used when the widget is being hidden. */ - hide?: fx.AnimationOptions; - }; - /** A Boolean value specifying whether or not the widget is closed if a user presses the Back hardware button. */ - closeOnBackButton?: boolean; - /** A Boolean value specifying whether or not the widget is closed if a user clicks outside of the overlapping window. */ - closeOnOutsideClick?: any; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - /** Specifies whether or not an end-user can drag the widget. */ - dragEnabled?: boolean; - /** Specifies whether or not an end user can resize the widget. */ - resizeEnabled?: boolean; - /** The height of the widget in pixels. */ - height?: any; - /** Specifies the maximum height the widget can reach while resizing. */ - maxHeight?: any; - /** Specifies the maximum width the widget can reach while resizing. */ - maxWidth?: any; - /** Specifies the minimum height the widget can reach while resizing. */ - minHeight?: any; - /** Specifies the minimum width the widget can reach while resizing. */ - minWidth?: any; - /** A handler for the hidden event. */ - onHidden?: Function; - /** A handler for the resizeStart event. */ - onResizeStart?: Function; - /** A handler for the resize event. */ - onResize?: Function; - /** A handler for the resizeEnd event. */ - onResizeEnd?: Function; - /** A handler for the hiding event. */ - onHiding?: Function; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** A Boolean value specifying whether or not the main screen is inactive while the widget is active. */ - shading?: boolean; - /** Specifies the shading color. */ - shadingColor?: string; - /** A handler for the showing event. */ - onShowing?: Function; - /** A handler for the shown event. */ - onShown?: Function; - onContentReady?: Function; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - /** The widget width in pixels. */ - width?: any; - } - /** A widget displaying the required content in an overlay window. */ - export class dxOverlay extends Widget { - constructor(element: JQuery, options?: dxOverlayOptions); - constructor(element: Element, options?: dxOverlayOptions); - /** An HTML element of the widget. */ - content(): JQuery; - /** Hides the widget. */ - hide(): JQueryPromise; - /** Recalculates the overlay's size and position. */ - repaint(): void; - /** Shows the widget. */ - show(): JQueryPromise; - /** Toggles the visibility of the widget. */ - toggle(showing: boolean): JQueryPromise; - /** A static method that specifies the base z-index for all overlay widgets. */ - static baseZIndex(zIndex: number): void; - } - export interface dxNumberBoxOptions extends dxTextEditorOptions { - /** The maximum value accepted by the number box. */ - max?: number; - /** The minimum value accepted by the number box. */ - min?: number; - /** Specifies whether or not to show spin buttons. */ - showSpinButtons?: boolean; - useTouchSpinButtons?: boolean; - /** Specifies by which value the widget value changes when a spin button is clicked. */ - step?: number; - /** The current number box value. */ - value?: number; - /** The "mode" attribute value of the actual HTML input element representing the widget. */ - mode?: string; - } - /** A textbox widget that enables a user to enter numeric values. */ - export class dxNumberBox extends dxTextEditor { - constructor(element: JQuery, options?: dxNumberBoxOptions); - constructor(element: Element, options?: dxNumberBoxOptions); - } - export interface dxNavBarOptions extends dxTabsOptions { - scrollingEnabled?: boolean; - } - /** A widget that contains items used to navigate through application views. */ - export class dxNavBar extends dxTabs { - constructor(element: JQuery, options?: dxNavBarOptions); - constructor(element: Element, options?: dxNavBarOptions); - } - export interface dxMultiViewOptions extends CollectionWidgetOptions { - /** Specifies whether or not to animate the displayed item change. */ - animationEnabled?: boolean; - /** A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped. */ - loop?: boolean; - /** The index of the currently displayed item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to allow users to change the selected index by swiping. */ - swipeEnabled?: boolean; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - } - /** A widget used to display a view and to switch between several views. */ - export class dxMultiView extends CollectionWidget { - constructor(element: JQuery, options?: dxMultiViewOptions); - constructor(element: Element, options?: dxMultiViewOptions); - } - export interface dxMapOptions extends WidgetOptions { - /** Specifies whether or not the widget automatically adjusts center and zoom option values when adding a new marker or route, or when creating a widget if it initially contains markers or routes. */ - autoAdjust?: boolean; - center?: { - /** The latitude location displayed in the center of the widget. */ - lat?: number; - /** The longitude location displayed in the center of the widget. */ - lng?: number; - }; - /** A handler for the click event. */ - onClick?: any; - /** Specifies whether or not map widget controls are available. */ - controls?: boolean; - /** Specifies the height of the widget. */ - height?: any; - /** A key used to authenticate the application within the required map provider. */ - key?: { - /** A key used to authenticate the application within the "Bing" map provider. */ - bing?: string; - /** A key used to authenticate the application within the "Google" map provider. */ - google?: string; - /** A key used to authenticate the application within the "Google Static" map provider. */ - googleStatic?: string; - } - /** A handler for the markerAdded event. */ - onMarkerAdded?: Function; - /** A URL pointing to the custom icon to be used for map markers. */ - markerIconSrc?: string; - /** A handler for the markerRemoved event. */ - onMarkerRemoved?: Function; - /** An array of markers displayed on a map. */ - markers?: Array; - /** The name of the current map data provider. */ - provider?: string; - /** A handler for the ready event. */ - onReady?: Function; - /** A handler for the routeAdded event. */ - onRouteAdded?: Function; - /** A handler for the routeRemoved event. */ - onRouteRemoved?: Function; - /** An array of routes shown on the map. */ - routes?: Array; - /** The type of a map to display. */ - type?: string; - /** Specifies the width of the widget. */ - width?: any; - /** The zoom level of the map. */ - zoom?: number; - } - /** An interactive map widget. */ - export class dxMap extends Widget { - constructor(element: JQuery, options?: dxMapOptions); - constructor(element: Element, options?: dxMapOptions); - /** Adds a marker to the map. */ - addMarker(markerOptions: Object): JQueryPromise; - /** Adds a route to the map. */ - addRoute(routeOptions: Object): JQueryPromise; - /** Removes a marker from the map. */ - removeMarker(marker: Object): JQueryPromise; - /** Removes a route from the map. */ - removeRoute(route: any): JQueryPromise; - } - export interface dxLookupOptions extends dxDropDownListOptions { - applyValueMode?: string; - /** An object that defines widget animation options. */ - animation?: { - /** An object that defines the animation options used when the widget is being shown. */ - show?: fx.AnimationOptions; - /** An object that defines the animation options used when the widget is being hidden. */ - hide?: fx.AnimationOptions; - }; - /** The text displayed on the Cancel button. */ - cancelButtonText?: string; - /** The text displayed on the Clear button. */ - clearButtonText?: string; - /** Specifies whether or not the widget cleans the search box when the popup window is displayed. */ - cleanSearchOnOpening?: boolean; - /** A Boolean value specifying whether or not a widget is closed if a user clicks outside of the overlaying window. */ - closeOnOutsideClick?: any; - /** The text displayed on the Apply button. */ - applyButtonText?: string; - /** A Boolean value specifying whether or not to display the lookup in full-screen mode. */ - fullScreen?: boolean; - focusStateEnabled?: boolean; - /** A Boolean value specifying whether or not to group widget items. */ - grouped?: boolean; - /** The name of the template used to display a group header. */ - groupTemplate?: any; - /** The text displayed on the button used to load the next page from the data source. */ - nextButtonText?: string; - /** A handler for the pageLoading event. */ - onPageLoading?: Function; - /** Specifies whether the next page is loaded when a user scrolls the widget to the bottom or when the "next" button is clicked. */ - pageLoadMode?: string; - /** Specifies the text shown in the pullDown panel, which is displayed when the widget is scrolled to the bottom. */ - pageLoadingText?: string; - /** The text displayed by the widget when nothing is selected. */ - placeholder?: string; - /** The height of the widget popup element. */ - popupHeight?: any; - /** The width of the widget popup element. */ - popupWidth?: any; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** Specifies the text displayed in the pullDown panel when the widget is pulled below the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the pullRefresh event. */ - onPullRefresh?: Function; - /** A Boolean value specifying whether or not the widget supports the "pull down to refresh" gesture. */ - pullRefreshEnabled?: boolean; - /** Specifies the text displayed in the pullDown panel while the widget is being refreshed. */ - refreshingText?: string; - /** A handler for the scroll event. */ - onScroll?: Function; - /** A Boolean value specifying whether or not the search bar is visible. */ - searchEnabled?: boolean; - /** The text that is provided as a hint in the lookup's search bar. */ - searchPlaceholder?: string; - /** A Boolean value specifying whether or not the main screen is inactive while the lookup is active. */ - shading?: boolean; - /** Specifies whether to display the Cancel button in the lookup window. */ - showCancelButton?: boolean; - /** - * A Boolean value specifying whether the widget loads the next page automatically when you reach the bottom of the list or when a button is clicked. - * @deprecated Use the pageLoadMode option instead. - */ - showNextButton?: boolean; - /** The title of the lookup window. */ - title?: string; - /** A template to be used for rendering the widget title. */ - titleTemplate?: any; - /** Specifies whether or not the widget uses native scrolling. */ - useNativeScrolling?: boolean; - /** Specifies whether or not to show lookup contents in a dxPopover widget. */ - usePopover?: boolean; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - /** A Boolean value specifying whether or not to display the title in the popup window. */ - showPopupTitle?: boolean; - /** The template to be used for rendering the widget text field. */ - fieldTemplate?: any; - } - /** A widget that allows a user to select predefined values from a lookup window. */ - export class dxLookup extends dxDropDownList { - constructor(element: JQuery, options?: dxLookupOptions); - constructor(element: Element, options?: dxLookupOptions); - } - export interface dxLoadPanelOptions extends dxOverlayOptions { - /** An object defining the animation options of the widget. */ - animation?: fx.AnimationOptions; - /** The delay in milliseconds after which the load panel is displayed. */ - delay?: number; - /** The height of the widget. */ - height?: number; - /** A URL pointing to an image to be used as a load indicator. */ - indicatorSrc?: string; - /** The text displayed in the load panel. */ - message?: string; - /** A Boolean value specifying whether or not to show a load indicator. */ - showIndicator?: boolean; - /** A Boolean value specifying whether or not to show the pane behind the load indicator. */ - showPane?: boolean; - /** The width of the widget. */ - width?: number; - } - /** A widget used to indicate whether or not an element is loading. */ - export class dxLoadPanel extends dxOverlay { - constructor(element: JQuery, options?: dxLoadPanelOptions); - constructor(element: Element, options?: dxLoadPanelOptions); - } - export interface dxLoadIndicatorOptions extends WidgetOptions { - /** Specifies the path to an image used as the indicator. */ - indicatorSrc?: string; - } - /** The widget used to indicate the loading process. */ - export class dxLoadIndicator extends Widget { - constructor(element: JQuery, options?: dxLoadIndicatorOptions); - constructor(element: Element, options?: dxLoadIndicatorOptions); - } - /** An object containing items for a context menu called for a list item. */ - export interface ListOptionsMenuItem { - /** Specifies the menu item text. */ - text?: string; - /** Specifies the function called when the menu item is clicked. */ - action?: (itemElement: Element, itemData: any) => void; - } - export interface dxListOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not to display a grouped list. */ - grouped?: boolean; - /** The template to be used for rendering item groups. */ - groupTemplate?: any; - onItemDeleting?: Function; - /** A handler for the itemDeleted event. */ - onItemDeleted?: Function; - /** A handler for the groupRendered event. */ - onGroupRendered?: Function; - /** A handler for the itemReordered event. */ - onItemReordered?: Function; - /** A handler for the itemClick event. */ - onItemClick?: any; - /** A handler for the itemSwipe event. */ - onItemSwipe?: Function; - /** The text displayed on the button used to load the next page from the data source. */ - nextButtonText?: string; - /** A handler for the pageLoading event. */ - onPageLoading?: Function; - /** Specifies the text shown in the pullDown panel, which is displayed when the list is scrolled to the bottom. */ - pageLoadingText?: string; - /** Specifies the text displayed in the pullDown panel when the list is pulled below the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the pullRefresh event. */ - onPullRefresh?: Function; - /** A Boolean value specifying whether or not the widget supports the "pull down to refresh" gesture. */ - pullRefreshEnabled?: boolean; - /** Specifies the text displayed in the pullDown panel while the list is being refreshed. */ - refreshingText?: string; - /** A handler for the scroll event. */ - onScroll?: Function; - /** A Boolean value specifying whether to enable or disable list scrolling. */ - scrollingEnabled?: boolean; - /** Specifies when the widget shows the scrollbar. */ - showScrollbar?: string; - /** Specifies whether or not the widget uses native scrolling. */ - useNativeScrolling?: boolean; - /** A Boolean value specifying whether to enable or disable the bounce-back effect. */ - bounceEnabled?: boolean; - /** A Boolean value specifying if the list is scrolled by content. */ - scrollByContent?: boolean; - /** A Boolean value specifying if the list is scrolled using the scrollbar. */ - scrollByThumb?: boolean; - onItemContextMenu?: Function; - onItemHold?: Function; - /** Specifies whether or not an end-user can collapse groups. */ - collapsibleGroups?: boolean; - /** Specifies whether the next page is loaded when a user scrolls the widget to the bottom or when the "next" button is clicked. */ - pageLoadMode?: string; - /** Specifies whether or not to display controls used to select list items. */ - showSelectionControls?: boolean; - /** Specifies item selection mode. */ - selectionMode?: string; - selectAllText?: string; - onSelectAllChanged?: Function; - /** Specifies the array of items for a context menu called for a list item. */ - menuItems?: Array; - /** Specifies whether an item context menu is shown when a user holds or swipes an item. */ - menuMode?: string; - /** Specifies whether or not an end user can delete list items. */ - allowItemDeleting?: boolean; - /** Specifies the way a user can delete items from the list. */ - itemDeleteMode?: string; - /** Specifies whether or not an end user can reorder list items. */ - allowItemReordering?: boolean; - /** Specifies whether or not to show the loading panel when the DataSource bound to the widget is loading data. */ - indicateLoading?: boolean; - activeStateEnabled?: boolean; - } - /** A list widget. */ - export class dxList extends CollectionWidget { - constructor(element: JQuery, options?: dxListOptions); - constructor(element: Element, options?: dxListOptions); - /** Returns the height of the widget in pixels. */ - clientHeight(): number; - /** Removes the specified item from the list. */ - deleteItem(itemIndex: any): JQueryPromise; - /** Removes the specified item from the list. */ - deleteItem(itemElement: Element): JQueryPromise; - /** Returns a Boolean value that indicates whether or not the specified item is selected. */ - isItemSelected(itemIndex: any): boolean; - /** Returns a Boolean value that indicates whether or not the specified item is selected. */ - isItemSelected(itemElement: Element): boolean; - /** Reloads list data. */ - reload(): void; - /** Moves the specified item to the specified position in the list. */ - reorderItem(itemElement: Element, toItemElement: Element): JQueryPromise; - /** Moves the specified item to the specified position in the list. */ - reorderItem(itemIndex: any, toItemIndex: any): JQueryPromise; - /** Scrolls the list content by the specified number of pixels. */ - scrollBy(distance: number): void; - /** Returns the height of the list content in pixels. */ - scrollHeight(): number; - /** Scrolls list content to the specified position. */ - scrollTo(location: number): void; - /** Scrolls the list to the specified item. */ - scrollToItem(itemElement: Element): void; - /** Scrolls the list to the specified item. */ - scrollToItem(itemIndex: any): void; - /** Returns how far the list content is scrolled from the top. */ - scrollTop(): number; - /** Selects the specified item from the list. */ - selectItem(itemElement: Element): void; - /** Selects the specified item from the list. */ - selectItem(itemIndex: any): void; - /** Deselects the specified item from the list. */ - unselectItem(itemElement: Element): void; - /** Unselects the specified item from the list. */ - unselectItem(itemIndex: any): void; - /** Updates the widget scrollbar according to widget content size. */ - updateDimensions(): JQueryPromise; - /** Expands the specified group. */ - expandGroup(groupIndex: number): JQueryPromise; - /** Collapses the specified group. */ - collapseGroup(groupIndex: number): JQueryPromise; - } - export interface dxGalleryOptions extends CollectionWidgetOptions { - /** The time, in milliseconds, spent on slide animation. */ - animationDuration?: number; - /** Specifies whether or not to animate the displayed item change. */ - animationEnabled?: boolean; - /** A Boolean value specifying whether or not to allow users to switch between items by clicking an indicator. */ - indicatorEnabled?: boolean; - /** A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped. */ - loop?: boolean; - /** The index of the currently active gallery item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to display an indicator that points to the selected gallery item. */ - showIndicator?: boolean; - /** A Boolean value that specifies the availability of the "Forward" and "Back" navigation buttons. */ - showNavButtons?: boolean; - /** The time interval in milliseconds, after which the gallery switches to the next item. */ - slideshowDelay?: number; - /** A Boolean value specifying whether or not to allow users to switch between items by swiping. */ - swipeEnabled?: boolean; - /** Specifies whether or not to display parts of previous and next images along the sides of the current image. */ - wrapAround?: boolean; - /** Specifies if the widget stretches images to fit the total gallery width. */ - stretchImages?: boolean; - /** Specifies the width of an area used to display a single image. */ - initialItemWidth?: number; - } - /** An image gallery widget. */ - export class dxGallery extends CollectionWidget { - constructor(element: JQuery, options?: dxGalleryOptions); - constructor(element: Element, options?: dxGalleryOptions); - /** Shows the specified gallery item. */ - goToItem(itemIndex: number, animation: boolean): JQueryPromise; - /** Shows the next gallery item. */ - nextItem(animation: boolean): JQueryPromise; - /** Shows the previous gallery item. */ - prevItem(animation: boolean): JQueryPromise; - } - export interface dxDropDownEditorOptions extends dxTextBoxOptions { - /** Specifies the current value displayed by the widget. */ - value?: Object; - /** A handler for the closed event. */ - onClosed?: Function; - /** A handler for the opened event. */ - onOpened?: Function; - /** Specifies whether or not the drop-down editor is displayed. */ - opened?: boolean; - /** Specifies whether or not the widget allows an end-user to enter a custom value. */ - fieldEditEnabled?: boolean; - /** Specifies the way an end-user applies the selected value. */ - applyValueMode?: string; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - activeStateEnabled?: boolean; - } - /** A drop-down editor widget. */ - export class dxDropDownEditor extends dxTextBox { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - /** Closes the drop-down editor. */ - close(): void; - /** Opens the drop-down editor. */ - open(): void; - /** Resets the widget's value to null. */ - reset(): void; - /** Returns an <input> element of the widget. */ - field(): JQuery; - /** Returns an HTML element of the popup window content. */ - content(): JQuery; - } - export interface dxDateBoxOptions extends dxTextEditorOptions { - /** A format used to display date/time information. */ - format?: string; - /** A Globalize format string specifying the date display format. */ - formatString?: string; - /** The last date that can be selected within the widget. */ - max?: any; - /** The minimum date that can be selected within the widget. */ - min?: any; - /** The text displayed by the widget when the widget value is not yet specified. This text is also used as a title of the date picker. */ - placeholder?: string; - /** - * Specifies whether or not a user can pick out a date using the drop-down calendar. - * @deprecated Use the pickerType option instead. - */ - useCalendar?: boolean; - /** An object or a value, specifying the date and time currently selected using the date box. */ - value?: any; - /** - * Specifies whether or not the widget uses the native HTML input element. - * @deprecated Use the pickerType option instead. - */ - useNative?: boolean; - /** Specifies the interval between neighboring values in the popup list in minutes. */ - interval?: number; - /** Specifies the maximum zoom level of a calendar, which is used to pick the date. */ - maxZoomLevel?: string; - /** Specifies the minimal zoom level of a calendar, which is used to pick the date. */ - minZoomLevel?: string; - /** Specifies the type of date/time picker. */ - pickerType?: string; - /** Specifies the message displayed if the typed value is not a valid date or time. */ - invalidDateMessage?: string; - /** Specifies the message displayed if the specified date is later than the max value or earlier than the min value. */ - dateOutOfRangeMessage?: string; - /** The text displayed on the Apply button. */ - applyButtonText?: string; - /** The text displayed on the Cancel button. */ - cancelButtonText?: string; - } - /** A date box widget. */ - export class dxDateBox extends dxDropDownEditor { - constructor(element: JQuery, options?: dxDateBoxOptions); - constructor(element: Element, options?: dxDateBoxOptions); - } - export interface dxCheckBoxOptions extends EditorOptions { - activeStateEnabled?: boolean; - /** Specifies the widget state. */ - value?: boolean; - /** Specifies the text displayed by the check box. */ - text?: string; - } - /** A check box widget. */ - export class dxCheckBox extends Editor { - constructor(element: JQuery, options?: dxCheckBoxOptions); - constructor(element: Element, options?: dxCheckBoxOptions); - } - export interface dxCalendarOptions extends EditorOptions { - activeStateEnabled?: boolean; - /** Specifies a date displayed on the current calendar page. */ - currentDate?: Date; - /** Specifies the first day of a week. */ - firstDayOfWeek?: number; - /** An object or a value, specifying the date and time currently selected in the calendar. */ - value?: any; - /** The latest date the widget allows to select. */ - max?: any; - /** The earliest date the widget allows to select. */ - min?: any; - /** Specifies whether or not the widget displays a button that selects the current date. */ - showTodayButton?: boolean; - /** Specifies the current calendar zoom level. */ - zoomLevel?: string; - /** Specifies the maximum zoom level of the calendar. */ - maxZoomLevel?: string; - /** Specifies the minimum zoom level of the calendar. */ - minZoomLevel?: string; - /** The template to be used for rendering calendar cells. */ - cellTemplate?: any; - } - /** A calendar widget. */ - export class dxCalendar extends Editor { - constructor(element: JQuery, options?: dxCalendarOptions); - constructor(element: Element, options?: dxCalendarOptions); - } - export interface dxButtonOptions extends WidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A handler for the click event. */ - onClick?: any; - /** Specifies the icon to be displayed on the button. */ - icon?: string; - iconSrc?: string; - /** A template to be used for rendering the dxButton widget. */ - template?: any; - /** The text displayed on the button. */ - text?: string; - /** Specifies the button type. */ - type?: string; - /** Specifies the name of the validation group to be accessed in the click event handler. */ - validationGroup?: string; - } - /** A button widget. */ - export class dxButton extends Widget { - constructor(element: JQuery, options?: dxButtonOptions); - constructor(element: Element, options?: dxButtonOptions); - } - export interface dxBoxOptions extends CollectionWidgetOptions { - /** Specifies how widget items are aligned along the main direction. */ - align?: string; - /** Specifies the direction of item positioning in the widget. */ - direction?: string; - /** Specifies how widget items are aligned cross-wise. */ - crossAlign?: string; - } - /** A container widget used to arrange inner elements. */ - export class dxBox extends CollectionWidget { - constructor(element: JQuery, options?: dxBoxOptions); - constructor(element: Element, options?: dxBoxOptions); - } - export interface dxResponsiveBoxOptions extends CollectionWidgetOptions { - /** Specifies the collection of rows for the grid used to position layout elements. */ - rows?: Array; - /** Specifies the collection of columns for the grid used to position layout elements. */ - cols?: Array; - /** Specifies the function returning the screen factor depending on the screen width. */ - screenByWidth?: (width: number) => string; - /** Specifies the screen factor with which all elements are located in a single column. */ - singleColumnScreen?: string; - } - /** A widget used to build an adaptive markup that is dependent on screen resolution. */ - export class dxResponsiveBox extends CollectionWidget { - constructor(element: JQuery, options?: dxBoxOptions); - constructor(element: Element, options?: dxBoxOptions); - } - export interface dxAutocompleteOptions extends dxDropDownListOptions { - /** Specifies the current value displayed by the widget. */ - value?: string; - /** The minimum number of characters that must be entered into the text box to begin a search. */ - minSearchLength?: number; - /** Specifies the maximum count of items displayed by the widget. */ - maxItemCount?: number; - /** Gets the currently selected item. */ - selectedItem?: Object; - } - /** A textbox widget that supports autocompletion. */ - export class dxAutocomplete extends dxDropDownList { - constructor(element: JQuery, options?: dxAutocompleteOptions); - constructor(element: Element, options?: dxAutocompleteOptions); - /** Opens the drop-down editor. */ - open(): void; - /** Closes the drop-down editor. */ - close(): void; - } - export interface dxAccordionOptions extends CollectionWidgetOptions { - /** A number specifying the time in milliseconds spent on the animation of the expanding or collapsing of a panel. */ - animationDuration?: number; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies whether all items can be collapsed or whether at least one item must always be expanded. */ - collapsible?: boolean; - /** Specifies whether the widget can expand several items or only a single item at once. */ - multiple?: boolean; - /** The template to be used for rendering dxAccordion items. */ - itemTemplate?: any; - /** A handler for the itemTitleClick event. */ - onItemTitleClick?: any; - /** The template to be used for rendering an item title. */ - itemTitleTemplate?: any; - /** The index number of the currently selected item. */ - selectedIndex?: number; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - } - /** A widget that displays data source items on collapsible panels. */ - export class dxAccordion extends CollectionWidget { - constructor(element: JQuery, options?: dxAccordionOptions); - constructor(element: Element, options?: dxAccordionOptions); - /** Collapses the specified item. */ - collapseItem(index: number): JQueryPromise; - /** Expands the specified item. */ - expandItem(index: number): JQueryPromise; - /** Updates the dimensions of the widget contents. */ - updateDimensions(): JQueryPromise; - } - export interface dxFileUploaderOptions extends EditorOptions { - /** A read-only option that holds a File instance representing the selected file. */ - value?: File; - /** Holds the File instances representing files selected in the widget. */ - values?: Array; - buttonText?: string; - /** The text displayed on the button that opens the file browser. */ - selectButtonText?: string; - /** The text displayed on the button that starts uploading. */ - uploadButtonText?: string; - /** Specifies the text displayed on the area to which an end-user can drop a file. */ - labelText?: string; - /** Specifies the value passed to the name attribute of the underlying input element. */ - name?: string; - /** Specifies whether the widget enables an end-user to select a single file or multiple files. */ - multiple?: boolean; - /** Specifies a file type or several types accepted by the widget. */ - accept?: string; - /** Specifies a target Url for the upload request. */ - uploadUrl?: string; - /** Specifies if an end user can remove a file from the selection and interrupt uploading. */ - allowCanceling?: boolean; - /** Specifies whether or not the widget displays the list of selected files. */ - showFileList?: boolean; - /** Gets the current progress in percentages. */ - progress?: number; - /** The message displayed by the widget when it is ready to upload the specified files. */ - readyToUploadMessage?: string; - /** The message displayed by the widget when uploading is finished. */ - uploadedMessage?: string; - /** The message displayed by the widget on uploading failure. */ - uploadFailedMessage?: string; - /** Specifies how the widget uploads files. */ - uploadMode?: string; - /** A handler for the uploaded event. */ - onUploaded?: Function; - /** A handler for the uploaded event. */ - onProgress?: Function; - /** A handler for the uploadError event. */ - onUploadError?: Function; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - } - /** A widget used to select and upload a file or multiple files. */ - export class dxFileUploader extends Editor { - constructor(element: JQuery, options?: dxFileUploaderOptions); - constructor(element: Element, options?: dxFileUploaderOptions); - } - export interface dxTrackBarOptions extends EditorOptions { - /** The minimum value the widget can accept. */ - min?: number; - /** The maximum value the widget can accept. */ - max?: number; - /** The current widget value. */ - value?: number; - } - /** A base class for track bar widgets. */ - export class dxTrackBar extends Editor { - constructor(element: JQuery, options?: dxTrackBarOptions); - constructor(element: Element, options?: dxTrackBarOptions); - } - export interface dxProgressBarOptions extends dxTrackBarOptions { - /** Specifies a format for the progress status. */ - statusFormat?: any; - /** Specifies whether or not the widget displays a progress status. */ - showStatus?: boolean; - /** A handler for the complete event. */ - onComplete?: Function; - } - /** A widget used to indicate progress. */ - export class dxProgressBar extends dxTrackBar { - constructor(element: JQuery, options?: dxProgressBarOptions); - constructor(element: Element, options?: dxProgressBarOptions); - } - export interface dxSliderOptions extends dxTrackBarOptions { - activeStateEnabled?: boolean; - /** The slider step size. */ - step?: number; - /** The current slider value. */ - value?: number; - /** Specifies whether or not to highlight a range selected within the widget. */ - showRange?: boolean; - /** Specifies the size of a step by which a slider handle is moved when a user uses the Page up or Page down keyboard shortcuts. */ - keyStep?: number; - /** Specifies options for the slider tooltip. */ - tooltip?: { - /** Specifies whether or not the tooltip is enabled. */ - enabled?: boolean; - /** Specifies format for the tooltip. */ - format?: any; - /** Specifies whether the tooltip is located over or under the slider. */ - position?: string; - /** Specifies whether the widget always shows a tooltip or only when a pointer is over the slider. */ - showMode?: string; - }; - /** Specifies options for labels displayed at the min and max values. */ - label?: { - /** Specifies whether or not slider labels are visible. */ - visible?: boolean; - /** Specifies whether labels are located over or under the scale. */ - position?: string; - /** Specifies a format for labels. */ - format?: any; - }; - } - /** A widget that allows a user to select a numeric value within a given range. */ - export class dxSlider extends dxTrackBar { - constructor(element: JQuery, options?: dxSliderOptions); - constructor(element: Element, options?: dxSliderOptions); - } - export interface dxRangeSliderOptions extends dxSliderOptions { - /** The left edge of the interval currently selected using the range slider. */ - start?: number; - /** The right edge of the interval currently selected using the range slider. */ - end?: number; - } - /** A widget that enables a user to select a range of numeric values. */ - export class dxRangeSlider extends dxSlider { - constructor(element: JQuery, options?: dxRangeSliderOptions); - constructor(element: Element, options?: dxRangeSliderOptions); - } - export interface dxFormItemLabel { - /** Specifies the label text. */ - text?: string; - /** Specifies whether or not the label is visible. */ - visible?: boolean; - /** Specifies whether or not a colon is displayed at the end of the current label. */ - showColon?: boolean; - /** Specifies the location of a label against the editor. */ - location?: string; - /** Specifies the label horizontal alignment. */ - alignment?: string; - } - export interface dxFormItem { - /** Specifies the type of the current item. */ - itemType?: string; - /** Specifies whether or not the current form item is visible. */ - visible?: boolean; - /** Specifies the sequence number of the item in a form, group or tab. */ - visibleIndex?: number; - /** Specifies a CSS class to be applied to the form item. */ - cssClass?: string; - /** Specifies the number of columns spanned by the item. */ - colSpan?: number; - } - export interface dxFormEmptyItem extends dxFormItem { - /** Specifies the form item name. */ - name?: string; - } - export interface dxFormSimpleItem extends dxFormItem { - /** Specifies the path to the formData object field bound to the current form item. */ - dataField?: string; - /** Specifies the form item name. */ - name?: string; - /** Specifies which editor widget is used to display and edit the form item value. */ - editorType?: string; - /** Specifies configuration options for the editor widget of the current form item. */ - editorOptions?: Object; - /** A template to be used for rendering the form item. */ - template?: any; - /** Specifies the help text displayed for the current form item. */ - helpText?: string; - /** Specifies whether the current form item is required. */ - isRequired?: boolean; - /** Specifies options for the form item label. */ - label?: dxFormItemLabel; - /** An array of validation rules to be checked for the form item editor. */ - validationRules?: Array; - } - export interface dxFormGroupItem extends dxFormItem { - /** Specifies the group caption. */ - caption?: string; - /** A template to be used for rendering the group item. */ - template?: any; - /** The count of columns in the group layout. */ - colCount?: number; - /** Specifies whether or not all group item labels are aligned. */ - alignItemLabels?: boolean; - /** Holds an array of form items displayed within the group. */ - items?: Array; - } - export interface dxFormTab { - /** Specifies the tab title. */ - title?: string; - /** The count of columns in the tab layout. */ - colCount?: number; - /** Specifies whether or not labels of items displayed within the current tab are aligned. */ - alignItemLabels?: boolean; - /** Holds an array of form items displayed within the tab. */ - items?: Array; - /** Specifies a badge text for the tab. */ - badge?: string; - /** A Boolean value specifying whether or not the tab can respond to user interaction. */ - disabled?: boolean; - /** Specifies the icon to be displayed on the tab. */ - icon?: string; - /** The template to be used for rendering the tab. */ - tabTemplate?: any; - /** The template to be used for rendering the tab content. */ - template?: any; - } - export interface dxFormTabbedItem extends dxFormItem { - /** Holds a configuration object for the dxTabPanel widget used to display the current form item. */ - tabPanelOptions?: Object; - /** An array of tab configuration objects. */ - tabs?: Array; - } - export interface dxFormOptions extends WidgetOptions { - /** An object providing data for the form. */ - formData?: Object; - /** The count of columns in the form layout. */ - colCount?: any; - /** Specifies the location of a label against the editor. */ - labelLocation?: string; - /** Specifies whether or not all editors on the form are read-only. */ - readOnly?: boolean; - /** A handler for the fieldDataChanged event. */ - onFieldDataChanged?: (e: Object) => void; - /** A handler for the editorEnterKey event. */ - onEditorEnterKey?: (e: Object) => void; - /** Specifies a function that customizes a form item after it has been created. */ - customizeItem?: Function; - /** The minimum column width used for calculating column count in the form layout. */ - minColWidth?: number; - /** Specifies whether or not all root item labels are aligned. */ - alignItemLabels?: boolean; - /** Specifies whether or not item labels in all groups are aligned. */ - alignItemLabelsInAllGroups?: boolean; - /** Specifies whether or not a colon is displayed at the end of form labels. */ - showColonAfterLabel?: boolean; - /** Specifies whether or not the required mark is displayed for required fields. */ - showRequiredMark?: boolean; - /** Specifies whether or not the optional mark is displayed for optional fields. */ - showOptionalMark?: boolean; - /** The text displayed for required fields. */ - requiredMark?: string; - /** The text displayed for optional fields. */ - optionalMark?: string; - /** Specifies the message that is shown for end-users if a required field value is not specified. */ - requiredMessage?: string; - /** Specifies whether or not the total validation summary is displayed on the form. */ - showValidationSummary?: boolean; - /** Holds an array of form items. */ - items?: Array; - /** A Boolean value specifying whether to enable or disable form scrolling. */ - scrollingEnabled?: boolean; - onContentReady?: Function; - } - /** A form widget used to display and edit values of object fields. */ - export class dxForm extends Widget { - constructor(element: JQuery, options?: dxFormOptions); - constructor(element: Element, options?: dxFormOptions); - /** Updates the specified field of the formData object and the corresponding editor on the form. */ - updateData(dataField: string, value: any): void; - /** Updates the specified fields of the formData object and the corresponding editors on the form. */ - updateData(data: Object): void; - /** Updates the value of a form item option. */ - itemOption(field: string, option: string, value: any): void; - /** Updates the values of form item options. */ - itemOption(field: string, options: Object): void; - /** Returns an editor instance associated with the specified formData field. */ - getEditor(field: string): Object; - /** Updates the dimensions of the widget contents. */ - updateDimensions(): JQueryPromise; - /** Validates the values of all editors on the form against the list of the validation rules specified for each form item. */ - validate(): Object; - /** Resets the editor's value to undefined. */ - resetValues(): void; - } - export interface dxDeferRenderingOptions extends WidgetOptions { - /** Indicates if a load indicator should be shown until the widget's content is rendered. */ - showLoadIndicator?: boolean; - /** Specifies a jQuery.Promise or a boolean value, which upon resolving forces widget content to render. */ - renderWhen?: any; - /** Specifies the animation to be used to show the rendered content. */ - animation?: fx.AnimationOptions; - /** Specifies a jQuery selector of items that should be rendered using a staggered animation. */ - staggerItemSelector?: string; - /** Specifies a callback function that is called when the widget's content has finished rendering but is not yet shown. */ - onRendered?: Function; - /** Specifies a callback function that is called when widget content is shown and animation has completed. */ - onShown?: Function; - } - /** A container for elements that must be rendered at a specified moment. */ - export class dxDeferRendering extends Widget { - constructor(element: JQuery, options?: dxDeferRenderingOptions); - constructor(element: Element, options?: dxDeferRenderingOptions); - } -} -interface JQuery { - dxProgressBar(): JQuery; - dxProgressBar(options: "instance"): DevExpress.ui.dxProgressBar; - dxProgressBar(options: string): any; - dxProgressBar(options: string, ...params: any[]): any; - dxProgressBar(options: DevExpress.ui.dxProgressBarOptions): JQuery; - dxSlider(): JQuery; - dxSlider(options: "instance"): DevExpress.ui.dxSlider; - dxSlider(options: string): any; - dxSlider(options: string, ...params: any[]): any; - dxSlider(options: DevExpress.ui.dxSliderOptions): JQuery; - dxRangeSlider(): JQuery; - dxRangeSlider(options: "instance"): DevExpress.ui.dxRangeSlider; - dxRangeSlider(options: string): any; - dxRangeSlider(options: string, ...params: any[]): any; - dxRangeSlider(options: DevExpress.ui.dxRangeSliderOptions): JQuery; - dxFileUploader(): JQuery; - dxFileUploader(options: "instance"): DevExpress.ui.dxFileUploader; - dxFileUploader(options: string): any; - dxFileUploader(options: string, ...params: any[]): any; - dxFileUploader(options: DevExpress.ui.dxFileUploaderOptions): JQuery; - dxValidator(): JQuery; - dxValidator(options: "instance"): DevExpress.ui.dxValidator; - dxValidator(options: string): any; - dxValidator(options: string, ...params: any[]): any; - dxValidator(options: DevExpress.ui.dxValidatorOptions): JQuery; - dxValidationGroup(): JQuery; - dxValidationGroup(options: "instance"): DevExpress.ui.dxValidationGroup; - dxValidationGroup(options: string): any; - dxValidationGroup(options: string, ...params: any[]): any; - dxValidationSummary(): JQuery; - dxValidationSummary(options: "instance"): DevExpress.ui.dxValidationSummary; - dxValidationSummary(options: string): any; - dxValidationSummary(options: string, ...params: any[]): any; - dxValidationSummary(options: DevExpress.ui.dxValidationSummaryOptions): JQuery; - dxTooltip(): JQuery; - dxTooltip(options: "instance"): DevExpress.ui.dxTooltip; - dxTooltip(options: string): any; - dxTooltip(options: string, ...params: any[]): any; - dxTooltip(options: DevExpress.ui.dxTooltipOptions): JQuery; - dxResizable(): JQuery; - dxResizable(options: "instance"): DevExpress.ui.dxResizable; - dxResizable(options: string): any; - dxResizable(options: string, ...params: any[]): any; - dxResizable(options: DevExpress.ui.dxResizableOptions): JQuery; - dxDropDownList(): JQuery; - dxDropDownList(options: "instance"): DevExpress.ui.dxDropDownList; - dxDropDownList(options: string): any; - dxDropDownList(options: string, ...params: any[]): any; - dxDropDownList(options: DevExpress.ui.dxDropDownListOptions): JQuery; - dxToolbar(): JQuery; - dxToolbar(options: "instance"): DevExpress.ui.dxToolbar; - dxToolbar(options: string): any; - dxToolbar(options: string, ...params: any[]): any; - dxToolbar(options: DevExpress.ui.dxToolbarOptions): JQuery; - dxToast(): JQuery; - dxToast(options: "instance"): DevExpress.ui.dxToast; - dxToast(options: string): any; - dxToast(options: string, ...params: any[]): any; - dxToast(options: DevExpress.ui.dxToastOptions): JQuery; - dxTextEditor(): JQuery; - dxTextEditor(options: "instance"): DevExpress.ui.dxTextEditor; - dxTextEditor(options: string): any; - dxTextEditor(options: string, ...params: any[]): any; - dxTextEditor(options: DevExpress.ui.dxTextEditorOptions): JQuery; - dxTextBox(): JQuery; - dxTextBox(options: "instance"): DevExpress.ui.dxTextBox; - dxTextBox(options: string): any; - dxTextBox(options: string, ...params: any[]): any; - dxTextBox(options: DevExpress.ui.dxTextBoxOptions): JQuery; - dxTextArea(): JQuery; - dxTextArea(options: "instance"): DevExpress.ui.dxTextArea; - dxTextArea(options: string): any; - dxTextArea(options: string, ...params: any[]): any; - dxTextArea(options: DevExpress.ui.dxTextAreaOptions): JQuery; - dxTabs(): JQuery; - dxTabs(options: "instance"): DevExpress.ui.dxTabs; - dxTabs(options: string): any; - dxTabs(options: string, ...params: any[]): any; - dxTabs(options: DevExpress.ui.dxTabsOptions): JQuery; - dxTabPanel(): JQuery; - dxTabPanel(options: "instance"): DevExpress.ui.dxTabPanel; - dxTabPanel(options: string): any; - dxTabPanel(options: string, ...params: any[]): any; - dxTabPanel(options: DevExpress.ui.dxTabPanelOptions): JQuery; - dxSelectBox(): JQuery; - dxSelectBox(options: "instance"): DevExpress.ui.dxSelectBox; - dxSelectBox(options: string): any; - dxSelectBox(options: string, ...params: any[]): any; - dxSelectBox(options: DevExpress.ui.dxSelectBoxOptions): JQuery; - dxTagBox(): JQuery; - dxTagBox(options: "instance"): DevExpress.ui.dxTagBox; - dxTagBox(options: string): any; - dxTagBox(options: string, ...params: any[]): any; - dxTagBox(options: DevExpress.ui.dxTagBoxOptions): JQuery; - dxScrollView(): JQuery; - dxScrollView(options: "instance"): DevExpress.ui.dxScrollView; - dxScrollView(options: string): any; - dxScrollView(options: string, ...params: any[]): any; - dxScrollView(options: DevExpress.ui.dxScrollViewOptions): JQuery; - dxScrollable(): JQuery; - dxScrollable(options: "instance"): DevExpress.ui.dxScrollable; - dxScrollable(options: string): any; - dxScrollable(options: string, ...params: any[]): any; - dxScrollable(options: DevExpress.ui.dxScrollableOptions): JQuery; - dxRadioGroup(): JQuery; - dxRadioGroup(options: "instance"): DevExpress.ui.dxRadioGroup; - dxRadioGroup(options: string): any; - dxRadioGroup(options: string, ...params: any[]): any; - dxRadioGroup(options: DevExpress.ui.dxRadioGroupOptions): JQuery; - dxPopup(): JQuery; - dxPopup(options: "instance"): DevExpress.ui.dxPopup; - dxPopup(options: string): any; - dxPopup(options: string, ...params: any[]): any; - dxPopup(options: DevExpress.ui.dxPopupOptions): JQuery; - dxPopover(): JQuery; - dxPopover(options: "instance"): DevExpress.ui.dxPopover; - dxPopover(options: string): any; - dxPopover(options: string, ...params: any[]): any; - dxPopover(options: DevExpress.ui.dxPopoverOptions): JQuery; - dxOverlay(): JQuery; - dxOverlay(options: "instance"): DevExpress.ui.dxOverlay; - dxOverlay(options: string): any; - dxOverlay(options: string, ...params: any[]): any; - dxOverlay(options: DevExpress.ui.dxOverlayOptions): JQuery; - dxNumberBox(): JQuery; - dxNumberBox(options: "instance"): DevExpress.ui.dxNumberBox; - dxNumberBox(options: string): any; - dxNumberBox(options: string, ...params: any[]): any; - dxNumberBox(options: DevExpress.ui.dxNumberBoxOptions): JQuery; - dxNavBar(): JQuery; - dxNavBar(options: "instance"): DevExpress.ui.dxNavBar; - dxNavBar(options: string): any; - dxNavBar(options: string, ...params: any[]): any; - dxNavBar(options: DevExpress.ui.dxNavBarOptions): JQuery; - dxMultiView(): JQuery; - dxMultiView(options: "instance"): DevExpress.ui.dxMultiView; - dxMultiView(options: string): any; - dxMultiView(options: string, ...params: any[]): any; - dxMultiView(options: DevExpress.ui.dxMultiViewOptions): JQuery; - dxMap(): JQuery; - dxMap(options: "instance"): DevExpress.ui.dxMap; - dxMap(options: string): any; - dxMap(options: string, ...params: any[]): any; - dxMap(options: DevExpress.ui.dxMapOptions): JQuery; - dxLookup(): JQuery; - dxLookup(options: "instance"): DevExpress.ui.dxLookup; - dxLookup(options: string): any; - dxLookup(options: string, ...params: any[]): any; - dxLookup(options: DevExpress.ui.dxLookupOptions): JQuery; - dxLoadPanel(): JQuery; - dxLoadPanel(options: "instance"): DevExpress.ui.dxLoadPanel; - dxLoadPanel(options: string): any; - dxLoadPanel(options: string, ...params: any[]): any; - dxLoadPanel(options: DevExpress.ui.dxLoadPanelOptions): JQuery; - dxLoadIndicator(): JQuery; - dxLoadIndicator(options: "instance"): DevExpress.ui.dxLoadIndicator; - dxLoadIndicator(options: string): any; - dxLoadIndicator(options: string, ...params: any[]): any; - dxLoadIndicator(options: DevExpress.ui.dxLoadIndicatorOptions): JQuery; - dxList(): JQuery; - dxList(options: "instance"): DevExpress.ui.dxList; - dxList(options: string): any; - dxList(options: string, ...params: any[]): any; - dxList(options: DevExpress.ui.dxListOptions): JQuery; - dxGallery(): JQuery; - dxGallery(options: "instance"): DevExpress.ui.dxGallery; - dxGallery(options: string): any; - dxGallery(options: string, ...params: any[]): any; - dxGallery(options: DevExpress.ui.dxGalleryOptions): JQuery; - dxDropDownEditor(): JQuery; - dxDropDownEditor(options: "instance"): DevExpress.ui.dxDropDownEditor; - dxDropDownEditor(options: string): any; - dxDropDownEditor(options: string, ...params: any[]): any; - dxDropDownEditor(options: DevExpress.ui.dxDropDownEditorOptions): JQuery; - dxDateBox(): JQuery; - dxDateBox(options: "instance"): DevExpress.ui.dxDateBox; - dxDateBox(options: string): any; - dxDateBox(options: string, ...params: any[]): any; - dxDateBox(options: DevExpress.ui.dxDateBoxOptions): JQuery; - dxCheckBox(): JQuery; - dxCheckBox(options: "instance"): DevExpress.ui.dxCheckBox; - dxCheckBox(options: string): any; - dxCheckBox(options: string, ...params: any[]): any; - dxCheckBox(options: DevExpress.ui.dxCheckBoxOptions): JQuery; - dxBox(): JQuery; - dxBox(options: "instance"): DevExpress.ui.dxBox; - dxBox(options: string): any; - dxBox(options: string, ...params: any[]): any; - dxBox(options: DevExpress.ui.dxBoxOptions): JQuery; - dxButton(): JQuery; - dxButton(options: "instance"): DevExpress.ui.dxButton; - dxButton(options: string): any; - dxButton(options: string, ...params: any[]): any; - dxButton(options: DevExpress.ui.dxButtonOptions): JQuery; - dxCalendar(): JQuery; - dxCalendar(options: "instance"): DevExpress.ui.dxCalendar; - dxCalendar(options: string): any; - dxCalendar(options: string, ...params: any[]): any; - dxCalendar(options: DevExpress.ui.dxCalendarOptions): JQuery; - dxAccordion(): JQuery; - dxAccordion(options: "instance"): DevExpress.ui.dxAccordion; - dxAccordion(options: string): any; - dxAccordion(options: string, ...params: any[]): any; - dxAccordion(options: DevExpress.ui.dxAccordionOptions): JQuery; - dxResponsiveBox(): JQuery; - dxResponsiveBox(options: "instance"): DevExpress.ui.dxResponsiveBox; - dxResponsiveBox(options: string): any; - dxResponsiveBox(options: string, ...params: any[]): any; - dxResponsiveBox(options: DevExpress.ui.dxResponsiveBoxOptions): JQuery; - dxAutocomplete(): JQuery; - dxAutocomplete(options: "instance"): DevExpress.ui.dxAutocomplete; - dxAutocomplete(options: string): any; - dxAutocomplete(options: string, ...params: any[]): any; - dxAutocomplete(options: DevExpress.ui.dxAutocompleteOptions): JQuery; - dxForm(): JQuery; - dxForm(options: "instance"): DevExpress.ui.dxForm; - dxForm(options: string): any; - dxForm(options: string, ...params: any[]): any; - dxForm(options: DevExpress.ui.dxFormOptions): JQuery; -} - -declare module DevExpress.ui { - export interface dxTileViewOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** Specifies the height of the base tile view item. */ - baseItemHeight?: number; - /** Specifies the width of the base tile view item. */ - baseItemWidth?: number; - /** Specifies whether tiles are placed horizontally or vertically. */ - direction?: string; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies the distance in pixels between adjacent tiles. */ - itemMargin?: number; - /** A Boolean value specifying whether or not to display a scrollbar. */ - showScrollbar?: boolean; - } - /** A widget displaying several blocks of data as tiles. */ - export class dxTileView extends CollectionWidget { - constructor(element: JQuery, options?: dxTileViewOptions); - constructor(element: Element, options?: dxTileViewOptions); - /** Returns the current scroll position of the widget content. */ - scrollPosition(): number; - } - export interface dxSwitchOptions extends EditorOptions { - activeStateEnabled?: boolean; - /** Text displayed when the widget is in a disabled state. */ - offText?: string; - /** Text displayed when the widget is in an enabled state. */ - onText?: string; - /** A Boolean value specifying whether the current switch state is "On" or "Off". */ - value?: boolean; - } - /** A switch widget. */ - export class dxSwitch extends Editor { - constructor(element: JQuery, options?: dxSwitchOptions); - constructor(element: Element, options?: dxSwitchOptions); - } - export interface dxSlideOutViewOptions extends WidgetOptions { - /** Specifies the current menu position. */ - menuPosition?: string; - /** Specifies whether or not the menu panel is visible. */ - menuVisible?: boolean; - /** Specifies whether or not the menu is shown when a user swipes the widget content. */ - swipeEnabled?: boolean; - /** A template to be used for rendering menu panel content. */ - menuTemplate?: any; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - } - /** The widget that allows you to slide-out the current view to reveal a custom menu. */ - export class dxSlideOutView extends Widget { - constructor(element: JQuery, options?: dxSlideOutViewOptions); - constructor(element: Element, options?: dxSlideOutViewOptions); - /** Returns an HTML element of the widget menu block. */ - menuContent(): JQuery; - /** Returns an HTML element of the widget content block. */ - content(): JQuery; - /** Displays the widget's menu block. */ - showMenu(): JQueryPromise; - /** Hides the widget's menu block. */ - hideMenu(): JQueryPromise; - /** Toggles the visibility of the widget's menu block. */ - toggleMenuVisibility(): JQueryPromise; - } - export interface dxSlideOutOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A Boolean value specifying whether or not to display a grouped menu. */ - menuGrouped?: boolean; - /** Specifies the current menu position. */ - menuPosition?: string; - /** The name of the template used to display a group header. */ - menuGroupTemplate?: any; - /** The template used to render menu items. */ - menuItemTemplate?: any; - /** A handler for the menuGroupRendered event. */ - onMenuGroupRendered?: Function; - /** A handler for the menuItemRendered event. */ - onMenuItemRendered?: Function; - /** Specifies whether or not the slide-out menu is displayed. */ - menuVisible?: boolean; - /** Indicates whether the menu can be shown/hidden by swiping the widget's main panel. */ - swipeEnabled?: boolean; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - } - /** The widget that allows you to slide-out the current view to reveal an item list. */ - export class dxSlideOut extends CollectionWidget { - constructor(element: JQuery, options?: dxSlideOutOptions); - constructor(element: Element, options?: dxSlideOutOptions); - /** Hides the widget's slide-out menu. */ - hideMenu(): JQueryPromise; - /** Displays the widget's slide-out menu. */ - showMenu(): JQueryPromise; - /** Toggles the visibility of the widget's slide-out menu. */ - toggleMenuVisibility(showing: boolean): JQueryPromise; - } - export interface dxPivotOptions extends CollectionWidgetOptions { - /** The index of the currently active pivot item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to allow users to switch between items by swiping. */ - swipeEnabled?: boolean; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - /** The template to be used for rendering an item title. */ - itemTitleTemplate?: any; - } - /** A widget that is similar to a traditional tab control, but optimized for the phone with simplified end-user interaction. */ - export class dxPivot extends CollectionWidget { - constructor(element: JQuery, options?: dxPivotOptions); - constructor(element: Element, options?: dxPivotOptions); - } - export interface dxPanoramaOptions extends CollectionWidgetOptions { - /** An object exposing options for setting a background image for the panorama. */ - backgroundImage?: { - /** Specifies the height of the panorama's background image. */ - height?: number; - /** Specifies the URL of the image that is used as the panorama's background image. */ - url?: string; - /** Specifies the width of the panorama's background image. */ - width?: number; - }; - /** The index of the currently active panorama item. */ - selectedIndex?: number; - /** Specifies the widget content title. */ - title?: string; - } - /** A widget displaying the required content in a long horizontal canvas that extends beyond the frames of the screen. */ - export class dxPanorama extends CollectionWidget { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - } - export interface dxDropDownMenuOptions extends WidgetOptions { - /** A handler for the buttonClick event. */ - onButtonClick?: any; - /** The name of the icon to be displayed by the DropDownMenu button. */ - buttonIcon?: string; - /** The text displayed in the DropDownMenu button. */ - buttonText?: string; - buttonIconSrc?: string; - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** A handler for the itemClick event. */ - onItemClick?: any; - /** An array of items displayed by the widget. */ - items?: Array; - /** The template to be used for rendering items. */ - itemTemplate?: any; - /** Specifies whether or not to show the drop down menu within a dxPopover widget. */ - usePopover?: boolean; - /** The width of the menu popup in pixels. */ - popupWidth?: any; - /** The height of the menu popup in pixels. */ - popupHeight?: any; - /** Specifies whether or not the drop-down menu is displayed. */ - opened?: boolean; - hoverStateEnabled?: boolean; - activeStateEnabled?: boolean; - } - /** A drop-down menu widget. */ - export class dxDropDownMenu extends Widget { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - /** Opens the drop-down menu. */ - open(): void; - /** Closes the drop-down menu. */ - close(): void; - } - export interface dxActionSheetOptions extends CollectionWidgetOptions { - /** A handler for the cancelClick event. */ - onCancelClick?: any; - /** The text displayed in the button that closes the action sheet. */ - cancelText?: string; - /** Specifies whether or not to display the Cancel button in action sheet. */ - showCancelButton?: boolean; - /** A Boolean value specifying whether or not the title of the action sheet is visible. */ - showTitle?: boolean; - /** Specifies the element the action sheet popover points at. */ - target?: any; - /** The title of the action sheet. */ - title?: string; - /** Specifies whether or not to show the action sheet within a dxPopover widget. */ - usePopover?: boolean; - /** A Boolean value specifying whether or not the dxActionSheet widget is visible. */ - visible?: boolean; - } - /** A widget consisting of a set of choices related to a certain task. */ - export class dxActionSheet extends CollectionWidget { - constructor(element: JQuery, options?: dxActionSheetOptions); - constructor(element: Element, options?: dxActionSheetOptions); - /** Hides the widget. */ - hide(): JQueryPromise; - /** Shows the widget. */ - show(): JQueryPromise; - /** Shows or hides the widget depending on the Boolean value passed as the parameter. */ - toggle(showing: boolean): JQueryPromise; - } -} -interface JQuery { - dxTileView(): JQuery; - dxTileView(options: "instance"): DevExpress.ui.dxTileView; - dxTileView(options: string): any; - dxTileView(options: string, ...params: any[]): any; - dxTileView(options: DevExpress.ui.dxTileViewOptions): JQuery; - dxSwitch(): JQuery; - dxSwitch(options: "instance"): DevExpress.ui.dxSwitch; - dxSwitch(options: string): any; - dxSwitch(options: string, ...params: any[]): any; - dxSwitch(options: DevExpress.ui.dxSwitchOptions): JQuery; - dxSlideOut(): JQuery; - dxSlideOut(options: "instance"): DevExpress.ui.dxSlideOut; - dxSlideOut(options: string): any; - dxSlideOut(options: string, ...params: any[]): any; - dxSlideOut(options: DevExpress.ui.dxSlideOutOptions): JQuery; - dxPivot(): JQuery; - dxPivot(options: "instance"): DevExpress.ui.dxPivot; - dxPivot(options: string): any; - dxPivot(options: string, ...params: any[]): any; - dxPivot(options: DevExpress.ui.dxPivotOptions): JQuery; - dxPanorama(): JQuery; - dxPanorama(options: "instance"): DevExpress.ui.dxPanorama; - dxPanorama(options: string): any; - dxPanorama(options: string, ...params: any[]): any; - dxPanorama(options: DevExpress.ui.dxPanoramaOptions): JQuery; - dxActionSheet(): JQuery; - dxActionSheet(options: "instance"): DevExpress.ui.dxActionSheet; - dxActionSheet(options: string): any; - dxActionSheet(options: string, ...params: any[]): any; - dxActionSheet(options: DevExpress.ui.dxActionSheetOptions): JQuery; - dxDropDownMenu(): JQuery; - dxDropDownMenu(options: "instance"): DevExpress.ui.dxDropDownMenu; - dxDropDownMenu(options: string): any; - dxDropDownMenu(options: string, ...params: any[]): any; - dxDropDownMenu(options: DevExpress.ui.dxDropDownMenuOptions): JQuery; -} -declare module DevExpress.data { - export interface XmlaStoreOptions { - /** The HTTP address to an XMLA OLAP server. */ - url?: string; - /** The name of the database associated with the Store. */ - catalog?: string; - /** The cube name. */ - cube?: string; - /** A function used to customize a web request before it is sent. */ - beforeSend?: (request: Object) => void; - } - /** A Store that provides access to an OLAP cube using the XMLA standard. */ - export class XmlaStore { - constructor(options: XmlaStoreOptions); - } - export interface PivotGridField { - index?: number; - /** A boolean value specifying whether or not the field is visible in the pivot grid and the Field Chooser. */ - visible?: boolean; - /** Name of the data source field containing data for the pivot grid field. */ - dataField?: string; - /** A caption that will be displayed in the pivot grid's field chooser to identify the field. */ - caption?: string; - /** Specifies a type of field values. */ - dataType?: string; - /** Specifies how the values of the current field are combined into groups. Cannot be used for the XmlaStore store type. */ - groupInterval?: any; - /** Specifies how to aggregate field data. Cannot be used for the XmlaStore store type. */ - summaryType?: string; - /** Allows you to use a custom aggregate function to calculate the summary values. Cannot be used for the XmlaStore store type. */ - calculateCustomSummary?: (options: { - summaryProcess?: string; - value?: any; - totalValue?: any; - }) => void; - /** Specifies the function that determines how to split data from the data source into ranges for header items. Cannot be used for the XmlaStore store type. */ - selector?: (data: Object) => any; - /** Type of the area where the field is located. */ - area?: string; - /** Index among the other fields displayed within the same area. */ - areaIndex?: number; - /** The name of the folder in which the field is located. */ - displayFolder?: string; - /** The name of the group to which the field belongs. */ - groupName?: string; - /** The index of the field within a group. */ - groupIndex?: number; - /** Specifies the sort order of field values. */ - sortOrder?: string; - /** Specifies how field data should be sorted. Can be used for the XmlaStore store type only. */ - sortBy?: string; - /** Sorts the header items of this field by the summary values of another field. */ - sortBySummaryField?: string; - /** The array of field names that specify a path to column/row whose summary field is used for sorting of this field's header items. */ - sortBySummaryPath?: Array; - /** The filter values for the current field. */ - filterValues?: Array; - /** The filter type for the current field. */ - filterType?: string; - /** Indicates whether all header items of the field's header level are expanded. */ - expanded?: boolean; - /** Specifies whether the field should be treated as a Data Field. */ - isMeasure?: boolean; - /** Specifies a display format for field values. */ - format?: string; - /** Specifies a callback function that returns the text to be displayed in the cells of a field. */ - customizeText?: (cellInfo: { value: any; valueText: string }) => string; - /** Specifies a precision for formatted field values. */ - precision?: number; - /** Specifies how to sort the header items. */ - sortingMethod?: (a: Object, b: Object) => number; - /** Allows an end-user to change sorting options. */ - allowSorting?: boolean; - /** Allows an end-user to sort columns by summary values. */ - allowSortingBySummary?: boolean; - /** Allows an end-user to change filtering options. */ - allowFiltering?: boolean; - /** Allows an end-user to expand/collapse all header items within a header level. */ - allowExpandAll?: boolean; - /** Specifies the absolute width of the field in the pivot grid. */ - width?: number; - /** Specifies the summary post-processing algorithm. */ - summaryDisplayMode?: string; - /** Specifies whether to summarize each next summary value with the previous one by rows or columns. */ - runningTotal?: string; - /** Specifies whether to allow the predefined summary post-processing functions ('absoluteVariation' and 'percentVariation') and runningTotal to take values of different groups into account. */ - allowCrossGroupCalculation?: boolean; - /** Specifies a callback function that allows you to modify summary values after they are calculated. */ - calculateSummaryValue?: (e: Object) => number; - /** Specifies whether or not to display Total values for the field. */ - showTotals?: boolean; - /** Specifies whether or not to display Grand Total values for the field. */ - showGrandTotals?: boolean; - } - export class SummaryCell { - /** Gets the parent cell in a specified direction. */ - parent(direction: string): SummaryCell; - /** Gets all children cells in a specified direction. */ - children(direction: string): Array; - /** Gets a partial Grand Total cell of a row or column. */ - grandTotal(direction: string): SummaryCell; - /** Gets the Grand Total of the entire pivot grid. */ - grandTotal(): SummaryCell; - /** Gets the cell next to the current one in a specified direction. */ - next(direction: string): SummaryCell; - /** Gets the cell next to current in a specified direction. */ - next(direction: string, allowCrossGroup: boolean): SummaryCell; - /** Gets the cell prior to the current one in a specified direction. */ - prev(direction: string): SummaryCell; - /** Gets the cell previous to current in a specified direction. */ - prev(direction: string, allowCrossGroup: boolean): SummaryCell; - /** Gets the child cell in a specified direction. */ - child(direction: string, fieldValue: any): SummaryCell; - /** Gets the cell located by the path of the source cell with one field value changed. */ - slice(field: PivotGridField, value: any): SummaryCell; - /** Gets the row or column field to which the current cell belongs. */ - field(area: string): PivotGridField; - /** Gets the value of the current cell. */ - value(): any; - /** Gets the value of the current cell. */ - value(isCalculatedValue: boolean): any; - /** Gets the value of any field linked with the current cell. */ - value(field: PivotGridField): any; - /** Gets the value of any field linked with the current cell. */ - value(field: PivotGridField, isCalculatedValue: boolean): any; - } - export interface PivotGridDataSourceOptions { - /** Specifies the underlying Store instance used to access data. */ - store?: any; - /** Indicates whether or not the automatic field generation from data in the Store is enabled. */ - retrieveFields?: boolean; - /** Specifies data filtering conditions. Cannot be used for the XmlaStore store type. */ - filter?: Object; - /** An array of pivot grid fields. */ - fields?: Array; - /** A handler for the changed event. */ - onChanged?: () => void; - /** A handler for the loadingChanged event. */ - onLoadingChanged?: (isLoading: boolean) => void; - /** A handler for the loadError event. */ - onLoadError?: (e?: Object) => void; - /** A handler for the fieldsPrepared event. */ - onFieldsPrepared?: (e?: Array) => void; - } - /** An object that provides access to data for the dxPivotGrid widget. */ - export class PivotGridDataSource implements EventsMixin { - constructor(options?: PivotGridDataSource); - /** Starts reloading data from any store and updating the data source. */ - reload(): JQueryPromise; - /** Starts updating the data source. Reloads data from the XMLA store only. */ - load(): JQueryPromise; - /** Indicates whether or not the PivotGridDataSource is currently being loaded. */ - isLoading(): boolean; - /** Gets data displayed in a PivotGrid. */ - getData(): Object; - /** Gets all fields within a specified area. */ - getAreaFields(area: string, collectGroups: boolean): Array; - /** Gets all fields from the data source. */ - fields(): Array; - /** Sets the fields option. */ - fields(fields: Array): void; - /** Gets current options of a specified field. */ - field(id: any): PivotGridField; - /** Sets one or more options of a specified field. */ - field(id: any, field: PivotGridField): void; - /** Collapses a specified header item. */ - collapseHeaderItem(area: string, path: Array): void; - /** Expands a specified header item. */ - expandHeaderItem(area: string, path: Array): void; - /** Expands all header items of a field. */ - expandAll(id: any): void; - /** Collapses all header items of a field. */ - collapseAll(id: any): void; - /** Disposes of all resources associated with this PivotGridDataSource. */ - dispose(): void; - /** Gets the current filter expression. Cannot be used for the XmlaStore store type. */ - filter(): Object; - /** Applies a new filter expression. Cannot be used for the XmlaStore store type. */ - filter(filterExpr: Object): void; - /** Provides access to a list of records (facts) that were used to calculate a specific summary. */ - createDrillDownDataSource(options: { - columnPath?: Array; - rowPath?: Array; - dataIndex?: number; - maxRowCount?: number; - customColumns?: Array; - }): DevExpress.data.DataSource; - /** Gets the current PivotGridDataSource state (fields configuration, sorting, filters, expanded headers, etc.) */ - state(): Object; - /** Sets the PivotGridDataSource state. */ - state(state: Object): void; - on(eventName: string, eventHandler: Function): PivotGridDataSource; - on(events: { [eventName: string]: Function; }): PivotGridDataSource; - off(eventName: string): PivotGridDataSource; - off(eventName: string, eventHandler: Function): PivotGridDataSource; - } -} -declare module DevExpress.ui { - export interface dxSchedulerOptions extends WidgetOptions { - /** Specifies a date displayed on the current scheduler view by default. */ - currentDate?: any; - /** The earliest date the widget allows you to select. */ - min?: Date; - /** The latest date the widget allows you to select. */ - max?: Date; - /** Specifies the view used in the scheduler by default. */ - currentView?: string; - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** Specifies the first day of a week. */ - firstDayOfWeek?: number; - /** The template to be used for rendering appointments. */ - appointmentTemplate?: any; - /** The template to be used for rendering an appointment tooltip. */ - appointmentTooltipTemplate?: any; - /** Lists the views to be available within the scheduler's View Selector. */ - views?: Array; - /** Specifies the resource kinds by which the scheduler's appointments are grouped in a timetable. */ - groups?: Array; - /** Specifies a start hour in the scheduler view's time interval. */ - startDayHour?: number; - /** Specifies an end hour in the scheduler view's time interval. */ - endDayHour?: number; - /** Specifies whether or not the "All-day" panel is visible. */ - showAllDayPanel?: boolean; - /** Specifies cell duration in minutes. */ - cellDuration?: number; - /** Specifies the edit mode for recurring appointments. */ - recurrenceEditMode?: string; - /** Specifies which editing operations an end-user can perform on appointments. */ - editing?: { - /** Specifies whether or not an end-user can add appointments. */ - allowAdding?: boolean; - /** Specifies whether or not an end-user can change appointment options. */ - allowUpdating?: boolean; - /** Specifies whether or not an end-user can delete appointments. */ - allowDeleting?: boolean; - /** Specifies whether or not an end-user can change an appointment duration. */ - allowResizing?: boolean; - /** Specifies whether or not an end-user can drag appointments. */ - allowDragging?: boolean; - } - /** Specifies an array of resources available in the scheduler. */ - resources?: Array<{ - /** Indicates whether or not several resources of this kind can be assigned to an appointment. */ - allowMultiple?: boolean; - /** - * Indicates whether or not resources of this kind have priority in the color identification of the appointments that have resources of different kinds assigned. - * @deprecated Use the useColorAsDefault option instead. - */ - mainColor?: boolean; - /** Indicates whether or not resources of this kind have priority in the color identification of the appointments that have resources of different kinds assigned. */ - useColorAsDefault?: boolean; - /** A data source used to fetch resources to be available in the scheduler. */ - dataSource?: any; - /** Specifies the resource object field whose value is displayed by the Resource editor in the Appointment popup window. */ - displayExpr?: any; - /** Specifies the resource object field that is used as a value of the Resource editor in the Appointment popup window. */ - valueExpr?: any; - /** The name of the appointment object field that specifies a resource of this kind. */ - field?: string; - /** Specifies the label of the Appointment popup window field that allows end users to assign a resource of this kind. */ - label?: string; - }>; - /** A handler for the AppointmentAdding event. */ - onAppointmentAdding?: Function; - /** A handler for the appointmentAdded event. */ - onAppointmentAdded?: Function; - /** A handler for the AppointmentUpdating event. */ - onAppointmentUpdating?: Function; - /** A handler for the appointmentUpdated event. */ - onAppointmentUpdated?: Function; - /** A handler for the AppointmentDeleting event. */ - onAppointmentDeleting?: Function; - /** A handler for the appointmentDeleted event. */ - onAppointmentDeleted?: Function; - /** A handler for the appointmentRendered event. */ - onAppointmentRendered?: Function; - /** A handler for the appointmentClick event. */ - onAppointmentClick?: any; - /** A handler for the appointmentDblClick event. */ - onAppointmentDblClick?: any; - /** A handler for the cellClick event. */ - onCellClick?: any; - /** A handler for the appointmentFormCreated event. */ - onAppointmentFormCreated?: Function; - /** Specifies whether or not an end-user can scroll the view horizontally. */ - horizontalScrollingEnabled?: boolean; - /** Specifies whether a user can switch views using tabs or a drop-down menu. */ - useDropDownViewSwitcher?: boolean; - /** Specifies the name of the data source item field that defines the start of an appointment. */ - startDateExpr?: string; - /** Specifies the name of the data source item field that defines the ending of an appointment. */ - endDateExpr?: string; - /** Specifies the name of the data source item field that holds the subject of an appointment. */ - textExpr?: string; - /** Specifies the name of the data source item field whose value holds the description of the corresponding appointment. */ - descriptionExpr?: string; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding appointment is an all-day appointment. */ - allDayExpr?: string; - /** Specifies the name of the data source item field that defines a recurrence rule for generating recurring appointments. */ - recurrenceRuleExpr?: string; - /** Specifies the name of the data source item field that defines exceptions for the current recurring appointment. */ - recurrenceExceptionExpr?: string; - /** Specifies whether filtering is performed on the server or client side. */ - remoteFiltering?: boolean; - } - /** A widget that displays scheduled data using different views and provides the capability to load, add and edit appointments. */ - export class dxScheduler extends Widget { - constructor(element: JQuery, options?: dxSchedulerOptions); - constructor(element: Element, options?: dxSchedulerOptions); - /** Add the appointment defined by the object passed as a parameter to the data associated with the widget. */ - addAppointment(appointment: Object): void; - /** Updates the appointment specified by the first method parameter by the appointment object specified by the second method parameter in the the data associated with the widget. */ - updateAppointment(target: Object, appointment: Object): void; - /** Deletes the appointment defined by the parameter from the the data associated with the widget. */ - deleteAppointment(appointment: Object): void; - /** Scrolls the scheduler work space to the specified time of the specified day. */ - scrollToTime(hours: number, minutes: number, date: Date): void; - /** Displayes the Appointment Details popup. */ - showAppointmentPopup(appointmentData: Object, createNewAppointment?: boolean, currentAppointmentData?: Object): void; - } - export interface dxColorBoxOptions extends dxDropDownEditorOptions { - /** Specifies the text displayed on the button that applies changes and closes the drop-down editor. */ - applyButtonText?: string; - applyValueMode?: string; - /** Specifies the text displayed on the button that cancels changes and closes the drop-down editor. */ - cancelButtonText?: string; - /** Specifies whether or not the widget value includes the alpha channel component. */ - editAlphaChannel?: boolean; - /** Specifies the size of a step by which a handle is moved using a keyboard shortcut. */ - keyStep?: number; - } - /** A widget used to specify a color value. */ - export class dxColorBox extends dxDropDownEditor { - constructor(element: JQuery, options?: dxColorBoxOptions); - constructor(element: Element, options?: dxColorBoxOptions); - } - export interface HierarchicalCollectionWidgetOptions extends CollectionWidgetOptions { - /** Specifies the name of the data source item field whose value is displayed by the widget. */ - displayExpr?: any; - /** Specifies the name of the data source item field used as a key. */ - keyExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding widget items is selected. */ - selectedExpr?: any; - /** Specifies the name of the data source item field that contains an array of nested items. */ - itemsExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding widget item is disabled. */ - disabledExpr?: any; - /** Specifies the name of the data source item field that holds the key of the parent item. */ - parentIdExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding widget items is expanded. */ - expandedExpr?: any; - hoverStateEnabled?: boolean; - focusStateEnabled?: boolean; - } - export class HierarchicalCollectionWidget extends CollectionWidget { - } - export interface dxTreeViewOptions extends HierarchicalCollectionWidgetOptions { - /** Specifies whether or not to animate item collapsing and expanding. */ - animationEnabled?: boolean; - /** Specifies whether a nested or plain array is used as a data source. */ - dataStructure?: string; - /** Specifies whether or not a user can expand all tree view items by the "*" hot key. */ - expandAllEnabled?: boolean; - /** - * Specifies whether or not a check box is displayed at each tree view item. - * @deprecated Use the showCheckBoxesMode options instead. - */ - showCheckBoxes?: boolean; - /** Specifies the current check boxes display mode. */ - showCheckBoxesMode?: string; - /** Specifies whether or not to select nodes recursively. */ - selectNodesRecursive?: boolean; - /** Specifies whether or not all parent nodes of an initially expanded node are displayed expanded. */ - expandNodesRecursive?: boolean; - /** - * Specifies whether the "Select All" check box is displayed over the tree view. - * @deprecated Use the showCheckBoxesMode options instead. - */ - selectAllEnabled?: boolean; - /** Specifies the text displayed at the "Select All" check box. */ - selectAllText?: string; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding node includes child nodes. */ - hasItemsExpr?: any; - /** Specifies if the virtual mode is enabled. */ - virtualModeEnabled?: boolean; - /** Specifies the parent ID value of the root item. */ - rootValue?: any; - /** Specifies the current value used to filter tree view items. */ - searchValue?: string; - /** A string value specifying available scrolling directions. */ - scrollDirection?: string; - /** A handler for the itemSelected event. */ - onItemSelected?: Function; - /** A handler for the itemExpanded event. */ - onItemExpanded?: Function; - /** A handler for the itemCollapsed event. */ - onItemCollapsed?: Function; - onItemClick?: Function; - onItemContextMenu?: Function; - onItemRendered?: Function; - onItemHold?: Function; - } - /** A widget displaying specified data items as a tree. */ - export class dxTreeView extends HierarchicalCollectionWidget { - constructor(element: JQuery, options?: dxTreeViewOptions); - constructor(element: Element, options?: dxTreeViewOptions); - /** Updates the tree view scrollbars according to the current size of the widget content. */ - updateDimensions(): JQueryPromise; - /** Selects the specified item. */ - selectItem(itemElement: any): void; - /** Unselects the specified item. */ - unselectItem(itemElement: any): void; - /** Expands the specified item. */ - expandItem(itemElement: any): void; - /** Collapses the specified item. */ - collapseItem(itemElement: any): void; - /** Returns all nodes of the tree view. */ - getNodes(): Array; - /** Selects all widget items. */ - selectAll(): void; - /** Unselects all widget items. */ - unselectAll(): void; - } - export interface dxMenuBaseOptions extends HierarchicalCollectionWidgetOptions { - /** An object that defines the animation options of the widget. */ - animation?: { - /** An object that defines the animation options used when the widget is being shown. */ - show?: fx.AnimationOptions; - /** An object that defines the animation options used when the widget is being hidden. */ - hide?: fx.AnimationOptions; - }; - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** Specifies the name of the CSS class associated with the menu. */ - cssClass?: string; - /** Holds an array of menu items. */ - items?: Array; - /** Specifies whether or not an item becomes selected if an end-user clicks it. */ - selectionByClick?: boolean; - /** Specifies the selection mode supported by the menu. */ - selectionMode?: string; - /** Specifies options of submenu showing and hiding. */ - showSubmenuMode?: { - /** Specifies the mode name. */ - name?: string; - /** Specifies the delay of submenu show and hiding. */ - delay?: { - /** The time span after which the submenu is shown. */ - show?: number; - /** The time span after which the submenu is hidden. */ - hide?: number; - }; - }; - } - export class dxMenuBase extends HierarchicalCollectionWidget { - constructor(element: JQuery, options?: dxMenuBaseOptions); - constructor(element: Element, options?: dxMenuBaseOptions); - /** Selects the specified item. */ - selectItem(itemElement: any): void; - /** Unselects the specified item. */ - unselectItem(itemElement: any): void; - } - export interface dxMenuOptions extends dxMenuBaseOptions { - /** Specifies whether or not the submenu is hidden when the mouse pointer leaves it. */ - hideSubmenuOnMouseLeave?: boolean; - /** Specifies whether the menu has horizontal or vertical orientation. */ - orientation?: string; - /** Specifies options for showing and hiding the first level submenu. */ - showFirstSubmenuMode?: { - /** Specifies the mode name. */ - name?: string; - /** Specifies the delay in submenu showing and hiding. */ - delay?: { - /** The time span after which the submenu is shown. */ - show?: number; - /** The time span after which the submenu is hidden. */ - hide?: number; - }; - }; - /** Specifies the direction at which the submenus are displayed. */ - submenuDirection?: string; - /** A handler for the submenuHidden event. */ - onSubmenuHidden?: Function; - /** A handler for the submenuHiding event. */ - onSubmenuHiding?: Function; - /** A handler for the submenuShowing event. */ - onSubmenuShowing?: Function; - /** A handler for the submenuShown event. */ - onSubmenuShown?: Function; - } - /** A menu widget. */ - export class dxMenu extends dxMenuBase { - constructor(element: JQuery, options?: dxMenuOptions); - constructor(element: Element, options?: dxMenuOptions); - } - export interface dxContextMenuOptions extends dxMenuBaseOptions { - /** Holds an object that specifies options of alternative menu invocation. */ - alternativeInvocationMode?: { - /** Specifies whether or not the standard context menu invocation (on a right mouse click or on a long tap) is disabled. */ - enabled?: Boolean; - /** Specifies the element used to invoke the context menu. */ - invokingElement?: any; - }; - /** A handler for the hidden event. */ - onHidden?: Function; - /** A handler for the hiding event. */ - onHiding?: Function; - /** A handler for the positioning event. */ - onPositioning?: Function; - /** A handler for the showing event. */ - onShowing?: Function; - /** A handler for the shown event. */ - onShown?: Function; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** Specifies the direction at which submenus are displayed. */ - submenuDirection?: string; - /** The target element associated with a popover. */ - target?: any; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - } - /** A context menu widget. */ - export class dxContextMenu extends dxMenuBase { - constructor(element: JQuery, options?: dxContextMenuOptions); - constructor(element: Element, options?: dxContextMenuOptions); - /** Toggles the visibility of the widget. */ - toggle(showing: boolean): JQueryPromise; - /** Shows the widget. */ - show(): JQueryPromise; - /** Hides the widget. */ - hide(): JQueryPromise; - } - export interface dxRemoteOperations { - /** Specifies whether or not filtering must be performed on the server side. */ - filtering?: boolean; - /** Specifies whether or not paging must be performed on the server side. */ - paging?: boolean; - /** Specifies whether or not sorting must be performed on the server side. */ - sorting?: boolean; - /** Specifies whether or not grouping must be performed on the server side. */ - grouping?: boolean; - /** Specifies whether or not summaries calculation must be performed on the server side. */ - summary?: boolean; - } - export interface dxDataGridRow { - /** The data object represented by the row. */ - data: Object; - /** The key of the data object represented by the row. */ - key: any; - /** The visible index of the row. */ - rowIndex: number; - /** The type of the row. */ - rowType: string; - /** The group index of the row. Available when the rowType is "group". */ - groupIndex: number; - /** Indicates whether the row is expanded or collapsed. Available if rowType is "data", "detail" or "group". */ - isExpanded: boolean; - /** Indicates whether the row is selected. Available if rowType is "data". */ - isSelected: boolean; - /** Values of the row as they exist in the data source. */ - values: Array; - } - export interface dxDataGridColumn { - /** Specifies the content alignment within column cells. */ - alignment?: string; - /** Specifies whether the values in a column can be edited at runtime. Setting this option makes sense only when editing is enabled for a grid. */ - allowEditing?: boolean; - /** Specifies whether or not a column can be used for filtering grid records. Setting this option makes sense only when the filter row and column header filtering are visible. */ - allowFiltering?: boolean; - /** Specifies whether or not to allow filtering by this column using its header. */ - allowHeaderFiltering?: boolean; - /** Specifies whether or not the column can be anchored to a grid edge by end users. Setting this option makes sense only when the columnFixing | enabled option is set to true. */ - allowFixing?: boolean; - /** Specifies if a column can be used for searching grid records. Setting this option makes sense only when the search panel is visible. */ - allowSearch?: boolean; - /** Specifies whether a column can be used for grouping grid records at runtime. Setting this option makes sense only when the group panel is visible. */ - allowGrouping?: boolean; - /** Specifies whether or not a column can be hidden by a user. Setting this option makes sense only when the column chooser is visible. */ - allowHiding?: boolean; - /** Specifies whether or not a particular column can be used in column reordering. Setting this option makes sense only when the allowColumnReordering option is set to true. */ - allowReordering?: boolean; - /** Specifies whether or not a particular column can be resized by a user. Setting this option makes sense only when the allowColumnResizing option is true. */ - allowResizing?: boolean; - /** Specifies whether grid records can be sorted by a specific column at runtime. Setting this option makes sense only when the sorting mode differs from none. */ - allowSorting?: boolean; - /** Specifies whether groups appear expanded or not when records are grouped by a specific column. Setting this option makes sense only when grouping is allowed for this column. */ - autoExpandGroup?: boolean; - /** Specifies a callback function that returns a value to be displayed in a column cell. */ - calculateCellValue?: (rowData: Object) => string; - /** Specifies a callback function to be invoked after the cell value is edited by an end-user and before the new value is saved to the data source. */ - setCellValue?: (rowData: Object, value: any) => void; - /** Specifies a callback function that defines filters for customary calculated grid cells. */ - calculateFilterExpression?: (filterValue: any, selectedFilterOperation: string, target: string) => Array; - /** Specifies a caption for a column. */ - caption?: string; - /** Specifies a custom template for grid column cells. */ - cellTemplate?: any; - /** Specifies a CSS class to be applied to a column. */ - cssClass?: string; - /** Specifies how to get a value to be displayed in a cell when it is not in an editing state. */ - calculateDisplayValue?: any; - /** Specifies a field name or a function that returns a field name or a value to be used for grouping column cells. */ - calculateGroupValue?: any; - /** Specifies a field name or a function that returns a field name or a value to be used for sorting column cells. */ - calculateSortValue?: any; - /** Specifies a callback function that returns the text to be displayed in the cells of a column. */ - customizeText?: (cellInfo: { value: any; valueText: string }) => string; - /** Specifies the field of a data source that provides data for a column. */ - dataField?: string; - /** Specifies the required type of column values. */ - dataType?: string; - /** Specifies a custom template for the cell of a grid column when it is in an editing state. */ - editCellTemplate?: any; - /** Specifies configuration options for the editor widget of the current column. */ - editorOptions?: Object; - /** Specifies whether HTML tags are displayed as plain text or applied to the values of the column. */ - encodeHtml?: boolean; - /** In a boolean column, replaces all false items with a specified text. */ - falseText?: string; - /** Specifies the set of available filter operations. */ - filterOperations?: Array; - /** Specifies a filter value for a column. */ - filterValue?: any; - /** Specifies initial filter values for the column's header filter. */ - filterValues?: Array; - /** Specifies whether to include or exclude the records with the values selected in the column's header filter. */ - filterType?: string; - /** Indicates whether the column takes part in horizontal grid scrolling or is anchored to a grid edge. */ - fixed?: boolean; - /** Specifies the grid edge to which the column is anchored. */ - fixedPosition?: string; - /** Specifies a format for the values displayed in a column. */ - format?: string; - /** Specifies a custom template for the group cell of a grid column. */ - groupCellTemplate?: any; - /** Specifies the index of a column when grid records are grouped by the values of this column. */ - groupIndex?: number; - /** Specifies a custom template for the header of a grid column. */ - headerCellTemplate?: any; - /** Specifies options of a lookup column. */ - lookup?: { - /** Specifies whether or not a user can nullify values of a lookup column. */ - allowClearing?: boolean; - /** Specifies the data source providing data for a lookup column. */ - dataSource?: any; - /** Specifies the expression defining the data source field whose values must be displayed. */ - displayExpr?: any; - /** Specifies the expression defining the data source field whose values must be replaced. */ - valueExpr?: string; - }; - /** Specifies column-level options for filtering using a column header filter. */ - headerFilter?: { - /** Specifies the data source to be used for the header filter. */ - dataSource?: any; - /** Specifies how header filter values should be combined into groups. */ - groupInterval?: any; - }; - /** Specifies a precision for formatted values displayed in a column. */ - precision?: number; - /** Specifies the default filter operation of a column. */ - selectedFilterOperation?: string; - /** Specifies whether or not the column displays its values by using editors. */ - showEditorAlways?: boolean; - /** Specifies whether or not to display the column when grid records are grouped by it. */ - showWhenGrouped?: boolean; - /** Specifies the index of a column when grid records are sorted by the values of this column. */ - sortIndex?: number; - /** Specifies the initial sort order of column values. */ - sortOrder?: string; - /** In a boolean column, replaces all true items with a specified text. */ - trueText?: string; - /** Specifies whether a column is visible or not. */ - visible?: boolean; - /** Specifies the sequence number of the column in the grid. */ - visibleIndex?: number; - /** Specifies a column width in pixels or percentages. */ - width?: any; - /** Specifies an array of validation rules to be checked when updating column cell values. */ - validationRules?: Array; - /** Specifies whether or not to display the header of a hidden column in the column chooser. */ - showInColumnChooser?: boolean; - /** Specifies the identifier of the column. */ - name?: string; - /** The form item configuration object. Used only when the editing mode is "form". */ - formItem?: DevExpress.ui.dxFormItem; - } - export interface dxDataGridOptions extends WidgetOptions { - /** Specifies whether the outer borders of the grid are visible or not. */ - showBorders?: boolean; - /** Indicates whether to show the error row for the grid. */ - errorRowEnabled?: boolean; - /** A handler for the rowValidating event. */ - onRowValidating?: (e: Object) => void; - /** A handler for the contextMenuPreparing event. */ - onContextMenuPreparing?: (e: Object) => void; - /** A handler for the initNewRow event. */ - onInitNewRow?: (e: { data: Object }) => void; - /** A handler for the rowInserted event. */ - onRowInserted?: (e: { data: Object; key: any }) => void; - /** A handler for the rowInserting event. */ - onRowInserting?: (e: { data: Object; cancel: any }) => void; - /** A handler for the rowRemoved event. */ - onRowRemoved?: (e: { data: Object; key: any }) => void; - /** A handler for the rowRemoving event. */ - onRowRemoving?: (e: { data: Object; key: any; cancel: any }) => void; - /** A handler for the rowUpdated event. */ - onRowUpdated?: (e: { data: Object; key: any }) => void; - /** A handler for the rowUpdating event. */ - onRowUpdating?: (e: { oldData: Object; newData: Object; key: any; cancel: any }) => void; - /** Enables a hint that appears when a user hovers the mouse pointer over a cell with truncated content. */ - cellHintEnabled?: boolean; - /** Specifies whether or not grid columns can be reordered by a user. */ - allowColumnReordering?: boolean; - /** Specifies whether or not grid columns can be resized by a user. */ - allowColumnResizing?: boolean; - /** A handler for the cellClick event. */ - onCellClick?: any; - /** A handler for the cellHoverChanged event. */ - onCellHoverChanged?: (e: Object) => void; - /** A handler for the cellPrepared event. */ - onCellPrepared?: (e: Object) => void; - /** Specifies whether or not the width of grid columns depends on column content. */ - columnAutoWidth?: boolean; - /** Specifies the options of a column chooser. */ - columnChooser?: { - /** Specifies text displayed by the column chooser panel when it does not contain any columns. */ - emptyPanelText?: string; - /** Specifies whether a user can invoke the column chooser or not. */ - enabled?: boolean; - /** Specifies the height of the column chooser panel. */ - height?: number; - /** Specifies text displayed in the title of the column chooser panel. */ - title?: string; - /** Specifies the width of the column chooser panel. */ - width?: number; - }; - /** Specifies options for column fixing. */ - columnFixing?: { - /** Indicates if column fixing is enabled. */ - enabled?: boolean; - /** Contains options that specify texts for column-fixing related commands in the column header's context menu. */ - texts?: { - /** Specifies text for a context menu item that fixes the column for which the context menu is invoked. */ - fix?: string; - /** Specifies text for a context menu item that unfixes the column for which the context menu is invoked. */ - unfix?: string; - /** Specifies text for a context menu subitem that fixes a column, for which the context menu is invoked, to the left grid edge. */ - leftPosition?: string; - /** Specifies text for a context menu subitem that fixes a column, for which the context menu is invoked, to the right grid edge. */ - rightPosition?: string; - }; - }; - /** Specifies options for filtering using a column header filter. */ - headerFilter?: { - /** Indicates whether or not the column header filter button is visible. */ - visible?: boolean; - /** Specifies the height of the dropdown menu invoked when using a column header filter. */ - height?: number; - /** Specifies the width of the dropdown menu invoked when using a column header filter. */ - width?: number; - /** Contains options that specify texts for the dropdown menu invoked when you use a column header filter. */ - texts?: { - /** Specifies text for the item specifying an empty value in the column header filter's dropdown menu. */ - emptyValue?: string; - /** Specifies text for a button that closes the column header filter's dropdown menu and applies specified filtering. */ - ok?: string; - /** Specifies text for a button that closes the column header filter's dropdown menu without applying performed selection. */ - cancel?: string; - } - }; - /** An array of grid columns. */ - columns?: Array; - onContentReady?: Function; - /** Specifies a function that customizes grid columns after they are created. */ - customizeColumns?: (columns: Array) => void; - /** Customizes grid columns and data before exporting. */ - customizeExportData?: (columns: Array, rows: Array) => void; - /** Specifies a data source for the grid. */ - dataSource?: any; - /** Specifies whether or not to enable data caching. */ - cacheEnabled?: boolean; - /** A handler for the editingStart event. */ - onEditingStart?: (e: { - data: Object; - key: any; - cancel: boolean; - column: dxDataGridColumn - }) => void; - /** A handler for the editorPrepared event. */ - onEditorPrepared?: (e: Object) => void; - /** A handler for the editorPreparing event. */ - onEditorPreparing?: (e: Object) => void; - /** Contains options that specify how grid content can be changed. */ - editing?: { - editMode?: string; - editEnabled?: boolean; - insertEnabled?: boolean; - removeEnabled?: boolean; - /** Specifies how grid values can be edited manually. */ - mode?: string; - /** Specifies whether or not grid records can be edited at runtime. */ - allowUpdating?: boolean; - /** Specifies whether or not new grid records can be added at runtime. */ - allowAdding?: boolean; - /** Specifies whether or not grid records can be deleted at runtime. */ - allowDeleting?: boolean; - /** The form configuration object. Used only when the editing mode is "form". */ - form?: DevExpress.ui.dxFormOptions; - /** Contains options that specify texts for editing-related grid controls. */ - texts?: { - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Save" button. Setting this option makes sense only when the mode option is set to batch. */ - saveAllChanges?: string; - /** Specifies text for a cancel button displayed when a row is in the editing state. Setting this option makes sense only when the allowUpdating option is set to true. */ - cancelRowChanges?: string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Revert" button. Setting this option makes sense only when the mode option is set to batch. */ - cancelAllChanges?: string; - /** Specifies a message to be displayed by a confirmation window. Setting this option makes sense only when the edit mode is "row". */ - confirmDeleteMessage?: string; - /** Specifies text to be displayed in the title of a confirmation window. Setting this option makes sense only when the edit mode is "row". */ - confirmDeleteTitle?: string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Cancel changes" button. Setting this option makes sense only when the mode option is set to cell and the validation capabilities are enabled. */ - validationCancelChanges?: string; - /** Specifies text for a button that deletes a row from a grid. Setting this option makes sense only when the allowDeleting option is set to true. */ - deleteRow?: string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Add" button. Setting this option makes sense only when the allowAdding option is true. */ - addRow?: string; - /** Specifies text for a button that turns a row into the editing state. Setting this option makes sense only when the allowUpdating option is set to true. */ - editRow?: string; - /** Specifies text for a save button displayed when a row is in the editing state. Setting this option makes sense only when the allowUpdating option is set to true. */ - saveRowChanges?: string; - /** Specifies text for a button that recovers a deleted row. Setting this option makes sense only if the grid uses the batch edit mode and the allowDeleting option is set to true. */ - undeleteRow?: string; - }; - }; - /** Specifies filter row options. */ - filterRow?: { - /** Specifies when to apply a filter. */ - applyFilter?: string; - /** Specifies text for the hint that pops up when a user hovers the mouse pointer over the "Apply Filter" button. */ - applyFilterText?: string; - /** Specifies descriptions for filter operations. */ - operationDescriptions?: { - "=": string; - "<>": string; - "<": string; - "<=": string; - ">": string; - ">=": string; - "startswith": string; - "contains": string; - "notcontains": string; - "endswith": string; - }; - /** Specifies text for the reset operation in a filter list. */ - resetOperationText?: string; - /** Specifies text for the operation of clearing the applied filter when a select box is used. */ - showAllText?: string; - /** Specifies text for the range start in the 'between' filter type. */ - betweenStartText?: string; - /** Specifies text for the range end in the 'between' filter type. */ - betweenEndText?: string; - /** Specifies whether or not an icon that allows the user to choose a filter operation is visible. */ - showOperationChooser?: boolean; - /** Specifies whether the filter row is visible or not. */ - visible?: boolean; - }; - /** Specifies the behavior of grouped grid records. */ - grouping?: { - /** Specifies whether the user can collapse grouped records in a grid or not. */ - allowCollapsing?: boolean; - /** Specifies whether groups appear expanded or not. */ - autoExpandAll?: boolean; - /** Specifies the message displayed in a group row when the corresponding group is continued from the previous page. */ - groupContinuedMessage?: string; - /** Specifies the message displayed in a group row when the corresponding group continues on the next page. */ - groupContinuesMessage?: string; - }; - /** Specifies options that configure the group panel. */ - groupPanel?: { - /** Specifies whether columns can be dragged onto or from the group panel. */ - allowColumnDragging?: boolean; - /** Specifies text displayed by the group panel when it does not contain any columns. */ - emptyPanelText?: string; - /** Specifies whether the group panel is visible or not. */ - visible?: boolean; - }; - /** Specifies options configuring the load panel. */ - loadPanel?: { - /** Specifies whether to show the load panel or not. */ - enabled?: boolean; - /** Specifies the height of the load panel in pixels. */ - height?: number; - /** Specifies a URL pointing to an image to be used as a loading indicator. */ - indicatorSrc?: string; - /** Specifies whether or not a loading indicator must be displayed on the load panel. */ - showIndicator?: boolean; - /** Specifies whether or not the pane of the load panel must be displayed. */ - showPane?: boolean; - /** Specifies text displayed by the load panel. */ - text?: string; - /** Specifies the width of the load panel in pixels. */ - width?: number; - }; - /** Specifies text displayed when a grid does not contain any records. */ - noDataText?: string; - /** Specifies the options of a grid pager. */ - pager?: { - /** Specifies the page sizes that can be selected at runtime. */ - allowedPageSizes?: any; - /** Specifies whether to show the page size selector or not. */ - showPageSizeSelector?: boolean; - /** Specifies whether to show the pager or not. */ - visible?: any; - /** Specifies the text accompanying the page navigator. */ - infoText?: string; - /** Specifies whether or not to display the text accompanying the page navigator. This text is specified by the infoText option. */ - showInfo?: boolean; - /** Specifies whether or not to display buttons that switch the grid to the previous or next page. */ - showNavigationButtons?: boolean; - }; - /** Specifies paging options. */ - paging?: { - /** Specifies whether dxDataGrid loads data page by page or all at once. */ - enabled?: boolean; - /** Specifies the grid page that should be displayed by default. */ - pageIndex?: number; - /** Specifies the size of grid pages. */ - pageSize?: number; - }; - /** Specifies whether or not grid rows must be shaded in a different way. */ - rowAlternationEnabled?: boolean; - /** Specifies whether to enable two-way data binding. */ - twoWayBindingEnabled?: boolean; - /** A handler for the rowClick event. */ - onRowClick?: any; - /** A handler for the rowPrepared event. */ - onRowPrepared?: (e: Object) => void; - /** Specifies a custom template for grid rows. */ - rowTemplate?: any; - /** A configuration object specifying scrolling options. */ - scrolling?: { - /** Specifies the scrolling mode. */ - mode?: string; - /** Specifies whether or not a grid must preload pages adjacent to the current page when using virtual scrolling. */ - preloadEnabled?: boolean; - /** Specifies whether or not the widget uses native scrolling. */ - useNative?: any; - /** Specifies the scrollbar display policy. */ - showScrollbar?: string; - /** Specifies whether or not the scrolling by content is enabled. */ - scrollByContent?: boolean; - /** Specifies whether or not the scrollbar thumb scrolling enabled. */ - scrollByThumb?: boolean; - }; - /** Specifies options of the search panel. */ - searchPanel?: { - /** Specifies whether or not search strings in the located grid records should be highlighted. */ - highlightSearchText?: boolean; - /** Specifies text displayed by the search panel when no search string was typed. */ - placeholder?: string; - /** Specifies whether the search panel is visible or not. */ - visible?: boolean; - /** Specifies the width of the search panel in pixels. */ - width?: number; - /** Sets a search string for the search panel. */ - text?: string; - }; - /** Specifies the operations that must be performed on the server side. */ - remoteOperations?: any; - /** Allows you to sort groups according to the values of group summary items. */ - sortByGroupSummaryInfo?: Array<{ - /** Specifies the group summary item whose values must be used to sort groups. */ - summaryItem?: string; - /** Specifies the identifier of the column that must be used in grouping so that sorting by group summary item values be applied. */ - groupColumn?: string; - /** Specifies the sort order of group summary item values. */ - sortOrder?: string; - }>; - /** Allows you to build a master-detail interface in the grid. */ - masterDetail?: { - /** Enables an end-user to expand/collapse detail sections. */ - enabled?: boolean; - /** Specifies whether detail sections appear expanded or collapsed. */ - autoExpandAll?: boolean; - /** Specifies the template for detail sections. */ - template?: any; - }; - /** Specifies options for exporting grid data. */ - export?: { - /** Indicates if the export feature is enabled in the grid. */ - enabled?: boolean; - /** Specifies a default name for the file to which grid data is exported. */ - fileName?: string; - /** Specifies whether to enable Excel filtering for the exported data in the resulting XLSX file. */ - excelFilterEnabled?: boolean; - /** Specifies whether to enable word wrapping for the exported data in the resulting XLSX file. */ - excelWrapTextEnabled?: boolean; - /** Specifies the URL of the server-side proxy that streams the resulting file to the end user to enable export in IE8, IE9 and Safari browsers. */ - proxyUrl?: string; - /** Indicates whether to allow end users to export not only the data displayed in the grid, but the selected rows only. */ - allowExportSelectedData?: boolean; - /** Contains options that specify texts for the export-related commands and hints. */ - texts?: { - /** Specifies text for the Export button when this button invokes a dropdown menu so you can choose the required export format. */ - exportTo?: string; - /** Specifies text for the Export button's hint when this button exports to the XSLX format without invoking the drop-down menu. */ - exportToExcel?: string; - /** Specifies text for the item in the Export dropdown menu that exports grid data to Excel. */ - excelFormat?: string; - /** Specifies text for the option in the Export dropdown menu that allows you to choose whether to export all the grid data or the selected rows only. */ - selectedRows?: string; - } - }; - /** Specifies the keys of the records that must appear selected initially. */ - selectedRowKeys?: Array; - /** Specifies options of runtime selection. */ - selection?: { - /** Specifies the checkbox row display policy in the multiple mode. */ - showCheckBoxesMode?: string; - /** Specifies whether the user can select all grid records at once. */ - allowSelectAll?: boolean; - /** Specifies the selection mode. */ - mode?: string; - }; - /** A handler for the dataErrorOccured event. */ - onDataErrorOccurred?: (e: { error: Error }) => void; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: (e: { - currentSelectedRowKeys: Array; - currentDeselectedRowKeys: Array; - selectedRowKeys: Array; - selectedRowsData: Array; - }) => void; - /** A handler for the exporting event. */ - onExporting?: (e: { - fileName: string; - cancel: boolean; - }) => void; - /** A handler for the fileSaving event. */ - onFileSaving?: (e: { - fileName: string; - format: string; - data: any; - cancel: boolean; - }) => void; - /** A handler for the exported event. */ - onExported?: (e: Object) => void; - /** A handler for the keyDown event. */ - onKeyDown?: (e: Object) => void; - /** A handler for the rowExpanding event. */ - onRowExpanding?: (e: Object) => void; - /** A handler for the rowExpanded event. */ - onRowExpanded?: (e: Object) => void; - /** A handler for the rowCollapsing event. */ - onRowCollapsing?: (e: Object) => void; - /** A handler for the rowCollapsed event. */ - onRowCollapsed?: (e: Object) => void; - /** Specifies whether column headers are visible or not. */ - showColumnHeaders?: boolean; - /** Specifies whether or not vertical lines separating one grid column from another are visible. */ - showColumnLines?: boolean; - /** Specifies whether or not horizontal lines separating one grid row from another are visible. */ - showRowLines?: boolean; - /** Specifies options of runtime sorting. */ - sorting?: { - /** Specifies text for the context menu item that sets an ascending sort order in a column. */ - ascendingText?: string; - /** Specifies text for the context menu item that resets sorting settings for a column. */ - clearText?: string; - /** Specifies text for the context menu item that sets a descending sort order in a column. */ - descendingText?: string; - /** Specifies the runtime sorting mode. */ - mode?: string; - }; - /** Specifies options of state storing. */ - stateStoring?: { - /** Specifies a callback function that performs specific actions on state loading. */ - customLoad?: () => JQueryPromise; - /** Specifies a callback function that performs specific actions on state saving. */ - customSave?: (state: Object) => void; - /** Specifies whether or not a grid saves its state. */ - enabled?: boolean; - /** Specifies the delay between the last change of a grid state and the operation of saving this state in milliseconds. */ - savingTimeout?: number; - /** Specifies a unique key to be used for storing the grid state. */ - storageKey?: string; - /** Specifies the type of storage to be used for state storing. */ - type?: string; - }; - /** Specifies the options of the grid summary. */ - summary?: { - /** Contains options that specify text patterns for summary items. */ - texts?: { - /** Specifies a pattern for the 'sum' summary items when they are displayed in the parent column. */ - sum?: string; - /** Specifies a pattern for the 'sum' summary items displayed in a group row or in any other column rather than the parent one. */ - sumOtherColumn?: string; - /** Specifies a pattern for the 'min' summary items when they are displayed in the parent column. */ - min?: string; - /** Specifies a pattern for the 'min' summary items displayed in a group row or in any other column rather than the parent one. */ - minOtherColumn?: string; - /** Specifies a pattern for the 'max' summary items when they are displayed in the parent column. */ - max?: string; - /** Specifies a pattern for the 'max' summary items displayed in a group row or in any other column rather than the parent one. */ - maxOtherColumn?: string; - /** Specifies a pattern for the 'avg' summary items when they are displayed in the parent column. */ - avg?: string; - /** Specifies a pattern for the 'avg' summary items displayed in a group row or in any other column rather than the parent one. */ - avgOtherColumn?: string; - /** Specifies a pattern for the 'count' summary items. */ - count?: string; - }; - /** Specifies items of the group summary. */ - groupItems?: Array<{ - /** Specifies the identifier of a summary item. */ - name?: string; - /** Specifies the column that provides data for a group summary item. */ - column?: string; - /** Customizes the text to be displayed in the summary item. */ - customizeText?: (itemInfo: { - value: any; - valueText: string; - }) => string; - /** Specifies a pattern for the summary item text. */ - displayFormat?: string; - /** Specifies a precision for the summary item value of a numeric format. */ - precision?: number; - /** Specifies whether or not a summary item must be displayed in the group footer. */ - showInGroupFooter?: boolean; - /** Indicates whether to display group summary items in parentheses after the group row header or to align them by the corresponding columns within the group row. */ - alignByColumn?: boolean; - /** Specifies the column that must hold the summary item when this item is displayed in the group footer or aligned by a column in the group row. */ - showInColumn?: string; - /** Specifies how to aggregate data for a summary item. */ - summaryType?: string; - /** Specifies a format for the summary item value. */ - valueFormat?: string; - /** Specifies whether or not to skip empty strings, null and undefined values when calculating a summary. */ - skipEmptyValues?: boolean; - }>; - /** Specifies items of the total summary. */ - totalItems?: Array<{ - /** Specifies the identifier of a summary item. */ - name?: string; - /** Specifies the alignment of a summary item. */ - alignment?: string; - /** Specifies the column that provides data for a summary item. */ - column?: string; - /** Specifies a CSS class to be applied to a summary item. */ - cssClass?: string; - /** Customizes the text to be displayed in the summary item. */ - customizeText?: (itemInfo: { - value: any; - valueText: string; - }) => string; - /** Specifies a pattern for the summary item text. */ - displayFormat?: string; - /** Specifies a precision for the summary item value of a numeric format. */ - precision?: number; - /** Specifies the column that must hold the summary item. */ - showInColumn?: string; - /** Specifies how to aggregate data for a summary item. */ - summaryType?: string; - /** Specifies a format for the summary item value. */ - valueFormat?: string; - /** Specifies whether or not to skip empty strings, null and undefined values when calculating a summary. */ - skipEmptyValues?: boolean; - }>; - /** Specifies whether or not to skip empty strings, null and undefined values when calculating a summary. */ - skipEmptyValues?: boolean; - /** Allows you to use a custom aggregate function to calculate the value of a summary item. */ - calculateCustomSummary?: (options: { - component: dxDataGrid; - name?: string; - value: any; - totalValue: any; - summaryProcess: string - }) => void; - }; - /** Specifies whether text that does not fit into a column should be wrapped. */ - wordWrapEnabled?: boolean; - } - /** A data grid widget. */ - export class dxDataGrid extends Widget { - constructor(element: JQuery, options?: dxDataGridOptions); - constructor(element: Element, options?: dxDataGridOptions); - /** Ungroups grid records. */ - clearGrouping(): void; - /** Clears sorting settings of all grid columns at once. */ - clearSorting(): void; - /** Allows you to obtain a cell by its row index and the data field of its column. */ - getCellElement(rowIndex: number, dataField: string): any; - /** Allows you to obtain a cell by its row index and the visible index of its column. */ - getCellElement(rowIndex: number, visibleColumnIndex: number): any; - /** Returns the current state of the grid. */ - state(): Object; - /** Sets the grid state. */ - state(state: Object): void; - /** Allows you to obtain the row index by a data key. */ - getRowIndexByKey(key: any): number; - /** Allows you to obtain the data key by a row index. */ - getKeyByRowIndex(rowIndex: number): any; - /** Adds a new column to a grid. */ - addColumn(columnOptions: dxDataGridColumn): void; - /** Removes the column from the grid. */ - deleteColumn(id: any): void; - /** Displays the load panel. */ - beginCustomLoading(messageText: string): void; - /** Discards changes made in a grid. */ - cancelEditData(): void; - /** Checks whether or not the grid contains unsaved changes. */ - hasEditData(): boolean; - /** Clears all the filters of a specific type applied to grid records. */ - clearFilter(): void; - /** Deselects all grid records. */ - clearSelection(): void; - /** Draws the cell being edited from the editing state. Use this method when the edit mode is batch. */ - closeEditCell(): void; - /** Collapses groups or master rows in a grid. */ - collapseAll(groupIndex?: number): void; - /** Returns the number of data columns in a grid. */ - columnCount(): number; - /** Returns the value of a specific column option. */ - columnOption(id: any, optionName: string): any; - /** Sets an option of a specific column. */ - columnOption(id: any, optionName: string, optionValue: any): void; - /** Returns the options of a column by an identifier. */ - columnOption(id: any): Object; - /** Sets several options of a column at once. */ - columnOption(id: any, options: Object): void; - /** Sets a specific cell into the editing state. */ - editCell(rowIndex: number, visibleColumnIndex: number): void; - /** Sets a specific cell into the editing state. */ - editCell(rowIndex: number, dataField: string): void; - /** Sets a specific row into the editing state. */ - editRow(rowIndex: number): void; - /** Gets the cell value. */ - cellValue(rowIndex: number, dataField: string): any; - /** Gets the cell value. */ - cellValue(rowIndex: number, visibleColumnIndex: number): any; - /** Sets the cell value. */ - cellValue(rowIndex: number, dataField: string, value: any): void; - /** Sets the cell value. */ - cellValue(rowIndex: number, visibleColumnIndex: number, value: any): void; - /** Hides the load panel. */ - endCustomLoading(): void; - /** Expands groups or master rows in a grid. */ - expandAll(groupIndex: number): void; - /** Allows you to find out whether a specific group or master row is expanded or collapsed. */ - isRowExpanded(key: any): boolean; - /** Allows you to expand a specific group or master row by its key. */ - expandRow(key: any): void; - /** Allows you to collapse a specific group or master row by its key. */ - collapseRow(key: any): void; - /** Applies a filter to the grid's data source. */ - filter(filterExpr?: any): void; - /** Returns a filter expression applied to the grid's data source using the filter(filterExpr) method. */ - filter(): any; - /** Returns a filter expression applied to the grid using all possible scenarious. */ - getCombinedFilter(): any; - /** Gets the keys of currently selected grid records. */ - getSelectedRowKeys(): Array; - /** Gets the data objects of currently selected grid records. */ - getSelectedRowsData(): Array; - /** Hides the column chooser panel. */ - hideColumnChooser(): void; - /** Adds a new data row to a grid. */ - addRow(): void; - /** - * Adds a new data row to a grid. - * @deprecated Use the addRow() method instead. - */ - insertRow(): void; - /** Returns the key corresponding to the passed data object. */ - keyOf(obj: Object): any; - /** Switches a grid to a specified page. */ - pageIndex(newIndex: number): void; - /** Gets the index of the current page. */ - pageIndex(): number; - /** Sets the page size. */ - pageSize(value: number): void; - /** Gets the current page size. */ - pageSize(): number; - /** Refreshes grid data. */ - refresh(): JQueryPromise; - /** Removes a specific row from a grid. */ - deleteRow(rowIndex: number): void; - /** - * Removes a specific row from a grid. - * @deprecated Use the deleteRow(rowIndex) method instead. - */ - removeRow(rowIndex: number): void; - /** Saves changes made in a grid. */ - saveEditData(): JQueryPromise; - /** Searches grid records by a search string. */ - searchByText(text: string): void; - /** Selects all grid records. */ - selectAll(): void; - /** Deselects the rows that are currently selected within the applied filter. */ - deselectAll(): void; - /** Selects specific grid records. */ - selectRows(keys: Array, preserve: boolean): void; - /** Deselects specific grid records. */ - deselectRows(keys: Array): void; - /** Selects grid rows by indexes. */ - selectRowsByIndexes(indexes: Array): void; - /** Allows you to find out whether a row is selected or not. */ - isRowSelected(key: any): boolean; - /** Invokes the column chooser panel. */ - showColumnChooser(): void; - startSelectionWithCheckboxes(): boolean; - /** Returns the number of records currently held by a grid. */ - totalCount(): number; - /** Recovers a row deleted in the batch edit mode. */ - undeleteRow(rowIndex: number): void; - /** Allows you to obtain a data object by its key. */ - byKey(key: any): JQueryPromise; - /** Gets the value of a total summary item. */ - getTotalSummaryValue(summaryItemName: string): any; - /** Exports grid data to Excel. */ - exportToExcel(selectionOnly: boolean): void; - /** Updates the grid to the size of its content. */ - updateDimensions(): void; - /** Focuses the specified cell element in the grid. */ - focus(element?: JQuery): void; - } - export interface dxPivotGridOptions extends WidgetOptions { - onContentReady?: Function; - /** Specifies a data source for the pivot grid. */ - dataSource?: any; - useNativeScrolling?: any; - /** A configuration object specifying scrolling options. */ - scrolling?: { - /** Specifies the scrolling mode. */ - mode?: string; - /** Specifies whether or not the widget uses native scrolling. */ - useNative?: any; - }; - /** Allows an end-user to change sorting options. */ - allowSorting?: boolean; - /** Allows an end-user to sort columns by summary values. */ - allowSortingBySummary?: boolean; - /** Allows an end-user to change filtering options. */ - allowFiltering?: boolean; - /** Allows an end-user to expand/collapse all header items within a header level. */ - allowExpandAll?: boolean; - /** Specifies whether to display the Total rows. */ - showRowTotals?: boolean; - /** Specifies whether to display the Grand Total row. */ - showRowGrandTotals?: boolean; - /** Specifies whether to display the Total columns. */ - showColumnTotals?: boolean; - /** Specifies whether to display the Grand Total column. */ - showColumnGrandTotals?: boolean; - /** Specifies whether or not to hide rows and columns with no data. */ - hideEmptySummaryCells?: boolean; - /** Specifies where to show the total rows or columns. */ - showTotalsPrior?: string; - /** Specifies whether the outer borders of the grid are visible or not. */ - showBorders?: boolean; - /** The Field Chooser configuration options. */ - fieldChooser?: { - /** Enables or disables the field chooser. */ - enabled?: boolean; - /** Specifies the field chooser layout. */ - layout?: number; - /** Specifies the text to display as a title of the field chooser popup window. */ - title?: string; - /** Specifies the field chooser width. */ - width?: number; - /** Specifies the field chooser height. */ - height?: number; - /** Strings that can be changed or localized in the pivot grid's integrated Field Chooser. */ - texts?: { - /** The string to display instead of Row Fields. */ - rowFields?: string; - /** The string to display instead of Column Fields. */ - columnFields?: string; - /** The string to display instead of Data Fields. */ - dataFields?: string; - /** The string to display instead of Filter Fields. */ - filterFields?: string; - /** The string to display instead of All Fields. */ - allFields?: string; - }; - } - /** Strings that can be changed or localized in the dxPivotGrid widget. */ - texts?: { - /** The string to display as a header of the Grand Total row and column. */ - grandTotal?: string; - /** The string to display as a header of the Total row and column. */ - total?: string; - /** Specifies the text displayed when a pivot grid does not contain any fields. */ - noData?: string; - /** The string to display as a Show Field Chooser context menu item. */ - showFieldChooser?: string; - /** The string to display as an Expand All context menu item. */ - expandAll?: string; - /** The string to display as a Collapse All context menu item. */ - collapseAll?: string; - /** The string to display as a Sort Column by Summary Value context menu item. */ - sortColumnBySummary?: string; - /** The string to display as a Sort Row by Summary Value context menu item. */ - sortRowBySummary?: string; - /** The string to display as a Remove All Sorting context menu item. */ - removeAllSorting?: string; - /** The string to display as an Export to Excel file context menu item. */ - exportToExcel?: string; - }; - /** Specifies options configuring the load panel. */ - loadPanel?: { - /** Enables or disables the load panel. */ - enabled?: boolean; - /** Specifies the height of the load panel. */ - height?: number; - /** Specifies the URL pointing to an image that will be used as a load indicator. */ - indicatorSrc?: string; - /** Specifies whether or not to show a load indicator. */ - showIndicator?: boolean; - /** Specifies whether or not to show load panel background. */ - showPane?: boolean; - /** Specifies the text to display inside a load panel. */ - text?: string; - /** Specifies the width of the load panel. */ - width?: number; - }; - /** A handler for the cellClick event. */ - onCellClick?: (e: any) => void; - /** A handler for the cellPrepared event. */ - onCellPrepared?: (e: any) => void; - /** A handler for the contextMenuPreparing event. */ - onContextMenuPreparing?: (e: Object) => void; - /** Specifies options for exporting pivot grid data. */ - export?: { - /** Indicates whether the export feature is enabled for the pivot grid. */ - enabled?: boolean; - /** Specifies a default name for the file to which grid data is exported. */ - fileName?: string; - /** Specifies the URL of the server-side proxy that streams the resulting file to the end user to enable export in IE8, IE9 and Safari browsers. */ - proxyUrl?: string; - }; - /** A handler for the exporting event. */ - onExporting?: (e: { - fileName: string; - cancel: boolean; - }) => void; - /** A handler for the fileSaving event. */ - onFileSaving?: (e: { - fileName: string; - format: string; - data: any; - cancel: boolean; - }) => void; - /** A handler for the exported event. */ - onExported?: (e: Object) => void; - /** A configuration object specifying options related to state storing. */ - stateStoring?: { - /** Specifies a callback function that performs specific actions on state loading. */ - customLoad?: () => JQueryPromise; - /** Specifies a callback function that performs specific actions on state saving. */ - customSave?: (gridState: Object) => void; - /** Specifies whether or not a grid saves its state. */ - enabled?: boolean; - /** Specifies the delay between the last change of a grid state and the operation of saving this state in milliseconds. */ - savingTimeout?: number; - /** Specifies a unique key to be used for storing the grid state. */ - storageKey?: string; - /** Specifies the type of storage to be used for state storing. */ - type?: string; - }; - } - /** A data summarization widget for multi-dimensional data analysis and data mining. */ - export class dxPivotGrid extends Widget { - constructor(element: JQuery, options?: dxPivotGridOptions); - constructor(element: Element, options?: dxPivotGridOptions); - /** Gets the PivotGridDataSource instance. */ - getDataSource(): DevExpress.data.PivotGridDataSource; - /** Gets the dxPopup instance of the field chooser window. */ - getFieldChooserPopup(): DevExpress.ui.dxPopup; - /** Updates the widget to the size of its content. */ - updateDimensions(): void; - /** Exports pivot grid data to the Excel file. */ - exportToExcel(): void; - } - export interface dxPivotGridFieldChooserOptions extends WidgetOptions { - /** Specifies the height of the widget. */ - height?: any; - /** Specifies the field chooser layout. */ - layout?: number; - /** The data source of a dxPivotGrid widget. */ - dataSource?: DevExpress.data.PivotGridDataSource; - onContentReady?: Function; - /** Strings that can be changed or localized in the dxPivotGridFieldChooser widget. */ - texts?: { - /** The string to display instead of Row Fields. */ - rowFields?: string; - /** The string to display instead of Column Fields. */ - columnFields?: string; - /** The string to display instead of Data Fields. */ - dataFields?: string; - /** The string to display instead of Filter Fields. */ - filterFields?: string; - /** The string to display instead of All Fields. */ - allFields?: string; - }; - } - /** A complementary widget for dxPivotGrid that allows you to manage data displayed in the dxPivotGrid. */ - export class dxPivotGridFieldChooser extends Widget { - constructor(element: JQuery, options?: dxPivotGridFieldChooserOptions); - constructor(element: Element, options?: dxPivotGridFieldChooserOptions); - /** Updates the widget to the size of its content. */ - updateDimensions(): void; - } -} -interface JQuery { - dxTreeView(): JQuery; - dxTreeView(options: "instance"): DevExpress.ui.dxTreeView; - dxTreeView(options: string): any; - dxTreeView(options: string, ...params: any[]): any; - dxTreeView(options: DevExpress.ui.dxTreeViewOptions): JQuery; - dxMenuBase(): JQuery; - dxMenuBase(options: "instance"): DevExpress.ui.dxMenuBase; - dxMenuBase(options: string): any; - dxMenuBase(options: string, ...params: any[]): any; - dxMenuBase(options: DevExpress.ui.dxMenuBaseOptions): JQuery; - dxMenu(): JQuery; - dxMenu(options: "instance"): DevExpress.ui.dxMenu; - dxMenu(options: string): any; - dxMenu(options: string, ...params: any[]): any; - dxMenu(options: DevExpress.ui.dxMenuOptions): JQuery; - dxContextMenu(): JQuery; - dxContextMenu(options: "instance"): DevExpress.ui.dxContextMenu; - dxContextMenu(options: string): any; - dxContextMenu(options: string, ...params: any[]): any; - dxContextMenu(options: DevExpress.ui.dxContextMenuOptions): JQuery; - dxColorBox(): JQuery; - dxColorBox(options: "instance"): DevExpress.ui.dxColorBox; - dxColorBox(options: string): any; - dxColorBox(options: string, ...params: any[]): any; - dxColorBox(options: DevExpress.ui.dxColorBoxOptions): JQuery; - dxDataGrid(): JQuery; - dxDataGrid(options: "instance"): DevExpress.ui.dxDataGrid; - dxDataGrid(options: string): any; - dxDataGrid(options: string, ...params: any[]): any; - dxDataGrid(options: DevExpress.ui.dxDataGridOptions): JQuery; - dxPivotGrid(): JQuery; - dxPivotGrid(options: "instance"): DevExpress.ui.dxPivotGrid; - dxPivotGrid(options: string): any; - dxPivotGrid(options: string, ...params: any[]): any; - dxPivotGrid(options: DevExpress.ui.dxPivotGridOptions): JQuery; - dxPivotGridFieldChooser(): JQuery; - dxPivotGridFieldChooser(options: "instance"): DevExpress.ui.dxPivotGridFieldChooser; - dxPivotGridFieldChooser(options: string): any; - dxPivotGridFieldChooser(options: string, ...params: any[]): any; - dxPivotGridFieldChooser(options: DevExpress.ui.dxPivotGridFieldChooserOptions): JQuery; - dxScheduler(): JQuery; - dxScheduler(options: "instance"): DevExpress.ui.dxScheduler; - dxScheduler(options: string): any; - dxScheduler(options: string, ...params: any[]): any; - dxScheduler(options: DevExpress.ui.dxSchedulerOptions): JQuery; -} -declare module DevExpress.framework { - /** An object used to store information on the views displayed in an application. */ - export class ViewCache { - viewRemoved: JQueryCallback; - /** Removes all the viewInfo objects from the cache. */ - clear(): void; - /** Obtains a viewInfo object from the cache by the specified key. */ - getView(key: string): Object; - /** Checks whether or not a viewInfo object is contained in the view cache under the specified key. */ - hasView(key: string): boolean; - /** Removes a viewInfo object from the cache by the specified key. */ - removeView(key: string): Object; - /** Adds the specified viewInfo object to the cache under the specified key. */ - setView(key: string, viewInfo: Object): void; - } - export interface dxCommandOptions extends DOMComponentOptions { - /** Specifies an action performed when the execute() method of the command is called. */ - onExecute?: any; - /** Indicates whether or not the widget that displays this command is disabled. */ - disabled?: boolean; - /** Specifies whether the current command is rendered when a view is being rendered or after a view is shown. */ - renderStage?: string; - /** Specifies the name of the icon shown inside the widget associated with this command. */ - icon?: string; - iconSrc?: string; - /** The identifier of the command. */ - id?: string; - /** Specifies the title of the widget associated with this command. */ - title?: string; - /** Specifies the type of the button, if the command is rendered as a dxButton widget. */ - type?: string; - /** A Boolean value specifying whether or not the widget associated with this command is visible. */ - visible?: boolean; - } - /** A markup component used to define markup options for a command. */ - export class dxCommand extends DOMComponent { - constructor(element: JQuery, options: dxCommandOptions); - constructor(options: dxCommandOptions); - /** Executes the action associated with this command. */ - execute(): void; - } - /** An object responsible for routing. */ - export class Router { - /** Adds a routing rule to the list of registered rules. */ - register(pattern: string, defaults?: Object, constraints?: Object): void; - /** Decodes the specified URI to an object using the registered routing rules. */ - parse(uri: string): Object; - /** Formats an object to a URI. */ - format(obj: Object): string; - } - export interface StateManagerOptions { - /** A storage to which the state manager saves the application state. */ - storage?: Object; - } - /** An object used to store the current application state. */ - export class StateManager { - constructor(options?: StateManagerOptions); - /** Adds an object that implements an interface of a state source to the state manager's collection of state sources. */ - addStateSource(stateSource: Object): void; - /** Removes a specified state source from the state manager's collection of state sources. */ - removeStateSource(stateSource: Object): void; - /** Saves the current application state. */ - saveState(): void; - /** Restores the application state that has been saved by the saveState() method to the state storage. */ - restoreState(): void; - /** Removes the application state that has been saved by the saveState() method to the state storage. */ - clearState(): void; - } - export module html { - export var layoutSets: Array; - export var animationSets: { [animationSetName: string]: AnimationSet }; - export interface AnimationSet { - [animationName: string]: any - } - export interface HtmlApplicationOptions { - /** Specifies where the commands that are defined in the application's views must be displayed. */ - commandMapping?: Object; - /** Specifies whether or not view caching is disabled. */ - disableViewCache?: boolean; - /** An array of layout controllers that should be used to show application views in the current navigation context. */ - layoutSet?: any; - /** Specifies the animation presets that are used to animate different UI elements in the current application. */ - animationSet?: AnimationSet; - /** Specifies whether the current application must behave as a mobile or web application. */ - mode?: string; - /** Specifies the object that represents a root namespace of the application. */ - namespace?: Object; - /** Specifies application behavior when the user navigates to a root view. */ - navigateToRootViewMode?: string; - /** An array of dxCommand configuration objects used to define commands available from the application's global navigation. */ - navigation?: Array; - /** A state manager to be used in the application. */ - stateManager?: StateManager; - /** Specifies the storage to be used by the application's state manager to store the application state. */ - stateStorage?: Object; - /** Indicates whether on not to use the title of the previously displayed view as text on the Back button. */ - useViewTitleAsBackText?: boolean; - /** A custom view cache to be used in the application. */ - viewCache?: Object; - /** Specifies a limit for the views that can be cached. */ - viewCacheSize?: number; - /** Specifies the current version of application templates. */ - templatesVersion?: string; - /** Specifies options for the viewport meta tag of a mobile browser. */ - viewPort?: JQuery; - /** A custom router to be used in the application. */ - router?: Router; - } - /** An object used to manage views, as well as control the application life cycle. */ - export class HtmlApplication implements EventsMixin { - constructor(options: HtmlApplicationOptions); - afterViewSetup: JQueryCallback; - beforeViewSetup: JQueryCallback; - initialized: JQueryCallback; - navigating: JQueryCallback; - navigatingBack: JQueryCallback; - resolveLayoutController: JQueryCallback; - resolveViewCacheKey: JQueryCallback; - viewDisposed: JQueryCallback; - viewDisposing: JQueryCallback; - viewHidden: JQueryCallback; - viewRendered: JQueryCallback; - viewShowing: JQueryCallback; - viewShown: JQueryCallback; - /** Provides access to the ViewCache object. */ - viewCache: ViewCache; - /** An array of dxCommand components that are created based on the application's navigation option value. */ - navigation: Array; - /** Provides access to the StateManager object. */ - stateManager: StateManager; - /** Provides access to the Router object. */ - router: Router; - /** Navigates to the URI preceding the current one in the navigation history. */ - back(): void; - /** Returns a Boolean value indicating whether or not backwards navigation is currently possible. */ - canBack(): boolean; - /** Calls the clearState() method of the application's StateManager object. */ - clearState(): void; - /** Creates global navigation commands. */ - createNavigation(navigationConfig: Array): void; - /** Returns an HTML template of the specified view. */ - getViewTemplate(viewName: string): JQuery; - /** Returns a configuration object used to create a dxView component for a specified view. */ - getViewTemplateInfo(viewName: string): Object; - /** Adds a specified HTML template to a collection of view or layout templates. */ - loadTemplates(source: any): JQueryPromise; - /** Navigates to the specified URI. */ - navigate(uri?: any, options?: Object): void; - /** Renders navigation commands to the navigation command containers that are located in the layouts used in the application. */ - renderNavigation(): void; - /** Calls the restoreState() method of the application's StateManager object. */ - restoreState(): void; - /** Calls the saveState method of the application's StateManager object. */ - saveState(): void; - /** Provides access to the object that defines the current context to be considered when choosing an appropriate template for a view. */ - templateContext(): Object; - on(eventName: "initialized", eventHandler: () => void): HtmlApplication; - on(eventName: "afterViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "beforeViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "navigating", eventHandler: (e: { - currentUri: string; - uri: string; - cancel: boolean; - options: { - root: boolean; - target: string; - direction: string; - rootInDetailPane: boolean; - modal: boolean; - }; - }) => void): HtmlApplication; - on(eventName: "navigatingBack", eventHandler: (e: { - cancel: boolean; - isHardwareButton: boolean; - }) => void): HtmlApplication; - on(eventName: "resolveLayoutController", eventHandler: (e: { - viewInfo: Object; - layoutController: Object; - availableLayoutControllers: Array; - }) => void): HtmlApplication; - on(eventName: "resolveViewCacheKey", eventHandler: (e: { - key: string; - navigationItem: Object; - routeData: Object; - }) => void): HtmlApplication; - on(eventName: "viewDisposed", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewDisposing", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewHidden", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewRendered", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewShowing", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - on(eventName: "viewShown", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - on(eventName: string, eventHandler: Function): HtmlApplication; - on(events: { [eventName: string]: Function; }): HtmlApplication; - off(eventName: "initialized"): HtmlApplication; - off(eventName: "afterViewSetup"): HtmlApplication; - off(eventName: "beforeViewSetup"): HtmlApplication; - off(eventName: "navigating"): HtmlApplication; - off(eventName: "navigatingBack"): HtmlApplication; - off(eventName: "resolveLayoutController"): HtmlApplication; - off(eventName: "resolveViewCacheKey"): HtmlApplication; - off(eventName: "viewDisposed"): HtmlApplication; - off(eventName: "viewDisposing"): HtmlApplication; - off(eventName: "viewHidden"): HtmlApplication; - off(eventName: "viewRendered"): HtmlApplication; - off(eventName: "viewShowing"): HtmlApplication; - off(eventName: "viewShown"): HtmlApplication; - off(eventName: string): HtmlApplication; - off(eventName: "initialized", eventHandler: () => void): HtmlApplication; - off(eventName: "afterViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "beforeViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "navigating", eventHandler: (e: { - currentUri: string; - uri: string; - cancel: boolean; - options: { - root: boolean; - target: string; - direction: string; - rootInDetailPane: boolean; - modal: boolean; - }; - }) => void): HtmlApplication; - off(eventName: "navigatingBack", eventHandler: (e: { - cancel: boolean; - isHardwareButton: boolean; - }) => void): HtmlApplication; - off(eventName: "resolveLayoutController", eventHandler: (e: { - viewInfo: Object; - layoutController: Object; - availableLayoutControllers: Array; - }) => void): HtmlApplication; - off(eventName: "resolveViewCacheKey", eventHandler: (e: { - key: string; - navigationItem: Object; - routeData: Object; - }) => void): HtmlApplication; - off(eventName: "viewDisposed", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewDisposing", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewHidden", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewRendered", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewShowing", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - off(eventName: "viewShown", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - off(eventName: string, eventHandler: Function): HtmlApplication; - } - } -} -declare module DevExpress.viz.core { - /** - * Applies a theme for the entire page with several DevExtreme visualization widgets. - * @deprecated Use the DevExpress.viz.currentTheme(theme) method instead. - */ - export function currentTheme(theme: string): void; - /** - * Applies a new theme (with the color scheme defined separately) for the entire page with several DevExtreme visualization widgets. - * @deprecated Use the DevExpress.viz.currentTheme(platform, colorScheme) method instead. - */ - export function currentTheme(platform: string, colorScheme: string): void; - /** - * Registers a new theme based on the existing one. - * @deprecated Use the DevExpress.viz.registerTheme(customTheme, baseTheme) method instead. - */ - export function registerTheme(customTheme: Object, baseTheme: string): void; - /** - * Applies a predefined or registered custom palette to all visualization widgets at once. - * @deprecated Use the DevExpress.viz.currentPalette(paletteName) method instead. - */ - export function currentPalette(paletteName: string): void; - /** - * Obtains the color sets of a predefined or registered palette. - * @deprecated Use the DevExpress.viz.getPalette(paletteName) method instead. - */ - export function getPalette(paletteName: string): Object; - /** - * Registers a new palette. - * @deprecated Use the DevExpress.viz.registerPalette(paletteName, palette) method instead. - */ - export function registerPalette(paletteName: string, palette: Object): void; - export interface Border { - /** Sets a border color for a selected series. */ - color?: string; - /** Sets border visibility for a selected series. */ - visible?: boolean; - /** Sets a border width for a selected series. */ - width?: number; - } - export interface DashedBorder extends Border { - /** Specifies a dash style for the border of a selected series point. */ - dashStyle?: string; - } - export interface DashedBorderWithOpacity extends DashedBorder { - /** Specifies the opacity of the tooltip's border. */ - opacity?: number; - } - export interface Font { - /** Specifies the font color for a strip label. */ - color?: string; - /** Specifies the font family for a strip label. */ - family?: string; - /** Specifies the font opacity for a strip label. */ - opacity?: number; - /** Specifies the font size for a strip label. */ - size?: any; - /** Specifies the font weight for the text displayed in strips. */ - weight?: number; - } - export interface Hatching { - direction?: string; - /** Specifies the opacity of hatching lines. */ - opacity?: number; - /** Specifies the distance between hatching lines in pixels. */ - step?: number; - /** Specifies the width of hatching lines in pixels. */ - width?: number; - } - export interface Margins { - /** Specifies the distance in pixels between the bottom side of the title and the surrounding widget elements. */ - bottom?: number; - /** Specifies the distance in pixels between the left side of the title and the surrounding widget elements. */ - left?: number; - /** Specifies the distance between the right side of the title and surrounding widget elements in pixels. */ - right?: number; - /** Specifies the distance between the top side of the title and surrounding widget elements in pixels. */ - top?: number; - } - export interface Size { - /** Specifies the width of the widget. */ - width?: number; - /** Specifies the height of the widget. */ - height?: number; - } - export interface Title { - /** Specifies font options for the title. */ - font?: viz.core.Font; - /** Specifies the widget title's horizontal position. */ - horizontalAlignment?: string; - /** Specifies the widget title's position in the vertical direction. */ - verticalAlignment?: string; - /** Specifies the distance between the title and surrounding widget elements in pixels. */ - margin?: viz.core.Margins; - /** Specifies the height of the space reserved for the title. */ - placeholderSize?: number; - /** Specifies text for the title. */ - text?: string; - /** Specifies a subtitle for the widget. */ - subtitle?: { - /** Specifies font options for the subtitle. */ - font?: viz.core.Font; - /** Specifies text for the subtitle. */ - text?: string; - } - } - export interface Tooltip { - /** Specifies the length of the tooltip's arrow in pixels. */ - arrowLength?: number; - /** Specifies the appearance of the tooltip's border. */ - border?: viz.core.DashedBorderWithOpacity; - /** Specifies a color for the tooltip. */ - color?: string; - /** Specifies the z-index for tooltips. */ - zIndex?: number; - /** Specifies the container to draw tooltips inside of it. */ - container?: any; - /** Specifies text and appearance of a set of tooltips. */ - customizeTooltip?: (arg: Object) => { color?: string; text?: string }; - /** Specifies whether or not the tooltip is enabled. */ - enabled?: boolean; - /** Specifies font options for the text displayed by the tooltip. */ - font?: Font; - /** Specifies a format for the text displayed by the tooltip. */ - format?: string; - /** Specifies the opacity of a tooltip. */ - opacity?: number; - /** Specifies a distance from the tooltip's left/right boundaries to the inner text in pixels. */ - paddingLeftRight?: number; - /** Specifies a distance from the tooltip's top/bottom boundaries to the inner text in pixels. */ - paddingTopBottom?: number; - /** Specifies a precision for formatted values displayed by the tooltip. */ - precision?: number; - /** Specifies options of the tooltip's shadow. */ - shadow?: { - /** Specifies the blur distance of the tooltip's shadow. */ - blur?: number; - /** Specifies the color of the tooltip's shadow. */ - color?: string; - /** Specifies the horizontal offset of the tooltip's shadow relative to the tooltip in pixels. */ - offsetX?: number; - /** Specifies the vertical offset of the tooltip's shadow relative to the tooltip in pixels. */ - offsetY?: number; - /** Specifies the opacity of the tooltip's shadow. */ - opacity?: number; - }; - } - export interface Animation { - /** Determines how long animation runs. */ - duration?: number; - /** Specifies the animation easing mode. */ - easing?: string; - /** Indicates whether or not animation is enabled. */ - enabled?: boolean; - } - export interface LoadingIndicator { - /** Specifies a color for the loading indicator background. */ - backgroundColor?: string; - /** Specifies font options for the loading indicator text. */ - font?: viz.core.Font; - /** Specifies whether to show the loading indicator or not. */ - show?: boolean; - /** Specifies a text to be displayed by the loading indicator. */ - text?: string; - } - export interface LegendBorder extends viz.core.DashedBorderWithOpacity { - /** Specifies a radius for the corners of the legend border. */ - cornerRadius?: number; - } - export interface BaseLegend { - /** Specifies the color of the legend's background. */ - backgroundColor?: string; - /** Specifies legend border settings. */ - border?: viz.core.LegendBorder; - /** Specifies how many columns must be taken to arrange legend items. */ - columnCount?: number; - /** Specifies the spacing between a pair of neighboring legend columns in pixels. */ - columnItemSpacing?: number; - /** Specifies font options for legend items. */ - font?: viz.core.Font; - /** Specifies the legend's position on the map. */ - horizontalAlignment?: string; - /** Specifies the alignment of legend items. */ - itemsAlignment?: string; - /** Specifies the position of text relative to the item marker. */ - itemTextPosition?: string; - /** Specifies the distance between the legend and the container borders in pixels. */ - margin?: viz.core.Margins; - /** Specifies the size of item markers in the legend in pixels. */ - markerSize?: number; - /** Specifies whether to arrange legend items horizontally or vertically. */ - orientation?: string; - /** Specifies the spacing between the legend left/right border and legend items in pixels. */ - paddingLeftRight?: number; - /** Specifies the spacing between the legend top/bottom border and legend items in pixels. */ - paddingTopBottom?: number; - /** Specifies how many rows must be taken to arrange legend items. */ - rowCount?: number; - /** Specifies the spacing between a pair of neighboring legend rows in pixels. */ - rowItemSpacing?: number; - /** Specifies the legend's position on the map. */ - verticalAlignment?: string; - /** Specifies whether or not the legend is visible on the map. */ - visible?: boolean; - } - export interface BaseWidgetOptions extends DOMComponentOptions { - /** A handler for the drawn event. */ - onDrawn?: (e: { - component: BaseWidget; - element: Element; - }) => void; - /** A handler for the incidentOccurred event. */ - onIncidentOccurred?: ( - component: BaseWidget, - element: Element, - target: { - id: string; - type: string; - args: any; - text: string; - widget: string; - version: string; - } - ) => void; - /** Notifies a widget that it is embedded into an HTML page that uses a path modifier. */ - pathModified?: boolean; - /** Specifies whether or not the widget supports right-to-left representation. */ - rtlEnabled?: boolean; - /** Sets the name of the theme to be used in the widget. */ - theme?: string; - } - /** This section describes options and methods that are common to all widgets. */ - export class BaseWidget extends DOMComponent { - /** Returns the widget's SVG markup. */ - svg(): string; - } -} -declare module DevExpress.viz.charts { - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface BaseSeries { - /** Provides information about the state of the series object. */ - fullState: number; - /** Returns the type of the series. */ - type: string; - /** Unselects all the selected points of the series. The points are displayed in an initial style. */ - clearSelection(): void; - /** Gets the color of a particular series. */ - getColor(): string; - /** Gets points from the series point collection based on the specified argument. */ - getPointsByArg(pointArg: any): Array; - /** Gets a point from the series point collection based on the specified point position. */ - getPointByPos(positionIndex: number): Object; - /** Selects the series. The series is displayed in a 'selected' style until another series is selected or the current series is deselected programmatically. */ - select(): void; - /** Selects the specified point. The point is displayed in a 'selected' style. */ - selectPoint(point: BasePoint): void; - /** Deselects the specified point. The point is displayed in an initial style. */ - deselectPoint(point: BasePoint): void; - /** Returns an array of all points in the series. */ - getAllPoints(): Array; - /** Returns visible series points. */ - getVisiblePoints(): Array; - /** Returns the name of the series. */ - name: string; - /** Returns the tag of the series. */ - tag: string; - /** Hides a series. */ - hide(): void; - /** Provides information about the hover state of a series. */ - isHovered(): boolean; - /** Provides information about the selection state of a series. */ - isSelected(): boolean; - /** Provides information about the visibility state of a series. */ - isVisible(): boolean; - /** Makes a particular series visible. */ - show(): void; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface BasePoint { - /** Provides information about the state of the point object. */ - fullState: number; - /** Returns the point's argument value that was set in the data source. */ - originalArgument: any; - /** Returns the point's value that was set in the data source. */ - originalValue: any; - /** Returns the tag of the point. */ - tag: string; - /** Deselects the point. */ - clearSelection(): void; - /** Gets the color of a particular point. */ - getColor(): string; - /** Hides the tooltip of the point. */ - hideTooltip(): void; - /** Provides information about the hover state of a point. */ - isHovered(): boolean; - /** Provides information about the selection state of a point. */ - isSelected(): boolean; - /** Selects the point. The point is displayed in a 'selected' style until another point is selected or the current point is deselected programmatically. */ - select(): void; - /** Shows the tooltip of the point. */ - showTooltip(): void; - /** Allows you to obtain the label of a series point. */ - getLabel(): any; - /** Returns the series object to which the point belongs. */ - series: BaseSeries; - } - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface ChartSeries extends BaseSeries { - /** Returns the name of the series pane. */ - pane: string; - /** Returns the name of the value axis of the series. */ - axis: string; - selectPoint(point: ChartPoint): void; - deselectPoint(point: ChartPoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface ChartPoint extends BasePoint { - /** Contains the close value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalCloseValue: any; - /** Contains the high value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalHighValue: any; - /** Contains the low value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalLowValue: any; - /** Contains the first value of the point. This field is useful for points belonging to a series of the range area or range bar type only. */ - originalMinValue: any; - /** Contains the open value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalOpenValue: any; - /** Contains the size of the bubble as it was set in the data source. This field is useful for points belonging to a series of the bubble type only. */ - size: any; - /** Gets the parameters of the point's minimum bounding rectangle (MBR). */ - getBoundingRect(): { x: number; y: number; width: number; height: number; }; - series: ChartSeries; - } - /** This section describes the methods that can be used in code to manipulate the Label object. */ - export interface Label { - /** Gets the parameters of the label's minimum bounding rectangle (MBR). */ - getBoundingRect(): { x: number; y: number; width: number; height: number; }; - /** Hides the point label. */ - hide(): void; - /** Shows the point label. */ - show(): void; - } - export interface PieSeries extends BaseSeries { - selectPoint(point: PiePoint): void; - deselectPoint(point: PiePoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface PiePoint extends BasePoint { - /** Gets the percentage value of the specific point. */ - percent: any; - /** Provides information about the visibility state of a point. */ - isVisible(): boolean; - /** Makes a specific point visible. */ - show(): void; - /** Hides a specific point. */ - hide(): void; - series: PieSeries; - } - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface PolarSeries extends BaseSeries { - /** Returns the name of the value axis of the series. */ - axis: string; - selectPoint(point: PolarPoint): void; - deselectPoint(point: PolarPoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface PolarPoint extends BasePoint { - series: PolarSeries; - } - export interface Strip { - /** Specifies a color for a strip. */ - color?: string; - /** An object that defines the label configuration options of a strip. */ - label?: { - /** Specifies the text displayed in a strip. */ - text?: string; - }; - /** Specifies a start value for a strip. */ - startValue?: any; - /** Specifies an end value for a strip. */ - endValue?: any; - } - export interface BaseSeriesConfigLabel { - /** Specifies a format for arguments displayed by point labels. */ - argumentFormat?: string; - /** Specifies a precision for formatted point arguments displayed in point labels. */ - argumentPrecision?: number; - /** Specifies a background color for point labels. */ - backgroundColor?: string; - /** Specifies border options for point labels. */ - border?: viz.core.DashedBorder; - /** Specifies connector options for series point labels. */ - connector?: { - /** Specifies the color of label connectors. */ - color?: string; - /** Indicates whether or not label connectors are visible. */ - visible?: boolean; - /** Specifies the width of label connectors. */ - width?: number; - }; - /** Specifies a callback function that returns the text to be displayed by point labels. */ - customizeText?: (pointInfo: Object) => string; - /** Specifies font options for the text displayed in point labels. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed by point labels. */ - format?: string; - position?: string; - /** Specifies a precision for formatted point values displayed in point labels. */ - precision?: number; - /** Specifies the angle used to rotate point labels from their initial position. */ - rotationAngle?: number; - /** Specifies the visibility of point labels. */ - visible?: boolean; - } - export interface SeriesConfigLabel extends BaseSeriesConfigLabel { - /** Specifies whether or not to show a label when the point has a zero value. */ - showForZeroValues?: boolean; - } - export interface ChartSeriesConfigLabel extends SeriesConfigLabel { - /** Specifies how to align point labels relative to the corresponding data points that they represent. */ - alignment?: string; - /** Specifies how to shift point labels horizontally from their initial positions. */ - horizontalOffset?: number; - /** Specifies how to shift point labels vertically from their initial positions. */ - verticalOffset?: number; - /** Specifies a precision for the percentage values displayed in the labels of a full-stacked-like series. */ - percentPrecision?: number; - } - export interface BaseCommonSeriesConfig { - /** Specifies the data source field that provides arguments for series points. */ - argumentField?: string; - axis?: string; - /** An object defining the label configuration options for a series in the dxChart widget. */ - label?: ChartSeriesConfigLabel; - /** Specifies border options for point labels. */ - border?: viz.core.DashedBorder; - /** Specifies a series color. */ - color?: string; - /** Specifies the dash style of the series' line. */ - dashStyle?: string; - hoverMode?: string; - hoverStyle?: { - /** An object defining the border options for a hovered series. */ - border?: viz.core.DashedBorder; - /**

Sets a color for a series when it is hovered over.

*/ - color?: string; - /** Specifies the dash style for the line in a hovered series. */ - dashStyle?: string; - hatching?: viz.core.Hatching; - /** Specifies the width of a line in a hovered series. */ - width?: number; - }; - /** Specifies whether a chart ignores null data points or not. */ - ignoreEmptyPoints?: boolean; - /** Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed. */ - maxLabelCount?: number; - /** Specifies the minimal length of a displayed bar in pixels. */ - minBarSize?: number; - /** Specifies opacity for a series. */ - opacity?: number; - /** Specifies the series elements to highlight when the series is selected. */ - selectionMode?: string; - selectionStyle?: { - /** An object defining the border options for a selected series. */ - border?: viz.core.DashedBorder; - /** Sets a color for a series when it is selected. */ - color?: string; - /** Specifies the dash style for the line in a selected series. */ - dashStyle?: string; - hatching?: viz.core.Hatching; - /** Specifies the width of a line in a selected series. */ - width?: number; - }; - /** Specifies whether or not to show the series in the chart's legend. */ - showInLegend?: boolean; - /** Specifies the name of the stack where the values of the _stackedBar_ series must be located. */ - stack?: string; - /** Specifies the name of the data source field that provides data about a point. */ - tagField?: string; - /** Specifies the data source field that provides values for series points. */ - valueField?: string; - /** Specifies the visibility of a series. */ - visible?: boolean; - /** Specifies a line width. */ - width?: number; - /** Configures error bars. */ - valueErrorBar?: { - /** Specifies whether error bars must be displayed in full or partially. */ - displayMode?: string; - /** Specifies the data field that provides data for low error values. */ - lowValueField?: string; - /** Specifies the data field that provides data for high error values. */ - highValueField?: string; - /** Specifies how error bar values must be calculated. */ - type?: string; - /** Specifies the value to be used for generating error bars. */ - value?: number; - /** Specifies the color of error bars. */ - color?: string; - /** Specifies the opacity of error bars. */ - opacity?: number; - /** Specifies the length of the lines that indicate the error bar edges. */ - edgeLength?: number; - /** Specifies the width of the error bar line. */ - lineWidth?: number; - }; - } - export interface CommonPointOptions { - /** Specifies border options for points in the line and area series. */ - border?: viz.core.Border; - /** Specifies the points color. */ - color?: string; - /** Specifies what series points to highlight when a point is hovered over. */ - hoverMode?: string; - /** An object defining configuration options for a hovered point. */ - hoverStyle?: { - /** An object defining the border options for a hovered point. */ - border?: viz.core.Border; - /** Sets a color for a point when it is hovered over. */ - color?: string; - /** Specifies the diameter of a hovered point in the series that represents data points as symbols (not as bars for instance). */ - size?: number; - }; - /** Specifies what series points to highlight when a point is selected. */ - selectionMode?: string; - /** An object defining configuration options for a selected point. */ - selectionStyle?: { - /** An object defining the border options for a selected point. */ - border?: viz.core.Border; - /**

Sets a color for a point when it is selected.

*/ - color?: string; - /** Specifies the diameter of a selected point in the series that represents data points as symbols (not as bars for instance). */ - size?: number; - }; - /** Specifies the point diameter in pixels for those series that represent data points as symbols (not as bars for instance). */ - size?: number; - /** Specifies a symbol for presenting points of the line and area series. */ - symbol?: string; - visible?: boolean; - } - export interface ChartCommonPointOptions extends CommonPointOptions { - /** An object specifying the parameters of an image that is used as a point marker. */ - image?: { - /** Specifies the height of an image that is used as a point marker. */ - height?: any; - /** Specifies a URL leading to the image to be used as a point marker. */ - url?: any; - /** Specifies the width of an image that is used as a point marker. */ - width?: any; - }; - } - export interface PolarCommonPointOptions extends CommonPointOptions { - /** An object specifying the parameters of an image that is used as a point marker. */ - image?: { - /** Specifies the height of an image that is used as a point marker. */ - height?: number; - /** Specifies a URL leading to the image to be used as a point marker. */ - url?: string; - /** Specifies the width of an image that is used as a point marker. */ - width?: number; - }; - } - /** An object that defines configuration options for chart series. */ - export interface CommonSeriesConfig extends BaseCommonSeriesConfig { - /** Specifies the data source field that provides a 'close' value for a _candleStick_ or _stock_ series. */ - closeValueField?: string; - /** Specifies a radius for bar corners. */ - cornerRadius?: number; - /** Specifies the data source field that provides a 'high' value for a _candleStick_ or _stock_ series. */ - highValueField?: string; - /** Specifies the color for the body (rectangle) of a _candleStick_ series. */ - innerColor?: string; - /** Specifies the data source field that provides a 'low' value for a _candleStick_ or _stock_ series. */ - lowValueField?: string; - /** Specifies the data source field that provides an 'open' value for a _candleStick_ or _stock_ series. */ - openValueField?: string; - /** Specifies the pane that will be used to display a series. */ - pane?: string; - /** An object defining configuration options for points in line-, scatter- and area-like series. */ - point?: ChartCommonPointOptions; - /** Specifies the data source field that provides values for one end of a range series. To set the data source field for the other end of the range series, use the rangeValue2Field property. */ - rangeValue1Field?: string; - /** Specifies the data source field that provides values for the second end of a range series. To set the data source field for the other end of the range series, use the rangeValue1Field property. */ - rangeValue2Field?: string; - /** Specifies reduction options for the stock or candleStick series. */ - reduction?: { - /** Specifies a color for the points whose reduction level price is lower in comparison to the value in the previous point. */ - color?: string; - /** Specifies for which price level (open, high, low or close) to enable reduction options in the series. */ - level?: string; - }; - /** Specifies the data source field that defines the size of bubbles. */ - sizeField?: string; - } - export interface CommonSeriesSettings extends CommonSeriesConfig { - /**

An object that specifies configuration options for all series of the area type in the chart.

*/ - area?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _bar_ type in the chart. */ - bar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the bubble type in the chart. */ - bubble?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _candleStick_ type in the chart. */ - candlestick?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _fullStackedArea_ type in the chart. */ - fullstackedarea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Full-Stacked Spline Area type in the chart. */ - fullstackedsplinearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _fullStackedBar_ type in the chart. */ - fullstackedbar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _fullStackedLine_ type in the chart. */ - fullstackedline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Full-Stacked Spline type in the chart. */ - fullstackedspline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _line_ type in the chart. */ - line?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _rangeArea_ type in the chart. */ - rangearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _rangeBar_ type in the chart. */ - rangebar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _scatter_ type in the chart. */ - scatter?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _spline_ type in the chart. */ - spline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _splineArea_ type in the chart. */ - splinearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedArea_ type in the chart. */ - stackedarea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Stacked Spline Area type in the chart. */ - stackedsplinearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedBar_ type in the chart. */ - stackedbar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedLine_ type in the chart. */ - stackedline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Stacked Spline type in the chart. */ - stackedspline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stepArea_ type in the chart. */ - steparea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stepLine_ type in the chart. */ - stepline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stock_ type in the chart. */ - stock?: CommonSeriesConfig; - /** Sets a series type. */ - type?: string; - } - export interface SeriesConfig extends CommonSeriesConfig { - /** Specifies the name that identifies the series. */ - name?: string; - /** Specifies data about a series. */ - tag?: any; - /** Sets the series type. */ - type?: string; - } - /** An object that defines configuration options for polar chart series. */ - export interface CommonPolarSeriesConfig extends BaseCommonSeriesConfig { - /** Specifies whether or not to close the chart by joining the end point with the first point. */ - closed?: boolean; - label?: SeriesConfigLabel; - point?: PolarCommonPointOptions; - } - export interface CommonPolarSeriesSettings extends CommonPolarSeriesConfig { - /** An object that specifies configuration options for all series of the area type in the chart. */ - area?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _bar_ type in the chart. */ - bar?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _line_ type in the chart. */ - line?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _scatter_ type in the chart. */ - scatter?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedBar_ type in the chart. */ - stackedbar?: CommonPolarSeriesConfig; - /** Sets a series type. */ - type?: string; - } - export interface PolarSeriesConfig extends CommonPolarSeriesConfig { - /** Specifies the name that identifies the series. */ - name?: string; - /** Specifies data about a series. */ - tag?: any; - /** Sets the series type. */ - type?: string; - } - export interface PieSeriesConfigLabel extends BaseSeriesConfigLabel { - /** Specifies how to shift labels from their initial position in a radial direction in pixels. */ - radialOffset?: number; - /** Specifies a precision for the percentage values displayed in labels. */ - percentPrecision?: number; - } - /** An object that defines configuration options for chart series. */ - export interface CommonPieSeriesConfig { - /** Specifies the data source field that provides arguments for series points. */ - argumentField?: string; - /** Specifies the required type for series arguments. */ - argumentType?: string; - /** An object defining the series border configuration options. */ - border?: viz.core.DashedBorder; - /** Specifies a series color. */ - color?: string; - /** Specifies the chart elements to highlight when a series is hovered over. */ - hoverMode?: string; - /** An object defining configuration options for a hovered series. */ - hoverStyle?: { - /** An object defining the border options for a hovered series. */ - border?: viz.core.DashedBorder; - /** Sets a color for the series when it is hovered over. */ - color?: string; - /** Specifies the hatching options to be applied when a point is hovered over. */ - hatching?: viz.core.Hatching; - }; - /** - * Specifies the fraction of the inner radius relative to the total radius in the series of the 'doughnut' type. - * @deprecated Use the innerRadius option instead. - */ - innerRadius?: number; - /** An object defining the label configuration options. */ - label?: PieSeriesConfigLabel; - /** Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed. */ - maxLabelCount?: number; - /** Specifies a minimal size of a displayed pie segment. */ - minSegmentSize?: number; - /** - * Specifies the direction in which the dxPieChart series points are located. - * @deprecated Use the segmentsDirection option instead. - */ - segmentsDirection?: string; - /**

Specifies the chart elements to highlight when the series is selected.

*/ - selectionMode?: string; - /** An object defining configuration options for the series when it is selected. */ - selectionStyle?: { - /** An object defining the border options for a selected series. */ - border?: viz.core.DashedBorder; - /** Sets a color for a series when it is selected. */ - color?: string; - /** Specifies the hatching options to be applied when a point is selected. */ - hatching?: viz.core.Hatching; - }; - /** Specifies chart segment grouping options. */ - smallValuesGrouping?: { - /** Specifies the name of the grouped chart segment. This name represents the segment in the chart legend. */ - groupName?: string; - /** Specifies the segment grouping mode. */ - mode?: string; - /** Specifies a threshold for segment values. */ - threshold?: number; - /** Specifies how many segments must not be grouped. */ - topCount?: number; - }; - /** - * Specifies a start angle for a pie chart in arc degrees. - * @deprecated Use the startAngle option instead. - */ - startAngle?: number; - /**

Specifies the name of the data source field that provides data about a point.

*/ - tagField?: string; - /** Specifies the data source field that provides values for series points. */ - valueField?: string; - } - export interface CommonPieSeriesSettings extends CommonPieSeriesConfig { - /** - * Specifies the type of the pie chart series. - * @deprecated Use the type option instead. - */ - type?: string; - } - export interface PieSeriesConfig extends CommonPieSeriesConfig { - /** - * Sets the series type. - * @deprecated Use the type option instead. - */ - type?: string; - /** Specifies the name that identifies the series. */ - name?: string; - /** Specifies data about a series. */ - tag?: any; - } - export interface SeriesTemplate { - /** Specifies a callback function that returns a series object with individual series settings. */ - customizeSeries?: (seriesName: string) => SeriesConfig; - /** Specifies a data source field that represents the series name. */ - nameField?: string; - } - export interface PolarSeriesTemplate { - /** Specifies a callback function that returns a series object with individual series settings. */ - customizeSeries?: (seriesName: string) => PolarSeriesConfig; - /** Specifies a data source field that represents the series name. */ - nameField?: string; - } - export interface ChartCommonConstantLineLabel { - /** Specifies font options for a constant line label. */ - font?: viz.core.Font; - /** Specifies the position of the constant line label relative to the chart plot. */ - position?: string; - /** Indicates whether or not to display labels for the axis constant lines. */ - visible?: boolean; - } - export interface PolarCommonConstantLineLabel { - /** Indicates whether or not to display labels for the axis constant lines. */ - visible?: boolean; - /** Specifies font options for a constant line label. */ - font?: viz.core.Font; - } - export interface ConstantLineStyle { - /** Specifies a color for a constant line. */ - color?: string; - /** Specifies a dash style for a constant line. */ - dashStyle?: string; - /** Specifies a constant line width in pixels. */ - width?: number; - } - export interface ChartCommonConstantLineStyle extends ConstantLineStyle { - /** An object defining constant line label options. */ - label?: ChartCommonConstantLineLabel; - /** Specifies the space between the constant line label and the left/right side of the constant line. */ - paddingLeftRight?: number; - /** Specifies the space between the constant line label and the top/bottom side of the constant line. */ - paddingTopBottom?: number; - } - export interface PolarCommonConstantLineStyle extends ConstantLineStyle { - /** An object defining constant line label options. */ - label?: PolarCommonConstantLineLabel; - } - export interface CommonAxisLabel { - /** Specifies font options for axis labels. */ - font?: viz.core.Font; - /** Specifies the spacing between an axis and its labels in pixels. */ - indentFromAxis?: number; - /** Indicates whether or not axis labels are visible. */ - visible?: boolean; - } - export interface ChartCommonAxisLabel extends CommonAxisLabel { - /** Specifies the label's position relative to the tick (grid line). */ - alignment?: string; - /** Specifies the overlap resolving algorithm to be applied to axis labels. */ - overlappingBehavior?: { - /** Specifies how to arrange axis labels. */ - mode?: string; - /** Specifies the angle used to rotate axis labels. */ - rotationAngle?: number; - /** Specifies the spacing that must be set between staggered rows when the 'stagger' algorithm is applied. */ - staggeringSpacing?: number; - }; - } - export interface PolarCommonAxisLabel extends CommonAxisLabel { - /** Specifies the overlap resolving algorithm to be applied to axis labels. */ - overlappingBehavior?: string; - } - export interface CommonAxisTitle { - /** Specifies font options for an axis title. */ - font?: viz.core.Font; - /** Specifies a margin for an axis title in pixels. */ - margin?: number; - } - export interface BaseCommonAxisSettings { - /** Specifies the color of the line that represents an axis. */ - color?: string; - /** Specifies whether ticks/grid lines of a discrete axis are located between labels or cross the labels. */ - discreteAxisDivisionMode?: string; - /** An object defining the configuration options for the grid lines of an axis in the dxPolarChart widget. */ - grid?: { - /** Specifies a color for grid lines. */ - color?: string; - /** Specifies an opacity for grid lines. */ - opacity?: number; - /** Indicates whether or not the grid lines of an axis are visible. */ - visible?: boolean; - /** Specifies the width of grid lines. */ - width?: number; - }; - /** Specifies the options of the minor grid. */ - minorGrid?: { - /** Specifies a color for the lines of the minor grid. */ - color?: string; - /** Specifies an opacity for the lines of the minor grid. */ - opacity?: number; - /** Indicates whether the minor grid is visible or not. */ - visible?: boolean; - /** Specifies a width for the lines of the minor grid. */ - width?: number; - }; - /** Indicates whether or not an axis is inverted. */ - inverted?: boolean; - /** Specifies the opacity of the line that represents an axis. */ - opacity?: number; - /** Indicates whether or not to set ticks/grid lines of a continuous axis of the 'date-time' type at the beginning of each date-time interval. */ - setTicksAtUnitBeginning?: boolean; - /** An object defining the configuration options for axis ticks. */ - tick?: { - /** Specifies ticks color. */ - color?: string; - /** Specifies tick opacity. */ - opacity?: number; - /** Indicates whether or not ticks are visible on an axis. */ - visible?: boolean; - /** Specifies tick width. */ - width?: number; - /** Specifies tick length. */ - length?: number; - }; - /** Specifies the options of the minor ticks. */ - minorTick?: { - /** Specifies a color for the minor ticks. */ - color?: string; - /** Specifies an opacity for the minor ticks. */ - opacity?: number; - /** Indicates whether or not the minor ticks are displayed on an axis. */ - visible?: boolean; - /** Specifies minor tick width. */ - width?: number; - /** Specifies minor tick length. */ - length?: number; - }; - /** Indicates whether or not the line that represents an axis in a chart is visible. */ - visible?: boolean; - /** Specifies the width of the line that represents an axis in the chart. */ - width?: number; - } - export interface ChartCommonAxisSettings extends BaseCommonAxisSettings { - /** Specifies the appearance of all the widget's constant lines. */ - constantLineStyle?: ChartCommonConstantLineStyle; - /** An object defining the label configuration options that are common for all axes in the dxChart widget. */ - label?: ChartCommonAxisLabel; - /** Specifies a coefficient that determines the spacing between the maximum series point and the axis. */ - maxValueMargin?: number; - /** Specifies a coefficient that determines the spacing between the minimum series point and the axis. */ - minValueMargin?: number; - /** Specifies, in pixels, the space reserved for an axis. */ - placeholderSize?: number; - /** An object defining configuration options for strip style. */ - stripStyle?: { - /** An object defining the configuration options for a strip label style. */ - label?: { - /** Specifies font options for a strip label. */ - font?: viz.core.Font; - /** Specifies the label's position on a strip. */ - horizontalAlignment?: string; - /** Specifies a label's position on a strip. */ - verticalAlignment?: string; - }; - /** Specifies the spacing, in pixels, between the left/right strip border and the strip label. */ - paddingLeftRight?: number; - /** Specifies the spacing, in pixels, between the top/bottom strip borders and the strip label. */ - paddingTopBottom?: number; - }; - /** An object defining the title configuration options that are common for all axes in the dxChart widget. */ - title?: CommonAxisTitle; - /** Indicates whether or not to display series with indents from axis boundaries. */ - valueMarginsEnabled?: boolean; - } - export interface PolarCommonAxisSettings extends BaseCommonAxisSettings { - /** Specifies the appearance of all the widget's constant lines. */ - constantLineStyle?: PolarCommonConstantLineStyle; - /** An object defining the label configuration options that are common for all axes in the dxPolarChart widget. */ - label?: PolarCommonAxisLabel; - /** An object defining configuration options for strip style. */ - stripStyle?: { - /** An object defining the configuration options for a strip label style. */ - label?: { - /** Specifies font options for a strip label. */ - font?: viz.core.Font; - }; - }; - } - export interface ChartConstantLineLabel extends ChartCommonConstantLineLabel { - /** Specifies the horizontal alignment of a constant line label. */ - horizontalAlignment?: string; - /** Specifies the vertical alignment of a constant line label. */ - verticalAlignment?: string; - /** Specifies the text to be displayed in a constant line label. */ - text?: string; - } - export interface PolarConstantLineLabel extends PolarCommonConstantLineLabel { - /** Specifies the text to be displayed in a constant line label. */ - text?: string; - } - export interface AxisLabel { - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a label on the value axis. */ - customizeHint?: (argument: { value: any; valueText: string }) => string; - /** Specifies a callback function that returns the text to be displayed in value axis labels. */ - customizeText?: (argument: { value: any; valueText: string }) => string; - /** Specifies a format for the text displayed by axis labels. */ - format?: string; - /** Specifies a precision for the formatted value displayed in the axis labels. */ - precision?: number; - } - export interface ChartAxisLabel extends ChartCommonAxisLabel, AxisLabel { } - export interface PolarAxisLabel extends PolarCommonAxisLabel, AxisLabel { } - export interface AxisTitle extends CommonAxisTitle { - /** Specifies the text for the value axis title. */ - text?: string; - } - export interface ChartConstantLineStyle extends ChartCommonConstantLineStyle { - /** An object defining constant line label options. */ - label?: ChartConstantLineLabel; - } - export interface ChartConstantLine extends ChartConstantLineStyle { - /** An object defining constant line label options. */ - label?: ChartConstantLineLabel; - /** Specifies a value to be displayed by a constant line. */ - value?: any; - } - export interface PolarConstantLine extends PolarCommonConstantLineStyle { - /** An object defining constant line label options. */ - label?: PolarConstantLineLabel; - /** Specifies a value to be displayed by a constant line. */ - value?: any; - } - export interface Axis { - /** Specifies a coefficient for dividing the value axis. */ - axisDivisionFactor?: number; - /** Specifies the order in which discrete values are arranged on the value axis. */ - categories?: Array; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic axis. */ - logarithmBase?: number; - /** Specifies an interval between axis ticks/grid lines. */ - tickInterval?: any; - /** Specifies the interval between minor ticks. */ - minorTickInterval?: any; - /** Specifies the number of minor ticks between two neighboring major ticks. */ - minorTickCount?: number; - /** Specifies the required type of the value axis. */ - type?: string; - /** Specifies the pane on which the current value axis will be displayed. */ - pane?: string; - /** Specifies options for value axis strips. */ - strips?: Array; - } - export interface ChartAxis extends ChartCommonAxisSettings, Axis { - /** Defines an array of the value axis constant lines. */ - constantLines?: Array; - /** Specifies the appearance options for the constant lines of the value axis. */ - constantLineStyle?: ChartCommonConstantLineStyle; - /** Specifies options for value axis labels. */ - label?: ChartAxisLabel; - /** Specifies the maximum value on the value axis. */ - max?: any; - /** Specifies the minimum value on the value axis. */ - min?: any; - /** Specifies the position of the value axis on a chart. */ - position?: string; - /** Specifies the title for a value axis. */ - title?: any; - } - export interface PolarAxis extends PolarCommonAxisSettings, Axis { - /** Defines an array of the value axis constant lines. */ - constantLines?: Array; - /** Specifies options for value axis labels. */ - label?: PolarAxisLabel; - } - export interface ArgumentAxis { - /** Specifies the desired type of axis values. */ - argumentType?: string; - /** Specifies the elements that will be highlighted when the argument axis is hovered over. */ - hoverMode?: string; - } - export interface ChartArgumentAxis extends ChartAxis, ArgumentAxis { } - export interface PolarArgumentAxis extends PolarAxis, ArgumentAxis { - /** Specifies the angle in arc degrees to which the argument axis should be rotated. The positive values rotate the axis clockwise. */ - startAngle?: number; - /** Specifies whether or not to display the first point at the angle specified by the startAngle option. */ - firstPointOnStartAngle?: boolean; - /** Specifies the value to be used as the origin for the argument axis. */ - originValue?: number; - /** Specifies the period of the argument values in the data source. */ - period?: number; - } - export interface ValueAxis { - /** Specifies the name of the value axis. */ - name?: string; - /** Specifies whether or not to indicate a zero value on the value axis. */ - showZero?: boolean; - /** Specifies the desired type of axis values. */ - valueType?: string; - } - export interface ChartValueAxis extends ChartAxis, ValueAxis { - /** Specifies the spacing, in pixels, between multiple value axes in a chart. */ - multipleAxesSpacing?: number; - /** Specifies the value by which the chart's value axes are synchronized. */ - synchronizedValue?: number; - } - export interface PolarValueAxis extends PolarAxis, ValueAxis { - /** Indicates whether to display series with indents from axis boundaries. */ - valueMarginsEnabled?: boolean; - /** Specifies a coefficient that determines the spacing between the maximum series point and the axis. */ - maxValueMargin?: number; - /** Specifies a coefficient that determines the spacing between the minimum series point and the axis. */ - minValueMargin?: number; - tick?: { - visible?: boolean; - } - } - export interface CommonPane { - /** Specifies a background color in a pane. */ - backgroundColor?: string; - /** Specifies the border options of a chart's pane. */ - border?: PaneBorder; - } - export interface Pane extends CommonPane { - /** Specifies the name of a pane. */ - name?: string; - } - export interface PaneBorder extends viz.core.DashedBorderWithOpacity { - /** Specifies the bottom border's visibility state in a pane. */ - bottom?: boolean; - /** Specifies the left border's visibility state in a pane. */ - left?: boolean; - /** Specifies the right border's visibility state in a pane. */ - right?: boolean; - /** Specifies the top border's visibility state in a pane. */ - top?: boolean; - } - export interface ChartAnimation extends viz.core.Animation { - /** Specifies the maximum series point count in the chart that the animation supports. */ - maxPointCountSupported?: number; - } - export interface BaseChartTooltip extends viz.core.Tooltip { - /** Specifies a format for arguments of the chart's series points. */ - argumentFormat?: string; - /** Specifies a precision for formatted arguments displayed in tooltips. */ - argumentPrecision?: number; - /** Specifies a precision for a percent value displayed in tooltips for stacked series and dxPieChart series. */ - percentPrecision?: number; - } - export interface BaseChartOptions extends viz.core.BaseWidgetOptions { - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - /** Specifies the width of the widget that is small enough for the layout to begin adapting. */ - width?: number; - /** Specifies the height of the widget that is small enough for the layout to begin adapting. */ - height?: number; - /** Specifies whether or not point labels can be hidden when the layout is adapting. */ - keepLabels?: boolean; - }; - /** Specifies animation options. */ - animation?: ChartAnimation; - /** Specifies a callback function that returns an object with options for a specific point label. */ - customizeLabel?: (labelInfo: Object) => Object; - /** Specifies a callback function that returns an object with options for a specific point. */ - customizePoint?: (pointInfo: Object) => Object; - /** Specifies a data source for the chart. */ - dataSource?: any; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies options of a dxChart's (dxPieChart's) legend. */ - legend?: core.BaseLegend; - /** Specifies the blank space between the chart's extreme elements and the boundaries of the area provided for the widget (see size) in pixels. */ - margin?: viz.core.Margins; - /** Sets the name of the palette to be used in the chart. Alternatively, an array of colors can be set as a custom palette to be used within this chart. */ - palette?: any; - /** A handler for the done event. */ - onDone?: (e: { - component: BaseChart; - element: Element; - }) => void; - /** A handler for the pointClick event. */ - onPointClick?: any; - /** A handler for the pointHoverChanged event. */ - onPointHoverChanged?: (e: { - component: BaseChart; - element: Element; - target: TPoint; - }) => void; - /** A handler for the pointSelectionChanged event. */ - onPointSelectionChanged?: (e: { - component: BaseChart; - element: Element; - target: TPoint; - }) => void; - /** Specifies whether a single point or multiple points can be selected in the chart. */ - pointSelectionMode?: string; - /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */ - redrawOnResize?: boolean; - /** Specifies options for the dxChart and dxPieChart widget series. */ - series?: any; - /** Specifies the size of the widget in pixels. */ - size?: viz.core.Size; - /** Specifies a title for the chart. */ - title?: viz.core.Title; - /** Specifies tooltip options. */ - tooltip?: BaseChartTooltip; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: BaseChart; - element: Element; - target: BasePoint; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: BaseChart; - element: Element; - target: BasePoint; - }) => void; - } - /** A base class for all chart widgets included in the ChartJS library. */ - export class BaseChart extends viz.core.BaseWidget { - /** Deselects the chart's selected series. The series is displayed in an initial style. */ - clearSelection(): void; - /** Gets the current size of the widget. */ - getSize(): { width: number; height: number }; - /** Returns an array of all series in the chart. */ - getAllSeries(): Array; - /** Gets a series within the chart's series collection by the specified name (see the name option). */ - getSeriesByName(seriesName: string): BaseSeries; - /** Gets a series within the chart's series collection by its position number. */ - getSeriesByPos(seriesIndex: number): BaseSeries; - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Hides all widget tooltips. */ - hideTooltip(): void; - /** Redraws a widget. */ - render(renderOptions?: { - force?: boolean; - animate?: boolean; - asyncSeriesRendering?: boolean; - }): void; - } - export interface AdvancedLegend extends core.BaseLegend { - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item. */ - customizeHint?: (seriesInfo: { seriesName: string; seriesIndex: number; seriesColor: string; }) => string; - /**

Specifies a callback function that returns the text to be displayed by legend items.

*/ - customizeText?: (seriesInfo: { seriesName: string; seriesIndex: number; seriesColor: string; }) => string; - /** Specifies what series elements to highlight when a corresponding item in the legend is hovered over. */ - hoverMode?: string; - } - export interface AdvancedOptions extends BaseChartOptions { - /** A handler for the argumentAxisClick event. */ - onArgumentAxisClick?: any; - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** An object providing options for managing data from a data source. */ - dataPrepareSettings?: { - /** Specifies whether or not to validate the values from a data source. */ - checkTypeForAllData?: boolean; - /** Specifies whether or not to convert the values from a data source into the data type of an axis. */ - convertToAxisDataType?: boolean; - /** Specifies how to sort the series points. */ - sortingMethod?: any; - }; - /** A handler for the legendClick event. */ - onLegendClick?: any; - /** A handler for the seriesClick event. */ - onSeriesClick?: any; - /** A handler for the seriesHoverChanged event. */ - onSeriesHoverChanged?: (e: { - component: BaseChart; - element: Element; - target: TSeries; - }) => void; - /** A handler for the seriesSelectionChanged event. */ - onSeriesSelectionChanged?: (e: { - component: BaseChart; - element: Element; - target: TSeries; - }) => void; - /** Specifies whether a single series or multiple series can be selected in the chart. */ - seriesSelectionMode?: string; - /** Specifies how the chart must behave when series point labels overlap. */ - resolveLabelOverlapping?: string; - /** Specifies whether or not all bars in a series must have the same angle, or may have different angles if any points in other series are missing. */ - equalBarWidth?: boolean; - /** Specifies a common bar width as a percentage from 0 to 1. */ - barWidth?: number; - /** Forces the widget to treat negative values as zeroes. Applies to stacked-like series only. */ - negativesAsZeroes?: boolean; - } - export interface Legend extends AdvancedLegend { - /** Specifies whether the legend is located outside or inside the chart's plot. */ - position?: string; - } - export interface ChartTooltip extends BaseChartTooltip { - /** Specifies whether the tooltip must be located in the center of a bar or on its edge. Applies to the Bar and Bubble series. */ - location?: string; - /** Specifies the kind of information to display in a tooltip. */ - shared?: boolean; - } - export interface dxChartOptions extends AdvancedOptions { - adaptiveLayout?: { - keepLabels?: boolean; - }; - /** Indicates whether or not to synchronize value axes when they are displayed on a single pane. */ - synchronizeMultiAxes?: boolean; - /** Specifies whether or not to filter the series points depending on their quantity. */ - useAggregation?: boolean; - /** Indicates whether or not to adjust a value axis to the current minimum and maximum values of a zoomed chart. */ - adjustOnZoom?: boolean; - /** Specifies argument axis options for the dxChart widget. */ - argumentAxis?: ChartArgumentAxis; - /** An object defining the configuration options that are common for all axes of the dxChart widget. */ - commonAxisSettings?: ChartCommonAxisSettings; - /** An object defining the configuration options that are common for all panes in the dxChart widget. */ - commonPaneSettings?: CommonPane; - /** An object defining the configuration options that are common for all series of the dxChart widget. */ - commonSeriesSettings?: CommonSeriesSettings; - /** An object that specifies the appearance options of the chart crosshair. */ - crosshair?: { - /** Specifies a color for the crosshair lines. */ - color?: string; - /** Specifies a dash style for the crosshair lines. */ - dashStyle?: string; - /** Specifies whether to enable the crosshair or not. */ - enabled?: boolean; - /** Specifies the opacity of the crosshair lines. */ - opacity?: number; - /** Specifies the width of the crosshair lines. */ - width?: number; - /** Specifies the appearance of the horizontal crosshair line. */ - horizontalLine?: CrosshaierWithLabel; - /** Specifies the appearance of the vertical crosshair line. */ - verticalLine?: CrosshaierWithLabel; - /** Specifies the options of the crosshair labels. */ - label?: { - /** Specifies a color for the background of the crosshair labels. */ - backgroundColor?: string; - /** Specifies whether the crosshair labels are visible or not. */ - visible?: boolean; - /** Specifies font options for the text of the crosshair labels. */ - font?: viz.core.Font; - /** Specifies the format of the values displayed by crosshair labels. */ - format?: string; - /** Specifies a precision for formatted values. */ - precision?: number; - /** Customizes the text displayed by the crosshair labels. */ - customizeText?: (info: { value: any; valueText: string; point: ChartPoint; }) => string; - } - }; - /** Specifies a default pane for the chart series. */ - defaultPane?: string; - /** Specifies a coefficient determining the diameter of the largest bubble. */ - maxBubbleSize?: number; - /** Specifies the diameter of the smallest bubble measured in pixels. */ - minBubbleSize?: number; - /** Defines the dxChart widget's pane(s). */ - panes?: Array; - /** Swaps the axes round so that the value axis becomes horizontal and the argument axes becomes vertical. */ - rotated?: boolean; - /** Specifies the options of a chart's legend. */ - legend?: Legend; - /** Specifies options for dxChart widget series. */ - series?: Array; - /** Defines options for the series template. */ - seriesTemplate?: SeriesTemplate; - /** Specifies tooltip options. */ - tooltip?: ChartTooltip; - /** Specifies value axis options for the dxChart widget. */ - valueAxis?: Array; - /** Enables scrolling in your chart. */ - scrollingMode?: string; - /** Enables zooming in your chart. */ - zoomingMode?: string; - /** Specifies the settings of the scroll bar. */ - scrollBar?: { - /** Specifies whether the scroll bar is visible or not. */ - visible?: boolean; - /** Specifies the spacing between the scroll bar and the chart's plot in pixels. */ - offset?: number; - /** Specifies the color of the scroll bar. */ - color?: string; - /** Specifies the width of the scroll bar in pixels. */ - width?: number; - /** Specifies the opacity of the scroll bar. */ - opacity?: number; - /** Specifies the position of the scroll bar in the chart. */ - position?: string; - }; - } - /** A widget used to embed charts into web applications. */ - export class dxChart extends BaseChart { - constructor(element: JQuery, options?: dxChartOptions); - constructor(element: Element, options?: dxChartOptions); - /** Sets the specified start and end values for the chart's argument axis. */ - zoomArgument(startValue: any, endValue: any): void; - } - interface CrosshaierWithLabel extends viz.core.DashedBorderWithOpacity { - /** Configures the label that belongs to the horizontal crosshair line. */ - label?: { - /** Specifies a color for the background of the label that belongs to the horizontal crosshair line. */ - backgroundColor?: string; - /** Specifies whether the label of the horizontal crosshair line is visible or not. */ - visible?: boolean; - /** Specifies font options for the text of the label that belongs to the horizontal crosshair line. */ - font?: viz.core.Font; - /** Specifies the format of the values displayed by crosshair labels. */ - format?: string; - /** Specifies a precision for formatted values. */ - precision?: number; - /** Customizes the text displayed by the crosshair label that accompany the horizontal line. */ - customizeText?: (info: { value: any; valueText: string; point: ChartPoint; }) => string; - } - } - export interface PolarChartTooltip extends BaseChartTooltip { - /** Specifies the kind of information to display in a tooltip. */ - shared?: boolean; - } - export interface dxPolarChartOptions extends AdvancedOptions { - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - width?: number; - height?: number; - /** Specifies whether or not point labels can be hidden when the layout is adapting. */ - keepLabels?: boolean; - }; - /** Indicates whether or not to display a "spider web". */ - useSpiderWeb?: boolean; - /** Specifies argument axis options for the dxPolarChart widget. */ - argumentAxis?: PolarArgumentAxis; - /** An object defining the configuration options that are common for all axes of the dxPolarChart widget. */ - commonAxisSettings?: PolarCommonAxisSettings; - /** An object defining the configuration options that are common for all series of the dxPolarChart widget. */ - commonSeriesSettings?: CommonPolarSeriesSettings; - /** Specifies the options of a chart's legend. */ - legend?: AdvancedLegend; - /** Specifies options for dxPolarChart widget series. */ - series?: Array; - /** Defines options for the series template. */ - seriesTemplate?: PolarSeriesTemplate; - /** Specifies tooltip options. */ - tooltip?: PolarChartTooltip; - /** Specifies value axis options for the dxPolarChart widget. */ - valueAxis?: PolarValueAxis; - } - /** A chart widget displaying data in a polar coordinate system. */ - export class dxPolarChart extends BaseChart { - constructor(element: JQuery, options?: dxPolarChartOptions); - constructor(element: Element, options?: dxPolarChartOptions); - } - export interface PieLegend extends core.BaseLegend { - /** Specifies what chart elements to highlight when a corresponding item in the legend is hovered over. */ - hoverMode?: string; - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item. */ - customizeHint?: (pointInfo: { pointName: string; pointIndex: number; pointColor: string; }) => string; - /** Specifies a callback function that returns the text to be displayed by a legend item. */ - customizeText?: (pointInfo: { pointName: string; pointIndex: number; pointColor: string; }) => string; - } - export interface dxPieChartOptions extends BaseChartOptions { - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - /** Specifies whether or not point labels can be hidden when the layout is adapting. */ - keepLabels?: boolean; - }; - /** Specifies dxPieChart legend options. */ - legend?: PieLegend; - /** Specifies options for the series of the dxPieChart widget. */ - series?: Array; - /** Specifies the diameter of the pie. */ - diameter?: number; - /** Specifies the direction that the pie chart segments will occupy. */ - segmentsDirection?: string; - /** Specifies the angle in arc degrees from which the first segment of a pie chart should start. */ - startAngle?: number; - /** Specifies the fraction of the inner radius relative to the total radius in the series of the 'doughnut' type. The value should be between 0 and 1. */ - innerRadius?: number; - /** A handler for the legendClick event. */ - onLegendClick?: any; - /** Specifies how a chart must behave when series point labels overlap. */ - resolveLabelOverlapping?: string; - /** An object defining the configuration options that are common for all series of the dxPieChart widget. */ - commonSeriesSettings?: CommonPieSeriesSettings; - /** Specifies the type of the pie chart series. */ - type?: string; - } - /** A circular chart widget for web applications. */ - export class dxPieChart extends BaseChart { - constructor(element: JQuery, options?: dxPieChartOptions); - constructor(element: Element, options?: dxPieChartOptions); - /** - * Provides access to the dxPieChart series. - * @deprecated Use the getAllSeries() method instead. - */ - getSeries(): PieSeries; - } -} -interface JQuery { - dxChart(options?: DevExpress.viz.charts.dxChartOptions): JQuery; - dxChart(methodName: string, ...params: any[]): any; - dxChart(methodName: "instance"): DevExpress.viz.charts.dxChart; - dxPieChart(options?: DevExpress.viz.charts.dxPieChartOptions): JQuery; - dxPieChart(methodName: string, ...params: any[]): any; - dxPieChart(methodName: "instance"): DevExpress.viz.charts.dxPieChart; - dxPolarChart(options?: DevExpress.viz.charts.dxPolarChartOptions): JQuery; - dxPolarChart(methodName: string, ...params: any[]): any; - dxPolarChart(methodName: "instance"): DevExpress.viz.charts.dxPolarChart; -} -declare module DevExpress.viz.gauges { - export interface BaseRangeContainer { - /** Specifies a range container's background color. */ - backgroundColor?: string; - /** Specifies the offset of the range container from an invisible scale line in pixels. */ - offset?: number; - /** Sets the name of the palette or an array of colors to be used for coloring the gauge range container. */ - palette?: any; - /** An array of objects representing ranges contained in the range container. */ - ranges?: Array<{ startValue: number; endValue: number; color: string }>; - /** Specifies a color of a range. */ - color?: string; - /** Specifies an end value of a range. */ - endValue?: number; - /** Specifies a start value of a range. */ - startValue?: number; - } - export interface ScaleTick { - /** Specifies the color of the scale's minor ticks. */ - color?: string; - /** - * Specifies an array of custom minor ticks. - * @deprecated Use the scale | customMinorTicks option instead. - */ - customTickValues?: Array; - /** Specifies the length of the scale's minor ticks. */ - length?: number; - /** - * Indicates whether automatically calculated minor ticks are visible or not. - * @deprecated This feature is no longer available. - */ - showCalculatedTicks?: boolean; - /** - * Specifies an interval between minor ticks. - * @deprecated Use the scale | minorTickInterval option instead. - */ - tickInterval?: number; - /** Indicates whether scale minor ticks are visible or not. */ - visible?: boolean; - /** Specifies the width of the scale's minor ticks. */ - width?: number; - } - export interface ScaleMajorTick extends ScaleTick { - /** - * Specifies whether or not to expand the current major tick interval if labels overlap each other. - * @deprecated Use the overlappingBehavior | useAutoArrangement option instead. - */ - useTicksAutoArrangement?: boolean; - } - export interface ScaleMinorTick extends ScaleTick { - /** Specifies the opacity of the scale's minor ticks. */ - opacity?: number; - } - export interface BaseScaleLabel { - /** Specifies whether or not scale labels should be colored similarly to their corresponding ranges in the range container. */ - useRangeColors?: boolean; - /** Specifies a callback function that returns the text to be displayed in scale labels. */ - customizeText?: (scaleValue: { value: number; valueText: string }) => string; - /** Specifies the overlap resolving options to be applied to scale labels. */ - overlappingBehavior?: { - /** Specifies whether or not to expand the current major tick interval if labels overlap each other. */ - useAutoArrangement?: boolean; - /** Specifies what label to hide in case of overlapping. */ - hideFirstOrLast?: string; - }; - /** Specifies font options for the text displayed in the scale labels of the gauge. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in scale labels. */ - format?: string; - /** Specifies a precision for the formatted value displayed in the scale labels. */ - precision?: number; - /** Specifies whether or not scale labels are visible on the gauge. */ - visible?: boolean; - } - export interface BaseScale { - /** Specifies the end value for the scale of the gauge. */ - endValue?: number; - /** - * Specifies whether or not to hide the first scale label. - * @deprecated This feature is no longer available. - */ - hideFirstLabel?: boolean; - /** - * Specifies whether or not to hide the first major tick on the scale. - * @deprecated This feature is no longer available. - */ - hideFirstTick?: boolean; - /** - * Specifies whether or not to hide the last scale label. - * @deprecated This feature is no longer available. - */ - hideLastLabel?: boolean; - /** - * Specifies whether or not to hide the last major tick on the scale. - * @deprecated This feature is no longer available. - */ - hideLastTick?: boolean; - /** Specifies an interval between major ticks. */ - tickInterval?: number; - /** Specifies an interval between minor ticks. */ - minorTickInterval?: number; - /** Specifies an array of custom major ticks. */ - customTicks?: Array; - /** Specifies an array of custom minor ticks. */ - customMinorTicks?: Array; - /** Specifies common options for scale labels. */ - label?: BaseScaleLabel; - /** - * Specifies options of the gauge's major ticks. - * @deprecated Use the tick option instead. - */ - majorTick?: ScaleMajorTick; - /** Specifies options of the gauge's major ticks. */ - tick?: { - /** Specifies the color of the scale's major ticks. */ - color?: string; - /** Specifies the length of the scale's major ticks. */ - length?: number; - /** Indicates whether scale major ticks are visible or not. */ - visible?: boolean; - /** Specifies the width of the scale's major ticks. */ - width?: number; - /** Specifies the opacity of the scale's major ticks. */ - opacity?: number; - }; - /** Specifies options of the gauge's minor ticks. */ - minorTick?: ScaleMinorTick; - /** Specifies the start value for the scale of the gauge. */ - startValue?: number; - } - export interface BaseValueIndicator { - /** Specifies the type of subvalue indicators. */ - type?: string; - /** Specifies the background color for the indicator of the rangeBar type. */ - backgroundColor?: string; - /** Specifies the base value for the indicator of the rangeBar type. */ - baseValue?: number; - /** Specifies a color of the indicator. */ - color?: string; - /** Specifies the range bar size for an indicator of the rangeBar type. */ - size?: number; - text?: { - /** Specifies a callback function that returns the text to be displayed in an indicator. */ - customizeText?: (indicatedValue: { value: number; valueText: string }) => string; - font?: viz.core.Font; - /** Specifies a format for the text displayed in an indicator. */ - format?: string; - /** Specifies the range bar's label indent in pixels. */ - indent?: number; - /** Specifies a precision for the formatted value displayed by an indicator. */ - precision?: number; - }; - offset?: number; - length?: number; - width?: number; - /** Specifies the length of an arrow for the indicator of the textCloud type in pixels. */ - arrowLength?: number; - /** Sets the array of colors to be used for coloring subvalue indicators. */ - palette?: Array; - /** Specifies the distance between the needle and the center of a gauge for the indicator of a needle-like type. */ - indentFromCenter?: number; - /** Specifies the second color for the indicator of the twoColorNeedle type. */ - secondColor?: string; - /** Specifies the length of a twoNeedleColor type indicator tip as a percentage. */ - secondFraction?: number; - /** Specifies the spindle's diameter in pixels for the indicator of a needle-like type. */ - spindleSize?: number; - /** Specifies the inner diameter in pixels, so that the spindle has the shape of a ring. */ - spindleGapSize?: number; - /** Specifies the orientation of the rangeBar indicator on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - /** Specifies the orientation of the rangeBar indicator on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - } - export interface SharedGaugeOptions { - /** Specifies animation options. */ - animation?: viz.core.Animation; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */ - redrawOnResize?: boolean; - /** Specifies the size of the widget in pixels. */ - size?: viz.core.Size; - /** - * Specifies a subtitle for the widget. - * @deprecated Use the title | subtitle option instead. - */ - subtitle?: { - /** - * Specifies font options for the subtitle. - * @deprecated Use the title | subtitle | font option instead. - */ - font?: viz.core.Font; - /** - * Specifies a text for the subtitle. - * @deprecated Use the title | subtitle | text option instead. - */ - text?: string; - }; - /** Specifies a title for a gauge. */ - title?: { - /** Specifies font options for the title. */ - font?: viz.core.Font; - /** - * Specifies a title's position on the gauge. - * @deprecated Use the horizontalAlignment and verticalAlignment options instead. - */ - position?: string; - /** Specifies the distance between the title and surrounding gauge elements in pixels. */ - margin?: viz.core.Margins; - /** Specifies the height of the space reserved for the title. */ - placeholderSize?: number; - /** Specifies the gauge title's position in the vertical direction. */ - verticalAlignment?: string; - /** Specifies the gauge title's horizontal position. */ - horizontalAlignment?: string; - /** Specifies text for the title. */ - text?: string; - /** Specifies a subtitle for the widget. */ - subtitle?: { - /** Specifies font options for the subtitle. */ - font?: viz.core.Font; - /** Specifies text for the subtitle. */ - text?: string; - } - }; - /** Specifies options for gauge tooltips. */ - tooltip?: viz.core.Tooltip; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: dxBaseGauge; - element: Element; - target: {}; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: dxBaseGauge; - element: Element; - target: {}; - }) => void; - } - export interface BaseGaugeOptions extends viz.core.BaseWidgetOptions, SharedGaugeOptions { - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** Specifies the blank space in pixels between the widget's extreme elements and the boundaries of the area provided for the widget (see the size option). */ - margin?: viz.core.Margins; - /** Specifies options of the gauge's range container. */ - rangeContainer?: BaseRangeContainer; - /** Specifies a gauge's scale options. */ - scale?: BaseScale; - /** Specifies the appearance options of subvalue indicators. */ - subvalueIndicator?: BaseValueIndicator; - /** Specifies a set of subvalues to be designated by the subvalue indicators. */ - subvalues?: Array; - /** Specifies the main value on a gauge. */ - value?: number; - /** Specifies the appearance options of the value indicator. */ - valueIndicator?: BaseValueIndicator; - } - /** A gauge widget. */ - export class dxBaseGauge extends viz.core.BaseWidget { - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(): void; - /** Returns the main gauge value. */ - value(): number; - /** Updates a gauge value. */ - value(value: number): void; - /** Returns an array of gauge subvalues. */ - subvalues(): Array; - /** Updates gauge subvalues. */ - subvalues(subvalues: Array): void; - } - export interface LinearRangeContainer extends BaseRangeContainer { - /** Specifies the orientation of the range container on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - /** Specifies the orientation of a range container on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - /** Specifies the width of the range container's start and end boundaries in the dxLinearGauge widget. */ - width?: any; - /** Specifies an end width of a range container. */ - end?: number; - /** Specifies a start width of a range container. */ - start?: number; - } - export interface LinearScaleLabel extends BaseScaleLabel { - /** Specifies the spacing between scale labels and ticks. */ - indentFromTick?: number; - } - export interface LinearScale extends BaseScale { - /** Specifies the orientation of scale ticks on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - label?: LinearScaleLabel; - /** Specifies the orientation of scale ticks on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - } - export interface dxLinearGaugeOptions extends BaseGaugeOptions { - /** Specifies the options required to set the geometry of the dxLinearGauge widget. */ - geometry?: { - /** Indicates whether to display the dxLinearGauge widget vertically or horizontally. */ - orientation?: string; - }; - /** Specifies gauge range container options. */ - rangeContainer?: LinearRangeContainer; - scale?: LinearScale; - } - /** A widget that represents a gauge with a linear scale. */ - export class dxLinearGauge extends dxBaseGauge { - constructor(element: JQuery, options?: dxLinearGaugeOptions); - constructor(element: Element, options?: dxLinearGaugeOptions); - } - export interface CircularRangeContainer extends BaseRangeContainer { - /** Specifies the orientation of the range container in the dxCircularGauge widget. */ - orientation?: string; - /** Specifies the range container's width in pixels. */ - width?: number; - } - export interface CircularScaleLabel extends BaseScaleLabel { - /** Specifies the spacing between scale labels and ticks. */ - indentFromTick?: number; - } - export interface CircularScale extends BaseScale { - label?: CircularScaleLabel; - /** Specifies the orientation of scale ticks. */ - orientation?: string; - } - export interface dxCircularGaugeOptions extends BaseGaugeOptions { - /** Specifies the options required to set the geometry of the dxCircularGauge widget. */ - geometry?: { - /** Specifies the end angle of the circular gauge's arc. */ - endAngle?: number; - /** Specifies the start angle of the circular gauge's arc. */ - startAngle?: number; - }; - /** Specifies gauge range container options. */ - rangeContainer?: CircularRangeContainer; - scale?: CircularScale; - } - /** A widget that represents a gauge with a circular scale. */ - export class dxCircularGauge extends dxBaseGauge { - constructor(element: JQuery, options?: dxCircularGaugeOptions); - constructor(element: Element, options?: dxCircularGaugeOptions); - } - export interface dxBarGaugeOptions extends viz.core.BaseWidgetOptions, SharedGaugeOptions { - /** Specifies a color for the remaining segment of the bar's track. */ - backgroundColor?: string; - /** Specifies a distance between bars in pixels. */ - barSpacing?: number; - /** Specifies a base value for bars. */ - baseValue?: number; - /** Specifies an end value for the gauge's invisible scale. */ - endValue?: number; - /** Defines the shape of the gauge's arc. */ - geometry?: { - /** Specifies the end angle of the bar gauge's arc. */ - endAngle?: number; - /** Specifies the start angle of the bar gauge's arc. */ - startAngle?: number; - }; - /** Specifies the options of the labels that accompany gauge bars. */ - label?: { - /** Specifies a color for the label connector text. */ - connectorColor?: string; - /** Specifies the width of the label connector in pixels. */ - connectorWidth?: number; - /** Specifies a callback function that returns a text for labels. */ - customizeText?: (barValue: { value: number; valueText: string }) => string; - /** Specifies font options for bar labels. */ - font?: viz.core.Font; - /** Specifies a format for bar labels. */ - format?: string; - /** Specifies the distance between the upper bar and bar labels in pixels. */ - indent?: number; - /** Specifies a precision for the formatted value displayed by labels. */ - precision?: number; - /** Specifies whether bar labels appear on a gauge or not. */ - visible?: boolean; - }; - /** Sets the name of the palette or an array of colors to be used for coloring the gauge range container. */ - palette?: any; - /** Defines the radius of the bar that is closest to the center relatively to the radius of the topmost bar. */ - relativeInnerRadius?: number; - /** Specifies a start value for the gauge's invisible scale. */ - startValue?: number; - /** Specifies the array of values to be indicated on a bar gauge. */ - values?: Array; - } - /** A circular bar widget. */ - export class dxBarGauge extends viz.core.BaseWidget { - constructor(element: JQuery, options?: dxBarGaugeOptions); - constructor(element: Element, options?: dxBarGaugeOptions); - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws the widget. */ - render(): void; - /** Returns an array of gauge values. */ - values(): Array; - /** Updates the values displayed by a gauge. */ - values(values: Array): void; - } -} -interface JQuery { - dxLinearGauge(options?: DevExpress.viz.gauges.dxLinearGaugeOptions): JQuery; - dxLinearGauge(methodName: string, ...params: any[]): any; - dxLinearGauge(methodName: "instance"): DevExpress.viz.gauges.dxLinearGauge; - dxCircularGauge(options?: DevExpress.viz.gauges.dxCircularGaugeOptions): JQuery; - dxCircularGauge(methodName: string, ...params: any[]): any; - dxCircularGauge(methodName: "instance"): DevExpress.viz.gauges.dxCircularGauge; - dxBarGauge(options?: DevExpress.viz.gauges.dxBarGaugeOptions): JQuery; - dxBarGauge(methodName: string, ...params: any[]): any; - dxBarGauge(methodName: "instance"): DevExpress.viz.gauges.dxBarGauge; -} -declare module DevExpress.viz.rangeSelector { - export interface dxRangeSelectorOptions extends viz.core.BaseWidgetOptions { - /** Specifies the options for the range selector's background. */ - background?: { - /** Specifies the background color for the dxRangeSelector. */ - color?: string; - /** Specifies image options. */ - image?: { - /** Specifies a location for the image in the background of a range selector. */ - location?: string; - /** Specifies the image's URL. */ - url?: string; - }; - /** Indicates whether or not the background (background color and/or image) is visible. */ - visible?: boolean; - }; - /** Specifies a title for the range selector. */ - title?: viz.core.Title; - /** Specifies the dxRangeSelector's behavior options. */ - behavior?: { - /** Indicates whether or not you can swap sliders. */ - allowSlidersSwap?: boolean; - /** Indicates whether or not animation is enabled. */ - animationEnabled?: boolean; - /** Specifies when to call the onSelectedRangeChanged function. */ - callSelectedRangeChanged?: string; - /** Indicates whether or not an end user can specify the range using a mouse, without the use of sliders. */ - manualRangeSelectionEnabled?: boolean; - /** Indicates whether or not an end user can shift the selected range to the required location on a scale by clicking. */ - moveSelectedRangeByClick?: boolean; - /** Indicates whether to snap a slider to ticks. */ - snapToTicks?: boolean; - }; - /** Specifies the options required to display a chart as the range selector's background. */ - chart?: { - /** Specifies a coefficient for determining an indent from the bottom background boundary to the lowest chart point. */ - bottomIndent?: number; - /** An object defining the common configuration options for the chart’s series. */ - commonSeriesSettings?: viz.charts.CommonSeriesSettings; - /** An object providing options for managing data from a data source. */ - dataPrepareSettings?: { - /** Specifies whether or not to validate values from a data source. */ - checkTypeForAllData?: boolean; - /** Specifies whether or not to convert the values from a data source into the data type of an axis. */ - convertToAxisDataType?: boolean; - /** Specifies how to sort series points. */ - sortingMethod?: any; - }; - /** Specifies whether all bars in a series must have the same width, or may have different widths if any points in other series are missing. */ - equalBarWidth?: boolean; - /** Specifies a common bar width as a percentage from 0 to 1. */ - barWidth?: number; - /** Forces the widget to treat negative values as zeroes. Applies to stacked-like series only. */ - negativesAsZeroes?: boolean; - /** Sets the name of the palette to be used in the range selector's chart. Alternatively, an array of colors can be set as a custom palette to be used within this chart. */ - palette?: any; - /** An object defining the chart’s series. */ - series?: Array; - /** Defines options for the series template. */ - seriesTemplate?: viz.charts.SeriesTemplate; - /** Specifies a coefficient for determining an indent from the background's top boundary to the topmost chart point. */ - topIndent?: number; - /** Specifies whether or not to filter the series points depending on their quantity. */ - useAggregation?: boolean; - /** Specifies options for the chart's value axis. */ - valueAxis?: { - /** Indicates whether or not the chart's value axis must be inverted. */ - inverted?: boolean; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic value axis. */ - logarithmBase?: number; - /** Specifies the maximum value of the chart's value axis. */ - max?: number; - /** Specifies the minimum value of the chart's value axis. */ - min?: number; - /** Specifies the type of the value axis. */ - type?: string; - /** Specifies the desired type of axis values. */ - valueType?: string; - }; - }; - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** Specifies a data source for the scale values and for the chart at the background. */ - dataSource?: any; - /** Specifies the data source field that provides data for the scale. */ - dataSourceField?: string; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies the blank space in pixels between the dxRangeSelector widget's extreme elements and the boundaries of the area provided for the widget (see size). */ - margin?: viz.core.Margins; - /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */ - redrawOnResize?: boolean; - /** Specifies options of the range selector's scale. */ - scale?: { - /** Specifies the scale's end value. */ - endValue?: any; - /** Specifies common options for scale labels. */ - label?: { - /** Specifies a callback function that returns the text to be displayed in scale labels. */ - customizeText?: (scaleValue: { value: any; valueText: string; }) => string; - /** Specifies font options for the text displayed in the range selector's scale labels. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in scale labels. */ - format?: string; - /** Specifies a precision for the formatted value displayed in the scale labels. */ - precision?: number; - /** Specifies a spacing between scale labels and the background bottom edge. */ - topIndent?: number; - /** Specifies whether or not the scale's labels are visible. */ - visible?: boolean; - }; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic scale. */ - logarithmBase?: number; - /** - * Specifies an interval between major ticks. - * @deprecated Use the tickInterval option instead. - */ - majorTickInterval?: any; - /** Specifies an interval between axis ticks. */ - tickInterval?: any; - /** Specifies options for the date-time scale's markers. */ - marker?: { - /** Defines the options that can be set for the text that is displayed by the scale markers. */ - label?: { - /** Specifies a callback function that returns the text to be displayed in scale markers. */ - customizeText?: (markerValue: { value: any; valueText: string }) => string; - /** Specifies a format for the text displayed in scale markers. */ - format?: string; - }; - /** Specifies the height of the marker's separator. */ - separatorHeight?: number; - /** Specifies the space between the marker label and the marker separator. */ - textLeftIndent?: number; - /** Specifies the space between the marker's label and the top edge of the marker's separator. */ - textTopIndent?: number; - /** Specified the indent between the marker and the scale lables. */ - topIndent?: number; - /** Indicates whether scale markers are visible. */ - visible?: boolean; - }; - /** Specifies the maximum range that can be selected. */ - maxRange?: any; - /** Specifies the number of minor ticks between neighboring major ticks. */ - minorTickCount?: number; - /** Specifies an interval between minor ticks. */ - minorTickInterval?: any; - /** Specifies the minimum range that can be selected. */ - minRange?: any; - /** Specifies the height of the space reserved for the scale in pixels. */ - placeholderHeight?: number; - /** Indicates whether or not to set ticks of a date-time scale at the beginning of each date-time interval. */ - setTicksAtUnitBeginning?: boolean; - /** Specifies whether or not to show ticks for the boundary scale values, when neither major ticks nor minor ticks are created for these values. */ - showCustomBoundaryTicks?: boolean; - /** - * Indicates whether or not to show minor ticks on the scale. - * @deprecated Use the minorTick | visible option instead. - */ - showMinorTicks?: boolean; - /** Specifies the scale's start value. */ - startValue?: any; - /** Specifies options defining the appearance of scale ticks. */ - tick?: { - /** Specifies the color of scale ticks (both major and minor ticks). */ - color?: string; - /** Specifies the opacity of scale ticks (both major and minor ticks). */ - opacity?: number; - /** Specifies the width of the scale's ticks (both major and minor ticks). */ - width?: number; - }; - /** Specifies options of the range selector's minor ticks. */ - minorTick?: { - /** Specifies the color of the scale's minor ticks. */ - color?: string; - /** Specifies the opacity of the scale's minor ticks. */ - opacity?: number; - /** Specifies the width of the scale's minor ticks. */ - width?: number; - /** Indicates whether scale minor ticks are visible or not. */ - visible?: boolean; - }; - /** Specifies the type of the scale. */ - type?: string; - /** Specifies whether or not to expand the current tick interval if labels overlap each other. */ - useTicksAutoArrangement?: boolean; - /** Specifies the type of values on the scale. */ - valueType?: string; - /** Specifies the order of arguments on a discrete scale. */ - categories?: Array; - }; - /** Specifies the range to be selected when displaying the dxRangeSelector. */ - selectedRange?: { - /** Specifies the start value of the range to be selected when displaying the dxRangeSelector widget on a page. */ - startValue?: any; - /** Specifies the end value of the range to be selected when displaying the dxRangeSelector widget on a page. */ - endValue?: any; - }; - /** Specifies the color of the selected range. */ - selectedRangeColor?: string; - /** Range selector's indent options. */ - indent?: { - /** Specifies range selector's left indent. */ - left?: number; - /** Specifies range selector's right indent. */ - right?: number; - }; - /** A handler for the selectedRangeChanged event. */ - onSelectedRangeChanged?: (e: { - startValue: any; - endValue: any; - component: dxRangeSelector; - element: Element; - }) => void; - /** Specifies range selector shutter options. */ - shutter?: { - /** Specifies shutter color. */ - color?: string; - /** Specifies the opacity of the color of shutters. */ - opacity?: number; - }; - /** Specifies in pixels the size of the dxRangeSelector widget. */ - size?: viz.core.Size; - /** Specifies the appearance of the range selector's slider handles. */ - sliderHandle?: { - /** Specifies the color of the slider handles. */ - color?: string; - /** Specifies the opacity of the slider handles. */ - opacity?: number; - /** Specifies the width of the slider handles. */ - width?: number; - }; - /** Defines the options of the range selector slider markers. */ - sliderMarker?: { - /** Specifies the color of the slider markers. */ - color?: string; - /** Specifies a callback function that returns the text to be displayed by slider markers. */ - customizeText?: (scaleValue: { value: any; valueText: any; }) => string; - /** Specifies font options for the text displayed by the range selector slider markers. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in slider markers. */ - format?: string; - /** Specifies the color used for the slider marker text when the currently selected range does not match the minRange and maxRange values. */ - invalidRangeColor?: string; - /** - * Specifies the empty space between the marker's border and the marker’s text. - * @deprecated Use the paddingTopBottom and paddingLeftRight options instead. - */ - padding?: number; - /** Specifies the empty space between the marker's top and bottom borders and the marker's text. */ - paddingTopBottom?: number; - /** Specifies the empty space between the marker's left and right borders and the marker's text. */ - paddingLeftRight?: number; - /** Specifies the placeholder height of the slider marker. */ - placeholderHeight?: number; - /** - * Specifies in pixels the height and width of the space reserved for the range selector slider markers. - * @deprecated Use the placeholderHeight and indent options instead. - */ - placeholderSize?: { - /** Specifies the height of the placeholder for the left and right slider markers. */ - height?: number; - /** Specifies the width of the placeholder for the left and right slider markers. */ - width?: { - /** Specifies the width of the left slider marker's placeholder. */ - left?: number; - /** Specifies the width of the right slider marker's placeholder. */ - right?: number; - }; - }; - /** Specifies a precision for the formatted value displayed in slider markers. */ - precision?: number; - /** Indicates whether or not the slider markers are visible. */ - visible?: boolean; - }; - } - /** A widget that allows end users to select a range of values on a scale. */ - export class dxRangeSelector extends viz.core.BaseWidget { - constructor(element: JQuery, options?: dxRangeSelectorOptions); - constructor(element: Element, options?: dxRangeSelectorOptions); - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(skipChartAnimation?: boolean): void; - /** Returns the currently selected range. */ - getSelectedRange(): { startValue: any; endValue: any; }; - /** Sets a specified range. */ - setSelectedRange(selectedRange: { startValue: any; endValue: any; }): void; - } -} -interface JQuery { - dxRangeSelector(options?: DevExpress.viz.rangeSelector.dxRangeSelectorOptions): JQuery; - dxRangeSelector(methodName: string, ...params: any[]): any; - dxRangeSelector(methodName: "instance"): DevExpress.viz.rangeSelector.dxRangeSelector; -} -declare module DevExpress.viz.map { - /** This section describes the fields and methods that can be used in code to manipulate the Layer object. */ - export interface MapLayer { - /** The name of the layer. */ - name: string; - /** The layer index in the layers array. */ - index: number; - /** The layer type. Can be "area", "line" or "marker". */ - type: string; - /** The type of the layer elements. */ - elementType: string; - /** Gets all layer elements. */ - getElements(): Array; - /** Deselects all layer elements. */ - clearSelection(): void; - } - /** This section describes the fields and methods that can be used in code to manipulate the Layer Element object. */ - export interface MapLayerElement { - /** The parent layer of the layer element. */ - layer: MapLayer; - /** Gets the layer element coordinates. */ - coordinates(): Object; - /** Sets the value of an attribute. */ - attribute(name: string, value: any): void; - /** Gets the value of an attribute. */ - attribute(name: string): any; - /** Gets the selection state of the layer element. */ - selected(): boolean; - /** Sets the selection state of the layer element. */ - selected(state: boolean): void; - /** Applies the layer element settings and updates element appearance. */ - applySettings(settings: any): void; - } - /** - * This section describes the fields and methods that can be used in code to manipulate the Area object. - * @deprecated Use the Layer Element instead. - */ - export interface Area { - /** - * Contains the element type. - * @deprecated Use the Layer | type instead. - */ - type: string; - /** - * Return the value of an attribute. - * @deprecated Use the Layer Element | attribute(name, value) method instead. - */ - attribute(name: string): any; - /** - * Provides information about the selection state of an area. - * @deprecated Use the Layer Element | selected() method instead. - */ - selected(): boolean; - /** - * Sets a new selection state for an area. - * @deprecated Use the Layer Element | selected(state) method instead. - */ - selected(state: boolean): void; - /** - * Applies the area settings specified as a parameter and updates the area appearance. - * @deprecated Use the Layer Element | applySettings(settings) method instead. - */ - applySettings(settings: any): void; - } - /** - * This section describes the fields and methods that can be used in code to manipulate the Markers object. - * @deprecated Use the Layer Element instead. - */ - export interface Marker { - /** - * Contains the descriptive text accompanying the map marker. - * @deprecated Get the text using the Layer Element | attribute(name) method. The name parameter value for text is set at the dataField option. - */ - text: string; - /** - * Contains the type of the element. - * @deprecated Use the Layer | type instead. - */ - type: string; - /** - * Contains the URL of an image map marker. - * @deprecated Get the image URL using the Layer Element | attribute(name) method. The name parameter value for the image URL is set at the dataField option. - */ - url: string; - /** - * Contains the value of a bubble map marker. - * @deprecated Get the bubble value using the Layer Element | attribute(name) method. The name parameter for the bubble value is set at the dataField option. - */ - value: number; - /** - * Contains the values of a pie map marker. - * @deprecated Get the pie values using the Layer Element | attribute(name) method. The name parameter for pie values is set at the dataField option. - */ - values: Array; - /** - * Returns the value of an attribute. - * @deprecated Use the Layer Element | attribute(name, value) method instead. - */ - attribute(name: string): any; - /** - * Returns the coordinates of a specific marker. - * @deprecated Use the Layer Element | coordinates() method instead. - */ - coordinates(): Array; - /** - * Provides information about the selection state of a marker. - * @deprecated Use the Layer Element | selected() method instead. - */ - selected(): boolean; - /** - * Sets a new selection state for a marker. - * @deprecated Use the Layer Element | selected(state) method instead. - */ - selected(state: boolean): void; - /** - * Applies the marker settings specified as a parameter and updates marker appearance. - * @deprecated Use the Layer Element | applySettings(settings) method instead. - */ - applySettings(settings: any): void; - } - export interface MapLayerSettings { - /** Specifies the layer name. */ - name?: string; - /** Specifies layer type. */ - type?: string; - /** Specifies the type of a marker element. Setting this option makes sense only if the layer type is "marker". */ - elementType?: string; - /** Specifies a data source for the layer. */ - dataSource?: any; - /** Specifies the line width (for layers of a line type) or width of the layer elements border in pixels. */ - borderWidth?: number; - /** Specifies a color for the border of the layer elements. */ - borderColor?: string; - /** Specifies a color for layer elements. */ - color?: string; - /** Specifies a color for the border of the layer element when it is hovered over. */ - hoveredBorderColor?: string; - /** Specifies the pixel-measured line width (for layers of a line type) or width for the border of the layer element when it is hovered over. */ - hoveredBorderWidth?: number; - /** Specifies a color for a layer element when it is hovered over. */ - hoveredColor?: string; - /** Specifies a pixel-measured line width (for layers of a line type) or width for the border of the layer element when it is selected. */ - selectedBorderWidth?: number; - /** Specifies a color for the border of the layer element when it is selected. */ - selectedBorderColor?: string; - /** Specifies a color for the layer element when it is selected. */ - selectedColor?: string; - /** Specifies the layer opacity (from 0 to 1). */ - opacity?: number; - /** Specifies the size of markers. Setting this option makes sense only if the layer type is "marker" and the elementType is "dot", "pie" or "image". */ - size?: number; - /** Specifies the pixel-measured diameter of the marker that represents the smallest value. Setting this option makes sense only if the layer type is "marker". */ - minSize?: number; - /** Specifies the pixel-measured diameter of the marker that represents the biggest value. Setting this option makes sense only if the layer type is "marker". */ - maxSize?: number; - /** Specifies whether or not to change the appearance of a layer element when it is hovered over. */ - hoverEnabled?: boolean; - /** Specifies whether single or multiple map elements can be selected on a vector map. */ - selectionMode?: string; - /** Specifies the name of the palette or a custom range of colors to be used for coloring a layer. */ - palette?: any; - /** Specifies the number of colors in a palette. */ - paletteSize?: number; - /** Allows you to paint layer elements with similar attributes in the same color. */ - colorGroups?: Array; - /** Specifies the field that provides data to be used for coloring of layer elements. */ - colorGroupingField?: string; - /** Allows you to display bubbles with similar attributes in the same size. Setting this option makes sense only if the layer type is "marker" and the elementType is "bubble". */ - sizeGroups?: Array; - /** Specifies the field that provides data to be used for sizing bubble markers. Setting this option makes sense only if the layer type is "marker" and the elementType is "bubble". */ - sizeGroupingField?: string; - /** Specifies the name of the attribute containing marker data. Setting this option makes sense only if the layer type is "marker" and the elementType is "bubble", "pie" or "image". */ - dataField?: string; - /** Specifies the function that customizes each layer element individually. */ - customize?: (eleemnts: Array) => void; - /** Specifies marker label options. */ - label?: { - /** The name of the dataSource attribute containing marker texts. */ - dataField?: string; - /** Enables marker labels. */ - enabled?: boolean; - /** Specifies font options for marker labels. */ - font?: viz.core.Font; - }; - } - export interface AreaSettings { - /** - * Specifies the width of the area border in pixels. - * @deprecated Use the layers | borderWidth option instead. - */ - borderWidth?: number; - /** - * Specifies a color for the area border. - * @deprecated Use the layers | borderColor option instead. - */ - borderColor?: string; - /** - * Specifies a color for an area. - * @deprecated Use the layers | color option instead. - */ - color?: string; - /** - * Specifies the function that customizes each area individually. - * @deprecated Use the layers | customize option instead. - */ - customize?: (areaInfo: Area) => AreaSettings; - /** - * Specifies a color for the area border when the area is hovered over. - * @deprecated Use the layers | hoveredBorderColor option instead. - */ - hoveredBorderColor?: string; - /** - * Specifies the pixel-measured width of the area border when the area is hovered over. - * @deprecated Use the layers | hoveredBorderWidth option instead. - */ - hoveredBorderWidth?: number; - /** - * Specifies a color for an area when this area is hovered over. - * @deprecated Use the layers | hoveredColor option instead. - */ - hoveredColor?: string; - /** - * Specifies whether or not to change the appearance of an area when it is hovered over. - * @deprecated Use the layers | hoverEnabled option instead. - */ - hoverEnabled?: boolean; - /** - * Configures area labels. - * @deprecated Use the layers | label option instead. - */ - label?: { - /** - * Specifies the data field that provides data for area labels. - * @deprecated Use the layers | label | dataField option instead. - */ - dataField?: string; - /** - * Enables area labels. - * @deprecated Use the layers | label | enabled option instead. - */ - enabled?: boolean; - /** - * Specifies font options for area labels. - * @deprecated Use the layers | label | font option instead. - */ - font?: viz.core.Font; - }; - /** - * Specifies the name of the palette or a custom range of colors to be used for coloring a map. - * @deprecated Use the layers | palette option instead. - */ - palette?: any; - /** - * Specifies the number of colors in a palette. - * @deprecated Use the layers | paletteSize option instead. - */ - paletteSize?: number; - /** - * Allows you to paint areas with similar attributes in the same color. - * @deprecated Use the layers | colorGroups option instead. - */ - colorGroups?: Array; - /** - * Specifies the field that provides data to be used for coloring areas. - * @deprecated Use the layers | colorGroupingField option instead. - */ - colorGroupingField?: string; - /** - * Specifies a color for the area border when the area is selected. - * @deprecated Use the layers | selectedBorderColor option instead. - */ - selectedBorderColor?: string; - /** - * Specifies a color for an area when this area is selected. - * @deprecated Use the layers | selectedColor option instead. - */ - selectedColor?: string; - /** - * Specifies the pixel-measured width of the area border when the area is selected. - * @deprecated Use the layers | selectedBorderWidth option instead. - */ - selectedBorderWidth?: number; - /** - * Specifies whether single or multiple areas can be selected on a vector map. - * @deprecated Use the layers | selectionMode option instead. - */ - selectionMode?: string; - } - export interface MarkerSettings { - /** - * Specifies a color for the marker border. - * @deprecated Use the layers | borderColor option instead. - */ - borderColor?: string; - /** - * Specifies the width of the marker border in pixels. - * @deprecated Use the layers | borderWidth option instead. - */ - borderWidth?: number; - /** - * Specifies a color for a marker of the dot or bubble type. - * @deprecated Use the layers | color option instead. - */ - color?: string; - /** - * Specifies the function that customizes each marker individually. - * @deprecated Use the layers | customize option instead. - */ - customize?: (markerInfo: Marker) => MarkerSettings; - /** - * Specifies the pixel-measured width of the marker border when the marker is hovered over. - * @deprecated Use the layers | hoveredBorderWidth option instead. - */ - hoveredBorderWidth?: number; - /** - * Specifies a color for the marker border when the marker is hovered over. - * @deprecated Use the layers | hoveredBorderColor option instead. - */ - hoveredBorderColor?: string; - /** - * Specifies a color for a marker of the dot or bubble type when this marker is hovered over. - * @deprecated Use the layers | hoveredColor option instead. - */ - hoveredColor?: string; - /** - * Specifies whether or not to change the appearance of a marker when it is hovered over. - * @deprecated Use the layers | hoverEnabled option instead. - */ - hoverEnabled?: boolean; - /** - * Specifies marker label options. - * @deprecated Use the layers | label option instead. - */ - label?: { - /** - * Enables marker labels. - * @deprecated Use the layers | label | enabled option instead. - */ - enabled?: boolean; - /** - * Specifies font options for marker labels. - * @deprecated Use the layers | label | font option instead. - */ - font?: viz.core.Font; - }; - /** - * Specifies the pixel-measured diameter of the marker that represents the biggest value. Setting this option makes sense only if you use markers of the bubble type. - * @deprecated Use the layers | maxSize option instead. - */ - maxSize?: number; - /** - * Specifies the pixel-measured diameter of the marker that represents the smallest value. Setting this option makes sense only if you use markers of the bubble type. - * @deprecated Use the layers | minSize option instead. - */ - minSize?: number; - /** - * Specifies the opacity of markers. Setting this option makes sense only if you use markers of the bubble type. - * @deprecated Use the layers | opacity option instead. - */ - opacity?: number; - /** - * Specifies the pixel-measured width of the marker border when the marker is selected. - * @deprecated Use the layers | selectedBorderWidth option instead. - */ - selectedBorderWidth?: number; - /** - * Specifies a color for the marker border when the marker is selected. - * @deprecated Use the layers | selectedBorderColor option instead. - */ - selectedBorderColor?: string; - /** - * Specifies a color for a marker of the dot or bubble type when this marker is selected. - * @deprecated Use the layers | selectedColor option instead. - */ - selectedColor?: string; - /** - * Specifies whether a single or multiple markers can be selected on a vector map. - * @deprecated Use the layers | selectionMode option instead. - */ - selectionMode?: string; - /** - * Specifies the size of markers. Setting this option makes sense for any type of marker except bubble. - * @deprecated Use the layers | size option instead. - */ - size?: number; - /** - * Specifies the type of markers to be used on the map. - * @deprecated Use the layers | elementType option instead. - */ - type?: string; - /** - * Specifies the name of a palette or a custom set of colors to be used for coloring markers of the pie type. - * @deprecated Use the layers | palette option instead. - */ - palette?: any; - /** - * Allows you to paint markers with similar attributes in the same color. - * @deprecated Use the layers | colorGroups option instead. - */ - colorGroups?: Array; - /** - * Specifies the field that provides data to be used for coloring markers. - * @deprecated Use the layers | colorGroupingField option instead. - */ - colorGroupingField?: string; - /** - * Allows you to display bubbles with similar attributes in the same size. - * @deprecated Use the layers | sizeGroups option instead. - */ - sizeGroups?: Array; - /** - * Specifies the field that provides data to be used for sizing bubble markers. - * @deprecated Use the layers | sizeGroupingField option instead. - */ - sizeGroupingField?: string; - } - export interface dxVectorMapOptions extends viz.core.BaseWidgetOptions { - /** - * An object specifying options for the map areas. - * @deprecated Use the "area" type element of the layers array. - */ - areaSettings?: AreaSettings; - /** Specifies the options for the map background. */ - background?: { - /** Specifies a color for the background border. */ - borderColor?: string; - /** Specifies a color for the background. */ - color?: string; - }; - /** Specifies options for dxVectorMap widget layers. */ - layers?: Array; - /** Specifies the map projection. */ - projection?: Object; - /** Specifies the positioning of a map in geographical coordinates. */ - bounds?: Array; - /** Specifies the options of the control bar. */ - controlBar?: { - /** Specifies a color for the outline of the control bar elements. */ - borderColor?: string; - /** Specifies a color for the inner area of the control bar elements. */ - color?: string; - /** Specifies whether or not to display the control bar. */ - enabled?: boolean; - /** Specifies the margin of the control bar in pixels. */ - margin?: number; - /** Specifies the position of the control bar. */ - horizontalAlignment?: string; - /** Specifies the position of the control bar. */ - verticalAlignment?: string; - /** Specifies the opacity of the control bar. */ - opacity?: number; - }; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** - * Specifies a data source for the map area. - * @deprecated Use the layers | dataSource option instead. - */ - mapData?: any; - /** - * Specifies a data source for the map markers. - * @deprecated Use the layers | dataSource option instead. - */ - markers?: any; - /** - * An object specifying options for the map markers. - * @deprecated Use the "marker" type element of the layers array. - */ - markerSettings?: MarkerSettings; - /** Specifies the size of the dxVectorMap widget. */ - size?: viz.core.Size; - /** Specifies a title for the vector map. */ - title?: viz.core.Title; - /** Specifies tooltip options. */ - tooltip?: viz.core.Tooltip; - /** Configures map legends. */ - legends?: Array; - /** Specifies whether or not the map should respond when a user rolls the mouse wheel. */ - wheelEnabled?: boolean; - /** Specifies whether the map should respond to touch gestures. */ - touchEnabled?: boolean; - /** Disables the zooming capability. */ - zoomingEnabled?: boolean; - /** Specifies the geographical coordinates of the center for a map. */ - center?: Array; - /** A handler for the centerChanged event. */ - onCenterChanged?: (e: { - center: Array; - component: dxVectorMap; - element: Element; - }) => void; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: dxVectorMap; - element: Element; - target: {}; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: dxVectorMap; - element: Element; - target: {}; - }) => void; - /** Specifies a number that is used to zoom a map initially. */ - zoomFactor?: number; - /** Specifies a map's maximum zoom factor. */ - maxZoomFactor?: number; - /** A handler for the zoomFactorChanged event. */ - onZoomFactorChanged?: (e: { - component: dxVectorMap; - element: Element; - zoomFactor: number; - }) => void; - /** A handler for the click event. */ - onClick?: any; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: (e: { - component: dxVectorMap; - element: Element; - target: MapLayerElement; - }) => void; - /** - * A handler for the areaClick event. - * @deprecated Use the onClick option instead. - */ - onAreaClick?: any; - /** - * A handler for the areaSelectionChanged event. - * @deprecated Use the onSelectionChanged option instead. - */ - onAreaSelectionChanged?: (e: { - target: Area; - component: dxVectorMap; - element: Element; - }) => void; - /** - * A handler for the markerClick event. - * @deprecated Use the onClick option instead. - */ - onMarkerClick?: any; - /** - * A handler for the markerSelectionChanged event. - * @deprecated Use the onSelecitonChanged option instead. - */ - onMarkerSelectionChanged?: (e: { - target: Marker; - component: dxVectorMap; - element: Element; - }) => void; - /** Disables the panning capability. */ - panningEnabled?: boolean; - } - export interface Legend extends viz.core.BaseLegend { - /** Specifies the color of item markers in the legend. The specified color applied only when the legend uses 'size' source. */ - markerColor?: string; - /** Specifies text for legend items. */ - customizeText?: (itemInfo: { start: number; end: number; index: number; color: string; size: number; }) => string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the text of a legend item. */ - customizeHint?: (itemInfo: { start: number; end: number; index: number; color: string; size: number }) => string; - /** Specifies the source of data for the legend. */ - source?: { - /** Specifies a layer to which the legend belongs. */ - layer?: string; - /** Specifies the type of the legend grouping. */ - grouping?: string; - } - } - /** A vector map widget. */ - export class dxVectorMap extends viz.core.BaseWidget { - constructor(element: JQuery, options?: dxVectorMapOptions); - constructor(element: Element, options?: dxVectorMapOptions); - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(): void; - /** Gets the current coordinates of the map center. */ - center(): Array; - /** Sets the coordinates of the map center. */ - center(centerCoordinates: Array): void; - /** - * Deselects all the selected areas on a map. The areas are displayed in their initial style after. - * @deprecated Use the layer's clearSelection() method instead. - */ - clearAreaSelection(): void; - /** - * Deselects all the selected markers on a map. The markers are displayed in their initial style after. - * @deprecated Use the layer's clearSelection() method instead. - */ - clearMarkerSelection(): void; - /** Deselects all the selected area and markers on a map at once. The areas and markers are displayed in their initial style after. */ - clearSelection(): void; - /** Converts client area coordinates into map coordinates. */ - convertCoordinates(x: number, y: number): Array; - /** Gets all map layers. */ - getLayers(): Array; - /** Gets the layer by its index. */ - getLayerByIndex(index: number): MapLayer; - /** Gets the layer by its name. */ - getLayerByName(name: string): MapLayer; - /** - * Returns an array with all the map areas. - * @deprecated Use the layer's getElements() method instead. - */ - getAreas(): Array; - /** - * Returns an array with all the map markers. - * @deprecated Use the layer's getElements() method instead. - */ - getMarkers(): Array; - /** Gets the current coordinates of the map viewport. */ - viewport(): Array; - /** Sets the coordinates of the map viewport. */ - viewport(viewportCoordinates: Array): void; - /** Gets the current value of the map zoom factor. */ - zoomFactor(): number; - /** Sets the value of the map zoom factor. */ - zoomFactor(zoomFactor: number): void; - } - export var projection: ProjectionCreator; - export interface ProjectionCreator { - /** Creates a new projection. */ - (data: { - to?: (coordinates: Array) => Array; - from?: (coordinates: Array) => Array; - aspectRatio?: number; - }): Object; - /** Gets the default or custom projection from the projection storage. */ - get(name: string): Object; - /** Adds a new projection to the internal projections storage. */ - add(name: string, projection: Object): void; - } -} -interface JQuery { - dxVectorMap(options?: DevExpress.viz.map.dxVectorMapOptions): JQuery; - dxVectorMap(methodName: string, ...params: any[]): any; - dxVectorMap(methodName: "instance"): DevExpress.viz.map.dxVectorMap; -} -declare module DevExpress.viz.sparklines { - export interface SparklineTooltip extends viz.core.Tooltip { - /** - * Specifies how a tooltip is horizontally aligned relative to the graph. - * @deprecated Tooltip alignment is no longer useful because the tooltips are aligned automatically. - */ - horizontalAlignment?: string; - /** - * Specifies how a tooltip is vertically aligned relative to the graph. - * @deprecated Tooltip alignment is no longer useful because the tooltips are aligned automatically. - */ - verticalAlignment?: string; - } - export interface BaseSparklineOptions extends viz.core.BaseWidgetOptions { - /** Specifies the blank space between the widget's extreme elements and the boundaries of the area provided for the widget in pixels. */ - margin?: viz.core.Margins; - /** Specifies the size of the widget. */ - size?: viz.core.Size; - /** Specifies tooltip options. */ - tooltip?: SparklineTooltip; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: BaseSparkline; - element: Element; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: BaseSparkline; - element: Element; - }) => void; - } - /** Overridden by descriptions for particular widgets. */ - export class BaseSparkline extends viz.core.BaseWidget { - /** Redraws a widget. */ - render(): void; - } - export interface dxBulletOptions extends BaseSparklineOptions { - /** Specifies a color for the bullet bar. */ - color?: string; - /** Specifies an end value for the invisible scale. */ - endScaleValue?: number; - /** Specifies whether or not to show the target line. */ - showTarget?: boolean; - /** Specifies whether or not to show the line indicating zero on the invisible scale. */ - showZeroLevel?: boolean; - /** Specifies a start value for the invisible scale. */ - startScaleValue?: number; - /** Specifies the value indicated by the target line. */ - target?: number; - /** Specifies a color for both the target and zero level lines. */ - targetColor?: string; - /** Specifies the width of the target line. */ - targetWidth?: number; - /** Specifies the primary value indicated by the bullet bar. */ - value?: number; - } - /** A bullet graph widget. */ - export class dxBullet extends BaseSparkline { - constructor(element: JQuery, options?: dxBulletOptions); - constructor(element: Element, options?: dxBulletOptions); - } - export interface dxSparklineOptions extends BaseSparklineOptions { - /** Specifies the data source field that provides arguments for a sparkline. */ - argumentField?: string; - /** Sets a color for the bars indicating negative values. Available for a sparkline of the bar type only. */ - barNegativeColor?: string; - /** Sets a color for the bars indicating positive values. Available for a sparkline of the bar type only. */ - barPositiveColor?: string; - /** Specifies a data source for the sparkline. */ - dataSource?: any; - /** Sets a color for the boundary of both the first and last points on a sparkline. */ - firstLastColor?: string; - /** Specifies whether a sparkline ignores null data points or not. */ - ignoreEmptyPoints?: boolean; - /** Sets a color for a line on a sparkline. Available for the sparklines of the line- and area-like types. */ - lineColor?: string; - /** Specifies a width for a line on a sparkline. Available for the sparklines of the line- and area-like types. */ - lineWidth?: number; - /** Sets a color for the bars indicating the values that are less than the winloss threshold. Available for a sparkline of the winloss type only. */ - lossColor?: string; - /** Sets a color for the boundary of the maximum point on a sparkline. */ - maxColor?: string; - /** Sets a color for the boundary of the minimum point on a sparkline. */ - minColor?: string; - /** Sets a color for points on a sparkline. Available for the sparklines of the line- and area-like types. */ - pointColor?: string; - /** Specifies the diameter of sparkline points in pixels. Available for the sparklines of line- and area-like types. */ - pointSize?: number; - /** Specifies a symbol to use as a point marker on a sparkline. Available for the sparklines of the line- and area-like types. */ - pointSymbol?: string; - /** Specifies whether or not to indicate both the first and last values on a sparkline. */ - showFirstLast?: boolean; - /** Specifies whether or not to indicate both the minimum and maximum values on a sparkline. */ - showMinMax?: boolean; - /** Determines the type of a sparkline. */ - type?: string; - /** Specifies the data source field that provides values for a sparkline. */ - valueField?: string; - /** Sets a color for the bars indicating the values greater than a winloss threshold. Available for a sparkline of the winloss type only. */ - winColor?: string; - /** Specifies a value that serves as a threshold for the sparkline of the winloss type. */ - winlossThreshold?: number; - /** Specifies the minimum value of the sparkline value axis. */ - minValue?: number; - /** Specifies the maximum value of the sparkline's value axis. */ - maxValue?: number; - } - /** A sparkline widget. */ - export class dxSparkline extends BaseSparkline { - constructor(element: JQuery, options?: dxSparklineOptions); - constructor(element: Element, options?: dxSparklineOptions); - } -} -interface JQuery { - dxBullet(options?: DevExpress.viz.sparklines.dxBulletOptions): JQuery; - dxBullet(methodName: string, ...params: any[]): any; - dxBullet(methodName: "instance"): DevExpress.viz.sparklines.dxBullet; - dxSparkline(options?: DevExpress.viz.sparklines.dxSparklineOptions): JQuery; - dxSparkline(methodName: string, ...params: any[]): any; - dxSparkline(methodName: "instance"): DevExpress.viz.sparklines.dxSparkline; -} diff --git a/devextreme/devextreme-15.2.4.d.ts b/devextreme/devextreme-15.2.4.d.ts deleted file mode 100644 index bffccd11ca..0000000000 --- a/devextreme/devextreme-15.2.4.d.ts +++ /dev/null @@ -1,7325 +0,0 @@ -// Type definitions for DevExtreme 15.2.4 -// Project: http://js.devexpress.com/ -// Definitions by: DevExpress Inc. -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -/// - -declare namespace DevExpress { - /** A mixin that provides a capability to fire and subscribe to events. */ - export interface EventsMixin { - /** Subscribes to a specified event. */ - on(eventName: string, eventHandler: Function): T; - /** Subscribes to the specified events. */ - on(events: { [eventName: string]: Function; }): T; - /** Detaches all event handlers from the specified event. */ - off(eventName: string): Object; - /** Detaches a particular event handler from the specified event. */ - off(eventName: string, eventHandler: Function): T; - } - /** An object that serves as a namespace for the methods required to perform validation. */ - export module validationEngine { - export interface IValidator { - validate(): ValidatorValidationResult; - reset(): void; - } - export interface ValidatorValidationResult { - isValid: boolean; - name?: string; - value: any; - brokenRule: any; - validationRules: any[]; - } - export interface ValidationGroupValidationResult { - isValid: boolean; - brokenRules: any[]; - validators: IValidator[]; - } - export interface GroupConfig extends EventsMixin { - group: any; - validators: IValidator[]; - validate(): ValidationGroupValidationResult; - reset(): void; - } - /** Provides access to the object that represents the specified validation group. */ - export function getGroupConfig(group: any): GroupConfig - /** Provides access to the object that represents the default validation group. */ - export function getGroupConfig(): GroupConfig - /** Validates rules of the validators that belong to the specified validation group. */ - export function validateGroup(group: any): ValidationGroupValidationResult; - /** Validates rules of the validators that belong to the default validation group. */ - export function validateGroup(): ValidationGroupValidationResult; - /** Resets the values and validation result of the editors that belong to the specified validation group. */ - export function resetGroup(group: any): void; - /** Resets the values and validation result of the editors that belong to the default validation group. */ - export function resetGroup(): void; - /** Validates the rules that are defined within the dxValidator objects that are registered for the specified ViewModel. */ - export function validateModel(model: Object): ValidationGroupValidationResult; - /** Registers all the dxValidator objects by which the fields of the specified ViewModel are extended. */ - export function registerModelForValidation(model: Object): void; - } - export var hardwareBackButton: JQueryCallback; - /** Processes the hardware back button click. */ - export function processHardwareBackButton(): void; - /** Hides the last displayed overlay widget. */ - export function hideTopOverlay(): boolean; - /** Specifies whether or not the entire application/site supports right-to-left representation. */ - export var rtlEnabled: boolean; - /** Registers a new component in the DevExpress.ui namespace as a jQuery plugin, Angular directive and Knockout binding. */ - export function registerComponent(name: string, componentClass: Object): void; - /** Registers a new component in the specified namespace as a jQuery plugin, Angular directive and Knockout binding. */ - export function registerComponent(name: string, namespace: Object, componentClass: Object): void; - export function requestAnimationFrame(callback: Function): number; - export function cancelAnimationFrame(requestID: number): void; - /** Custom Knockout binding that links an HTML element with a specific action. */ - export class Action { } - /** Used to get URLs that vary in a locally running application and the application running on production. */ - export class EndpointSelector { - constructor(options: { - [key: string]: { - local?: string; - production?: string; - } - }); - /** Returns a local or a productional URL depending on how the application is currently running. */ - urlFor(key: string): string; - } - /** An object that serves as a namespace for the methods that are used to animate UI elements. */ - export module fx { - /** Defines animation options. */ - export interface AnimationOptions { - /** A function called after animation is completed. */ - complete?: (element: JQuery, config: AnimationOptions) => void; - /** A number specifying wait time before animation execution. */ - delay?: number; - /** A number specifying the time period to wait before the animation of the next stagger item starts. */ - staggerDelay?: number; - /** A number specifying the time in milliseconds spent on animation. */ - duration?: number; - /** A string specifying the type of an easing function used for animation. */ - easing?: string; - /** Specifies the initial animation state. */ - from?: any; - /** A function called before animation is started. */ - start?: (element: JQuery, config: AnimationOptions) => void; - /** Specifies a final animation state. */ - to?: any; - /** A string value specifying the animation type. */ - type?: string; - /** Specifies the animation direction for the "slideIn" and "slideOut" animation types. */ - direction?: string; - } - /** Animates the specified element. */ - export function animate(element: HTMLElement, config: AnimationOptions): Object; - /** Returns a value indicating whether the specified element is being animated. */ - export function isAnimating(element: HTMLElement): boolean; - /** Stops the animation. */ - export function stop(element: HTMLElement, jumpToEnd: boolean): void; - } - /** The manager that performs several specified animations at a time. */ - export class TransitionExecutor { - /** Deletes all the animations registered in the Transition Executor by using the enter(elements, animation) and leave(elements, animation) methods. */ - reset(): void; - /** Registers a set of elements that should be animated as "entering" using the specified animation configuration. */ - enter(elements: JQuery, animation: any): void; - /** Registers a set of elements that should be animated as "leaving" using the specified animation configuration. */ - leave(elements: JQuery, animation: any): void; - /** Starts all the animations registered using the enter(elements, animation) and leave(elements, animation) methods beforehand. */ - start(config: Object): JQueryPromise; - /** Stops all started animations. */ - stop(): void; - } - export class AnimationPresetCollection { - /** Resets all the changes made in the animation repository. */ - resetToDefaults(): void; - /** Deletes the specified animation or clears all the animation repository, if an animation name is not passed. */ - clear(name: string): void; - /** Adds the specified animation preset to the animation repository by the specified name. */ - registerPreset(name: string, config: any): void; - /** Applies the changes made in the animation repository. */ - applyChanges(): void; - /** Returns the configuration of the animation found in the animation repository by the specified name for the current device. */ - getPreset(name: string): void; - /** Registers predefined animations in the animation repository. */ - registerDefaultPresets(): void; - } - /** A repository of animations. */ - export var animationPresets: AnimationPresetCollection; - /** The device object defines the device on which the application is running. */ - export interface Device { - /** Indicates whether or not the device platform is Android. */ - android?: boolean; - /** Specifies the type of the device on which the application is running. */ - deviceType?: string; - /** Indicates whether or not the device platform is generic, which means that the application will look and behave according to a generic "light" or "dark" theme. */ - generic?: boolean; - /** Indicates whether or not the device platform is iOS. */ - ios?: boolean; - /** Indicates whether or not the device type is 'phone'. */ - phone?: boolean; - /** Specifies the platform of the device on which the application is running. */ - platform?: string; - /** Indicates whether or not the device type is 'tablet'. */ - tablet?: boolean; - /** Specifies an array with the major and minor versions of the device platform. */ - version?: Array; - /** Indicates whether or not the device platform is Windows. */ - win?: boolean; - /** Specifies a performance grade of the current device. */ - grade?: string; - } - export class Devices implements EventsMixin { - constructor(options: { window: Window }); - /** Overrides actual device information to force the application to operate as if it was running on the specified device. */ - current(deviceName: any): void; - /** Returns information about the current device. */ - current(): Device; - orientationChanged: JQueryCallback; - /** Returns the current device orientation. */ - orientation(): string; - /** Returns real information about the current device regardless of the value passed to the devices.current(deviceName) method. */ - real(): Device; - on(eventName: "orientationChanged", eventHandler: (e: { orientation: string }) => void): Devices; - on(eventName: string, eventHandler: Function): Devices; - on(events: { [eventName: string]: Function; }): Devices; - off(eventName: "orientationChanged"): Devices; - off(eventName: string): Devices; - off(eventName: "orientationChanged", eventHandler: (e: { orientation: string }) => void): Devices; - off(eventName: string, eventHandler: Function): Devices; - } - /** An object that serves as a namespace for the methods and events specifying information on the current device. */ - export var devices: Devices; - /** The position object specifies the widget positioning options. */ - export interface PositionOptions { - /** The target element position that the widget is positioned against. */ - at?: string; - /** The element within which the widget is positioned. */ - boundary?: Element; - /** A string value holding horizontal and vertical offset from the window's boundaries. */ - boundaryOffset?: string; - /** Specifies how to move the widget if it overflows the screen. */ - collision?: any; - /** The position of the widget to align against the target element. */ - my?: string; - /** The target element that the widget is positioned against. */ - of?: HTMLElement; - /** A string value holding horizontal and vertical offset in pixels, separated by a space (e.g., "5 -10"). */ - offset?: string; - } - export interface ComponentOptions { - /** A handler for the initialized event. */ - onInitialized?: Function; - /** A handler for the optionChanged event. */ - onOptionChanged?: Function; - /** A handler for the disposing event. */ - onDisposing?: Function; - } - /** A base class for all components and widgets. */ - export class Component { - constructor(options?: ComponentOptions) - /** Prevents the component from refreshing until the endUpdate method is called. */ - beginUpdate(): void; - /** Enables the component to refresh after the beginUpdate method call. */ - endUpdate(): void; - /** Returns an instance of this component class. */ - instance(): Component; - /** Returns the configuration options of this component. */ - option(): { - [optionKey: string]: any; - }; - /** Sets one or more options of this component. */ - option(options: { - [optionKey: string]: any; - }): void; - /** Gets the value of the specified configuration option of this component. */ - option(optionName: string): any; - /** Sets a value to the specified configuration option of this component. */ - option(optionName: string, optionValue: any): void; - } - export interface DOMComponentOptions extends ComponentOptions { - /** Specifies whether or not the current component supports a right-to-left representation. */ - rtlEnabled?: boolean; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies the width of the widget. */ - width?: any; - } - /** A base class for all components. */ - export class DOMComponent extends Component { - constructor(element: JQuery, options?: DOMComponentOptions); - constructor(element: HTMLElement, options?: DOMComponentOptions); - /** Returns the root HTML element of the widget. */ - element(): JQuery; - /** Specifies the device-dependent default configuration options for this component. */ - static defaultOptions(rule: { - device?: any; - options?: any; - }): void; - } - export module data { - export interface ODataError extends Error { - httpStatus?: number; - errorDetails?: any; - } - export interface StoreOptions { - /** A handler for the modified event. */ - onModified?: () => void; - /** A handler for the modifying event. */ - onModifying?: () => void; - /** A handler for the removed event. */ - onRemoved?: (key: any) => void; - /** A handler for the removing event. */ - onRemoving?: (key: any) => void; - /** A handler for the updated event. */ - onUpdated?: (key: any, values: Object) => void; - /** A handler for the updating event. */ - onUpdating?: (key: any, values: Object) => void; - /** A handler for the loaded event. */ - onLoaded?: (result: Array) => void; - /** A handler for the loading event. */ - onLoading?: (loadOptions: LoadOptions) => void; - /** A handler for the inserted event. */ - onInserted?: (values: Object, key: any) => void; - /** A handler for the inserting event. */ - onInserting?: (values: Object) => void; - /** Specifies the function called when the Store causes an error. */ - errorHandler?: (e: Error) => void; - /** Specifies the key properties within the data associated with the Store. */ - key?: any; - } - export interface LoadOptions { - filter?: Object; - sort?: Object; - select?: Object; - expand?: Object; - group?: Object; - skip?: number; - take?: number; - userData?: Object; - requireTotalCount?: boolean; - } - /** The base class for all Stores. */ - export class Store implements EventsMixin { - constructor(options?: StoreOptions); - /** Returns the data item specified by the key. */ - byKey(key: any): JQueryPromise; - /** Adds an item to the data associated with this Store. */ - insert(values: Object): JQueryPromise; - /** Returns the key expression specified via the key configuration option. */ - key(): any; - /** Returns the key of the Store item that matches the specified object. */ - keyOf(obj: Object): any; - /** Starts loading data. */ - load(obj?: LoadOptions): JQueryPromise; - /** Removes the data item specified by the key. */ - remove(key: any): JQueryPromise; - /** Obtains the total count of items that will be returned by the load() function. */ - totalCount(options?: { - filter?: Object; - group?: Object; - }): JQueryPromise; - /** Updates the data item specified by the key. */ - update(key: any, values: Object): JQueryPromise; - on(eventName: "removing", eventHandler: (key: any) => void): Store; - on(eventName: "removed", eventHandler: (key: any) => void): Store; - on(eventName: "updating", eventHandler: (key: any, values: Object) => void): Store; - on(eventName: "updated", eventHandler: (key: any, values: Object) => void): Store; - on(eventName: "inserting", eventHandler: (values: Object) => void): Store; - on(eventName: "inserted", eventHandler: (values: Object, key: any) => void): Store; - on(eventName: "modifying", eventHandler: () => void): Store; - on(eventName: "modified", eventHandler: () => void): Store; - on(eventName: "loading", eventHandler: (loadOptions: LoadOptions) => void): Store; - on(eventName: "loaded", eventHandler: (result: Array) => void): Store; - on(eventName: string, eventHandler: Function): Store; - on(events: { [eventName: string]: Function; }): Store; - off(eventName: "removing"): Store; - off(eventName: "removed"): Store; - off(eventName: "updating"): Store; - off(eventName: "updated"): Store; - off(eventName: "inserting"): Store; - off(eventName: "inserted"): Store; - off(eventName: "modifying"): Store; - off(eventName: "modified"): Store; - off(eventName: "loading"): Store; - off(eventName: "loaded"): Store; - off(eventName: string): Store; - off(eventName: "removing", eventHandler: (key: any) => void): Store; - off(eventName: "removed", eventHandler: (key: any) => void): Store; - off(eventName: "updating", eventHandler: (key: any, values: Object) => void): Store; - off(eventName: "updated", eventHandler: (key: any, values: Object) => void): Store; - off(eventName: "inserting", eventHandler: (values: Object) => void): Store; - off(eventName: "inserted", eventHandler: (values: Object, key: any) => void): Store; - off(eventName: "modifying", eventHandler: () => void): Store; - off(eventName: "modified", eventHandler: () => void): Store; - off(eventName: "loading", eventHandler: (loadOptions: LoadOptions) => void): Store; - off(eventName: "loaded", eventHandler: (result: Array) => void): Store; - off(eventName: string, eventHandler: Function): Store; - } - export interface ArrayStoreOptions extends StoreOptions { - /** Specifies the array associated with this Store. */ - data?: Array; - } - /** A Store accessing an in-memory array. */ - export class ArrayStore extends Store { - constructor(options?: ArrayStoreOptions); - /** Clears all data associated with the current ArrayStore. */ - clear(): void; - /** Creates the Query object for the underlying array. */ - createQuery(): Query; - } - interface Promise { - then(doneFn?: Function, failFn?: Function, progressFn?: Function): Promise; - } - export interface CustomStoreOptions extends StoreOptions { - /** The user implementation of the byKey(key, extraOptions) method. */ - byKey?: (key: any) => Promise; - /** The user implementation of the insert(values) method. */ - insert?: (values: Object) => Promise; - /** The user implementation of the load(options) method. */ - load?: (options?: LoadOptions) => Promise; - /** The user implementation of the remove(key) method. */ - remove?: (key: any) => Promise; - /** The user implementation of the totalCount(options) method. */ - totalCount?: (options?: { - filter?: Object; - group?: Object; - }) => Promise; - /** The user implementation of the update(key, values) method. */ - update?: (key: any, values: Object) => Promise; - } - /** A Store object that enables you to implement your own data access logic. */ - export class CustomStore extends Store { - constructor(options: CustomStoreOptions); - } - export interface DataSourceOptions { - /** Specifies data filtering conditions. */ - filter?: Object; - /** Specifies data grouping conditions. */ - group?: Object; - /** The item mapping function. */ - map?: (record: any) => any; - /** Specifies the maximum number of items the page can contain. */ - pageSize?: number; - /** Specifies whether a DataSource loads data by pages, or all items at once. */ - paginate?: boolean; - /** The data post processing function. */ - postProcess?: (data: any[]) => any[]; - /** Specifies a value by which the required items are searched. */ - searchExpr?: Object; - /** Specifies the comparison operation used to search for the required items. */ - searchOperation?: string; - /** Specifies the value to which the search expression is compared. */ - searchValue?: Object; - /** Specifies the initial select option value. */ - select?: Object; - /** An array of the strings that represent the names of the navigation properties to be loaded simultaneously with the OData store's entity. */ - expand?: Object; - /** Specifies whether or not the DataSource instance requests the total count of items available in the storage. */ - requireTotalCount?: boolean; - /** Specifies the initial sort option value. */ - sort?: Object; - /** Specifies the underlying Store instance used to access data. */ - store?: any; - /** A handler for the changed event. */ - onChanged?: () => void; - /** A handler for the loadingChanged event. */ - onLoadingChanged?: (isLoading: boolean) => void; - /** A handler for the loadError event. */ - onLoadError?: (e?: Error) => void; - } - /** An object that provides access to a data web service or local data storage for collection container widgets. */ - export class DataSource implements EventsMixin { - constructor(options?: DataSourceOptions); - /** Disposes all resources associated with this DataSource. */ - dispose(): void; - /** Returns the current filter option value. */ - filter(): Object; - /** Sets the filter option value. */ - filter(filterExpr: Object): void; - /** Returns the current group option value. */ - group(): Object; - /** Sets the group option value. */ - group(groupExpr: Object): void; - /** Indicates whether or not the current page contains fewer items than the number of items specified by the pageSize configuration option. */ - isLastPage(): boolean; - /** Indicates whether or not at least one load() method execution has successfully finished. */ - isLoaded(): boolean; - /** Indicates whether or not the DataSource is currently being loaded. */ - isLoading(): boolean; - /** Returns the array of items currently operated by the DataSource. */ - items(): Array; - /** Returns the key expression. */ - key(): any; - /** Starts loading data. */ - load(): JQueryPromise>; - /** Returns an object that would be passed to the load() method of the underlying Store according to the current data shaping option values of the current DataSource instance. */ - loadOptions(): Object; - /** Returns the current pageSize option value. */ - pageSize(): number; - /** Sets the pageSize option value. */ - pageSize(value: number): void; - /** Specifies the index of the currently loaded page. */ - pageIndex(): number; - /** Specifies the index of the page to be loaded during the next load() method execution. */ - pageIndex(newIndex: number): void; - /** Returns the current paginate option value. */ - paginate(): boolean; - /** Sets the paginate option value. */ - paginate(value: boolean): void; - /** Returns the searchExpr option value. */ - searchExpr(): Object; - /** Sets the searchExpr option value. */ - searchExpr(expr: Object): void; - /** Returns the currently specified search operation. */ - searchOperation(): string; - /** Sets the current search operation. */ - searchOperation(op: string): void; - /** Returns the searchValue option value. */ - searchValue(): Object; - /** Sets the searchValue option value. */ - searchValue(value: Object): void; - /** Returns the current select option value. */ - select(): Object; - /** Sets the select option value. */ - select(expr: Object): void; - /** Returns the current requireTotalCount option value. */ - requireTotalCount(): boolean; - /** Sets the requireTotalCount option value. */ - requireTotalCount(value: boolean): void; - /** Returns the current sort option value. */ - sort(): Object; - /** Sets the sort option value. */ - sort(sortExpr: Object): void; - /** Returns the underlying Store instance. */ - store(): Store; - /** Returns the number of data items available in an underlying Store after the last load() operation without paging. */ - totalCount(): number; - on(eventName: "loadingChanged", eventHandler: (isLoading: boolean) => void): DataSource; - on(eventName: "loadError", eventHandler: (e?: Error) => void): DataSource; - on(eventName: "changed", eventHandler: () => void): DataSource; - on(eventName: string, eventHandler: Function): DataSource; - on(events: { [eventName: string]: Function; }): DataSource; - off(eventName: "loadingChanged"): DataSource; - off(eventName: "loadError"): DataSource; - off(eventName: "changed"): DataSource; - off(eventName: string): DataSource; - off(eventName: "loadingChanged", eventHandler: (isLoading: boolean) => void): DataSource; - off(eventName: "loadError", eventHandler: (e?: Error) => void): DataSource; - off(eventName: "changed", eventHandler: () => void): DataSource; - off(eventName: string, eventHandler: Function): DataSource; - } - /** An object used to work with primitive data types not supported by JavaScript when accessing an OData web service. */ - export class EdmLiteral { - /** Creates an EdmLiteral instance and assigns the specified value to it. */ - constructor(value: string); - /** Returns a string representation of the value associated with this EdmLiteral object. */ - valueOf(): string; - } - /** An object used to generate and hold the GUID. */ - export class Guid { - /** Creates a new Guid instance that holds the specified GUID. */ - constructor(value: string); - /** Creates a new Guid instance holding the generated GUID. */ - constructor(); - /** Returns a string representation of the Guid instance. */ - toString(): string; - /** Returns a string representation of the Guid instance. */ - valueOf(): string; - } - export interface LocalStoreOptions extends ArrayStoreOptions { - /** Specifies the time (in miliseconds) after the change operation, before the data is flushed. */ - flushInterval?: number; - /** Specifies whether the data is flushed immediatelly after each change operation, or after the delay specified via the flushInterval option. */ - immediate?: boolean; - /** The unique identifier used to distinguish the data within the HTML5 Web Storage. */ - name?: string; - } - /** A Store providing access to the HTML5 Web Storage. */ - export class LocalStore extends ArrayStore { - constructor(options?: LocalStoreOptions); - /** Removes all data associated with this Store. */ - clear(): void; - } - export interface ODataContextOptions extends ODataStoreOptions { - /** Specifies the list of entities to be accessed via the ODataContext. */ - entities?: Object; - /** Specifies the function called if the ODataContext causes an error. */ - errorHandler?: (e: Error) => void; - } - /** Provides access to the entire OData service. */ - export class ODataContext { - constructor(options?: ODataContextOptions); - /** Initiates the specified WebGet service operation that returns a value. For the information on service operations, refer to the OData documentation. */ - get(operationName: string, params: Object): JQueryPromise; - /** Initiates the specified WebGet service operation that returns nothing. For the information on service operations, refer to the OData documentation. */ - invoke(operationName: string, params: Object, httpMethod: Object): JQueryPromise; - /** Return a special proxy object to describe the entity link. */ - objectLink(entityAlias: string, key: any): Object; - } - export interface ODataStoreOptions extends StoreOptions { - /** A function used to customize a web request before it is sent. */ - beforeSend?: (request: { - url: string; - async: boolean; - method: string; - timeout: number; - params: Object; - payload: Object; - headers: Object; - }) => void; - /** Specifies whether the ODataStore uses the JSONP approach to access non-CORS-compatible remote services. */ - jsonp?: boolean; - /** Specifies the type of the ODataStore key property. The following key types are supported out of the box: String, Int32, Int64, and Guid. */ - keyType?: any; - /** Specifies whether or not dates found in the response are deserialized. */ - deserializeDates?: boolean; - /** Specifies the URL of the data service being accessed via the current ODataContext. */ - url?: string; - /** Specifies the version of the OData protocol used to interact with the data service. */ - version?: number; - /** Specifies the value of the withCredentials field of the underlying jqXHR object. */ - withCredentials?: boolean; - } - /** A Store providing access to a separate OData web service entity. */ - export class ODataStore extends Store { - constructor(options?: ODataStoreOptions); - /** Creates the Query object for the OData endpoint. */ - createQuery(loadOptions: Object): Object; - /** Returns the data item specified by the key. */ - byKey(key: any, extraOptions?: { expand?: Object }): JQueryPromise; - } - /** An universal chainable data query interface object. */ - export interface Query { - /** Calculates a custom summary for the items in the current Query. */ - aggregate(step: (accumulator: any, value: any) => any): JQueryPromise; - /** Calculates a custom summary for the items in the current Query. */ - aggregate(seed: any, step: (accumulator: any, value: any) => any, finalize: (result: any) => any): JQueryPromise; - /** Calculates the average item value for the current Query. */ - avg(getter: Object): JQueryPromise; - /** Finds the item with the maximum getter value. */ - max(getter: Object): JQueryPromise; - /** Finds the item with the maximum value in the Query. */ - max(): JQueryPromise; - /** Finds the item with the minimum value in the Query. */ - min(): JQueryPromise; - /** Finds the item with the minimum getter value. */ - min(getter: Object): JQueryPromise; - /** Calculates the average item value for the current Query, if each Query item has a numeric type. */ - avg(): JQueryPromise; - /** Returns the total count of items in the current Query. */ - count(): JQueryPromise; - /** Executes the Query. */ - enumerate(): JQueryPromise; - /** Filters the current Query data. */ - filter(criteria: Array): Query; - /** Groups the current Query data. */ - groupBy(getter: Object): Query; - /** Applies the specified transformation to each item. */ - select(getter: Object): Query; - /** Limits the data item count. */ - slice(skip: number, take?: number): Query; - /** Sorts current Query data. */ - sortBy(getter: Object, desc: boolean): Query; - /** Sorts current Query data. */ - sortBy(getter: Object): Query; - /** Calculates the sum of item getter values in the current Query. */ - sum(getter: Object): JQueryPromise; - /** Calculates the sum of item values in the current Query. */ - sum(): JQueryPromise; - /** Adds one more sorting condition to the current Query. */ - thenBy(getter: Object): Query; - /** Adds one more sorting condition to the current Query. */ - thenBy(getter: Object, desc: boolean): Query; - /** Returns the array of current Query items. */ - toArray(): Array; - } - /** The global data layer error handler. */ - export var errorHandler: (e: Error) => void; - /** Encodes the specified string or array of bytes to base64 encoding. */ - export function base64_encode(input: any): string; - /** Creates a Query instance. */ - export function query(array: Array): Query; - /** Creates a Query instance for accessing the remote service specified by a URL. */ - export function query(url: string, queryOptions: Object): Query; - /** This section describes the utility objects provided by the DevExtreme data layer. */ - export var utils: { - /** Compiles a getter function from the getter expression. */ - compileGetter(expr: any): Function; - /** Compiles a setter function from the setter expression. */ - compileSetter(expr: any): Function; - odata: { - /** Holds key value converters for OData. */ - keyConverters: { - String(value: any): string; - Int32(value: any): number; - Int64(value: any): EdmLiteral; - Guid(value: any): Guid; - Boolean(value: any): boolean; - Single(value: any): EdmLiteral; - Decimal(value: any): EdmLiteral; - }; - } - } - } - /** An object that serves as a namespace for DevExtreme UI widgets as well as for methods implementing UI logic in DevExtreme sites/applications. */ - export module ui { - export interface WidgetOptions extends DOMComponentOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A Boolean value specifying whether or not the widget can respond to user interaction. */ - disabled?: boolean; - /** A Boolean value specifying whether or not the widget changes its state when being hovered by an end user. */ - hoverStateEnabled?: boolean; - /** Specifies whether or not the widget can be focused. */ - focusStateEnabled?: boolean; - /** Specifies a shortcut key that sets focus on the widget element. */ - accessKey?: string; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - /** Specifies the widget tab index. */ - tabIndex?: number; - /** Specifies the text of the hint displayed for the widget. */ - hint?: string; - } - /** The base class for widgets. */ - export class Widget extends DOMComponent { - constructor(options?: WidgetOptions); - /** Redraws the widget. */ - repaint(): void; - /** Sets focus on the widget. */ - focus(): void; - /** Registers a handler when a specified key is pressed. */ - registerKeyHandler(key: string, handler: Function): void; - } - export interface CollectionWidgetOptions extends WidgetOptions { - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** The time period in milliseconds before the onItemHold event is raised. */ - itemHoldTimeout?: number; - /** An array of items displayed by the widget. */ - items?: Array; - /** The template to be used for rendering items. */ - itemTemplate?: any; - loopItemFocus?: boolean; - /** The text or HTML markup displayed by the widget if the item collection is empty. */ - noDataText?: string; - onContentReady?: any; - /** A handler for the itemClick event. */ - onItemClick?: any; - /** A handler for the itemContextMenu event. */ - onItemContextMenu?: Function; - /** A handler for the itemHold event. */ - onItemHold?: Function; - /** A handler for the itemRendered event. */ - onItemRendered?: Function; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: Function; - /** The index of the currently selected widget item. */ - selectedIndex?: number; - /** The selected item object. */ - selectedItem?: Object; - /** An array of currently selected item objects. */ - selectedItems?: Array; - /** A handler for the itemDeleting event. */ - onItemDeleting?: Function; - /** A handler for the itemDeleted event. */ - onItemDeleted?: Function; - /** A handler for the itemReordered event. */ - onItemReordered?: Function; - } - /** The base class for widgets containing an item collection. */ - export class CollectionWidget extends Widget { - constructor(element: JQuery, options?: CollectionWidgetOptions); - constructor(element: HTMLElement, options?: CollectionWidgetOptions); - selectItem(itemElement: any): void; - unselectItem(itemElement: any): void; - deleteItem(itemElement: any): JQueryPromise; - isItemSelected(itemElement: any): boolean; - reorderItem(itemElement: any, toItemElement: any): JQueryPromise; - } - export interface DataExpressionMixinOptions { - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** Specifies the name of the data source item field whose value is displayed by the widget. */ - displayExpr?: any; - /** Specifies the name of a data source item field whose value is held in the value configuration option. */ - valueExpr?: any; - /** An array of items displayed by the widget. */ - items?: Array; - /** The template to be used for rendering items. */ - itemTemplate?: any; - /** The currently selected value in the widget. */ - value?: Object; - } - export interface EditorOptions extends WidgetOptions { - /** The currently specified value. */ - value?: Object; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - /** A Boolean value specifying whether or not the widget is read-only. */ - readOnly?: boolean; - /** Holds the object that defines the error that occurred during validation. */ - validationError?: Object; - /** Specifies whether the editor's value is valid. */ - isValid?: boolean; - /** Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed. */ - validationMessageMode?: string; - } - /** A base class for editors. */ - export class Editor extends Widget { - /** Resets the editor's value to undefined. */ - reset(): void; - } - /** An object that serves as a namespace for methods displaying a message in an application/site. */ - export var dialog: { - /** Creates an alert dialog message containing a single "OK" button. */ - alert(message: string, title: string): JQueryPromise; - /** Creates a confirm dialog that contains "Yes" and "No" buttons. */ - confirm(message: string, title: string): JQueryPromise; - /** Creates a custom dialog using the options specified by the passed configuration object. */ - custom(options: { title?: string; message?: string; buttons?: Array; }): { - show(): JQueryPromise; - hide(): void; - hide(value: any): void; - }; - }; - /** Creates a toast message. */ - export function notify(message: any, type: string, displayTime: number): void; - /** Creates a toast message. */ - export function notify(options: Object): void; - /** An object that serves as a namespace for the methods that work with DevExtreme CSS Themes. */ - export var themes: { - /** Returns the name of the currently applied theme. */ - current(): string; - /** Changes the current theme to the specified one. */ - current(themeName: string): void; - }; - /** Sets a specified template engine. */ - export function setTemplateEngine(name: string): void; - /** Sets a custom template engine defined via custom compile and render functions. */ - export function setTemplateEngine(options: Object): void; - } - /** An object that serves as a namespace for utility methods that can be helpful when working with the DevExtreme framework and UI widgets. */ - export var utils: { - /** Sets parameters for the viewport meta tag. */ - initMobileViewport(options: { allowZoom?: boolean; allowPan?: boolean; allowSelection?: boolean }): void; - /** Requests that the browser call a specified function to update animation before the next repaint. */ - requestAnimationFrame(callback: Function): number; - /** Cancels an animation frame request scheduled with the requestAnimationFrame method. */ - cancelAnimationFrame(requestID: number): void; - }; - /** An object that serves as a namespace for DevExtreme Data Visualization Widgets. */ - export module viz { - /** Applies a theme for the entire page with several DevExtreme visualization widgets. */ - export function currentTheme(theme: string): void; - /** Applies a new theme (with the color scheme defined separately) for the entire page with several DevExtreme visualization widgets. */ - export function currentTheme(platform: string, colorScheme: string): void; - /** Registers a new theme based on the existing one. */ - export function registerTheme(customTheme: Object, baseTheme: string): void; - /** Applies a predefined or registered custom palette to all visualization widgets at once. */ - export function currentPalette(paletteName: string): void; - /** Obtains the color sets of a predefined or registered palette. */ - export function getPalette(paletteName: string): Object; - /** Registers a new palette. */ - export function registerPalette(paletteName: string, palette: Object): void; - } -} -declare namespace DevExpress.ui { - export interface dxValidatorOptions extends DOMComponentOptions { - /** An array of validation rules to be checked for the editor with which the dxValidator object is associated. */ - validationRules?: Array; - /** Specifies the editor name to be used in the validation default messages. */ - name?: string; - /** An object that specifies what and when to validate and how to apply the validation result. */ - adapter?: Object; - /** Specifies the validation group the editor will be related to. */ - validationGroup?: string; - /** A handler for the validated event. */ - onValidated?: (params: validationEngine.ValidatorValidationResult) => void; - } - /** A widget that is used to validate the associated DevExtreme editors against the defined validation rules. */ - export class dxValidator extends DOMComponent implements validationEngine.IValidator { - constructor(element: JQuery, options?: dxValidatorOptions); - constructor(element: Element, options?: dxValidatorOptions); - /** Validates the value of the editor that is controlled by the current dxValidator object against the list of the specified validation rules. */ - validate(): validationEngine.ValidatorValidationResult; - /** Resets the value and validation result of the editor associated with the current dxValidator object. */ - reset(): void; - } - /** The widget that is used in the Knockout and Angular approaches to combine the editors to be validated. */ - export class dxValidationGroup extends DOMComponent { - constructor(element: JQuery); - constructor(element: Element); - /** Validates rules of the validators that belong to the current validation group. */ - validate(): validationEngine.ValidationGroupValidationResult; - /** Resets the value and validation result of the editors that are included to the current validation group. */ - reset(): void; - } - export interface dxValidationSummaryOptions extends CollectionWidgetOptions { - /** Specifies the validation group for which summary should be generated. */ - validationGroup?: string; - } - /** A widget for displaying the result of checking validation rules for editors. */ - export class dxValidationSummary extends CollectionWidget { - constructor(element: JQuery, options?: dxValidationSummaryOptions); - constructor(element: Element, options?: dxValidationSummaryOptions); - } - export interface dxResizableOptions extends DOMComponentOptions { - /** Specifies which borders of the widget element are used as a handle. */ - handles?: string; - /** Specifies the lower width boundary for resizing. */ - minWidth?: number; - /** Specifies the upper width boundary for resizing. */ - maxWidth?: number; - /** Specifies the lower height boundary for resizing. */ - minHeight?: number; - /** Specifies the upper height boundary for resizing. */ - maxHeight?: number; - /** A handler for the resizeStart event. */ - onResizeStart?: Function; - /** A handler for the resize event. */ - onResize?: Function; - /** A handler for the resizeEnd event. */ - onResizeEnd?: Function; - } - /** A widget that displays required content in a resizable element. */ - export class dxResizable extends DOMComponent { - constructor(element: JQuery, options?: dxResizableOptions); - constructor(element: Element, options?: dxResizableOptions); - } - export interface dxTooltipOptions extends dxPopoverOptions { - } - /** A tooltip widget. */ - export class dxTooltip extends dxPopover { - constructor(element: JQuery, options?: dxTooltipOptions); - constructor(element: Element, options?: dxTooltipOptions); - } - export interface dxDropDownListOptions extends dxDropDownEditorOptions, DataExpressionMixinOptions { - /** Returns the value currently displayed by the widget. */ - displayValue?: string; - /** The minimum number of characters that must be entered into the text box to begin a search. */ - minSearchLength?: number; - /** Specifies whether or not the widget displays unfiltered values until a user types a number of characters exceeding the minSearchLength option value. */ - showDataBeforeSearch?: boolean; - /** Specifies the name of a data source item field or an expression whose value is compared to the search criterion. */ - searchExpr?: Object; - /** Specifies the binary operation used to filter data. */ - searchMode?: string; - /** Specifies the time delay, in milliseconds, after the last character has been typed in, before a search is executed. */ - searchTimeout?: number; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - /** Specifies DOM event names that update a widget's value. */ - valueChangeEvent?: string; - /** Specifies whether or not the widget supports searching. */ - searchEnabled?: boolean; - /** - * Specifies whether or not the widget displays items by pages. - * @deprecated dataSource.paginate.md - */ - pagingEnabled?: boolean; - /** The text or HTML markup displayed by the widget if the item collection is empty. */ - noDataText?: string; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: Function; - /** A handler for the itemClick event. */ - onItemClick?: Function; - onContentReady?: Function; - } - /** A base class for drop-down list widgets. */ - export class dxDropDownList extends dxDropDownEditor { - constructor(element: JQuery, options?: dxDropDownListOptions); - constructor(element: Element, options?: dxDropDownListOptions); - } - export interface dxToolbarOptions extends CollectionWidgetOptions { - /** The template used to render menu items. */ - menuItemTemplate?: any; - /** Informs the widget about its location in a view HTML markup. */ - renderAs?: string; - } - /** A toolbar widget. */ - export class dxToolbar extends CollectionWidget { - constructor(element: JQuery, options?: dxToolbarOptions); - constructor(element: Element, options?: dxToolbarOptions); - } - export interface dxToastOptions extends dxOverlayOptions { - animation?: fx.AnimationOptions; - /** The time span in milliseconds during which the dxToast widget is visible. */ - displayTime?: number; - height?: any; - /** The dxToast message text. */ - message?: string; - position?: PositionOptions; - shading?: boolean; - /** Specifies the dxToast widget type. */ - type?: string; - width?: any; - closeOnBackButton?: boolean; - /** A Boolean value specifying whether or not the toast is closed if a user swipes it out of the screen boundaries. */ - closeOnSwipe?: boolean; - /** A Boolean value specifying whether or not the toast is closed if a user clicks it. */ - closeOnClick?: boolean; - } - /** The toast message widget. */ - export class dxToast extends dxOverlay { - constructor(element: JQuery, options?: dxToastOptions); - constructor(element: Element, options?: dxToastOptions); - } - export interface dxTextEditorOptions extends EditorOptions { - /** A handler for the change event. */ - onChange?: Function; - /** A handler for the copy event. */ - onCopy?: Function; - /** A handler for the cut event. */ - onCut?: Function; - /** A handler for the enterKey event. */ - onEnterKey?: Function; - /** A handler for the focusIn event. */ - onFocusIn?: Function; - /** A handler for the focusOut event. */ - onFocusOut?: Function; - /** A handler for the input event. */ - onInput?: Function; - /** A handler for the keyDown event. */ - onKeyDown?: Function; - /** A handler for the keyPress event. */ - onKeyPress?: Function; - /** A handler for the keyUp event. */ - onKeyUp?: Function; - /** A handler for the paste event. */ - onPaste?: Function; - /** The text displayed by the widget when the widget value is empty. */ - placeholder?: string; - /** Specifies whether to display the Clear button in the widget. */ - showClearButton?: boolean; - /** Specifies the current value displayed by the widget. */ - value?: any; - /** Specifies DOM event names that update a widget's value. */ - valueChangeEvent?: string; - /** Specifies whether or not the widget checks the inner text for spelling mistakes. */ - spellcheck?: boolean; - /** Specifies HTML attributes applied to the inner input element of the widget. */ - attr?: Object; - /** The read-only option that holds the text displayed by the widget input element. */ - text?: string; - focusStateEnabled?: boolean; - hoverStateEnabled?: boolean; - /** The editor mask that specifies the format of the entered string. */ - mask?: string; - /** Specifies a mask placeholder character. */ - maskChar?: string; - /** Specifies custom mask rules. */ - maskRules?: Object; - /** A message displayed when the entered text does not match the specified pattern. */ - maskInvalidMessage?: string; - /** Specifies whether the value option holds only characters entered by a user or prompt characters as well. */ - useMaskedValue?: boolean; - } - /** A base class for text editing widgets. */ - export class dxTextEditor extends Editor { - constructor(element: JQuery, options?: dxTextEditorOptions); - constructor(element: Element, options?: dxTextEditorOptions); - /** Removes focus from the input element. */ - blur(): void; - /** Sets focus to the input element representing the widget. */ - focus(): void; - } - export interface dxTextBoxOptions extends dxTextEditorOptions { - /** Specifies the maximum number of characters you can enter into the textbox. */ - maxLength?: any; - /** The "mode" attribute value of the actual HTML input element representing the text box. */ - mode?: string; - } - /** A single-line text box widget. */ - export class dxTextBox extends dxTextEditor { - constructor(element: JQuery, options?: dxTextBoxOptions); - constructor(element: Element, options?: dxTextBoxOptions); - } - export interface dxTextAreaOptions extends dxTextBoxOptions { - /** Specifies whether or not the widget checks the inner text for spelling mistakes. */ - spellcheck?: boolean; - } - /** A widget used to display and edit multi-line text. */ - export class dxTextArea extends dxTextBox { - constructor(element: JQuery, options?: dxTextAreaOptions); - constructor(element: Element, options?: dxTextAreaOptions); - } - export interface dxTabsOptions extends CollectionWidgetOptions { - /** Specifies whether the widget enables an end-user to select only a single item or multiple items. */ - selectionMode?: string; - /** Specifies whether or not an end-user can scroll tabs by swiping. */ - scrollByContent?: boolean; - /** Specifies whether or not an end-user can scroll tabs. */ - scrollingEnabled?: boolean; - /** A Boolean value that specifies the availability of navigation buttons. */ - showNavButtons?: boolean; - } - /** A tab strip used to switch between pages. */ - export class dxTabs extends CollectionWidget { - constructor(element: JQuery, options?: dxTabsOptions); - constructor(element: Element, options?: dxTabsOptions); - } - export interface dxTabPanelOptions extends dxMultiViewOptions { - /** A handler for the titleClick event. */ - onTitleClick?: any; - /** A handler for the titleHold event. */ - onTitleHold?: Function; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - /** The template to be used for rendering an item title. */ - itemTitleTemplate?: any; - /** A Boolean value specifying if the list is scrolled by content. */ - scrollByContent?: boolean; - /** A Boolean value specifying whether to enable or disable scrolling. */ - scrollingEnabled?: boolean; - /** A Boolean value that specifies the availability of navigation buttons. */ - showNavButtons?: boolean; - } - /** A widget used to display a view and to switch between several views by clicking the appropriate tabs. */ - export class dxTabPanel extends dxMultiView { - constructor(element: JQuery, options?: dxTabPanelOptions); - constructor(element: Element, options?: dxTabPanelOptions); - } - export interface dxSelectBoxOptions extends dxDropDownListOptions { - /** Specifies DOM event names that update a widget's value. */ - valueChangeEvent?: string; - /** The template to be used for rendering the widget text field. */ - fieldTemplate?: any; - /** The text that is provided as a hint in the select box editor. */ - placeholder?: string; - /** Specifies whether or not the widget allows an end-user to enter a custom value. */ - fieldEditEnabled?: boolean; - } - /** A widget that allows you to select an item in a dropdown list. */ - export class dxSelectBox extends dxDropDownList { - constructor(element: JQuery, options?: dxSelectBoxOptions); - constructor(element: Element, options?: dxSelectBoxOptions); - } - export interface dxTagBoxOptions extends dxSelectBoxOptions { - /** Holds the list of selected values. */ - values?: Array; - /** A read-only option that holds the last selected value. */ - value?: Object; - } - /** A widget that allows you to select multiple items from a dropdown list. */ - export class dxTagBox extends dxSelectBox { - constructor(element: JQuery, options?: dxTagBoxOptions); - constructor(element: Element, options?: dxTagBoxOptions); - } - export interface dxScrollViewOptions extends dxScrollableOptions { - /** A handler for the pullDown event. */ - onPullDown?: Function; - /** Specifies the text shown in the pullDown panel when pulling the content down lowers the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while pulling the content down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the reachBottom event. */ - onReachBottom?: Function; - /** Specifies the text shown in the pullDown panel displayed when content is scrolled to the bottom. */ - reachBottomText?: string; - /** Specifies the text shown in the pullDown panel displayed when the content is being refreshed. */ - refreshingText?: string; - /** Returns a value indicating if the scrollView content is larger then the widget container. */ - isFull(): boolean; - /** Locks the widget until the release(preventScrollBottom) method is called and executes the function passed to the onPullDown option and the handler assigned to the pullDown event. */ - refresh(): void; - /** Notifies the scroll view that data loading is finished. */ - release(preventScrollBottom: boolean): JQueryPromise; - /** Toggles the loading state of the widget. */ - toggleLoading(showOrHide: boolean): void; - } - /** A widget used to display scrollable content. */ - export class dxScrollView extends dxScrollable { - constructor(element: JQuery, options?: dxScrollViewOptions); - constructor(element: Element, options?: dxScrollViewOptions); - } - export interface dxScrollableLocation { - top?: number; - left?: number; - } - export interface dxScrollableOptions extends DOMComponentOptions { - /** A string value specifying the available scrolling directions. */ - direction?: string; - /** A Boolean value specifying whether or not the widget can respond to user interaction. */ - disabled?: boolean; - /** A handler for the scroll event. */ - onScroll?: Function; - /** Specifies when the widget shows the scrollbar. */ - showScrollbar?: string; - /** A handler for the update event. */ - onUpdated?: Function; - /** Indicates whether to use native or simulated scrolling. */ - useNative?: boolean; - /** A Boolean value specifying whether to enable or disable the bounce-back effect. */ - bounceEnabled?: boolean; - /** A Boolean value specifying whether or not an end-user can scroll the widget content swiping it up or down. */ - scrollByContent?: boolean; - /** A Boolean value specifying whether or not an end-user can scroll the widget content using the scrollbar. */ - scrollByThumb?: boolean; - } - /** A widget used to display scrollable content. */ - export class dxScrollable extends DOMComponent { - constructor(element: JQuery, options?: dxScrollableOptions); - constructor(element: Element, options?: dxScrollableOptions); - /** Returns the height of the scrollable widget in pixels. */ - clientHeight(): number; - /** Returns the width of the scrollable widget in pixels. */ - clientWidth(): number; - /** Returns an HTML element of the widget. */ - content(): JQuery; - /** Scrolls the widget content by the specified number of pixels. */ - scrollBy(distance: number): void; - /** Scrolls widget content by the specified number of pixels in horizontal and vertical directions. */ - scrollBy(distanceObject: dxScrollableLocation): void; - /** Returns the height of the scrollable content in pixels. */ - scrollHeight(): number; - /** Returns the current scroll position against the leftmost position. */ - scrollLeft(): number; - /** Returns how far the scrollable content is scrolled from the top and from the left. */ - scrollOffset(): dxScrollableLocation; - /** Scrolls widget content to the specified position. */ - scrollTo(targetLocation: number): void; - /** Scrolls widget content to a specified position. */ - scrollTo(targetLocation: dxScrollableLocation): void; - /** Scrolls widget content to the specified element. */ - scrollToElement(element: Element): void; - /** Returns the current scroll position against the topmost position. */ - scrollTop(): number; - /** Returns the width of the scrollable content in pixels. */ - scrollWidth(): number; - /** Updates the dimensions of the scrollable contents. */ - update(): void; - } - export interface dxRadioGroupOptions extends CollectionWidgetOptions, DataExpressionMixinOptions { - activeStateEnabled?: boolean; - /** Specifies the radio group layout. */ - layout?: string; - } - /** A widget that enables a user to select one item within a list of items represented by radio buttons. */ - export class dxRadioGroup extends CollectionWidget { - constructor(element: JQuery, options?: dxRadioGroupOptions); - constructor(element: Element, options?: dxRadioGroupOptions); - } - export interface dxPopupOptions extends dxOverlayOptions { - animation?: fx.AnimationOptions; - /** Specifies whether or not to allow a user to drag the popup window. */ - dragEnabled?: boolean; - /** A Boolean value specifying whether or not to display the widget in full-screen mode. */ - fullScreen?: boolean; - position?: PositionOptions; - /** A Boolean value specifying whether or not to display the title in the popup window. */ - showTitle?: boolean; - /** The title in the overlay window. */ - title?: string; - /** A template to be used for rendering the widget title. */ - titleTemplate?: any; - width?: any; - /** Specifies items displayed on the top or bottom toolbar of the popup window. */ - buttons?: Array; - /** Specifies whether or not the widget displays the Close button. */ - showCloseButton?: boolean; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - } - /** A widget that displays required content in a popup window. */ - export class dxPopup extends dxOverlay { - constructor(element: JQuery, options?: dxPopupOptions); - constructor(element: Element, options?: dxPopupOptions); - } - export interface dxPopoverOptions extends dxPopupOptions { - /** An object defining animation options of the widget. */ - animation?: fx.AnimationOptions; - /** Specifies the height of the widget. */ - height?: any; - /** An object defining widget positioning options. */ - position?: PositionOptions; - shading?: boolean; - /** A Boolean value specifying whether or not to display the title in the overlay window. */ - showTitle?: boolean; - /** The target element associated with a popover. */ - target?: any; - /** Specifies the width of the widget. */ - width?: any; - } - /** A widget that displays the required content in a popup window. */ - export class dxPopover extends dxPopup { - constructor(element: JQuery, options?: dxPopoverOptions); - constructor(element: Element, options?: dxPopoverOptions); - /** Displays the widget for the specified target element. */ - show(target?: any): JQueryPromise; - } - export interface dxOverlayOptions extends WidgetOptions { - /** An object that defines the animation options of the widget. */ - animation?: fx.AnimationOptions; - /** A Boolean value specifying whether or not the widget is closed if a user presses the Back hardware button. */ - closeOnBackButton?: boolean; - /** A Boolean value specifying whether or not the widget is closed if a user clicks outside of the overlapping window. */ - closeOnOutsideClick?: any; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - /** Specifies whether or not an end-user can drag the widget. */ - dragEnabled?: boolean; - /** Specifies whether or not an end user can resize the widget. */ - resizeEnabled?: boolean; - /** The height of the widget in pixels. */ - height?: any; - /** Specifies the maximum height the widget can reach while resizing. */ - maxHeight?: any; - /** Specifies the maximum width the widget can reach while resizing. */ - maxWidth?: any; - /** Specifies the minimum height the widget can reach while resizing. */ - minHeight?: any; - /** Specifies the minimum width the widget can reach while resizing. */ - minWidth?: any; - /** A handler for the hidden event. */ - onHidden?: Function; - /** A handler for the resizeStart event. */ - onResizeStart?: Function; - /** A handler for the resize event. */ - onResize?: Function; - /** A handler for the resizeEnd event. */ - onResizeEnd?: Function; - /** A handler for the hiding event. */ - onHiding?: Function; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** A Boolean value specifying whether or not the main screen is inactive while the widget is active. */ - shading?: boolean; - /** Specifies the shading color. */ - shadingColor?: string; - /** A handler for the showing event. */ - onShowing?: Function; - /** A handler for the shown event. */ - onShown?: Function; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - /** The widget width in pixels. */ - width?: any; - } - /** A widget displaying the required content in an overlay window. */ - export class dxOverlay extends Widget { - constructor(element: JQuery, options?: dxOverlayOptions); - constructor(element: Element, options?: dxOverlayOptions); - /** An HTML element of the widget. */ - content(): JQuery; - /** Hides the widget. */ - hide(): JQueryPromise; - /** Recalculates the overlay's size and position. */ - repaint(): void; - /** Shows the widget. */ - show(): JQueryPromise; - /** Toggles the visibility of the widget. */ - toggle(showing: boolean): JQueryPromise; - /** A static method that specifies the base z-index for all overlay widgets. */ - static baseZIndex(zIndex: number): void; - } - export interface dxNumberBoxOptions extends dxTextEditorOptions { - /** The maximum value accepted by the number box. */ - max?: number; - /** The minimum value accepted by the number box. */ - min?: number; - /** Specifies whether or not to show spin buttons. */ - showSpinButtons?: boolean; - useTouchSpinButtons?: boolean; - /** Specifies by which value the widget value changes when a spin button is clicked. */ - step?: number; - /** The current number box value. */ - value?: number; - } - /** A textbox widget that enables a user to enter numeric values. */ - export class dxNumberBox extends dxTextEditor { - constructor(element: JQuery, options?: dxNumberBoxOptions); - constructor(element: Element, options?: dxNumberBoxOptions); - } - export interface dxNavBarOptions extends dxTabsOptions { - scrollingEnabled?: boolean; - } - /** A widget that contains items used to navigate through application views. */ - export class dxNavBar extends dxTabs { - constructor(element: JQuery, options?: dxNavBarOptions); - constructor(element: Element, options?: dxNavBarOptions); - } - export interface dxMultiViewOptions extends CollectionWidgetOptions { - /** Specifies whether or not to animate the displayed item change. */ - animationEnabled?: boolean; - /** A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped. */ - loop?: boolean; - /** The index of the currently displayed item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to allow users to change the selected index by swiping. */ - swipeEnabled?: boolean; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - } - /** A widget used to display a view and to switch between several views. */ - export class dxMultiView extends CollectionWidget { - constructor(element: JQuery, options?: dxMultiViewOptions); - constructor(element: Element, options?: dxMultiViewOptions); - } - export interface dxMapOptions extends WidgetOptions { - /** Specifies whether or not the widget automatically adjusts center and zoom option values when adding a new marker or route. */ - autoAdjust?: boolean; - center?: { - /** The latitude location displayed in the center of the widget. */ - lat?: number; - /** The longitude location displayed in the center of the widget. */ - lng?: number; - }; - /** A handler for the click event. */ - onClick?: any; - /** Specifies whether or not map widget controls are available. */ - controls?: boolean; - /** Specifies the height of the widget. */ - height?: any; - /** A key used to authenticate the application within the required map provider. */ - key?: { - /** A key used to authenticate the application within the "Bing" map provider. */ - bing?: string; - /** A key used to authenticate the application within the "Google" map provider. */ - google?: string; - /** A key used to authenticate the application within the "Google Static" map provider. */ - googleStatic?: string; - } - /** A handler for the markerAdded event. */ - onMarkerAdded?: Function; - /** A URL pointing to the custom icon to be used for map markers. */ - markerIconSrc?: string; - /** A handler for the markerRemoved event. */ - onMarkerRemoved?: Function; - /** An array of markers displayed on a map. */ - markers?: Array; - /** The name of the current map data provider. */ - provider?: string; - /** A handler for the ready event. */ - onReady?: Function; - /** A handler for the routeAdded event. */ - onRouteAdded?: Function; - /** A handler for the routeRemoved event. */ - onRouteRemoved?: Function; - /** An array of routes shown on the map. */ - routes?: Array; - /** The type of a map to display. */ - type?: string; - /** Specifies the width of the widget. */ - width?: any; - /** The zoom level of the map. */ - zoom?: number; - } - /** An interactive map widget. */ - export class dxMap extends Widget { - constructor(element: JQuery, options?: dxMapOptions); - constructor(element: Element, options?: dxMapOptions); - /** Adds a marker to the map. */ - addMarker(markerOptions: Object): JQueryPromise; - /** Adds a route to the map. */ - addRoute(routeOptions: Object): JQueryPromise; - /** Removes a marker from the map. */ - removeMarker(marker: Object): JQueryPromise; - /** Removes a route from the map. */ - removeRoute(route: any): JQueryPromise; - } - export interface dxLookupOptions extends dxDropDownListOptions { - /** An object defining widget animation options. */ - animation?: fx.AnimationOptions; - /** The text displayed on the Cancel button. */ - cancelButtonText?: string; - /** The text displayed on the Clear button. */ - clearButtonText?: string; - /** Specifies whether or not the widget cleans the search box when the popup window is displayed. */ - cleanSearchOnOpening?: boolean; - /** A Boolean value specifying whether or not the widget is closed if a user clicks outside of the overlaying window. */ - closeOnOutsideClick?: any; - /** The text displayed on the Apply button. */ - applyButtonText?: string; - /** A Boolean value specifying whether or not to display the lookup in full-screen mode. */ - fullScreen?: boolean; - focusStateEnabled?: boolean; - /** A Boolean value specifying whether or not to group widget items. */ - grouped?: boolean; - /** The name of the template used to display a group header. */ - groupTemplate?: any; - /** The text displayed on the button used to load the next page from the data source. */ - nextButtonText?: string; - /** A handler for the pageLoading event. */ - onPageLoading?: Function; - /** Specifies whether the next page is loaded when a user scrolls the widget to the bottom or when the "next" button is clicked. */ - pageLoadMode?: string; - /** Specifies the text shown in the pullDown panel, which is displayed when the widget is scrolled to the bottom. */ - pageLoadingText?: string; - /** The text displayed by the widget when nothing is selected. */ - placeholder?: string; - /** The height of the widget popup element. */ - popupHeight?: any; - /** The width of the widget popup element. */ - popupWidth?: any; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** Specifies the text displayed in the pullDown panel when the widget is pulled below the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the pullRefresh event. */ - onPullRefresh?: Function; - /** A Boolean value specifying whether or not the widget supports the "pull down to refresh" gesture. */ - pullRefreshEnabled?: boolean; - /** Specifies the text displayed in the pullDown panel while the widget is being refreshed. */ - refreshingText?: string; - /** A handler for the scroll event. */ - onScroll?: Function; - /** A Boolean value specifying whether or not the search bar is visible. */ - searchEnabled?: boolean; - /** The text that is provided as a hint in the lookup's search bar. */ - searchPlaceholder?: string; - /** A Boolean value specifying whether or not the main screen is inactive while the lookup is active. */ - shading?: boolean; - /** Specifies whether to display the Cancel button in the lookup window. */ - showCancelButton?: boolean; - /** - * A Boolean value specifying whether the widget loads the next page automatically when you reach the bottom of the list or when a button is clicked. - * @deprecated pageLoadMode.md - */ - showNextButton?: boolean; - /** The title of the lookup window. */ - title?: string; - /** A template to be used for rendering the widget title. */ - titleTemplate?: any; - /** Specifies whether or not the widget uses native scrolling. */ - useNativeScrolling?: boolean; - /** Specifies whether or not to show lookup contents in a dxPopover widget. */ - usePopover?: boolean; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - /** A Boolean value specifying whether or not to display the title in the popup window. */ - showPopupTitle?: boolean; - } - /** A widget that allows a user to select predefined values from a lookup window. */ - export class dxLookup extends dxDropDownList { - constructor(element: JQuery, options?: dxLookupOptions); - constructor(element: Element, options?: dxLookupOptions); - /** This section lists the data source fields that are used in a default template for lookup drop-down items. */ - } - export interface dxLoadPanelOptions extends dxOverlayOptions { - /** An object defining the animation options of the widget. */ - animation?: fx.AnimationOptions; - /** The delay in milliseconds after which the load panel is displayed. */ - delay?: number; - /** The height of the widget. */ - height?: number; - /** A URL pointing to an image to be used as a load indicator. */ - indicatorSrc?: string; - /** The text displayed in the load panel. */ - message?: string; - /** A Boolean value specifying whether or not to show a load indicator. */ - showIndicator?: boolean; - /** A Boolean value specifying whether or not to show the pane behind the load indicator. */ - showPane?: boolean; - /** The width of the widget. */ - width?: number; - } - /** A widget used to indicate whether or not an element is loading. */ - export class dxLoadPanel extends dxOverlay { - constructor(element: JQuery, options?: dxLoadPanelOptions); - constructor(element: Element, options?: dxLoadPanelOptions); - } - export interface dxLoadIndicatorOptions extends WidgetOptions { - /** Specifies the path to an image used as the indicator. */ - indicatorSrc?: string; - } - /** The widget used to indicate the loading process. */ - export class dxLoadIndicator extends Widget { - constructor(element: JQuery, options?: dxLoadIndicatorOptions); - constructor(element: Element, options?: dxLoadIndicatorOptions); - } - export interface dxListOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not to display a grouped list. */ - grouped?: boolean; - /** The template to be used for rendering item groups. */ - groupTemplate?: any; - onItemDeleting?: Function; - /** A handler for the itemDeleted event. */ - onItemDeleted?: Function; - /** A handler for the groupRendered event. */ - onGroupRendered?: Function; - /** A handler for the itemReordered event. */ - onItemReordered?: Function; - /** A handler for the itemClick event. */ - onItemClick?: any; - /** A handler for the itemSwipe event. */ - onItemSwipe?: Function; - /** The text displayed on the button used to load the next page from the data source. */ - nextButtonText?: string; - /** A handler for the pageLoading event. */ - onPageLoading?: Function; - /** Specifies the text shown in the pullDown panel, which is displayed when the list is scrolled to the bottom. */ - pageLoadingText?: string; - /** Specifies the text displayed in the pullDown panel when the list is pulled below the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the pullRefresh event. */ - onPullRefresh?: Function; - /** A Boolean value specifying whether or not the widget supports the "pull down to refresh" gesture. */ - pullRefreshEnabled?: boolean; - /** Specifies the text displayed in the pullDown panel while the list is being refreshed. */ - refreshingText?: string; - /** A handler for the scroll event. */ - onScroll?: Function; - /** A Boolean value specifying whether to enable or disable list scrolling. */ - scrollingEnabled?: boolean; - /** Specifies when the widget shows the scrollbar. */ - showScrollbar?: string; - /** Specifies whether or not the widget uses native scrolling. */ - useNativeScrolling?: boolean; - /** A Boolean value specifying whether to enable or disable the bounce-back effect. */ - bounceEnabled?: boolean; - /** A Boolean value specifying if the list is scrolled by content. */ - scrollByContent?: boolean; - /** A Boolean value specifying if the list is scrolled using the scrollbar. */ - scrollByThumb?: boolean; - onItemContextMenu?: Function; - onItemHold?: Function; - /** Specifies whether or not an end-user can collapse groups. */ - collapsibleGroups?: boolean; - /** Specifies whether the next page is loaded when a user scrolls the widget to the bottom or when the "next" button is clicked. */ - pageLoadMode?: string; - /** Specifies whether or not to display controls used to select list items. */ - showSelectionControls?: boolean; - /** Specifies item selection mode. */ - selectionMode?: string; - selectAllText?: string; - onSelectAllChanged?: Function; - /** Specifies the array of items for a context menu called for a list item. */ - menuItems?: Array; - /** Specifies whether an item context menu is shown when a user holds or swipes an item. */ - menuMode?: string; - /** Specifies whether or not an end user can delete list items. */ - allowItemDeleting?: boolean; - /** Specifies the way a user can delete items from the list. */ - itemDeleteMode?: string; - /** Specifies whether or not an end user can reorder list items. */ - allowItemReordering?: boolean; - /** Specifies whether or not to show the loading panel when the DataSource bound to the widget is loading data. */ - indicateLoading?: boolean; - activeStateEnabled?: boolean; - } - /** A list widget. */ - export class dxList extends CollectionWidget { - constructor(element: JQuery, options?: dxListOptions); - constructor(element: Element, options?: dxListOptions); - /** Returns the height of the widget in pixels. */ - clientHeight(): number; - /** Removes the specified item from the list. */ - deleteItem(itemIndex: any): JQueryPromise; - /** Removes the specified item from the list. */ - deleteItem(itemElement: Element): JQueryPromise; - /** Returns a Boolean value that indicates whether or not the specified item is selected. */ - isItemSelected(itemIndex: any): boolean; - /** Returns a Boolean value that indicates whether or not the specified item is selected. */ - isItemSelected(itemElement: Element): boolean; - /** Reloads list data. */ - reload(): void; - /** Moves the specified item to the specified position in the list. */ - reorderItem(itemElement: Element, toItemElement: Element): JQueryPromise; - /** Moves the specified item to the specified position in the list. */ - reorderItem(itemIndex: any, toItemIndex: any): JQueryPromise; - /** Scrolls the list content by the specified number of pixels. */ - scrollBy(distance: number): void; - /** Returns the height of the list content in pixels. */ - scrollHeight(): number; - /** Scrolls list content to the specified position. */ - scrollTo(location: number): void; - /** Scrolls the list to the specified item. */ - scrollToItem(itemElement: Element): void; - /** Scrolls the list to the specified item. */ - scrollToItem(itemIndex: any): void; - /** Returns how far the list content is scrolled from the top. */ - scrollTop(): number; - /** Selects the specified item from the list. */ - selectItem(itemElement: Element): void; - /** Selects the specified item from the list. */ - selectItem(itemIndex: any): void; - /** Deselects the specified item from the list. */ - unselectItem(itemElement: Element): void; - /** Unselects the specified item from the list. */ - unselectItem(itemIndex: any): void; - /** Updates the widget scrollbar according to widget content size. */ - updateDimensions(): JQueryPromise; - /** Expands the specified group. */ - expandGroup(groupIndex: number): JQueryPromise; - /** Collapses the specified group. */ - collapseGroup(groupIndex: number): JQueryPromise; - } - export interface dxGalleryOptions extends CollectionWidgetOptions { - /** The time, in milliseconds, spent on slide animation. */ - animationDuration?: number; - /** Specifies whether or not to animate the displayed item change. */ - animationEnabled?: boolean; - /** A Boolean value specifying whether or not to allow users to switch between items by clicking an indicator. */ - indicatorEnabled?: boolean; - /** A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped. */ - loop?: boolean; - /** The index of the currently active gallery item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to display an indicator that points to the selected gallery item. */ - showIndicator?: boolean; - /** A Boolean value that specifies the availability of the "Forward" and "Back" navigation buttons. */ - showNavButtons?: boolean; - /** The time interval in milliseconds, after which the gallery switches to the next item. */ - slideshowDelay?: number; - /** A Boolean value specifying whether or not to allow users to switch between items by swiping. */ - swipeEnabled?: boolean; - /** Specifies whether or not to display parts of previous and next images along the sides of the current image. */ - wrapAround?: boolean; - /** Specifies if the widget stretches images to fit the total gallery width. */ - stretchImages?: boolean; - /** Specifies the width of an area used to display a single image. */ - initialItemWidth?: number; - } - /** An image gallery widget. */ - export class dxGallery extends CollectionWidget { - constructor(element: JQuery, options?: dxGalleryOptions); - constructor(element: Element, options?: dxGalleryOptions); - /** Shows the specified gallery item. */ - goToItem(itemIndex: number, animation: boolean): JQueryPromise; - /** Shows the next gallery item. */ - nextItem(animation: boolean): JQueryPromise; - /** Shows the previous gallery item. */ - prevItem(animation: boolean): JQueryPromise; - } - export interface dxDropDownEditorOptions extends dxTextBoxOptions { - /** Specifies the current value displayed by the widget. */ - value?: Object; - /** A handler for the closed event. */ - onClosed?: Function; - /** A handler for the opened event. */ - onOpened?: Function; - /** Specifies whether or not the drop-down editor is displayed. */ - opened?: boolean; - /** Specifies whether or not the widget allows an end-user to enter a custom value. */ - fieldEditEnabled?: boolean; - /** Specifies the way an end-user applies the selected value. */ - applyValueMode?: string; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - activeStateEnabled?: boolean; - } - /** A drop-down editor widget. */ - export class dxDropDownEditor extends dxTextBox { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - /** Closes the drop-down editor. */ - close(): void; - /** Opens the drop-down editor. */ - open(): void; - /** Resets the widget's value to null. */ - reset(): void; - /** Returns an <input> element of the widget. */ - field(): JQuery; - /** Returns an HTML element of the popup window content. */ - content(): JQuery; - } - export interface dxDateBoxOptions extends dxTextEditorOptions { - /** A format used to display date/time information. */ - format?: string; - /** A Globalize format string specifying the date display format. */ - formatString?: string; - /** The last date that can be selected within the widget. */ - max?: any; - /** The minimum date that can be selected within the widget. */ - min?: any; - /** The text displayed by the widget when the widget value is not yet specified. This text is also used as a title of the date picker. */ - placeholder?: string; - /** - * Specifies whether or not a user can pick out a date using the drop-down calendar. - * @deprecated Use 'pickerType' option instead. - */ - useCalendar?: boolean; - /** An object or a value, specifying the date and time currently selected using the date box. */ - value?: any; - /** - * Specifies whether or not the widget uses the native HTML input element. - * @deprecated Use 'pickerType' option instead. - */ - useNative?: boolean; - /** Specifies the interval between neighboring values in the popup list in minutes. */ - interval?: number; - /** Specifies the maximum zoom level of a calendar, which is used to pick the date. */ - maxZoomLevel?: string; - /** Specifies the minimal zoom level of a calendar, which is used to pick the date. */ - minZoomLevel?: string; - /** Specifies the type of date/time picker. */ - pickerType?: string; - /** Specifies the message displayed if the typed value is not a valid date or time. */ - invalidDateMessage?: string; - /** Specifies the message displayed if the specified date is later than the max value or earlier than the min value. */ - dateOutOfRangeMessage?: string; - } - /** A date box widget. */ - export class dxDateBox extends dxDropDownEditor { - constructor(element: JQuery, options?: dxDateBoxOptions); - constructor(element: Element, options?: dxDateBoxOptions); - } - export interface dxCheckBoxOptions extends EditorOptions { - activeStateEnabled?: boolean; - /** Specifies the widget state. */ - value?: boolean; - /** Specifies the text displayed by the check box. */ - text?: string; - } - /** A check box widget. */ - export class dxCheckBox extends Editor { - constructor(element: JQuery, options?: dxCheckBoxOptions); - constructor(element: Element, options?: dxCheckBoxOptions); - } - export interface dxCalendarOptions extends EditorOptions { - activeStateEnabled?: boolean; - /** Specifies a date displayed on the current calendar page. */ - currentDate?: Date; - /** Specifies the first day of a week. */ - firstDayOfWeek?: number; - /** The latest date the widget allows to select. */ - max?: Date; - /** The earliest date the widget allows to select. */ - min?: Date; - /** Specifies whether or not the widget displays a button that selects the current date. */ - showTodayButton?: boolean; - /** Specifies the current calendar zoom level. */ - zoomLevel?: string; - /** Specifies the maximum zoom level of the calendar. */ - maxZoomLevel?: string; - /** Specifies the minimum zoom level of the calendar. */ - minZoomLevel?: string; - /** The template to be used for rendering calendar cells. */ - cellTemplate?: any; - } - /** A calendar widget. */ - export class dxCalendar extends Editor { - constructor(element: JQuery, options?: dxCalendarOptions); - constructor(element: Element, options?: dxCalendarOptions); - } - export interface dxButtonOptions extends WidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A handler for the click event. */ - onClick?: any; - /** Specifies the icon to be displayed on the button. */ - icon?: string; - iconSrc?: string; - /** A template to be used for rendering the dxButton widget. */ - template?: any; - /** The text displayed on the button. */ - text?: string; - /** Specifies the button type. */ - type?: string; - /** Specifies the name of the validation group to be accessed in the click event handler. */ - validationGroup?: string; - } - /** A button widget. */ - export class dxButton extends Widget { - constructor(element: JQuery, options?: dxButtonOptions); - constructor(element: Element, options?: dxButtonOptions); - } - export interface dxBoxOptions extends CollectionWidget { - /** Specifies how widget items are aligned along the main direction. */ - align?: string; - /** Specifies the direction of item positioning in the widget. */ - direction?: string; - /** Specifies how widget items are aligned cross-wise. */ - crossAlign?: string; - } - /** A container widget used to arrange inner elements. */ - export class dxBox extends CollectionWidget { - constructor(element: JQuery, options?: dxBoxOptions); - constructor(element: Element, options?: dxBoxOptions); - } - export interface dxResponsiveBoxOptions extends CollectionWidgetOptions { - /** Specifies the collection of rows for the grid used to position layout elements. */ - rows?: Array; - /** Specifies the collection of columns for the grid used to position layout elements. */ - cols?: Array; - /** Specifies the function returning the screen factor depending on the screen width. */ - screenByWidth?: (width: number) => string; - /** Specifies the screen factor with which all elements are located in a single column. */ - singleColumnScreen?: string; - } - /** A widget used to build an adaptive markup that is dependent on screen resolution. */ - export class dxResponsiveBox extends CollectionWidget { - constructor(element: JQuery, options?: dxBoxOptions); - constructor(element: Element, options?: dxBoxOptions); - } - export interface dxAutocompleteOptions extends dxDropDownListOptions { - /** Specifies the current value displayed by the widget. */ - value?: string; - /** The minimum number of characters that must be entered into the text box to begin a search. */ - minSearchLength?: number; - /** Specifies the maximum count of items displayed by the widget. */ - maxItemCount?: number; - /** Gets the currently selected item. */ - selectedItem?: Object; - } - /** A textbox widget that supports autocompletion. */ - export class dxAutocomplete extends dxDropDownList { - constructor(element: JQuery, options?: dxAutocompleteOptions); - constructor(element: Element, options?: dxAutocompleteOptions); - /** Opens the drop-down editor. */ - open(): void; - /** Closes the drop-down editor. */ - close(): void; - } - export interface dxAccordionOptions extends CollectionWidgetOptions { - /** A number specifying the time in milliseconds spent on the animation of the expanding or collapsing of a panel. */ - animationDuration?: number; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies whether all items can be collapsed or whether at least one item must always be expanded. */ - collapsible?: boolean; - /** Specifies whether the widget can expand several items or only a single item at once. */ - multiple?: boolean; - /** The template to be used for rendering dxAccordion items. */ - itemTemplate?: any; - /** A handler for the itemTitleClick event. */ - onItemTitleClick?: any; - /** A handler for the itemTitleHold event. */ - onItemTitleHold?: Function; - /** The template to be used for rendering an item title. */ - itemTitleTemplate?: any; - /** The index number of the currently selected item. */ - selectedIndex?: number; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - } - /** A widget that displays data source items on collapsible panels. */ - export class dxAccordion extends CollectionWidget { - constructor(element: JQuery, options?: dxAccordionOptions); - constructor(element: Element, options?: dxAccordionOptions); - /** Collapses the specified item. */ - collapseItem(index: number): JQueryPromise; - /** Expands the specified item. */ - expandItem(index: number): JQueryPromise; - /** Updates the dimensions of the widget contents. */ - updateDimensions(): JQueryPromise; - } - export interface dxFileUploaderOptions extends EditorOptions { - /** A read-only option that holds a File instance representing the selected file. */ - value?: File; - /** Holds the File instances representing files selected in the widget. */ - values?: Array; - buttonText?: string; - /** The text displayed on the button that opens the file browser. */ - selectButtonText?: string; - /** The text displayed on the button that starts uploading. */ - uploadButtonText?: string; - /** Specifies the text displayed on the area to which an end-user can drop a file. */ - labelText?: string; - /** Specifies the value passed to the name attribute of the underlying input element. */ - name?: string; - /** Specifies whether the widget enables an end-user to select a single file or multiple files. */ - multiple?: boolean; - /** Specifies a file type or several types accepted by the widget. */ - accept?: string; - /** Specifies a target Url for the upload request. */ - uploadUrl?: string; - /** Specifies if an end user can remove a file from the selection and interrupt uploading. */ - allowCanceling?: boolean; - /** Specifies whether or not the widget displays the list of selected files. */ - showFileList?: boolean; - /** Gets the current progress in percentages. */ - progress?: number; - /** The message displayed by the widget when it is ready to upload the specified files. */ - readyToUploadMessage?: string; - /** The message displayed by the widget when uploading is finished. */ - uploadedMessage?: string; - /** The message displayed by the widget on uploading failure. */ - uploadFailedMessage?: string; - /** Specifies how the widget uploads files. */ - uploadMode?: string; - /** A handler for the uploaded event. */ - onUploaded?: Function; - /** A handler for the uploaded event. */ - onProgress?: Function; - /** A handler for the uploadError event. */ - onUploadError?: Function; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - } - /** A widget used to select and upload a file or multiple files. */ - export class dxFileUploader extends Editor { - constructor(element: JQuery, options?: dxFileUploaderOptions); - constructor(element: Element, options?: dxFileUploaderOptions); - } - export interface dxTrackBarOptions extends EditorOptions { - /** The minimum value the widget can accept. */ - min?: number; - /** The maximum value the widget can accept. */ - max?: number; - /** The current widget value. */ - value?: number; - } - /** A base class for track bar widgets. */ - export class dxTrackBar extends Editor { - constructor(element: JQuery, options?: dxTrackBarOptions); - constructor(element: Element, options?: dxTrackBarOptions); - } - export interface dxProgressBarOptions extends dxTrackBarOptions { - /** Specifies a format for the progress status. */ - statusFormat?: any; - /** Specifies whether or not the widget displays a progress status. */ - showStatus?: boolean; - /** A handler for the complete event. */ - onComplete?: Function; - } - /** A widget used to indicate progress. */ - export class dxProgressBar extends dxTrackBar { - constructor(element: JQuery, options?: dxProgressBarOptions); - constructor(element: Element, options?: dxProgressBarOptions); - } - export interface dxSliderOptions extends dxTrackBarOptions { - activeStateEnabled?: boolean; - /** The slider step size. */ - step?: number; - /** The current slider value. */ - value?: number; - /** Specifies whether or not to highlight a range selected within the widget. */ - showRange?: boolean; - /** Specifies the size of a step by which a slider handle is moved when a user uses the Page up or Page down keyboard shortcuts. */ - keyStep?: number; - /** Specifies options for the slider tooltip. */ - tooltip?: { - /** Specifies whether or not the tooltip is enabled. */ - enabled?: boolean; - /** Specifies format for the tooltip. */ - format?: any; - /** Specifies whether the tooltip is located over or under the slider. */ - position?: string; - /** Specifies whether the widget always shows a tooltip or only when a pointer is over the slider. */ - showMode?: string; - }; - /** Specifies options for labels displayed at the min and max values. */ - label?: { - /** Specifies whether or not slider labels are visible. */ - visible?: boolean; - /** Specifies whether labels are located over or under the scale. */ - position?: string; - /** Specifies a format for labels. */ - format?: any; - }; - } - /** A widget that allows a user to select a numeric value within a given range. */ - export class dxSlider extends dxTrackBar { - constructor(element: JQuery, options?: dxSliderOptions); - constructor(element: Element, options?: dxSliderOptions); - } - export interface dxRangeSliderOptions extends dxSliderOptions { - /** The left edge of the interval currently selected using the range slider. */ - start?: number; - /** The right edge of the interval currently selected using the range slider. */ - end?: number; - } - /** A widget that enables a user to select a range of numeric values. */ - export class dxRangeSlider extends dxSlider { - constructor(element: JQuery, options?: dxRangeSliderOptions); - constructor(element: Element, options?: dxRangeSliderOptions); - } - export interface dxFormItemLabel { - /** Specifies the label text. */ - text?: string; - /** Specifies whether or not the label is visible. */ - visible?: boolean; - /** Specifies whether or not a colon is displayed at the end of the current label. */ - showColon?: boolean; - /** Specifies the location of a label against the editor. */ - location?: string; - /** Specifies the label horizontal alignment. */ - alignment?: string; - } - export interface dxFormItem { - /** Specifies the type of the current item. */ - itemType?: string; - /** Specifies whether or not the current form item is visible. */ - visible?: boolean; - /** Specifies the sequence number of the item in a form, group or tab. */ - visibleIndex?: number; - /** Specifies a CSS class to be applied to the form item. */ - cssClass?: string; - /** Specifies the number of columns spanned by the item. */ - colSpan?: number; - } - export interface dxFormSimpleItem extends dxFormItem { - /** Specifies the path to the formData object field bound to the current form item. */ - dataField?: string; - /** Specifies the form item name. */ - name?: string; - /** Specifie which editor widget is used to display and edit the form item value. */ - editorType?: string; - /** Specifies configuration options for the editor widget of the current form item. */ - editorOptions?: Object; - /** A template to be used for rendering the form item. */ - template?: any; - /** Specifies the help text displayed for the current form item. */ - helpText?: string; - /** Specifies whether the current form item is required. */ - isRequired?: boolean; - /** Specifies options for the form item label. */ - label?: dxFormItemLabel; - /** An array of validation rules to be checked for the form item editor. */ - validationRules?: Array; - } - export interface dxFormGroupItem extends dxFormItem { - /** Specifies the group caption. */ - caption?: string; - /** A template to be used for rendering the group item. */ - template?: any; - /** The count of columns in the group layout. */ - colCount?: number; - /** Specifies whether or not all group item labels are aligned. */ - alignItemLabels?: boolean; - /** Holds an array of form items displayed within the group. */ - items?: Array; - } - export interface dxFormTab { - /** Specifies the tab title. */ - title?: string; - /** The count of columns in the tab layout. */ - colCount?: number; - /** Specifies whether or not labels of items displayed within the current tab are aligned. */ - alignItemLabels?: boolean; - /** Holds an array of form items displayed within the tab. */ - items?: Array; - } - export interface dxFormTabbedItem extends dxFormItem { - /** Holds a configuration object for the dxTabPanel widget used to display the current form item. */ - tabPanelOptions?: Object; - /** An array of tab configuration objects. */ - tabs?: Array; - } - export interface dxFormOptions extends WidgetOptions { - /** An object providing data for the form. */ - formData?: Object; - /** The count of columns in the form layout. */ - colCount?: any; - /** Specifies the location of a label against the editor. */ - labelLocation?: string; - /** Specifies whether or not all editors on the form are read-only. */ - readOnly?: boolean; - /** A handler for the fieldDataChanged event. */ - onFieldDataChanged?: (e: Object) => void; - /** A handler for the editorEnterKey event. */ - onEditorEnterKey?: (e: Object) => void; - /** Specifies a function that customizes a form item after it has been created. */ - customizeItem?: Function; - /** The minimum column width used for calculating column count in the form layout. */ - minColWidth?: number; - /** Specifies whether or not all root item labels are aligned. */ - alignItemLabels?: boolean; - /** Specifies whether or not item labels in all groups are aligned. */ - alignItemLabelsInAllGroups?: boolean; - /** Specifies whether or not a colon is displayed at the end of form labels. */ - showColonAfterLabel?: boolean; - /** Specifies whether or not the required mark is displayed for optional fields. */ - showRequiredMark?: boolean; - /** Specifies whether or not the optional mark is displayed for optional fields. */ - showOptionalMark?: boolean; - /** The text displayed for required fields. */ - requiredMark?: string; - /** The text displayed for optional fields. */ - optionalMark?: string; - /** Specifies whether or not the total validation summary is displayed on the form. */ - showValidationSummary?: boolean; - /** Holds an array of form items. */ - items?: Array; - /** A Boolean value specifying whether to enable or disable form scrolling. */ - scrollingEnabled?: boolean; - } - /** A form widget used to display and edit values of object fields. */ - export class dxForm extends Widget { - constructor(element: JQuery, options?: dxFormOptions); - constructor(element: Element, options?: dxFormOptions); - /** Updates the specified field of the formData object and the corresponding editor on the form. */ - updateData(dataField: string, value: any): void; - /** Updates the specified fields of the formData object and the corresponding editors on the form. */ - updateData(data: Object): void; - /** Updates the value of a form item option. */ - itemOption(field: string, option: string, value: any): void; - /** Updates the values of form item options. */ - itemOption(field: string, options: Object): void; - /** Returns an editor instance associated with the specified formData field. */ - getEditor(field: string): Object; - /** Updates the dimensions of the widget contents. */ - updateDimensions(): JQueryPromise; - /** Validates the values of all editors on the form against the list of the validation rules specified for each form item. */ - validate(): Object; - } -} -interface JQuery { - dxProgressBar(): JQuery; - dxProgressBar(options: "instance"): DevExpress.ui.dxProgressBar; - dxProgressBar(options: string): any; - dxProgressBar(options: string, ...params: any[]): any; - dxProgressBar(options: DevExpress.ui.dxProgressBarOptions): JQuery; - dxSlider(): JQuery; - dxSlider(options: "instance"): DevExpress.ui.dxSlider; - dxSlider(options: string): any; - dxSlider(options: string, ...params: any[]): any; - dxSlider(options: DevExpress.ui.dxSliderOptions): JQuery; - dxRangeSlider(): JQuery; - dxRangeSlider(options: "instance"): DevExpress.ui.dxRangeSlider; - dxRangeSlider(options: string): any; - dxRangeSlider(options: string, ...params: any[]): any; - dxRangeSlider(options: DevExpress.ui.dxRangeSliderOptions): JQuery; - dxFileUploader(): JQuery; - dxFileUploader(options: "instance"): DevExpress.ui.dxFileUploader; - dxFileUploader(options: string): any; - dxFileUploader(options: string, ...params: any[]): any; - dxFileUploader(options: DevExpress.ui.dxFileUploaderOptions): JQuery; - dxValidator(): JQuery; - dxValidator(options: "instance"): DevExpress.ui.dxValidator; - dxValidator(options: string): any; - dxValidator(options: string, ...params: any[]): any; - dxValidator(options: DevExpress.ui.dxValidatorOptions): JQuery; - dxValidationGroup(): JQuery; - dxValidationGroup(options: "instance"): DevExpress.ui.dxValidationGroup; - dxValidationGroup(options: string): any; - dxValidationGroup(options: string, ...params: any[]): any; - dxValidationSummary(): JQuery; - dxValidationSummary(options: "instance"): DevExpress.ui.dxValidationSummary; - dxValidationSummary(options: string): any; - dxValidationSummary(options: string, ...params: any[]): any; - dxValidationSummary(options: DevExpress.ui.dxValidationSummaryOptions): JQuery; - dxTooltip(): JQuery; - dxTooltip(options: "instance"): DevExpress.ui.dxTooltip; - dxTooltip(options: string): any; - dxTooltip(options: string, ...params: any[]): any; - dxTooltip(options: DevExpress.ui.dxTooltipOptions): JQuery; - dxResizable(): JQuery; - dxResizable(options: "instance"): DevExpress.ui.dxResizable; - dxResizable(options: string): any; - dxResizable(options: string, ...params: any[]): any; - dxResizable(options: DevExpress.ui.dxResizableOptions): JQuery; - dxDropDownList(): JQuery; - dxDropDownList(options: "instance"): DevExpress.ui.dxDropDownList; - dxDropDownList(options: string): any; - dxDropDownList(options: string, ...params: any[]): any; - dxDropDownList(options: DevExpress.ui.dxDropDownListOptions): JQuery; - dxToolbar(): JQuery; - dxToolbar(options: "instance"): DevExpress.ui.dxToolbar; - dxToolbar(options: string): any; - dxToolbar(options: string, ...params: any[]): any; - dxToolbar(options: DevExpress.ui.dxToolbarOptions): JQuery; - dxToast(): JQuery; - dxToast(options: "instance"): DevExpress.ui.dxToast; - dxToast(options: string): any; - dxToast(options: string, ...params: any[]): any; - dxToast(options: DevExpress.ui.dxToastOptions): JQuery; - dxTextEditor(): JQuery; - dxTextEditor(options: "instance"): DevExpress.ui.dxTextEditor; - dxTextEditor(options: string): any; - dxTextEditor(options: string, ...params: any[]): any; - dxTextEditor(options: DevExpress.ui.dxTextEditorOptions): JQuery; - dxTextBox(): JQuery; - dxTextBox(options: "instance"): DevExpress.ui.dxTextBox; - dxTextBox(options: string): any; - dxTextBox(options: string, ...params: any[]): any; - dxTextBox(options: DevExpress.ui.dxTextBoxOptions): JQuery; - dxTextArea(): JQuery; - dxTextArea(options: "instance"): DevExpress.ui.dxTextArea; - dxTextArea(options: string): any; - dxTextArea(options: string, ...params: any[]): any; - dxTextArea(options: DevExpress.ui.dxTextAreaOptions): JQuery; - dxTabs(): JQuery; - dxTabs(options: "instance"): DevExpress.ui.dxTabs; - dxTabs(options: string): any; - dxTabs(options: string, ...params: any[]): any; - dxTabs(options: DevExpress.ui.dxTabsOptions): JQuery; - dxTabPanel(): JQuery; - dxTabPanel(options: "instance"): DevExpress.ui.dxTabPanel; - dxTabPanel(options: string): any; - dxTabPanel(options: string, ...params: any[]): any; - dxTabPanel(options: DevExpress.ui.dxTabPanelOptions): JQuery; - dxSelectBox(): JQuery; - dxSelectBox(options: "instance"): DevExpress.ui.dxSelectBox; - dxSelectBox(options: string): any; - dxSelectBox(options: string, ...params: any[]): any; - dxSelectBox(options: DevExpress.ui.dxSelectBoxOptions): JQuery; - dxTagBox(): JQuery; - dxTagBox(options: "instance"): DevExpress.ui.dxTagBox; - dxTagBox(options: string): any; - dxTagBox(options: string, ...params: any[]): any; - dxTagBox(options: DevExpress.ui.dxTagBoxOptions): JQuery; - dxScrollView(): JQuery; - dxScrollView(options: "instance"): DevExpress.ui.dxScrollView; - dxScrollView(options: string): any; - dxScrollView(options: string, ...params: any[]): any; - dxScrollView(options: DevExpress.ui.dxScrollViewOptions): JQuery; - dxScrollable(): JQuery; - dxScrollable(options: "instance"): DevExpress.ui.dxScrollable; - dxScrollable(options: string): any; - dxScrollable(options: string, ...params: any[]): any; - dxScrollable(options: DevExpress.ui.dxScrollableOptions): JQuery; - dxRadioGroup(): JQuery; - dxRadioGroup(options: "instance"): DevExpress.ui.dxRadioGroup; - dxRadioGroup(options: string): any; - dxRadioGroup(options: string, ...params: any[]): any; - dxRadioGroup(options: DevExpress.ui.dxRadioGroupOptions): JQuery; - dxPopup(): JQuery; - dxPopup(options: "instance"): DevExpress.ui.dxPopup; - dxPopup(options: string): any; - dxPopup(options: string, ...params: any[]): any; - dxPopup(options: DevExpress.ui.dxPopupOptions): JQuery; - dxPopover(): JQuery; - dxPopover(options: "instance"): DevExpress.ui.dxPopover; - dxPopover(options: string): any; - dxPopover(options: string, ...params: any[]): any; - dxPopover(options: DevExpress.ui.dxPopoverOptions): JQuery; - dxOverlay(): JQuery; - dxOverlay(options: "instance"): DevExpress.ui.dxOverlay; - dxOverlay(options: string): any; - dxOverlay(options: string, ...params: any[]): any; - dxOverlay(options: DevExpress.ui.dxOverlayOptions): JQuery; - dxNumberBox(): JQuery; - dxNumberBox(options: "instance"): DevExpress.ui.dxNumberBox; - dxNumberBox(options: string): any; - dxNumberBox(options: string, ...params: any[]): any; - dxNumberBox(options: DevExpress.ui.dxNumberBoxOptions): JQuery; - dxNavBar(): JQuery; - dxNavBar(options: "instance"): DevExpress.ui.dxNavBar; - dxNavBar(options: string): any; - dxNavBar(options: string, ...params: any[]): any; - dxNavBar(options: DevExpress.ui.dxNavBarOptions): JQuery; - dxMultiView(): JQuery; - dxMultiView(options: "instance"): DevExpress.ui.dxMultiView; - dxMultiView(options: string): any; - dxMultiView(options: string, ...params: any[]): any; - dxMultiView(options: DevExpress.ui.dxMultiViewOptions): JQuery; - dxMap(): JQuery; - dxMap(options: "instance"): DevExpress.ui.dxMap; - dxMap(options: string): any; - dxMap(options: string, ...params: any[]): any; - dxMap(options: DevExpress.ui.dxMapOptions): JQuery; - dxLookup(): JQuery; - dxLookup(options: "instance"): DevExpress.ui.dxLookup; - dxLookup(options: string): any; - dxLookup(options: string, ...params: any[]): any; - dxLookup(options: DevExpress.ui.dxLookupOptions): JQuery; - dxLoadPanel(): JQuery; - dxLoadPanel(options: "instance"): DevExpress.ui.dxLoadPanel; - dxLoadPanel(options: string): any; - dxLoadPanel(options: string, ...params: any[]): any; - dxLoadPanel(options: DevExpress.ui.dxLoadPanelOptions): JQuery; - dxLoadIndicator(): JQuery; - dxLoadIndicator(options: "instance"): DevExpress.ui.dxLoadIndicator; - dxLoadIndicator(options: string): any; - dxLoadIndicator(options: string, ...params: any[]): any; - dxLoadIndicator(options: DevExpress.ui.dxLoadIndicatorOptions): JQuery; - dxList(): JQuery; - dxList(options: "instance"): DevExpress.ui.dxList; - dxList(options: string): any; - dxList(options: string, ...params: any[]): any; - dxList(options: DevExpress.ui.dxListOptions): JQuery; - dxGallery(): JQuery; - dxGallery(options: "instance"): DevExpress.ui.dxGallery; - dxGallery(options: string): any; - dxGallery(options: string, ...params: any[]): any; - dxGallery(options: DevExpress.ui.dxGalleryOptions): JQuery; - dxDropDownEditor(): JQuery; - dxDropDownEditor(options: "instance"): DevExpress.ui.dxDropDownEditor; - dxDropDownEditor(options: string): any; - dxDropDownEditor(options: string, ...params: any[]): any; - dxDropDownEditor(options: DevExpress.ui.dxDropDownEditorOptions): JQuery; - dxDateBox(): JQuery; - dxDateBox(options: "instance"): DevExpress.ui.dxDateBox; - dxDateBox(options: string): any; - dxDateBox(options: string, ...params: any[]): any; - dxDateBox(options: DevExpress.ui.dxDateBoxOptions): JQuery; - dxCheckBox(): JQuery; - dxCheckBox(options: "instance"): DevExpress.ui.dxCheckBox; - dxCheckBox(options: string): any; - dxCheckBox(options: string, ...params: any[]): any; - dxCheckBox(options: DevExpress.ui.dxCheckBoxOptions): JQuery; - dxBox(): JQuery; - dxBox(options: "instance"): DevExpress.ui.dxBox; - dxBox(options: string): any; - dxBox(options: string, ...params: any[]): any; - dxBox(options: DevExpress.ui.dxBoxOptions): JQuery; - dxButton(): JQuery; - dxButton(options: "instance"): DevExpress.ui.dxButton; - dxButton(options: string): any; - dxButton(options: string, ...params: any[]): any; - dxButton(options: DevExpress.ui.dxButtonOptions): JQuery; - dxCalendar(): JQuery; - dxCalendar(options: "instance"): DevExpress.ui.dxCalendar; - dxCalendar(options: string): any; - dxCalendar(options: string, ...params: any[]): any; - dxCalendar(options: DevExpress.ui.dxCalendarOptions): JQuery; - dxAccordion(): JQuery; - dxAccordion(options: "instance"): DevExpress.ui.dxAccordion; - dxAccordion(options: string): any; - dxAccordion(options: string, ...params: any[]): any; - dxAccordion(options: DevExpress.ui.dxAccordionOptions): JQuery; - dxResponsiveBox(): JQuery; - dxResponsiveBox(options: "instance"): DevExpress.ui.dxResponsiveBox; - dxResponsiveBox(options: string): any; - dxResponsiveBox(options: string, ...params: any[]): any; - dxResponsiveBox(options: DevExpress.ui.dxResponsiveBoxOptions): JQuery; - dxAutocomplete(): JQuery; - dxAutocomplete(options: "instance"): DevExpress.ui.dxAutocomplete; - dxAutocomplete(options: string): any; - dxAutocomplete(options: string, ...params: any[]): any; - dxAutocomplete(options: DevExpress.ui.dxAutocompleteOptions): JQuery; - dxForm(): JQuery; - dxForm(options: "instance"): DevExpress.ui.dxForm; - dxForm(options: string): any; - dxForm(options: string, ...params: any[]): any; - dxForm(options: DevExpress.ui.dxForm): JQuery; -} - -declare namespace DevExpress.ui { - export interface dxTileViewOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** Specifies the height of the base tile view item. */ - baseItemHeight?: number; - /** Specifies the width of the base tile view item. */ - baseItemWidth?: number; - /** Specifies whether tiles are placed horizontally or vertically. */ - direction?: string; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies the distance in pixels between adjacent tiles. */ - itemMargin?: number; - /** A Boolean value specifying whether or not to display a scrollbar. */ - showScrollbar?: boolean; - } - /** A widget displaying several blocks of data as tiles. */ - export class dxTileView extends CollectionWidget { - constructor(element: JQuery, options?: dxTileViewOptions); - constructor(element: Element, options?: dxTileViewOptions); - /** Returns the current scroll position of the widget content. */ - scrollPosition(): number; - } - export interface dxSwitchOptions extends EditorOptions { - activeStateEnabled?: boolean; - /** Text displayed when the widget is in a disabled state. */ - offText?: string; - /** Text displayed when the widget is in an enabled state. */ - onText?: string; - /** A Boolean value specifying whether the current switch state is "On" or "Off". */ - value?: boolean; - } - /** A switch widget. */ - export class dxSwitch extends Editor { - constructor(element: JQuery, options?: dxSwitchOptions); - constructor(element: Element, options?: dxSwitchOptions); - } - export interface dxSlideOutViewOptions extends WidgetOptions { - /** Specifies the current menu position. */ - menuPosition?: string; - /** Specifies whether or not the menu panel is visible. */ - menuVisible?: boolean; - /** Specifies whether or not the menu is shown when a user swipes the widget content. */ - swipeEnabled?: boolean; - /** A template to be used for rendering menu panel content. */ - menuTemplate?: any; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - } - /** The widget that allows you to slide-out the current view to reveal a custom menu. */ - export class dxSlideOutView extends Widget { - constructor(element: JQuery, options?: dxSlideOutViewOptions); - constructor(element: Element, options?: dxSlideOutViewOptions); - /** Returns an HTML element of the widget menu block. */ - menuContent(): JQuery; - /** Returns an HTML element of the widget content block. */ - content(): JQuery; - /** Displays the widget's menu block. */ - showMenu(): JQueryPromise; - /** Hides the widget's menu block. */ - hideMenu(): JQueryPromise; - /** Toggles the visibility of the widget's menu block. */ - toggleMenuVisibility(): JQueryPromise; - } - export interface dxSlideOutOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A Boolean value specifying whether or not to display a grouped menu. */ - menuGrouped?: boolean; - /** Specifies the current menu position. */ - menuPosition?: string; - /** The name of the template used to display a group header. */ - menuGroupTemplate?: any; - /** The template used to render menu items. */ - menuItemTemplate?: any; - /** A handler for the menuGroupRendered event. */ - onMenuGroupRendered?: Function; - /** A handler for the menuItemRendered event. */ - onMenuItemRendered?: Function; - /** Specifies whether or not the slide-out menu is displayed. */ - menuVisible?: boolean; - /** Indicates whether the menu can be shown/hidden by swiping the widget's main panel. */ - swipeEnabled?: boolean; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - } - /** The widget that allows you to slide-out the current view to reveal an item list. */ - export class dxSlideOut extends CollectionWidget { - constructor(element: JQuery, options?: dxSlideOutOptions); - constructor(element: Element, options?: dxSlideOutOptions); - /** Hides the widget's slide-out menu. */ - hideMenu(): JQueryPromise; - /** Displays the widget's slide-out menu. */ - showMenu(): JQueryPromise; - /** Toggles the visibility of the widget's slide-out menu. */ - toggleMenuVisibility(showing: boolean): JQueryPromise; - } - export interface dxPivotOptions extends CollectionWidgetOptions { - /** The index of the currently active pivot item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to allow users to switch between items by swiping. */ - swipeEnabled?: boolean; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - /** The template to be used for rendering an item title. */ - itemTitleTemplate?: any; - } - /** A widget that is similar to a traditional tab control, but optimized for the phone with simplified end-user interaction. */ - export class dxPivot extends CollectionWidget { - constructor(element: JQuery, options?: dxPivotOptions); - constructor(element: Element, options?: dxPivotOptions); - } - export interface dxPanoramaOptions extends CollectionWidgetOptions { - /** An object exposing options for setting a background image for the panorama. */ - backgroundImage?: { - /** Specifies the height of the panorama's background image. */ - height?: number; - /** Specifies the URL of the image that is used as the panorama's background image. */ - url?: string; - /** Specifies the width of the panorama's background image. */ - width?: number; - }; - /** The index of the currently active panorama item. */ - selectedIndex?: number; - /** Specifies the widget content title. */ - title?: string; - } - /** A widget displaying the required content in a long horizontal canvas that extends beyond the frames of the screen. */ - export class dxPanorama extends CollectionWidget { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - } - export interface dxDropDownMenuOptions extends WidgetOptions { - /** A handler for the buttonClick event. */ - onButtonClick?: any; - /** The name of the icon to be displayed by the DropDownMenu button. */ - buttonIcon?: string; - /** The text displayed in the DropDownMenu button. */ - buttonText?: string; - buttonIconSrc?: string; - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** A handler for the itemClick event. */ - onItemClick?: any; - /** An array of items displayed by the widget. */ - items?: Array; - /** The template to be used for rendering items. */ - itemTemplate?: any; - /** Specifies whether or not to show the drop down menu within a dxPopover widget. */ - usePopover?: boolean; - /** The width of the menu popup in pixels. */ - popupWidth?: any; - /** The height of the menu popup in pixels. */ - popupHeight?: any; - /** Specifies whether or not the drop-down menu is displayed. */ - opened?: boolean; - hoverStateEnabled?: boolean; - activeStateEnabled?: boolean; - } - /** A drop-down menu widget. */ - export class dxDropDownMenu extends Widget { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - /** This section lists the data source fields that are used in a default template for drop-down menu items. */ - /** Opens the drop-down menu. */ - open(): void; - /** Closes the drop-down menu. */ - close(): void; - } - export interface dxActionSheetOptions extends CollectionWidgetOptions { - /** A handler for the cancelClick event. */ - onCancelClick?: any; - /** The text displayed in the button that closes the action sheet. */ - cancelText?: string; - /** Specifies whether or not to display the Cancel button in action sheet. */ - showCancelButton?: boolean; - /** A Boolean value specifying whether or not the title of the action sheet is visible. */ - showTitle?: boolean; - /** Specifies the element the action sheet popover points at. */ - target?: any; - /** The title of the action sheet. */ - title?: string; - /** Specifies whether or not to show the action sheet within a dxPopover widget. */ - usePopover?: boolean; - /** A Boolean value specifying whether or not the dxActionSheet widget is visible. */ - visible?: boolean; - } - /** A widget consisting of a set of choices related to a certain task. */ - export class dxActionSheet extends CollectionWidget { - constructor(element: JQuery, options?: dxActionSheetOptions); - constructor(element: Element, options?: dxActionSheetOptions); - /** Hides the widget. */ - hide(): JQueryPromise; - /** Shows the widget. */ - show(): JQueryPromise; - /** Shows or hides the widget depending on the Boolean value passed as the parameter. */ - toggle(showing: boolean): JQueryPromise; - } -} -interface JQuery { - dxTileView(): JQuery; - dxTileView(options: "instance"): DevExpress.ui.dxTileView; - dxTileView(options: string): any; - dxTileView(options: string, ...params: any[]): any; - dxTileView(options: DevExpress.ui.dxTileViewOptions): JQuery; - dxSwitch(): JQuery; - dxSwitch(options: "instance"): DevExpress.ui.dxSwitch; - dxSwitch(options: string): any; - dxSwitch(options: string, ...params: any[]): any; - dxSwitch(options: DevExpress.ui.dxSwitchOptions): JQuery; - dxSlideOut(): JQuery; - dxSlideOut(options: "instance"): DevExpress.ui.dxSlideOut; - dxSlideOut(options: string): any; - dxSlideOut(options: string, ...params: any[]): any; - dxSlideOut(options: DevExpress.ui.dxSlideOutOptions): JQuery; - dxPivot(): JQuery; - dxPivot(options: "instance"): DevExpress.ui.dxPivot; - dxPivot(options: string): any; - dxPivot(options: string, ...params: any[]): any; - dxPivot(options: DevExpress.ui.dxPivotOptions): JQuery; - dxPanorama(): JQuery; - dxPanorama(options: "instance"): DevExpress.ui.dxPanorama; - dxPanorama(options: string): any; - dxPanorama(options: string, ...params: any[]): any; - dxPanorama(options: DevExpress.ui.dxPanoramaOptions): JQuery; - dxActionSheet(): JQuery; - dxActionSheet(options: "instance"): DevExpress.ui.dxActionSheet; - dxActionSheet(options: string): any; - dxActionSheet(options: string, ...params: any[]): any; - dxActionSheet(options: DevExpress.ui.dxActionSheetOptions): JQuery; - dxDropDownMenu(): JQuery; - dxDropDownMenu(options: "instance"): DevExpress.ui.dxDropDownMenu; - dxDropDownMenu(options: string): any; - dxDropDownMenu(options: string, ...params: any[]): any; - dxDropDownMenu(options: DevExpress.ui.dxDropDownMenuOptions): JQuery; -} -declare namespace DevExpress.data { - export interface XmlaStoreOptions { - /** The HTTP address to an XMLA OLAP server. */ - url?: string; - /** The name of the database associated with the Store. */ - catalog?: string; - /** The cube name. */ - cube?: string; - beforeSend?: (request: Object) => void; - } - /** A Store that provides access to an OLAP cube using the XMLA standard. */ - export class XmlaStore { - constructor(options: XmlaStoreOptions); - } - export interface PivotGridField { - index?: number; - /** A boolean value specifying whether or not the field is visible in the pivot grid and the Field Chooser. */ - visible?: boolean; - /** Name of the data source field containing data for the pivot grid field. */ - dataField?: string; - /** A caption that will be displayed in the pivot grid's field chooser to identify the field. */ - caption?: string; - /** Specifies a type of field values. */ - dataType?: string; - /** Specifies how the values of the current field are combined into groups. Cannot be used for the XmlaStore store type. */ - groupInterval?: any; - /** Specifies how to aggregate field data. Cannot be used for the XmlaStore store type. */ - summaryType?: string; - /** Allows you to use a custom aggregate function to calculate the summary values. Cannot be used for the XmlaStore store type. */ - calculateCustomSummary?: (options: { - summaryProcess?: string; - value?: any; - totalValue?: any; - }) => void; - /** Specifies the function that determines how to split data from the data source into ranges for header items. Cannot be used for the XmlaStore store type. */ - selector?: (data: Object) => any; - /** Type of the area where the field is located. */ - area?: string; - /** Index among the other fields displayed within the same area. */ - areaIndex?: number; - /** The name of the folder in which the field is located. */ - displayFolder?: string; - /** The name of the group to which the field belongs. */ - groupName?: string; - /** The index of the field within a group. */ - groupIndex?: number; - /** Specifies the initial sort order of field values. */ - sortOrder?: string; - /** Specifies how field data should be sorted. Can be used for the XmlaStore store type only. */ - sortBy?: string; - /** Specifies the data field against which the header items of this field should be sorted. */ - sortBySummaryField?: string; - /** The array of field names that specify a path to column/row whose summary field is used for sorting of this field's header items. */ - sortBySummaryPath?: Array; - /** The filter values for the current field. */ - filterValues?: Array; - /** The filter type for the current field. */ - filterType?: string; - /** Indicates whether all header items of the field's header level are expanded. */ - expanded?: boolean; - /** Specifies whether the field should be treated as a Data Field. */ - isMeasure?: boolean; - /** Specifies a display format for field values. */ - format?: string; - /** Specifies a callback function that returns the text to be displayed in the cells of a field. */ - customizeText?: (cellInfo: { value: any; valueText: string }) => string; - /** Specifies a precision for formatted field values. */ - precision?: number; - /** Specifies how to sort the header items. */ - sortingMethod?: (a: Object, b: Object) => number; - /** Allows an end-user to change sorting options. */ - allowSorting?: boolean; - /** Allows an end-user to sort columns by summary values. */ - allowSortingBySummary?: boolean; - /** Allows an end-user to change filtering options. */ - allowFiltering?: boolean; - /** Allows an end-user to expand/collapse all header items within a header level. */ - allowExpandAll?: boolean; - /** Specifies the absolute width of the field in the pivot grid. */ - width?: number; - /** Specifies the summary post-processing algorithm. */ - summaryDisplayMode?: string; - /** Specifies whether to summarize each next summary value with the previous one by rows or columns. */ - runningTotal?: string; - /** Specifies whether to allow the predefined summary post-processing functions ('absoluteVariation' and 'percentVariation') and runningTotal to take values of different groups into account. */ - allowCrossGroupCalculation?: boolean; - /** Specifies a callback function that allows you to modify summary values after they are calculated. */ - calculateSummaryValue?: (e: Object) => number; - /** Specifies whether or not to display Total values for the field. */ - showTotals?: boolean; - /** Specifies whether or not to display Grand Total values for the field. */ - showGrandTotals?: boolean; - } - export class SummaryCell { - /** Gets the parent cell in a specified direction. */ - parent(direction: string): SummaryCell; - /** Gets all children cells in a specified direction. */ - children(direction: string): Array; - /** Gets a partial Grand Total cell of a row or column. */ - grandTotal(direction: string): SummaryCell; - /** Gets the Grand Total of the entire pivot grid. */ - grandTotal(): SummaryCell; - /** Gets the cell next to the current one in a specified direction. */ - next(direction: string): SummaryCell; - /** Gets the cell next to current in a specified direction. */ - next(direction: string, allowCrossGroup: boolean): SummaryCell; - /** Gets the cell prior to the current one in a specified direction. */ - prev(direction: string): SummaryCell; - /** Gets the cell previous to current in a specified direction. */ - prev(direction: string, allowCrossGroup: boolean): SummaryCell; - /** Gets the child cell in a specified direction. */ - child(direction: string, fieldValue: any): SummaryCell; - /** Gets the cell located by the path of the source cell with one field value changed. */ - slice(field: PivotGridField, value: any): SummaryCell; - /** Gets the header cell of a row or column field to which the current cell belongs. */ - field(area: string): PivotGridField; - /** Gets the value of the current cell. */ - value(): any; - /** Gets the value of the current cell. */ - value(isCalculatedValue: boolean): any; - /** Gets the value of any field linked with the current cell. */ - value(field: PivotGridField): any; - /** Gets the value of any field linked with the current cell. */ - value(field: PivotGridField, isCalculatedValue: boolean): any; - } - export interface PivotGridDataSourceOptions { - /** Specifies the underlying Store instance used to access data. */ - store?: any; - /** Indicates whether or not the automatic field generation from data in the Store is enabled. */ - retrieveFields?: boolean; - /** Specifies data filtering conditions. Cannot be used for the XmlaStore store type. */ - filter?: Object; - /** An array of pivot grid fields. */ - fields?: Array; - /** A handler for the changed event. */ - onChanged?: () => void; - /** A handler for the loadingChanged event. */ - onLoadingChanged?: (isLoading: boolean) => void; - /** A handler for the loadError event. */ - onLoadError?: (e?: Object) => void; - /** A handler for the fieldsPrepared event. */ - onFieldsPrepared?: (e?: Array) => void; - } - /** An object that provides access to data for the dxPivotGrid widget. */ - export class PivotGridDataSource implements EventsMixin { - constructor(options?: PivotGridDataSource); - /** Starts reloading data from any store and updating the data source. */ - reload(): JQueryPromise; - /** Starts updating the data source. Reloads data from the XMLA store only. */ - load(): JQueryPromise; - /** Indicates whether or not the PivotGridDataSource is currently being loaded. */ - isLoading(): boolean; - /** Gets data displayed in a PivotGrid. */ - getData(): Object; - /** Gets all fields within a specified area. */ - getAreaFields(area: string, collectGroups: boolean): Array; - /** Gets all fields from the data source. */ - fields(): Array; - /** Sets the fields option. */ - fields(fields: Array): void; - /** Gets current options of a specified field. */ - field(id: any): PivotGridField; - /** Sets one or more options of a specified field. */ - field(id: any, field: PivotGridField): void; - /** Collapses a specified header item. */ - collapseHeaderItem(area: string, path: Array): void; - /** Expands a specified header item. */ - expandHeaderItem(area: string, path: Array): void; - /** Expands all header items of a field. */ - expandAll(id: any): void; - /** Collapses all header items of a field. */ - collapseAll(id: any): void; - /** Disposes of all resources associated with this PivotGridDataSource. */ - dispose(): void; - /** Gets the current filter expression. Cannot be used for the XmlaStore store type. */ - filter(): Object; - /** Applies a new filter expression. Cannot be used for the XmlaStore store type. */ - filter(filterExpr: Object): void; - /** Provides access to a list of records (facts) that were used to calculate a specific summary. */ - createDrillDownDataSource(options: { - columnPath?: Array; - rowPath?: Array; - dataIndex?: number; - maxRowCount?: number; - customColumns?: Array; - }): DevExpress.data.DataSource; - /** Gets the current PivotGridDataSource state (fields configuration, sorting, filters, expanded headers, etc.) */ - state(): Object; - /** Sets the PivotGridDataSource state. */ - state(state: Object): void; - on(eventName: string, eventHandler: Function): PivotGridDataSource; - on(events: { [eventName: string]: Function; }): PivotGridDataSource; - off(eventName: string): PivotGridDataSource; - off(eventName: string, eventHandler: Function): PivotGridDataSource; - } -} -declare namespace DevExpress.ui { - export interface dxSchedulerOptions extends WidgetOptions { - /** Specifies a date displayed on the current scheduler view by default. */ - currentDate?: Date; - /** The earliest date the widget allows you to select. */ - min?: Date; - /** The latest date the widget allows you to select. */ - max?: Date; - /** Specifies the view used in the scheduler by default. */ - currentView?: string; - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** Specifies the first day of a week. */ - firstDayOfWeek?: number; - /** The template to be used for rendering appointments. */ - appointmentTemplate?: any; - /** The template to be used for rendering an appointment tooltip. */ - appointmentTooltipTemplate?: any; - /** Lists the views to be available within the scheduler's View Selector. */ - views?: Array; - /** Specifies the resource kinds by which the scheduler's appointments are grouped in a timetable. */ - groups?: Array; - /** Specifies a start hour in the scheduler view's time interval. */ - startDayHour?: number; - /** Specifies an end hour in the scheduler view's time interval. */ - endDayHour?: number; - /** Specifies whether or not the "All-day" panel is visible. */ - showAllDayPanel?: boolean; - /** Specifies cell duration in minutes. */ - cellDuration?: number; - /** Specifies the edit mode for recurrent appointments. */ - recurrenceEditMode?: string; - /** Specifies which editing operations an end-user can perform on appointments. */ - editing?: { - /** Specifies whether or not an end-user can add appointments. */ - allowAdding?: boolean; - /** Specifies whether or not an end-user can change appointment options. */ - allowUpdating?: boolean; - /** Specifies whether or not an end-user can delete appointments. */ - allowDeleting?: boolean; - /** Specifies whether or not an end-user can change an appointment duration. */ - allowResizing?: boolean; - /** Specifies whether or not an end-user can drag appointments. */ - allowDragging?: boolean; - } - /** Specifies an array of resources available in the scheduler. */ - resources?: Array<{ - /** Indicates whether or not several resources of this kind can be assigned to an appointment. */ - allowMultiple?: boolean; - /** - * Indicates whether or not resources of this kind have priority in the color identification of the appointments that have resources of different kinds assigned. - * @deprecated Use the 'useColorAsDefault' property instead - */ - mainColor?: boolean; - /** Indicates whether or not resources of this kind have priority in the color identification of the appointments that have resources of different kinds assigned. */ - useColorAsDefault?: boolean; - /** A data source used to fetch resources to be available in the scheduler. */ - dataSource?: any; - /** Specifies the resource object field whose value is displayed by the Resource editor in the Appointment popup window. */ - displayExpr?: any; - /** Specifies the resource object field that is used as a value of the Resource editor in the Appointment popup window. */ - valueExpr?: any; - /** The name of the appointment object field that specifies a resource of this kind. */ - field?: string; - /** Specifies the label of the Appointment popup window field that allows end users to assign a resource of this kind. */ - label?: string; - }>; - /** A handler for the AppointmentAdding event. */ - onAppointmentAdding?: Function; - /** A handler for the appointmentAdded event. */ - onAppointmentAdded?: Function; - /** A handler for the AppointmentUpdating event. */ - onAppointmentUpdating?: Function; - /** A handler for the appointmentUpdated event. */ - onAppointmentUpdated?: Function; - /** A handler for the AppointmentDeleting event. */ - onAppointmentDeleting?: Function; - /** A handler for the appointmentDeleted event. */ - onAppointmentDeleted?: Function; - /** A handler for the appointmentRendered event. */ - onAppointmentRendered?: Function; - /** A handler for the appointmentClick event. */ - onAppointmentClick?: any; - /** A handler for the appointmentDblClick event. */ - onAppointmentDblClick?: any; - /** A handler for the cellClick event. */ - onCellClick?: any; - /** A handler for the appointmentFormCreated event. */ - onAppointmentFormCreated?: Function; - /** Specifies whether or not an end-user can scroll the view horizontally. */ - horizontalScrollingEnabled?: boolean; - /** Specifies whether a user can switch views using tabs or a drop-down menu. */ - useDropDownViewSwitcher?: boolean; - } - /** A widget that displays scheduled data using different views and provides the capability to load, add and edit appointments. */ - export class dxScheduler extends Widget { - constructor(element: JQuery, options?: dxSchedulerOptions); - constructor(element: Element, options?: dxSchedulerOptions); - /** Add the appointment defined by the object passed as a parameter to the data associated with the widget. */ - addAppointment(appointment: Object): void; - /** Updates the appointment specified by the first method parameter by the appointment object specified by the second method parameter in the the data associated with the widget. */ - updateAppointment(target: Object, appointment: Object): void; - /** Deletes the appointment defined by the parameter from the the data associated with the widget. */ - deleteAppointment(appointment: Object): void; - /** Scrolls the scheduler work space to the specified time. */ - scrollToTime(hours: number, minutes: number): void; - /** Displays the Appointment Details popup. */ - showAppointmentPopup(appointmentData: Object, createNewAppointment?: boolean): void; - } - export interface dxColorBoxOptions extends dxDropDownEditorOptions { - /** Specifies the text displayed on the button that applies changes and closes the drop-down editor. */ - applyButtonText?: string; - applyValueMode?: string; - /** Specifies the text displayed on the button that cancels changes and closes the drop-down editor. */ - cancelButtonText?: string; - /** Specifies whether or not the widget value includes the alpha channel component. */ - editAlphaChannel?: boolean; - /** Specifies the size of a step by which a handle is moved using a keyboard shortcut. */ - keyStep?: number; - } - /** A widget used to specify a color value. */ - export class dxColorBox extends dxDropDownEditor { - constructor(element: JQuery, options?: dxColorBoxOptions); - constructor(element: Element, options?: dxColorBoxOptions); - } - export interface HierarchicalCollectionWidgetOptions extends CollectionWidgetOptions { - /** Specifies the name of the data source item field whose value is displayed by the widget. */ - displayExpr?: any; - /** Specifies the name of the data source item field used as a key. */ - keyExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding widget items is selected. */ - selectedExpr?: any; - /** Specifies the name of the data source item field that contains an array of nested items. */ - itemsExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding widget item is disabled. */ - disabledExpr?: any; - /** Specifies the name of the data source item field that holds the key of the parent item. */ - parentIdExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding widget items is expanded. */ - expandedExpr?: any; - hoverStateEnabled?: boolean; - focusStateEnabled?: boolean; - } - export class HierarchicalCollectionWidget extends CollectionWidget { - } - export interface dxTreeViewOptions extends HierarchicalCollectionWidgetOptions { - /** Specifies whether or not to animate item collapsing and expanding. */ - animationEnabled?: boolean; - /** Specifies whether a nested or plain array is used as a data source. */ - dataStructure?: string; - /** Specifies whether or not a user can expand all tree view items by the "*" hot key. */ - expandAllEnabled?: boolean; - /** Specifies whether or not a check box is displayed at each tree view item. */ - showCheckBoxes?: boolean; - /** Specifies the current check boxes display mode. */ - showCheckBoxesMode?: string; - /** Specifies whether or not to select nodes recursively. */ - selectNodesRecursive?: boolean; - /** Specifies whether or not all parent nodes of an initially expanded node are displayed expanded. */ - expandNodesRecursive?: boolean; - /** Specifies whether the "Select All" check box is displayed over the tree view. */ - selectAllEnabled?: boolean; - /** Specifies the text displayed at the "Select All" check box. */ - selectAllText?: string; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding node includes child nodes. */ - hasItemsExpr?: any; - /** Specifies if the virtual mode is enabled. */ - virtualModeEnabled?: boolean; - /** Specifies the parent ID value of the root item. */ - rootValue?: any; - /** Specifies the current value used to filter tree view items. */ - searchValue?: string; - /** A string value specifying available scrolling directions. */ - scrollDirection?: string; - /** A handler for the itemSelected event. */ - onItemSelected?: Function; - /** A handler for the itemExpanded event. */ - onItemExpanded?: Function; - /** A handler for the itemCollapsed event. */ - onItemCollapsed?: Function; - onItemClick?: Function; - onItemContextMenu?: Function; - onItemRendered?: Function; - onItemHold?: Function; - } - /** A widget displaying specified data items as a tree. */ - export class dxTreeView extends HierarchicalCollectionWidget { - constructor(element: JQuery, options?: dxTreeViewOptions); - constructor(element: Element, options?: dxTreeViewOptions); - /** Updates the tree view scrollbars according to the current size of the widget content. */ - updateDimensions(): JQueryPromise; - /** Selects the specified item. */ - selectItem(itemElement: any): void; - /** Unselects the specified item. */ - unselectItem(itemElement: any): void; - /** Expands the specified item. */ - expandItem(itemElement: any): void; - /** Collapses the specified item. */ - collapseItem(itemElement: any): void; - /** Returns all nodes of the tree view. */ - getNodes(): Array; - /** Selects all widget items. */ - selectAll(): void; - /** Unselects all widget items. */ - unselectAll(): void; - } - export interface dxMenuBaseOptions extends HierarchicalCollectionWidgetOptions { - /** An object that defines the animation options of the widget. */ - animation?: fx.AnimationOptions; - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** Specifies the name of the CSS class associated with the menu. */ - cssClass?: string; - /** Holds an array of menu items. */ - items?: Array; - /** Specifies whether or not an item becomes selected if an end-user clicks it. */ - selectionByClick?: boolean; - /** Specifies the selection mode supported by the menu. */ - selectionMode?: string; - /** Specifies options of submenu showing and hiding. */ - showSubmenuMode?: { - /** Specifies the mode name. */ - name?: string; - /** Specifies the delay of submenu show and hiding. */ - delay?: { - /** The time span after which the submenu is shown. */ - show?: number; - /** The time span after which the submenu is hidden. */ - hide?: number; - }; - }; - } - export class dxMenuBase extends HierarchicalCollectionWidget { - constructor(element: JQuery, options?: dxMenuBaseOptions); - constructor(element: Element, options?: dxMenuBaseOptions); - /** Selects the specified item. */ - selectItem(itemElement: any): void; - /** Unselects the specified item. */ - unselectItem(itemElement: any): void; - } - export interface dxMenuOptions extends dxMenuBaseOptions { - /** Specifies whether or not the submenu is hidden when the mouse pointer leaves it. */ - hideSubmenuOnMouseLeave?: boolean; - /** Specifies whether the menu has horizontal or vertical orientation. */ - orientation?: string; - /** Specifies options for showing and hiding the first level submenu. */ - showFirstSubmenuMode?: { - /** Specifies the mode name. */ - name?: string; - /** Specifies the delay of submenu showing and hiding. */ - delay?: { - /** The time span after which the submenu is shown. */ - show?: number; - /** The time span after which the submenu is hidden. */ - hide?: number; - }; - }; - /** Specifies the direction at which the submenus are displayed. */ - submenuDirection?: string; - /** A handler for the submenuHidden event. */ - onSubmenuHidden?: Function; - /** A handler for the submenuHiding event. */ - onSubmenuHiding?: Function; - /** A handler for the submenuShowing event. */ - onSubmenuShowing?: Function; - /** A handler for the submenuShown event. */ - onSubmenuShown?: Function; - } - /** A menu widget. */ - export class dxMenu extends dxMenuBase { - constructor(element: JQuery, options?: dxMenuOptions); - constructor(element: Element, options?: dxMenuOptions); - } - export interface dxContextMenuOptions extends dxMenuBaseOptions { - /** Holds an object that specifies options of alternative menu invocation. */ - alternativeInvocationMode?: { - /** Specifies whether or not the standard context menu invocation (on a right mouse click or on a long tap) is disabled. */ - enabled?: Boolean; - /** Specifies the element used to invoke the context menu. */ - invokingElement?: any; - }; - /** A handler for the hidden event. */ - onHidden?: Function; - /** A handler for the hiding event. */ - onHiding?: Function; - /** A handler for the positioning event. */ - onPositioning?: Function; - /** A handler for the showing event. */ - onShowing?: Function; - /** A handler for the shown event. */ - onShown?: Function; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** Specifies the direction at which submenus are displayed. */ - submenuDirection?: string; - /** The target element associated with a popover. */ - target?: any; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - } - /** A context menu widget. */ - export class dxContextMenu extends dxMenuBase { - constructor(element: JQuery, options?: dxContextMenuOptions); - constructor(element: Element, options?: dxContextMenuOptions); - /** Toggles the visibility of the widget. */ - toggle(showing: boolean): JQueryPromise; - /** Shows the widget. */ - show(): JQueryPromise; - /** Hides the widget. */ - hide(): JQueryPromise; - } - export interface dxRemoteOperations { - /** Specifies whether or not filtering must be performed on the server side. */ - filtering?: boolean; - /** Specifies whether or not paging must be performed on the server side. */ - paging?: boolean; - /** Specifies whether or not sorting must be performed on the server side. */ - sorting?: boolean; - /** Specifies whether or not grouping must be performed on the server side. */ - grouping?: boolean; - /** Specifies whether or not summaries calculation must be performed on the server side. */ - summary?: boolean; - } - export interface dxDataGridColumn { - /** Specifies the content alignment within column cells. */ - alignment?: string; - /** Specifies whether the values in a column can be edited at runtime. Setting this option makes sense only when editing is enabled for a grid. */ - allowEditing?: boolean; - /** Specifies whether or not a column can be used for filtering grid records. Setting this option makes sense only when the filter row and column header filtering are visible. */ - allowFiltering?: boolean; - /** Specifies whether or not to allow filtering by this column using its header. */ - allowHeaderFiltering?: boolean; - /** Specifies whether or not the column can be anchored to a grid edge by end users. Setting this option makes sense only when the columnFixing | enabled option is set to true. */ - allowFixing?: boolean; - /** Specifies if a column can be used for searching grid records. Setting this option makes sense only when the search panel is visible. */ - allowSearch?: boolean; - /** Specifies whether a column can be used for grouping grid records at runtime. Setting this option makes sense only when the group panel is visible. */ - allowGrouping?: boolean; - /** Specifies whether or not a column can be hidden by a user. Setting this option makes sense only when the column chooser is visible. */ - allowHiding?: boolean; - /** Specifies whether or not a particular column can be used in column reordering. Setting this option makes sense only when the allowColumnReordering option is set to true. */ - allowReordering?: boolean; - /** Specifies whether or not a particular column can be resized by a user. Setting this option makes sense only when the allowColumnResizing option is true. */ - allowResizing?: boolean; - /** Specifies whether grid records can be sorted by a specific column at runtime. Setting this option makes sense only when the sorting mode differs from none. */ - allowSorting?: boolean; - /** Specifies whether groups appear expanded or not when records are grouped by a specific column. Setting this option makes sense only when grouping is allowed for this column. */ - autoExpandGroup?: boolean; - /** Specifies a callback function that returns a value to be displayed in a column cell. */ - calculateCellValue?: (rowData: Object) => string; - /** Specifies a callback function to be invoked after the cell value is edited by an end-user and before the new value is saved to the data source. */ - setCellValue?: (rowData: Object, value: any) => void; - /** Specifies a callback function that defines filters for customary calculated grid cells. */ - calculateFilterExpression?: (filterValue: any, selectedFilterOperation: string, target: string) => Array; - /** Specifies a caption for a column. */ - caption?: string; - /** Specifies a custom template for grid column cells. */ - cellTemplate?: any; - /** Specifies a CSS class to be applied to a column. */ - cssClass?: string; - /** Specifies how to get a value to be displayed in a cell when it is not in an editing state. */ - calculateDisplayValue?: any; - /** Specifies a field name or a function that returns a field name or a value to be used for grouping column cells. */ - calculateGroupValue?: any; - /** Specifies a field name or a function that returns a field name or a value to be used for sorting column cells. */ - calculateSortValue?: any; - /** Specifies a callback function that returns the text to be displayed in the cells of a column. */ - customizeText?: (cellInfo: { value: any; valueText: string }) => string; - /** Specifies the field of a data source that provides data for a column. */ - dataField?: string; - /** Specifies the required type of column values. */ - dataType?: string; - /** Specifies a custom template for the cell of a grid column when it is in an editing state. */ - editCellTemplate?: any; - /** Specifies configuration options for the editor widget of the current column. */ - editorOptions?: Object; - /** Specifies whether HTML tags are displayed as plain text or applied to the values of the column. */ - encodeHtml?: boolean; - /** In a boolean column, replaces all false items with a specified text. */ - falseText?: string; - /** Specifies the set of available filter operations. */ - filterOperations?: Array; - /** Specifies a filter value for a column. */ - filterValue?: any; - /** Specifies initial filter values for the column's header filter. */ - filterValues?: Array; - /** Specifies whether to include or exclude the records with the values selected in the column's header filter. */ - filterType?: string; - /** Indicates whether the column takes part in horizontal grid scrolling or is anchored to a grid edge. */ - fixed?: boolean; - /** Specifies the grid edge to which the column is anchored. */ - fixedPosition?: string; - /** Specifies a format for the values displayed in a column. */ - format?: string; - /** Specifies a custom template for the group cell of a grid column. */ - groupCellTemplate?: any; - /** Specifies the index of a column when grid records are grouped by the values of this column. */ - groupIndex?: number; - /** Specifies a custom template for the header of a grid column. */ - headerCellTemplate?: any; - /** Specifies options of a lookup column. */ - lookup?: { - /** Specifies whether or not a user can nullify values of a lookup column. */ - allowClearing?: boolean; - /** Specifies the data source providing data for a lookup column. */ - dataSource?: any; - /** Specifies the expression defining the data source field whose values must be displayed. */ - displayExpr?: any; - /** Specifies the expression defining the data source field whose values must be replaced. */ - valueExpr?: string; - }; - /** Specifies column-level options for filtering using a column header filter. */ - headerFilter?: { - /** Specifies the data source to be used for header filter. */ - dataSource?: any; - /** Specifies how header filter values should be combined into groups. */ - groupInterval?: any; - }; - /** Specifies a precision for formatted values displayed in a column. */ - precision?: number; - /** Specifies a filter operation applied to a column. */ - selectedFilterOperation?: string; - /** Specifies whether or not the column displays its values by using editors. */ - showEditorAlways?: boolean; - /** Specifies whether or not to display the column when grid records are grouped by it. */ - showWhenGrouped?: boolean; - /** Specifies the index of a column when grid records are sorted by the values of this column. */ - sortIndex?: number; - /** Specifies the initial sort order of column values. */ - sortOrder?: string; - /** In a boolean column, replaces all true items with a specified text. */ - trueText?: string; - /** Specifies whether a column is visible or not. */ - visible?: boolean; - /** Specifies the sequence number of the column in the grid. */ - visibleIndex?: number; - /** Specifies a column width in pixels or percentages. */ - width?: any; - /** Specifies an array of validation rules to be checked when updating column cell values. */ - validationRules?: Array; - /** Specifies whether or not to display the header of a hidden column in the column chooser. */ - showInColumnChooser?: boolean; - /** Specifies the identifier of the column. */ - name?: string; - /** The form item configuration object. Used only when the editing mode is "form". */ - formItem?: DevExpress.ui.dxFormItem; - } - export interface dxDataGridOptions extends WidgetOptions { - /** Specifies whether the outer borders of the grid are visible or not. */ - showBorders?: boolean; - /** Indicates whether to show the error row for the grid. */ - errorRowEnabled?: boolean; - /** A handler for the rowValidating event. */ - onRowValidating?: (e: Object) => void; - /** A handler for the contextMenuPreparing event. */ - onContextMenuPreparing?: (e: Object) => void; - /** A handler for the initNewRow event. */ - onInitNewRow?: (e: { data: Object }) => void; - /** A handler for the rowInserted event. */ - onRowInserted?: (e: { data: Object; key: any }) => void; - /** A handler for the rowInserting event. */ - onRowInserting?: (e: { data: Object; cancel: any }) => void; - /** A handler for the rowRemoved event. */ - onRowRemoved?: (e: { data: Object; key: any }) => void; - /** A handler for the rowRemoving event. */ - onRowRemoving?: (e: { data: Object; key: any; cancel: any }) => void; - /** A handler for the rowUpdated event. */ - onRowUpdated?: (e: { data: Object; key: any }) => void; - /** A handler for the rowUpdating event. */ - onRowUpdating?: (e: { oldData: Object; newData: Object; key: any; cancel: any }) => void; - /** Enables a hint that appears when a user hovers the mouse pointer over a cell with truncated content. */ - cellHintEnabled?: boolean; - /** Specifies whether or not grid columns can be reordered by a user. */ - allowColumnReordering?: boolean; - /** Specifies whether or not grid columns can be resized by a user. */ - allowColumnResizing?: boolean; - /** A handler for the cellClick event. */ - onCellClick?: any; - /** A handler for the cellHoverChanged event. */ - onCellHoverChanged?: (e: Object) => void; - /** A handler for the cellPrepared event. */ - onCellPrepared?: (e: Object) => void; - /** Specifies whether or not the width of grid columns depends on column content. */ - columnAutoWidth?: boolean; - /** Specifies the options of a column chooser. */ - columnChooser?: { - /** Specifies text displayed by the column chooser panel when it does not contain any columns. */ - emptyPanelText?: string; - /** Specifies whether a user can invoke the column chooser or not. */ - enabled?: boolean; - /** Specifies the height of the column chooser panel. */ - height?: number; - /** Specifies text displayed in the title of the column chooser panel. */ - title?: string; - /** Specifies the width of the column chooser panel. */ - width?: number; - }; - /** Specifies options for column fixing. */ - columnFixing?: { - /** Indicates if column fixing is enabled. */ - enabled?: boolean; - /** Contains options that specify texts for column-fixing related commands in the column header's context menu. */ - texts?: { - /** Specifies text for a context menu item that fixes the column for which the context menu is invoked. */ - fix?: string; - /** Specifies text for a context menu item that unfixes the column for which the context menu is invoked. */ - unfix?: string; - /** Specifies text for a context menu subitem that fixes a column, for which the context menu is invoked, to the left grid edge. */ - leftPosition?: string; - /** Specifies text for a context menu subitem that fixes a column, for which the context menu is invoked, to the right grid edge. */ - rightPosition?: string; - }; - }; - /** Specifies options for filtering using a column header filter. */ - headerFilter?: { - /** Indicates whether or not the column header filter button is visible. */ - visible?: boolean; - /** Specifies the height of the dropdown menu invoked when using a column header filter. */ - height?: number; - /** Specifies the width of the dropdown menu invoked when using a column header filter. */ - width?: number; - /** Contains options that specify texts for the dropdown menu invoked when you use a column header filter. */ - texts?: { - /** Specifies text for the item specifying an empty value in the column header filter's dropdown menu. */ - emptyValue?: string; - /** Specifies text for a button that closes the column header filter's dropdown menu and applies specified filtering. */ - ok?: string; - /** Specifies text for a button that closes the column header filter's dropdown menu without applying performed selection. */ - cancel?: string; - } - }; - /** An array of grid columns. */ - columns?: Array; - onContentReady?: Function; - /** Specifies a function that customizes grid columns after they are created. */ - customizeColumns?: (columns: Array) => void; - /** Specifies a data source for the grid. */ - dataSource?: any; - /** Specifies whether or not to enable data caching. */ - cacheEnabled?: boolean; - /** A handler for the editingStart event. */ - onEditingStart?: (e: { - data: Object; - key: any; - cancel: boolean; - column: dxDataGridColumn - }) => void; - /** A handler for the editorPrepared event. */ - onEditorPrepared?: (e: Object) => void; - /** A handler for the editorPreparing event. */ - onEditorPreparing?: (e: Object) => void; - /** Contains options that specify how grid content can be changed. */ - editing?: { - editMode?: string; - editEnabled?: boolean; - insertEnabled?: boolean; - removeEnabled?: boolean; - /** Specifies how grid values can be edited manually. */ - mode?: string; - /** Specifies whether or not grid records can be edited at runtime. */ - allowUpdating?: boolean; - /** Specifies whether or not new grid records can be added at runtime. */ - allowAdding?: boolean; - /** Specifies whether or not grid records can be deleted at runtime. */ - allowDeleting?: boolean; - /** The form configuration object. Used only when the editing mode is "form". */ - form?: DevExpress.ui.dxFormOptions; - /** Contains options that specify texts for editing-related grid controls. */ - texts?: { - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Save" button. Setting this option makes sense only when the editMode option is set to batch. */ - saveAllChanges?: string; - /** Specifies text for a cancel button displayed when a row is in the editing state. Setting this option makes sense only when the allowUpdating option is set to true. */ - cancelRowChanges?: string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Revert" button. Setting this option makes sense only when the editMode option is set to batch. */ - cancelAllChanges?: string; - /** Specifies a message to be displayed by a confirmation window. Setting this option makes sense only when the edit mode is "row". */ - confirmDeleteMessage?: string; - /** Specifies text to be displayed in the title of a confirmation window. Setting this option makes sense only when the edit mode is "row". */ - confirmDeleteTitle?: string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Cancel changes" button. Setting this option makes sense only when the editMode option is set to cell and the validation capabilities are enabled. */ - validationCancelChanges?: string; - /** Specifies text for a button that deletes a row from a grid. Setting this option makes sense only when the allowDeleting option is set to true. */ - deleteRow?: string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Add" button. Setting this option makes sense only when the allowAdding option is true. */ - addRow?: string; - /** Specifies text for a button that turns a row into the editing state. Setting this option makes sense only when the allowUpdating option is set to true. */ - editRow?: string; - /** Specifies text for a save button displayed when a row is in the editing state. Setting this option makes sense only when the allowUpdating option is set to true. */ - saveRowChanges?: string; - /** Specifies text for a button that recovers a deleted row. Setting this option makes sense only if the grid uses the batch edit mode and the allowDeleting option is set to true. */ - undeleteRow?: string; - }; - }; - /** Specifies filter row options. */ - filterRow?: { - /** Specifies when to apply a filter. */ - applyFilter?: string; - /** Specifies text for the hint that pops up when a user hovers the mouse pointer over the "Apply Filter" button. */ - applyFilterText?: string; - /** Specifies descriptions for filter operations. */ - operationDescriptions?: { - "=": string; - "<>": string; - "<": string; - "<=": string; - ">": string; - ">=": string; - "startswith": string; - "contains": string; - "notcontains": string; - "endswith": string; - }; - /** Specifies text for the reset operation in a filter list. */ - resetOperationText?: string; - /** Specifies text for the operation of clearing the applied filter when a select box is used. */ - showAllText?: string; - /** Specifies text for the range start in the 'between' filter type. */ - betweenStartText?: string; - /** Specifies text for the range end in the 'between' filter type. */ - betweenEndText?: string; - /** Specifies whether or not an icon that allows the user to choose a filter operation is visible. */ - showOperationChooser?: boolean; - /** Specifies whether the filter row is visible or not. */ - visible?: boolean; - }; - /** Specifies the behavior of grouped grid records. */ - grouping?: { - /** Specifies whether the user can collapse grouped records in a grid or not. */ - allowCollapsing?: boolean; - /** Specifies whether groups appear expanded or not. */ - autoExpandAll?: boolean; - /** Specifies the message displayed in a group row when the corresponding group is continued from the previous page. */ - groupContinuedMessage?: string; - /** Specifies the message displayed in a group row when the corresponding group continues on the next page. */ - groupContinuesMessage?: string; - }; - /** Specifies options that configure the group panel. */ - groupPanel?: { - /** Specifies whether columns can be dragged onto or from the group panel. */ - allowColumnDragging?: boolean; - /** Specifies text displayed by the group panel when it does not contain any columns. */ - emptyPanelText?: string; - /** Specifies whether the group panel is visible or not. */ - visible?: boolean; - }; - /** Specifies options configuring the load panel. */ - loadPanel?: { - /** Specifies whether to show the load panel or not. */ - enabled?: boolean; - /** Specifies the height of the load panel in pixels. */ - height?: number; - /** Specifies a URL pointing to an image to be used as a loading indicator. */ - indicatorSrc?: string; - /** Specifies whether or not a loading indicator must be displayed on the load panel. */ - showIndicator?: boolean; - /** Specifies whether or not the pane of the load panel must be displayed. */ - showPane?: boolean; - /** Specifies text displayed by the load panel. */ - text?: string; - /** Specifies the width of the load panel in pixels. */ - width?: number; - }; - /** Specifies text displayed when a grid does not contain any records. */ - noDataText?: string; - /** Specifies the options of a grid pager. */ - pager?: { - /** Specifies the page sizes that can be selected at runtime. */ - allowedPageSizes?: any; - /** Specifies whether to show the page size selector or not. */ - showPageSizeSelector?: boolean; - /** Specifies whether to show the pager or not. */ - visible?: any; - /** Specifies the text accompanying the page navigator. */ - infoText?: string; - /** Specifies whether or not to display the text accompanying the page navigator. This text is specified by the infoText option. */ - showInfo?: boolean; - /** Specifies whether or not to display buttons that switch the grid to the previous or next page. */ - showNavigationButtons?: boolean; - }; - /** Specifies paging options. */ - paging?: { - /** Specifies whether dxDataGrid loads data page by page or all at once. */ - enabled?: boolean; - /** Specifies the grid page that should be displayed by default. */ - pageIndex?: number; - /** Specifies the size of grid pages. */ - pageSize?: number; - }; - /** Specifies whether or not grid rows must be shaded in a different way. */ - rowAlternationEnabled?: boolean; - /** A handler for the rowClick event. */ - onRowClick?: any; - /** A handler for the rowPrepared event. */ - onRowPrepared?: (e: Object) => void; - /** Specifies a custom template for grid rows. */ - rowTemplate?: any; - /** A configuration object specifying scrolling options. */ - scrolling?: { - /** Specifies the scrolling mode. */ - mode?: string; - /** Specifies whether or not a grid must preload pages adjacent to the current page when using virtual scrolling. */ - preloadEnabled?: boolean; - /** Specifies whether or not the widget uses native scrolling. */ - useNative?: any; - /** Specifies the scrollbar display policy. */ - showScrollbar?: string; - /** Specifies whether or not the scrolling by content is enabled. */ - scrollByContent?: boolean; - /** Specifies whether or not the scrollbar thumb scrolling enabled. */ - scrollByThumb?: boolean; - }; - /** Specifies options of the search panel. */ - searchPanel?: { - /** Specifies whether or not search strings in the located grid records should be highlighted. */ - highlightSearchText?: boolean; - /** Specifies text displayed by the search panel when no search string was typed. */ - placeholder?: string; - /** Specifies whether the search panel is visible or not. */ - visible?: boolean; - /** Specifies the width of the search panel in pixels. */ - width?: number; - /** Sets a search string for the search panel. */ - text?: string; - }; - /** Specifies the operations that must be performed on the server side. */ - remoteOperations?: any; - /** Allows you to sort groups according to the values of group summary items. */ - sortByGroupSummaryInfo?: Array<{ - /** Specifies the group summary item whose values must be used to sort groups. */ - summaryItem?: string; - /** Specifies the identifier of the column that must be used in grouping so that sorting by group summary item values be applied. */ - groupColumn?: string; - /** Specifies the sort order of group summary item values. */ - sortOrder?: string; - }>; - /** Allows you to build a master-detail interface in the grid. */ - masterDetail?: { - /** Enables an end-user to expand/collapse detail sections. */ - enabled?: boolean; - /** Specifies whether detail sections appear expanded or collapsed. */ - autoExpandAll?: boolean; - /** Specifies the template for detail sections. */ - template?: any; - }; - /** Specifies options for exporting grid data. */ - export?: { - /** Indicates if the export feature is enabled in the grid. */ - enabled?: boolean; - /** Specifies a default name for the file to which grid data is exported. */ - fileName?: string; - /** Specifies whether to enable Excel filtering for the exported data in the resulting XLSX file. */ - excelFilterEnabled?: boolean; - /** Specifies whether to enable word wrapping for the exported data in the resulting XLSX file. */ - excelWrapTextEnabled?: boolean; - /** Specifies the URL of the server-side proxy that streams the resulting file to the end user to enable export in IE8, IE9 and Safari browsers. */ - proxyUrl?: string; - /** Indicates whether to allow end users to export not only the data displayed in the grid, but the selected rows only. */ - allowExportSelectedData?: boolean; - /** Contains options that specify texts for the export-related commands and hints. */ - texts?: { - /** Specifies text for the Export button when this button invokes a dropdown menu so you can choose the required export format. */ - exportTo?: string; - /** Specifies text for the Export button when this button exports to the XSLX format. */ - exportToExcel?: string; - /** Specifies text for the item in the Export dropdown menu that exports grid data to Excel. */ - excelFormat?: string; - /** Specifies text for the option in the Export dropdown menu that allows you to choose whether to export all the grid data or the selected rows only. */ - selectedRows?: string; - } - }; - /** Specifies the keys of the records that must appear selected initially. */ - selectedRowKeys?: Array; - /** Specifies options of runtime selection. */ - selection?: { - /** Specifies the checkbox row display policy in the multiple mode. */ - showCheckBoxesMode?: string; - /** Specifies whether the user can select all grid records at once. */ - allowSelectAll?: boolean; - /** Specifies the selection mode. */ - mode?: string; - }; - /** A handler for the dataErrorOccured event. */ - onDataErrorOccurred?: (e: { error: Error }) => void; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: (e: { - currentSelectedRowKeys: Array; - currentDeselectedRowKeys: Array; - selectedRowKeys: Array; - selectedRowsData: Array; - }) => void; - /** A handler for the exporting event. */ - onExporting?: (e: { - fileName: string; - format: string; - cancel: boolean; - }) => void; - /** A handler for the exported event. */ - onExported?: (e: Object) => void; - /** A handler for the keyDown event. */ - onKeyDown?: (e: Object) => void; - /** A handler for the rowExpanding event. */ - onRowExpanding?: (e: Object) => void; - /** A handler for the rowExpanded event. */ - onRowExpanded?: (e: Object) => void; - /** A handler for the rowCollapsing event. */ - onRowCollapsing?: (e: Object) => void; - /** A handler for the rowCollapsed event. */ - onRowCollapsed?: (e: Object) => void; - /** Specifies whether column headers are visible or not. */ - showColumnHeaders?: boolean; - /** Specifies whether or not vertical lines separating one grid column from another are visible. */ - showColumnLines?: boolean; - /** Specifies whether or not horizontal lines separating one grid row from another are visible. */ - showRowLines?: boolean; - /** Specifies options of runtime sorting. */ - sorting?: { - /** Specifies text for the context menu item that sets an ascending sort order in a column. */ - ascendingText?: string; - /** Specifies text for the context menu item that resets sorting settings for a column. */ - clearText?: string; - /** Specifies text for the context menu item that sets a descending sort order in a column. */ - descendingText?: string; - /** Specifies the runtime sorting mode. */ - mode?: string; - }; - /** Specifies options of state storing. */ - stateStoring?: { - /** Specifies a callback function that performs specific actions on state loading. */ - customLoad?: () => JQueryPromise; - /** Specifies a callback function that performs specific actions on state saving. */ - customSave?: (state: Object) => void; - /** Specifies whether or not a grid saves its state. */ - enabled?: boolean; - /** Specifies the delay between the last change of a grid state and the operation of saving this state in milliseconds. */ - savingTimeout?: number; - /** Specifies a unique key to be used for storing the grid state. */ - storageKey?: string; - /** Specifies the type of storage to be used for state storing. */ - type?: string; - }; - /** Specifies the options of the grid summary. */ - summary?: { - /** Contains options that specify text patterns for summary items. */ - texts?: { - /** Specifies a pattern for the 'sum' summary items when they are displayed in the parent column. */ - sum?: string; - /** Specifies a pattern for the 'sum' summary items displayed in a group row or in any other column rather than the parent one. */ - sumOtherColumn?: string; - /** Specifies a pattern for the 'min' summary items when they are displayed in the parent column. */ - min?: string; - /** Specifies a pattern for the 'min' summary items displayed in a group row or in any other column rather than the parent one. */ - minOtherColumn?: string; - /** Specifies a pattern for the 'max' summary items when they are displayed in the parent column. */ - max?: string; - /** Specifies a pattern for the 'max' summary items displayed in a group row or in any other column rather than the parent one. */ - maxOtherColumn?: string; - /** Specifies a pattern for the 'avg' summary items when they are displayed in the parent column. */ - avg?: string; - /** Specifies a pattern for the 'avg' summary items displayed in a group row or in any other column rather than the parent one. */ - avgOtherColumn?: string; - /** Specifies a pattern for the 'count' summary items. */ - count?: string; - }; - /** Specifies items of the group summary. */ - groupItems?: Array<{ - /** Specifies the identifier of a summary item. */ - name?: string; - /** Specifies the column that provides data for a group summary item. */ - column?: string; - /** Customizes the text to be displayed in the summary item. */ - customizeText?: (itemInfo: { - value: any; - valueText: string; - }) => string; - /** Specifies a pattern for the summary item text. */ - displayFormat?: string; - /** Specifies a precision for the summary item value of a numeric format. */ - precision?: number; - /** Specifies whether or not a summary item must be displayed in the group footer. */ - showInGroupFooter?: boolean; - /** Indicates whether to display group summary items in parentheses after the group row header or to align them by the corresponding columns within the group row. */ - alignByColumn?: boolean; - /** Specifies the column that must hold the summary item when this item is displayed in the group footer or aligned by a column in the group row. */ - showInColumn?: string; - /** Specifies how to aggregate data for a summary item. */ - summaryType?: string; - /** Specifies a format for the summary item value. */ - valueFormat?: string; - }>; - /** Specifies items of the total summary. */ - totalItems?: Array<{ - /** Specifies the identifier of a summary item. */ - name?: string; - /** Specifies the alignment of a summary item. */ - alignment?: string; - /** Specifies the column that provides data for a summary item. */ - column?: string; - /** Specifies a CSS class to be applied to a summary item. */ - cssClass?: string; - /** Customizes the text to be displayed in the summary item. */ - customizeText?: (itemInfo: { - value: any; - valueText: string; - }) => string; - /** Specifies a pattern for the summary item text. */ - displayFormat?: string; - /** Specifies a precision for the summary item value of a numeric format. */ - precision?: number; - /** Specifies the column that must hold the summary item. */ - showInColumn?: string; - /** Specifies how to aggregate data for a summary item. */ - summaryType?: string; - /** Specifies a format for the summary item value. */ - valueFormat?: string; - }>; - /** Allows you to use a custom aggregate function to calculate the value of a summary item. */ - calculateCustomSummary?: (options: { - component: dxDataGrid; - name?: string; - value: any; - totalValue: any; - summaryProcess: string - }) => void; - }; - /** Specifies whether text that does not fit into a column should be wrapped. */ - wordWrapEnabled?: boolean; - } - /** A data grid widget. */ - export class dxDataGrid extends Widget { - constructor(element: JQuery, options?: dxDataGridOptions); - constructor(element: Element, options?: dxDataGridOptions); - /** Ungroups grid records. */ - clearGrouping(): void; - /** Clears sorting settings of all grid columns at once. */ - clearSorting(): void; - /** Allows you to obtain a cell by its row index and the data field of its column. */ - getCellElement(rowIndex: number, dataField: string): any; - /** Allows you to obtain a cell by its row index and the visible index of its column. */ - getCellElement(rowIndex: number, visibleColumnIndex: number): any; - /** Returns the current state of the grid. */ - state(): Object; - /** Sets the grid state. */ - state(state: Object): void; - /** Allows you to obtain the row index by a data key. */ - getRowIndexByKey(key: any): number; - /** Allows you to obtain the data key by a row index. */ - getKeyByRowIndex(rowIndex: number): any; - /** Adds a new column to a grid. */ - addColumn(columnOptions: dxDataGridColumn): void; - /** Removes the column from the grid. */ - deleteColumn(id: any): void; - /** Displays the load panel. */ - beginCustomLoading(messageText: string): void; - /** Discards changes made in a grid. */ - cancelEditData(): void; - /** Checks whether or not the grid contains unsaved changes. */ - hasEditData(): boolean; - /** Clears all the filters of a specific type applied to grid records. */ - clearFilter(): void; - /** Deselects all grid records. */ - clearSelection(): void; - /** Draws the cell being edited from the editing state. Use this method when the edit mode is batch. */ - closeEditCell(): void; - /** Collapses groups or master rows in a grid. */ - collapseAll(groupIndex?: number): void; - /** Returns the number of data columns in a grid. */ - columnCount(): number; - /** Returns the value of a specific column option. */ - columnOption(id: any, optionName: string): any; - /** Sets an option of a specific column. */ - columnOption(id: any, optionName: string, optionValue: any): void; - /** Returns the options of a column by an identifier. */ - columnOption(id: any): Object; - /** Sets several options of a column at once. */ - columnOption(id: any, options: Object): void; - /** Sets a specific cell into the editing state. */ - editCell(rowIndex: number, visibleColumnIndex: number): void; - /** Sets a specific cell into the editing state. */ - editCell(rowIndex: number, dataField: string): void; - /** Sets a specific row into the editing state. */ - editRow(rowIndex: number): void; - /** Gets the cell value. */ - cellValue(rowIndex: number, dataField: string): any; - /** Gets the cell value. */ - cellValue(rowIndex: number, visibleColumnIndex: number): any; - /** Sets the cell value. */ - cellValue(rowIndex: number, dataField: string, value: any): void; - /** Sets the cell value. */ - cellValue(rowIndex: number, visibleColumnIndex: number, value: any): void; - /** Hides the load panel. */ - endCustomLoading(): void; - /** Expands groups or master rows in a grid. */ - expandAll(groupIndex: number): void; - /** Allows you to find out whether a specific group or master row is expanded or collapsed. */ - isRowExpanded(key: any): boolean; - /** Allows you to expand a specific group or master row by its key. */ - expandRow(key: any): void; - /** Allows you to collapse a specific group or master row by its key. */ - collapseRow(key: any): void; - /** Applies a filter to the grid's data source. */ - filter(filterExpr?: any): void; - /** Returns a filter expression applied to the grid's data source using the filter(filterExpr) method. */ - filter(): any; - /** Returns a filter expression applied to the grid using all possible scenarious. */ - getCombinedFilter(): any; - /** Gets the keys of currently selected grid records. */ - getSelectedRowKeys(): Array; - /** Gets the data objects of currently selected grid records. */ - getSelectedRowsData(): Array; - /** Hides the column chooser panel. */ - hideColumnChooser(): void; - /** Adds a new data row to a grid. */ - addRow(): void; - /** - * Adds a new data row to a grid. - * @deprecated Use the addRow() method instead. - */ - insertRow(): void; - /** Returns the key corresponding to the passed data object. */ - keyOf(obj: Object): any; - /** Switches a grid to a specified page. */ - pageIndex(newIndex: number): void; - /** Gets the index of the current page. */ - pageIndex(): number; - /** Sets the page size. */ - pageSize(value: number): void; - /** Gets the current page size. */ - pageSize(): number; - /** Refreshes grid data. */ - refresh(): void; - /** Removes a specific row from a grid. */ - deleteRow(rowIndex: number): void; - /** - * Removes a specific row from a grid. - * @deprecated Use the deleteRow() method instead. - */ - removeRow(rowIndex: number): void; - /** Saves changes made in a grid. */ - saveEditData(): void; - /** Searches grid records by a search string. */ - searchByText(text: string): void; - /** Selects all grid records. */ - selectAll(): void; - /** Deselects the rows that are currently selected within the applied filter. */ - deselectAll(): void; - /** Selects specific grid records. */ - selectRows(keys: Array, preserve: boolean): void; - /** Deselects specific grid records. */ - deselectRows(keys: Array): void; - /** Selects grid rows by indexes. */ - selectRowsByIndexes(indexes: Array): void; - /** Allows you to find out whether a row is selected or not. */ - isRowSelected(key: any): boolean; - /** Invokes the column chooser panel. */ - showColumnChooser(): void; - startSelectionWithCheckboxes(): boolean; - /** Returns the number of records currently held by a grid. */ - totalCount(): number; - /** Recovers a row deleted in the batch edit mode. */ - undeleteRow(rowIndex: number): void; - /** Allows you to obtain a data object by its key. */ - byKey(key: any): JQueryPromise; - /** Gets the value of a total summary item. */ - getTotalSummaryValue(summaryItemName: string): any; - /** Exports grid data to Excel. */ - exportToExcel(selectionOnly: boolean): void; - /** Updates the grid to the size of its content. */ - updateDimensions(): void; - /** Focuses the specified cell element in the grid. */ - focus(element?: JQuery): void; - } - export interface dxPivotGridOptions extends WidgetOptions { - onContentReady?: Function; - /** Specifies a data source for the pivot grid. */ - dataSource?: any; - useNativeScrolling?: any; - /** A configuration object specifying scrolling options. */ - scrolling?: { - /** Specifies the scrolling mode. */ - mode?: string; - /** Specifies whether or not the widget uses native scrolling. */ - useNative?: any; - }; - /** Allows an end-user to change sorting options. */ - allowSorting?: boolean; - /** Allows an end-user to sort columns by summary values. */ - allowSortingBySummary?: boolean; - /** Allows an end-user to change filtering options. */ - allowFiltering?: boolean; - /** Allows an end-user to expand/collapse all header items within a header level. */ - allowExpandAll?: boolean; - /** Specifies whether to display the Total rows. */ - showRowTotals?: boolean; - /** Specifies whether to display the Grand Total row. */ - showRowGrandTotals?: boolean; - /** Specifies whether to display the Total columns. */ - showColumnTotals?: boolean; - /** Specifies whether to display the Grand Total column. */ - showColumnGrandTotals?: boolean; - /** Specifies whether or not to hide rows and columns with no data. */ - hideEmptySummaryCells?: boolean; - /** Specifies where to show the total rows or columns. */ - showTotalsPrior?: string; - /** Specifies whether the outer borders of the grid are visible or not. */ - showBorders?: boolean; - /** The Field Chooser configuration options. */ - fieldChooser?: { - /** Enables or disables the field chooser. */ - enabled?: boolean; - /** Specifies the field chooser layout. */ - layout?: number; - /** Specifies the text to display as a title of the field chooser popup window. */ - title?: string; - /** Specifies the field chooser width. */ - width?: number; - /** Specifies the field chooser height. */ - height?: number; - /** Strings that can be changed or localized in the pivot grid's integrated Field Chooser. */ - texts?: { - /** The string to display instead of Row Fields. */ - rowFields?: string; - /** The string to display instead of Column Fields. */ - columnFields?: string; - /** The string to display instead of Data Fields. */ - dataFields?: string; - /** The string to display instead of Filter Fields. */ - filterFields?: string; - /** The string to display instead of All Fields. */ - allFields?: string; - }; - } - /** Strings that can be changed or localized in the dxPivotGrid widget. */ - texts?: { - /** The string to display as a header of the Grand Total row and column. */ - grandTotal?: string; - /** The string to display as a header of the Total row and column. */ - total?: string; - /** Specifies the text displayed when a pivot grid does not contain any fields. */ - noData?: string; - /** The string to display as a Show Field Chooser context menu item. */ - showFieldChooser?: string; - /** The string to display as an Expand All context menu item. */ - expandAll?: string; - /** The string to display as a Collapse All context menu item. */ - collapseAll?: string; - /** The string to display as a Sort Column by Summary Value context menu item. */ - sortColumnBySummary?: string; - /** The string to display as a Sort Row by Summary Value context menu item. */ - sortRowBySummary?: string; - /** The string to display as a Remove All Sorting context menu item. */ - removeAllSorting?: string; - /** The string to display as an Export to Excel file context menu item. */ - exportToExcel?: string; - }; - /** The Load panel configuration options. */ - loadPanel?: { - /** Enables or disables the load panel. */ - enabled?: boolean; - /** Specifies the height of the load panel. */ - height?: number; - /** Specifies the URL pointing to an image that will be used as a load indicator. */ - indicatorSrc?: string; - /** Specifies whether or not to show a load indicator. */ - showIndicator?: boolean; - /** Specifies whether or not to show load panel background. */ - showPane?: boolean; - /** Specifies the text to display inside a load panel. */ - text?: string; - /** Specifies the width of the load panel. */ - width?: number; - }; - /** A handler for the cellClick event. */ - onCellClick?: (e: any) => void; - /** A handler for the cellPrepared event. */ - onCellPrepared?: (e: any) => void; - /** A handler for the contextMenuPreparing event. */ - onContextMenuPreparing?: (e: Object) => void; - /** Specifies options for exporting pivot grid data. */ - export?: { - /** Indicates whether the export feature is enabled for the pivot grid. */ - enabled?: boolean; - /** Specifies a default name for the file to which grid data is exported. */ - fileName?: string; - /** Specifies the URL of the server-side proxy that streams the resulting file to the end user to enable export in IE8, IE9 and Safari browsers. */ - proxyUrl?: string; - }; - /** A handler for the exporting event. */ - onExporting?: (e: { - fileName: string; - format: string; - cancel: boolean; - }) => void; - /** A handler for the exported event. */ - onExported?: (e: Object) => void; - /** A configuration object specifying options related to state storing. */ - stateStoring?: { - /** Specifies a callback function that performs specific actions on state loading. */ - customLoad?: () => JQueryPromise; - /** Specifies a callback function that performs specific actions on state saving. */ - customSave?: (gridState: Object) => void; - /** Specifies whether or not a grid saves its state. */ - enabled?: boolean; - /** Specifies the delay between the last change of a grid state and the operation of saving this state in milliseconds. */ - savingTimeout?: number; - /** Specifies a unique key to be used for storing the grid state. */ - storageKey?: string; - /** Specifies the type of storage to be used for state storing. */ - type?: string; - }; - } - /** A data summarization widget for multi-dimensional data analysis and data mining. */ - export class dxPivotGrid extends Widget { - constructor(element: JQuery, options?: dxPivotGridOptions); - constructor(element: Element, options?: dxPivotGridOptions); - /** Gets the PivotGridDataSource instance. */ - getDataSource(): DevExpress.data.PivotGridDataSource; - /** Gets the dxPopup instance of the field chooser window. */ - getFieldChooserPopup(): DevExpress.ui.dxPopup; - /** Updates the widget to the size of its content. */ - updateDimensions(): void; - /** Exports pivot grid data to the Excel file. */ - exportToExcel(): void; - } - export interface dxPivotGridFieldChooserOptions extends WidgetOptions { - /** Specifies the height of the widget. */ - height?: any; - /** Specifies the field chooser layout. */ - layout?: number; - /** The data source of a dxPivotGrid widget. */ - dataSource?: DevExpress.data.PivotGridDataSource; - onContentReady?: Function; - /** Strings that can be changed or localized in the dxPivotGridFieldChooser widget. */ - texts?: { - /** The string to display instead of Row Fields. */ - rowFields?: string; - /** The string to display instead of Column Fields. */ - columnFields?: string; - /** The string to display instead of Data Fields. */ - dataFields?: string; - /** The string to display instead of Filter Fields. */ - filterFields?: string; - /** The string to display instead of All Fields. */ - allFields?: string; - }; - } - /** A complementary widget for dxPivotGrid that allows you to manage data displayed in the dxPivotGrid. */ - export class dxPivotGridFieldChooser extends Widget { - constructor(element: JQuery, options?: dxPivotGridFieldChooserOptions); - constructor(element: Element, options?: dxPivotGridFieldChooserOptions); - /** Updates the widget to the size of its content. */ - updateDimensions(): void; - } -} -interface JQuery { - dxTreeView(): JQuery; - dxTreeView(options: "instance"): DevExpress.ui.dxTreeView; - dxTreeView(options: string): any; - dxTreeView(options: string, ...params: any[]): any; - dxTreeView(options: DevExpress.ui.dxTreeViewOptions): JQuery; - dxMenuBase(): JQuery; - dxMenuBase(options: "instance"): DevExpress.ui.dxMenuBase; - dxMenuBase(options: string): any; - dxMenuBase(options: string, ...params: any[]): any; - dxMenuBase(options: DevExpress.ui.dxMenuBaseOptions): JQuery; - dxMenu(): JQuery; - dxMenu(options: "instance"): DevExpress.ui.dxMenu; - dxMenu(options: string): any; - dxMenu(options: string, ...params: any[]): any; - dxMenu(options: DevExpress.ui.dxMenuOptions): JQuery; - dxContextMenu(): JQuery; - dxContextMenu(options: "instance"): DevExpress.ui.dxContextMenu; - dxContextMenu(options: string): any; - dxContextMenu(options: string, ...params: any[]): any; - dxContextMenu(options: DevExpress.ui.dxContextMenuOptions): JQuery; - dxColorBox(): JQuery; - dxColorBox(options: "instance"): DevExpress.ui.dxColorBox; - dxColorBox(options: string): any; - dxColorBox(options: string, ...params: any[]): any; - dxColorBox(options: DevExpress.ui.dxColorBoxOptions): JQuery; - dxDataGrid(): JQuery; - dxDataGrid(options: "instance"): DevExpress.ui.dxDataGrid; - dxDataGrid(options: string): any; - dxDataGrid(options: string, ...params: any[]): any; - dxDataGrid(options: DevExpress.ui.dxDataGridOptions): JQuery; - dxPivotGrid(): JQuery; - dxPivotGrid(options: "instance"): DevExpress.ui.dxPivotGrid; - dxPivotGrid(options: string): any; - dxPivotGrid(options: string, ...params: any[]): any; - dxPivotGrid(options: DevExpress.ui.dxPivotGridOptions): JQuery; - dxPivotGridFieldChooser(): JQuery; - dxPivotGridFieldChooser(options: "instance"): DevExpress.ui.dxPivotGridFieldChooser; - dxPivotGridFieldChooser(options: string): any; - dxPivotGridFieldChooser(options: string, ...params: any[]): any; - dxPivotGridFieldChooser(options: DevExpress.ui.dxPivotGridFieldChooserOptions): JQuery; - dxScheduler(): JQuery; - dxScheduler(options: "instance"): DevExpress.ui.dxScheduler; - dxScheduler(options: string): any; - dxScheduler(options: string, ...params: any[]): any; - dxScheduler(options: DevExpress.ui.dxSchedulerOptions): JQuery; -} -declare namespace DevExpress.framework { - /** An object used to store information on the views displayed in an application. */ - export class ViewCache { - viewRemoved: JQueryCallback; - /** Removes all the viewInfo objects from the cache. */ - clear(): void; - /** Obtains a viewInfo object from the cache by the specified key. */ - getView(key: string): Object; - /** Checks whether or not a viewInfo object is contained in the view cache under the specified key. */ - hasView(key: string): boolean; - /** Removes a viewInfo object from the cache by the specified key. */ - removeView(key: string): Object; - /** Adds the specified viewInfo object to the cache under the specified key. */ - setView(key: string, viewInfo: Object): void; - } - export interface dxCommandOptions extends DOMComponentOptions { - /** Specifies an action performed when the execute() method of the command is called. */ - onExecute?: any; - /** Indicates whether or not the widget that displays this command is disabled. */ - disabled?: boolean; - /** Specifies whether the current command is rendered when a view is being rendered or after a view is shown. */ - renderStage?: string; - /** Specifies the name of the icon shown inside the widget associated with this command. */ - icon?: string; - iconSrc?: string; - /** The identifier of the command. */ - id?: string; - /** Specifies the title of the widget associated with this command. */ - title?: string; - /** Specifies the type of the button, if the command is rendered as a dxButton widget. */ - type?: string; - /** A Boolean value specifying whether or not the widget associated with this command is visible. */ - visible?: boolean; - } - /** A markup component used to define markup options for a command. */ - export class dxCommand extends DOMComponent { - constructor(element: JQuery, options: dxCommandOptions); - constructor(options: dxCommandOptions); - /** Executes the action associated with this command. */ - execute(): void; - } - /** An object responsible for routing. */ - export class Router { - /** Adds a routing rule to the list of registered rules. */ - register(pattern: string, defaults?: Object, constraints?: Object): void; - /** Decodes the specified URI to an object using the registered routing rules. */ - parse(uri: string): Object; - /** Formats an object to a URI. */ - format(obj: Object): string; - } - export interface StateManagerOptions { - /** A storage to which the state manager saves the application state. */ - storage?: Object; - } - /** An object used to store the current application state. */ - export class StateManager { - constructor(options?: StateManagerOptions); - /** Adds an object that implements an interface of a state source to the state manager's collection of state sources. */ - addStateSource(stateSource: Object): void; - /** Removes a specified state source from the state manager's collection of state sources. */ - removeStateSource(stateSource: Object): void; - /** Saves the current application state. */ - saveState(): void; - /** Restores the application state that has been saved by the saveState() method to the state storage. */ - restoreState(): void; - /** Removes the application state that has been saved by the saveState() method to the state storage. */ - clearState(): void; - } - export module html { - export var layoutSets: Array; - export var animationSets: { [animationSetName: string]: AnimationSet }; - export interface AnimationSet { - [animationName: string]: any - } - export interface HtmlApplicationOptions { - /** Specifies where the commands that are defined in the application's views must be displayed. */ - commandMapping?: Object; - /** Specifies whether or not view caching is disabled. */ - disableViewCache?: boolean; - /** An array of layout controllers that should be used to show application views in the current navigation context. */ - layoutSet?: any; - /** Specifies the animation presets that are used to animate different UI elements in the current application. */ - animationSet?: AnimationSet; - /** Specifies whether the current application must behave as a mobile or web application. */ - mode?: string; - /** Specifies the object that represents a root namespace of the application. */ - namespace?: Object; - /** Specifies application behavior when the user navigates to a root view. */ - navigateToRootViewMode?: string; - /** An array of dxCommand configuration objects used to define commands available from the application's global navigation. */ - navigation?: Array; - /** A state manager to be used in the application. */ - stateManager?: StateManager; - /** Specifies the storage to be used by the application's state manager to store the application state. */ - stateStorage?: Object; - /** Indicates whether on not to use the title of the previously displayed view as text on the Back button. */ - useViewTitleAsBackText?: boolean; - /** A custom view cache to be used in the application. */ - viewCache?: Object; - /** Specifies a limit for the views that can be cached. */ - viewCacheSize?: number; - /** Specifies the current version of application templates. */ - templatesVersion?: string; - /** Specifies options for the viewport meta tag of a mobile browser. */ - viewPort?: JQuery; - /** A custom router to be used in the application. */ - router?: Router; - } - /** An object used to manage views, as well as control the application life cycle. */ - export class HtmlApplication implements EventsMixin { - constructor(options: HtmlApplicationOptions); - afterViewSetup: JQueryCallback; - beforeViewSetup: JQueryCallback; - initialized: JQueryCallback; - navigating: JQueryCallback; - navigatingBack: JQueryCallback; - resolveLayoutController: JQueryCallback; - resolveViewCacheKey: JQueryCallback; - viewDisposed: JQueryCallback; - viewDisposing: JQueryCallback; - viewHidden: JQueryCallback; - viewRendered: JQueryCallback; - viewShowing: JQueryCallback; - viewShown: JQueryCallback; - /** Provides access to the ViewCache object. */ - viewCache: ViewCache; - /** An array of dxCommand components that are created based on the application's navigation option value. */ - navigation: Array; - /** Provides access to the StateManager object. */ - stateManager: StateManager; - /** Provides access to the Router object. */ - router: Router; - /** Navigates to the URI preceding the current one in the navigation history. */ - back(): void; - /** Returns a Boolean value indicating whether or not backwards navigation is currently possible. */ - canBack(): boolean; - /** Calls the clearState() method of the application's StateManager object. */ - clearState(): void; - /** Creates global navigation commands. */ - createNavigation(navigationConfig: Array): void; - /** Returns an HTML template of the specified view. */ - getViewTemplate(viewName: string): JQuery; - /** Returns a configuration object used to create a dxView component for a specified view. */ - getViewTemplateInfo(viewName: string): Object; - /** Adds a specified HTML template to a collection of view or layout templates. */ - loadTemplates(source: any): JQueryPromise; - /** Navigates to the specified URI. */ - navigate(uri?: any, options?: Object): void; - /** Renders navigation commands to the navigation command containers that are located in the layouts used in the application. */ - renderNavigation(): void; - /** Calls the restoreState() method of the application's StateManager object. */ - restoreState(): void; - /** Calls the saveState method of the application's StateManager object. */ - saveState(): void; - /** Provides access to the object that defines the current context to be considered when choosing an appropriate template for a view. */ - templateContext(): Object; - on(eventName: "initialized", eventHandler: () => void): HtmlApplication; - on(eventName: "afterViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "beforeViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "navigating", eventHandler: (e: { - currentUri: string; - uri: string; - cancel: boolean; - options: { - root: boolean; - target: string; - direction: string; - rootInDetailPane: boolean; - modal: boolean; - }; - }) => void): HtmlApplication; - on(eventName: "navigatingBack", eventHandler: (e: { - cancel: boolean; - isHardwareButton: boolean; - }) => void): HtmlApplication; - on(eventName: "resolveLayoutController", eventHandler: (e: { - viewInfo: Object; - layoutController: Object; - availableLayoutControllers: Array; - }) => void): HtmlApplication; - on(eventName: "resolveViewCacheKey", eventHandler: (e: { - key: string; - navigationItem: Object; - routeData: Object; - }) => void): HtmlApplication; - on(eventName: "viewDisposed", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewDisposing", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewHidden", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewRendered", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewShowing", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - on(eventName: "viewShown", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - on(eventName: string, eventHandler: Function): HtmlApplication; - on(events: { [eventName: string]: Function; }): HtmlApplication; - off(eventName: "initialized"): HtmlApplication; - off(eventName: "afterViewSetup"): HtmlApplication; - off(eventName: "beforeViewSetup"): HtmlApplication; - off(eventName: "navigating"): HtmlApplication; - off(eventName: "navigatingBack"): HtmlApplication; - off(eventName: "resolveLayoutController"): HtmlApplication; - off(eventName: "resolveViewCacheKey"): HtmlApplication; - off(eventName: "viewDisposed"): HtmlApplication; - off(eventName: "viewDisposing"): HtmlApplication; - off(eventName: "viewHidden"): HtmlApplication; - off(eventName: "viewRendered"): HtmlApplication; - off(eventName: "viewShowing"): HtmlApplication; - off(eventName: "viewShown"): HtmlApplication; - off(eventName: string): HtmlApplication; - off(eventName: "initialized", eventHandler: () => void): HtmlApplication; - off(eventName: "afterViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "beforeViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "navigating", eventHandler: (e: { - currentUri: string; - uri: string; - cancel: boolean; - options: { - root: boolean; - target: string; - direction: string; - rootInDetailPane: boolean; - modal: boolean; - }; - }) => void): HtmlApplication; - off(eventName: "navigatingBack", eventHandler: (e: { - cancel: boolean; - isHardwareButton: boolean; - }) => void): HtmlApplication; - off(eventName: "resolveLayoutController", eventHandler: (e: { - viewInfo: Object; - layoutController: Object; - availableLayoutControllers: Array; - }) => void): HtmlApplication; - off(eventName: "resolveViewCacheKey", eventHandler: (e: { - key: string; - navigationItem: Object; - routeData: Object; - }) => void): HtmlApplication; - off(eventName: "viewDisposed", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewDisposing", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewHidden", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewRendered", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewShowing", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - off(eventName: "viewShown", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - off(eventName: string, eventHandler: Function): HtmlApplication; - } - } -} -declare namespace DevExpress.viz.core { - /** - * Applies a theme for the entire page with several DevExtreme visualization widgets. - * @deprecated Use the DevExpress.viz.currentTheme(theme) method instead. - */ - export function currentTheme(theme: string): void; - /** - * Applies a new theme (with the color scheme defined separately) for the entire page with several DevExtreme visualization widgets. - * @deprecated Use the DevExpress.viz.currentTheme(platform, colorScheme) method instead. - */ - export function currentTheme(platform: string, colorScheme: string): void; - /** - * Registers a new theme based on the existing one. - * @deprecated Use the DevExpress.viz.registerTheme(customTheme, baseTheme) method instead. - */ - export function registerTheme(customTheme: Object, baseTheme: string): void; - /** - * Applies a predefined or registered custom palette to all visualization widgets at once. - * @deprecated Use the DevExpress.viz.currentPalette(paletteName) method instead. - */ - export function currentPalette(paletteName: string): void; - /** - * Obtains the color sets of a predefined or registered palette. - * @deprecated Use the DevExpress.viz.getPalette(paletteName) method instead. - */ - export function getPalette(paletteName: string): Object; - /** - * Registers a new palette. - * @deprecated Use the DevExpress.viz.registerPalette(paletteName, palette) method instead. - */ - export function registerPalette(paletteName: string, palette: Object): void; - export interface Border { - /** Sets a border color for a selected series. */ - color?: string; - /** Sets border visibility for a selected series. */ - visible?: boolean; - /** Sets a border width for a selected series. */ - width?: number; - } - export interface DashedBorder extends Border { - /** Specifies a dash style for the border of a selected series point. */ - dashStyle?: string; - } - export interface DashedBorderWithOpacity extends DashedBorder { - /** Specifies the opacity of the tooltip's border. */ - opacity?: number; - } - export interface Font { - /** Specifies the font color for a strip label. */ - color?: string; - /** Specifies the font family for a strip label. */ - family?: string; - /** Specifies the font opacity for a strip label. */ - opacity?: number; - /** Specifies the font size for a strip label. */ - size?: any; - /** Specifies the font weight for the text displayed in strips. */ - weight?: number; - } - export interface Hatching { - direction?: string; - /** Specifies the opacity of hatching lines. */ - opacity?: number; - /** Specifies the distance between hatching lines in pixels. */ - step?: number; - /** Specifies the width of hatching lines in pixels. */ - width?: number; - } - export interface Margins { - /** Specifies the distance in pixels between the bottom side of the title and the surrounding widget elements. */ - bottom?: number; - /** Specifies the distance in pixels between the left side of the title and the surrounding widget elements. */ - left?: number; - /** Specifies the distance between the right side of the title and surrounding widget elements in pixels. */ - right?: number; - /** Specifies the distance between the top side of the title and surrounding widget elements in pixels. */ - top?: number; - } - export interface Size { - /** Specifies the width of the widget. */ - width?: number; - /** Specifies the height of the widget. */ - height?: number; - } - export interface Title { - /** Specifies font options for the title. */ - font?: viz.core.Font; - /** Specifies the widget title's horizontal position. */ - horizontalAlignment?: string; - /** Specifies the widget title's position in the vertical direction. */ - verticalAlignment?: string; - /** Specifies the distance between the title and surrounding widget elements in pixels. */ - margin?: viz.core.Margins; - /** Specifies the height of the space reserved for the title. */ - placeholderSize?: number; - /** Specifies text for the title. */ - text?: string; - /** Specifies a subtitle for the widget. */ - subtitle?: { - /** Specifies font options for the subtitle. */ - font?: viz.core.Font; - /** Specifies text for the subtitle. */ - text?: string; - } - } - export interface Tooltip { - /** Specifies the length of the tooltip's arrow in pixels. */ - arrowLength?: number; - /** Specifies the appearance of the tooltip's border. */ - border?: viz.core.DashedBorderWithOpacity; - /** Specifies a color for the tooltip. */ - color?: string; - /** Specifies the z-index for tooltips. */ - zIndex?: number; - /** Specifies the container to draw tooltips inside of it. */ - container?: any; - /** Specifies text and appearance of a set of tooltips. */ - customizeTooltip?: (arg: Object) => { color?: string; text?: string }; - /** Specifies whether or not the tooltip is enabled. */ - enabled?: boolean; - /** Specifies font options for the text displayed by the tooltip. */ - font?: Font; - /** Specifies a format for the text displayed by the tooltip. */ - format?: string; - /** Specifies the opacity of a tooltip. */ - opacity?: number; - /** Specifies a distance from the tooltip's left/right boundaries to the inner text in pixels. */ - paddingLeftRight?: number; - /** Specifies a distance from the tooltip's top/bottom boundaries to the inner text in pixels. */ - paddingTopBottom?: number; - /** Specifies a precision for formatted values displayed by the tooltip. */ - precision?: number; - /** Specifies options of the tooltip's shadow. */ - shadow?: { - /** Specifies the blur distance of the tooltip's shadow. */ - blur?: number; - /** Specifies the color of the tooltip's shadow. */ - color?: string; - /** Specifies the horizontal offset of the tooltip's shadow relative to the tooltip in pixels. */ - offsetX?: number; - /** Specifies the vertical offset of the tooltip's shadow relative to the tooltip in pixels. */ - offsetY?: number; - /** Specifies the opacity of the tooltip's shadow. */ - opacity?: number; - }; - } - export interface Animation { - /** Determines how long animation runs. */ - duration?: number; - /** Specifies the animation easing mode. */ - easing?: string; - /** Indicates whether or not animation is enabled. */ - enabled?: boolean; - } - export interface LoadingIndicator { - /** Specifies a color for the loading indicator background. */ - backgroundColor?: string; - /** Specifies font options for the loading indicator text. */ - font?: viz.core.Font; - /** Specifies whether to show the loading indicator or not. */ - show?: boolean; - /** Specifies a text to be displayed by the loading indicator. */ - text?: string; - } - export interface LegendBorder extends viz.core.DashedBorderWithOpacity { - /** Specifies a radius for the corners of the legend border. */ - cornerRadius?: number; - } - export interface BaseLegend { - /** Specifies the color of the legend's background. */ - backgroundColor?: string; - /** Specifies legend border settings. */ - border?: viz.core.LegendBorder; - /** Specifies how many columns must be taken to arrange legend items. */ - columnCount?: number; - /** Specifies the spacing between a pair of neighboring legend columns in pixels. */ - columnItemSpacing?: number; - /** Specifies font options for legend items. */ - font?: viz.core.Font; - /** Specifies the legend's position on the map. */ - horizontalAlignment?: string; - /** Specifies the alignment of legend items. */ - itemsAlignment?: string; - /** Specifies the position of text relative to the item marker. */ - itemTextPosition?: string; - /** Specifies the distance between the legend and the container borders in pixels. */ - margin?: viz.core.Margins; - /** Specifies the size of item markers in the legend in pixels. */ - markerSize?: number; - /** Specifies whether to arrange legend items horizontally or vertically. */ - orientation?: string; - /** Specifies the spacing between the legend left/right border and legend items in pixels. */ - paddingLeftRight?: number; - /** Specifies the spacing between the legend top/bottom border and legend items in pixels. */ - paddingTopBottom?: number; - /** Specifies how many rows must be taken to arrange legend items. */ - rowCount?: number; - /** Specifies the spacing between a pair of neighboring legend rows in pixels. */ - rowItemSpacing?: number; - /** Specifies the legend's position on the map. */ - verticalAlignment?: string; - /** Specifies whether or not the legend is visible on the map. */ - visible?: boolean; - } - export interface BaseWidgetOptions { - /** A handler for the drawn event. */ - onDrawn?: (e: { - component: BaseWidget; - element: Element; - }) => void; - /** A handler for the incidentOccurred event. */ - onIncidentOccurred?: ( - component: BaseWidget, - element: Element, - target: { - id: string; - type: string; - args: any; - text: string; - widget: string; - version: string; - } - ) => void; - /** Notifies a widget that it is embedded into an HTML page that uses a path modifier. */ - pathModified?: boolean; - /** Specifies whether or not the widget supports right-to-left representation. */ - rtlEnabled?: boolean; - /** Sets the name of the theme to be used in the widget. */ - theme?: string; - } - /** This section describes options and methods that are common to all widgets. */ - export class BaseWidget extends DOMComponent { - /** Returns the widget's SVG markup. */ - svg(): string; - } -} -declare namespace DevExpress.viz.charts { - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface BaseSeries { - /** Provides information about the state of the series object. */ - fullState: number; - /** Returns the type of the series. */ - type: string; - /** Unselects all the selected points of the series. The points are displayed in an initial style. */ - clearSelection(): void; - /** Gets the color of a particular series. */ - getColor(): string; - /** Gets points from the series point collection based on the specified argument. */ - getPointsByArg(pointArg: any): Array; - /** Gets a point from the series point collection based on the specified point position. */ - getPointByPos(positionIndex: number): Object; - /** Selects the series. The series is displayed in a 'selected' style until another series is selected or the current series is deselected programmatically. */ - select(): void; - /** Selects the specified point. The point is displayed in a 'selected' style. */ - selectPoint(point: BasePoint): void; - /** Deselects the specified point. The point is displayed in an initial style. */ - deselectPoint(point: BasePoint): void; - /** Returns an array of all points in the series. */ - getAllPoints(): Array; - /** Returns visible series points. */ - getVisiblePoints(): Array; - /** Returns the name of the series. */ - name: string; - /** Returns the tag of the series. */ - tag: string; - /** Hides a series. */ - hide(): void; - /** Provides information about the hover state of a series. */ - isHovered(): boolean; - /** Provides information about the selection state of a series. */ - isSelected(): boolean; - /** Provides information about the visibility state of a series. */ - isVisible(): boolean; - /** Makes a particular series visible. */ - show(): void; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface BasePoint { - /** Provides information about the state of the point object. */ - fullState: number; - /** Returns the point's argument value that was set in the data source. */ - originalArgument: any; - /** Returns the point's value that was set in the data source. */ - originalValue: any; - /** Returns the tag of the point. */ - tag: string; - /** Deselects the point. */ - clearSelection(): void; - /** Gets the color of a particular point. */ - getColor(): string; - /** Hides the tooltip of the point. */ - hideTooltip(): void; - /** Provides information about the hover state of a point. */ - isHovered(): boolean; - /** Provides information about the selection state of a point. */ - isSelected(): boolean; - /** Selects the point. The point is displayed in a 'selected' style until another point is selected or the current point is deselected programmatically. */ - select(): void; - /** Shows the tooltip of the point. */ - showTooltip(): void; - /** Allows you to obtain the label of a series point. */ - getLabel(): any; - /** Returns the series object to which the point belongs. */ - series: BaseSeries; - } - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface ChartSeries extends BaseSeries { - /** Returns the name of the series pane. */ - pane: string; - /** Returns the name of the value axis of the series. */ - axis: string; - selectPoint(point: ChartPoint): void; - deselectPoint(point: ChartPoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface ChartPoint extends BasePoint { - /** Contains the close value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalCloseValue: any; - /** Contains the high value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalHighValue: any; - /** Contains the low value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalLowValue: any; - /** Contains the first value of the point. This field is useful for points belonging to a series of the range area or range bar type only. */ - originalMinValue: any; - /** Contains the open value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalOpenValue: any; - /** Contains the size of the bubble as it was set in the data source. This field is useful for points belonging to a series of the bubble type only. */ - size: any; - /** Gets the parameters of the point's minimum bounding rectangle (MBR). */ - getBoundingRect(): { x: number; y: number; width: number; height: number; }; - series: ChartSeries; - } - /** This section describes the methods that can be used in code to manipulate the Label object. */ - export interface Label { - /** Gets the parameters of the label's minimum bounding rectangle (MBR). */ - getBoundingRect(): { x: number; y: number; width: number; height: number; }; - /** Hides the point label. */ - hide(): void; - /** Shows the point label. */ - show(): void; - } - export interface PieSeries extends BaseSeries { - selectPoint(point: PiePoint): void; - deselectPoint(point: PiePoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface PiePoint extends BasePoint { - /** Gets the percentage value of the specific point. */ - percent: any; - /** Provides information about the visibility state of a point. */ - isVisible(): boolean; - /** Makes a specific point visible. */ - show(): void; - /** Hides a specific point. */ - hide(): void; - series: PieSeries; - } - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface PolarSeries extends BaseSeries { - /** Returns the name of the value axis of the series. */ - axis: string; - selectPoint(point: PolarPoint): void; - deselectPoint(point: PolarPoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface PolarPoint extends BasePoint { - series: PolarSeries; - } - export interface Strip { - /** Specifies a color for a strip. */ - color?: string; - /** An object that defines the label configuration options of a strip. */ - label?: { - /** Specifies the text displayed in a strip. */ - text?: string; - }; - /** Specifies a start value for a strip. */ - startValue?: any; - /** Specifies an end value for a strip. */ - endValue?: any; - } - export interface BaseSeriesConfigLabel { - /** Specifies a format for arguments displayed by point labels. */ - argumentFormat?: string; - /** Specifies a precision for formatted point arguments displayed in point labels. */ - argumentPrecision?: number; - /** Specifies a background color for point labels. */ - backgroundColor?: string; - /** Specifies border options for point labels. */ - border?: viz.core.DashedBorder; - /** Specifies connector options for series point labels. */ - connector?: { - /** Specifies the color of label connectors. */ - color?: string; - /** Indicates whether or not label connectors are visible. */ - visible?: boolean; - /** Specifies the width of label connectors. */ - width?: number; - }; - /** Specifies a callback function that returns the text to be displayed by point labels. */ - customizeText?: (pointInfo: Object) => string; - /** Specifies font options for the text displayed in point labels. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed by point labels. */ - format?: string; - position?: string; - /** Specifies a precision for formatted point values displayed in point labels. */ - precision?: number; - /** Specifies the angle used to rotate point labels from their initial position. */ - rotationAngle?: number; - /** Specifies the visibility of point labels. */ - visible?: boolean; - } - export interface SeriesConfigLabel extends BaseSeriesConfigLabel { - /** Specifies whether or not to show a label when the point has a zero value. */ - showForZeroValues?: boolean; - } - export interface ChartSeriesConfigLabel extends SeriesConfigLabel { - /** Specifies how to align point labels relative to the corresponding data points that they represent. */ - alignment?: string; - /** Specifies how to shift point labels horizontally from their initial positions. */ - horizontalOffset?: number; - /** Specifies how to shift point labels vertically from their initial positions. */ - verticalOffset?: number; - /** Specifies a precision for the percentage values displayed in the labels of a full-stacked-like series. */ - percentPrecision?: number; - } - export interface BaseCommonSeriesConfig { - /** Specifies the data source field that provides arguments for series points. */ - argumentField?: string; - axis?: string; - /** An object defining the label configuration options for a series in the dxChart widget. */ - label?: ChartSeriesConfigLabel; - /** Specifies border options for point labels. */ - border?: viz.core.DashedBorder; - /** Specifies a series color. */ - color?: string; - /** Specifies the dash style of the series' line. */ - dashStyle?: string; - hoverMode?: string; - hoverStyle?: { - /** An object defining the border options for a hovered series. */ - border?: viz.core.DashedBorder; - /**

Sets a color for a series when it is hovered over.

*/ - color?: string; - /** Specifies the dash style for the line in a hovered series. */ - dashStyle?: string; - hatching?: viz.core.Hatching; - /** Specifies the width of a line in a hovered series. */ - width?: number; - }; - /** Specifies whether a chart ignores null data points or not. */ - ignoreEmptyPoints?: boolean; - /** Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed. */ - maxLabelCount?: number; - /** Specifies the minimal length of a displayed bar in pixels. */ - minBarSize?: number; - /** Specifies opacity for a series. */ - opacity?: number; - /** Specifies the series elements to highlight when the series is selected. */ - selectionMode?: string; - selectionStyle?: { - /** An object defining the border options for a selected series. */ - border?: viz.core.DashedBorder; - /** Sets a color for a series when it is selected. */ - color?: string; - /** Specifies the dash style for the line in a selected series. */ - dashStyle?: string; - hatching?: viz.core.Hatching; - /** Specifies the width of a line in a selected series. */ - width?: number; - }; - /** Specifies whether or not to show the series in the chart's legend. */ - showInLegend?: boolean; - /** Specifies the name of the stack where the values of the _stackedBar_ series must be located. */ - stack?: string; - /** Specifies the name of the data source field that provides data about a point. */ - tagField?: string; - /** Specifies the data source field that provides values for series points. */ - valueField?: string; - /** Specifies the visibility of a series. */ - visible?: boolean; - /** Specifies a line width. */ - width?: number; - /** Configures error bars. */ - valueErrorBar?: { - /** Specifies whether error bars must be displayed in full or partially. */ - displayMode?: string; - /** Specifies the data field that provides data for low error values. */ - lowValueField?: string; - /** Specifies the data field that provides data for high error values. */ - highValueField?: string; - /** Specifies how error bar values must be calculated. */ - type?: string; - /** Specifies the value to be used for generating error bars. */ - value?: number; - /** Specifies the color of error bars. */ - color?: string; - /** Specifies the opacity of error bars. */ - opacity?: number; - /** Specifies the length of the lines that indicate the error bar edges. */ - edgeLength?: number; - /** Specifies the width of the error bar line. */ - lineWidth?: number; - }; - } - export interface CommonPointOptions { - /** Specifies border options for points in the line and area series. */ - border?: viz.core.Border; - /** Specifies the points color. */ - color?: string; - /** Specifies what series points to highlight when a point is hovered over. */ - hoverMode?: string; - /** An object defining configuration options for a hovered point. */ - hoverStyle?: { - /** An object defining the border options for a hovered point. */ - border?: viz.core.Border; - /** Sets a color for a point when it is hovered over. */ - color?: string; - /** Specifies the diameter of a hovered point in the series that represents data points as symbols (not as bars for instance). */ - size?: number; - }; - /** Specifies what series points to highlight when a point is selected. */ - selectionMode?: string; - /** An object defining configuration options for a selected point. */ - selectionStyle?: { - /** An object defining the border options for a selected point. */ - border?: viz.core.Border; - /**

Sets a color for a point when it is selected.

*/ - color?: string; - /** Specifies the diameter of a selected point in the series that represents data points as symbols (not as bars for instance). */ - size?: number; - }; - /** Specifies the point diameter in pixels for those series that represent data points as symbols (not as bars for instance). */ - size?: number; - /** Specifies a symbol for presenting points of the line and area series. */ - symbol?: string; - visible?: boolean; - } - export interface ChartCommonPointOptions extends CommonPointOptions { - /** An object specifying the parameters of an image that is used as a point marker. */ - image?: { - /** Specifies the height of an image that is used as a point marker. */ - height?: any; - /** Specifies a URL leading to the image to be used as a point marker. */ - url?: any; - /** Specifies the width of an image that is used as a point marker. */ - width?: any; - }; - } - export interface PolarCommonPointOptions extends CommonPointOptions { - /** An object specifying the parameters of an image that is used as a point marker. */ - image?: { - /** Specifies the height of an image that is used as a point marker. */ - height?: number; - /** Specifies a URL leading to the image to be used as a point marker. */ - url?: string; - /** Specifies the width of an image that is used as a point marker. */ - width?: number; - }; - } - /** An object that defines configuration options for chart series. */ - export interface CommonSeriesConfig extends BaseCommonSeriesConfig { - /** Specifies the data source field that provides a 'close' value for a _candleStick_ or _stock_ series. */ - closeValueField?: string; - /** Specifies a radius for bar corners. */ - cornerRadius?: number; - /** Specifies the data source field that provides a 'high' value for a _candleStick_ or _stock_ series. */ - highValueField?: string; - /** Specifies the color for the body (rectangle) of a _candleStick_ series. */ - innerColor?: string; - /** Specifies the data source field that provides a 'low' value for a _candleStick_ or _stock_ series. */ - lowValueField?: string; - /** Specifies the data source field that provides an 'open' value for a _candleStick_ or _stock_ series. */ - openValueField?: string; - /** Specifies the pane that will be used to display a series. */ - pane?: string; - /** An object defining configuration options for points in line-, scatter- and area-like series. */ - point?: ChartCommonPointOptions; - /** Specifies the data source field that provides values for one end of a range series. To set the data source field for the other end of the range series, use the rangeValue2Field property. */ - rangeValue1Field?: string; - /** Specifies the data source field that provides values for the second end of a range series. To set the data source field for the other end of the range series, use the rangeValue1Field property. */ - rangeValue2Field?: string; - /** Specifies reduction options for the stock or candleStick series. */ - reduction?: { - /** Specifies a color for the points whose reduction level price is lower in comparison to the value in the previous point. */ - color?: string; - /** Specifies for which price level (open, high, low or close) to enable reduction options in the series. */ - level?: string; - }; - /** Specifies the data source field that defines the size of bubbles. */ - sizeField?: string; - } - export interface CommonSeriesSettings extends CommonSeriesConfig { - /**

An object that specifies configuration options for all series of the area type in the chart.

*/ - area?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _bar_ type in the chart. */ - bar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the bubble type in the chart. */ - bubble?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _candleStick_ type in the chart. */ - candlestick?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _fullStackedArea_ type in the chart. */ - fullstackedarea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Full-Stacked Spline Area type in the chart. */ - fullstackedsplinearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _fullStackedBar_ type in the chart. */ - fullstackedbar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _fullStackedLine_ type in the chart. */ - fullstackedline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Full-Stacked Spline type in the chart. */ - fullstackedspline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _line_ type in the chart. */ - line?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _rangeArea_ type in the chart. */ - rangearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _rangeBar_ type in the chart. */ - rangebar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _scatter_ type in the chart. */ - scatter?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _spline_ type in the chart. */ - spline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _splineArea_ type in the chart. */ - splinearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedArea_ type in the chart. */ - stackedarea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Stacked Spline Area type in the chart. */ - stackedsplinearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedBar_ type in the chart. */ - stackedbar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedLine_ type in the chart. */ - stackedline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Stacked Spline type in the chart. */ - stackedspline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stepArea_ type in the chart. */ - steparea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stepLine_ type in the chart. */ - stepline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stock_ type in the chart. */ - stock?: CommonSeriesConfig; - /** Sets a series type. */ - type?: string; - } - export interface SeriesConfig extends CommonSeriesConfig { - /** Specifies the name that identifies the series. */ - name?: string; - /** Specifies data about a series. */ - tag?: any; - /** Sets the series type. */ - type?: string; - } - /** An object that defines configuration options for polar chart series. */ - export interface CommonPolarSeriesConfig extends BaseCommonSeriesConfig { - /** Specifies whether or not to close the chart by joining the end point with the first point. */ - closed?: boolean; - label?: SeriesConfigLabel; - point?: PolarCommonPointOptions; - } - export interface CommonPolarSeriesSettings extends CommonPolarSeriesConfig { - /** An object that specifies configuration options for all series of the area type in the chart. */ - area?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _bar_ type in the chart. */ - bar?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _line_ type in the chart. */ - line?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _scatter_ type in the chart. */ - scatter?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedBar_ type in the chart. */ - stackedbar?: CommonPolarSeriesConfig; - /** Sets a series type. */ - type?: string; - } - export interface PolarSeriesConfig extends CommonPolarSeriesConfig { - /** Specifies the name that identifies the series. */ - name?: string; - /** Specifies data about a series. */ - tag?: any; - /** Sets the series type. */ - type?: string; - } - export interface PieSeriesConfigLabel extends BaseSeriesConfigLabel { - /** Specifies how to shift labels from their initial position in a radial direction in pixels. */ - radialOffset?: number; - /** Specifies a precision for the percentage values displayed in labels. */ - percentPrecision?: number; - } - /** An object that defines configuration options for chart series. */ - export interface CommonPieSeriesConfig { - /** Specifies the data source field that provides arguments for series points. */ - argumentField?: string; - /** Specifies the required type for series arguments. */ - argumentType?: string; - /** An object defining the series border configuration options. */ - border?: viz.core.DashedBorder; - /** Specifies a series color. */ - color?: string; - /** Specifies the chart elements to highlight when a series is hovered over. */ - hoverMode?: string; - /** An object defining configuration options for a hovered series. */ - hoverStyle?: { - /** An object defining the border options for a hovered series. */ - border?: viz.core.DashedBorder; - /** Sets a color for the series when it is hovered over. */ - color?: string; - /** Specifies the hatching options to be applied when a point is hovered over. */ - hatching?: viz.core.Hatching; - }; - /** - * Specifies the fraction of the inner radius relative to the total radius in the series of the 'doughnut' type. - * @deprecated use the 'innerRadius' option instead - */ - innerRadius?: number; - /** An object defining the label configuration options. */ - label?: PieSeriesConfigLabel; - /** Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed. */ - maxLabelCount?: number; - /** Specifies a minimal size of a displayed pie segment. */ - minSegmentSize?: number; - /** - * Specifies the direction in which the dxPieChart series points are located. - * @deprecated use the 'segmentsDirection' option instead - */ - segmentsDirection?: string; - /**

Specifies the chart elements to highlight when the series is selected.

*/ - selectionMode?: string; - /** An object defining configuration options for the series when it is selected. */ - selectionStyle?: { - /** An object defining the border options for a selected series. */ - border?: viz.core.DashedBorder; - /** Sets a color for a series when it is selected. */ - color?: string; - /** Specifies the hatching options to be applied when a point is selected. */ - hatching?: viz.core.Hatching; - }; - /** Specifies chart segment grouping options. */ - smallValuesGrouping?: { - /** Specifies the name of the grouped chart segment. This name represents the segment in the chart legend. */ - groupName?: string; - /** Specifies the segment grouping mode. */ - mode?: string; - /** Specifies a threshold for segment values. */ - threshold?: number; - /** Specifies how many segments must not be grouped. */ - topCount?: number; - }; - /** - * Specifies a start angle for a pie chart in arc degrees. - * @deprecated use the 'startAngle' option instead - */ - startAngle?: number; - /**

Specifies the name of the data source field that provides data about a point.

*/ - tagField?: string; - /** Specifies the data source field that provides values for series points. */ - valueField?: string; - } - export interface CommonPieSeriesSettings extends CommonPieSeriesConfig { - type?: string; - } - export interface PieSeriesConfig extends CommonPieSeriesConfig { - /** - * Sets the series type. - * @deprecated use the 'type' option instead - */ - type?: string; - /** Specifies the name that identifies the series. */ - name?: string; - /** Specifies data about a series. */ - tag?: any; - } - export interface SeriesTemplate { - /** Specifies a callback function that returns a series object with individual series settings. */ - customizeSeries?: (seriesName: string) => SeriesConfig; - /** Specifies a data source field that represents the series name. */ - nameField?: string; - } - export interface PolarSeriesTemplate { - /** Specifies a callback function that returns a series object with individual series settings. */ - customizeSeries?: (seriesName: string) => PolarSeriesConfig; - /** Specifies a data source field that represents the series name. */ - nameField?: string; - } - export interface ChartCommonConstantLineLabel { - /** Specifies font options for a constant line label. */ - font?: viz.core.Font; - /** Specifies the position of the constant line label relative to the chart plot. */ - position?: string; - /** Indicates whether or not to display labels for the axis constant lines. */ - visible?: boolean; - } - export interface PolarCommonConstantLineLabel { - /** Indicates whether or not to display labels for the axis constant lines. */ - visible?: boolean; - /** Specifies font options for a constant line label. */ - font?: viz.core.Font; - } - export interface ConstantLineStyle { - /** Specifies a color for a constant line. */ - color?: string; - /** Specifies a dash style for a constant line. */ - dashStyle?: string; - /** Specifies a constant line width in pixels. */ - width?: number; - } - export interface ChartCommonConstantLineStyle extends ConstantLineStyle { - /** An object defining constant line label options. */ - label?: ChartCommonConstantLineLabel; - /** Specifies the space between the constant line label and the left/right side of the constant line. */ - paddingLeftRight?: number; - /** Specifies the space between the constant line label and the top/bottom side of the constant line. */ - paddingTopBottom?: number; - } - export interface PolarCommonConstantLineStyle extends ConstantLineStyle { - /** An object defining constant line label options. */ - label?: PolarCommonConstantLineLabel; - } - export interface CommonAxisLabel { - /** Specifies font options for axis labels. */ - font?: viz.core.Font; - /** Specifies the spacing between an axis and its labels in pixels. */ - indentFromAxis?: number; - /** Indicates whether or not axis labels are visible. */ - visible?: boolean; - } - export interface ChartCommonAxisLabel extends CommonAxisLabel { - /** Specifies the label's position relative to the tick (grid line). */ - alignment?: string; - /** Specifies the overlap resolving algorithm to be applied to axis labels. */ - overlappingBehavior?: { - /** Specifies how to arrange axis labels. */ - mode?: string; - /** Specifies the angle used to rotate axis labels. */ - rotationAngle?: number; - /** Specifies the spacing that must be set between staggered rows when the 'stagger' algorithm is applied. */ - staggeringSpacing?: number; - }; - } - export interface PolarCommonAxisLabel extends CommonAxisLabel { - /** Specifies the overlap resolving algorithm to be applied to axis labels. */ - overlappingBehavior?: string; - } - export interface CommonAxisTitle { - /** Specifies font options for an axis title. */ - font?: viz.core.Font; - /** Specifies a margin for an axis title in pixels. */ - margin?: number; - } - export interface BaseCommonAxisSettings { - /** Specifies the color of the line that represents an axis. */ - color?: string; - /** Specifies whether ticks/grid lines of a discrete axis are located between labels or cross the labels. */ - discreteAxisDivisionMode?: string; - /** An object defining the configuration options for the grid lines of an axis in the dxPolarChart widget. */ - grid?: { - /** Specifies a color for grid lines. */ - color?: string; - /** Specifies an opacity for grid lines. */ - opacity?: number; - /** Indicates whether or not the grid lines of an axis are visible. */ - visible?: boolean; - /** Specifies the width of grid lines. */ - width?: number; - }; - /** Specifies the options of the minor grid. */ - minorGrid?: { - /** Specifies a color for the lines of the minor grid. */ - color?: string; - /** Specifies an opacity for the lines of the minor grid. */ - opacity?: number; - /** Indicates whether the minor grid is visible or not. */ - visible?: boolean; - /** Specifies a width for the lines of the minor grid. */ - width?: number; - }; - /** Indicates whether or not an axis is inverted. */ - inverted?: boolean; - /** Specifies the opacity of the line that represents an axis. */ - opacity?: number; - /** Indicates whether or not to set ticks/grid lines of a continuous axis of the 'date-time' type at the beginning of each date-time interval. */ - setTicksAtUnitBeginning?: boolean; - /** An object defining the configuration options for axis ticks. */ - tick?: { - /** Specifies ticks color. */ - color?: string; - /** Specifies tick opacity. */ - opacity?: number; - /** Indicates whether or not ticks are visible on an axis. */ - visible?: boolean; - /** Specifies tick width. */ - width?: number; - /** Specifies tick length. */ - length?: number; - }; - /** Specifies the options of the minor ticks. */ - minorTick?: { - /** Specifies a color for the minor ticks. */ - color?: string; - /** Specifies an opacity for the minor ticks. */ - opacity?: number; - /** Indicates whether or not the minor ticks are displayed on an axis. */ - visible?: boolean; - /** Specifies minor tick width. */ - width?: number; - /** Specifies minor tick length. */ - length?: number; - }; - /** Indicates whether or not the line that represents an axis in a chart is visible. */ - visible?: boolean; - /** Specifies the width of the line that represents an axis in the chart. */ - width?: number; - } - export interface ChartCommonAxisSettings extends BaseCommonAxisSettings { - /** Specifies the appearance of all the widget's constant lines. */ - constantLineStyle?: ChartCommonConstantLineStyle; - /** An object defining the label configuration options that are common for all axes in the dxChart widget. */ - label?: ChartCommonAxisLabel; - /** Specifies a coefficient that determines the spacing between the maximum series point and the axis. */ - maxValueMargin?: number; - /** Specifies a coefficient that determines the spacing between the minimum series point and the axis. */ - minValueMargin?: number; - /** Specifies, in pixels, the space reserved for an axis. */ - placeholderSize?: number; - /** An object defining configuration options for strip style. */ - stripStyle?: { - /** An object defining the configuration options for a strip label style. */ - label?: { - /** Specifies font options for a strip label. */ - font?: viz.core.Font; - /** Specifies the label's position on a strip. */ - horizontalAlignment?: string; - /** Specifies a label's position on a strip. */ - verticalAlignment?: string; - }; - /** Specifies the spacing, in pixels, between the left/right strip border and the strip label. */ - paddingLeftRight?: number; - /** Specifies the spacing, in pixels, between the top/bottom strip borders and the strip label. */ - paddingTopBottom?: number; - }; - /** An object defining the title configuration options that are common for all axes in the dxChart widget. */ - title?: CommonAxisTitle; - /** Indicates whether or not to display series with indents from axis boundaries. */ - valueMarginsEnabled?: boolean; - } - export interface PolarCommonAxisSettings extends BaseCommonAxisSettings { - /** Specifies the appearance of all the widget's constant lines. */ - constantLineStyle?: PolarCommonConstantLineStyle; - /** An object defining the label configuration options that are common for all axes in the dxPolarChart widget. */ - label?: PolarCommonAxisLabel; - /** An object defining configuration options for strip style. */ - stripStyle?: { - /** An object defining the configuration options for a strip label style. */ - label?: { - /** Specifies font options for a strip label. */ - font?: viz.core.Font; - }; - }; - } - export interface ChartConstantLineLabel extends ChartCommonConstantLineLabel { - /** Specifies the horizontal alignment of a constant line label. */ - horizontalAlignment?: string; - /** Specifies the vertical alignment of a constant line label. */ - verticalAlignment?: string; - /** Specifies the text to be displayed in a constant line label. */ - text?: string; - } - export interface PolarConstantLineLabel extends PolarCommonConstantLineLabel { - /** Specifies the text to be displayed in a constant line label. */ - text?: string; - } - export interface AxisLabel { - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a label on the value axis. */ - customizeHint?: (argument: { value: any; valueText: string }) => string; - /** Specifies a callback function that returns the text to be displayed in value axis labels. */ - customizeText?: (argument: { value: any; valueText: string }) => string; - /** Specifies a format for the text displayed by axis labels. */ - format?: string; - /** Specifies a precision for the formatted value displayed in the axis labels. */ - precision?: number; - } - export interface ChartAxisLabel extends ChartCommonAxisLabel, AxisLabel { } - export interface PolarAxisLabel extends PolarCommonAxisLabel, AxisLabel { } - export interface AxisTitle extends CommonAxisTitle { - /** Specifies the text for the value axis title. */ - text?: string; - } - export interface ChartConstantLineStyle extends ChartCommonConstantLineStyle { - /** An object defining constant line label options. */ - label?: ChartConstantLineLabel; - } - export interface ChartConstantLine extends ChartConstantLineStyle { - /** An object defining constant line label options. */ - label?: ChartConstantLineLabel; - /** Specifies a value to be displayed by a constant line. */ - value?: any; - } - export interface PolarConstantLine extends PolarCommonConstantLineStyle { - /** An object defining constant line label options. */ - label?: PolarConstantLineLabel; - /** Specifies a value to be displayed by a constant line. */ - value?: any; - } - export interface Axis { - /** Specifies a coefficient for dividing the value axis. */ - axisDivisionFactor?: number; - /** Specifies the order in which discrete values are arranged on the value axis. */ - categories?: Array; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic axis. */ - logarithmBase?: number; - /** Specifies an interval between axis ticks/grid lines. */ - tickInterval?: any; - /** Specifies the interval between minor ticks. */ - minorTickInterval?: any; - /** Specifies the number of minor ticks between two neighboring major ticks. */ - minorTickCount?: number; - /** Specifies the required type of the value axis. */ - type?: string; - /** Specifies the pane on which the current value axis will be displayed. */ - pane?: string; - /** Specifies options for value axis strips. */ - strips?: Array; - } - export interface ChartAxis extends ChartCommonAxisSettings, Axis { - /** Defines an array of the value axis constant lines. */ - constantLines?: Array; - /** Specifies the appearance options for the constant lines of the value axis. */ - constantLineStyle?: ChartCommonConstantLineStyle; - /** Specifies options for value axis labels. */ - label?: ChartAxisLabel; - /** Specifies the maximum value on the value axis. */ - max?: any; - /** Specifies the minimum value on the value axis. */ - min?: any; - /** Specifies the position of the value axis on a chart. */ - position?: string; - /** Specifies the title for a value axis. */ - title?: AxisTitle; - } - export interface PolarAxis extends PolarCommonAxisSettings, Axis { - /** Defines an array of the value axis constant lines. */ - constantLines?: Array; - /** Specifies options for value axis labels. */ - label?: PolarAxisLabel; - } - export interface ArgumentAxis { - /** Specifies the desired type of axis values. */ - argumentType?: string; - /** Specifies the elements that will be highlighted when the argument axis is hovered over. */ - hoverMode?: string; - } - export interface ChartArgumentAxis extends ChartAxis, ArgumentAxis { } - export interface PolarArgumentAxis extends PolarAxis, ArgumentAxis { - /** Specifies a start angle for the argument axis in degrees. */ - startAngle?: number; - /** Specifies whether or not to display the first point at the angle specified by the startAngle option. */ - firstPointOnStartAngle?: boolean; - /** Specifies the period of the argument values in the data source. */ - period?: number; - } - export interface ValueAxis { - /** Specifies the name of the value axis. */ - name?: string; - /** Specifies whether or not to indicate a zero value on the value axis. */ - showZero?: boolean; - /** Specifies the desired type of axis values. */ - valueType?: string; - } - export interface ChartValueAxis extends ChartAxis, ValueAxis { - /** Specifies the spacing, in pixels, between multiple value axes in a chart. */ - multipleAxesSpacing?: number; - /** Specifies the value by which the chart's value axes are synchronized. */ - synchronizedValue?: number; - } - export interface PolarValueAxis extends PolarAxis, ValueAxis { - /** Indicates whether to display series with indents from axis boundaries. */ - valueMarginsEnabled?: boolean; - /** Specifies a coefficient that determines the spacing between the maximum series point and the axis. */ - maxValueMargin?: number; - /** Specifies a coefficient that determines the spacing between the minimum series point and the axis. */ - minValueMargin?: number; - tick?: { - visible?: boolean; - } - } - export interface CommonPane { - /** Specifies a background color in a pane. */ - backgroundColor?: string; - /** Specifies the border options of a chart's pane. */ - border?: PaneBorder; - } - export interface Pane extends CommonPane { - /** Specifies the name of a pane. */ - name?: string; - } - export interface PaneBorder extends viz.core.DashedBorderWithOpacity { - /** Specifies the bottom border's visibility state in a pane. */ - bottom?: boolean; - /** Specifies the left border's visibility state in a pane. */ - left?: boolean; - /** Specifies the right border's visibility state in a pane. */ - right?: boolean; - /** Specifies the top border's visibility state in a pane. */ - top?: boolean; - } - export interface ChartAnimation extends viz.core.Animation { - /** Specifies the maximum series point count in the chart that the animation supports. */ - maxPointCountSupported?: number; - } - export interface BaseChartTooltip extends viz.core.Tooltip { - /** Specifies a format for arguments of the chart's series points. */ - argumentFormat?: string; - /** Specifies a precision for formatted arguments displayed in tooltips. */ - argumentPrecision?: number; - /** Specifies a precision for a percent value displayed in tooltips for stacked series and dxPieChart series. */ - percentPrecision?: number; - } - export interface BaseChartOptions extends viz.core.BaseWidgetOptions { - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - /** Specifies the width of the widget that is small enough for the layout to begin adapting. */ - width?: number; - /** Specifies the height of the widget that is small enough for the layout to begin adapting. */ - height?: number; - /** Specifies whether or not point labels can be hidden when the layout is adapting. */ - keepLabels?: boolean; - }; - /** Specifies animation options. */ - animation?: ChartAnimation; - /** Specifies a callback function that returns an object with options for a specific point label. */ - customizeLabel?: (labelInfo: Object) => Object; - /** Specifies a callback function that returns an object with options for a specific point. */ - customizePoint?: (pointInfo: Object) => Object; - /** Specifies a data source for the chart. */ - dataSource?: any; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies options of a dxChart's (dxPieChart's) legend. */ - legend?: core.BaseLegend; - /** Specifies the blank space between the chart's extreme elements and the boundaries of the area provided for the widget (see size) in pixels. */ - margin?: viz.core.Margins; - /** Sets the name of the palette to be used in the chart. Alternatively, an array of colors can be set as a custom palette to be used within this chart. */ - palette?: any; - /** A handler for the done event. */ - onDone?: (e: { - component: BaseChart; - element: Element; - }) => void; - /** A handler for the pointClick event. */ - onPointClick?: any; - /** A handler for the pointHoverChanged event. */ - onPointHoverChanged?: (e: { - component: BaseChart; - element: Element; - target: TPoint; - }) => void; - /** A handler for the pointSelectionChanged event. */ - onPointSelectionChanged?: (e: { - component: BaseChart; - element: Element; - target: TPoint; - }) => void; - /** Specifies whether a single point or multiple points can be selected in the chart. */ - pointSelectionMode?: string; - /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */ - redrawOnResize?: boolean; - /** Specifies options for the dxChart and dxPieChart widget series. */ - series?: any; - /** Specifies the size of the widget in pixels. */ - size?: viz.core.Size; - /** Specifies a title for the chart. */ - title?: viz.core.Title; - /** Specifies tooltip options. */ - tooltip?: BaseChartTooltip; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: BaseChart; - element: Element; - target: BasePoint; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: BaseChart; - element: Element; - target: BasePoint; - }) => void; - } - /** A base class for all chart widgets included in the ChartJS library. */ - export class BaseChart extends viz.core.BaseWidget { - /** Deselects the chart's selected series. The series is displayed in an initial style. */ - clearSelection(): void; - /** Gets the current size of the widget. */ - getSize(): { width: number; height: number }; - /** Returns an array of all series in the chart. */ - getAllSeries(): Array; - /** Gets a series within the chart's series collection by the specified name (see the name option). */ - getSeriesByName(seriesName: string): BaseSeries; - /** Gets a series within the chart's series collection by its position number. */ - getSeriesByPos(seriesIndex: number): BaseSeries; - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Hides all widget tooltips. */ - hideTooltip(): void; - /** Redraws a widget. */ - render(renderOptions?: { - force?: boolean; - animate?: boolean; - asyncSeriesRendering?: boolean; - }): void; - } - export interface AdvancedLegend extends core.BaseLegend { - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item. */ - customizeHint?: (seriesInfo: { seriesName: string; seriesIndex: number; seriesColor: string; }) => string; - /**

Specifies a callback function that returns the text to be displayed by legend items.

*/ - customizeText?: (seriesInfo: { seriesName: string; seriesIndex: number; seriesColor: string; }) => string; - /** Specifies what series elements to highlight when a corresponding item in the legend is hovered over. */ - hoverMode?: string; - } - export interface AdvancedOptions extends BaseChartOptions { - /** A handler for the argumentAxisClick event. */ - onArgumentAxisClick?: any; - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** An object providing options for managing data from a data source. */ - dataPrepareSettings?: { - /** Specifies whether or not to validate the values from a data source. */ - checkTypeForAllData?: boolean; - /** Specifies whether or not to convert the values from a data source into the data type of an axis. */ - convertToAxisDataType?: boolean; - /** Specifies how to sort the series points. */ - sortingMethod?: any; - }; - /** A handler for the legendClick event. */ - onLegendClick?: any; - /** A handler for the seriesClick event. */ - onSeriesClick?: any; - /** A handler for the seriesHoverChanged event. */ - onSeriesHoverChanged?: (e: { - component: BaseChart; - element: Element; - target: TSeries; - }) => void; - /** A handler for the seriesSelectionChanged event. */ - onSeriesSelectionChanged?: (e: { - component: BaseChart; - element: Element; - target: TSeries; - }) => void; - /** Specifies whether a single series or multiple series can be selected in the chart. */ - seriesSelectionMode?: string; - /** Specifies how the chart must behave when series point labels overlap. */ - resolveLabelOverlapping?: string; - /** Specifies whether or not all bars in a series must have the same angle, or may have different angles if any points in other series are missing. */ - equalBarWidth?: boolean; - /** Specifies a common bar width as a percentage from 0 to 1. */ - barWidth?: number; - } - export interface Legend extends AdvancedLegend { - /** Specifies whether the legend is located outside or inside the chart's plot. */ - position?: string; - } - export interface ChartTooltip extends BaseChartTooltip { - /** Specifies whether the tooltip must be located in the center of a bar or on its edge. Applies to the Bar and Bubble series. */ - location?: string; - /** Specifies the kind of information to display in a tooltip. */ - shared?: boolean; - } - export interface dxChartOptions extends AdvancedOptions { - adaptiveLayout?: { - keepLabels?: boolean; - }; - /** Indicates whether or not to synchronize value axes when they are displayed on a single pane. */ - synchronizeMultiAxes?: boolean; - /** Specifies whether or not to filter the series points depending on their quantity. */ - useAggregation?: boolean; - /** Indicates whether or not to adjust a value axis to the current minimum and maximum values of a zoomed chart. */ - adjustOnZoom?: boolean; - /** Specifies argument axis options for the dxChart widget. */ - argumentAxis?: ChartArgumentAxis; - /** An object defining the configuration options that are common for all axes of the dxChart widget. */ - commonAxisSettings?: ChartCommonAxisSettings; - /** An object defining the configuration options that are common for all panes in the dxChart widget. */ - commonPaneSettings?: CommonPane; - /** An object defining the configuration options that are common for all series of the dxChart widget. */ - commonSeriesSettings?: CommonSeriesSettings; - /** An object that specifies the appearance options of the chart crosshair. */ - crosshair?: { - /** Specifies a color for the crosshair lines. */ - color?: string; - /** Specifies a dash style for the crosshair lines. */ - dashStyle?: string; - /** Specifies whether to enable the crosshair or not. */ - enabled?: boolean; - /** Specifies the opacity of the crosshair lines. */ - opacity?: number; - /** Specifies the width of the crosshair lines. */ - width?: number; - /** Specifies the appearance of the horizontal crosshair line. */ - horizontalLine?: CrosshaierWithLabel; - /** Specifies the appearance of the vertical crosshair line. */ - verticalLine?: CrosshaierWithLabel; - /** Specifies the options of the crosshair labels. */ - label?: { - /** Specifies a color for the background of the crosshair labels. */ - backgroundColor?: string; - /** Specifies whether the crosshair labels are visible or not. */ - visible?: boolean; - /** Specifies font options for the text of the crosshair labels. */ - font?: viz.core.Font; - } - }; - /** Specifies a default pane for the chart's series. */ - defaultPane?: string; - /** Specifies a coefficient determining the diameter of the largest bubble. */ - maxBubbleSize?: number; - /** Specifies the diameter of the smallest bubble measured in pixels. */ - minBubbleSize?: number; - /** Defines the dxChart widget's pane(s). */ - panes?: Array; - /** Swaps the axes round so that the value axis becomes horizontal and the argument axes becomes vertical. */ - rotated?: boolean; - /** Specifies the options of a chart's legend. */ - legend?: Legend; - /** Specifies options for dxChart widget series. */ - series?: Array; - /** Defines options for the series template. */ - seriesTemplate?: SeriesTemplate; - /** Specifies tooltip options. */ - tooltip?: ChartTooltip; - /** Specifies value axis options for the dxChart widget. */ - valueAxis?: Array; - /** Enables scrolling in your chart. */ - scrollingMode?: string; - /** Enables zooming in your chart. */ - zoomingMode?: string; - /** Specifies the settings of the scroll bar. */ - scrollBar?: { - /** Specifies whether the scroll bar is visible or not. */ - visible?: boolean; - /** Specifies the spacing between the scroll bar and the chart's plot in pixels. */ - offset?: number; - /** Specifies the color of the scroll bar. */ - color?: string; - /** Specifies the width of the scroll bar in pixels. */ - width?: number; - /** Specifies the opacity of the scroll bar. */ - opacity?: number; - /** Specifies the position of the scroll bar in the chart. */ - position?: string; - }; - } - /** A widget used to embed charts into HTML JS applications. */ - export class dxChart extends BaseChart { - constructor(element: JQuery, options?: dxChartOptions); - constructor(element: Element, options?: dxChartOptions); - /** Sets the specified start and end values for the chart's argument axis. */ - zoomArgument(startValue: any, endValue: any): void; - } - interface CrosshaierWithLabel extends viz.core.DashedBorderWithOpacity { - /** Configures the label that belongs to the horizontal crosshair line. */ - label?: { - /** Specifies a color for the background of the label that belongs to the horizontal crosshair line. */ - backgroundColor?: string; - /** Specifies whether the label of the horizontal crosshair line is visible or not. */ - visible?: boolean; - /** Specifies font options for the text of the label that belongs to the horizontal crosshair line. */ - font?: viz.core.Font; - } - } - export interface PolarChartTooltip extends BaseChartTooltip { - /** Specifies the kind of information to display in a tooltip. */ - shared?: boolean; - } - export interface dxPolarChartOptions extends AdvancedOptions { - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - width?: number; - height?: number; - /** Specifies whether or not point labels can be hidden when the layout is adapting. */ - keepLabels?: boolean; - }; - /** Indicates whether or not to display a "spider web". */ - useSpiderWeb?: boolean; - /** Specifies argument axis options for the dxPolarChart widget. */ - argumentAxis?: PolarArgumentAxis; - /** An object defining the configuration options that are common for all axes of the dxPolarChart widget. */ - commonAxisSettings?: PolarCommonAxisSettings; - /** An object defining the configuration options that are common for all series of the dxPolarChart widget. */ - commonSeriesSettings?: CommonPolarSeriesSettings; - /** Specifies the options of a chart's legend. */ - legend?: AdvancedLegend; - /** Specifies options for dxPolarChart widget series. */ - series?: Array; - /** Defines options for the series template. */ - seriesTemplate?: PolarSeriesTemplate; - /** Specifies tooltip options. */ - tooltip?: PolarChartTooltip; - /** Specifies value axis options for the dxPolarChart widget. */ - valueAxis?: PolarValueAxis; - } - /** A chart widget displaying data in a polar coordinate system. */ - export class dxPolarChart extends BaseChart { - constructor(element: JQuery, options?: dxPolarChartOptions); - constructor(element: Element, options?: dxPolarChartOptions); - } - export interface PieLegend extends core.BaseLegend { - /** Specifies what chart elements to highlight when a corresponding item in the legend is hovered over. */ - hoverMode?: string; - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item. */ - customizeHint?: (pointInfo: { pointName: string; pointIndex: number; pointColor: string; }) => string; - /** Specifies a callback function that returns the text to be displayed by a legend item. */ - customizeText?: (pointInfo: { pointName: string; pointIndex: number; pointColor: string; }) => string; - } - export interface dxPieChartOptions extends BaseChartOptions { - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - /** Specifies whether or not point labels can be hidden when the layout is adapting. */ - keepLabels?: boolean; - }; - /** Specifies dxPieChart legend options. */ - legend?: PieLegend; - /** Specifies options for the series of the dxPieChart widget. */ - series?: Array; - /** Specifies the diameter of the pie. */ - diameter?: number; - /** Specifies the direction that the pie chart segments will occupy. */ - segmentsDirection?: string; - /** Specifies the starting angle in arc degrees for the first segment in a pie chart. */ - startAngle?: number; - /** Specifies the fraction of the inner radius relative to the total radius in the series of the 'doughnut' type. The value should be between 0 and 1. */ - innerRadius?: number; - /** A handler for the legendClick event. */ - onLegendClick?: any; - /** Specifies how a chart must behave when series point labels overlap. */ - resolveLabelOverlapping?: string; - /** An object defining the configuration options that are common for all series of the dxPieChart widget. */ - commonSeriesSettings?: CommonPieSeriesSettings; - /** Specifies the type of the pie chart series. */ - type?: string; - } - /** A circular chart widget for HTML JS applications. */ - export class dxPieChart extends BaseChart { - constructor(element: JQuery, options?: dxPieChartOptions); - constructor(element: Element, options?: dxPieChartOptions); - /** - * Provides access to the dxPieChart series. - * @deprecated ..\..\BaseChart\3 Methods\getAllSeries().md - */ - getSeries(): PieSeries; - } -} -interface JQuery { - dxChart(options?: DevExpress.viz.charts.dxChartOptions): JQuery; - dxChart(methodName: string, ...params: any[]): any; - dxChart(methodName: "instance"): DevExpress.viz.charts.dxChart; - dxPieChart(options?: DevExpress.viz.charts.dxPieChartOptions): JQuery; - dxPieChart(methodName: string, ...params: any[]): any; - dxPieChart(methodName: "instance"): DevExpress.viz.charts.dxPieChart; - dxPolarChart(options?: DevExpress.viz.charts.dxPolarChartOptions): JQuery; - dxPolarChart(methodName: string, ...params: any[]): any; - dxPolarChart(methodName: "instance"): DevExpress.viz.charts.dxPolarChart; -} -declare namespace DevExpress.viz.gauges { - export interface BaseRangeContainer { - /** Specifies a range container's background color. */ - backgroundColor?: string; - /** Specifies the offset of the range container from an invisible scale line in pixels. */ - offset?: number; - /** Sets the name of the palette or an array of colors to be used for coloring the gauge range container. */ - palette?: any; - /** An array of objects representing ranges contained in the range container. */ - ranges?: Array<{ startValue: number; endValue: number; color: string }>; - /** Specifies a color of a range. */ - color?: string; - /** Specifies an end value of a range. */ - endValue?: number; - /** Specifies a start value of a range. */ - startValue?: number; - } - export interface ScaleTick { - /** Specifies the color of the scale's minor ticks. */ - color?: string; - /** - * Specifies an array of custom minor ticks. - * @deprecated ..\customMinorTicks.md - */ - customTickValues?: Array; - /** Specifies the length of the scale's minor ticks. */ - length?: number; - /** - * Indicates whether automatically calculated minor ticks are visible or not. - * @deprecated This functionality in not more available - */ - showCalculatedTicks?: boolean; - /** - * Specifies an interval between minor ticks. - * @deprecated ..\minorTickInterval.md - */ - tickInterval?: number; - /** Indicates whether scale minor ticks are visible or not. */ - visible?: boolean; - /** Specifies the width of the scale's minor ticks. */ - width?: number; - } - export interface ScaleMajorTick extends ScaleTick { - /** - * Specifies whether or not to expand the current major tick interval if labels overlap each other. - * @deprecated ..\label\overlappingBehavior\useAutoArrangement.md - */ - useTicksAutoArrangement?: boolean; - } - export interface ScaleMinorTick extends ScaleTick { - /** Specifies the opacity of the scale's minor ticks. */ - opacity?: number; - } - export interface BaseScaleLabel { - /** Specifies whether or not scale labels should be colored similarly to their corresponding ranges in the range container. */ - useRangeColors?: boolean; - /** Specifies a callback function that returns the text to be displayed in scale labels. */ - customizeText?: (scaleValue: { value: number; valueText: string }) => string; - /** Specifies the overlap resolving options to be applied to scale labels. */ - overlappingBehavior?: { - /** Specifies whether or not to expand the current major tick interval if labels overlap each other. */ - useAutoArrangement?: boolean; - /** Specifies what label to hide in case of overlapping. */ - hideFirstOrLast?: string; - }; - /** Specifies font options for the text displayed in the scale labels of the gauge. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in scale labels. */ - format?: string; - /** Specifies a precision for the formatted value displayed in the scale labels. */ - precision?: number; - /** Specifies whether or not scale labels are visible on the gauge. */ - visible?: boolean; - } - export interface BaseScale { - /** Specifies the end value for the scale of the gauge. */ - endValue?: number; - /** - * Specifies whether or not to hide the first scale label. - * @deprecated This functionality in not more available - */ - hideFirstLabel?: boolean; - /** - * Specifies whether or not to hide the first major tick on the scale. - * @deprecated This functionality in not more available - */ - hideFirstTick?: boolean; - /** - * Specifies whether or not to hide the last scale label. - * @deprecated This functionality in not more available - */ - hideLastLabel?: boolean; - /** - * Specifies whether or not to hide the last major tick on the scale. - * @deprecated This functionality in not more available - */ - hideLastTick?: boolean; - /** Specifies an interval between major ticks. */ - tickInterval?: number; - /** Specifies an interval between minor ticks. */ - minorTickInterval?: number; - /** Specifies an array of custom major ticks. */ - customTicks?: Array; - /** Specifies an array of custom minor ticks. */ - customMinorTicks?: Array; - /** Specifies common options for scale labels. */ - label?: BaseScaleLabel; - /** - * Specifies options of the gauge's major ticks. - * @deprecated ..\tick\tick.md - */ - majorTick?: ScaleMajorTick; - /** Specifies options of the gauge's major ticks. */ - tick?: { - /** Specifies the color of the scale's major ticks. */ - color?: string; - /** Specifies the length of the scale's major ticks. */ - length?: number; - /** Indicates whether scale major ticks are visible or not. */ - visible?: boolean; - /** Specifies the width of the scale's major ticks. */ - width?: number; - /** Specifies the opacity of the scale's major ticks. */ - opacity?: number; - }; - /** Specifies options of the gauge's minor ticks. */ - minorTick?: ScaleMinorTick; - /** Specifies the start value for the scale of the gauge. */ - startValue?: number; - } - export interface BaseValueIndicator { - /** Specifies the type of subvalue indicators. */ - type?: string; - /** Specifies the background color for the indicator of the rangeBar type. */ - backgroundColor?: string; - /** Specifies the base value for the indicator of the rangeBar type. */ - baseValue?: number; - /** Specifies a color of the indicator. */ - color?: string; - /** Specifies the range bar size for an indicator of the rangeBar type. */ - size?: number; - text?: { - /** Specifies a callback function that returns the text to be displayed in an indicator. */ - customizeText?: (indicatedValue: { value: number; valueText: string }) => string; - font?: viz.core.Font; - /** Specifies a format for the text displayed in an indicator. */ - format?: string; - /** Specifies the range bar's label indent in pixels. */ - indent?: number; - /** Specifies a precision for the formatted value displayed by an indicator. */ - precision?: number; - }; - offset?: number; - length?: number; - width?: number; - /** Specifies the length of an arrow for the indicator of the textCloud type in pixels. */ - arrowLength?: number; - /** Sets the array of colors to be used for coloring subvalue indicators. */ - palette?: Array; - /** Specifies the distance between the needle and the center of a gauge for the indicator of a needle-like type. */ - indentFromCenter?: number; - /** Specifies the second color for the indicator of the twoColorNeedle type. */ - secondColor?: string; - /** Specifies the length of a twoNeedleColor type indicator tip as a percentage. */ - secondFraction?: number; - /** Specifies the spindle's diameter in pixels for the indicator of a needle-like type. */ - spindleSize?: number; - /** Specifies the inner diameter in pixels, so that the spindle has the shape of a ring. */ - spindleGapSize?: number; - /** Specifies the orientation of the rangeBar indicator on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - /** Specifies the orientation of the rangeBar indicator on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - } - export interface SharedGaugeOptions { - /** Specifies animation options. */ - animation?: viz.core.Animation; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */ - redrawOnResize?: boolean; - /** Specifies the size of the widget in pixels. */ - size?: viz.core.Size; - /** - * Specifies a subtitle for the widget. - * @deprecated ..\..\..\BaseGauge\1 Configuration\title\subtitle\subtitle.md - */ - subtitle?: { - /** - * Specifies font options for the subtitle. - * @deprecated ..\..\title\subtitle\font\font.md - */ - font?: viz.core.Font; - /** - * Specifies a text for the subtitle. - * @deprecated ..\title\subtitle\text.md - */ - text?: string; - }; - /** Specifies a title for a gauge. */ - title?: { - /** Specifies font options for the title. */ - font?: viz.core.Font; - /** - * Specifies a title's position on the gauge. - * @deprecated basegaugeoptions_title_verticalAlignment and basegaugeoptions_title_horizontalAlignment - */ - position?: string; - /** Specifies the distance between the title and surrounding gauge elements in pixels. */ - margin?: viz.core.Margins; - /** Specifies the height of the space reserved for the title. */ - placeholderSize?: number; - /** Specifies the gauge title's position in the vertical direction. */ - verticalAlignment?: string; - /** Specifies the gauge title's horizontal position. */ - horizontalAlignment?: string; - /** Specifies text for the title. */ - text?: string; - /** Specifies a subtitle for the widget. */ - subtitle?: { - /** Specifies font options for the subtitle. */ - font?: viz.core.Font; - /** Specifies text for the subtitle. */ - text?: string; - } - }; - /** Specifies options for gauge tooltips. */ - tooltip?: viz.core.Tooltip; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: dxBaseGauge; - element: Element; - target: {}; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: dxBaseGauge; - element: Element; - target: {}; - }) => void; - } - export interface BaseGaugeOptions extends viz.core.BaseWidgetOptions, SharedGaugeOptions { - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** Specifies the blank space in pixels between the widget's extreme elements and the boundaries of the area provided for the widget (see the size option). */ - margin?: viz.core.Margins; - /** Specifies options of the gauge's range container. */ - rangeContainer?: BaseRangeContainer; - /** Specifies a gauge's scale options. */ - scale?: BaseScale; - /** Specifies the appearance options of subvalue indicators. */ - subvalueIndicator?: BaseValueIndicator; - /** Specifies a set of subvalues to be designated by the subvalue indicators. */ - subvalues?: Array; - /** Specifies the main value on a gauge. */ - value?: number; - /** Specifies the appearance options of the value indicator. */ - valueIndicator?: BaseValueIndicator; - } - /** A gauge widget. */ - export class dxBaseGauge extends viz.core.BaseWidget { - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(): void; - /** Returns the main gauge value. */ - value(): number; - /** Updates a gauge value. */ - value(value: number): void; - /** Returns an array of gauge subvalues. */ - subvalues(): Array; - /** Updates gauge subvalues. */ - subvalues(subvalues: Array): void; - } - export interface LinearRangeContainer extends BaseRangeContainer { - /** Specifies the orientation of the range container on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - /** Specifies the orientation of a range container on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - /** Specifies the width of the range container's start and end boundaries in the dxLinearGauge widget. */ - width?: any; - /** Specifies an end width of a range container. */ - end?: number; - /** Specifies a start width of a range container. */ - start?: number; - } - export interface LinearScaleLabel extends BaseScaleLabel { - /** Specifies the spacing between scale labels and ticks. */ - indentFromTick?: number; - } - export interface LinearScale extends BaseScale { - /** Specifies the orientation of scale ticks on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - label?: LinearScaleLabel; - /** Specifies the orientation of scale ticks on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - } - export interface dxLinearGaugeOptions extends BaseGaugeOptions { - /** Specifies the options required to set the geometry of the dxLinearGauge widget. */ - geometry?: { - /** Indicates whether to display the dxLinearGauge widget vertically or horizontally. */ - orientation?: string; - }; - /** Specifies gauge range container options. */ - rangeContainer?: LinearRangeContainer; - scale?: LinearScale; - } - /** A widget that represents a gauge with a linear scale. */ - export class dxLinearGauge extends dxBaseGauge { - constructor(element: JQuery, options?: dxLinearGaugeOptions); - constructor(element: Element, options?: dxLinearGaugeOptions); - } - export interface CircularRangeContainer extends BaseRangeContainer { - /** Specifies the orientation of the range container in the dxCircularGauge widget. */ - orientation?: string; - /** Specifies the range container's width in pixels. */ - width?: number; - } - export interface CircularScaleLabel extends BaseScaleLabel { - /** Specifies the spacing between scale labels and ticks. */ - indentFromTick?: number; - } - export interface CircularScale extends BaseScale { - label?: CircularScaleLabel; - /** Specifies the orientation of scale ticks. */ - orientation?: string; - } - export interface dxCircularGaugeOptions extends BaseGaugeOptions { - /** Specifies the options required to set the geometry of the dxCircularGauge widget. */ - geometry?: { - /** Specifies the end angle of the circular gauge's arc. */ - endAngle?: number; - /** Specifies the start angle of the circular gauge's arc. */ - startAngle?: number; - }; - /** Specifies gauge range container options. */ - rangeContainer?: CircularRangeContainer; - scale?: CircularScale; - } - /** A widget that represents a gauge with a circular scale. */ - export class dxCircularGauge extends dxBaseGauge { - constructor(element: JQuery, options?: dxCircularGaugeOptions); - constructor(element: Element, options?: dxCircularGaugeOptions); - } - export interface dxBarGaugeOptions extends viz.core.BaseWidgetOptions, SharedGaugeOptions { - /** Specifies a color for the remaining segment of the bar's track. */ - backgroundColor?: string; - /** Specifies a distance between bars in pixels. */ - barSpacing?: number; - /** Specifies a base value for bars. */ - baseValue?: number; - /** Specifies an end value for the gauge's invisible scale. */ - endValue?: number; - /** Defines the shape of the gauge's arc. */ - geometry?: { - /** Specifies the end angle of the bar gauge's arc. */ - endAngle?: number; - /** Specifies the start angle of the bar gauge's arc. */ - startAngle?: number; - }; - /** Specifies the options of the labels that accompany gauge bars. */ - label?: { - /** Specifies a color for the label connector text. */ - connectorColor?: string; - /** Specifies the width of the label connector in pixels. */ - connectorWidth?: number; - /** Specifies a callback function that returns a text for labels. */ - customizeText?: (barValue: { value: number; valueText: string }) => string; - /** Specifies font options for bar labels. */ - font?: viz.core.Font; - /** Specifies a format for bar labels. */ - format?: string; - /** Specifies the distance between the upper bar and bar labels in pixels. */ - indent?: number; - /** Specifies a precision for the formatted value displayed by labels. */ - precision?: number; - /** Specifies whether bar labels appear on a gauge or not. */ - visible?: boolean; - }; - /** Sets the name of the palette or an array of colors to be used for coloring the gauge range container. */ - palette?: string; - /** Defines the radius of the bar that is closest to the center relatively to the radius of the topmost bar. */ - relativeInnerRadius?: number; - /** Specifies a start value for the gauge's invisible scale. */ - startValue?: number; - /** Specifies the array of values to be indicated on a bar gauge. */ - values?: Array; - } - /** A circular bar widget. */ - export class dxBarGauge extends viz.core.BaseWidget { - constructor(element: JQuery, options?: dxBarGaugeOptions); - constructor(element: Element, options?: dxBarGaugeOptions); - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws the widget. */ - render(): void; - /** Returns an array of gauge values. */ - values(): Array; - /** Updates the values displayed by a gauge. */ - values(values: Array): void; - } -} -interface JQuery { - dxLinearGauge(options?: DevExpress.viz.gauges.dxLinearGaugeOptions): JQuery; - dxLinearGauge(methodName: string, ...params: any[]): any; - dxLinearGauge(methodName: "instance"): DevExpress.viz.gauges.dxLinearGauge; - dxCircularGauge(options?: DevExpress.viz.gauges.dxCircularGaugeOptions): JQuery; - dxCircularGauge(methodName: string, ...params: any[]): any; - dxCircularGauge(methodName: "instance"): DevExpress.viz.gauges.dxCircularGauge; - dxBarGauge(options?: DevExpress.viz.gauges.dxBarGaugeOptions): JQuery; - dxBarGauge(methodName: string, ...params: any[]): any; - dxBarGauge(methodName: "instance"): DevExpress.viz.gauges.dxBarGauge; -} -declare namespace DevExpress.viz.rangeSelector { - export interface dxRangeSelectorOptions extends viz.core.BaseWidgetOptions { - /** Specifies the options for the range selector's background. */ - background?: { - /** Specifies the background color for the dxRangeSelector. */ - color?: string; - /** Specifies image options. */ - image?: { - /** Specifies a location for the image in the background of a range selector. */ - location?: string; - /** Specifies the image's URL. */ - url?: string; - }; - /** Indicates whether or not the background (background color and/or image) is visible. */ - visible?: boolean; - }; - /** Specifies a title for the range selector. */ - title?: viz.core.Title; - /** Specifies the dxRangeSelector's behavior options. */ - behavior?: { - /** Indicates whether or not you can swap sliders. */ - allowSlidersSwap?: boolean; - /** Indicates whether or not animation is enabled. */ - animationEnabled?: boolean; - /** Specifies when to call the onSelectedRangeChanged function. */ - callSelectedRangeChanged?: string; - /** Indicates whether or not an end user can specify the range using a mouse, without the use of sliders. */ - manualRangeSelectionEnabled?: boolean; - /** Indicates whether or not an end user can shift the selected range to the required location on a scale by clicking. */ - moveSelectedRangeByClick?: boolean; - /** Indicates whether to snap a slider to ticks. */ - snapToTicks?: boolean; - }; - /** Specifies the options required to display a chart as the range selector's background. */ - chart?: { - /** Specifies a coefficient for determining an indent from the bottom background boundary to the lowest chart point. */ - bottomIndent?: number; - /** An object defining the common configuration options for the chart’s series. */ - commonSeriesSettings?: viz.charts.CommonSeriesSettings; - /** An object providing options for managing data from a data source. */ - dataPrepareSettings?: { - /** Specifies whether or not to validate values from a data source. */ - checkTypeForAllData?: boolean; - /** Specifies whether or not to convert the values from a data source into the data type of an axis. */ - convertToAxisDataType?: boolean; - /** Specifies how to sort series points. */ - sortingMethod?: any; - }; - /** Specifies whether all bars in a series must have the same width, or may have different widths if any points in other series are missing. */ - equalBarWidth?: boolean; - /** Specifies a common bar width as a percentage from 0 to 1. */ - barWidth?: number; - /** Sets the name of the palette to be used in the range selector's chart. Alternatively, an array of colors can be set as a custom palette to be used within this chart. */ - palette?: any; - /** An object defining the chart’s series. */ - series?: Array; - /** Defines options for the series template. */ - seriesTemplate?: viz.charts.SeriesTemplate; - /** Specifies a coefficient for determining an indent from the background's top boundary to the topmost chart point. */ - topIndent?: number; - /** Specifies whether or not to filter the series points depending on their quantity. */ - useAggregation?: boolean; - /** Specifies options for the chart's value axis. */ - valueAxis?: { - /** Indicates whether or not the chart's value axis must be inverted. */ - inverted?: boolean; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic value axis. */ - logarithmBase?: number; - /** Specifies the maximum value of the chart's value axis. */ - max?: number; - /** Specifies the minimum value of the chart's value axis. */ - min?: number; - /** Specifies the type of the value axis. */ - type?: string; - /** Specifies the desired type of axis values. */ - valueType?: string; - }; - }; - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** Specifies a data source for the scale values and for the chart at the background. */ - dataSource?: any; - /** Specifies the data source field that provides data for the scale. */ - dataSourceField?: string; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies the blank space in pixels between the dxRangeSelector widget's extreme elements and the boundaries of the area provided for the widget (see size). */ - margin?: viz.core.Margins; - /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */ - redrawOnResize?: boolean; - /** Specifies options of the range selector's scale. */ - scale?: { - /** Specifies the scale's end value. */ - endValue?: any; - /** Specifies common options for scale labels. */ - label?: { - /** Specifies a callback function that returns the text to be displayed in scale labels. */ - customizeText?: (scaleValue: { value: any; valueText: string; }) => string; - /** Specifies font options for the text displayed in the range selector's scale labels. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in scale labels. */ - format?: string; - /** Specifies a precision for the formatted value displayed in the scale labels. */ - precision?: number; - /** Specifies a spacing between scale labels and the background bottom edge. */ - topIndent?: number; - /** Specifies whether or not the scale's labels are visible. */ - visible?: boolean; - }; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic scale. */ - logarithmBase?: number; - /** - * Specifies an interval between major ticks. - * @deprecated ..\tickInterval\tickInterval.md - */ - majorTickInterval?: any; - tickInterval?: any; - /** Specifies options for the date-time scale's markers. */ - marker?: { - /** Defines the options that can be set for the text that is displayed by the scale markers. */ - label?: { - /** Specifies a callback function that returns the text to be displayed in scale markers. */ - customizeText?: (markerValue: { value: any; valueText: string }) => string; - /** Specifies a format for the text displayed in scale markers. */ - format?: string; - }; - /** Specifies the height of the marker's separator. */ - separatorHeight?: number; - /** Specifies the space between the marker label and the marker separator. */ - textLeftIndent?: number; - /** Specifies the space between the marker's label and the top edge of the marker's separator. */ - textTopIndent?: number; - /** Specified the indent between the marker and the scale lables. */ - topIndent?: number; - /** Indicates whether scale markers are visible. */ - visible?: boolean; - }; - /** Specifies the maximum range that can be selected. */ - maxRange?: any; - /** Specifies the number of minor ticks between neighboring major ticks. */ - minorTickCount?: number; - /** Specifies an interval between minor ticks. */ - minorTickInterval?: any; - /** Specifies the minimum range that can be selected. */ - minRange?: any; - /** Specifies the height of the space reserved for the scale in pixels. */ - placeholderHeight?: number; - /** Indicates whether or not to set ticks of a date-time scale at the beginning of each date-time interval. */ - setTicksAtUnitBeginning?: boolean; - /** Specifies whether or not to show ticks for the boundary scale values, when neither major ticks nor minor ticks are created for these values. */ - showCustomBoundaryTicks?: boolean; - /** - * Indicates whether or not to show minor ticks on the scale. - * @deprecated minorTick\visible.md - */ - showMinorTicks?: boolean; - /** Specifies the scale's start value. */ - startValue?: any; - /** Specifies options defining the appearance of scale ticks. */ - tick?: { - /** Specifies the color of scale ticks (both major and minor ticks). */ - color?: string; - /** Specifies the opacity of scale ticks (both major and minor ticks). */ - opacity?: number; - /** Specifies the width of the scale's ticks (both major and minor ticks). */ - width?: number; - }; - minorTick?: { - color?: string; - opacity?: number; - width?: number; - visible?: boolean; - }; - /** Specifies the type of the scale. */ - type?: string; - /** Specifies whether or not to expand the current tick interval if labels overlap each other. */ - useTicksAutoArrangement?: boolean; - /** Specifies the type of values on the scale. */ - valueType?: string; - /** Specifies the order of arguments on a discrete scale. */ - categories?: Array; - }; - /** Specifies the range to be selected when displaying the dxRangeSelector. */ - selectedRange?: { - /** Specifies the start value of the range to be selected when displaying the dxRangeSelector widget on a page. */ - startValue?: any; - /** Specifies the end value of the range to be selected when displaying the dxRangeSelector widget on a page. */ - endValue?: any; - }; - /** Specifies the color of the selected range. */ - selectedRangeColor?: string; - /** Range selector's indent options. */ - indent?: { - /** Specifies range selector's left indent. */ - left?: number; - /** Specifies range selector's right indent. */ - right?: number; - }; - /** A handler for the selectedRangeChanged event. */ - onSelectedRangeChanged?: (e: { - startValue: any; - endValue: any; - component: dxRangeSelector; - element: Element; - }) => void; - /** Specifies range selector shutter options. */ - shutter?: { - /** Specifies shutter color. */ - color?: string; - /** Specifies the opacity of the color of shutters. */ - opacity?: number; - }; - /** Specifies in pixels the size of the dxRangeSelector widget. */ - size?: viz.core.Size; - /** Specifies the appearance of the range selector's slider handles. */ - sliderHandle?: { - /** Specifies the color of the slider handles. */ - color?: string; - /** Specifies the opacity of the slider handles. */ - opacity?: number; - /** Specifies the width of the slider handles. */ - width?: number; - }; - /** Defines the options of the range selector slider markers. */ - sliderMarker?: { - /** Specifies the color of the slider markers. */ - color?: string; - /** Specifies a callback function that returns the text to be displayed by slider markers. */ - customizeText?: (scaleValue: { value: any; valueText: any; }) => string; - /** Specifies font options for the text displayed by the range selector slider markers. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in slider markers. */ - format?: string; - /** Specifies the color used for the slider marker text when the currently selected range does not match the minRange and maxRange values. */ - invalidRangeColor?: string; - /** - * Specifies the empty space between the marker's border and the marker’s text. - * @deprecated Use the 'paddingTopBottom' and 'paddingLeftRight' options instead - */ - padding?: number; - /** Specifies the empty space between the marker's top and bottom borders and the marker's text. */ - paddingTopBottom?: number; - /** Specifies the empty space between the marker's left and right borders and the marker's text. */ - paddingLeftRight?: number; - /** Specifies the placeholder height of the slider marker. */ - placeholderHeight?: number; - /** - * Specifies in pixels the height and width of the space reserved for the range selector slider markers. - * @deprecated Use the 'placeholderHeight' and 'indent' options instead - */ - placeholderSize?: { - /** Specifies the height of the placeholder for the left and right slider markers. */ - height?: number; - /** Specifies the width of the placeholder for the left and right slider markers. */ - width?: { - /** Specifies the width of the left slider marker's placeholder. */ - left?: number; - /** Specifies the width of the right slider marker's placeholder. */ - right?: number; - }; - }; - /** Specifies a precision for the formatted value displayed in slider markers. */ - precision?: number; - /** Indicates whether or not the slider markers are visible. */ - visible?: boolean; - }; - } - /** A widget that allows end users to select a range of values on a scale. */ - export class dxRangeSelector extends viz.core.BaseWidget { - constructor(element: JQuery, options?: dxRangeSelectorOptions); - constructor(element: Element, options?: dxRangeSelectorOptions); - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(skipChartAnimation?: boolean): void; - /** Returns the currently selected range. */ - getSelectedRange(): { startValue: any; endValue: any; }; - /** Sets a specified range. */ - setSelectedRange(selectedRange: { startValue: any; endValue: any; }): void; - } -} -interface JQuery { - dxRangeSelector(options?: DevExpress.viz.rangeSelector.dxRangeSelectorOptions): JQuery; - dxRangeSelector(methodName: string, ...params: any[]): any; - dxRangeSelector(methodName: "instance"): DevExpress.viz.rangeSelector.dxRangeSelector; -} -declare namespace DevExpress.viz.map { - /** This section describes the fields and methods that can be used in code to manipulate the Layer object. */ - export interface MapLayer { - /** The name of the layer. */ - name: string; - /** The layer index in the layers array. */ - index: number; - /** The layer type. Can be "area", "line" or "marker". */ - type: string; - /** The type of the layer elements. */ - elementType: string; - /** Gets all layer elements. */ - getElements(): Array; - /** Deselects all layer elements. */ - clearSelection(): void; - } - /** This section describes the fields and methods that can be used in code to manipulate the Layer Element object. */ - export interface MapLayerElement { - /** The parent layer of the layer element. */ - layer: MapLayer; - /** Gets the layer element coordinates. */ - coordinates(): Object; - /** Sets the value of an attribute. */ - attribute(name: string, value: any): void; - /** Gets the value of an attribute. */ - attribute(name: string): any; - /** Gets the selection state of the layer element. */ - selected(): boolean; - /** Sets the selection state of the layer element. */ - selected(state: boolean): void; - /** Applies the layer element settings and updates element appearance. */ - applySettings(settings: any): void; - } - /** - * This section describes the fields and methods that can be used in code to manipulate the Area object. - * @deprecated Use the "Layer Element" instead - */ - export interface Area { - /** - * Contains the element type. - * @deprecated ..\..\Layer\2 Fields\type.md - */ - type: string; - /** - * Return the value of an attribute. - * @deprecated ..\..\Layer Element\3 Methods\attribute(name_value).md - */ - attribute(name: string): any; - /** - * Provides information about the selection state of an area. - * @deprecated Use the "selected()" method of the Layer Element - */ - selected(): boolean; - /** - * Sets a new selection state for an area. - * @deprecated Use the "selected(state)" method of the Layer Element - */ - selected(state: boolean): void; - /** - * Applies the area settings specified as a parameter and updates the area appearance. - * @deprecated ..\..\Layer Element\3 Methods\applySettings(settings).md - */ - applySettings(settings: any): void; - } - /** - * This section describes the fields and methods that can be used in code to manipulate the Markers object. - * @deprecated Use the "Layer Element" instead - */ - export interface Marker { - /** - * Contains the descriptive text accompanying the map marker. - * @deprecated Get the text with the "attribute" method (using the "layers.label.dataField" value) - */ - text: string; - /** - * Contains the type of the element. - * @deprecated ..\..\Layer\2 Fields\type.md - */ - type: string; - /** - * Contains the URL of an image map marker. - * @deprecated Get the url with the "attribute" method (using the "layers.dataField" value) - */ - url: string; - /** - * Contains the value of a bubble map marker. - * @deprecated Get the value with the "attribute" method (using the "layers.dataField" value) - */ - value: number; - /** - * Contains the values of a pie map marker. - * @deprecated Get the values with the "attribute" method (using the "layers.dataField" value) - */ - values: Array; - /** - * Returns the value of an attribute. - * @deprecated ..\..\Layer Element\3 Methods\attribute(name_value).md - */ - attribute(name: string): any; - /** - * Returns the coordinates of a specific marker. - * @deprecated ..\..\Layer Element\3 Methods\coordinates().md - */ - coordinates(): Array; - /** - * Provides information about the selection state of a marker. - * @deprecated Use the "selected()" method of the Layer Element - */ - selected(): boolean; - /** - * Sets a new selection state for a marker. - * @deprecated Use the "selected(state)" method of the Layer Element - */ - selected(state: boolean): void; - /** - * Applies the marker settings specified as a parameter and updates marker appearance. - * @deprecated ..\..\Layer Element\3 Methods\applySettings(settings).md - */ - applySettings(settings: any): void; - } - export interface MapLayerSettings { - /** Specifies the layer name. */ - name?: string; - /** Specifies layer type. */ - type?: string; - /** Specifies the type of a marker element. Setting this option makes sense only if the layer type is "marker". */ - elementType?: string; - /** Specifies a data source for the layer. */ - data?: any; - /** Specifies the width of the layer elements border in pixels. */ - borderWidth?: number; - /** Specifies a color for the border of the layer elements. */ - borderColor?: string; - /** Specifies a color for layer elements. */ - color?: string; - /** Specifies a color for the border of the layer element when it is hovered over. */ - hoveredBorderColor?: string; - /** Specifies the pixel-measured width for the border of the layer element when it is hovered over. */ - hoveredBorderWidth?: number; - /** Specifies a color for a layer element when it is hovered over. */ - hoveredColor?: string; - /** Specifies a pixel-measured width for the border of the layer element when it is selected. */ - selectedBorderWidth?: number; - /** Specifies a color for the border of the layer element when it is selected. */ - selectedBorderColor?: string; - /** Specifies a color for the layer element when it is selected. */ - selectedColor?: string; - /** Specifies the layer opacity (from 0 to 1). */ - opacity?: number; - /** Specifies the size of markers. Setting this option makes sense only if the layer type is "marker" and the elementType is "dot", "pie" or "image". */ - size?: number; - /** Specifies the pixel-measured diameter of the marker that represents the smallest value. Setting this option makes sense only if the layer type is "marker". */ - minSize?: number; - /** Specifies the pixel-measured diameter of the marker that represents the biggest value. Setting this option makes sense only if the layer type is "marker". */ - maxSize?: number; - /** Specifies whether or not to change the appearance of a layer element when it is hovered over. */ - hoverEnabled?: boolean; - /** Specifies whether single or multiple map elements can be selected on a vector map. */ - selectionMode?: string; - /** Specifies the name of the palette or a custom range of colors to be used for coloring a layer. */ - palette?: any; - /** Specifies the number of colors in a palette. */ - paletteSize?: number; - /** Allows you to paint layer elements with similar attributes in the same color. */ - colorGroups?: Array; - /** Specifies the field that provides data to be used for coloring of layer elements. */ - colorGroupingField?: string; - /** Allows you to display bubbles with similar attributes in the same size. Setting this option makes sense only if the layer type is "marker" and the elementType is "bubble". */ - sizeGroups?: Array; - /** Specifies the field that provides data to be used for sizing bubble markers. Setting this option makes sense only if the layer type is "marker" and the elementType is "bubble". */ - sizeGroupingField?: string; - /** Specifies the name of the attribute containing marker data. Setting this option makes sense only if the layer type is "marker" and the elementType is "bubble", "pie" or "image". */ - dataField?: string; - /** Specifies the function that customizes each layer element individually. */ - customize?: (eleemnts: Array) => void; - /** Specifies marker label options. */ - label?: { - /** The name of the data attribute containing marker texts. */ - dataField?: string; - /** Enables marker labels. */ - enabled?: boolean; - /** Specifies font options for marker labels. */ - font?: viz.core.Font; - }; - } - export interface AreaSettings { - /** - * Specifies the width of the area border in pixels. - * @deprecated ..\layers\borderWidth.md - */ - borderWidth?: number; - /** - * Specifies a color for the area border. - * @deprecated ..\layers\borderColor.md - */ - borderColor?: string; - /** - * Specifies a color for an area. - * @deprecated ..\layers\color.md - */ - color?: string; - /** - * Specifies the function that customizes each area individually. - * @deprecated ..\layers\customize.md - */ - customize?: (areaInfo: Area) => AreaSettings; - /** - * Specifies a color for the area border when the area is hovered over. - * @deprecated ..\layers\hoveredBorderColor.md - */ - hoveredBorderColor?: string; - /** - * Specifies the pixel-measured width of the area border when the area is hovered over. - * @deprecated ..\layers\hoveredBorderWidth.md - */ - hoveredBorderWidth?: number; - /** - * Specifies a color for an area when this area is hovered over. - * @deprecated ..\layers\hoveredColor.md - */ - hoveredColor?: string; - /** - * Specifies whether or not to change the appearance of an area when it is hovered over. - * @deprecated ..\layers\hoverEnabled.md - */ - hoverEnabled?: boolean; - /** - * Configures area labels. - * @deprecated ..\..\layers\label\label.md - */ - label?: { - /** - * Specifies the data field that provides data for area labels. - * @deprecated ..\..\layers\label\dataField.md - */ - dataField?: string; - /** - * Enables area labels. - * @deprecated ..\..\layers\label\enabled.md - */ - enabled?: boolean; - /** - * Specifies font options for area labels. - * @deprecated ..\..\..\layers\label\font\font.md - */ - font?: viz.core.Font; - }; - /** - * Specifies the name of the palette or a custom range of colors to be used for coloring a map. - * @deprecated ..\layers\palette.md - */ - palette?: any; - /** - * Specifies the number of colors in a palette. - * @deprecated ..\layers\paletteSize.md - */ - paletteSize?: number; - /** - * Allows you to paint areas with similar attributes in the same color. - * @deprecated ..\layers\colorGroups.md - */ - colorGroups?: Array; - /** - * Specifies the field that provides data to be used for coloring areas. - * @deprecated ..\layers\colorGroupingField.md - */ - colorGroupingField?: string; - /** - * Specifies a color for the area border when the area is selected. - * @deprecated ..\layers\selectedBorderColor.md - */ - selectedBorderColor?: string; - /** - * Specifies a color for an area when this area is selected. - * @deprecated ..\layers\selectedColor.md - */ - selectedColor?: string; - /** - * Specifies the pixel-measured width of the area border when the area is selected. - * @deprecated ..\layers\selectedBorderWidth.md - */ - selectedBorderWidth?: number; - /** - * Specifies whether single or multiple areas can be selected on a vector map. - * @deprecated ..\layers\selectionMode.md - */ - selectionMode?: string; - } - export interface MarkerSettings { - /** - * Specifies a color for the marker border. - * @deprecated ..\layers\borderColor.md - */ - borderColor?: string; - /** - * Specifies the width of the marker border in pixels. - * @deprecated ..\layers\borderWidth.md - */ - borderWidth?: number; - /** - * Specifies a color for a marker of the dot or bubble type. - * @deprecated ..\layers\color.md - */ - color?: string; - /** - * Specifies the function that customizes each marker individually. - * @deprecated ..\layers\customize.md - */ - customize?: (markerInfo: Marker) => MarkerSettings; - /** - * Specifies the pixel-measured width of the marker border when the marker is hovered over. - * @deprecated ..\layers\hoveredBorderWidth.md - */ - hoveredBorderWidth?: number; - /** - * Specifies a color for the marker border when the marker is hovered over. - * @deprecated ..\layers\hoveredBorderColor.md - */ - hoveredBorderColor?: string; - /** - * Specifies a color for a marker of the dot or bubble type when this marker is hovered over. - * @deprecated ..\layers\hoveredColor.md - */ - hoveredColor?: string; - /** - * Specifies whether or not to change the appearance of a marker when it is hovered over. - * @deprecated ..\layers\hoverEnabled.md - */ - hoverEnabled?: boolean; - /** - * Specifies marker label options. - * @deprecated ..\..\layers\label\label.md - */ - label?: { - /** - * Enables marker labels. - * @deprecated ..\..\layers\label\enabled.md - */ - enabled?: boolean; - /** - * Specifies font options for marker labels. - * @deprecated ..\..\..\layers\label\font\font.md - */ - font?: viz.core.Font; - }; - /** - * Specifies the pixel-measured diameter of the marker that represents the biggest value. Setting this option makes sense only if you use markers of the bubble type. - * @deprecated ..\layers\maxSize.md - */ - maxSize?: number; - /** - * Specifies the pixel-measured diameter of the marker that represents the smallest value. Setting this option makes sense only if you use markers of the bubble type. - * @deprecated ..\layers\minSize.md - */ - minSize?: number; - /** - * Specifies the opacity of markers. Setting this option makes sense only if you use markers of the bubble type. - * @deprecated ..\layers\opacity.md - */ - opacity?: number; - /** - * Specifies the pixel-measured width of the marker border when the marker is selected. - * @deprecated ..\layers\selectedBorderWidth.md - */ - selectedBorderWidth?: number; - /** - * Specifies a color for the marker border when the marker is selected. - * @deprecated ..\layers\selectedBorderColor.md - */ - selectedBorderColor?: string; - /** - * Specifies a color for a marker of the dot or bubble type when this marker is selected. - * @deprecated ..\layers\selectedColor.md - */ - selectedColor?: string; - /** - * Specifies whether a single or multiple markers can be selected on a vector map. - * @deprecated ..\layers\selectionMode.md - */ - selectionMode?: string; - /** - * Specifies the size of markers. Setting this option makes sense for any type of marker except bubble. - * @deprecated ..\layers\size.md - */ - size?: number; - /** - * Specifies the type of markers to be used on the map. - * @deprecated ..\layers\elementType.md - */ - type?: string; - /** - * Specifies the name of a palette or a custom set of colors to be used for coloring markers of the pie type. - * @deprecated ..\layers\palette.md - */ - palette?: any; - /** - * Allows you to paint markers with similar attributes in the same color. - * @deprecated ..\layers\colorGroups.md - */ - colorGroups?: Array; - /** - * Specifies the field that provides data to be used for coloring markers. - * @deprecated ..\layers\colorGroupingField.md - */ - colorGroupingField?: string; - /** - * Allows you to display bubbles with similar attributes in the same size. - * @deprecated ..\layers\sizeGroups.md - */ - sizeGroups?: Array; - /** - * Specifies the field that provides data to be used for sizing bubble markers. - * @deprecated ..\layers\sizeGroupingField.md - */ - sizeGroupingField?: string; - } - export interface dxVectorMapOptions extends viz.core.BaseWidgetOptions { - /** - * An object specifying options for the map areas. - * @deprecated Use the 'layers' option instead - */ - areaSettings?: AreaSettings; - /** Specifies the options for the map background. */ - background?: { - /** Specifies a color for the background border. */ - borderColor?: string; - /** Specifies a color for the background. */ - color?: string; - }; - /** Specifies options for dxVectorMap widget layers. */ - layers?: Array; - /** Specifies the map projection. */ - projection?: Object; - /** Specifies the positioning of a map in geographical coordinates. */ - bounds?: Array; - /** Specifies the options of the control bar. */ - controlBar?: { - /** Specifies a color for the outline of the control bar elements. */ - borderColor?: string; - /** Specifies a color for the inner area of the control bar elements. */ - color?: string; - /** Specifies whether or not to display the control bar. */ - enabled?: boolean; - /** Specifies the margin of the control bar in pixels. */ - margin?: number; - /** Specifies the position of the control bar. */ - horizontalAlignment?: string; - /** Specifies the position of the control bar. */ - verticalAlignment?: string; - /** Specifies the opacity of the Control_Bar. */ - opacity?: number; - }; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** - * Specifies a data source for the map area. - * @deprecated Use the 'layers.data' option instead - */ - mapData?: any; - /** - * Specifies a data source for the map markers. - * @deprecated Use the 'layers.data' option instead - */ - markers?: any; - /** - * An object specifying options for the map markers. - * @deprecated Use the 'layers' option instead - */ - markerSettings?: MarkerSettings; - /** Specifies the size of the dxVectorMap widget. */ - size?: viz.core.Size; - /** Specifies a title for the vector map. */ - title?: viz.core.Title; - /** Specifies tooltip options. */ - tooltip?: viz.core.Tooltip; - /** Configures map legends. */ - legends?: Array; - /** Specifies whether or not the map should respond when a user rolls the mouse wheel. */ - wheelEnabled?: boolean; - /** Specifies whether the map should respond to touch gestures. */ - touchEnabled?: boolean; - /** Disables the zooming capability. */ - zoomingEnabled?: boolean; - /** Specifies the geographical coordinates of the center for a map. */ - center?: Array; - /** A handler for the centerChanged event. */ - onCenterChanged?: (e: { - center: Array; - component: dxVectorMap; - element: Element; - }) => void; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: dxVectorMap; - element: Element; - target: {}; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: dxVectorMap; - element: Element; - target: {}; - }) => void; - /** Specifies a number that is used to zoom a map initially. */ - zoomFactor?: number; - /** Specifies a map's maximum zoom factor. */ - maxZoomFactor?: number; - /** A handler for the zoomFactorChanged event. */ - onZoomFactorChanged?: (e: { - component: dxVectorMap; - element: Element; - zoomFactor: number; - }) => void; - /** A handler for the click event. */ - onClick?: any; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: (e: { - component: dxVectorMap; - element: Element; - target: MapLayerElement; - }) => void; - /** - * A handler for the areaClick event. - * @deprecated Use the 'onClick' option instead - */ - onAreaClick?: any; - /** - * A handler for the areaSelectionChanged event. - * @deprecated Use the 'onSelectionChanged' option instead - */ - onAreaSelectionChanged?: (e: { - target: Area; - component: dxVectorMap; - element: Element; - }) => void; - /** - * A handler for the markerClick event. - * @deprecated Use the 'onClick' option instead - */ - onMarkerClick?: any; - /** - * A handler for the markerSelectionChanged event. - * @deprecated Use the 'onSelecitonChanged' option instead - */ - onMarkerSelectionChanged?: (e: { - target: Marker; - component: dxVectorMap; - element: Element; - }) => void; - /** Disables the panning capability. */ - panningEnabled?: boolean; - } - export interface Legend extends viz.core.BaseLegend { - /** Specifies the color of item markers in the legend. The specified color applied only when the legend uses 'size' source. */ - markerColor?: string; - /** Specifies text for legend items. */ - customizeText?: (itemInfo: { start: number; end: number; index: number; color: string; size: number; }) => string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the text of a legend item. */ - customizeHint?: (itemInfo: { start: number; end: number; index: number; color: string; size: number }) => string; - /** Specifies the source of data for the legend. */ - source?: { - /** Specifies a layer to which the legend belongs. */ - layer?: string; - /** Specifies the type of the legend grouping. */ - grouping?: string; - } - } - /** A vector map widget. */ - export class dxVectorMap extends viz.core.BaseWidget { - constructor(element: JQuery, options?: dxVectorMapOptions); - constructor(element: Element, options?: dxVectorMapOptions); - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(): void; - /** Gets the current coordinates of the map center. */ - center(): Array; - /** Sets the coordinates of the map center. */ - center(centerCoordinates: Array): void; - /** - * Deselects all the selected areas on a map. The areas are displayed in their initial style after. - * @deprecated Use the 'clearSelection' method on a layer instead - */ - clearAreaSelection(): void; - /** - * Deselects all the selected markers on a map. The markers are displayed in their initial style after. - * @deprecated Use the 'clearSelection' method on a layer instead - */ - clearMarkerSelection(): void; - /** Deselects all the selected area and markers on a map at once. The areas and markers are displayed in their initial style after. */ - clearSelection(): void; - /** Converts client area coordinates into map coordinates. */ - convertCoordinates(x: number, y: number): Array; - /** Gets all map layers. */ - getLayers(): Array; - /** Gets the layer by its index. */ - getLayerByIndex(index: number): MapLayer; - /** Gets the layer by its name. */ - getLayerByName(name: string): MapLayer; - /** - * Returns an array with all the map areas. - * @deprecated Use the 'getElements' method on a layer instead - */ - getAreas(): Array; - /** - * Returns an array with all the map markers. - * @deprecated Use the 'getElements' method on a layer instead - */ - getMarkers(): Array; - /** Gets the current coordinates of the map viewport. */ - viewport(): Array; - /** Sets the coordinates of the map viewport. */ - viewport(viewportCoordinates: Array): void; - /** Gets the current value of the map zoom factor. */ - zoomFactor(): number; - /** Sets the value of the map zoom factor. */ - zoomFactor(zoomFactor: number): void; - } - export var projection: ProjectionCreator; - export interface ProjectionCreator { - /** Creates a new projection. */ - (data: { - to?: (coordinates: Array) => Array; - from?: (coordinates: Array) => Array; - aspectRatio?: number; - }): Object; - /** Gets the default or custom projection from the projection storage. */ - get(name: string): Object; - /** Adds a new projection to the internal projections storage. */ - add(name: string, projection: Object): void; - } -} -interface JQuery { - dxVectorMap(options?: DevExpress.viz.map.dxVectorMapOptions): JQuery; - dxVectorMap(methodName: string, ...params: any[]): any; - dxVectorMap(methodName: "instance"): DevExpress.viz.map.dxVectorMap; -} -declare namespace DevExpress.viz.sparklines { - export interface SparklineTooltip extends viz.core.Tooltip { - /** - * Specifies how a tooltip is horizontally aligned relative to the graph. - * @deprecated Tooltip alignment is no more available. - */ - horizontalAlignment?: string; - /** - * Specifies how a tooltip is vertically aligned relative to the graph. - * @deprecated Tooltip alignment is no more available. - */ - verticalAlignment?: string; - } - export interface BaseSparklineOptions extends viz.core.BaseWidgetOptions { - /** Specifies the blank space between the widget's extreme elements and the boundaries of the area provided for the widget in pixels. */ - margin?: viz.core.Margins; - /** Specifies the size of the widget. */ - size?: viz.core.Size; - /** Specifies tooltip options. */ - tooltip?: SparklineTooltip; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: BaseSparkline; - element: Element; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: BaseSparkline; - element: Element; - }) => void; - } - /** Overridden by descriptions for particular widgets. */ - export class BaseSparkline extends viz.core.BaseWidget { - /** Redraws a widget. */ - render(): void; - } - export interface dxBulletOptions extends BaseSparkline { - /** Specifies a color for the bullet bar. */ - color?: string; - /** Specifies an end value for the invisible scale. */ - endScaleValue?: number; - /** Specifies whether or not to show the target line. */ - showTarget?: boolean; - /** Specifies whether or not to show the line indicating zero on the invisible scale. */ - showZeroLevel?: boolean; - /** Specifies a start value for the invisible scale. */ - startScaleValue?: number; - /** Specifies the value indicated by the target line. */ - target?: number; - /** Specifies a color for both the target and zero level lines. */ - targetColor?: string; - /** Specifies the width of the target line. */ - targetWidth?: number; - /** Specifies the primary value indicated by the bullet bar. */ - value?: number; - } - /** A bullet graph widget. */ - export class dxBullet extends BaseSparkline { - constructor(element: JQuery, options?: dxBulletOptions); - constructor(element: Element, options?: dxBulletOptions); - } - export interface dxSparklineOptions extends BaseSparklineOptions { - /** Specifies the data source field that provides arguments for a sparkline. */ - argumentField?: string; - /** Sets a color for the bars indicating negative values. Available for a sparkline of the bar type only. */ - barNegativeColor?: string; - /** Sets a color for the bars indicating positive values. Available for a sparkline of the bar type only. */ - barPositiveColor?: string; - /** Specifies a data source for the sparkline. */ - dataSource?: Array; - /** Sets a color for the boundary of both the first and last points on a sparkline. */ - firstLastColor?: string; - /** Specifies whether a sparkline ignores null data points or not. */ - ignoreEmptyPoints?: boolean; - /** Sets a color for a line on a sparkline. Available for the sparklines of the line- and area-like types. */ - lineColor?: string; - /** Specifies a width for a line on a sparkline. Available for the sparklines of the line- and area-like types. */ - lineWidth?: number; - /** Sets a color for the bars indicating the values that are less than the winloss threshold. Available for a sparkline of the winloss type only. */ - lossColor?: string; - /** Sets a color for the boundary of the maximum point on a sparkline. */ - maxColor?: string; - /** Sets a color for the boundary of the minimum point on a sparkline. */ - minColor?: string; - /** Sets a color for points on a sparkline. Available for the sparklines of the line- and area-like types. */ - pointColor?: string; - /** Specifies the diameter of sparkline points in pixels. Available for the sparklines of line- and area-like types. */ - pointSize?: number; - /** Specifies a symbol to use as a point marker on a sparkline. Available for the sparklines of the line- and area-like types. */ - pointSymbol?: string; - /** Specifies whether or not to indicate both the first and last values on a sparkline. */ - showFirstLast?: boolean; - /** Specifies whether or not to indicate both the minimum and maximum values on a sparkline. */ - showMinMax?: boolean; - /** Determines the type of a sparkline. */ - type?: string; - /** Specifies the data source field that provides values for a sparkline. */ - valueField?: string; - /** Sets a color for the bars indicating the values greater than a winloss threshold. Available for a sparkline of the winloss type only. */ - winColor?: string; - /** Specifies a value that serves as a threshold for the sparkline of the winloss type. */ - winlossThreshold?: number; - /** Specifies the minimum value of the sparkline value axis. */ - minValue?: number; - /** Specifies the maximum value of the sparkline's value axis. */ - maxValue?: number; - } - /** A sparkline widget. */ - export class dxSparkline extends BaseSparkline { - constructor(element: JQuery, options?: dxSparklineOptions); - constructor(element: Element, options?: dxSparklineOptions); - } -} -interface JQuery { - dxBullet(options?: DevExpress.viz.sparklines.dxBulletOptions): JQuery; - dxBullet(methodName: string, ...params: any[]): any; - dxBullet(methodName: "instance"): DevExpress.viz.sparklines.dxBullet; - dxSparkline(options?: DevExpress.viz.sparklines.dxSparklineOptions): JQuery; - dxSparkline(methodName: string, ...params: any[]): any; - dxSparkline(methodName: "instance"): DevExpress.viz.sparklines.dxSparkline; -} diff --git a/devextreme/devextreme-15.2.5.d.ts b/devextreme/devextreme-15.2.5.d.ts deleted file mode 100644 index f968fcb1e5..0000000000 --- a/devextreme/devextreme-15.2.5.d.ts +++ /dev/null @@ -1,7383 +0,0 @@ -// Type definitions for DevExtreme 15.2.5 -// Project: http://js.devexpress.com/ -// Definitions by: DevExpress Inc. -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -/// - -declare namespace DevExpress { - /** A mixin that provides a capability to fire and subscribe to events. */ - export interface EventsMixin { - /** Subscribes to a specified event. */ - on(eventName: string, eventHandler: Function): T; - /** Subscribes to the specified events. */ - on(events: { [eventName: string]: Function; }): T; - /** Detaches all event handlers from the specified event. */ - off(eventName: string): Object; - /** Detaches a particular event handler from the specified event. */ - off(eventName: string, eventHandler: Function): T; - } - /** An object that serves as a namespace for the methods required to perform validation. */ - export module validationEngine { - export interface IValidator { - validate(): ValidatorValidationResult; - reset(): void; - } - export interface ValidatorValidationResult { - isValid: boolean; - name?: string; - value: any; - brokenRule: any; - validationRules: any[]; - } - export interface ValidationGroupValidationResult { - isValid: boolean; - brokenRules: any[]; - validators: IValidator[]; - } - export interface GroupConfig extends EventsMixin { - group: any; - validators: IValidator[]; - validate(): ValidationGroupValidationResult; - reset(): void; - } - /** Provides access to the object that represents the specified validation group. */ - export function getGroupConfig(group: any): GroupConfig - /** Provides access to the object that represents the default validation group. */ - export function getGroupConfig(): GroupConfig - /** Validates rules of the validators that belong to the specified validation group. */ - export function validateGroup(group: any): ValidationGroupValidationResult; - /** Validates rules of the validators that belong to the default validation group. */ - export function validateGroup(): ValidationGroupValidationResult; - /** Resets the values and validation result of the editors that belong to the specified validation group. */ - export function resetGroup(group: any): void; - /** Resets the values and validation result of the editors that belong to the default validation group. */ - export function resetGroup(): void; - /** Validates the rules that are defined within the dxValidator objects that are registered for the specified ViewModel. */ - export function validateModel(model: Object): ValidationGroupValidationResult; - /** Registers all the dxValidator objects by which the fields of the specified ViewModel are extended. */ - export function registerModelForValidation(model: Object) : void; - } - export var hardwareBackButton: JQueryCallback; - /** Processes the hardware back button click. */ - export function processHardwareBackButton(): void; - /** Hides the last displayed overlay widget. */ - export function hideTopOverlay(): boolean; - /** Specifies whether or not the entire application/site supports right-to-left representation. */ - export var rtlEnabled: boolean; - /** Registers a new component in the DevExpress.ui namespace as a jQuery plugin, Angular directive and Knockout binding. */ - export function registerComponent(name: string, componentClass: Object): void; - /** Registers a new component in the specified namespace as a jQuery plugin, Angular directive and Knockout binding. */ - export function registerComponent(name: string, namespace: Object, componentClass: Object): void; - export function requestAnimationFrame(callback: Function): number; - export function cancelAnimationFrame(requestID: number): void; - /** Custom Knockout binding that links an HTML element with a specific action. */ - export class Action { } - /** Used to get URLs that vary in a locally running application and the application running on production. */ - export class EndpointSelector { - constructor(options: { - [key: string]: { - local?: string; - production?: string; - } - }); - /** Returns a local or a productional URL depending on how the application is currently running. */ - urlFor(key: string): string; - } - /** An object that serves as a namespace for the methods that are used to animate UI elements. */ - export module fx { - /** Defines animation options. */ - export interface AnimationOptions { - /** A function called after animation is completed. */ - complete?: (element: JQuery, config: AnimationOptions) => void; - /** A number specifying wait time before animation execution. */ - delay?: number; - /** A number specifying the time period to wait before the animation of the next stagger item starts. */ - staggerDelay?: number; - /** A number specifying the time in milliseconds spent on animation. */ - duration?: number; - /** A string specifying the type of an easing function used for animation. */ - easing?: string; - /** Specifies the initial animation state. */ - from?: any; - /** A function called before animation is started. */ - start?: (element: JQuery, config: AnimationOptions) => void; - /** Specifies a final animation state. */ - to?: any; - /** A string value specifying the animation type. */ - type?: string; - /** Specifies the animation direction for the "slideIn" and "slideOut" animation types. */ - direction?: string; - } - /** Animates the specified element. */ - export function animate(element: HTMLElement, config: AnimationOptions): Object; - /** Returns a value indicating whether the specified element is being animated. */ - export function isAnimating(element: HTMLElement): boolean; - /** Stops the animation. */ - export function stop(element: HTMLElement, jumpToEnd: boolean): void; - } - /** The manager that performs several specified animations at a time. */ - export class TransitionExecutor { - /** Deletes all the animations registered in the Transition Executor by using the enter(elements, animation) and leave(elements, animation) methods. */ - reset(): void; - /** Registers a set of elements that should be animated as "entering" using the specified animation configuration. */ - enter(elements: JQuery, animation: any): void; - /** Registers a set of elements that should be animated as "leaving" using the specified animation configuration. */ - leave(elements: JQuery, animation: any): void; - /** Starts all the animations registered using the enter(elements, animation) and leave(elements, animation) methods beforehand. */ - start(config: Object): JQueryPromise; - /** Stops all started animations. */ - stop(): void; - } - export class AnimationPresetCollection { - /** Resets all the changes made in the animation repository. */ - resetToDefaults(): void; - /** Deletes the specified animation or clears all the animation repository, if an animation name is not passed. */ - clear(name: string): void; - /** Adds the specified animation preset to the animation repository by the specified name. */ - registerPreset(name: string, config: any): void; - /** Applies the changes made in the animation repository. */ - applyChanges(): void; - /** Returns the configuration of the animation found in the animation repository by the specified name for the current device. */ - getPreset(name: string): void; - /** Registers predefined animations in the animation repository. */ - registerDefaultPresets(): void; - } - /** A repository of animations. */ - export var animationPresets: AnimationPresetCollection; - /** The device object defines the device on which the application is running. */ - export interface Device { - /** Indicates whether or not the device platform is Android. */ - android?: boolean; - /** Specifies the type of the device on which the application is running. */ - deviceType?: string; - /** Indicates whether or not the device platform is generic, which means that the application will look and behave according to a generic "light" or "dark" theme. */ - generic?: boolean; - /** Indicates whether or not the device platform is iOS. */ - ios?: boolean; - /** Indicates whether or not the device type is 'phone'. */ - phone?: boolean; - /** Specifies the platform of the device on which the application is running. */ - platform?: string; - /** Indicates whether or not the device type is 'tablet'. */ - tablet?: boolean; - /** Specifies an array with the major and minor versions of the device platform. */ - version?: Array; - /** Indicates whether or not the device platform is Windows. */ - win?: boolean; - /** Specifies a performance grade of the current device. */ - grade?: string; - } - export class Devices implements EventsMixin { - constructor(options: { window: Window }); - /** Overrides actual device information to force the application to operate as if it was running on the specified device. */ - current(deviceName: any): void; - /** Returns information about the current device. */ - current(): Device; - orientationChanged: JQueryCallback; - /** Returns the current device orientation. */ - orientation(): string; - /** Returns real information about the current device regardless of the value passed to the devices.current(deviceName) method. */ - real(): Device; - on(eventName: "orientationChanged", eventHandler: (e: { orientation: string }) => void): Devices; - on(eventName: string, eventHandler: Function): Devices; - on(events: { [eventName: string]: Function; }): Devices; - off(eventName: "orientationChanged"): Devices; - off(eventName: string): Devices; - off(eventName: "orientationChanged", eventHandler: (e: { orientation: string }) => void): Devices; - off(eventName: string, eventHandler: Function): Devices; - } - /** An object that serves as a namespace for the methods and events specifying information on the current device. */ - export var devices: Devices; - /** The position object specifies the widget positioning options. */ - export interface PositionOptions { - /** The target element position that the widget is positioned against. */ - at?: string; - /** The element within which the widget is positioned. */ - boundary?: Element; - /** A string value holding horizontal and vertical offset from the window's boundaries. */ - boundaryOffset?: string; - /** Specifies how to move the widget if it overflows the screen. */ - collision?: any; - /** The position of the widget to align against the target element. */ - my?: string; - /** The target element that the widget is positioned against. */ - of?: HTMLElement; - /** A string value holding horizontal and vertical offset in pixels, separated by a space (e.g., "5 -10"). */ - offset?: string; - } - export interface ComponentOptions { - /** A handler for the initialized event. */ - onInitialized?: Function; - /** A handler for the optionChanged event. */ - onOptionChanged?: Function; - /** A handler for the disposing event. */ - onDisposing?: Function; - } - /** A base class for all components and widgets. */ - export class Component { - constructor(options?: ComponentOptions) - /** Prevents the component from refreshing until the endUpdate method is called. */ - beginUpdate(): void; - /** Enables the component to refresh after the beginUpdate method call. */ - endUpdate(): void; - /** Returns an instance of this component class. */ - instance(): Component; - /** Returns the configuration options of this component. */ - option(): { - [optionKey: string]: any; - }; - /** Sets one or more options of this component. */ - option(options: { - [optionKey: string]: any; - }): void; - /** Gets the value of the specified configuration option of this component. */ - option(optionName: string): any; - /** Sets a value to the specified configuration option of this component. */ - option(optionName: string, optionValue: any): void; - } - export interface DOMComponentOptions extends ComponentOptions { - /** Specifies whether or not the current component supports a right-to-left representation. */ - rtlEnabled?: boolean; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies the width of the widget. */ - width?: any; - } - /** A base class for all components. */ - export class DOMComponent extends Component { - constructor(element: JQuery, options?: DOMComponentOptions); - constructor(element: HTMLElement, options?: DOMComponentOptions); - /** Returns the root HTML element of the widget. */ - element(): JQuery; - /** Specifies the device-dependent default configuration options for this component. */ - static defaultOptions(rule: { - device?: any; - options?: any; - }): void; - } - export module data { - export interface ODataError extends Error { - httpStatus?: number; - errorDetails?: any; - } - export interface StoreOptions { - /** A handler for the modified event. */ - onModified?: () => void; - /** A handler for the modifying event. */ - onModifying?: () => void; - /** A handler for the removed event. */ - onRemoved?: (key: any) => void; - /** A handler for the removing event. */ - onRemoving?: (key: any) => void; - /** A handler for the updated event. */ - onUpdated?: (key: any, values: Object) => void; - /** A handler for the updating event. */ - onUpdating?: (key: any, values: Object) => void; - /** A handler for the loaded event. */ - onLoaded?: (result: Array) => void; - /** A handler for the loading event. */ - onLoading?: (loadOptions: LoadOptions) => void; - /** A handler for the inserted event. */ - onInserted?: (values: Object, key: any) => void; - /** A handler for the inserting event. */ - onInserting?: (values: Object) => void; - /** Specifies the function called when the Store causes an error. */ - errorHandler?: (e: Error) => void; - /** Specifies the key properties within the data associated with the Store. */ - key?: any; - } - export interface LoadOptions { - filter?: Object; - sort?: Object; - select?: Object; - expand?: Object; - group?: Object; - skip?: number; - take?: number; - userData?: Object; - requireTotalCount?: boolean; - } - /** The base class for all Stores. */ - export class Store implements EventsMixin { - constructor(options?: StoreOptions); - /** Returns the data item specified by the key. */ - byKey(key: any): JQueryPromise; - /** Adds an item to the data associated with this Store. */ - insert(values: Object): JQueryPromise; - /** Returns the key expression specified via the key configuration option. */ - key(): any; - /** Returns the key of the Store item that matches the specified object. */ - keyOf(obj: Object): any; - /** Starts loading data. */ - load(obj?: LoadOptions): JQueryPromise; - /** Removes the data item specified by the key. */ - remove(key: any): JQueryPromise; - /** Obtains the total count of items that will be returned by the load() function. */ - totalCount(options?: { - filter?: Object; - group?: Object; - }): JQueryPromise; - /** Updates the data item specified by the key. */ - update(key: any, values: Object): JQueryPromise; - on(eventName: "removing", eventHandler: (key: any) => void): Store; - on(eventName: "removed", eventHandler: (key: any) => void): Store; - on(eventName: "updating", eventHandler: (key: any, values: Object) => void): Store; - on(eventName: "updated", eventHandler: (key: any, values: Object) => void): Store; - on(eventName: "inserting", eventHandler: (values: Object) => void): Store; - on(eventName: "inserted", eventHandler: (values: Object, key: any) => void): Store; - on(eventName: "modifying", eventHandler: () => void): Store; - on(eventName: "modified", eventHandler: () => void): Store; - on(eventName: "loading", eventHandler: (loadOptions: LoadOptions) => void): Store; - on(eventName: "loaded", eventHandler: (result: Array) => void): Store; - on(eventName: string, eventHandler: Function): Store; - on(events: { [eventName: string]: Function; }): Store; - off(eventName: "removing"): Store; - off(eventName: "removed"): Store; - off(eventName: "updating"): Store; - off(eventName: "updated"): Store; - off(eventName: "inserting"): Store; - off(eventName: "inserted"): Store; - off(eventName: "modifying"): Store; - off(eventName: "modified"): Store; - off(eventName: "loading"): Store; - off(eventName: "loaded"): Store; - off(eventName: string): Store; - off(eventName: "removing", eventHandler: (key: any) => void): Store; - off(eventName: "removed", eventHandler: (key: any) => void): Store; - off(eventName: "updating", eventHandler: (key: any, values: Object) => void): Store; - off(eventName: "updated", eventHandler: (key: any, values: Object) => void): Store; - off(eventName: "inserting", eventHandler: (values: Object) => void): Store; - off(eventName: "inserted", eventHandler: (values: Object, key: any) => void): Store; - off(eventName: "modifying", eventHandler: () => void): Store; - off(eventName: "modified", eventHandler: () => void): Store; - off(eventName: "loading", eventHandler: (loadOptions: LoadOptions) => void): Store; - off(eventName: "loaded", eventHandler: (result: Array) => void): Store; - off(eventName: string, eventHandler: Function): Store; - } - export interface ArrayStoreOptions extends StoreOptions { - /** Specifies the array associated with this Store. */ - data?: Array; - } - /** A Store accessing an in-memory array. */ - export class ArrayStore extends Store { - constructor(options?: ArrayStoreOptions); - /** Clears all data associated with the current ArrayStore. */ - clear(): void; - /** Creates the Query object for the underlying array. */ - createQuery(): Query; - } - interface Promise { - then(doneFn?: Function, failFn?: Function, progressFn?: Function): Promise; - } - export interface CustomStoreOptions extends StoreOptions { - /** The user implementation of the byKey(key, extraOptions) method. */ - byKey?: (key: any) => Promise; - /** The user implementation of the insert(values) method. */ - insert?: (values: Object) => Promise; - /** The user implementation of the load(options) method. */ - load?: (options?: LoadOptions) => Promise; - /** The user implementation of the remove(key) method. */ - remove?: (key: any) => Promise; - /** The user implementation of the totalCount(options) method. */ - totalCount?: (options?: { - filter?: Object; - group?: Object; - }) => Promise; - /** The user implementation of the update(key, values) method. */ - update?: (key: any, values: Object) => Promise; - } - /** A Store object that enables you to implement your own data access logic. */ - export class CustomStore extends Store { - constructor(options: CustomStoreOptions); - } - export interface DataSourceOptions { - /** Specifies data filtering conditions. */ - filter?: Object; - /** Specifies data grouping conditions. */ - group?: Object; - /** The item mapping function. */ - map?: (record: any) => any; - /** Specifies the maximum number of items the page can contain. */ - pageSize?: number; - /** Specifies whether a DataSource loads data by pages, or all items at once. */ - paginate?: boolean; - /** The data post processing function. */ - postProcess?: (data: any[]) => any[]; - /** Specifies a value by which the required items are searched. */ - searchExpr?: Object; - /** Specifies the comparison operation used to search for the required items. */ - searchOperation?: string; - /** Specifies the value to which the search expression is compared. */ - searchValue?: Object; - /** Specifies the initial select option value. */ - select?: Object; - /** An array of the strings that represent the names of the navigation properties to be loaded simultaneously with the OData store's entity. */ - expand?: Object; - /** Specifies whether or not the DataSource instance requests the total count of items available in the storage. */ - requireTotalCount?: boolean; - /** Specifies the initial sort option value. */ - sort?: Object; - /** Specifies the underlying Store instance used to access data. */ - store?: any; - /** A handler for the changed event. */ - onChanged?: () => void; - /** A handler for the loadingChanged event. */ - onLoadingChanged?: (isLoading: boolean) => void; - /** A handler for the loadError event. */ - onLoadError?: (e?: Error) => void; - } - /** An object that provides access to a data web service or local data storage for collection container widgets. */ - export class DataSource implements EventsMixin { - constructor(url: string); - constructor(data: Array); - constructor(options: CustomStoreOptions); - constructor(options: DataSourceOptions); - /** Disposes all resources associated with this DataSource. */ - dispose(): void; - /** Returns the current filter option value. */ - filter(): Object; - /** Sets the filter option value. */ - filter(filterExpr: Object): void; - /** Returns the current group option value. */ - group(): Object; - /** Sets the group option value. */ - group(groupExpr: Object): void; - /** Indicates whether or not the current page contains fewer items than the number of items specified by the pageSize configuration option. */ - isLastPage(): boolean; - /** Indicates whether or not at least one load() method execution has successfully finished. */ - isLoaded(): boolean; - /** Indicates whether or not the DataSource is currently being loaded. */ - isLoading(): boolean; - /** Returns the array of items currently operated by the DataSource. */ - items(): Array; - /** Returns the key expression. */ - key(): any; - /** Starts loading data. */ - load(): JQueryPromise>; - /** Clears currently loaded DataSource items and calls the load() method. */ - reload(): JQueryPromise>; - /** Returns an object that would be passed to the load() method of the underlying Store according to the current data shaping option values of the current DataSource instance. */ - loadOptions(): Object; - /** Returns the current pageSize option value. */ - pageSize(): number; - /** Sets the pageSize option value. */ - pageSize(value: number): void; - /** Specifies the index of the currently loaded page. */ - pageIndex(): number; - /** Specifies the index of the page to be loaded during the next load() method execution. */ - pageIndex(newIndex: number): void; - /** Returns the current paginate option value. */ - paginate(): boolean; - /** Sets the paginate option value. */ - paginate(value: boolean): void; - /** Returns the searchExpr option value. */ - searchExpr(): Object; - /** Sets the searchExpr option value. */ - searchExpr(expr: Object): void; - /** Returns the currently specified search operation. */ - searchOperation(): string; - /** Sets the current search operation. */ - searchOperation(op: string): void; - /** Returns the searchValue option value. */ - searchValue(): Object; - /** Sets the searchValue option value. */ - searchValue(value: Object): void; - /** Returns the current select option value. */ - select(): Object; - /** Sets the select option value. */ - select(expr: Object): void; - /** Returns the current requireTotalCount option value. */ - requireTotalCount(): boolean; - /** Sets the requireTotalCount option value. */ - requireTotalCount(value: boolean): void; - /** Returns the current sort option value. */ - sort(): Object; - /** Sets the sort option value. */ - sort(sortExpr: Object): void; - /** Returns the underlying Store instance. */ - store(): Store; - /** Returns the number of data items available in an underlying Store after the last load() operation without paging. */ - totalCount(): number; - on(eventName: "loadingChanged", eventHandler: (isLoading: boolean) => void): DataSource; - on(eventName: "loadError", eventHandler: (e?: Error) => void): DataSource; - on(eventName: "changed", eventHandler: () => void): DataSource; - on(eventName: string, eventHandler: Function): DataSource; - on(events: { [eventName: string]: Function; }): DataSource; - off(eventName: "loadingChanged"): DataSource; - off(eventName: "loadError"): DataSource; - off(eventName: "changed"): DataSource; - off(eventName: string): DataSource; - off(eventName: "loadingChanged", eventHandler: (isLoading: boolean) => void): DataSource; - off(eventName: "loadError", eventHandler: (e?: Error) => void): DataSource; - off(eventName: "changed", eventHandler: () => void): DataSource; - off(eventName: string, eventHandler: Function): DataSource; - } - /** An object used to work with primitive data types not supported by JavaScript when accessing an OData web service. */ - export class EdmLiteral { - /** Creates an EdmLiteral instance and assigns the specified value to it. */ - constructor(value: string); - /** Returns a string representation of the value associated with this EdmLiteral object. */ - valueOf(): string; - } - /** An object used to generate and hold the GUID. */ - export class Guid { - /** Creates a new Guid instance that holds the specified GUID. */ - constructor(value: string); - /** Creates a new Guid instance holding the generated GUID. */ - constructor(); - /** Returns a string representation of the Guid instance. */ - toString(): string; - /** Returns a string representation of the Guid instance. */ - valueOf(): string; - } - export interface LocalStoreOptions extends ArrayStoreOptions { - /** Specifies the time (in miliseconds) after the change operation, before the data is flushed. */ - flushInterval?: number; - /** Specifies whether the data is flushed immediatelly after each change operation, or after the delay specified via the flushInterval option. */ - immediate?: boolean; - /** The unique identifier used to distinguish the data within the HTML5 Web Storage. */ - name?: string; - } - /** A Store providing access to the HTML5 Web Storage. */ - export class LocalStore extends ArrayStore { - constructor(options?: LocalStoreOptions); - /** Removes all data associated with this Store. */ - clear(): void; - } - export interface ODataContextOptions extends ODataStoreOptions { - /** Specifies the list of entities to be accessed via the ODataContext. */ - entities?: Object; - /** Specifies the function called if the ODataContext causes an error. */ - errorHandler?: (e: Error) => void; - } - /** Provides access to the entire OData service. */ - export class ODataContext { - constructor(options?: ODataContextOptions); - /** Initiates the specified WebGet service operation that returns a value. For the information on service operations, refer to the OData documentation. */ - get(operationName: string, params: Object): JQueryPromise; - /** Initiates the specified WebGet service operation that returns nothing. For the information on service operations, refer to the OData documentation. */ - invoke(operationName: string, params: Object, httpMethod: Object): JQueryPromise; - /** Return a special proxy object to describe the entity link. */ - objectLink(entityAlias: string, key: any): Object; - } - export interface ODataStoreOptions extends StoreOptions { - /** A function used to customize a web request before it is sent. */ - beforeSend?: (request: { - url: string; - async: boolean; - method: string; - timeout: number; - params: Object; - payload: Object; - headers: Object; - }) => void; - /** Specifies whether the ODataStore uses the JSONP approach to access non-CORS-compatible remote services. */ - jsonp?: boolean; - /** Specifies the type of the ODataStore key property. The following key types are supported out of the box: String, Int32, Int64, and Guid. */ - keyType?: any; - /** Specifies whether or not dates found in the response are deserialized. */ - deserializeDates?: boolean; - /** Specifies the URL of the data service being accessed via the current ODataContext. */ - url?: string; - /** Specifies the version of the OData protocol used to interact with the data service. */ - version?: number; - /** Specifies the value of the withCredentials field of the underlying jqXHR object. */ - withCredentials?: boolean; - } - /** A Store providing access to a separate OData web service entity. */ - export class ODataStore extends Store { - constructor(options?: ODataStoreOptions); - /** Creates the Query object for the OData endpoint. */ - createQuery(loadOptions: Object): Object; - /** Returns the data item specified by the key. */ - byKey(key: any, extraOptions?: { expand?: Object }): JQueryPromise; - } - /** An universal chainable data query interface object. */ - export interface Query { - /** Calculates a custom summary for the items in the current Query. */ - aggregate(step: (accumulator: any, value: any) => any): JQueryPromise; - /** Calculates a custom summary for the items in the current Query. */ - aggregate(seed: any, step: (accumulator: any, value: any) => any, finalize: (result: any) => any): JQueryPromise; - /** Calculates the average item value for the current Query. */ - avg(getter: Object): JQueryPromise; - /** Finds the item with the maximum getter value. */ - max(getter: Object): JQueryPromise; - /** Finds the item with the maximum value in the Query. */ - max(): JQueryPromise; - /** Finds the item with the minimum value in the Query. */ - min(): JQueryPromise; - /** Finds the item with the minimum getter value. */ - min(getter: Object): JQueryPromise; - /** Calculates the average item value for the current Query, if each Query item has a numeric type. */ - avg(): JQueryPromise; - /** Returns the total count of items in the current Query. */ - count(): JQueryPromise; - /** Executes the Query. */ - enumerate(): JQueryPromise; - /** Filters the current Query data. */ - filter(criteria: Array): Query; - /** Filters the current Query data. */ - filter(predicate: (item: any) => boolean): Query; - /** Groups the current Query data. */ - groupBy(getter: Object): Query; - /** Applies the specified transformation to each item. */ - select(getter: Object): Query; - /** Limits the data item count. */ - slice(skip: number, take?: number): Query; - /** Sorts current Query data. */ - sortBy(getter: Object, desc: boolean): Query; - /** Sorts current Query data. */ - sortBy(getter: Object): Query; - /** Calculates the sum of item getter values in the current Query. */ - sum(getter: Object): JQueryPromise; - /** Calculates the sum of item values in the current Query. */ - sum(): JQueryPromise; - /** Adds one more sorting condition to the current Query. */ - thenBy(getter: Object): Query; - /** Adds one more sorting condition to the current Query. */ - thenBy(getter: Object, desc: boolean): Query; - /** Returns the array of current Query items. */ - toArray(): Array; - } - /** The global data layer error handler. */ - export var errorHandler: (e: Error) => void; - /** Encodes the specified string or array of bytes to base64 encoding. */ - export function base64_encode(input: any): string; - /** Creates a Query instance. */ - export function query(array: Array): Query; - /** Creates a Query instance for accessing the remote service specified by a URL. */ - export function query(url: string, queryOptions: Object): Query; - /** This section describes the utility objects provided by the DevExtreme data layer. */ - export var utils: { - /** Compiles a getter function from the getter expression. */ - compileGetter(expr: any): Function; - /** Compiles a setter function from the setter expression. */ - compileSetter(expr: any): Function; - odata: { - /** Holds key value converters for OData. */ - keyConverters: { - String(value: any): string; - Int32(value: any): number; - Int64(value: any): EdmLiteral; - Guid(value: any): Guid; - Boolean(value: any): boolean; - Single(value: any): EdmLiteral; - Decimal(value: any): EdmLiteral; - }; - } - } - } - /** An object that serves as a namespace for DevExtreme UI widgets as well as for methods implementing UI logic in DevExtreme sites/applications. */ - export module ui { - export interface WidgetOptions extends DOMComponentOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A Boolean value specifying whether or not the widget can respond to user interaction. */ - disabled?: boolean; - /** A Boolean value specifying whether or not the widget changes its state when being hovered by an end user. */ - hoverStateEnabled?: boolean; - /** Specifies whether or not the widget can be focused. */ - focusStateEnabled?: boolean; - /** Specifies a shortcut key that sets focus on the widget element. */ - accessKey?: string; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - /** Specifies the widget tab index. */ - tabIndex?: number; - /** Specifies the text of the hint displayed for the widget. */ - hint?: string; - } - /** The base class for widgets. */ - export class Widget extends DOMComponent { - constructor(options?: WidgetOptions); - /** Redraws the widget. */ - repaint(): void; - /** Sets focus on the widget. */ - focus(): void; - /** Registers a handler when a specified key is pressed. */ - registerKeyHandler(key: string, handler: Function): void; - } - export interface CollectionWidgetOptions extends WidgetOptions { - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** The time period in milliseconds before the onItemHold event is raised. */ - itemHoldTimeout?: number; - /** An array of items displayed by the widget. */ - items?: Array; - /** The template to be used for rendering items. */ - itemTemplate?: any; - loopItemFocus?: boolean; - /** The text or HTML markup displayed by the widget if the item collection is empty. */ - noDataText?: string; - onContentReady?: any; - /** A handler for the itemClick event. */ - onItemClick?: any; - /** A handler for the itemContextMenu event. */ - onItemContextMenu?: Function; - /** A handler for the itemHold event. */ - onItemHold?: Function; - /** A handler for the itemRendered event. */ - onItemRendered?: Function; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: Function; - /** The index of the currently selected widget item. */ - selectedIndex?: number; - /** The selected item object. */ - selectedItem?: Object; - /** An array of currently selected item objects. */ - selectedItems?: Array; - /** A handler for the itemDeleting event. */ - onItemDeleting?: Function; - /** A handler for the itemDeleted event. */ - onItemDeleted?: Function; - /** A handler for the itemReordered event. */ - onItemReordered?: Function; - } - /** The base class for widgets containing an item collection. */ - export class CollectionWidget extends Widget { - constructor(element: JQuery, options?: CollectionWidgetOptions); - constructor(element: HTMLElement, options?: CollectionWidgetOptions); - selectItem(itemElement: any): void; - unselectItem(itemElement: any): void; - deleteItem(itemElement: any): JQueryPromise; - isItemSelected(itemElement: any): boolean; - reorderItem(itemElement: any, toItemElement: any): JQueryPromise; - } - export interface DataExpressionMixinOptions { - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** Specifies the name of the data source item field whose value is displayed by the widget. */ - displayExpr?: any; - /** Specifies the name of a data source item field whose value is held in the value configuration option. */ - valueExpr?: any; - /** An array of items displayed by the widget. */ - items?: Array; - /** The template to be used for rendering items. */ - itemTemplate?: any; - /** The currently selected value in the widget. */ - value?: Object; - } - export interface EditorOptions extends WidgetOptions { - /** The currently specified value. */ - value?: Object; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - /** A Boolean value specifying whether or not the widget is read-only. */ - readOnly?: boolean; - /** Holds the object that defines the error that occurred during validation. */ - validationError?: Object; - /** Specifies whether the editor's value is valid. */ - isValid?: boolean; - /** Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed. */ - validationMessageMode?: string; - } - /** A base class for editors. */ - export class Editor extends Widget { - /** Resets the editor's value to undefined. */ - reset(): void; - } - /** An object that serves as a namespace for methods displaying a message in an application/site. */ - export var dialog: { - /** Creates an alert dialog message containing a single "OK" button. */ - alert(message: string, title: string): JQueryPromise; - /** Creates a confirm dialog that contains "Yes" and "No" buttons. */ - confirm(message: string, title: string): JQueryPromise; - /** Creates a custom dialog using the options specified by the passed configuration object. */ - custom(options: { title?: string; message?: string; buttons?: Array; }): { - show(): JQueryPromise; - hide(): void; - hide(value: any): void; - }; - }; - /** Creates a toast message. */ - export function notify(message: any, type: string, displayTime: number): void; - /** Creates a toast message. */ - export function notify(options: Object): void; - /** An object that serves as a namespace for the methods that work with DevExtreme CSS Themes. */ - export var themes: { - /** Returns the name of the currently applied theme. */ - current(): string; - /** Changes the current theme to the specified one. */ - current(themeName: string): void; - }; - /** Sets a specified template engine. */ - export function setTemplateEngine(name: string): void; - /** Sets a custom template engine defined via custom compile and render functions. */ - export function setTemplateEngine(options: Object): void; - } - /** An object that serves as a namespace for utility methods that can be helpful when working with the DevExtreme framework and UI widgets. */ - export var utils: { - /** Sets parameters for the viewport meta tag. */ - initMobileViewport(options: { allowZoom?: boolean; allowPan?: boolean; allowSelection?: boolean }): void; - /** Requests that the browser call a specified function to update animation before the next repaint. */ - requestAnimationFrame(callback: Function): number; - /** Cancels an animation frame request scheduled with the requestAnimationFrame method. */ - cancelAnimationFrame(requestID: number): void; - }; - /** An object that serves as a namespace for DevExtreme Data Visualization Widgets. */ - export module viz { - /** Applies a theme for the entire page with several DevExtreme visualization widgets. */ - export function currentTheme(theme: string): void; - /** Applies a new theme (with the color scheme defined separately) for the entire page with several DevExtreme visualization widgets. */ - export function currentTheme(platform: string, colorScheme: string): void; - /** Registers a new theme based on the existing one. */ - export function registerTheme(customTheme: Object, baseTheme: string): void; - /** Applies a predefined or registered custom palette to all visualization widgets at once. */ - export function currentPalette(paletteName: string): void; - /** Obtains the color sets of a predefined or registered palette. */ - export function getPalette(paletteName: string): Object; - /** Registers a new palette. */ - export function registerPalette(paletteName: string, palette: Object): void; - } -} -declare namespace DevExpress.ui { - export interface dxValidatorOptions extends DOMComponentOptions { - /** An array of validation rules to be checked for the editor with which the dxValidator object is associated. */ - validationRules?: Array; - /** Specifies the editor name to be used in the validation default messages. */ - name?: string; - /** An object that specifies what and when to validate and how to apply the validation result. */ - adapter?: Object; - /** Specifies the validation group the editor will be related to. */ - validationGroup?: string; - /** A handler for the validated event. */ - onValidated?: (params: validationEngine.ValidatorValidationResult) => void; - } - /** A widget that is used to validate the associated DevExtreme editors against the defined validation rules. */ - export class dxValidator extends DOMComponent implements validationEngine.IValidator { - constructor(element: JQuery, options?: dxValidatorOptions); - constructor(element: Element, options?: dxValidatorOptions); - /** Validates the value of the editor that is controlled by the current dxValidator object against the list of the specified validation rules. */ - validate(): validationEngine.ValidatorValidationResult; - /** Resets the value and validation result of the editor associated with the current dxValidator object. */ - reset(): void; - } - /** The widget that is used in the Knockout and Angular approaches to combine the editors to be validated. */ - export class dxValidationGroup extends DOMComponent { - constructor(element: JQuery); - constructor(element: Element); - /** Validates rules of the validators that belong to the current validation group. */ - validate(): validationEngine.ValidationGroupValidationResult; - /** Resets the value and validation result of the editors that are included to the current validation group. */ - reset(): void; - } - export interface dxValidationSummaryOptions extends CollectionWidgetOptions { - /** Specifies the validation group for which summary should be generated. */ - validationGroup?: string; - } - /** A widget for displaying the result of checking validation rules for editors. */ - export class dxValidationSummary extends CollectionWidget { - constructor(element: JQuery, options?: dxValidationSummaryOptions); - constructor(element: Element, options?: dxValidationSummaryOptions); - } - export interface dxResizableOptions extends DOMComponentOptions { - /** Specifies which borders of the widget element are used as a handle. */ - handles?: string; - /** Specifies the lower width boundary for resizing. */ - minWidth?: number; - /** Specifies the upper width boundary for resizing. */ - maxWidth?: number; - /** Specifies the lower height boundary for resizing. */ - minHeight?: number; - /** Specifies the upper height boundary for resizing. */ - maxHeight?: number; - /** A handler for the resizeStart event. */ - onResizeStart?: Function; - /** A handler for the resize event. */ - onResize?: Function; - /** A handler for the resizeEnd event. */ - onResizeEnd?: Function; - } - /** A widget that displays required content in a resizable element. */ - export class dxResizable extends DOMComponent { - constructor(element: JQuery, options?: dxResizableOptions); - constructor(element: Element, options?: dxResizableOptions); - } - export interface dxTooltipOptions extends dxPopoverOptions { - } - /** A tooltip widget. */ - export class dxTooltip extends dxPopover { - constructor(element: JQuery, options?: dxTooltipOptions); - constructor(element: Element, options?: dxTooltipOptions); - } - export interface dxDropDownListOptions extends dxDropDownEditorOptions, DataExpressionMixinOptions { - /** Returns the value currently displayed by the widget. */ - displayValue?: string; - /** The minimum number of characters that must be entered into the text box to begin a search. */ - minSearchLength?: number; - /** Specifies whether or not the widget displays unfiltered values until a user types a number of characters exceeding the minSearchLength option value. */ - showDataBeforeSearch?: boolean; - /** Specifies the name of a data source item field or an expression whose value is compared to the search criterion. */ - searchExpr?: Object; - /** Specifies the binary operation used to filter data. */ - searchMode?: string; - /** Specifies the time delay, in milliseconds, after the last character has been typed in, before a search is executed. */ - searchTimeout?: number; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - /** Specifies DOM event names that update a widget's value. */ - valueChangeEvent?: string; - /** Specifies whether or not the widget supports searching. */ - searchEnabled?: boolean; - /** - * Specifies whether or not the widget displays items by pages. - * @deprecated dataSource.paginate.md - */ - pagingEnabled?: boolean; - /** The text or HTML markup displayed by the widget if the item collection is empty. */ - noDataText?: string; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: Function; - /** A handler for the itemClick event. */ - onItemClick?: Function; - onContentReady?: Function; - } - /** A base class for drop-down list widgets. */ - export class dxDropDownList extends dxDropDownEditor { - constructor(element: JQuery, options?: dxDropDownListOptions); - constructor(element: Element, options?: dxDropDownListOptions); - } - export interface dxToolbarOptions extends CollectionWidgetOptions { - /** The template used to render menu items. */ - menuItemTemplate?: any; - /** Informs the widget about its location in a view HTML markup. */ - renderAs?: string; - } - /** A toolbar widget. */ - export class dxToolbar extends CollectionWidget { - constructor(element: JQuery, options?: dxToolbarOptions); - constructor(element: Element, options?: dxToolbarOptions); - } - export interface dxToastOptions extends dxOverlayOptions { - animation?: fx.AnimationOptions; - /** The time span in milliseconds during which the dxToast widget is visible. */ - displayTime?: number; - height?: any; - /** The dxToast message text. */ - message?: string; - position?: PositionOptions; - shading?: boolean; - /** Specifies the dxToast widget type. */ - type?: string; - width?: any; - closeOnBackButton?: boolean; - /** A Boolean value specifying whether or not the toast is closed if a user swipes it out of the screen boundaries. */ - closeOnSwipe?: boolean; - /** A Boolean value specifying whether or not the toast is closed if a user clicks it. */ - closeOnClick?: boolean; - } - /** The toast message widget. */ - export class dxToast extends dxOverlay { - constructor(element: JQuery, options?: dxToastOptions); - constructor(element: Element, options?: dxToastOptions); - } - export interface dxTextEditorOptions extends EditorOptions { - /** A handler for the change event. */ - onChange?: Function; - /** A handler for the copy event. */ - onCopy?: Function; - /** A handler for the cut event. */ - onCut?: Function; - /** A handler for the enterKey event. */ - onEnterKey?: Function; - /** A handler for the focusIn event. */ - onFocusIn?: Function; - /** A handler for the focusOut event. */ - onFocusOut?: Function; - /** A handler for the input event. */ - onInput?: Function; - /** A handler for the keyDown event. */ - onKeyDown?: Function; - /** A handler for the keyPress event. */ - onKeyPress?: Function; - /** A handler for the keyUp event. */ - onKeyUp?: Function; - /** A handler for the paste event. */ - onPaste?: Function; - /** The text displayed by the widget when the widget value is empty. */ - placeholder?: string; - /** Specifies whether to display the Clear button in the widget. */ - showClearButton?: boolean; - /** Specifies the current value displayed by the widget. */ - value?: any; - /** Specifies DOM event names that update a widget's value. */ - valueChangeEvent?: string; - /** Specifies whether or not the widget checks the inner text for spelling mistakes. */ - spellcheck?: boolean; - /** Specifies HTML attributes applied to the inner input element of the widget. */ - attr?: Object; - /** The read-only option that holds the text displayed by the widget input element. */ - text?: string; - focusStateEnabled?: boolean; - hoverStateEnabled?: boolean; - /** The editor mask that specifies the format of the entered string. */ - mask?: string; - /** Specifies a mask placeholder character. */ - maskChar?: string; - /** Specifies custom mask rules. */ - maskRules?: Object; - /** A message displayed when the entered text does not match the specified pattern. */ - maskInvalidMessage?: string; - /** Specifies whether the value option holds only characters entered by a user or prompt characters as well. */ - useMaskedValue?: boolean; - } - /** A base class for text editing widgets. */ - export class dxTextEditor extends Editor { - constructor(element: JQuery, options?: dxTextEditorOptions); - constructor(element: Element, options?: dxTextEditorOptions); - /** Removes focus from the input element. */ - blur(): void; - /** Sets focus to the input element representing the widget. */ - focus(): void; - } - export interface dxTextBoxOptions extends dxTextEditorOptions { - /** Specifies the maximum number of characters you can enter into the textbox. */ - maxLength?: any; - /** The "mode" attribute value of the actual HTML input element representing the text box. */ - mode?: string; - } - /** A single-line text box widget. */ - export class dxTextBox extends dxTextEditor { - constructor(element: JQuery, options?: dxTextBoxOptions); - constructor(element: Element, options?: dxTextBoxOptions); - } - export interface dxTextAreaOptions extends dxTextBoxOptions { - /** Specifies whether or not the widget checks the inner text for spelling mistakes. */ - spellcheck?: boolean; - } - /** A widget used to display and edit multi-line text. */ - export class dxTextArea extends dxTextBox { - constructor(element: JQuery, options?: dxTextAreaOptions); - constructor(element: Element, options?: dxTextAreaOptions); - } - export interface dxTabsOptions extends CollectionWidgetOptions { - /** Specifies whether the widget enables an end-user to select only a single item or multiple items. */ - selectionMode?: string; - /** Specifies whether or not an end-user can scroll tabs by swiping. */ - scrollByContent?: boolean; - /** Specifies whether or not an end-user can scroll tabs. */ - scrollingEnabled?: boolean; - /** A Boolean value that specifies the availability of navigation buttons. */ - showNavButtons?: boolean; - } - /** A tab strip used to switch between pages. */ - export class dxTabs extends CollectionWidget { - constructor(element: JQuery, options?: dxTabsOptions); - constructor(element: Element, options?: dxTabsOptions); - } - export interface dxTabPanelOptions extends dxMultiViewOptions { - /** A handler for the titleClick event. */ - onTitleClick?: any; - /** A handler for the titleHold event. */ - onTitleHold?: Function; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - /** The template to be used for rendering an item title. */ - itemTitleTemplate?: any; - /** A Boolean value specifying if the list is scrolled by content. */ - scrollByContent?: boolean; - /** A Boolean value specifying whether to enable or disable scrolling. */ - scrollingEnabled?: boolean; - /** A Boolean value that specifies the availability of navigation buttons. */ - showNavButtons?: boolean; - } - /** A widget used to display a view and to switch between several views by clicking the appropriate tabs. */ - export class dxTabPanel extends dxMultiView { - constructor(element: JQuery, options?: dxTabPanelOptions); - constructor(element: Element, options?: dxTabPanelOptions); - } - export interface dxSelectBoxOptions extends dxDropDownListOptions { - /** Specifies DOM event names that update a widget's value. */ - valueChangeEvent?: string; - /** The template to be used for rendering the widget text field. */ - fieldTemplate?: any; - /** The text that is provided as a hint in the select box editor. */ - placeholder?: string; - /** Specifies whether or not the widget allows an end-user to enter a custom value. */ - fieldEditEnabled?: boolean; - } - /** A widget that allows you to select an item in a dropdown list. */ - export class dxSelectBox extends dxDropDownList { - constructor(element: JQuery, options?: dxSelectBoxOptions); - constructor(element: Element, options?: dxSelectBoxOptions); - } - export interface dxTagBoxOptions extends dxSelectBoxOptions { - /** Holds the list of selected values. */ - values?: Array; - /** A read-only option that holds the last selected value. */ - value?: Object; - } - /** A widget that allows you to select multiple items from a dropdown list. */ - export class dxTagBox extends dxSelectBox { - constructor(element: JQuery, options?: dxTagBoxOptions); - constructor(element: Element, options?: dxTagBoxOptions); - } - export interface dxScrollViewOptions extends dxScrollableOptions { - /** A handler for the pullDown event. */ - onPullDown?: Function; - /** Specifies the text shown in the pullDown panel when pulling the content down lowers the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while pulling the content down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the reachBottom event. */ - onReachBottom?: Function; - /** Specifies the text shown in the pullDown panel displayed when content is scrolled to the bottom. */ - reachBottomText?: string; - /** Specifies the text shown in the pullDown panel displayed when the content is being refreshed. */ - refreshingText?: string; - /** Returns a value indicating if the scrollView content is larger then the widget container. */ - isFull(): boolean; - /** Locks the widget until the release(preventScrollBottom) method is called and executes the function passed to the onPullDown option and the handler assigned to the pullDown event. */ - refresh(): void; - /** Notifies the scroll view that data loading is finished. */ - release(preventScrollBottom: boolean): JQueryPromise; - /** Toggles the loading state of the widget. */ - toggleLoading(showOrHide: boolean): void; - } - /** A widget used to display scrollable content. */ - export class dxScrollView extends dxScrollable { - constructor(element: JQuery, options?: dxScrollViewOptions); - constructor(element: Element, options?: dxScrollViewOptions); - } - export interface dxScrollableLocation { - top?: number; - left?: number; - } - export interface dxScrollableOptions extends DOMComponentOptions { - /** A string value specifying the available scrolling directions. */ - direction?: string; - /** A Boolean value specifying whether or not the widget can respond to user interaction. */ - disabled?: boolean; - /** A handler for the scroll event. */ - onScroll?: Function; - /** Specifies when the widget shows the scrollbar. */ - showScrollbar?: string; - /** A handler for the update event. */ - onUpdated?: Function; - /** Indicates whether to use native or simulated scrolling. */ - useNative?: boolean; - /** A Boolean value specifying whether to enable or disable the bounce-back effect. */ - bounceEnabled?: boolean; - /** A Boolean value specifying whether or not an end-user can scroll the widget content swiping it up or down. */ - scrollByContent?: boolean; - /** A Boolean value specifying whether or not an end-user can scroll the widget content using the scrollbar. */ - scrollByThumb?: boolean; - } - /** A widget used to display scrollable content. */ - export class dxScrollable extends DOMComponent { - constructor(element: JQuery, options?: dxScrollableOptions); - constructor(element: Element, options?: dxScrollableOptions); - /** Returns the height of the scrollable widget in pixels. */ - clientHeight(): number; - /** Returns the width of the scrollable widget in pixels. */ - clientWidth(): number; - /** Returns an HTML element of the widget. */ - content(): JQuery; - /** Scrolls the widget content by the specified number of pixels. */ - scrollBy(distance: number): void; - /** Scrolls widget content by the specified number of pixels in horizontal and vertical directions. */ - scrollBy(distanceObject: dxScrollableLocation): void; - /** Returns the height of the scrollable content in pixels. */ - scrollHeight(): number; - /** Returns the current scroll position against the leftmost position. */ - scrollLeft(): number; - /** Returns how far the scrollable content is scrolled from the top and from the left. */ - scrollOffset(): dxScrollableLocation; - /** Scrolls widget content to the specified position. */ - scrollTo(targetLocation: number): void; - /** Scrolls widget content to a specified position. */ - scrollTo(targetLocation: dxScrollableLocation): void; - /** Scrolls widget content to the specified element. */ - scrollToElement(element: Element): void; - /** Returns the current scroll position against the topmost position. */ - scrollTop(): number; - /** Returns the width of the scrollable content in pixels. */ - scrollWidth(): number; - /** Updates the dimensions of the scrollable contents. */ - update(): void; - } - export interface dxRadioGroupOptions extends CollectionWidgetOptions, DataExpressionMixinOptions { - activeStateEnabled?: boolean; - /** Specifies the radio group layout. */ - layout?: string; - } - /** A widget that enables a user to select one item within a list of items represented by radio buttons. */ - export class dxRadioGroup extends CollectionWidget { - constructor(element: JQuery, options?: dxRadioGroupOptions); - constructor(element: Element, options?: dxRadioGroupOptions); - } - export interface dxPopupOptions extends dxOverlayOptions { - animation?: fx.AnimationOptions; - /** Specifies whether or not to allow a user to drag the popup window. */ - dragEnabled?: boolean; - /** A Boolean value specifying whether or not to display the widget in full-screen mode. */ - fullScreen?: boolean; - position?: PositionOptions; - /** A Boolean value specifying whether or not to display the title in the popup window. */ - showTitle?: boolean; - /** The title in the overlay window. */ - title?: string; - /** A template to be used for rendering the widget title. */ - titleTemplate?: any; - width?: any; - /** Specifies items displayed on the top or bottom toolbar of the popup window. */ - buttons?: Array; - /** Specifies whether or not the widget displays the Close button. */ - showCloseButton?: boolean; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - } - /** A widget that displays required content in a popup window. */ - export class dxPopup extends dxOverlay { - constructor(element: JQuery, options?: dxPopupOptions); - constructor(element: Element, options?: dxPopupOptions); - } - export interface dxPopoverOptions extends dxPopupOptions { - /** An object defining animation options of the widget. */ - animation?: fx.AnimationOptions; - /** Specifies the height of the widget. */ - height?: any; - /** An object defining widget positioning options. */ - position?: PositionOptions; - shading?: boolean; - /** A Boolean value specifying whether or not to display the title in the overlay window. */ - showTitle?: boolean; - /** The target element associated with a popover. */ - target?: any; - /** Specifies the width of the widget. */ - width?: any; - } - /** A widget that displays the required content in a popup window. */ - export class dxPopover extends dxPopup { - constructor(element: JQuery, options?: dxPopoverOptions); - constructor(element: Element, options?: dxPopoverOptions); - /** Displays the widget for the specified target element. */ - show(target?: any): JQueryPromise; - } - export interface dxOverlayOptions extends WidgetOptions { - /** An object that defines the animation options of the widget. */ - animation?: fx.AnimationOptions; - /** A Boolean value specifying whether or not the widget is closed if a user presses the Back hardware button. */ - closeOnBackButton?: boolean; - /** A Boolean value specifying whether or not the widget is closed if a user clicks outside of the overlapping window. */ - closeOnOutsideClick?: any; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - /** Specifies whether or not an end-user can drag the widget. */ - dragEnabled?: boolean; - /** Specifies whether or not an end user can resize the widget. */ - resizeEnabled?: boolean; - /** The height of the widget in pixels. */ - height?: any; - /** Specifies the maximum height the widget can reach while resizing. */ - maxHeight?: any; - /** Specifies the maximum width the widget can reach while resizing. */ - maxWidth?: any; - /** Specifies the minimum height the widget can reach while resizing. */ - minHeight?: any; - /** Specifies the minimum width the widget can reach while resizing. */ - minWidth?: any; - /** A handler for the hidden event. */ - onHidden?: Function; - /** A handler for the resizeStart event. */ - onResizeStart?: Function; - /** A handler for the resize event. */ - onResize?: Function; - /** A handler for the resizeEnd event. */ - onResizeEnd?: Function; - /** A handler for the hiding event. */ - onHiding?: Function; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** A Boolean value specifying whether or not the main screen is inactive while the widget is active. */ - shading?: boolean; - /** Specifies the shading color. */ - shadingColor?: string; - /** A handler for the showing event. */ - onShowing?: Function; - /** A handler for the shown event. */ - onShown?: Function; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - /** The widget width in pixels. */ - width?: any; - } - /** A widget displaying the required content in an overlay window. */ - export class dxOverlay extends Widget { - constructor(element: JQuery, options?: dxOverlayOptions); - constructor(element: Element, options?: dxOverlayOptions); - /** An HTML element of the widget. */ - content(): JQuery; - /** Hides the widget. */ - hide(): JQueryPromise; - /** Recalculates the overlay's size and position. */ - repaint(): void; - /** Shows the widget. */ - show(): JQueryPromise; - /** Toggles the visibility of the widget. */ - toggle(showing: boolean): JQueryPromise; - /** A static method that specifies the base z-index for all overlay widgets. */ - static baseZIndex(zIndex: number): void; - } - export interface dxNumberBoxOptions extends dxTextEditorOptions { - /** The maximum value accepted by the number box. */ - max?: number; - /** The minimum value accepted by the number box. */ - min?: number; - /** Specifies whether or not to show spin buttons. */ - showSpinButtons?: boolean; - useTouchSpinButtons?: boolean; - /** Specifies by which value the widget value changes when a spin button is clicked. */ - step?: number; - /** The current number box value. */ - value?: number; - } - /** A textbox widget that enables a user to enter numeric values. */ - export class dxNumberBox extends dxTextEditor { - constructor(element: JQuery, options?: dxNumberBoxOptions); - constructor(element: Element, options?: dxNumberBoxOptions); - } - export interface dxNavBarOptions extends dxTabsOptions { - scrollingEnabled?: boolean; - } - /** A widget that contains items used to navigate through application views. */ - export class dxNavBar extends dxTabs { - constructor(element: JQuery, options?: dxNavBarOptions); - constructor(element: Element, options?: dxNavBarOptions); - } - export interface dxMultiViewOptions extends CollectionWidgetOptions { - /** Specifies whether or not to animate the displayed item change. */ - animationEnabled?: boolean; - /** A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped. */ - loop?: boolean; - /** The index of the currently displayed item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to allow users to change the selected index by swiping. */ - swipeEnabled?: boolean; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - } - /** A widget used to display a view and to switch between several views. */ - export class dxMultiView extends CollectionWidget { - constructor(element: JQuery, options?: dxMultiViewOptions); - constructor(element: Element, options?: dxMultiViewOptions); - } - export interface dxMapOptions extends WidgetOptions { - /** Specifies whether or not the widget automatically adjusts center and zoom option values when adding a new marker or route. */ - autoAdjust?: boolean; - center?: { - /** The latitude location displayed in the center of the widget. */ - lat?: number; - /** The longitude location displayed in the center of the widget. */ - lng?: number; - }; - /** A handler for the click event. */ - onClick?: any; - /** Specifies whether or not map widget controls are available. */ - controls?: boolean; - /** Specifies the height of the widget. */ - height?: any; - /** A key used to authenticate the application within the required map provider. */ - key?: { - /** A key used to authenticate the application within the "Bing" map provider. */ - bing?: string; - /** A key used to authenticate the application within the "Google" map provider. */ - google?: string; - /** A key used to authenticate the application within the "Google Static" map provider. */ - googleStatic?: string; - } - /** A handler for the markerAdded event. */ - onMarkerAdded?: Function; - /** A URL pointing to the custom icon to be used for map markers. */ - markerIconSrc?: string; - /** A handler for the markerRemoved event. */ - onMarkerRemoved?: Function; - /** An array of markers displayed on a map. */ - markers?: Array; - /** The name of the current map data provider. */ - provider?: string; - /** A handler for the ready event. */ - onReady?: Function; - /** A handler for the routeAdded event. */ - onRouteAdded?: Function; - /** A handler for the routeRemoved event. */ - onRouteRemoved?: Function; - /** An array of routes shown on the map. */ - routes?: Array; - /** The type of a map to display. */ - type?: string; - /** Specifies the width of the widget. */ - width?: any; - /** The zoom level of the map. */ - zoom?: number; - } - /** An interactive map widget. */ - export class dxMap extends Widget { - constructor(element: JQuery, options?: dxMapOptions); - constructor(element: Element, options?: dxMapOptions); - /** Adds a marker to the map. */ - addMarker(markerOptions: Object): JQueryPromise; - /** Adds a route to the map. */ - addRoute(routeOptions: Object): JQueryPromise; - /** Removes a marker from the map. */ - removeMarker(marker: Object): JQueryPromise; - /** Removes a route from the map. */ - removeRoute(route: any): JQueryPromise; - } - export interface dxLookupOptions extends dxDropDownListOptions { - /** An object defining widget animation options. */ - animation?: fx.AnimationOptions; - /** The text displayed on the Cancel button. */ - cancelButtonText?: string; - /** The text displayed on the Clear button. */ - clearButtonText?: string; - /** Specifies whether or not the widget cleans the search box when the popup window is displayed. */ - cleanSearchOnOpening?: boolean; - /** A Boolean value specifying whether or not a widget is closed if a user clicks outside of the overlaying window. */ - closeOnOutsideClick?: any; - /** The text displayed on the Apply button. */ - applyButtonText?: string; - /** A Boolean value specifying whether or not to display the lookup in full-screen mode. */ - fullScreen?: boolean; - focusStateEnabled?: boolean; - /** A Boolean value specifying whether or not to group widget items. */ - grouped?: boolean; - /** The name of the template used to display a group header. */ - groupTemplate?: any; - /** The text displayed on the button used to load the next page from the data source. */ - nextButtonText?: string; - /** A handler for the pageLoading event. */ - onPageLoading?: Function; - /** Specifies whether the next page is loaded when a user scrolls the widget to the bottom or when the "next" button is clicked. */ - pageLoadMode?: string; - /** Specifies the text shown in the pullDown panel, which is displayed when the widget is scrolled to the bottom. */ - pageLoadingText?: string; - /** The text displayed by the widget when nothing is selected. */ - placeholder?: string; - /** The height of the widget popup element. */ - popupHeight?: any; - /** The width of the widget popup element. */ - popupWidth?: any; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** Specifies the text displayed in the pullDown panel when the widget is pulled below the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the pullRefresh event. */ - onPullRefresh?: Function; - /** A Boolean value specifying whether or not the widget supports the "pull down to refresh" gesture. */ - pullRefreshEnabled?: boolean; - /** Specifies the text displayed in the pullDown panel while the widget is being refreshed. */ - refreshingText?: string; - /** A handler for the scroll event. */ - onScroll?: Function; - /** A Boolean value specifying whether or not the search bar is visible. */ - searchEnabled?: boolean; - /** The text that is provided as a hint in the lookup's search bar. */ - searchPlaceholder?: string; - /** A Boolean value specifying whether or not the main screen is inactive while the lookup is active. */ - shading?: boolean; - /** Specifies whether to display the Cancel button in the lookup window. */ - showCancelButton?: boolean; - /** - * A Boolean value specifying whether the widget loads the next page automatically when you reach the bottom of the list or when a button is clicked. - * @deprecated pageLoadMode.md - */ - showNextButton?: boolean; - /** The title of the lookup window. */ - title?: string; - /** A template to be used for rendering the widget title. */ - titleTemplate?: any; - /** Specifies whether or not the widget uses native scrolling. */ - useNativeScrolling?: boolean; - /** Specifies whether or not to show lookup contents in a dxPopover widget. */ - usePopover?: boolean; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - /** A Boolean value specifying whether or not to display the title in the popup window. */ - showPopupTitle?: boolean; - } - /** A widget that allows a user to select predefined values from a lookup window. */ - export class dxLookup extends dxDropDownList { - constructor(element: JQuery, options?: dxLookupOptions); - constructor(element: Element, options?: dxLookupOptions); - /** This section lists the data source fields that are used in a default template for lookup drop-down items. */ - } - export interface dxLoadPanelOptions extends dxOverlayOptions { - /** An object defining the animation options of the widget. */ - animation?: fx.AnimationOptions; - /** The delay in milliseconds after which the load panel is displayed. */ - delay?: number; - /** The height of the widget. */ - height?: number; - /** A URL pointing to an image to be used as a load indicator. */ - indicatorSrc?: string; - /** The text displayed in the load panel. */ - message?: string; - /** A Boolean value specifying whether or not to show a load indicator. */ - showIndicator?: boolean; - /** A Boolean value specifying whether or not to show the pane behind the load indicator. */ - showPane?: boolean; - /** The width of the widget. */ - width?: number; - } - /** A widget used to indicate whether or not an element is loading. */ - export class dxLoadPanel extends dxOverlay { - constructor(element: JQuery, options?: dxLoadPanelOptions); - constructor(element: Element, options?: dxLoadPanelOptions); - } - export interface dxLoadIndicatorOptions extends WidgetOptions { - /** Specifies the path to an image used as the indicator. */ - indicatorSrc?: string; - } - /** The widget used to indicate the loading process. */ - export class dxLoadIndicator extends Widget { - constructor(element: JQuery, options?: dxLoadIndicatorOptions); - constructor(element: Element, options?: dxLoadIndicatorOptions); - } - export interface dxListOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not to display a grouped list. */ - grouped?: boolean; - /** The template to be used for rendering item groups. */ - groupTemplate?: any; - onItemDeleting?: Function; - /** A handler for the itemDeleted event. */ - onItemDeleted?: Function; - /** A handler for the groupRendered event. */ - onGroupRendered?: Function; - /** A handler for the itemReordered event. */ - onItemReordered?: Function; - /** A handler for the itemClick event. */ - onItemClick?: any; - /** A handler for the itemSwipe event. */ - onItemSwipe?: Function; - /** The text displayed on the button used to load the next page from the data source. */ - nextButtonText?: string; - /** A handler for the pageLoading event. */ - onPageLoading?: Function; - /** Specifies the text shown in the pullDown panel, which is displayed when the list is scrolled to the bottom. */ - pageLoadingText?: string; - /** Specifies the text displayed in the pullDown panel when the list is pulled below the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the pullRefresh event. */ - onPullRefresh?: Function; - /** A Boolean value specifying whether or not the widget supports the "pull down to refresh" gesture. */ - pullRefreshEnabled?: boolean; - /** Specifies the text displayed in the pullDown panel while the list is being refreshed. */ - refreshingText?: string; - /** A handler for the scroll event. */ - onScroll?: Function; - /** A Boolean value specifying whether to enable or disable list scrolling. */ - scrollingEnabled?: boolean; - /** Specifies when the widget shows the scrollbar. */ - showScrollbar?: string; - /** Specifies whether or not the widget uses native scrolling. */ - useNativeScrolling?: boolean; - /** A Boolean value specifying whether to enable or disable the bounce-back effect. */ - bounceEnabled?: boolean; - /** A Boolean value specifying if the list is scrolled by content. */ - scrollByContent?: boolean; - /** A Boolean value specifying if the list is scrolled using the scrollbar. */ - scrollByThumb?: boolean; - onItemContextMenu?: Function; - onItemHold?: Function; - /** Specifies whether or not an end-user can collapse groups. */ - collapsibleGroups?: boolean; - /** Specifies whether the next page is loaded when a user scrolls the widget to the bottom or when the "next" button is clicked. */ - pageLoadMode?: string; - /** Specifies whether or not to display controls used to select list items. */ - showSelectionControls?: boolean; - /** Specifies item selection mode. */ - selectionMode?: string; - selectAllText?: string; - onSelectAllChanged?: Function; - /** Specifies the array of items for a context menu called for a list item. */ - menuItems?: Array; - /** Specifies whether an item context menu is shown when a user holds or swipes an item. */ - menuMode?: string; - /** Specifies whether or not an end user can delete list items. */ - allowItemDeleting?: boolean; - /** Specifies the way a user can delete items from the list. */ - itemDeleteMode?: string; - /** Specifies whether or not an end user can reorder list items. */ - allowItemReordering?: boolean; - /** Specifies whether or not to show the loading panel when the DataSource bound to the widget is loading data. */ - indicateLoading?: boolean; - activeStateEnabled?: boolean; - } - /** A list widget. */ - export class dxList extends CollectionWidget { - constructor(element: JQuery, options?: dxListOptions); - constructor(element: Element, options?: dxListOptions); - /** Returns the height of the widget in pixels. */ - clientHeight(): number; - /** Removes the specified item from the list. */ - deleteItem(itemIndex: any): JQueryPromise; - /** Removes the specified item from the list. */ - deleteItem(itemElement: Element): JQueryPromise; - /** Returns a Boolean value that indicates whether or not the specified item is selected. */ - isItemSelected(itemIndex: any): boolean; - /** Returns a Boolean value that indicates whether or not the specified item is selected. */ - isItemSelected(itemElement: Element): boolean; - /** Reloads list data. */ - reload(): void; - /** Moves the specified item to the specified position in the list. */ - reorderItem(itemElement: Element, toItemElement: Element): JQueryPromise; - /** Moves the specified item to the specified position in the list. */ - reorderItem(itemIndex: any, toItemIndex: any): JQueryPromise; - /** Scrolls the list content by the specified number of pixels. */ - scrollBy(distance: number): void; - /** Returns the height of the list content in pixels. */ - scrollHeight(): number; - /** Scrolls list content to the specified position. */ - scrollTo(location: number): void; - /** Scrolls the list to the specified item. */ - scrollToItem(itemElement: Element): void; - /** Scrolls the list to the specified item. */ - scrollToItem(itemIndex: any): void; - /** Returns how far the list content is scrolled from the top. */ - scrollTop(): number; - /** Selects the specified item from the list. */ - selectItem(itemElement: Element): void; - /** Selects the specified item from the list. */ - selectItem(itemIndex: any): void; - /** Deselects the specified item from the list. */ - unselectItem(itemElement: Element): void; - /** Unselects the specified item from the list. */ - unselectItem(itemIndex: any): void; - /** Updates the widget scrollbar according to widget content size. */ - updateDimensions(): JQueryPromise; - /** Expands the specified group. */ - expandGroup(groupIndex: number): JQueryPromise; - /** Collapses the specified group. */ - collapseGroup(groupIndex: number): JQueryPromise; - } - export interface dxGalleryOptions extends CollectionWidgetOptions { - /** The time, in milliseconds, spent on slide animation. */ - animationDuration?: number; - /** Specifies whether or not to animate the displayed item change. */ - animationEnabled?: boolean; - /** A Boolean value specifying whether or not to allow users to switch between items by clicking an indicator. */ - indicatorEnabled?: boolean; - /** A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped. */ - loop?: boolean; - /** The index of the currently active gallery item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to display an indicator that points to the selected gallery item. */ - showIndicator?: boolean; - /** A Boolean value that specifies the availability of the "Forward" and "Back" navigation buttons. */ - showNavButtons?: boolean; - /** The time interval in milliseconds, after which the gallery switches to the next item. */ - slideshowDelay?: number; - /** A Boolean value specifying whether or not to allow users to switch between items by swiping. */ - swipeEnabled?: boolean; - /** Specifies whether or not to display parts of previous and next images along the sides of the current image. */ - wrapAround?: boolean; - /** Specifies if the widget stretches images to fit the total gallery width. */ - stretchImages?: boolean; - /** Specifies the width of an area used to display a single image. */ - initialItemWidth?: number; - } - /** An image gallery widget. */ - export class dxGallery extends CollectionWidget { - constructor(element: JQuery, options?: dxGalleryOptions); - constructor(element: Element, options?: dxGalleryOptions); - /** Shows the specified gallery item. */ - goToItem(itemIndex: number, animation: boolean): JQueryPromise; - /** Shows the next gallery item. */ - nextItem(animation: boolean): JQueryPromise; - /** Shows the previous gallery item. */ - prevItem(animation: boolean): JQueryPromise; - } - export interface dxDropDownEditorOptions extends dxTextBoxOptions { - /** Specifies the current value displayed by the widget. */ - value?: Object; - /** A handler for the closed event. */ - onClosed?: Function; - /** A handler for the opened event. */ - onOpened?: Function; - /** Specifies whether or not the drop-down editor is displayed. */ - opened?: boolean; - /** Specifies whether or not the widget allows an end-user to enter a custom value. */ - fieldEditEnabled?: boolean; - /** Specifies the way an end-user applies the selected value. */ - applyValueMode?: string; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - activeStateEnabled?: boolean; - } - /** A drop-down editor widget. */ - export class dxDropDownEditor extends dxTextBox { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - /** Closes the drop-down editor. */ - close(): void; - /** Opens the drop-down editor. */ - open(): void; - /** Resets the widget's value to null. */ - reset(): void; - /** Returns an <input> element of the widget. */ - field(): JQuery; - /** Returns an HTML element of the popup window content. */ - content(): JQuery; - } - export interface dxDateBoxOptions extends dxTextEditorOptions { - /** A format used to display date/time information. */ - format?: string; - /** A Globalize format string specifying the date display format. */ - formatString?: string; - /** The last date that can be selected within the widget. */ - max?: any; - /** The minimum date that can be selected within the widget. */ - min?: any; - /** The text displayed by the widget when the widget value is not yet specified. This text is also used as a title of the date picker. */ - placeholder?: string; - /** - * Specifies whether or not a user can pick out a date using the drop-down calendar. - * @deprecated Use 'pickerType' option instead. - */ - useCalendar?: boolean; - /** An object or a value, specifying the date and time currently selected using the date box. */ - value?: any; - /** - * Specifies whether or not the widget uses the native HTML input element. - * @deprecated Use 'pickerType' option instead. - */ - useNative?: boolean; - /** Specifies the interval between neighboring values in the popup list in minutes. */ - interval?: number; - /** Specifies the maximum zoom level of a calendar, which is used to pick the date. */ - maxZoomLevel?: string; - /** Specifies the minimal zoom level of a calendar, which is used to pick the date. */ - minZoomLevel?: string; - /** Specifies the type of date/time picker. */ - pickerType?: string; - /** Specifies the message displayed if the typed value is not a valid date or time. */ - invalidDateMessage?: string; - /** Specifies the message displayed if the specified date is later than the max value or earlier than the min value. */ - dateOutOfRangeMessage?: string; - } - /** A date box widget. */ - export class dxDateBox extends dxDropDownEditor { - constructor(element: JQuery, options?: dxDateBoxOptions); - constructor(element: Element, options?: dxDateBoxOptions); - } - export interface dxCheckBoxOptions extends EditorOptions { - activeStateEnabled?: boolean; - /** Specifies the widget state. */ - value?: boolean; - /** Specifies the text displayed by the check box. */ - text?: string; - } - /** A check box widget. */ - export class dxCheckBox extends Editor { - constructor(element: JQuery, options?: dxCheckBoxOptions); - constructor(element: Element, options?: dxCheckBoxOptions); - } - export interface dxCalendarOptions extends EditorOptions { - activeStateEnabled?: boolean; - /** Specifies a date displayed on the current calendar page. */ - currentDate?: Date; - /** Specifies the first day of a week. */ - firstDayOfWeek?: number; - /** The latest date the widget allows to select. */ - max?: Date; - /** The earliest date the widget allows to select. */ - min?: Date; - /** Specifies whether or not the widget displays a button that selects the current date. */ - showTodayButton?: boolean; - /** Specifies the current calendar zoom level. */ - zoomLevel?: string; - /** Specifies the maximum zoom level of the calendar. */ - maxZoomLevel?: string; - /** Specifies the minimum zoom level of the calendar. */ - minZoomLevel?: string; - /** The template to be used for rendering calendar cells. */ - cellTemplate?: any; - } - /** A calendar widget. */ - export class dxCalendar extends Editor { - constructor(element: JQuery, options?: dxCalendarOptions); - constructor(element: Element, options?: dxCalendarOptions); - } - export interface dxButtonOptions extends WidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A handler for the click event. */ - onClick?: any; - /** Specifies the icon to be displayed on the button. */ - icon?: string; - iconSrc?: string; - /** A template to be used for rendering the dxButton widget. */ - template?: any; - /** The text displayed on the button. */ - text?: string; - /** Specifies the button type. */ - type?: string; - /** Specifies the name of the validation group to be accessed in the click event handler. */ - validationGroup?: string; - } - /** A button widget. */ - export class dxButton extends Widget { - constructor(element: JQuery, options?: dxButtonOptions); - constructor(element: Element, options?: dxButtonOptions); - } - export interface dxBoxOptions extends CollectionWidget { - /** Specifies how widget items are aligned along the main direction. */ - align?: string; - /** Specifies the direction of item positioning in the widget. */ - direction?: string; - /** Specifies how widget items are aligned cross-wise. */ - crossAlign?: string; - } - /** A container widget used to arrange inner elements. */ - export class dxBox extends CollectionWidget { - constructor(element: JQuery, options?: dxBoxOptions); - constructor(element: Element, options?: dxBoxOptions); - } - export interface dxResponsiveBoxOptions extends CollectionWidgetOptions { - /** Specifies the collection of rows for the grid used to position layout elements. */ - rows?: Array; - /** Specifies the collection of columns for the grid used to position layout elements. */ - cols?: Array; - /** Specifies the function returning the screen factor depending on the screen width. */ - screenByWidth?: (width: number) => string; - /** Specifies the screen factor with which all elements are located in a single column. */ - singleColumnScreen?: string; - } - /** A widget used to build an adaptive markup that is dependent on screen resolution. */ - export class dxResponsiveBox extends CollectionWidget { - constructor(element: JQuery, options?: dxBoxOptions); - constructor(element: Element, options?: dxBoxOptions); - } - export interface dxAutocompleteOptions extends dxDropDownListOptions { - /** Specifies the current value displayed by the widget. */ - value?: string; - /** The minimum number of characters that must be entered into the text box to begin a search. */ - minSearchLength?: number; - /** Specifies the maximum count of items displayed by the widget. */ - maxItemCount?: number; - /** Gets the currently selected item. */ - selectedItem?: Object; - } - /** A textbox widget that supports autocompletion. */ - export class dxAutocomplete extends dxDropDownList { - constructor(element: JQuery, options?: dxAutocompleteOptions); - constructor(element: Element, options?: dxAutocompleteOptions); - /** Opens the drop-down editor. */ - open(): void; - /** Closes the drop-down editor. */ - close(): void; - } - export interface dxAccordionOptions extends CollectionWidgetOptions { - /** A number specifying the time in milliseconds spent on the animation of the expanding or collapsing of a panel. */ - animationDuration?: number; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies whether all items can be collapsed or whether at least one item must always be expanded. */ - collapsible?: boolean; - /** Specifies whether the widget can expand several items or only a single item at once. */ - multiple?: boolean; - /** The template to be used for rendering dxAccordion items. */ - itemTemplate?: any; - /** A handler for the itemTitleClick event. */ - onItemTitleClick?: any; - /** A handler for the itemTitleHold event. */ - onItemTitleHold?: Function; - /** The template to be used for rendering an item title. */ - itemTitleTemplate?: any; - /** The index number of the currently selected item. */ - selectedIndex?: number; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - } - /** A widget that displays data source items on collapsible panels. */ - export class dxAccordion extends CollectionWidget { - constructor(element: JQuery, options?: dxAccordionOptions); - constructor(element: Element, options?: dxAccordionOptions); - /** Collapses the specified item. */ - collapseItem(index: number): JQueryPromise; - /** Expands the specified item. */ - expandItem(index: number): JQueryPromise; - /** Updates the dimensions of the widget contents. */ - updateDimensions(): JQueryPromise; - } - export interface dxFileUploaderOptions extends EditorOptions { - /** A read-only option that holds a File instance representing the selected file. */ - value?: File; - /** Holds the File instances representing files selected in the widget. */ - values?: Array; - buttonText?: string; - /** The text displayed on the button that opens the file browser. */ - selectButtonText?: string; - /** The text displayed on the button that starts uploading. */ - uploadButtonText?: string; - /** Specifies the text displayed on the area to which an end-user can drop a file. */ - labelText?: string; - /** Specifies the value passed to the name attribute of the underlying input element. */ - name?: string; - /** Specifies whether the widget enables an end-user to select a single file or multiple files. */ - multiple?: boolean; - /** Specifies a file type or several types accepted by the widget. */ - accept?: string; - /** Specifies a target Url for the upload request. */ - uploadUrl?: string; - /** Specifies if an end user can remove a file from the selection and interrupt uploading. */ - allowCanceling?: boolean; - /** Specifies whether or not the widget displays the list of selected files. */ - showFileList?: boolean; - /** Gets the current progress in percentages. */ - progress?: number; - /** The message displayed by the widget when it is ready to upload the specified files. */ - readyToUploadMessage?: string; - /** The message displayed by the widget when uploading is finished. */ - uploadedMessage?: string; - /** The message displayed by the widget on uploading failure. */ - uploadFailedMessage?: string; - /** Specifies how the widget uploads files. */ - uploadMode?: string; - /** A handler for the uploaded event. */ - onUploaded?: Function; - /** A handler for the uploaded event. */ - onProgress?: Function; - /** A handler for the uploadError event. */ - onUploadError?: Function; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - } - /** A widget used to select and upload a file or multiple files. */ - export class dxFileUploader extends Editor { - constructor(element: JQuery, options?: dxFileUploaderOptions); - constructor(element: Element, options?: dxFileUploaderOptions); - } - export interface dxTrackBarOptions extends EditorOptions { - /** The minimum value the widget can accept. */ - min?: number; - /** The maximum value the widget can accept. */ - max?: number; - /** The current widget value. */ - value?: number; - } - /** A base class for track bar widgets. */ - export class dxTrackBar extends Editor { - constructor(element: JQuery, options?: dxTrackBarOptions); - constructor(element: Element, options?: dxTrackBarOptions); - } - export interface dxProgressBarOptions extends dxTrackBarOptions { - /** Specifies a format for the progress status. */ - statusFormat?: any; - /** Specifies whether or not the widget displays a progress status. */ - showStatus?: boolean; - /** A handler for the complete event. */ - onComplete?: Function; - } - /** A widget used to indicate progress. */ - export class dxProgressBar extends dxTrackBar { - constructor(element: JQuery, options?: dxProgressBarOptions); - constructor(element: Element, options?: dxProgressBarOptions); - } - export interface dxSliderOptions extends dxTrackBarOptions { - activeStateEnabled?: boolean; - /** The slider step size. */ - step?: number; - /** The current slider value. */ - value?: number; - /** Specifies whether or not to highlight a range selected within the widget. */ - showRange?: boolean; - /** Specifies the size of a step by which a slider handle is moved when a user uses the Page up or Page down keyboard shortcuts. */ - keyStep?: number; - /** Specifies options for the slider tooltip. */ - tooltip?: { - /** Specifies whether or not the tooltip is enabled. */ - enabled?: boolean; - /** Specifies format for the tooltip. */ - format?: any; - /** Specifies whether the tooltip is located over or under the slider. */ - position?: string; - /** Specifies whether the widget always shows a tooltip or only when a pointer is over the slider. */ - showMode?: string; - }; - /** Specifies options for labels displayed at the min and max values. */ - label?: { - /** Specifies whether or not slider labels are visible. */ - visible?: boolean; - /** Specifies whether labels are located over or under the scale. */ - position?: string; - /** Specifies a format for labels. */ - format?: any; - }; - } - /** A widget that allows a user to select a numeric value within a given range. */ - export class dxSlider extends dxTrackBar { - constructor(element: JQuery, options?: dxSliderOptions); - constructor(element: Element, options?: dxSliderOptions); - } - export interface dxRangeSliderOptions extends dxSliderOptions { - /** The left edge of the interval currently selected using the range slider. */ - start?: number; - /** The right edge of the interval currently selected using the range slider. */ - end?: number; - } - /** A widget that enables a user to select a range of numeric values. */ - export class dxRangeSlider extends dxSlider { - constructor(element: JQuery, options?: dxRangeSliderOptions); - constructor(element: Element, options?: dxRangeSliderOptions); - } - export interface dxFormItemLabel { - /** Specifies the label text. */ - text?: string; - /** Specifies whether or not the label is visible. */ - visible?: boolean; - /** Specifies whether or not a colon is displayed at the end of the current label. */ - showColon?: boolean; - /** Specifies the location of a label against the editor. */ - location?: string; - /** Specifies the label horizontal alignment. */ - alignment?: string; - } - export interface dxFormItem { - /** Specifies the type of the current item. */ - itemType?: string; - /** Specifies whether or not the current form item is visible. */ - visible?: boolean; - /** Specifies the sequence number of the item in a form, group or tab. */ - visibleIndex?: number; - /** Specifies a CSS class to be applied to the form item. */ - cssClass?: string; - /** Specifies the number of columns spanned by the item. */ - colSpan?: number; - } - export interface dxFormSimpleItem extends dxFormItem { - /** Specifies the path to the formData object field bound to the current form item. */ - dataField?: string; - /** Specifies the form item name. */ - name?: string; - /** Specifies which editor widget is used to display and edit the form item value. */ - editorType?: string; - /** Specifies configuration options for the editor widget of the current form item. */ - editorOptions?: Object; - /** A template to be used for rendering the form item. */ - template?: any; - /** Specifies the help text displayed for the current form item. */ - helpText?: string; - /** Specifies whether the current form item is required. */ - isRequired?: boolean; - /** Specifies options for the form item label. */ - label?: dxFormItemLabel; - /** An array of validation rules to be checked for the form item editor. */ - validationRules?: Array; - } - export interface dxFormGroupItem extends dxFormItem { - /** Specifies the group caption. */ - caption?: string; - /** A template to be used for rendering the group item. */ - template?: any; - /** The count of columns in the group layout. */ - colCount?: number; - /** Specifies whether or not all group item labels are aligned. */ - alignItemLabels?: boolean; - /** Holds an array of form items displayed within the group. */ - items?: Array; - } - export interface dxFormTab { - /** Specifies the tab title. */ - title?: string; - /** The count of columns in the tab layout. */ - colCount?: number; - /** Specifies whether or not labels of items displayed within the current tab are aligned. */ - alignItemLabels?: boolean; - /** Holds an array of form items displayed within the tab. */ - items?: Array; - } - export interface dxFormTabbedItem extends dxFormItem { - /** Holds a configuration object for the dxTabPanel widget used to display the current form item. */ - tabPanelOptions?: Object; - /** An array of tab configuration objects. */ - tabs?: Array; - } - export interface dxFormOptions extends WidgetOptions { - /** An object providing data for the form. */ - formData?: Object; - /** The count of columns in the form layout. */ - colCount?: any; - /** Specifies the location of a label against the editor. */ - labelLocation?: string; - /** Specifies whether or not all editors on the form are read-only. */ - readOnly?: boolean; - /** A handler for the fieldDataChanged event. */ - onFieldDataChanged?: (e: Object) => void; - /** A handler for the editorEnterKey event. */ - onEditorEnterKey?: (e: Object) => void; - /** Specifies a function that customizes a form item after it has been created. */ - customizeItem?: Function; - /** The minimum column width used for calculating column count in the form layout. */ - minColWidth?: number; - /** Specifies whether or not all root item labels are aligned. */ - alignItemLabels?: boolean; - /** Specifies whether or not item labels in all groups are aligned. */ - alignItemLabelsInAllGroups?: boolean; - /** Specifies whether or not a colon is displayed at the end of form labels. */ - showColonAfterLabel?: boolean; - /** Specifies whether or not the required mark is displayed for optional fields. */ - showRequiredMark?: boolean; - /** Specifies whether or not the optional mark is displayed for optional fields. */ - showOptionalMark?: boolean; - /** The text displayed for required fields. */ - requiredMark?: string; - /** The text displayed for optional fields. */ - optionalMark?: string; - /** Specifies whether or not the total validation summary is displayed on the form. */ - showValidationSummary?: boolean; - /** Holds an array of form items. */ - items?: Array; - /** A Boolean value specifying whether to enable or disable form scrolling. */ - scrollingEnabled?: boolean; - onContentReady?: Function; - } - /** A form widget used to display and edit values of object fields. */ - export class dxForm extends Widget { - constructor(element: JQuery, options?: dxFormOptions); - constructor(element: Element, options?: dxFormOptions); - /** Updates the specified field of the formData object and the corresponding editor on the form. */ - updateData(dataField: string, value: any): void; - /** Updates the specified fields of the formData object and the corresponding editors on the form. */ - updateData(data: Object): void; - /** Updates the value of a form item option. */ - itemOption(field: string, option: string, value: any): void; - /** Updates the values of form item options. */ - itemOption(field: string, options: Object): void; - /** Returns an editor instance associated with the specified formData field. */ - getEditor(field: string): Object; - /** Updates the dimensions of the widget contents. */ - updateDimensions(): JQueryPromise; - /** Validates the values of all editors on the form against the list of the validation rules specified for each form item. */ - validate(): Object; - } -} -interface JQuery { - dxProgressBar(): JQuery; - dxProgressBar(options: "instance"): DevExpress.ui.dxProgressBar; - dxProgressBar(options: string): any; - dxProgressBar(options: string, ...params: any[]): any; - dxProgressBar(options: DevExpress.ui.dxProgressBarOptions): JQuery; - dxSlider(): JQuery; - dxSlider(options: "instance"): DevExpress.ui.dxSlider; - dxSlider(options: string): any; - dxSlider(options: string, ...params: any[]): any; - dxSlider(options: DevExpress.ui.dxSliderOptions): JQuery; - dxRangeSlider(): JQuery; - dxRangeSlider(options: "instance"): DevExpress.ui.dxRangeSlider; - dxRangeSlider(options: string): any; - dxRangeSlider(options: string, ...params: any[]): any; - dxRangeSlider(options: DevExpress.ui.dxRangeSliderOptions): JQuery; - dxFileUploader(): JQuery; - dxFileUploader(options: "instance"): DevExpress.ui.dxFileUploader; - dxFileUploader(options: string): any; - dxFileUploader(options: string, ...params: any[]): any; - dxFileUploader(options: DevExpress.ui.dxFileUploaderOptions): JQuery; - dxValidator(): JQuery; - dxValidator(options: "instance"): DevExpress.ui.dxValidator; - dxValidator(options: string): any; - dxValidator(options: string, ...params: any[]): any; - dxValidator(options: DevExpress.ui.dxValidatorOptions): JQuery; - dxValidationGroup(): JQuery; - dxValidationGroup(options: "instance"): DevExpress.ui.dxValidationGroup; - dxValidationGroup(options: string): any; - dxValidationGroup(options: string, ...params: any[]): any; - dxValidationSummary(): JQuery; - dxValidationSummary(options: "instance"): DevExpress.ui.dxValidationSummary; - dxValidationSummary(options: string): any; - dxValidationSummary(options: string, ...params: any[]): any; - dxValidationSummary(options: DevExpress.ui.dxValidationSummaryOptions): JQuery; - dxTooltip(): JQuery; - dxTooltip(options: "instance"): DevExpress.ui.dxTooltip; - dxTooltip(options: string): any; - dxTooltip(options: string, ...params: any[]): any; - dxTooltip(options: DevExpress.ui.dxTooltipOptions): JQuery; - dxResizable(): JQuery; - dxResizable(options: "instance"): DevExpress.ui.dxResizable; - dxResizable(options: string): any; - dxResizable(options: string, ...params: any[]): any; - dxResizable(options: DevExpress.ui.dxResizableOptions): JQuery; - dxDropDownList(): JQuery; - dxDropDownList(options: "instance"): DevExpress.ui.dxDropDownList; - dxDropDownList(options: string): any; - dxDropDownList(options: string, ...params: any[]): any; - dxDropDownList(options: DevExpress.ui.dxDropDownListOptions): JQuery; - dxToolbar(): JQuery; - dxToolbar(options: "instance"): DevExpress.ui.dxToolbar; - dxToolbar(options: string): any; - dxToolbar(options: string, ...params: any[]): any; - dxToolbar(options: DevExpress.ui.dxToolbarOptions): JQuery; - dxToast(): JQuery; - dxToast(options: "instance"): DevExpress.ui.dxToast; - dxToast(options: string): any; - dxToast(options: string, ...params: any[]): any; - dxToast(options: DevExpress.ui.dxToastOptions): JQuery; - dxTextEditor(): JQuery; - dxTextEditor(options: "instance"): DevExpress.ui.dxTextEditor; - dxTextEditor(options: string): any; - dxTextEditor(options: string, ...params: any[]): any; - dxTextEditor(options: DevExpress.ui.dxTextEditorOptions): JQuery; - dxTextBox(): JQuery; - dxTextBox(options: "instance"): DevExpress.ui.dxTextBox; - dxTextBox(options: string): any; - dxTextBox(options: string, ...params: any[]): any; - dxTextBox(options: DevExpress.ui.dxTextBoxOptions): JQuery; - dxTextArea(): JQuery; - dxTextArea(options: "instance"): DevExpress.ui.dxTextArea; - dxTextArea(options: string): any; - dxTextArea(options: string, ...params: any[]): any; - dxTextArea(options: DevExpress.ui.dxTextAreaOptions): JQuery; - dxTabs(): JQuery; - dxTabs(options: "instance"): DevExpress.ui.dxTabs; - dxTabs(options: string): any; - dxTabs(options: string, ...params: any[]): any; - dxTabs(options: DevExpress.ui.dxTabsOptions): JQuery; - dxTabPanel(): JQuery; - dxTabPanel(options: "instance"): DevExpress.ui.dxTabPanel; - dxTabPanel(options: string): any; - dxTabPanel(options: string, ...params: any[]): any; - dxTabPanel(options: DevExpress.ui.dxTabPanelOptions): JQuery; - dxSelectBox(): JQuery; - dxSelectBox(options: "instance"): DevExpress.ui.dxSelectBox; - dxSelectBox(options: string): any; - dxSelectBox(options: string, ...params: any[]): any; - dxSelectBox(options: DevExpress.ui.dxSelectBoxOptions): JQuery; - dxTagBox(): JQuery; - dxTagBox(options: "instance"): DevExpress.ui.dxTagBox; - dxTagBox(options: string): any; - dxTagBox(options: string, ...params: any[]): any; - dxTagBox(options: DevExpress.ui.dxTagBoxOptions): JQuery; - dxScrollView(): JQuery; - dxScrollView(options: "instance"): DevExpress.ui.dxScrollView; - dxScrollView(options: string): any; - dxScrollView(options: string, ...params: any[]): any; - dxScrollView(options: DevExpress.ui.dxScrollViewOptions): JQuery; - dxScrollable(): JQuery; - dxScrollable(options: "instance"): DevExpress.ui.dxScrollable; - dxScrollable(options: string): any; - dxScrollable(options: string, ...params: any[]): any; - dxScrollable(options: DevExpress.ui.dxScrollableOptions): JQuery; - dxRadioGroup(): JQuery; - dxRadioGroup(options: "instance"): DevExpress.ui.dxRadioGroup; - dxRadioGroup(options: string): any; - dxRadioGroup(options: string, ...params: any[]): any; - dxRadioGroup(options: DevExpress.ui.dxRadioGroupOptions): JQuery; - dxPopup(): JQuery; - dxPopup(options: "instance"): DevExpress.ui.dxPopup; - dxPopup(options: string): any; - dxPopup(options: string, ...params: any[]): any; - dxPopup(options: DevExpress.ui.dxPopupOptions): JQuery; - dxPopover(): JQuery; - dxPopover(options: "instance"): DevExpress.ui.dxPopover; - dxPopover(options: string): any; - dxPopover(options: string, ...params: any[]): any; - dxPopover(options: DevExpress.ui.dxPopoverOptions): JQuery; - dxOverlay(): JQuery; - dxOverlay(options: "instance"): DevExpress.ui.dxOverlay; - dxOverlay(options: string): any; - dxOverlay(options: string, ...params: any[]): any; - dxOverlay(options: DevExpress.ui.dxOverlayOptions): JQuery; - dxNumberBox(): JQuery; - dxNumberBox(options: "instance"): DevExpress.ui.dxNumberBox; - dxNumberBox(options: string): any; - dxNumberBox(options: string, ...params: any[]): any; - dxNumberBox(options: DevExpress.ui.dxNumberBoxOptions): JQuery; - dxNavBar(): JQuery; - dxNavBar(options: "instance"): DevExpress.ui.dxNavBar; - dxNavBar(options: string): any; - dxNavBar(options: string, ...params: any[]): any; - dxNavBar(options: DevExpress.ui.dxNavBarOptions): JQuery; - dxMultiView(): JQuery; - dxMultiView(options: "instance"): DevExpress.ui.dxMultiView; - dxMultiView(options: string): any; - dxMultiView(options: string, ...params: any[]): any; - dxMultiView(options: DevExpress.ui.dxMultiViewOptions): JQuery; - dxMap(): JQuery; - dxMap(options: "instance"): DevExpress.ui.dxMap; - dxMap(options: string): any; - dxMap(options: string, ...params: any[]): any; - dxMap(options: DevExpress.ui.dxMapOptions): JQuery; - dxLookup(): JQuery; - dxLookup(options: "instance"): DevExpress.ui.dxLookup; - dxLookup(options: string): any; - dxLookup(options: string, ...params: any[]): any; - dxLookup(options: DevExpress.ui.dxLookupOptions): JQuery; - dxLoadPanel(): JQuery; - dxLoadPanel(options: "instance"): DevExpress.ui.dxLoadPanel; - dxLoadPanel(options: string): any; - dxLoadPanel(options: string, ...params: any[]): any; - dxLoadPanel(options: DevExpress.ui.dxLoadPanelOptions): JQuery; - dxLoadIndicator(): JQuery; - dxLoadIndicator(options: "instance"): DevExpress.ui.dxLoadIndicator; - dxLoadIndicator(options: string): any; - dxLoadIndicator(options: string, ...params: any[]): any; - dxLoadIndicator(options: DevExpress.ui.dxLoadIndicatorOptions): JQuery; - dxList(): JQuery; - dxList(options: "instance"): DevExpress.ui.dxList; - dxList(options: string): any; - dxList(options: string, ...params: any[]): any; - dxList(options: DevExpress.ui.dxListOptions): JQuery; - dxGallery(): JQuery; - dxGallery(options: "instance"): DevExpress.ui.dxGallery; - dxGallery(options: string): any; - dxGallery(options: string, ...params: any[]): any; - dxGallery(options: DevExpress.ui.dxGalleryOptions): JQuery; - dxDropDownEditor(): JQuery; - dxDropDownEditor(options: "instance"): DevExpress.ui.dxDropDownEditor; - dxDropDownEditor(options: string): any; - dxDropDownEditor(options: string, ...params: any[]): any; - dxDropDownEditor(options: DevExpress.ui.dxDropDownEditorOptions): JQuery; - dxDateBox(): JQuery; - dxDateBox(options: "instance"): DevExpress.ui.dxDateBox; - dxDateBox(options: string): any; - dxDateBox(options: string, ...params: any[]): any; - dxDateBox(options: DevExpress.ui.dxDateBoxOptions): JQuery; - dxCheckBox(): JQuery; - dxCheckBox(options: "instance"): DevExpress.ui.dxCheckBox; - dxCheckBox(options: string): any; - dxCheckBox(options: string, ...params: any[]): any; - dxCheckBox(options: DevExpress.ui.dxCheckBoxOptions): JQuery; - dxBox(): JQuery; - dxBox(options: "instance"): DevExpress.ui.dxBox; - dxBox(options: string): any; - dxBox(options: string, ...params: any[]): any; - dxBox(options: DevExpress.ui.dxBoxOptions): JQuery; - dxButton(): JQuery; - dxButton(options: "instance"): DevExpress.ui.dxButton; - dxButton(options: string): any; - dxButton(options: string, ...params: any[]): any; - dxButton(options: DevExpress.ui.dxButtonOptions): JQuery; - dxCalendar(): JQuery; - dxCalendar(options: "instance"): DevExpress.ui.dxCalendar; - dxCalendar(options: string): any; - dxCalendar(options: string, ...params: any[]): any; - dxCalendar(options: DevExpress.ui.dxCalendarOptions): JQuery; - dxAccordion(): JQuery; - dxAccordion(options: "instance"): DevExpress.ui.dxAccordion; - dxAccordion(options: string): any; - dxAccordion(options: string, ...params: any[]): any; - dxAccordion(options: DevExpress.ui.dxAccordionOptions): JQuery; - dxResponsiveBox(): JQuery; - dxResponsiveBox(options: "instance"): DevExpress.ui.dxResponsiveBox; - dxResponsiveBox(options: string): any; - dxResponsiveBox(options: string, ...params: any[]): any; - dxResponsiveBox(options: DevExpress.ui.dxResponsiveBoxOptions): JQuery; - dxAutocomplete(): JQuery; - dxAutocomplete(options: "instance"): DevExpress.ui.dxAutocomplete; - dxAutocomplete(options: string): any; - dxAutocomplete(options: string, ...params: any[]): any; - dxAutocomplete(options: DevExpress.ui.dxAutocompleteOptions): JQuery; - dxForm(): JQuery; - dxForm(options: "instance"): DevExpress.ui.dxForm; - dxForm(options: string): any; - dxForm(options: string, ...params: any[]): any; - dxForm(options: DevExpress.ui.dxForm): JQuery; -} - -declare namespace DevExpress.ui { - export interface dxTileViewOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** Specifies the height of the base tile view item. */ - baseItemHeight?: number; - /** Specifies the width of the base tile view item. */ - baseItemWidth?: number; - /** Specifies whether tiles are placed horizontally or vertically. */ - direction?: string; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies the distance in pixels between adjacent tiles. */ - itemMargin?: number; - /** A Boolean value specifying whether or not to display a scrollbar. */ - showScrollbar?: boolean; - } - /** A widget displaying several blocks of data as tiles. */ - export class dxTileView extends CollectionWidget { - constructor(element: JQuery, options?: dxTileViewOptions); - constructor(element: Element, options?: dxTileViewOptions); - /** Returns the current scroll position of the widget content. */ - scrollPosition(): number; - } - export interface dxSwitchOptions extends EditorOptions { - activeStateEnabled?: boolean; - /** Text displayed when the widget is in a disabled state. */ - offText?: string; - /** Text displayed when the widget is in an enabled state. */ - onText?: string; - /** A Boolean value specifying whether the current switch state is "On" or "Off". */ - value?: boolean; - } - /** A switch widget. */ - export class dxSwitch extends Editor { - constructor(element: JQuery, options?: dxSwitchOptions); - constructor(element: Element, options?: dxSwitchOptions); - } - export interface dxSlideOutViewOptions extends WidgetOptions { - /** Specifies the current menu position. */ - menuPosition?: string; - /** Specifies whether or not the menu panel is visible. */ - menuVisible?: boolean; - /** Specifies whether or not the menu is shown when a user swipes the widget content. */ - swipeEnabled?: boolean; - /** A template to be used for rendering menu panel content. */ - menuTemplate?: any; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - } - /** The widget that allows you to slide-out the current view to reveal a custom menu. */ - export class dxSlideOutView extends Widget { - constructor(element: JQuery, options?: dxSlideOutViewOptions); - constructor(element: Element, options?: dxSlideOutViewOptions); - /** Returns an HTML element of the widget menu block. */ - menuContent(): JQuery; - /** Returns an HTML element of the widget content block. */ - content(): JQuery; - /** Displays the widget's menu block. */ - showMenu(): JQueryPromise; - /** Hides the widget's menu block. */ - hideMenu(): JQueryPromise; - /** Toggles the visibility of the widget's menu block. */ - toggleMenuVisibility(): JQueryPromise; - } - export interface dxSlideOutOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A Boolean value specifying whether or not to display a grouped menu. */ - menuGrouped?: boolean; - /** Specifies the current menu position. */ - menuPosition?: string; - /** The name of the template used to display a group header. */ - menuGroupTemplate?: any; - /** The template used to render menu items. */ - menuItemTemplate?: any; - /** A handler for the menuGroupRendered event. */ - onMenuGroupRendered?: Function; - /** A handler for the menuItemRendered event. */ - onMenuItemRendered?: Function; - /** Specifies whether or not the slide-out menu is displayed. */ - menuVisible?: boolean; - /** Indicates whether the menu can be shown/hidden by swiping the widget's main panel. */ - swipeEnabled?: boolean; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - } - /** The widget that allows you to slide-out the current view to reveal an item list. */ - export class dxSlideOut extends CollectionWidget { - constructor(element: JQuery, options?: dxSlideOutOptions); - constructor(element: Element, options?: dxSlideOutOptions); - /** Hides the widget's slide-out menu. */ - hideMenu(): JQueryPromise; - /** Displays the widget's slide-out menu. */ - showMenu(): JQueryPromise; - /** Toggles the visibility of the widget's slide-out menu. */ - toggleMenuVisibility(showing: boolean): JQueryPromise; - } - export interface dxPivotOptions extends CollectionWidgetOptions { - /** The index of the currently active pivot item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to allow users to switch between items by swiping. */ - swipeEnabled?: boolean; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - /** The template to be used for rendering an item title. */ - itemTitleTemplate?: any; - } - /** A widget that is similar to a traditional tab control, but optimized for the phone with simplified end-user interaction. */ - export class dxPivot extends CollectionWidget { - constructor(element: JQuery, options?: dxPivotOptions); - constructor(element: Element, options?: dxPivotOptions); - } - export interface dxPanoramaOptions extends CollectionWidgetOptions { - /** An object exposing options for setting a background image for the panorama. */ - backgroundImage?: { - /** Specifies the height of the panorama's background image. */ - height?: number; - /** Specifies the URL of the image that is used as the panorama's background image. */ - url?: string; - /** Specifies the width of the panorama's background image. */ - width?: number; - }; - /** The index of the currently active panorama item. */ - selectedIndex?: number; - /** Specifies the widget content title. */ - title?: string; - } - /** A widget displaying the required content in a long horizontal canvas that extends beyond the frames of the screen. */ - export class dxPanorama extends CollectionWidget { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - } - export interface dxDropDownMenuOptions extends WidgetOptions { - /** A handler for the buttonClick event. */ - onButtonClick?: any; - /** The name of the icon to be displayed by the DropDownMenu button. */ - buttonIcon?: string; - /** The text displayed in the DropDownMenu button. */ - buttonText?: string; - buttonIconSrc?: string; - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** A handler for the itemClick event. */ - onItemClick?: any; - /** An array of items displayed by the widget. */ - items?: Array; - /** The template to be used for rendering items. */ - itemTemplate?: any; - /** Specifies whether or not to show the drop down menu within a dxPopover widget. */ - usePopover?: boolean; - /** The width of the menu popup in pixels. */ - popupWidth?: any; - /** The height of the menu popup in pixels. */ - popupHeight?: any; - /** Specifies whether or not the drop-down menu is displayed. */ - opened?: boolean; - hoverStateEnabled?: boolean; - activeStateEnabled?: boolean; - } - /** A drop-down menu widget. */ - export class dxDropDownMenu extends Widget { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - /** This section lists the data source fields that are used in a default template for drop-down menu items. */ - /** Opens the drop-down menu. */ - open(): void; - /** Closes the drop-down menu. */ - close(): void; - } - export interface dxActionSheetOptions extends CollectionWidgetOptions { - /** A handler for the cancelClick event. */ - onCancelClick?: any; - /** The text displayed in the button that closes the action sheet. */ - cancelText?: string; - /** Specifies whether or not to display the Cancel button in action sheet. */ - showCancelButton?: boolean; - /** A Boolean value specifying whether or not the title of the action sheet is visible. */ - showTitle?: boolean; - /** Specifies the element the action sheet popover points at. */ - target?: any; - /** The title of the action sheet. */ - title?: string; - /** Specifies whether or not to show the action sheet within a dxPopover widget. */ - usePopover?: boolean; - /** A Boolean value specifying whether or not the dxActionSheet widget is visible. */ - visible?: boolean; - } - /** A widget consisting of a set of choices related to a certain task. */ - export class dxActionSheet extends CollectionWidget { - constructor(element: JQuery, options?: dxActionSheetOptions); - constructor(element: Element, options?: dxActionSheetOptions); - /** Hides the widget. */ - hide(): JQueryPromise; - /** Shows the widget. */ - show(): JQueryPromise; - /** Shows or hides the widget depending on the Boolean value passed as the parameter. */ - toggle(showing: boolean): JQueryPromise; - } -} -interface JQuery { - dxTileView(): JQuery; - dxTileView(options: "instance"): DevExpress.ui.dxTileView; - dxTileView(options: string): any; - dxTileView(options: string, ...params: any[]): any; - dxTileView(options: DevExpress.ui.dxTileViewOptions): JQuery; - dxSwitch(): JQuery; - dxSwitch(options: "instance"): DevExpress.ui.dxSwitch; - dxSwitch(options: string): any; - dxSwitch(options: string, ...params: any[]): any; - dxSwitch(options: DevExpress.ui.dxSwitchOptions): JQuery; - dxSlideOut(): JQuery; - dxSlideOut(options: "instance"): DevExpress.ui.dxSlideOut; - dxSlideOut(options: string): any; - dxSlideOut(options: string, ...params: any[]): any; - dxSlideOut(options: DevExpress.ui.dxSlideOutOptions): JQuery; - dxPivot(): JQuery; - dxPivot(options: "instance"): DevExpress.ui.dxPivot; - dxPivot(options: string): any; - dxPivot(options: string, ...params: any[]): any; - dxPivot(options: DevExpress.ui.dxPivotOptions): JQuery; - dxPanorama(): JQuery; - dxPanorama(options: "instance"): DevExpress.ui.dxPanorama; - dxPanorama(options: string): any; - dxPanorama(options: string, ...params: any[]): any; - dxPanorama(options: DevExpress.ui.dxPanoramaOptions): JQuery; - dxActionSheet(): JQuery; - dxActionSheet(options: "instance"): DevExpress.ui.dxActionSheet; - dxActionSheet(options: string): any; - dxActionSheet(options: string, ...params: any[]): any; - dxActionSheet(options: DevExpress.ui.dxActionSheetOptions): JQuery; - dxDropDownMenu(): JQuery; - dxDropDownMenu(options: "instance"): DevExpress.ui.dxDropDownMenu; - dxDropDownMenu(options: string): any; - dxDropDownMenu(options: string, ...params: any[]): any; - dxDropDownMenu(options: DevExpress.ui.dxDropDownMenuOptions): JQuery; -} -declare namespace DevExpress.data { - export interface XmlaStoreOptions { - /** The HTTP address to an XMLA OLAP server. */ - url?: string; - /** The name of the database associated with the Store. */ - catalog?: string; - /** The cube name. */ - cube?: string; - beforeSend?: (request: Object) => void; - } - /** A Store that provides access to an OLAP cube using the XMLA standard. */ - export class XmlaStore { - constructor(options: XmlaStoreOptions); - } - export interface PivotGridField { - index?: number; - /** A boolean value specifying whether or not the field is visible in the pivot grid and the Field Chooser. */ - visible?: boolean; - /** Name of the data source field containing data for the pivot grid field. */ - dataField?: string; - /** A caption that will be displayed in the pivot grid's field chooser to identify the field. */ - caption?: string; - /** Specifies a type of field values. */ - dataType?: string; - /** Specifies how the values of the current field are combined into groups. Cannot be used for the XmlaStore store type. */ - groupInterval?: any; - /** Specifies how to aggregate field data. Cannot be used for the XmlaStore store type. */ - summaryType?: string; - /** Allows you to use a custom aggregate function to calculate the summary values. Cannot be used for the XmlaStore store type. */ - calculateCustomSummary?: (options: { - summaryProcess?: string; - value?: any; - totalValue?: any; - }) => void; - /** Specifies the function that determines how to split data from the data source into ranges for header items. Cannot be used for the XmlaStore store type. */ - selector?: (data: Object) => any; - /** Type of the area where the field is located. */ - area?: string; - /** Index among the other fields displayed within the same area. */ - areaIndex?: number; - /** The name of the folder in which the field is located. */ - displayFolder?: string; - /** The name of the group to which the field belongs. */ - groupName?: string; - /** The index of the field within a group. */ - groupIndex?: number; - /** Specifies the initial sort order of field values. */ - sortOrder?: string; - /** Specifies how field data should be sorted. Can be used for the XmlaStore store type only. */ - sortBy?: string; - /** Specifies the data field against which the header items of this field should be sorted. */ - sortBySummaryField?: string; - /** The array of field names that specify a path to column/row whose summary field is used for sorting of this field's header items. */ - sortBySummaryPath?: Array; - /** The filter values for the current field. */ - filterValues?: Array; - /** The filter type for the current field. */ - filterType?: string; - /** Indicates whether all header items of the field's header level are expanded. */ - expanded?: boolean; - /** Specifies whether the field should be treated as a Data Field. */ - isMeasure?: boolean; - /** Specifies a display format for field values. */ - format?: string; - /** Specifies a callback function that returns the text to be displayed in the cells of a field. */ - customizeText?: (cellInfo: { value: any; valueText: string }) => string; - /** Specifies a precision for formatted field values. */ - precision?: number; - /** Specifies how to sort the header items. */ - sortingMethod?: (a: Object, b: Object) => number; - /** Allows an end-user to change sorting options. */ - allowSorting?: boolean; - /** Allows an end-user to sort columns by summary values. */ - allowSortingBySummary?: boolean; - /** Allows an end-user to change filtering options. */ - allowFiltering?: boolean; - /** Allows an end-user to expand/collapse all header items within a header level. */ - allowExpandAll?: boolean; - /** Specifies the absolute width of the field in the pivot grid. */ - width?: number; - /** Specifies the summary post-processing algorithm. */ - summaryDisplayMode?: string; - /** Specifies whether to summarize each next summary value with the previous one by rows or columns. */ - runningTotal?: string; - /** Specifies whether to allow the predefined summary post-processing functions ('absoluteVariation' and 'percentVariation') and runningTotal to take values of different groups into account. */ - allowCrossGroupCalculation?: boolean; - /** Specifies a callback function that allows you to modify summary values after they are calculated. */ - calculateSummaryValue?: (e: Object) => number; - /** Specifies whether or not to display Total values for the field. */ - showTotals?: boolean; - /** Specifies whether or not to display Grand Total values for the field. */ - showGrandTotals?: boolean; - } - export class SummaryCell { - /** Gets the parent cell in a specified direction. */ - parent(direction: string): SummaryCell; - /** Gets all children cells in a specified direction. */ - children(direction: string): Array; - /** Gets a partial Grand Total cell of a row or column. */ - grandTotal(direction: string): SummaryCell; - /** Gets the Grand Total of the entire pivot grid. */ - grandTotal(): SummaryCell; - /** Gets the cell next to the current one in a specified direction. */ - next(direction: string): SummaryCell; - /** Gets the cell next to current in a specified direction. */ - next(direction: string, allowCrossGroup: boolean): SummaryCell; - /** Gets the cell prior to the current one in a specified direction. */ - prev(direction: string): SummaryCell; - /** Gets the cell previous to current in a specified direction. */ - prev(direction: string, allowCrossGroup: boolean): SummaryCell; - /** Gets the child cell in a specified direction. */ - child(direction: string, fieldValue: any): SummaryCell; - /** Gets the cell located by the path of the source cell with one field value changed. */ - slice(field: PivotGridField, value: any): SummaryCell; - /** Gets the header cell of a row or column field to which the current cell belongs. */ - field(area: string): PivotGridField; - /** Gets the value of the current cell. */ - value(): any; - /** Gets the value of the current cell. */ - value(isCalculatedValue: boolean): any; - /** Gets the value of any field linked with the current cell. */ - value(field: PivotGridField): any; - /** Gets the value of any field linked with the current cell. */ - value(field: PivotGridField, isCalculatedValue: boolean): any; - } - export interface PivotGridDataSourceOptions { - /** Specifies the underlying Store instance used to access data. */ - store?: any; - /** Indicates whether or not the automatic field generation from data in the Store is enabled. */ - retrieveFields?: boolean; - /** Specifies data filtering conditions. Cannot be used for the XmlaStore store type. */ - filter?: Object; - /** An array of pivot grid fields. */ - fields?: Array; - /** A handler for the changed event. */ - onChanged?: () => void; - /** A handler for the loadingChanged event. */ - onLoadingChanged?: (isLoading: boolean) => void; - /** A handler for the loadError event. */ - onLoadError?: (e?: Object) => void; - /** A handler for the fieldsPrepared event. */ - onFieldsPrepared?: (e?: Array) => void; - } - /** An object that provides access to data for the dxPivotGrid widget. */ - export class PivotGridDataSource implements EventsMixin { - constructor(options?: PivotGridDataSource); - /** Starts reloading data from any store and updating the data source. */ - reload(): JQueryPromise; - /** Starts updating the data source. Reloads data from the XMLA store only. */ - load(): JQueryPromise; - /** Indicates whether or not the PivotGridDataSource is currently being loaded. */ - isLoading(): boolean; - /** Gets data displayed in a PivotGrid. */ - getData(): Object; - /** Gets all fields within a specified area. */ - getAreaFields(area: string, collectGroups: boolean): Array; - /** Gets all fields from the data source. */ - fields(): Array; - /** Sets the fields option. */ - fields(fields: Array): void; - /** Gets current options of a specified field. */ - field(id: any): PivotGridField; - /** Sets one or more options of a specified field. */ - field(id: any, field: PivotGridField): void; - /** Collapses a specified header item. */ - collapseHeaderItem(area: string, path: Array): void; - /** Expands a specified header item. */ - expandHeaderItem(area: string, path: Array): void; - /** Expands all header items of a field. */ - expandAll(id: any): void; - /** Collapses all header items of a field. */ - collapseAll(id: any): void; - /** Disposes of all resources associated with this PivotGridDataSource. */ - dispose(): void; - /** Gets the current filter expression. Cannot be used for the XmlaStore store type. */ - filter(): Object; - /** Applies a new filter expression. Cannot be used for the XmlaStore store type. */ - filter(filterExpr: Object): void; - /** Provides access to a list of records (facts) that were used to calculate a specific summary. */ - createDrillDownDataSource(options: { - columnPath?: Array; - rowPath?: Array; - dataIndex?: number; - maxRowCount?: number; - customColumns?: Array; - }): DevExpress.data.DataSource; - /** Gets the current PivotGridDataSource state (fields configuration, sorting, filters, expanded headers, etc.) */ - state(): Object; - /** Sets the PivotGridDataSource state. */ - state(state: Object): void; - on(eventName: string, eventHandler: Function): PivotGridDataSource; - on(events: { [eventName: string]: Function; }): PivotGridDataSource; - off(eventName: string): PivotGridDataSource; - off(eventName: string, eventHandler: Function): PivotGridDataSource; - } -} -declare namespace DevExpress.ui { - export interface dxSchedulerOptions extends WidgetOptions { - /** Specifies a date displayed on the current scheduler view by default. */ - currentDate?: Date; - /** The earliest date the widget allows you to select. */ - min?: Date; - /** The latest date the widget allows you to select. */ - max?: Date; - /** Specifies the view used in the scheduler by default. */ - currentView?: string; - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** Specifies the first day of a week. */ - firstDayOfWeek?: number; - /** The template to be used for rendering appointments. */ - appointmentTemplate?: any; - /** The template to be used for rendering an appointment tooltip. */ - appointmentTooltipTemplate?: any; - /** Lists the views to be available within the scheduler's View Selector. */ - views?: Array; - /** Specifies the resource kinds by which the scheduler's appointments are grouped in a timetable. */ - groups?: Array; - /** Specifies a start hour in the scheduler view's time interval. */ - startDayHour?: number; - /** Specifies an end hour in the scheduler view's time interval. */ - endDayHour?: number; - /** Specifies whether or not the "All-day" panel is visible. */ - showAllDayPanel?: boolean; - /** Specifies cell duration in minutes. */ - cellDuration?: number; - /** Specifies the edit mode for recurrent appointments. */ - recurrenceEditMode?: string; - /** Specifies which editing operations an end-user can perform on appointments. */ - editing?: { - /** Specifies whether or not an end-user can add appointments. */ - allowAdding?: boolean; - /** Specifies whether or not an end-user can change appointment options. */ - allowUpdating?: boolean; - /** Specifies whether or not an end-user can delete appointments. */ - allowDeleting?: boolean; - /** Specifies whether or not an end-user can change an appointment duration. */ - allowResizing?: boolean; - /** Specifies whether or not an end-user can drag appointments. */ - allowDragging?: boolean; - } - /** Specifies an array of resources available in the scheduler. */ - resources?: Array<{ - /** Indicates whether or not several resources of this kind can be assigned to an appointment. */ - allowMultiple?: boolean; - /** - * Indicates whether or not resources of this kind have priority in the color identification of the appointments that have resources of different kinds assigned. - * @deprecated Use the 'useColorAsDefault' property instead - */ - mainColor?: boolean; - /** Indicates whether or not resources of this kind have priority in the color identification of the appointments that have resources of different kinds assigned. */ - useColorAsDefault?: boolean; - /** A data source used to fetch resources to be available in the scheduler. */ - dataSource?: any; - /** Specifies the resource object field whose value is displayed by the Resource editor in the Appointment popup window. */ - displayExpr?: any; - /** Specifies the resource object field that is used as a value of the Resource editor in the Appointment popup window. */ - valueExpr?: any; - /** The name of the appointment object field that specifies a resource of this kind. */ - field?: string; - /** Specifies the label of the Appointment popup window field that allows end users to assign a resource of this kind. */ - label?: string; - }>; - /** A handler for the AppointmentAdding event. */ - onAppointmentAdding?: Function; - /** A handler for the appointmentAdded event. */ - onAppointmentAdded?: Function; - /** A handler for the AppointmentUpdating event. */ - onAppointmentUpdating?: Function; - /** A handler for the appointmentUpdated event. */ - onAppointmentUpdated?: Function; - /** A handler for the AppointmentDeleting event. */ - onAppointmentDeleting?: Function; - /** A handler for the appointmentDeleted event. */ - onAppointmentDeleted?: Function; - /** A handler for the appointmentRendered event. */ - onAppointmentRendered?: Function; - /** A handler for the appointmentClick event. */ - onAppointmentClick?: any; - /** A handler for the appointmentDblClick event. */ - onAppointmentDblClick?: any; - /** A handler for the cellClick event. */ - onCellClick?: any; - /** A handler for the appointmentFormCreated event. */ - onAppointmentFormCreated?: Function; - /** Specifies whether or not an end-user can scroll the view horizontally. */ - horizontalScrollingEnabled?: boolean; - /** Specifies whether a user can switch views using tabs or a drop-down menu. */ - useDropDownViewSwitcher?: boolean; - /** Specifies the name of the data source item field that defines the start of the appointment. */ - startDateExpr?: string; - /** Specifies the name of the data source item field that defines the ending of the appointment. */ - endDateExpr?: string; - /** Specifies the name of the data source item field that holds the subject of the appointment. */ - textExpr?: string; - /** Specifies the name of the data source item field whose value holds the description of the corresponding appointment. */ - descriptionExpr?: string; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding appointment is an all-day appointment. */ - allDayExpr?: string; - /** Specifies the name of the data source item field that defines a recurrence rule for generating recurring appointments. */ - recurrenceRuleExpr?: string; - /** Specifies the name of the data source item field that defines exceptions for the current recurring appointment. */ - recurrenceExceptionExpr?: string; - /** Specifies whether filtering is performed on the server or client side. */ - remoteFiltering?: boolean; - } - /** A widget that displays scheduled data using different views and provides the capability to load, add and edit appointments. */ - export class dxScheduler extends Widget { - constructor(element: JQuery, options?: dxSchedulerOptions); - constructor(element: Element, options?: dxSchedulerOptions); - /** Add the appointment defined by the object passed as a parameter to the data associated with the widget. */ - addAppointment(appointment: Object): void; - /** Updates the appointment specified by the first method parameter by the appointment object specified by the second method parameter in the the data associated with the widget. */ - updateAppointment(target: Object, appointment: Object): void; - /** Deletes the appointment defined by the parameter from the the data associated with the widget. */ - deleteAppointment(appointment: Object): void; - /** Scrolls the scheduler work space to the specified time. */ - scrollToTime(hours: number, minutes: number): void; - /** Displays the Appointment Details popup. */ - showAppointmentPopup(appointmentData: Object, createNewAppointment?: boolean): void; - } - export interface dxColorBoxOptions extends dxDropDownEditorOptions { - /** Specifies the text displayed on the button that applies changes and closes the drop-down editor. */ - applyButtonText?: string; - applyValueMode?: string; - /** Specifies the text displayed on the button that cancels changes and closes the drop-down editor. */ - cancelButtonText?: string; - /** Specifies whether or not the widget value includes the alpha channel component. */ - editAlphaChannel?: boolean; - /** Specifies the size of a step by which a handle is moved using a keyboard shortcut. */ - keyStep?: number; - } - /** A widget used to specify a color value. */ - export class dxColorBox extends dxDropDownEditor { - constructor(element: JQuery, options?: dxColorBoxOptions); - constructor(element: Element, options?: dxColorBoxOptions); - } - export interface HierarchicalCollectionWidgetOptions extends CollectionWidgetOptions { - /** Specifies the name of the data source item field whose value is displayed by the widget. */ - displayExpr?: any; - /** Specifies the name of the data source item field used as a key. */ - keyExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding widget items is selected. */ - selectedExpr?: any; - /** Specifies the name of the data source item field that contains an array of nested items. */ - itemsExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding widget item is disabled. */ - disabledExpr?: any; - /** Specifies the name of the data source item field that holds the key of the parent item. */ - parentIdExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding widget items is expanded. */ - expandedExpr?: any; - hoverStateEnabled?: boolean; - focusStateEnabled?: boolean; - } - export class HierarchicalCollectionWidget extends CollectionWidget { - } - export interface dxTreeViewOptions extends HierarchicalCollectionWidgetOptions { - /** Specifies whether or not to animate item collapsing and expanding. */ - animationEnabled?: boolean; - /** Specifies whether a nested or plain array is used as a data source. */ - dataStructure?: string; - /** Specifies whether or not a user can expand all tree view items by the "*" hot key. */ - expandAllEnabled?: boolean; - /** - * Specifies whether or not a check box is displayed at each tree view item. - * @deprecated Use the showCheckBoxesMode option instead. - */ - showCheckBoxes?: boolean; - /** Specifies the current check boxes display mode. */ - showCheckBoxesMode?: string; - /** Specifies whether or not to select nodes recursively. */ - selectNodesRecursive?: boolean; - /** Specifies whether or not all parent nodes of an initially expanded node are displayed expanded. */ - expandNodesRecursive?: boolean; - /** - * Specifies whether the "Select All" check box is displayed over the tree view. - * @deprecated Use the showCheckBoxesMode option instead. - */ - selectAllEnabled?: boolean; - /** Specifies the text displayed at the "Select All" check box. */ - selectAllText?: string; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding node includes child nodes. */ - hasItemsExpr?: any; - /** Specifies if the virtual mode is enabled. */ - virtualModeEnabled?: boolean; - /** Specifies the parent ID value of the root item. */ - rootValue?: any; - /** Specifies the current value used to filter tree view items. */ - searchValue?: string; - /** A string value specifying available scrolling directions. */ - scrollDirection?: string; - /** A handler for the itemSelected event. */ - onItemSelected?: Function; - /** A handler for the itemExpanded event. */ - onItemExpanded?: Function; - /** A handler for the itemCollapsed event. */ - onItemCollapsed?: Function; - onItemClick?: Function; - onItemContextMenu?: Function; - onItemRendered?: Function; - onItemHold?: Function; - } - /** A widget displaying specified data items as a tree. */ - export class dxTreeView extends HierarchicalCollectionWidget { - constructor(element: JQuery, options?: dxTreeViewOptions); - constructor(element: Element, options?: dxTreeViewOptions); - /** Updates the tree view scrollbars according to the current size of the widget content. */ - updateDimensions(): JQueryPromise; - /** Selects the specified item. */ - selectItem(itemElement: any): void; - /** Unselects the specified item. */ - unselectItem(itemElement: any): void; - /** Expands the specified item. */ - expandItem(itemElement: any): void; - /** Collapses the specified item. */ - collapseItem(itemElement: any): void; - /** Returns all nodes of the tree view. */ - getNodes(): Array; - /** Selects all widget items. */ - selectAll(): void; - /** Unselects all widget items. */ - unselectAll(): void; - } - export interface dxMenuBaseOptions extends HierarchicalCollectionWidgetOptions { - /** An object that defines the animation options of the widget. */ - animation?: fx.AnimationOptions; - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** Specifies the name of the CSS class associated with the menu. */ - cssClass?: string; - /** Holds an array of menu items. */ - items?: Array; - /** Specifies whether or not an item becomes selected if an end-user clicks it. */ - selectionByClick?: boolean; - /** Specifies the selection mode supported by the menu. */ - selectionMode?: string; - /** Specifies options of submenu showing and hiding. */ - showSubmenuMode?: { - /** Specifies the mode name. */ - name?: string; - /** Specifies the delay of submenu show and hiding. */ - delay?: { - /** The time span after which the submenu is shown. */ - show?: number; - /** The time span after which the submenu is hidden. */ - hide?: number; - }; - }; - } - export class dxMenuBase extends HierarchicalCollectionWidget { - constructor(element: JQuery, options?: dxMenuBaseOptions); - constructor(element: Element, options?: dxMenuBaseOptions); - /** Selects the specified item. */ - selectItem(itemElement: any): void; - /** Unselects the specified item. */ - unselectItem(itemElement: any): void; - } - export interface dxMenuOptions extends dxMenuBaseOptions { - /** Specifies whether or not the submenu is hidden when the mouse pointer leaves it. */ - hideSubmenuOnMouseLeave?: boolean; - /** Specifies whether the menu has horizontal or vertical orientation. */ - orientation?: string; - /** Specifies options for showing and hiding the first level submenu. */ - showFirstSubmenuMode?: { - /** Specifies the mode name. */ - name?: string; - /** Specifies the delay of submenu showing and hiding. */ - delay?: { - /** The time span after which the submenu is shown. */ - show?: number; - /** The time span after which the submenu is hidden. */ - hide?: number; - }; - }; - /** Specifies the direction at which the submenus are displayed. */ - submenuDirection?: string; - /** A handler for the submenuHidden event. */ - onSubmenuHidden?: Function; - /** A handler for the submenuHiding event. */ - onSubmenuHiding?: Function; - /** A handler for the submenuShowing event. */ - onSubmenuShowing?: Function; - /** A handler for the submenuShown event. */ - onSubmenuShown?: Function; - } - /** A menu widget. */ - export class dxMenu extends dxMenuBase { - constructor(element: JQuery, options?: dxMenuOptions); - constructor(element: Element, options?: dxMenuOptions); - } - export interface dxContextMenuOptions extends dxMenuBaseOptions { - /** Holds an object that specifies options of alternative menu invocation. */ - alternativeInvocationMode?: { - /** Specifies whether or not the standard context menu invocation (on a right mouse click or on a long tap) is disabled. */ - enabled?: Boolean; - /** Specifies the element used to invoke the context menu. */ - invokingElement?: any; - }; - /** A handler for the hidden event. */ - onHidden?: Function; - /** A handler for the hiding event. */ - onHiding?: Function; - /** A handler for the positioning event. */ - onPositioning?: Function; - /** A handler for the showing event. */ - onShowing?: Function; - /** A handler for the shown event. */ - onShown?: Function; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** Specifies the direction at which submenus are displayed. */ - submenuDirection?: string; - /** The target element associated with a popover. */ - target?: any; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - } - /** A context menu widget. */ - export class dxContextMenu extends dxMenuBase { - constructor(element: JQuery, options?: dxContextMenuOptions); - constructor(element: Element, options?: dxContextMenuOptions); - /** Toggles the visibility of the widget. */ - toggle(showing: boolean): JQueryPromise; - /** Shows the widget. */ - show(): JQueryPromise; - /** Hides the widget. */ - hide(): JQueryPromise; - } - export interface dxRemoteOperations { - /** Specifies whether or not filtering must be performed on the server side. */ - filtering?: boolean; - /** Specifies whether or not paging must be performed on the server side. */ - paging?: boolean; - /** Specifies whether or not sorting must be performed on the server side. */ - sorting?: boolean; - /** Specifies whether or not grouping must be performed on the server side. */ - grouping?: boolean; - /** Specifies whether or not summaries calculation must be performed on the server side. */ - summary?: boolean; - } - export interface dxDataGridColumn { - /** Specifies the content alignment within column cells. */ - alignment?: string; - /** Specifies whether the values in a column can be edited at runtime. Setting this option makes sense only when editing is enabled for a grid. */ - allowEditing?: boolean; - /** Specifies whether or not a column can be used for filtering grid records. Setting this option makes sense only when the filter row and column header filtering are visible. */ - allowFiltering?: boolean; - /** Specifies whether or not to allow filtering by this column using its header. */ - allowHeaderFiltering?: boolean; - /** Specifies whether or not the column can be anchored to a grid edge by end users. Setting this option makes sense only when the columnFixing | enabled option is set to true. */ - allowFixing?: boolean; - /** Specifies if a column can be used for searching grid records. Setting this option makes sense only when the search panel is visible. */ - allowSearch?: boolean; - /** Specifies whether a column can be used for grouping grid records at runtime. Setting this option makes sense only when the group panel is visible. */ - allowGrouping?: boolean; - /** Specifies whether or not a column can be hidden by a user. Setting this option makes sense only when the column chooser is visible. */ - allowHiding?: boolean; - /** Specifies whether or not a particular column can be used in column reordering. Setting this option makes sense only when the allowColumnReordering option is set to true. */ - allowReordering?: boolean; - /** Specifies whether or not a particular column can be resized by a user. Setting this option makes sense only when the allowColumnResizing option is true. */ - allowResizing?: boolean; - /** Specifies whether grid records can be sorted by a specific column at runtime. Setting this option makes sense only when the sorting mode differs from none. */ - allowSorting?: boolean; - /** Specifies whether groups appear expanded or not when records are grouped by a specific column. Setting this option makes sense only when grouping is allowed for this column. */ - autoExpandGroup?: boolean; - /** Specifies a callback function that returns a value to be displayed in a column cell. */ - calculateCellValue?: (rowData: Object) => string; - /** Specifies a callback function to be invoked after the cell value is edited by an end-user and before the new value is saved to the data source. */ - setCellValue?: (rowData: Object, value: any) => void; - /** Specifies a callback function that defines filters for customary calculated grid cells. */ - calculateFilterExpression?: (filterValue: any, selectedFilterOperation: string, target: string) => Array; - /** Specifies a caption for a column. */ - caption?: string; - /** Specifies a custom template for grid column cells. */ - cellTemplate?: any; - /** Specifies a CSS class to be applied to a column. */ - cssClass?: string; - /** Specifies how to get a value to be displayed in a cell when it is not in an editing state. */ - calculateDisplayValue?: any; - /** Specifies a field name or a function that returns a field name or a value to be used for grouping column cells. */ - calculateGroupValue?: any; - /** Specifies a field name or a function that returns a field name or a value to be used for sorting column cells. */ - calculateSortValue?: any; - /** Specifies a callback function that returns the text to be displayed in the cells of a column. */ - customizeText?: (cellInfo: { value: any; valueText: string }) => string; - /** Specifies the field of a data source that provides data for a column. */ - dataField?: string; - /** Specifies the required type of column values. */ - dataType?: string; - /** Specifies a custom template for the cell of a grid column when it is in an editing state. */ - editCellTemplate?: any; - /** Specifies configuration options for the editor widget of the current column. */ - editorOptions?: Object; - /** Specifies whether HTML tags are displayed as plain text or applied to the values of the column. */ - encodeHtml?: boolean; - /** In a boolean column, replaces all false items with a specified text. */ - falseText?: string; - /** Specifies the set of available filter operations. */ - filterOperations?: Array; - /** Specifies a filter value for a column. */ - filterValue?: any; - /** Specifies initial filter values for the column's header filter. */ - filterValues?: Array; - /** Specifies whether to include or exclude the records with the values selected in the column's header filter. */ - filterType?: string; - /** Indicates whether the column takes part in horizontal grid scrolling or is anchored to a grid edge. */ - fixed?: boolean; - /** Specifies the grid edge to which the column is anchored. */ - fixedPosition?: string; - /** Specifies a format for the values displayed in a column. */ - format?: string; - /** Specifies a custom template for the group cell of a grid column. */ - groupCellTemplate?: any; - /** Specifies the index of a column when grid records are grouped by the values of this column. */ - groupIndex?: number; - /** Specifies a custom template for the header of a grid column. */ - headerCellTemplate?: any; - /** Specifies options of a lookup column. */ - lookup?: { - /** Specifies whether or not a user can nullify values of a lookup column. */ - allowClearing?: boolean; - /** Specifies the data source providing data for a lookup column. */ - dataSource?: any; - /** Specifies the expression defining the data source field whose values must be displayed. */ - displayExpr?: any; - /** Specifies the expression defining the data source field whose values must be replaced. */ - valueExpr?: string; - }; - /** Specifies column-level options for filtering using a column header filter. */ - headerFilter?: { - /** Specifies the data source to be used for the header filter. */ - dataSource?: any; - /** Specifies how header filter values should be combined into groups. */ - groupInterval?: any; - }; - /** Specifies a precision for formatted values displayed in a column. */ - precision?: number; - /** Specifies a filter operation applied to a column. */ - selectedFilterOperation?: string; - /** Specifies whether or not the column displays its values by using editors. */ - showEditorAlways?: boolean; - /** Specifies whether or not to display the column when grid records are grouped by it. */ - showWhenGrouped?: boolean; - /** Specifies the index of a column when grid records are sorted by the values of this column. */ - sortIndex?: number; - /** Specifies the initial sort order of column values. */ - sortOrder?: string; - /** In a boolean column, replaces all true items with a specified text. */ - trueText?: string; - /** Specifies whether a column is visible or not. */ - visible?: boolean; - /** Specifies the sequence number of the column in the grid. */ - visibleIndex?: number; - /** Specifies a column width in pixels or percentages. */ - width?: any; - /** Specifies an array of validation rules to be checked when updating column cell values. */ - validationRules?: Array; - /** Specifies whether or not to display the header of a hidden column in the column chooser. */ - showInColumnChooser?: boolean; - /** Specifies the identifier of the column. */ - name?: string; - /** The form item configuration object. Used only when the editing mode is "form". */ - formItem?: DevExpress.ui.dxFormItem; - } - export interface dxDataGridOptions extends WidgetOptions { - /** Specifies whether the outer borders of the grid are visible or not. */ - showBorders?: boolean; - /** Indicates whether to show the error row for the grid. */ - errorRowEnabled?: boolean; - /** A handler for the rowValidating event. */ - onRowValidating?: (e: Object) => void; - /** A handler for the contextMenuPreparing event. */ - onContextMenuPreparing?: (e: Object) => void; - /** A handler for the initNewRow event. */ - onInitNewRow?: (e: { data: Object }) => void; - /** A handler for the rowInserted event. */ - onRowInserted?: (e: { data: Object; key: any }) => void; - /** A handler for the rowInserting event. */ - onRowInserting?: (e: { data: Object; cancel: any }) => void; - /** A handler for the rowRemoved event. */ - onRowRemoved?: (e: { data: Object; key: any }) => void; - /** A handler for the rowRemoving event. */ - onRowRemoving?: (e: { data: Object; key: any; cancel: any }) => void; - /** A handler for the rowUpdated event. */ - onRowUpdated?: (e: { data: Object; key: any }) => void; - /** A handler for the rowUpdating event. */ - onRowUpdating?: (e: { oldData: Object; newData: Object; key: any; cancel: any }) => void; - /** Enables a hint that appears when a user hovers the mouse pointer over a cell with truncated content. */ - cellHintEnabled?: boolean; - /** Specifies whether or not grid columns can be reordered by a user. */ - allowColumnReordering?: boolean; - /** Specifies whether or not grid columns can be resized by a user. */ - allowColumnResizing?: boolean; - /** A handler for the cellClick event. */ - onCellClick?: any; - /** A handler for the cellHoverChanged event. */ - onCellHoverChanged?: (e: Object) => void; - /** A handler for the cellPrepared event. */ - onCellPrepared?: (e: Object) => void; - /** Specifies whether or not the width of grid columns depends on column content. */ - columnAutoWidth?: boolean; - /** Specifies the options of a column chooser. */ - columnChooser?: { - /** Specifies text displayed by the column chooser panel when it does not contain any columns. */ - emptyPanelText?: string; - /** Specifies whether a user can invoke the column chooser or not. */ - enabled?: boolean; - /** Specifies the height of the column chooser panel. */ - height?: number; - /** Specifies text displayed in the title of the column chooser panel. */ - title?: string; - /** Specifies the width of the column chooser panel. */ - width?: number; - }; - /** Specifies options for column fixing. */ - columnFixing?: { - /** Indicates if column fixing is enabled. */ - enabled?: boolean; - /** Contains options that specify texts for column-fixing related commands in the column header's context menu. */ - texts?: { - /** Specifies text for a context menu item that fixes the column for which the context menu is invoked. */ - fix?: string; - /** Specifies text for a context menu item that unfixes the column for which the context menu is invoked. */ - unfix?: string; - /** Specifies text for a context menu subitem that fixes a column, for which the context menu is invoked, to the left grid edge. */ - leftPosition?: string; - /** Specifies text for a context menu subitem that fixes a column, for which the context menu is invoked, to the right grid edge. */ - rightPosition?: string; - }; - }; - /** Specifies options for filtering using a column header filter. */ - headerFilter?: { - /** Indicates whether or not the column header filter button is visible. */ - visible?: boolean; - /** Specifies the height of the dropdown menu invoked when using a column header filter. */ - height?: number; - /** Specifies the width of the dropdown menu invoked when using a column header filter. */ - width?: number; - /** Contains options that specify texts for the dropdown menu invoked when you use a column header filter. */ - texts?: { - /** Specifies text for the item specifying an empty value in the column header filter's dropdown menu. */ - emptyValue?: string; - /** Specifies text for a button that closes the column header filter's dropdown menu and applies specified filtering. */ - ok?: string; - /** Specifies text for a button that closes the column header filter's dropdown menu without applying performed selection. */ - cancel?: string; - } - }; - /** An array of grid columns. */ - columns?: Array; - onContentReady?: Function; - /** Specifies a function that customizes grid columns after they are created. */ - customizeColumns?: (columns: Array) => void; - /** Specifies a data source for the grid. */ - dataSource?: any; - /** Specifies whether or not to enable data caching. */ - cacheEnabled?: boolean; - /** A handler for the editingStart event. */ - onEditingStart?: (e: { - data: Object; - key: any; - cancel: boolean; - column: dxDataGridColumn - }) => void; - /** A handler for the editorPrepared event. */ - onEditorPrepared?: (e: Object) => void; - /** A handler for the editorPreparing event. */ - onEditorPreparing?: (e: Object) => void; - /** Contains options that specify how grid content can be changed. */ - editing?: { - editMode?: string; - editEnabled?: boolean; - insertEnabled?: boolean; - removeEnabled?: boolean; - /** Specifies how grid values can be edited manually. */ - mode?: string; - /** Specifies whether or not grid records can be edited at runtime. */ - allowUpdating?: boolean; - /** Specifies whether or not new grid records can be added at runtime. */ - allowAdding?: boolean; - /** Specifies whether or not grid records can be deleted at runtime. */ - allowDeleting?: boolean; - /** The form configuration object. Used only when the editing mode is "form". */ - form?: DevExpress.ui.dxFormOptions; - /** Contains options that specify texts for editing-related grid controls. */ - texts?: { - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Save" button. Setting this option makes sense only when the editMode option is set to batch. */ - saveAllChanges?: string; - /** Specifies text for a cancel button displayed when a row is in the editing state. Setting this option makes sense only when the allowUpdating option is set to true. */ - cancelRowChanges?: string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Revert" button. Setting this option makes sense only when the editMode option is set to batch. */ - cancelAllChanges?: string; - /** Specifies a message to be displayed by a confirmation window. Setting this option makes sense only when the edit mode is "row". */ - confirmDeleteMessage?: string; - /** Specifies text to be displayed in the title of a confirmation window. Setting this option makes sense only when the edit mode is "row". */ - confirmDeleteTitle?: string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Cancel changes" button. Setting this option makes sense only when the editMode option is set to cell and the validation capabilities are enabled. */ - validationCancelChanges?: string; - /** Specifies text for a button that deletes a row from a grid. Setting this option makes sense only when the allowDeleting option is set to true. */ - deleteRow?: string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Add" button. Setting this option makes sense only when the allowAdding option is true. */ - addRow?: string; - /** Specifies text for a button that turns a row into the editing state. Setting this option makes sense only when the allowUpdating option is set to true. */ - editRow?: string; - /** Specifies text for a save button displayed when a row is in the editing state. Setting this option makes sense only when the allowUpdating option is set to true. */ - saveRowChanges?: string; - /** Specifies text for a button that recovers a deleted row. Setting this option makes sense only if the grid uses the batch edit mode and the allowDeleting option is set to true. */ - undeleteRow?: string; - }; - }; - /** Specifies filter row options. */ - filterRow?: { - /** Specifies when to apply a filter. */ - applyFilter?: string; - /** Specifies text for the hint that pops up when a user hovers the mouse pointer over the "Apply Filter" button. */ - applyFilterText?: string; - /** Specifies descriptions for filter operations. */ - operationDescriptions?: { - "=": string; - "<>": string; - "<": string; - "<=": string; - ">": string; - ">=": string; - "startswith": string; - "contains": string; - "notcontains": string; - "endswith": string; - }; - /** Specifies text for the reset operation in a filter list. */ - resetOperationText?: string; - /** Specifies text for the operation of clearing the applied filter when a select box is used. */ - showAllText?: string; - /** Specifies text for the range start in the 'between' filter type. */ - betweenStartText?: string; - /** Specifies text for the range end in the 'between' filter type. */ - betweenEndText?: string; - /** Specifies whether or not an icon that allows the user to choose a filter operation is visible. */ - showOperationChooser?: boolean; - /** Specifies whether the filter row is visible or not. */ - visible?: boolean; - }; - /** Specifies the behavior of grouped grid records. */ - grouping?: { - /** Specifies whether the user can collapse grouped records in a grid or not. */ - allowCollapsing?: boolean; - /** Specifies whether groups appear expanded or not. */ - autoExpandAll?: boolean; - /** Specifies the message displayed in a group row when the corresponding group is continued from the previous page. */ - groupContinuedMessage?: string; - /** Specifies the message displayed in a group row when the corresponding group continues on the next page. */ - groupContinuesMessage?: string; - }; - /** Specifies options that configure the group panel. */ - groupPanel?: { - /** Specifies whether columns can be dragged onto or from the group panel. */ - allowColumnDragging?: boolean; - /** Specifies text displayed by the group panel when it does not contain any columns. */ - emptyPanelText?: string; - /** Specifies whether the group panel is visible or not. */ - visible?: boolean; - }; - /** Specifies options configuring the load panel. */ - loadPanel?: { - /** Specifies whether to show the load panel or not. */ - enabled?: boolean; - /** Specifies the height of the load panel in pixels. */ - height?: number; - /** Specifies a URL pointing to an image to be used as a loading indicator. */ - indicatorSrc?: string; - /** Specifies whether or not a loading indicator must be displayed on the load panel. */ - showIndicator?: boolean; - /** Specifies whether or not the pane of the load panel must be displayed. */ - showPane?: boolean; - /** Specifies text displayed by the load panel. */ - text?: string; - /** Specifies the width of the load panel in pixels. */ - width?: number; - }; - /** Specifies text displayed when a grid does not contain any records. */ - noDataText?: string; - /** Specifies the options of a grid pager. */ - pager?: { - /** Specifies the page sizes that can be selected at runtime. */ - allowedPageSizes?: any; - /** Specifies whether to show the page size selector or not. */ - showPageSizeSelector?: boolean; - /** Specifies whether to show the pager or not. */ - visible?: any; - /** Specifies the text accompanying the page navigator. */ - infoText?: string; - /** Specifies whether or not to display the text accompanying the page navigator. This text is specified by the infoText option. */ - showInfo?: boolean; - /** Specifies whether or not to display buttons that switch the grid to the previous or next page. */ - showNavigationButtons?: boolean; - }; - /** Specifies paging options. */ - paging?: { - /** Specifies whether dxDataGrid loads data page by page or all at once. */ - enabled?: boolean; - /** Specifies the grid page that should be displayed by default. */ - pageIndex?: number; - /** Specifies the size of grid pages. */ - pageSize?: number; - }; - /** Specifies whether or not grid rows must be shaded in a different way. */ - rowAlternationEnabled?: boolean; - /** Specifies whether to enable two-way data binding. */ - twoWayBindingEnabled?: boolean; - /** A handler for the rowClick event. */ - onRowClick?: any; - /** A handler for the rowPrepared event. */ - onRowPrepared?: (e: Object) => void; - /** Specifies a custom template for grid rows. */ - rowTemplate?: any; - /** A configuration object specifying scrolling options. */ - scrolling?: { - /** Specifies the scrolling mode. */ - mode?: string; - /** Specifies whether or not a grid must preload pages adjacent to the current page when using virtual scrolling. */ - preloadEnabled?: boolean; - /** Specifies whether or not the widget uses native scrolling. */ - useNative?: any; - /** Specifies the scrollbar display policy. */ - showScrollbar?: string; - /** Specifies whether or not the scrolling by content is enabled. */ - scrollByContent?: boolean; - /** Specifies whether or not the scrollbar thumb scrolling enabled. */ - scrollByThumb?: boolean; - }; - /** Specifies options of the search panel. */ - searchPanel?: { - /** Specifies whether or not search strings in the located grid records should be highlighted. */ - highlightSearchText?: boolean; - /** Specifies text displayed by the search panel when no search string was typed. */ - placeholder?: string; - /** Specifies whether the search panel is visible or not. */ - visible?: boolean; - /** Specifies the width of the search panel in pixels. */ - width?: number; - /** Sets a search string for the search panel. */ - text?: string; - }; - /** Specifies the operations that must be performed on the server side. */ - remoteOperations?: any; - /** Allows you to sort groups according to the values of group summary items. */ - sortByGroupSummaryInfo?: Array<{ - /** Specifies the group summary item whose values must be used to sort groups. */ - summaryItem?: string; - /** Specifies the identifier of the column that must be used in grouping so that sorting by group summary item values be applied. */ - groupColumn?: string; - /** Specifies the sort order of group summary item values. */ - sortOrder?: string; - }>; - /** Allows you to build a master-detail interface in the grid. */ - masterDetail?: { - /** Enables an end-user to expand/collapse detail sections. */ - enabled?: boolean; - /** Specifies whether detail sections appear expanded or collapsed. */ - autoExpandAll?: boolean; - /** Specifies the template for detail sections. */ - template?: any; - }; - /** Specifies options for exporting grid data. */ - export?: { - /** Indicates if the export feature is enabled in the grid. */ - enabled?: boolean; - /** Specifies a default name for the file to which grid data is exported. */ - fileName?: string; - /** Specifies whether to enable Excel filtering for the exported data in the resulting XLSX file. */ - excelFilterEnabled?: boolean; - /** Specifies whether to enable word wrapping for the exported data in the resulting XLSX file. */ - excelWrapTextEnabled?: boolean; - /** Specifies the URL of the server-side proxy that streams the resulting file to the end user to enable export in IE8, IE9 and Safari browsers. */ - proxyUrl?: string; - /** Indicates whether to allow end users to export not only the data displayed in the grid, but the selected rows only. */ - allowExportSelectedData?: boolean; - /** Contains options that specify texts for the export-related commands and hints. */ - texts?: { - /** Specifies text for the Export button when this button invokes a dropdown menu so you can choose the required export format. */ - exportTo?: string; - /** Specifies text for the Export button's hint when this button exports to the XSLX format without invoking the drop-down menu. */ - exportToExcel?: string; - /** Specifies text for the item in the Export dropdown menu that exports grid data to Excel. */ - excelFormat?: string; - /** Specifies text for the option in the Export dropdown menu that allows you to choose whether to export all the grid data or the selected rows only. */ - selectedRows?: string; - } - }; - /** Specifies the keys of the records that must appear selected initially. */ - selectedRowKeys?: Array; - /** Specifies options of runtime selection. */ - selection?: { - /** Specifies the checkbox row display policy in the multiple mode. */ - showCheckBoxesMode?: string; - /** Specifies whether the user can select all grid records at once. */ - allowSelectAll?: boolean; - /** Specifies the selection mode. */ - mode?: string; - }; - /** A handler for the dataErrorOccured event. */ - onDataErrorOccurred?: (e: { error: Error }) => void; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: (e: { - currentSelectedRowKeys: Array; - currentDeselectedRowKeys: Array; - selectedRowKeys: Array; - selectedRowsData: Array; - }) => void; - /** A handler for the exporting event. */ - onExporting?: (e: { - fileName: string; - format: string; - cancel: boolean; - }) => void; - /** A handler for the fileSaving event. */ - onFileSaving?: (e: { - fileName: string; - format: string; - data: any; - cancel: boolean; - }) => void; - /** A handler for the exported event. */ - onExported?: (e: Object) => void; - /** A handler for the keyDown event. */ - onKeyDown?: (e: Object) => void; - /** A handler for the rowExpanding event. */ - onRowExpanding?: (e: Object) => void; - /** A handler for the rowExpanded event. */ - onRowExpanded?: (e: Object) => void; - /** A handler for the rowCollapsing event. */ - onRowCollapsing?: (e: Object) => void; - /** A handler for the rowCollapsed event. */ - onRowCollapsed?: (e: Object) => void; - /** Specifies whether column headers are visible or not. */ - showColumnHeaders?: boolean; - /** Specifies whether or not vertical lines separating one grid column from another are visible. */ - showColumnLines?: boolean; - /** Specifies whether or not horizontal lines separating one grid row from another are visible. */ - showRowLines?: boolean; - /** Specifies options of runtime sorting. */ - sorting?: { - /** Specifies text for the context menu item that sets an ascending sort order in a column. */ - ascendingText?: string; - /** Specifies text for the context menu item that resets sorting settings for a column. */ - clearText?: string; - /** Specifies text for the context menu item that sets a descending sort order in a column. */ - descendingText?: string; - /** Specifies the runtime sorting mode. */ - mode?: string; - }; - /** Specifies options of state storing. */ - stateStoring?: { - /** Specifies a callback function that performs specific actions on state loading. */ - customLoad?: () => JQueryPromise; - /** Specifies a callback function that performs specific actions on state saving. */ - customSave?: (state: Object) => void; - /** Specifies whether or not a grid saves its state. */ - enabled?: boolean; - /** Specifies the delay between the last change of a grid state and the operation of saving this state in milliseconds. */ - savingTimeout?: number; - /** Specifies a unique key to be used for storing the grid state. */ - storageKey?: string; - /** Specifies the type of storage to be used for state storing. */ - type?: string; - }; - /** Specifies the options of the grid summary. */ - summary?: { - /** Contains options that specify text patterns for summary items. */ - texts?: { - /** Specifies a pattern for the 'sum' summary items when they are displayed in the parent column. */ - sum?: string; - /** Specifies a pattern for the 'sum' summary items displayed in a group row or in any other column rather than the parent one. */ - sumOtherColumn?: string; - /** Specifies a pattern for the 'min' summary items when they are displayed in the parent column. */ - min?: string; - /** Specifies a pattern for the 'min' summary items displayed in a group row or in any other column rather than the parent one. */ - minOtherColumn?: string; - /** Specifies a pattern for the 'max' summary items when they are displayed in the parent column. */ - max?: string; - /** Specifies a pattern for the 'max' summary items displayed in a group row or in any other column rather than the parent one. */ - maxOtherColumn?: string; - /** Specifies a pattern for the 'avg' summary items when they are displayed in the parent column. */ - avg?: string; - /** Specifies a pattern for the 'avg' summary items displayed in a group row or in any other column rather than the parent one. */ - avgOtherColumn?: string; - /** Specifies a pattern for the 'count' summary items. */ - count?: string; - }; - /** Specifies items of the group summary. */ - groupItems?: Array<{ - /** Specifies the identifier of a summary item. */ - name?: string; - /** Specifies the column that provides data for a group summary item. */ - column?: string; - /** Customizes the text to be displayed in the summary item. */ - customizeText?: (itemInfo: { - value: any; - valueText: string; - }) => string; - /** Specifies a pattern for the summary item text. */ - displayFormat?: string; - /** Specifies a precision for the summary item value of a numeric format. */ - precision?: number; - /** Specifies whether or not a summary item must be displayed in the group footer. */ - showInGroupFooter?: boolean; - /** Indicates whether to display group summary items in parentheses after the group row header or to align them by the corresponding columns within the group row. */ - alignByColumn?: boolean; - /** Specifies the column that must hold the summary item when this item is displayed in the group footer or aligned by a column in the group row. */ - showInColumn?: string; - /** Specifies how to aggregate data for a summary item. */ - summaryType?: string; - /** Specifies a format for the summary item value. */ - valueFormat?: string; - }>; - /** Specifies items of the total summary. */ - totalItems?: Array<{ - /** Specifies the identifier of a summary item. */ - name?: string; - /** Specifies the alignment of a summary item. */ - alignment?: string; - /** Specifies the column that provides data for a summary item. */ - column?: string; - /** Specifies a CSS class to be applied to a summary item. */ - cssClass?: string; - /** Customizes the text to be displayed in the summary item. */ - customizeText?: (itemInfo: { - value: any; - valueText: string; - }) => string; - /** Specifies a pattern for the summary item text. */ - displayFormat?: string; - /** Specifies a precision for the summary item value of a numeric format. */ - precision?: number; - /** Specifies the column that must hold the summary item. */ - showInColumn?: string; - /** Specifies how to aggregate data for a summary item. */ - summaryType?: string; - /** Specifies a format for the summary item value. */ - valueFormat?: string; - }>; - /** Allows you to use a custom aggregate function to calculate the value of a summary item. */ - calculateCustomSummary?: (options: { - component: dxDataGrid; - name?: string; - value: any; - totalValue: any; - summaryProcess: string - }) => void; - }; - /** Specifies whether text that does not fit into a column should be wrapped. */ - wordWrapEnabled?: boolean; - } - /** A data grid widget. */ - export class dxDataGrid extends Widget { - constructor(element: JQuery, options?: dxDataGridOptions); - constructor(element: Element, options?: dxDataGridOptions); - /** Ungroups grid records. */ - clearGrouping(): void; - /** Clears sorting settings of all grid columns at once. */ - clearSorting(): void; - /** Allows you to obtain a cell by its row index and the data field of its column. */ - getCellElement(rowIndex: number, dataField: string): any; - /** Allows you to obtain a cell by its row index and the visible index of its column. */ - getCellElement(rowIndex: number, visibleColumnIndex: number): any; - /** Returns the current state of the grid. */ - state(): Object; - /** Sets the grid state. */ - state(state: Object): void; - /** Allows you to obtain the row index by a data key. */ - getRowIndexByKey(key: any): number; - /** Allows you to obtain the data key by a row index. */ - getKeyByRowIndex(rowIndex: number): any; - /** Adds a new column to a grid. */ - addColumn(columnOptions: dxDataGridColumn): void; - /** Removes the column from the grid. */ - deleteColumn(id: any): void; - /** Displays the load panel. */ - beginCustomLoading(messageText: string): void; - /** Discards changes made in a grid. */ - cancelEditData(): void; - /** Checks whether or not the grid contains unsaved changes. */ - hasEditData(): boolean; - /** Clears all the filters of a specific type applied to grid records. */ - clearFilter(): void; - /** Deselects all grid records. */ - clearSelection(): void; - /** Draws the cell being edited from the editing state. Use this method when the edit mode is batch. */ - closeEditCell(): void; - /** Collapses groups or master rows in a grid. */ - collapseAll(groupIndex?: number): void; - /** Returns the number of data columns in a grid. */ - columnCount(): number; - /** Returns the value of a specific column option. */ - columnOption(id: any, optionName: string): any; - /** Sets an option of a specific column. */ - columnOption(id: any, optionName: string, optionValue: any): void; - /** Returns the options of a column by an identifier. */ - columnOption(id: any): Object; - /** Sets several options of a column at once. */ - columnOption(id: any, options: Object): void; - /** Sets a specific cell into the editing state. */ - editCell(rowIndex: number, visibleColumnIndex: number): void; - /** Sets a specific cell into the editing state. */ - editCell(rowIndex: number, dataField: string): void; - /** Sets a specific row into the editing state. */ - editRow(rowIndex: number): void; - /** Gets the cell value. */ - cellValue(rowIndex: number, dataField: string): any; - /** Gets the cell value. */ - cellValue(rowIndex: number, visibleColumnIndex: number): any; - /** Sets the cell value. */ - cellValue(rowIndex: number, dataField: string, value: any): void; - /** Sets the cell value. */ - cellValue(rowIndex: number, visibleColumnIndex: number, value: any): void; - /** Hides the load panel. */ - endCustomLoading(): void; - /** Expands groups or master rows in a grid. */ - expandAll(groupIndex: number): void; - /** Allows you to find out whether a specific group or master row is expanded or collapsed. */ - isRowExpanded(key: any): boolean; - /** Allows you to expand a specific group or master row by its key. */ - expandRow(key: any): void; - /** Allows you to collapse a specific group or master row by its key. */ - collapseRow(key: any): void; - /** Applies a filter to the grid's data source. */ - filter(filterExpr?: any): void; - /** Returns a filter expression applied to the grid's data source using the filter(filterExpr) method. */ - filter(): any; - /** Returns a filter expression applied to the grid using all possible scenarious. */ - getCombinedFilter(): any; - /** Gets the keys of currently selected grid records. */ - getSelectedRowKeys(): Array; - /** Gets the data objects of currently selected grid records. */ - getSelectedRowsData(): Array; - /** Hides the column chooser panel. */ - hideColumnChooser(): void; - /** Adds a new data row to a grid. */ - addRow(): void; - /** - * Adds a new data row to a grid. - * @deprecated Use the addRow() method instead. - */ - insertRow(): void; - /** Returns the key corresponding to the passed data object. */ - keyOf(obj: Object): any; - /** Switches a grid to a specified page. */ - pageIndex(newIndex: number): void; - /** Gets the index of the current page. */ - pageIndex(): number; - /** Sets the page size. */ - pageSize(value: number): void; - /** Gets the current page size. */ - pageSize(): number; - /** Refreshes grid data. */ - refresh(): void; - /** Removes a specific row from a grid. */ - deleteRow(rowIndex: number): void; - /** - * Removes a specific row from a grid. - * @deprecated Use the deleteRow() method instead. - */ - removeRow(rowIndex: number): void; - /** Saves changes made in a grid. */ - saveEditData(): void; - /** Searches grid records by a search string. */ - searchByText(text: string): void; - /** Selects all grid records. */ - selectAll(): void; - /** Deselects the rows that are currently selected within the applied filter. */ - deselectAll(): void; - /** Selects specific grid records. */ - selectRows(keys: Array, preserve: boolean): void; - /** Deselects specific grid records. */ - deselectRows(keys: Array): void; - /** Selects grid rows by indexes. */ - selectRowsByIndexes(indexes: Array): void; - /** Allows you to find out whether a row is selected or not. */ - isRowSelected(key: any): boolean; - /** Invokes the column chooser panel. */ - showColumnChooser(): void; - startSelectionWithCheckboxes(): boolean; - /** Returns the number of records currently held by a grid. */ - totalCount(): number; - /** Recovers a row deleted in the batch edit mode. */ - undeleteRow(rowIndex: number): void; - /** Allows you to obtain a data object by its key. */ - byKey(key: any): JQueryPromise; - /** Gets the value of a total summary item. */ - getTotalSummaryValue(summaryItemName: string): any; - /** Exports grid data to Excel. */ - exportToExcel(selectionOnly: boolean): void; - /** Updates the grid to the size of its content. */ - updateDimensions(): void; - /** Focuses the specified cell element in the grid. */ - focus(element?: JQuery): void; - } - export interface dxPivotGridOptions extends WidgetOptions { - onContentReady?: Function; - /** Specifies a data source for the pivot grid. */ - dataSource?: any; - useNativeScrolling?: any; - /** A configuration object specifying scrolling options. */ - scrolling?: { - /** Specifies the scrolling mode. */ - mode?: string; - /** Specifies whether or not the widget uses native scrolling. */ - useNative?: any; - }; - /** Allows an end-user to change sorting options. */ - allowSorting?: boolean; - /** Allows an end-user to sort columns by summary values. */ - allowSortingBySummary?: boolean; - /** Allows an end-user to change filtering options. */ - allowFiltering?: boolean; - /** Allows an end-user to expand/collapse all header items within a header level. */ - allowExpandAll?: boolean; - /** Specifies whether to display the Total rows. */ - showRowTotals?: boolean; - /** Specifies whether to display the Grand Total row. */ - showRowGrandTotals?: boolean; - /** Specifies whether to display the Total columns. */ - showColumnTotals?: boolean; - /** Specifies whether to display the Grand Total column. */ - showColumnGrandTotals?: boolean; - /** Specifies whether or not to hide rows and columns with no data. */ - hideEmptySummaryCells?: boolean; - /** Specifies where to show the total rows or columns. */ - showTotalsPrior?: string; - /** Specifies whether the outer borders of the grid are visible or not. */ - showBorders?: boolean; - /** The Field Chooser configuration options. */ - fieldChooser?: { - /** Enables or disables the field chooser. */ - enabled?: boolean; - /** Specifies the field chooser layout. */ - layout?: number; - /** Specifies the text to display as a title of the field chooser popup window. */ - title?: string; - /** Specifies the field chooser width. */ - width?: number; - /** Specifies the field chooser height. */ - height?: number; - /** Strings that can be changed or localized in the pivot grid's integrated Field Chooser. */ - texts?: { - /** The string to display instead of Row Fields. */ - rowFields?: string; - /** The string to display instead of Column Fields. */ - columnFields?: string; - /** The string to display instead of Data Fields. */ - dataFields?: string; - /** The string to display instead of Filter Fields. */ - filterFields?: string; - /** The string to display instead of All Fields. */ - allFields?: string; - }; - } - /** Strings that can be changed or localized in the dxPivotGrid widget. */ - texts?: { - /** The string to display as a header of the Grand Total row and column. */ - grandTotal?: string; - /** The string to display as a header of the Total row and column. */ - total?: string; - /** Specifies the text displayed when a pivot grid does not contain any fields. */ - noData?: string; - /** The string to display as a Show Field Chooser context menu item. */ - showFieldChooser?: string; - /** The string to display as an Expand All context menu item. */ - expandAll?: string; - /** The string to display as a Collapse All context menu item. */ - collapseAll?: string; - /** The string to display as a Sort Column by Summary Value context menu item. */ - sortColumnBySummary?: string; - /** The string to display as a Sort Row by Summary Value context menu item. */ - sortRowBySummary?: string; - /** The string to display as a Remove All Sorting context menu item. */ - removeAllSorting?: string; - /** The string to display as an Export to Excel file context menu item. */ - exportToExcel?: string; - }; - /** The Load panel configuration options. */ - loadPanel?: { - /** Enables or disables the load panel. */ - enabled?: boolean; - /** Specifies the height of the load panel. */ - height?: number; - /** Specifies the URL pointing to an image that will be used as a load indicator. */ - indicatorSrc?: string; - /** Specifies whether or not to show a load indicator. */ - showIndicator?: boolean; - /** Specifies whether or not to show load panel background. */ - showPane?: boolean; - /** Specifies the text to display inside a load panel. */ - text?: string; - /** Specifies the width of the load panel. */ - width?: number; - }; - /** A handler for the cellClick event. */ - onCellClick?: (e: any) => void; - /** A handler for the cellPrepared event. */ - onCellPrepared?: (e: any) => void; - /** A handler for the contextMenuPreparing event. */ - onContextMenuPreparing?: (e: Object) => void; - /** Specifies options for exporting pivot grid data. */ - export?: { - /** Indicates whether the export feature is enabled for the pivot grid. */ - enabled?: boolean; - /** Specifies a default name for the file to which grid data is exported. */ - fileName?: string; - /** Specifies the URL of the server-side proxy that streams the resulting file to the end user to enable export in IE8, IE9 and Safari browsers. */ - proxyUrl?: string; - }; - /** A handler for the exporting event. */ - onExporting?: (e: { - fileName: string; - format: string; - cancel: boolean; - }) => void; - /** A handler for the fileSaving event. */ - onFileSaving?: (e: { - fileName: string; - format: string; - data: any; - cancel: boolean; - }) => void; - /** A handler for the exported event. */ - onExported?: (e: Object) => void; - /** A configuration object specifying options related to state storing. */ - stateStoring?: { - /** Specifies a callback function that performs specific actions on state loading. */ - customLoad?: () => JQueryPromise; - /** Specifies a callback function that performs specific actions on state saving. */ - customSave?: (gridState: Object) => void; - /** Specifies whether or not a grid saves its state. */ - enabled?: boolean; - /** Specifies the delay between the last change of a grid state and the operation of saving this state in milliseconds. */ - savingTimeout?: number; - /** Specifies a unique key to be used for storing the grid state. */ - storageKey?: string; - /** Specifies the type of storage to be used for state storing. */ - type?: string; - }; - } - /** A data summarization widget for multi-dimensional data analysis and data mining. */ - export class dxPivotGrid extends Widget { - constructor(element: JQuery, options?: dxPivotGridOptions); - constructor(element: Element, options?: dxPivotGridOptions); - /** Gets the PivotGridDataSource instance. */ - getDataSource(): DevExpress.data.PivotGridDataSource; - /** Gets the dxPopup instance of the field chooser window. */ - getFieldChooserPopup(): DevExpress.ui.dxPopup; - /** Updates the widget to the size of its content. */ - updateDimensions(): void; - /** Exports pivot grid data to the Excel file. */ - exportToExcel(): void; - } - export interface dxPivotGridFieldChooserOptions extends WidgetOptions { - /** Specifies the height of the widget. */ - height?: any; - /** Specifies the field chooser layout. */ - layout?: number; - /** The data source of a dxPivotGrid widget. */ - dataSource?: DevExpress.data.PivotGridDataSource; - onContentReady?: Function; - /** Strings that can be changed or localized in the dxPivotGridFieldChooser widget. */ - texts?: { - /** The string to display instead of Row Fields. */ - rowFields?: string; - /** The string to display instead of Column Fields. */ - columnFields?: string; - /** The string to display instead of Data Fields. */ - dataFields?: string; - /** The string to display instead of Filter Fields. */ - filterFields?: string; - /** The string to display instead of All Fields. */ - allFields?: string; - }; - } - /** A complementary widget for dxPivotGrid that allows you to manage data displayed in the dxPivotGrid. */ - export class dxPivotGridFieldChooser extends Widget { - constructor(element: JQuery, options?: dxPivotGridFieldChooserOptions); - constructor(element: Element, options?: dxPivotGridFieldChooserOptions); - /** Updates the widget to the size of its content. */ - updateDimensions(): void; - } -} -interface JQuery { - dxTreeView(): JQuery; - dxTreeView(options: "instance"): DevExpress.ui.dxTreeView; - dxTreeView(options: string): any; - dxTreeView(options: string, ...params: any[]): any; - dxTreeView(options: DevExpress.ui.dxTreeViewOptions): JQuery; - dxMenuBase(): JQuery; - dxMenuBase(options: "instance"): DevExpress.ui.dxMenuBase; - dxMenuBase(options: string): any; - dxMenuBase(options: string, ...params: any[]): any; - dxMenuBase(options: DevExpress.ui.dxMenuBaseOptions): JQuery; - dxMenu(): JQuery; - dxMenu(options: "instance"): DevExpress.ui.dxMenu; - dxMenu(options: string): any; - dxMenu(options: string, ...params: any[]): any; - dxMenu(options: DevExpress.ui.dxMenuOptions): JQuery; - dxContextMenu(): JQuery; - dxContextMenu(options: "instance"): DevExpress.ui.dxContextMenu; - dxContextMenu(options: string): any; - dxContextMenu(options: string, ...params: any[]): any; - dxContextMenu(options: DevExpress.ui.dxContextMenuOptions): JQuery; - dxColorBox(): JQuery; - dxColorBox(options: "instance"): DevExpress.ui.dxColorBox; - dxColorBox(options: string): any; - dxColorBox(options: string, ...params: any[]): any; - dxColorBox(options: DevExpress.ui.dxColorBoxOptions): JQuery; - dxDataGrid(): JQuery; - dxDataGrid(options: "instance"): DevExpress.ui.dxDataGrid; - dxDataGrid(options: string): any; - dxDataGrid(options: string, ...params: any[]): any; - dxDataGrid(options: DevExpress.ui.dxDataGridOptions): JQuery; - dxPivotGrid(): JQuery; - dxPivotGrid(options: "instance"): DevExpress.ui.dxPivotGrid; - dxPivotGrid(options: string): any; - dxPivotGrid(options: string, ...params: any[]): any; - dxPivotGrid(options: DevExpress.ui.dxPivotGridOptions): JQuery; - dxPivotGridFieldChooser(): JQuery; - dxPivotGridFieldChooser(options: "instance"): DevExpress.ui.dxPivotGridFieldChooser; - dxPivotGridFieldChooser(options: string): any; - dxPivotGridFieldChooser(options: string, ...params: any[]): any; - dxPivotGridFieldChooser(options: DevExpress.ui.dxPivotGridFieldChooserOptions): JQuery; - dxScheduler(): JQuery; - dxScheduler(options: "instance"): DevExpress.ui.dxScheduler; - dxScheduler(options: string): any; - dxScheduler(options: string, ...params: any[]): any; - dxScheduler(options: DevExpress.ui.dxSchedulerOptions): JQuery; -} -declare namespace DevExpress.framework { - /** An object used to store information on the views displayed in an application. */ - export class ViewCache { - viewRemoved: JQueryCallback; - /** Removes all the viewInfo objects from the cache. */ - clear(): void; - /** Obtains a viewInfo object from the cache by the specified key. */ - getView(key: string): Object; - /** Checks whether or not a viewInfo object is contained in the view cache under the specified key. */ - hasView(key: string): boolean; - /** Removes a viewInfo object from the cache by the specified key. */ - removeView(key: string): Object; - /** Adds the specified viewInfo object to the cache under the specified key. */ - setView(key: string, viewInfo: Object): void; - } - export interface dxCommandOptions extends DOMComponentOptions { - /** Specifies an action performed when the execute() method of the command is called. */ - onExecute?: any; - /** Indicates whether or not the widget that displays this command is disabled. */ - disabled?: boolean; - /** Specifies whether the current command is rendered when a view is being rendered or after a view is shown. */ - renderStage?: string; - /** Specifies the name of the icon shown inside the widget associated with this command. */ - icon?: string; - iconSrc?: string; - /** The identifier of the command. */ - id?: string; - /** Specifies the title of the widget associated with this command. */ - title?: string; - /** Specifies the type of the button, if the command is rendered as a dxButton widget. */ - type?: string; - /** A Boolean value specifying whether or not the widget associated with this command is visible. */ - visible?: boolean; - } - /** A markup component used to define markup options for a command. */ - export class dxCommand extends DOMComponent { - constructor(element: JQuery, options: dxCommandOptions); - constructor(options: dxCommandOptions); - /** Executes the action associated with this command. */ - execute(): void; - } - /** An object responsible for routing. */ - export class Router { - /** Adds a routing rule to the list of registered rules. */ - register(pattern: string, defaults?: Object, constraints?: Object): void; - /** Decodes the specified URI to an object using the registered routing rules. */ - parse(uri: string): Object; - /** Formats an object to a URI. */ - format(obj: Object): string; - } - export interface StateManagerOptions { - /** A storage to which the state manager saves the application state. */ - storage?: Object; - } - /** An object used to store the current application state. */ - export class StateManager { - constructor(options?: StateManagerOptions); - /** Adds an object that implements an interface of a state source to the state manager's collection of state sources. */ - addStateSource(stateSource: Object): void; - /** Removes a specified state source from the state manager's collection of state sources. */ - removeStateSource(stateSource: Object): void; - /** Saves the current application state. */ - saveState(): void; - /** Restores the application state that has been saved by the saveState() method to the state storage. */ - restoreState(): void; - /** Removes the application state that has been saved by the saveState() method to the state storage. */ - clearState(): void; - } - export module html { - export var layoutSets: Array; - export var animationSets: { [animationSetName: string]: AnimationSet }; - export interface AnimationSet { - [animationName: string]: any - } - export interface HtmlApplicationOptions { - /** Specifies where the commands that are defined in the application's views must be displayed. */ - commandMapping?: Object; - /** Specifies whether or not view caching is disabled. */ - disableViewCache?: boolean; - /** An array of layout controllers that should be used to show application views in the current navigation context. */ - layoutSet?: any; - /** Specifies the animation presets that are used to animate different UI elements in the current application. */ - animationSet?: AnimationSet; - /** Specifies whether the current application must behave as a mobile or web application. */ - mode?: string; - /** Specifies the object that represents a root namespace of the application. */ - namespace?: Object; - /** Specifies application behavior when the user navigates to a root view. */ - navigateToRootViewMode?: string; - /** An array of dxCommand configuration objects used to define commands available from the application's global navigation. */ - navigation?: Array; - /** A state manager to be used in the application. */ - stateManager?: StateManager; - /** Specifies the storage to be used by the application's state manager to store the application state. */ - stateStorage?: Object; - /** Indicates whether on not to use the title of the previously displayed view as text on the Back button. */ - useViewTitleAsBackText?: boolean; - /** A custom view cache to be used in the application. */ - viewCache?: Object; - /** Specifies a limit for the views that can be cached. */ - viewCacheSize?: number; - /** Specifies the current version of application templates. */ - templatesVersion?: string; - /** Specifies options for the viewport meta tag of a mobile browser. */ - viewPort?: JQuery; - /** A custom router to be used in the application. */ - router?: Router; - } - /** An object used to manage views, as well as control the application life cycle. */ - export class HtmlApplication implements EventsMixin { - constructor(options: HtmlApplicationOptions); - afterViewSetup: JQueryCallback; - beforeViewSetup: JQueryCallback; - initialized: JQueryCallback; - navigating: JQueryCallback; - navigatingBack: JQueryCallback; - resolveLayoutController: JQueryCallback; - resolveViewCacheKey: JQueryCallback; - viewDisposed: JQueryCallback; - viewDisposing: JQueryCallback; - viewHidden: JQueryCallback; - viewRendered: JQueryCallback; - viewShowing: JQueryCallback; - viewShown: JQueryCallback; - /** Provides access to the ViewCache object. */ - viewCache: ViewCache; - /** An array of dxCommand components that are created based on the application's navigation option value. */ - navigation: Array; - /** Provides access to the StateManager object. */ - stateManager: StateManager; - /** Provides access to the Router object. */ - router: Router; - /** Navigates to the URI preceding the current one in the navigation history. */ - back(): void; - /** Returns a Boolean value indicating whether or not backwards navigation is currently possible. */ - canBack(): boolean; - /** Calls the clearState() method of the application's StateManager object. */ - clearState(): void; - /** Creates global navigation commands. */ - createNavigation(navigationConfig: Array): void; - /** Returns an HTML template of the specified view. */ - getViewTemplate(viewName: string): JQuery; - /** Returns a configuration object used to create a dxView component for a specified view. */ - getViewTemplateInfo(viewName: string): Object; - /** Adds a specified HTML template to a collection of view or layout templates. */ - loadTemplates(source: any): JQueryPromise; - /** Navigates to the specified URI. */ - navigate(uri?: any, options?: Object): void; - /** Renders navigation commands to the navigation command containers that are located in the layouts used in the application. */ - renderNavigation(): void; - /** Calls the restoreState() method of the application's StateManager object. */ - restoreState(): void; - /** Calls the saveState method of the application's StateManager object. */ - saveState(): void; - /** Provides access to the object that defines the current context to be considered when choosing an appropriate template for a view. */ - templateContext(): Object; - on(eventName: "initialized", eventHandler: () => void): HtmlApplication; - on(eventName: "afterViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "beforeViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "navigating", eventHandler: (e: { - currentUri: string; - uri: string; - cancel: boolean; - options: { - root: boolean; - target: string; - direction: string; - rootInDetailPane: boolean; - modal: boolean; - }; - }) => void): HtmlApplication; - on(eventName: "navigatingBack", eventHandler: (e: { - cancel: boolean; - isHardwareButton: boolean; - }) => void): HtmlApplication; - on(eventName: "resolveLayoutController", eventHandler: (e: { - viewInfo: Object; - layoutController: Object; - availableLayoutControllers: Array; - }) => void): HtmlApplication; - on(eventName: "resolveViewCacheKey", eventHandler: (e: { - key: string; - navigationItem: Object; - routeData: Object; - }) => void): HtmlApplication; - on(eventName: "viewDisposed", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewDisposing", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewHidden", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewRendered", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewShowing", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - on(eventName: "viewShown", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - on(eventName: string, eventHandler: Function): HtmlApplication; - on(events: { [eventName: string]: Function; }): HtmlApplication; - off(eventName: "initialized"): HtmlApplication; - off(eventName: "afterViewSetup"): HtmlApplication; - off(eventName: "beforeViewSetup"): HtmlApplication; - off(eventName: "navigating"): HtmlApplication; - off(eventName: "navigatingBack"): HtmlApplication; - off(eventName: "resolveLayoutController"): HtmlApplication; - off(eventName: "resolveViewCacheKey"): HtmlApplication; - off(eventName: "viewDisposed"): HtmlApplication; - off(eventName: "viewDisposing"): HtmlApplication; - off(eventName: "viewHidden"): HtmlApplication; - off(eventName: "viewRendered"): HtmlApplication; - off(eventName: "viewShowing"): HtmlApplication; - off(eventName: "viewShown"): HtmlApplication; - off(eventName: string): HtmlApplication; - off(eventName: "initialized", eventHandler: () => void): HtmlApplication; - off(eventName: "afterViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "beforeViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "navigating", eventHandler: (e: { - currentUri: string; - uri: string; - cancel: boolean; - options: { - root: boolean; - target: string; - direction: string; - rootInDetailPane: boolean; - modal: boolean; - }; - }) => void): HtmlApplication; - off(eventName: "navigatingBack", eventHandler: (e: { - cancel: boolean; - isHardwareButton: boolean; - }) => void): HtmlApplication; - off(eventName: "resolveLayoutController", eventHandler: (e: { - viewInfo: Object; - layoutController: Object; - availableLayoutControllers: Array; - }) => void): HtmlApplication; - off(eventName: "resolveViewCacheKey", eventHandler: (e: { - key: string; - navigationItem: Object; - routeData: Object; - }) => void): HtmlApplication; - off(eventName: "viewDisposed", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewDisposing", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewHidden", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewRendered", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewShowing", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - off(eventName: "viewShown", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - off(eventName: string, eventHandler: Function): HtmlApplication; - } - } -} -declare namespace DevExpress.viz.core { - /** - * Applies a theme for the entire page with several DevExtreme visualization widgets. - * @deprecated Use the DevExpress.viz.currentTheme(theme) method instead. - */ - export function currentTheme(theme: string): void; - /** - * Applies a new theme (with the color scheme defined separately) for the entire page with several DevExtreme visualization widgets. - * @deprecated Use the DevExpress.viz.currentTheme(platform, colorScheme) method instead. - */ - export function currentTheme(platform: string, colorScheme: string): void; - /** - * Registers a new theme based on the existing one. - * @deprecated Use the DevExpress.viz.registerTheme(customTheme, baseTheme) method instead. - */ - export function registerTheme(customTheme: Object, baseTheme: string): void; - /** - * Applies a predefined or registered custom palette to all visualization widgets at once. - * @deprecated Use the DevExpress.viz.currentPalette(paletteName) method instead. - */ - export function currentPalette(paletteName: string): void; - /** - * Obtains the color sets of a predefined or registered palette. - * @deprecated Use the DevExpress.viz.getPalette(paletteName) method instead. - */ - export function getPalette(paletteName: string): Object; - /** - * Registers a new palette. - * @deprecated Use the DevExpress.viz.registerPalette(paletteName, palette) method instead. - */ - export function registerPalette(paletteName: string, palette: Object): void; - export interface Border { - /** Sets a border color for a selected series. */ - color?: string; - /** Sets border visibility for a selected series. */ - visible?: boolean; - /** Sets a border width for a selected series. */ - width?: number; - } - export interface DashedBorder extends Border { - /** Specifies a dash style for the border of a selected series point. */ - dashStyle?: string; - } - export interface DashedBorderWithOpacity extends DashedBorder { - /** Specifies the opacity of the tooltip's border. */ - opacity?: number; - } - export interface Font { - /** Specifies the font color for a strip label. */ - color?: string; - /** Specifies the font family for a strip label. */ - family?: string; - /** Specifies the font opacity for a strip label. */ - opacity?: number; - /** Specifies the font size for a strip label. */ - size?: any; - /** Specifies the font weight for the text displayed in strips. */ - weight?: number; - } - export interface Hatching { - direction?: string; - /** Specifies the opacity of hatching lines. */ - opacity?: number; - /** Specifies the distance between hatching lines in pixels. */ - step?: number; - /** Specifies the width of hatching lines in pixels. */ - width?: number; - } - export interface Margins { - /** Specifies the distance in pixels between the bottom side of the title and the surrounding widget elements. */ - bottom?: number; - /** Specifies the distance in pixels between the left side of the title and the surrounding widget elements. */ - left?: number; - /** Specifies the distance between the right side of the title and surrounding widget elements in pixels. */ - right?: number; - /** Specifies the distance between the top side of the title and surrounding widget elements in pixels. */ - top?: number; - } - export interface Size { - /** Specifies the width of the widget. */ - width?: number; - /** Specifies the height of the widget. */ - height?: number; - } - export interface Title { - /** Specifies font options for the title. */ - font?: viz.core.Font; - /** Specifies the widget title's horizontal position. */ - horizontalAlignment?: string; - /** Specifies the widget title's position in the vertical direction. */ - verticalAlignment?: string; - /** Specifies the distance between the title and surrounding widget elements in pixels. */ - margin?: viz.core.Margins; - /** Specifies the height of the space reserved for the title. */ - placeholderSize?: number; - /** Specifies text for the title. */ - text?: string; - /** Specifies a subtitle for the widget. */ - subtitle?: { - /** Specifies font options for the subtitle. */ - font?: viz.core.Font; - /** Specifies text for the subtitle. */ - text?: string; - } - } - export interface Tooltip { - /** Specifies the length of the tooltip's arrow in pixels. */ - arrowLength?: number; - /** Specifies the appearance of the tooltip's border. */ - border?: viz.core.DashedBorderWithOpacity; - /** Specifies a color for the tooltip. */ - color?: string; - /** Specifies the z-index for tooltips. */ - zIndex?: number; - /** Specifies the container to draw tooltips inside of it. */ - container?: any; - /** Specifies text and appearance of a set of tooltips. */ - customizeTooltip?: (arg: Object) => { color?: string; text?: string }; - /** Specifies whether or not the tooltip is enabled. */ - enabled?: boolean; - /** Specifies font options for the text displayed by the tooltip. */ - font?: Font; - /** Specifies a format for the text displayed by the tooltip. */ - format?: string; - /** Specifies the opacity of a tooltip. */ - opacity?: number; - /** Specifies a distance from the tooltip's left/right boundaries to the inner text in pixels. */ - paddingLeftRight?: number; - /** Specifies a distance from the tooltip's top/bottom boundaries to the inner text in pixels. */ - paddingTopBottom?: number; - /** Specifies a precision for formatted values displayed by the tooltip. */ - precision?: number; - /** Specifies options of the tooltip's shadow. */ - shadow?: { - /** Specifies the blur distance of the tooltip's shadow. */ - blur?: number; - /** Specifies the color of the tooltip's shadow. */ - color?: string; - /** Specifies the horizontal offset of the tooltip's shadow relative to the tooltip in pixels. */ - offsetX?: number; - /** Specifies the vertical offset of the tooltip's shadow relative to the tooltip in pixels. */ - offsetY?: number; - /** Specifies the opacity of the tooltip's shadow. */ - opacity?: number; - }; - } - export interface Animation { - /** Determines how long animation runs. */ - duration?: number; - /** Specifies the animation easing mode. */ - easing?: string; - /** Indicates whether or not animation is enabled. */ - enabled?: boolean; - } - export interface LoadingIndicator { - /** Specifies a color for the loading indicator background. */ - backgroundColor?: string; - /** Specifies font options for the loading indicator text. */ - font?: viz.core.Font; - /** Specifies whether to show the loading indicator or not. */ - show?: boolean; - /** Specifies a text to be displayed by the loading indicator. */ - text?: string; - } - export interface LegendBorder extends viz.core.DashedBorderWithOpacity { - /** Specifies a radius for the corners of the legend border. */ - cornerRadius?: number; - } - export interface BaseLegend { - /** Specifies the color of the legend's background. */ - backgroundColor?: string; - /** Specifies legend border settings. */ - border?: viz.core.LegendBorder; - /** Specifies how many columns must be taken to arrange legend items. */ - columnCount?: number; - /** Specifies the spacing between a pair of neighboring legend columns in pixels. */ - columnItemSpacing?: number; - /** Specifies font options for legend items. */ - font?: viz.core.Font; - /** Specifies the legend's position on the map. */ - horizontalAlignment?: string; - /** Specifies the alignment of legend items. */ - itemsAlignment?: string; - /** Specifies the position of text relative to the item marker. */ - itemTextPosition?: string; - /** Specifies the distance between the legend and the container borders in pixels. */ - margin?: viz.core.Margins; - /** Specifies the size of item markers in the legend in pixels. */ - markerSize?: number; - /** Specifies whether to arrange legend items horizontally or vertically. */ - orientation?: string; - /** Specifies the spacing between the legend left/right border and legend items in pixels. */ - paddingLeftRight?: number; - /** Specifies the spacing between the legend top/bottom border and legend items in pixels. */ - paddingTopBottom?: number; - /** Specifies how many rows must be taken to arrange legend items. */ - rowCount?: number; - /** Specifies the spacing between a pair of neighboring legend rows in pixels. */ - rowItemSpacing?: number; - /** Specifies the legend's position on the map. */ - verticalAlignment?: string; - /** Specifies whether or not the legend is visible on the map. */ - visible?: boolean; - } - export interface BaseWidgetOptions extends DOMComponentOptions { - /** A handler for the drawn event. */ - onDrawn?: (e: { - component: BaseWidget; - element: Element; - }) => void; - /** A handler for the incidentOccurred event. */ - onIncidentOccurred?: ( - component: BaseWidget, - element: Element, - target: { - id: string; - type: string; - args: any; - text: string; - widget: string; - version: string; - } - ) => void; - /** Notifies a widget that it is embedded into an HTML page that uses a path modifier. */ - pathModified?: boolean; - /** Specifies whether or not the widget supports right-to-left representation. */ - rtlEnabled?: boolean; - /** Sets the name of the theme to be used in the widget. */ - theme?: string; - } - /** This section describes options and methods that are common to all widgets. */ - export class BaseWidget extends DOMComponent { - /** Returns the widget's SVG markup. */ - svg(): string; - } -} -declare namespace DevExpress.viz.charts { - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface BaseSeries { - /** Provides information about the state of the series object. */ - fullState: number; - /** Returns the type of the series. */ - type: string; - /** Unselects all the selected points of the series. The points are displayed in an initial style. */ - clearSelection(): void; - /** Gets the color of a particular series. */ - getColor(): string; - /** Gets points from the series point collection based on the specified argument. */ - getPointsByArg(pointArg: any): Array; - /** Gets a point from the series point collection based on the specified point position. */ - getPointByPos(positionIndex: number): Object; - /** Selects the series. The series is displayed in a 'selected' style until another series is selected or the current series is deselected programmatically. */ - select(): void; - /** Selects the specified point. The point is displayed in a 'selected' style. */ - selectPoint(point: BasePoint): void; - /** Deselects the specified point. The point is displayed in an initial style. */ - deselectPoint(point: BasePoint): void; - /** Returns an array of all points in the series. */ - getAllPoints(): Array; - /** Returns visible series points. */ - getVisiblePoints(): Array; - /** Returns the name of the series. */ - name: string; - /** Returns the tag of the series. */ - tag: string; - /** Hides a series. */ - hide(): void; - /** Provides information about the hover state of a series. */ - isHovered(): boolean; - /** Provides information about the selection state of a series. */ - isSelected(): boolean; - /** Provides information about the visibility state of a series. */ - isVisible(): boolean; - /** Makes a particular series visible. */ - show(): void; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface BasePoint { - /** Provides information about the state of the point object. */ - fullState: number; - /** Returns the point's argument value that was set in the data source. */ - originalArgument: any; - /** Returns the point's value that was set in the data source. */ - originalValue: any; - /** Returns the tag of the point. */ - tag: string; - /** Deselects the point. */ - clearSelection(): void; - /** Gets the color of a particular point. */ - getColor(): string; - /** Hides the tooltip of the point. */ - hideTooltip(): void; - /** Provides information about the hover state of a point. */ - isHovered(): boolean; - /** Provides information about the selection state of a point. */ - isSelected(): boolean; - /** Selects the point. The point is displayed in a 'selected' style until another point is selected or the current point is deselected programmatically. */ - select(): void; - /** Shows the tooltip of the point. */ - showTooltip(): void; - /** Allows you to obtain the label of a series point. */ - getLabel(): any; - /** Returns the series object to which the point belongs. */ - series: BaseSeries; - } - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface ChartSeries extends BaseSeries { - /** Returns the name of the series pane. */ - pane: string; - /** Returns the name of the value axis of the series. */ - axis: string; - selectPoint(point: ChartPoint): void; - deselectPoint(point: ChartPoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface ChartPoint extends BasePoint { - /** Contains the close value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalCloseValue: any; - /** Contains the high value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalHighValue: any; - /** Contains the low value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalLowValue: any; - /** Contains the first value of the point. This field is useful for points belonging to a series of the range area or range bar type only. */ - originalMinValue: any; - /** Contains the open value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalOpenValue: any; - /** Contains the size of the bubble as it was set in the data source. This field is useful for points belonging to a series of the bubble type only. */ - size: any; - /** Gets the parameters of the point's minimum bounding rectangle (MBR). */ - getBoundingRect(): { x: number; y: number; width: number; height: number; }; - series: ChartSeries; - } - /** This section describes the methods that can be used in code to manipulate the Label object. */ - export interface Label { - /** Gets the parameters of the label's minimum bounding rectangle (MBR). */ - getBoundingRect(): { x: number; y: number; width: number; height: number; }; - /** Hides the point label. */ - hide(): void; - /** Shows the point label. */ - show(): void; - } - export interface PieSeries extends BaseSeries { - selectPoint(point: PiePoint): void; - deselectPoint(point: PiePoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface PiePoint extends BasePoint { - /** Gets the percentage value of the specific point. */ - percent: any; - /** Provides information about the visibility state of a point. */ - isVisible(): boolean; - /** Makes a specific point visible. */ - show(): void; - /** Hides a specific point. */ - hide(): void; - series: PieSeries; - } - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface PolarSeries extends BaseSeries { - /** Returns the name of the value axis of the series. */ - axis: string; - selectPoint(point: PolarPoint): void; - deselectPoint(point: PolarPoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface PolarPoint extends BasePoint { - series: PolarSeries; - } - export interface Strip { - /** Specifies a color for a strip. */ - color?: string; - /** An object that defines the label configuration options of a strip. */ - label?: { - /** Specifies the text displayed in a strip. */ - text?: string; - }; - /** Specifies a start value for a strip. */ - startValue?: any; - /** Specifies an end value for a strip. */ - endValue?: any; - } - export interface BaseSeriesConfigLabel { - /** Specifies a format for arguments displayed by point labels. */ - argumentFormat?: string; - /** Specifies a precision for formatted point arguments displayed in point labels. */ - argumentPrecision?: number; - /** Specifies a background color for point labels. */ - backgroundColor?: string; - /** Specifies border options for point labels. */ - border?: viz.core.DashedBorder; - /** Specifies connector options for series point labels. */ - connector?: { - /** Specifies the color of label connectors. */ - color?: string; - /** Indicates whether or not label connectors are visible. */ - visible?: boolean; - /** Specifies the width of label connectors. */ - width?: number; - }; - /** Specifies a callback function that returns the text to be displayed by point labels. */ - customizeText?: (pointInfo: Object) => string; - /** Specifies font options for the text displayed in point labels. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed by point labels. */ - format?: string; - position?: string; - /** Specifies a precision for formatted point values displayed in point labels. */ - precision?: number; - /** Specifies the angle used to rotate point labels from their initial position. */ - rotationAngle?: number; - /** Specifies the visibility of point labels. */ - visible?: boolean; - } - export interface SeriesConfigLabel extends BaseSeriesConfigLabel { - /** Specifies whether or not to show a label when the point has a zero value. */ - showForZeroValues?: boolean; - } - export interface ChartSeriesConfigLabel extends SeriesConfigLabel { - /** Specifies how to align point labels relative to the corresponding data points that they represent. */ - alignment?: string; - /** Specifies how to shift point labels horizontally from their initial positions. */ - horizontalOffset?: number; - /** Specifies how to shift point labels vertically from their initial positions. */ - verticalOffset?: number; - /** Specifies a precision for the percentage values displayed in the labels of a full-stacked-like series. */ - percentPrecision?: number; - } - export interface BaseCommonSeriesConfig { - /** Specifies the data source field that provides arguments for series points. */ - argumentField?: string; - axis?: string; - /** An object defining the label configuration options for a series in the dxChart widget. */ - label?: ChartSeriesConfigLabel; - /** Specifies border options for point labels. */ - border?: viz.core.DashedBorder; - /** Specifies a series color. */ - color?: string; - /** Specifies the dash style of the series' line. */ - dashStyle?: string; - hoverMode?: string; - hoverStyle?: { - /** An object defining the border options for a hovered series. */ - border?: viz.core.DashedBorder; - /**

Sets a color for a series when it is hovered over.

*/ - color?: string; - /** Specifies the dash style for the line in a hovered series. */ - dashStyle?: string; - hatching?: viz.core.Hatching; - /** Specifies the width of a line in a hovered series. */ - width?: number; - }; - /** Specifies whether a chart ignores null data points or not. */ - ignoreEmptyPoints?: boolean; - /** Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed. */ - maxLabelCount?: number; - /** Specifies the minimal length of a displayed bar in pixels. */ - minBarSize?: number; - /** Specifies opacity for a series. */ - opacity?: number; - /** Specifies the series elements to highlight when the series is selected. */ - selectionMode?: string; - selectionStyle?: { - /** An object defining the border options for a selected series. */ - border?: viz.core.DashedBorder; - /** Sets a color for a series when it is selected. */ - color?: string; - /** Specifies the dash style for the line in a selected series. */ - dashStyle?: string; - hatching?: viz.core.Hatching; - /** Specifies the width of a line in a selected series. */ - width?: number; - }; - /** Specifies whether or not to show the series in the chart's legend. */ - showInLegend?: boolean; - /** Specifies the name of the stack where the values of the _stackedBar_ series must be located. */ - stack?: string; - /** Specifies the name of the data source field that provides data about a point. */ - tagField?: string; - /** Specifies the data source field that provides values for series points. */ - valueField?: string; - /** Specifies the visibility of a series. */ - visible?: boolean; - /** Specifies a line width. */ - width?: number; - /** Configures error bars. */ - valueErrorBar?: { - /** Specifies whether error bars must be displayed in full or partially. */ - displayMode?: string; - /** Specifies the data field that provides data for low error values. */ - lowValueField?: string; - /** Specifies the data field that provides data for high error values. */ - highValueField?: string; - /** Specifies how error bar values must be calculated. */ - type?: string; - /** Specifies the value to be used for generating error bars. */ - value?: number; - /** Specifies the color of error bars. */ - color?: string; - /** Specifies the opacity of error bars. */ - opacity?: number; - /** Specifies the length of the lines that indicate the error bar edges. */ - edgeLength?: number; - /** Specifies the width of the error bar line. */ - lineWidth?: number; - }; - } - export interface CommonPointOptions { - /** Specifies border options for points in the line and area series. */ - border?: viz.core.Border; - /** Specifies the points color. */ - color?: string; - /** Specifies what series points to highlight when a point is hovered over. */ - hoverMode?: string; - /** An object defining configuration options for a hovered point. */ - hoverStyle?: { - /** An object defining the border options for a hovered point. */ - border?: viz.core.Border; - /** Sets a color for a point when it is hovered over. */ - color?: string; - /** Specifies the diameter of a hovered point in the series that represents data points as symbols (not as bars for instance). */ - size?: number; - }; - /** Specifies what series points to highlight when a point is selected. */ - selectionMode?: string; - /** An object defining configuration options for a selected point. */ - selectionStyle?: { - /** An object defining the border options for a selected point. */ - border?: viz.core.Border; - /**

Sets a color for a point when it is selected.

*/ - color?: string; - /** Specifies the diameter of a selected point in the series that represents data points as symbols (not as bars for instance). */ - size?: number; - }; - /** Specifies the point diameter in pixels for those series that represent data points as symbols (not as bars for instance). */ - size?: number; - /** Specifies a symbol for presenting points of the line and area series. */ - symbol?: string; - visible?: boolean; - } - export interface ChartCommonPointOptions extends CommonPointOptions { - /** An object specifying the parameters of an image that is used as a point marker. */ - image?: { - /** Specifies the height of an image that is used as a point marker. */ - height?: any; - /** Specifies a URL leading to the image to be used as a point marker. */ - url?: any; - /** Specifies the width of an image that is used as a point marker. */ - width?: any; - }; - } - export interface PolarCommonPointOptions extends CommonPointOptions { - /** An object specifying the parameters of an image that is used as a point marker. */ - image?: { - /** Specifies the height of an image that is used as a point marker. */ - height?: number; - /** Specifies a URL leading to the image to be used as a point marker. */ - url?: string; - /** Specifies the width of an image that is used as a point marker. */ - width?: number; - }; - } - /** An object that defines configuration options for chart series. */ - export interface CommonSeriesConfig extends BaseCommonSeriesConfig { - /** Specifies the data source field that provides a 'close' value for a _candleStick_ or _stock_ series. */ - closeValueField?: string; - /** Specifies a radius for bar corners. */ - cornerRadius?: number; - /** Specifies the data source field that provides a 'high' value for a _candleStick_ or _stock_ series. */ - highValueField?: string; - /** Specifies the color for the body (rectangle) of a _candleStick_ series. */ - innerColor?: string; - /** Specifies the data source field that provides a 'low' value for a _candleStick_ or _stock_ series. */ - lowValueField?: string; - /** Specifies the data source field that provides an 'open' value for a _candleStick_ or _stock_ series. */ - openValueField?: string; - /** Specifies the pane that will be used to display a series. */ - pane?: string; - /** An object defining configuration options for points in line-, scatter- and area-like series. */ - point?: ChartCommonPointOptions; - /** Specifies the data source field that provides values for one end of a range series. To set the data source field for the other end of the range series, use the rangeValue2Field property. */ - rangeValue1Field?: string; - /** Specifies the data source field that provides values for the second end of a range series. To set the data source field for the other end of the range series, use the rangeValue1Field property. */ - rangeValue2Field?: string; - /** Specifies reduction options for the stock or candleStick series. */ - reduction?: { - /** Specifies a color for the points whose reduction level price is lower in comparison to the value in the previous point. */ - color?: string; - /** Specifies for which price level (open, high, low or close) to enable reduction options in the series. */ - level?: string; - }; - /** Specifies the data source field that defines the size of bubbles. */ - sizeField?: string; - } - export interface CommonSeriesSettings extends CommonSeriesConfig { - /**

An object that specifies configuration options for all series of the area type in the chart.

*/ - area?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _bar_ type in the chart. */ - bar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the bubble type in the chart. */ - bubble?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _candleStick_ type in the chart. */ - candlestick?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _fullStackedArea_ type in the chart. */ - fullstackedarea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Full-Stacked Spline Area type in the chart. */ - fullstackedsplinearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _fullStackedBar_ type in the chart. */ - fullstackedbar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _fullStackedLine_ type in the chart. */ - fullstackedline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Full-Stacked Spline type in the chart. */ - fullstackedspline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _line_ type in the chart. */ - line?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _rangeArea_ type in the chart. */ - rangearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _rangeBar_ type in the chart. */ - rangebar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _scatter_ type in the chart. */ - scatter?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _spline_ type in the chart. */ - spline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _splineArea_ type in the chart. */ - splinearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedArea_ type in the chart. */ - stackedarea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Stacked Spline Area type in the chart. */ - stackedsplinearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedBar_ type in the chart. */ - stackedbar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedLine_ type in the chart. */ - stackedline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Stacked Spline type in the chart. */ - stackedspline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stepArea_ type in the chart. */ - steparea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stepLine_ type in the chart. */ - stepline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stock_ type in the chart. */ - stock?: CommonSeriesConfig; - /** Sets a series type. */ - type?: string; - } - export interface SeriesConfig extends CommonSeriesConfig { - /** Specifies the name that identifies the series. */ - name?: string; - /** Specifies data about a series. */ - tag?: any; - /** Sets the series type. */ - type?: string; - } - /** An object that defines configuration options for polar chart series. */ - export interface CommonPolarSeriesConfig extends BaseCommonSeriesConfig { - /** Specifies whether or not to close the chart by joining the end point with the first point. */ - closed?: boolean; - label?: SeriesConfigLabel; - point?: PolarCommonPointOptions; - } - export interface CommonPolarSeriesSettings extends CommonPolarSeriesConfig { - /** An object that specifies configuration options for all series of the area type in the chart. */ - area?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _bar_ type in the chart. */ - bar?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _line_ type in the chart. */ - line?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _scatter_ type in the chart. */ - scatter?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedBar_ type in the chart. */ - stackedbar?: CommonPolarSeriesConfig; - /** Sets a series type. */ - type?: string; - } - export interface PolarSeriesConfig extends CommonPolarSeriesConfig { - /** Specifies the name that identifies the series. */ - name?: string; - /** Specifies data about a series. */ - tag?: any; - /** Sets the series type. */ - type?: string; - } - export interface PieSeriesConfigLabel extends BaseSeriesConfigLabel { - /** Specifies how to shift labels from their initial position in a radial direction in pixels. */ - radialOffset?: number; - /** Specifies a precision for the percentage values displayed in labels. */ - percentPrecision?: number; - } - /** An object that defines configuration options for chart series. */ - export interface CommonPieSeriesConfig { - /** Specifies the data source field that provides arguments for series points. */ - argumentField?: string; - /** Specifies the required type for series arguments. */ - argumentType?: string; - /** An object defining the series border configuration options. */ - border?: viz.core.DashedBorder; - /** Specifies a series color. */ - color?: string; - /** Specifies the chart elements to highlight when a series is hovered over. */ - hoverMode?: string; - /** An object defining configuration options for a hovered series. */ - hoverStyle?: { - /** An object defining the border options for a hovered series. */ - border?: viz.core.DashedBorder; - /** Sets a color for the series when it is hovered over. */ - color?: string; - /** Specifies the hatching options to be applied when a point is hovered over. */ - hatching?: viz.core.Hatching; - }; - /** - * Specifies the fraction of the inner radius relative to the total radius in the series of the 'doughnut' type. - * @deprecated use the 'innerRadius' option instead - */ - innerRadius?: number; - /** An object defining the label configuration options. */ - label?: PieSeriesConfigLabel; - /** Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed. */ - maxLabelCount?: number; - /** Specifies a minimal size of a displayed pie segment. */ - minSegmentSize?: number; - /** - * Specifies the direction in which the dxPieChart series points are located. - * @deprecated use the 'segmentsDirection' option instead - */ - segmentsDirection?: string; - /**

Specifies the chart elements to highlight when the series is selected.

*/ - selectionMode?: string; - /** An object defining configuration options for the series when it is selected. */ - selectionStyle?: { - /** An object defining the border options for a selected series. */ - border?: viz.core.DashedBorder; - /** Sets a color for a series when it is selected. */ - color?: string; - /** Specifies the hatching options to be applied when a point is selected. */ - hatching?: viz.core.Hatching; - }; - /** Specifies chart segment grouping options. */ - smallValuesGrouping?: { - /** Specifies the name of the grouped chart segment. This name represents the segment in the chart legend. */ - groupName?: string; - /** Specifies the segment grouping mode. */ - mode?: string; - /** Specifies a threshold for segment values. */ - threshold?: number; - /** Specifies how many segments must not be grouped. */ - topCount?: number; - }; - /** - * Specifies a start angle for a pie chart in arc degrees. - * @deprecated use the 'startAngle' option instead - */ - startAngle?: number; - /**

Specifies the name of the data source field that provides data about a point.

*/ - tagField?: string; - /** Specifies the data source field that provides values for series points. */ - valueField?: string; - } - export interface CommonPieSeriesSettings extends CommonPieSeriesConfig { - /** - * Specifies the type of the pie chart series. - * @deprecated use the 'type' option instead - */ - type?: string; - } - export interface PieSeriesConfig extends CommonPieSeriesConfig { - /** - * Sets the series type. - * @deprecated use the 'type' option instead - */ - type?: string; - /** Specifies the name that identifies the series. */ - name?: string; - /** Specifies data about a series. */ - tag?: any; - } - export interface SeriesTemplate { - /** Specifies a callback function that returns a series object with individual series settings. */ - customizeSeries?: (seriesName: string) => SeriesConfig; - /** Specifies a data source field that represents the series name. */ - nameField?: string; - } - export interface PolarSeriesTemplate { - /** Specifies a callback function that returns a series object with individual series settings. */ - customizeSeries?: (seriesName: string) => PolarSeriesConfig; - /** Specifies a data source field that represents the series name. */ - nameField?: string; - } - export interface ChartCommonConstantLineLabel { - /** Specifies font options for a constant line label. */ - font?: viz.core.Font; - /** Specifies the position of the constant line label relative to the chart plot. */ - position?: string; - /** Indicates whether or not to display labels for the axis constant lines. */ - visible?: boolean; - } - export interface PolarCommonConstantLineLabel { - /** Indicates whether or not to display labels for the axis constant lines. */ - visible?: boolean; - /** Specifies font options for a constant line label. */ - font?: viz.core.Font; - } - export interface ConstantLineStyle { - /** Specifies a color for a constant line. */ - color?: string; - /** Specifies a dash style for a constant line. */ - dashStyle?: string; - /** Specifies a constant line width in pixels. */ - width?: number; - } - export interface ChartCommonConstantLineStyle extends ConstantLineStyle { - /** An object defining constant line label options. */ - label?: ChartCommonConstantLineLabel; - /** Specifies the space between the constant line label and the left/right side of the constant line. */ - paddingLeftRight?: number; - /** Specifies the space between the constant line label and the top/bottom side of the constant line. */ - paddingTopBottom?: number; - } - export interface PolarCommonConstantLineStyle extends ConstantLineStyle { - /** An object defining constant line label options. */ - label?: PolarCommonConstantLineLabel; - } - export interface CommonAxisLabel { - /** Specifies font options for axis labels. */ - font?: viz.core.Font; - /** Specifies the spacing between an axis and its labels in pixels. */ - indentFromAxis?: number; - /** Indicates whether or not axis labels are visible. */ - visible?: boolean; - } - export interface ChartCommonAxisLabel extends CommonAxisLabel { - /** Specifies the label's position relative to the tick (grid line). */ - alignment?: string; - /** Specifies the overlap resolving algorithm to be applied to axis labels. */ - overlappingBehavior?: { - /** Specifies how to arrange axis labels. */ - mode?: string; - /** Specifies the angle used to rotate axis labels. */ - rotationAngle?: number; - /** Specifies the spacing that must be set between staggered rows when the 'stagger' algorithm is applied. */ - staggeringSpacing?: number; - }; - } - export interface PolarCommonAxisLabel extends CommonAxisLabel { - /** Specifies the overlap resolving algorithm to be applied to axis labels. */ - overlappingBehavior?: string; - } - export interface CommonAxisTitle { - /** Specifies font options for an axis title. */ - font?: viz.core.Font; - /** Specifies a margin for an axis title in pixels. */ - margin?: number; - } - export interface BaseCommonAxisSettings { - /** Specifies the color of the line that represents an axis. */ - color?: string; - /** Specifies whether ticks/grid lines of a discrete axis are located between labels or cross the labels. */ - discreteAxisDivisionMode?: string; - /** An object defining the configuration options for the grid lines of an axis in the dxPolarChart widget. */ - grid?: { - /** Specifies a color for grid lines. */ - color?: string; - /** Specifies an opacity for grid lines. */ - opacity?: number; - /** Indicates whether or not the grid lines of an axis are visible. */ - visible?: boolean; - /** Specifies the width of grid lines. */ - width?: number; - }; - /** Specifies the options of the minor grid. */ - minorGrid?: { - /** Specifies a color for the lines of the minor grid. */ - color?: string; - /** Specifies an opacity for the lines of the minor grid. */ - opacity?: number; - /** Indicates whether the minor grid is visible or not. */ - visible?: boolean; - /** Specifies a width for the lines of the minor grid. */ - width?: number; - }; - /** Indicates whether or not an axis is inverted. */ - inverted?: boolean; - /** Specifies the opacity of the line that represents an axis. */ - opacity?: number; - /** Indicates whether or not to set ticks/grid lines of a continuous axis of the 'date-time' type at the beginning of each date-time interval. */ - setTicksAtUnitBeginning?: boolean; - /** An object defining the configuration options for axis ticks. */ - tick?: { - /** Specifies ticks color. */ - color?: string; - /** Specifies tick opacity. */ - opacity?: number; - /** Indicates whether or not ticks are visible on an axis. */ - visible?: boolean; - /** Specifies tick width. */ - width?: number; - /** Specifies tick length. */ - length?: number; - }; - /** Specifies the options of the minor ticks. */ - minorTick?: { - /** Specifies a color for the minor ticks. */ - color?: string; - /** Specifies an opacity for the minor ticks. */ - opacity?: number; - /** Indicates whether or not the minor ticks are displayed on an axis. */ - visible?: boolean; - /** Specifies minor tick width. */ - width?: number; - /** Specifies minor tick length. */ - length?: number; - }; - /** Indicates whether or not the line that represents an axis in a chart is visible. */ - visible?: boolean; - /** Specifies the width of the line that represents an axis in the chart. */ - width?: number; - } - export interface ChartCommonAxisSettings extends BaseCommonAxisSettings { - /** Specifies the appearance of all the widget's constant lines. */ - constantLineStyle?: ChartCommonConstantLineStyle; - /** An object defining the label configuration options that are common for all axes in the dxChart widget. */ - label?: ChartCommonAxisLabel; - /** Specifies a coefficient that determines the spacing between the maximum series point and the axis. */ - maxValueMargin?: number; - /** Specifies a coefficient that determines the spacing between the minimum series point and the axis. */ - minValueMargin?: number; - /** Specifies, in pixels, the space reserved for an axis. */ - placeholderSize?: number; - /** An object defining configuration options for strip style. */ - stripStyle?: { - /** An object defining the configuration options for a strip label style. */ - label?: { - /** Specifies font options for a strip label. */ - font?: viz.core.Font; - /** Specifies the label's position on a strip. */ - horizontalAlignment?: string; - /** Specifies a label's position on a strip. */ - verticalAlignment?: string; - }; - /** Specifies the spacing, in pixels, between the left/right strip border and the strip label. */ - paddingLeftRight?: number; - /** Specifies the spacing, in pixels, between the top/bottom strip borders and the strip label. */ - paddingTopBottom?: number; - }; - /** An object defining the title configuration options that are common for all axes in the dxChart widget. */ - title?: CommonAxisTitle; - /** Indicates whether or not to display series with indents from axis boundaries. */ - valueMarginsEnabled?: boolean; - } - export interface PolarCommonAxisSettings extends BaseCommonAxisSettings { - /** Specifies the appearance of all the widget's constant lines. */ - constantLineStyle?: PolarCommonConstantLineStyle; - /** An object defining the label configuration options that are common for all axes in the dxPolarChart widget. */ - label?: PolarCommonAxisLabel; - /** An object defining configuration options for strip style. */ - stripStyle?: { - /** An object defining the configuration options for a strip label style. */ - label?: { - /** Specifies font options for a strip label. */ - font?: viz.core.Font; - }; - }; - } - export interface ChartConstantLineLabel extends ChartCommonConstantLineLabel { - /** Specifies the horizontal alignment of a constant line label. */ - horizontalAlignment?: string; - /** Specifies the vertical alignment of a constant line label. */ - verticalAlignment?: string; - /** Specifies the text to be displayed in a constant line label. */ - text?: string; - } - export interface PolarConstantLineLabel extends PolarCommonConstantLineLabel { - /** Specifies the text to be displayed in a constant line label. */ - text?: string; - } - export interface AxisLabel { - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a label on the value axis. */ - customizeHint?: (argument: { value: any; valueText: string }) => string; - /** Specifies a callback function that returns the text to be displayed in value axis labels. */ - customizeText?: (argument: { value: any; valueText: string }) => string; - /** Specifies a format for the text displayed by axis labels. */ - format?: string; - /** Specifies a precision for the formatted value displayed in the axis labels. */ - precision?: number; - } - export interface ChartAxisLabel extends ChartCommonAxisLabel, AxisLabel { } - export interface PolarAxisLabel extends PolarCommonAxisLabel, AxisLabel { } - export interface AxisTitle extends CommonAxisTitle { - /** Specifies the text for the value axis title. */ - text?: string; - } - export interface ChartConstantLineStyle extends ChartCommonConstantLineStyle { - /** An object defining constant line label options. */ - label?: ChartConstantLineLabel; - } - export interface ChartConstantLine extends ChartConstantLineStyle { - /** An object defining constant line label options. */ - label?: ChartConstantLineLabel; - /** Specifies a value to be displayed by a constant line. */ - value?: any; - } - export interface PolarConstantLine extends PolarCommonConstantLineStyle { - /** An object defining constant line label options. */ - label?: PolarConstantLineLabel; - /** Specifies a value to be displayed by a constant line. */ - value?: any; - } - export interface Axis { - /** Specifies a coefficient for dividing the value axis. */ - axisDivisionFactor?: number; - /** Specifies the order in which discrete values are arranged on the value axis. */ - categories?: Array; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic axis. */ - logarithmBase?: number; - /** Specifies an interval between axis ticks/grid lines. */ - tickInterval?: any; - /** Specifies the interval between minor ticks. */ - minorTickInterval?: any; - /** Specifies the number of minor ticks between two neighboring major ticks. */ - minorTickCount?: number; - /** Specifies the required type of the value axis. */ - type?: string; - /** Specifies the pane on which the current value axis will be displayed. */ - pane?: string; - /** Specifies options for value axis strips. */ - strips?: Array; - } - export interface ChartAxis extends ChartCommonAxisSettings, Axis { - /** Defines an array of the value axis constant lines. */ - constantLines?: Array; - /** Specifies the appearance options for the constant lines of the value axis. */ - constantLineStyle?: ChartCommonConstantLineStyle; - /** Specifies options for value axis labels. */ - label?: ChartAxisLabel; - /** Specifies the maximum value on the value axis. */ - max?: any; - /** Specifies the minimum value on the value axis. */ - min?: any; - /** Specifies the position of the value axis on a chart. */ - position?: string; - /** Specifies the title for a value axis. */ - title?: AxisTitle; - } - export interface PolarAxis extends PolarCommonAxisSettings, Axis { - /** Defines an array of the value axis constant lines. */ - constantLines?: Array; - /** Specifies options for value axis labels. */ - label?: PolarAxisLabel; - } - export interface ArgumentAxis { - /** Specifies the desired type of axis values. */ - argumentType?: string; - /** Specifies the elements that will be highlighted when the argument axis is hovered over. */ - hoverMode?: string; - } - export interface ChartArgumentAxis extends ChartAxis, ArgumentAxis { } - export interface PolarArgumentAxis extends PolarAxis, ArgumentAxis { - /** Specifies the angle in arc degrees to which the argument axis should be rotated. The positive values rotate the axis clockwise. */ - startAngle?: number; - /** Specifies whether or not to display the first point at the angle specified by the startAngle option. */ - firstPointOnStartAngle?: boolean; - /** Specifies the value to be used as the origin for the argument axis. */ - originValue?: number; - /** Specifies the period of the argument values in the data source. */ - period?: number; - } - export interface ValueAxis { - /** Specifies the name of the value axis. */ - name?: string; - /** Specifies whether or not to indicate a zero value on the value axis. */ - showZero?: boolean; - /** Specifies the desired type of axis values. */ - valueType?: string; - } - export interface ChartValueAxis extends ChartAxis, ValueAxis { - /** Specifies the spacing, in pixels, between multiple value axes in a chart. */ - multipleAxesSpacing?: number; - /** Specifies the value by which the chart's value axes are synchronized. */ - synchronizedValue?: number; - } - export interface PolarValueAxis extends PolarAxis, ValueAxis { - /** Indicates whether to display series with indents from axis boundaries. */ - valueMarginsEnabled?: boolean; - /** Specifies a coefficient that determines the spacing between the maximum series point and the axis. */ - maxValueMargin?: number; - /** Specifies a coefficient that determines the spacing between the minimum series point and the axis. */ - minValueMargin?: number; - tick?: { - visible?: boolean; - } - } - export interface CommonPane { - /** Specifies a background color in a pane. */ - backgroundColor?: string; - /** Specifies the border options of a chart's pane. */ - border?: PaneBorder; - } - export interface Pane extends CommonPane { - /** Specifies the name of a pane. */ - name?: string; - } - export interface PaneBorder extends viz.core.DashedBorderWithOpacity { - /** Specifies the bottom border's visibility state in a pane. */ - bottom?: boolean; - /** Specifies the left border's visibility state in a pane. */ - left?: boolean; - /** Specifies the right border's visibility state in a pane. */ - right?: boolean; - /** Specifies the top border's visibility state in a pane. */ - top?: boolean; - } - export interface ChartAnimation extends viz.core.Animation { - /** Specifies the maximum series point count in the chart that the animation supports. */ - maxPointCountSupported?: number; - } - export interface BaseChartTooltip extends viz.core.Tooltip { - /** Specifies a format for arguments of the chart's series points. */ - argumentFormat?: string; - /** Specifies a precision for formatted arguments displayed in tooltips. */ - argumentPrecision?: number; - /** Specifies a precision for a percent value displayed in tooltips for stacked series and dxPieChart series. */ - percentPrecision?: number; - } - export interface BaseChartOptions extends viz.core.BaseWidgetOptions { - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - /** Specifies the width of the widget that is small enough for the layout to begin adapting. */ - width?: number; - /** Specifies the height of the widget that is small enough for the layout to begin adapting. */ - height?: number; - /** Specifies whether or not point labels can be hidden when the layout is adapting. */ - keepLabels?: boolean; - }; - /** Specifies animation options. */ - animation?: ChartAnimation; - /** Specifies a callback function that returns an object with options for a specific point label. */ - customizeLabel?: (labelInfo: Object) => Object; - /** Specifies a callback function that returns an object with options for a specific point. */ - customizePoint?: (pointInfo: Object) => Object; - /** Specifies a data source for the chart. */ - dataSource?: any; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies options of a dxChart's (dxPieChart's) legend. */ - legend?: core.BaseLegend; - /** Specifies the blank space between the chart's extreme elements and the boundaries of the area provided for the widget (see size) in pixels. */ - margin?: viz.core.Margins; - /** Sets the name of the palette to be used in the chart. Alternatively, an array of colors can be set as a custom palette to be used within this chart. */ - palette?: any; - /** A handler for the done event. */ - onDone?: (e: { - component: BaseChart; - element: Element; - }) => void; - /** A handler for the pointClick event. */ - onPointClick?: any; - /** A handler for the pointHoverChanged event. */ - onPointHoverChanged?: (e: { - component: BaseChart; - element: Element; - target: TPoint; - }) => void; - /** A handler for the pointSelectionChanged event. */ - onPointSelectionChanged?: (e: { - component: BaseChart; - element: Element; - target: TPoint; - }) => void; - /** Specifies whether a single point or multiple points can be selected in the chart. */ - pointSelectionMode?: string; - /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */ - redrawOnResize?: boolean; - /** Specifies options for the dxChart and dxPieChart widget series. */ - series?: any; - /** Specifies the size of the widget in pixels. */ - size?: viz.core.Size; - /** Specifies a title for the chart. */ - title?: viz.core.Title; - /** Specifies tooltip options. */ - tooltip?: BaseChartTooltip; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: BaseChart; - element: Element; - target: BasePoint; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: BaseChart; - element: Element; - target: BasePoint; - }) => void; - } - /** A base class for all chart widgets included in the ChartJS library. */ - export class BaseChart extends viz.core.BaseWidget { - /** Deselects the chart's selected series. The series is displayed in an initial style. */ - clearSelection(): void; - /** Gets the current size of the widget. */ - getSize(): { width: number; height: number }; - /** Returns an array of all series in the chart. */ - getAllSeries(): Array; - /** Gets a series within the chart's series collection by the specified name (see the name option). */ - getSeriesByName(seriesName: string): BaseSeries; - /** Gets a series within the chart's series collection by its position number. */ - getSeriesByPos(seriesIndex: number): BaseSeries; - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Hides all widget tooltips. */ - hideTooltip(): void; - /** Redraws a widget. */ - render(renderOptions?: { - force?: boolean; - animate?: boolean; - asyncSeriesRendering?: boolean; - }): void; - } - export interface AdvancedLegend extends core.BaseLegend { - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item. */ - customizeHint?: (seriesInfo: { seriesName: string; seriesIndex: number; seriesColor: string; }) => string; - /**

Specifies a callback function that returns the text to be displayed by legend items.

*/ - customizeText?: (seriesInfo: { seriesName: string; seriesIndex: number; seriesColor: string; }) => string; - /** Specifies what series elements to highlight when a corresponding item in the legend is hovered over. */ - hoverMode?: string; - } - export interface AdvancedOptions extends BaseChartOptions { - /** A handler for the argumentAxisClick event. */ - onArgumentAxisClick?: any; - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** An object providing options for managing data from a data source. */ - dataPrepareSettings?: { - /** Specifies whether or not to validate the values from a data source. */ - checkTypeForAllData?: boolean; - /** Specifies whether or not to convert the values from a data source into the data type of an axis. */ - convertToAxisDataType?: boolean; - /** Specifies how to sort the series points. */ - sortingMethod?: any; - }; - /** A handler for the legendClick event. */ - onLegendClick?: any; - /** A handler for the seriesClick event. */ - onSeriesClick?: any; - /** A handler for the seriesHoverChanged event. */ - onSeriesHoverChanged?: (e: { - component: BaseChart; - element: Element; - target: TSeries; - }) => void; - /** A handler for the seriesSelectionChanged event. */ - onSeriesSelectionChanged?: (e: { - component: BaseChart; - element: Element; - target: TSeries; - }) => void; - /** Specifies whether a single series or multiple series can be selected in the chart. */ - seriesSelectionMode?: string; - /** Specifies how the chart must behave when series point labels overlap. */ - resolveLabelOverlapping?: string; - /** Specifies whether or not all bars in a series must have the same angle, or may have different angles if any points in other series are missing. */ - equalBarWidth?: boolean; - /** Specifies a common bar width as a percentage from 0 to 1. */ - barWidth?: number; - } - export interface Legend extends AdvancedLegend { - /** Specifies whether the legend is located outside or inside the chart's plot. */ - position?: string; - } - export interface ChartTooltip extends BaseChartTooltip { - /** Specifies whether the tooltip must be located in the center of a bar or on its edge. Applies to the Bar and Bubble series. */ - location?: string; - /** Specifies the kind of information to display in a tooltip. */ - shared?: boolean; - } - export interface dxChartOptions extends AdvancedOptions { - adaptiveLayout?: { - keepLabels?: boolean; - }; - /** Indicates whether or not to synchronize value axes when they are displayed on a single pane. */ - synchronizeMultiAxes?: boolean; - /** Specifies whether or not to filter the series points depending on their quantity. */ - useAggregation?: boolean; - /** Indicates whether or not to adjust a value axis to the current minimum and maximum values of a zoomed chart. */ - adjustOnZoom?: boolean; - /** Specifies argument axis options for the dxChart widget. */ - argumentAxis?: ChartArgumentAxis; - /** An object defining the configuration options that are common for all axes of the dxChart widget. */ - commonAxisSettings?: ChartCommonAxisSettings; - /** An object defining the configuration options that are common for all panes in the dxChart widget. */ - commonPaneSettings?: CommonPane; - /** An object defining the configuration options that are common for all series of the dxChart widget. */ - commonSeriesSettings?: CommonSeriesSettings; - /** An object that specifies the appearance options of the chart crosshair. */ - crosshair?: { - /** Specifies a color for the crosshair lines. */ - color?: string; - /** Specifies a dash style for the crosshair lines. */ - dashStyle?: string; - /** Specifies whether to enable the crosshair or not. */ - enabled?: boolean; - /** Specifies the opacity of the crosshair lines. */ - opacity?: number; - /** Specifies the width of the crosshair lines. */ - width?: number; - /** Specifies the appearance of the horizontal crosshair line. */ - horizontalLine?: CrosshaierWithLabel; - /** Specifies the appearance of the vertical crosshair line. */ - verticalLine?: CrosshaierWithLabel; - /** Specifies the options of the crosshair labels. */ - label?: { - /** Specifies a color for the background of the crosshair labels. */ - backgroundColor?: string; - /** Specifies whether the crosshair labels are visible or not. */ - visible?: boolean; - /** Specifies font options for the text of the crosshair labels. */ - font?: viz.core.Font; - } - }; - /** Specifies a default pane for the chart's series. */ - defaultPane?: string; - /** Specifies a coefficient determining the diameter of the largest bubble. */ - maxBubbleSize?: number; - /** Specifies the diameter of the smallest bubble measured in pixels. */ - minBubbleSize?: number; - /** Defines the dxChart widget's pane(s). */ - panes?: Array; - /** Swaps the axes round so that the value axis becomes horizontal and the argument axes becomes vertical. */ - rotated?: boolean; - /** Specifies the options of a chart's legend. */ - legend?: Legend; - /** Specifies options for dxChart widget series. */ - series?: Array; - /** Defines options for the series template. */ - seriesTemplate?: SeriesTemplate; - /** Specifies tooltip options. */ - tooltip?: ChartTooltip; - /** Specifies value axis options for the dxChart widget. */ - valueAxis?: Array; - /** Enables scrolling in your chart. */ - scrollingMode?: string; - /** Enables zooming in your chart. */ - zoomingMode?: string; - /** Specifies the settings of the scroll bar. */ - scrollBar?: { - /** Specifies whether the scroll bar is visible or not. */ - visible?: boolean; - /** Specifies the spacing between the scroll bar and the chart's plot in pixels. */ - offset?: number; - /** Specifies the color of the scroll bar. */ - color?: string; - /** Specifies the width of the scroll bar in pixels. */ - width?: number; - /** Specifies the opacity of the scroll bar. */ - opacity?: number; - /** Specifies the position of the scroll bar in the chart. */ - position?: string; - }; - } - /** A widget used to embed charts into HTML JS applications. */ - export class dxChart extends BaseChart { - constructor(element: JQuery, options?: dxChartOptions); - constructor(element: Element, options?: dxChartOptions); - /** Sets the specified start and end values for the chart's argument axis. */ - zoomArgument(startValue: any, endValue: any): void; - } - interface CrosshaierWithLabel extends viz.core.DashedBorderWithOpacity { - /** Configures the label that belongs to the horizontal crosshair line. */ - label?: { - /** Specifies a color for the background of the label that belongs to the horizontal crosshair line. */ - backgroundColor?: string; - /** Specifies whether the label of the horizontal crosshair line is visible or not. */ - visible?: boolean; - /** Specifies font options for the text of the label that belongs to the horizontal crosshair line. */ - font?: viz.core.Font; - } - } - export interface PolarChartTooltip extends BaseChartTooltip { - /** Specifies the kind of information to display in a tooltip. */ - shared?: boolean; - } - export interface dxPolarChartOptions extends AdvancedOptions { - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - width?: number; - height?: number; - /** Specifies whether or not point labels can be hidden when the layout is adapting. */ - keepLabels?: boolean; - }; - /** Indicates whether or not to display a "spider web". */ - useSpiderWeb?: boolean; - /** Specifies argument axis options for the dxPolarChart widget. */ - argumentAxis?: PolarArgumentAxis; - /** An object defining the configuration options that are common for all axes of the dxPolarChart widget. */ - commonAxisSettings?: PolarCommonAxisSettings; - /** An object defining the configuration options that are common for all series of the dxPolarChart widget. */ - commonSeriesSettings?: CommonPolarSeriesSettings; - /** Specifies the options of a chart's legend. */ - legend?: AdvancedLegend; - /** Specifies options for dxPolarChart widget series. */ - series?: Array; - /** Defines options for the series template. */ - seriesTemplate?: PolarSeriesTemplate; - /** Specifies tooltip options. */ - tooltip?: PolarChartTooltip; - /** Specifies value axis options for the dxPolarChart widget. */ - valueAxis?: PolarValueAxis; - } - /** A chart widget displaying data in a polar coordinate system. */ - export class dxPolarChart extends BaseChart { - constructor(element: JQuery, options?: dxPolarChartOptions); - constructor(element: Element, options?: dxPolarChartOptions); - } - export interface PieLegend extends core.BaseLegend { - /** Specifies what chart elements to highlight when a corresponding item in the legend is hovered over. */ - hoverMode?: string; - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item. */ - customizeHint?: (pointInfo: { pointName: string; pointIndex: number; pointColor: string; }) => string; - /** Specifies a callback function that returns the text to be displayed by a legend item. */ - customizeText?: (pointInfo: { pointName: string; pointIndex: number; pointColor: string; }) => string; - } - export interface dxPieChartOptions extends BaseChartOptions { - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - /** Specifies whether or not point labels can be hidden when the layout is adapting. */ - keepLabels?: boolean; - }; - /** Specifies dxPieChart legend options. */ - legend?: PieLegend; - /** Specifies options for the series of the dxPieChart widget. */ - series?: Array; - /** Specifies the diameter of the pie. */ - diameter?: number; - /** Specifies the direction that the pie chart segments will occupy. */ - segmentsDirection?: string; - /** Specifies the angle in arc degrees from which the first segment of a pie chart should start. */ - startAngle?: number; - /** Specifies the fraction of the inner radius relative to the total radius in the series of the 'doughnut' type. The value should be between 0 and 1. */ - innerRadius?: number; - /** A handler for the legendClick event. */ - onLegendClick?: any; - /** Specifies how a chart must behave when series point labels overlap. */ - resolveLabelOverlapping?: string; - /** An object defining the configuration options that are common for all series of the dxPieChart widget. */ - commonSeriesSettings?: CommonPieSeriesSettings; - /** Specifies the type of the pie chart series. */ - type?: string; - } - /** A circular chart widget for HTML JS applications. */ - export class dxPieChart extends BaseChart { - constructor(element: JQuery, options?: dxPieChartOptions); - constructor(element: Element, options?: dxPieChartOptions); - /** - * Provides access to the dxPieChart series. - * @deprecated ..\..\BaseChart\3 Methods\getAllSeries().md - */ - getSeries(): PieSeries; - } -} -interface JQuery { - dxChart(options?: DevExpress.viz.charts.dxChartOptions): JQuery; - dxChart(methodName: string, ...params: any[]): any; - dxChart(methodName: "instance"): DevExpress.viz.charts.dxChart; - dxPieChart(options?: DevExpress.viz.charts.dxPieChartOptions): JQuery; - dxPieChart(methodName: string, ...params: any[]): any; - dxPieChart(methodName: "instance"): DevExpress.viz.charts.dxPieChart; - dxPolarChart(options?: DevExpress.viz.charts.dxPolarChartOptions): JQuery; - dxPolarChart(methodName: string, ...params: any[]): any; - dxPolarChart(methodName: "instance"): DevExpress.viz.charts.dxPolarChart; -} -declare namespace DevExpress.viz.gauges { - export interface BaseRangeContainer { - /** Specifies a range container's background color. */ - backgroundColor?: string; - /** Specifies the offset of the range container from an invisible scale line in pixels. */ - offset?: number; - /** Sets the name of the palette or an array of colors to be used for coloring the gauge range container. */ - palette?: any; - /** An array of objects representing ranges contained in the range container. */ - ranges?: Array<{ startValue: number; endValue: number; color: string }>; - /** Specifies a color of a range. */ - color?: string; - /** Specifies an end value of a range. */ - endValue?: number; - /** Specifies a start value of a range. */ - startValue?: number; - } - export interface ScaleTick { - /** Specifies the color of the scale's minor ticks. */ - color?: string; - /** - * Specifies an array of custom minor ticks. - * @deprecated ..\customMinorTicks.md - */ - customTickValues?: Array; - /** Specifies the length of the scale's minor ticks. */ - length?: number; - /** - * Indicates whether automatically calculated minor ticks are visible or not. - * @deprecated This functionality in not more available - */ - showCalculatedTicks?: boolean; - /** - * Specifies an interval between minor ticks. - * @deprecated ..\minorTickInterval.md - */ - tickInterval?: number; - /** Indicates whether scale minor ticks are visible or not. */ - visible?: boolean; - /** Specifies the width of the scale's minor ticks. */ - width?: number; - } - export interface ScaleMajorTick extends ScaleTick { - /** - * Specifies whether or not to expand the current major tick interval if labels overlap each other. - * @deprecated ..\label\overlappingBehavior\useAutoArrangement.md - */ - useTicksAutoArrangement?: boolean; - } - export interface ScaleMinorTick extends ScaleTick { - /** Specifies the opacity of the scale's minor ticks. */ - opacity?: number; - } - export interface BaseScaleLabel { - /** Specifies whether or not scale labels should be colored similarly to their corresponding ranges in the range container. */ - useRangeColors?: boolean; - /** Specifies a callback function that returns the text to be displayed in scale labels. */ - customizeText?: (scaleValue: { value: number; valueText: string }) => string; - /** Specifies the overlap resolving options to be applied to scale labels. */ - overlappingBehavior?: { - /** Specifies whether or not to expand the current major tick interval if labels overlap each other. */ - useAutoArrangement?: boolean; - /** Specifies what label to hide in case of overlapping. */ - hideFirstOrLast?: string; - }; - /** Specifies font options for the text displayed in the scale labels of the gauge. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in scale labels. */ - format?: string; - /** Specifies a precision for the formatted value displayed in the scale labels. */ - precision?: number; - /** Specifies whether or not scale labels are visible on the gauge. */ - visible?: boolean; - } - export interface BaseScale { - /** Specifies the end value for the scale of the gauge. */ - endValue?: number; - /** - * Specifies whether or not to hide the first scale label. - * @deprecated This functionality in not more available - */ - hideFirstLabel?: boolean; - /** - * Specifies whether or not to hide the first major tick on the scale. - * @deprecated This functionality in not more available - */ - hideFirstTick?: boolean; - /** - * Specifies whether or not to hide the last scale label. - * @deprecated This functionality in not more available - */ - hideLastLabel?: boolean; - /** - * Specifies whether or not to hide the last major tick on the scale. - * @deprecated This functionality in not more available - */ - hideLastTick?: boolean; - /** Specifies an interval between major ticks. */ - tickInterval?: number; - /** Specifies an interval between minor ticks. */ - minorTickInterval?: number; - /** Specifies an array of custom major ticks. */ - customTicks?: Array; - /** Specifies an array of custom minor ticks. */ - customMinorTicks?: Array; - /** Specifies common options for scale labels. */ - label?: BaseScaleLabel; - /** - * Specifies options of the gauge's major ticks. - * @deprecated ..\tick\tick.md - */ - majorTick?: ScaleMajorTick; - /** Specifies options of the gauge's major ticks. */ - tick?: { - /** Specifies the color of the scale's major ticks. */ - color?: string; - /** Specifies the length of the scale's major ticks. */ - length?: number; - /** Indicates whether scale major ticks are visible or not. */ - visible?: boolean; - /** Specifies the width of the scale's major ticks. */ - width?: number; - /** Specifies the opacity of the scale's major ticks. */ - opacity?: number; - }; - /** Specifies options of the gauge's minor ticks. */ - minorTick?: ScaleMinorTick; - /** Specifies the start value for the scale of the gauge. */ - startValue?: number; - } - export interface BaseValueIndicator { - /** Specifies the type of subvalue indicators. */ - type?: string; - /** Specifies the background color for the indicator of the rangeBar type. */ - backgroundColor?: string; - /** Specifies the base value for the indicator of the rangeBar type. */ - baseValue?: number; - /** Specifies a color of the indicator. */ - color?: string; - /** Specifies the range bar size for an indicator of the rangeBar type. */ - size?: number; - text?: { - /** Specifies a callback function that returns the text to be displayed in an indicator. */ - customizeText?: (indicatedValue: { value: number; valueText: string }) => string; - font?: viz.core.Font; - /** Specifies a format for the text displayed in an indicator. */ - format?: string; - /** Specifies the range bar's label indent in pixels. */ - indent?: number; - /** Specifies a precision for the formatted value displayed by an indicator. */ - precision?: number; - }; - offset?: number; - length?: number; - width?: number; - /** Specifies the length of an arrow for the indicator of the textCloud type in pixels. */ - arrowLength?: number; - /** Sets the array of colors to be used for coloring subvalue indicators. */ - palette?: Array; - /** Specifies the distance between the needle and the center of a gauge for the indicator of a needle-like type. */ - indentFromCenter?: number; - /** Specifies the second color for the indicator of the twoColorNeedle type. */ - secondColor?: string; - /** Specifies the length of a twoNeedleColor type indicator tip as a percentage. */ - secondFraction?: number; - /** Specifies the spindle's diameter in pixels for the indicator of a needle-like type. */ - spindleSize?: number; - /** Specifies the inner diameter in pixels, so that the spindle has the shape of a ring. */ - spindleGapSize?: number; - /** Specifies the orientation of the rangeBar indicator on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - /** Specifies the orientation of the rangeBar indicator on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - } - export interface SharedGaugeOptions { - /** Specifies animation options. */ - animation?: viz.core.Animation; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */ - redrawOnResize?: boolean; - /** Specifies the size of the widget in pixels. */ - size?: viz.core.Size; - /** - * Specifies a subtitle for the widget. - * @deprecated ..\..\..\BaseGauge\1 Configuration\title\subtitle\subtitle.md - */ - subtitle?: { - /** - * Specifies font options for the subtitle. - * @deprecated ..\..\title\subtitle\font\font.md - */ - font?: viz.core.Font; - /** - * Specifies a text for the subtitle. - * @deprecated ..\title\subtitle\text.md - */ - text?: string; - }; - /** Specifies a title for a gauge. */ - title?: { - /** Specifies font options for the title. */ - font?: viz.core.Font; - /** - * Specifies a title's position on the gauge. - * @deprecated basegaugeoptions_title_verticalAlignment and basegaugeoptions_title_horizontalAlignment - */ - position?: string; - /** Specifies the distance between the title and surrounding gauge elements in pixels. */ - margin?: viz.core.Margins; - /** Specifies the height of the space reserved for the title. */ - placeholderSize?: number; - /** Specifies the gauge title's position in the vertical direction. */ - verticalAlignment?: string; - /** Specifies the gauge title's horizontal position. */ - horizontalAlignment?: string; - /** Specifies text for the title. */ - text?: string; - /** Specifies a subtitle for the widget. */ - subtitle?: { - /** Specifies font options for the subtitle. */ - font?: viz.core.Font; - /** Specifies text for the subtitle. */ - text?: string; - } - }; - /** Specifies options for gauge tooltips. */ - tooltip?: viz.core.Tooltip; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: dxBaseGauge; - element: Element; - target: {}; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: dxBaseGauge; - element: Element; - target: {}; - }) => void; - } - export interface BaseGaugeOptions extends viz.core.BaseWidgetOptions, SharedGaugeOptions { - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** Specifies the blank space in pixels between the widget's extreme elements and the boundaries of the area provided for the widget (see the size option). */ - margin?: viz.core.Margins; - /** Specifies options of the gauge's range container. */ - rangeContainer?: BaseRangeContainer; - /** Specifies a gauge's scale options. */ - scale?: BaseScale; - /** Specifies the appearance options of subvalue indicators. */ - subvalueIndicator?: BaseValueIndicator; - /** Specifies a set of subvalues to be designated by the subvalue indicators. */ - subvalues?: Array; - /** Specifies the main value on a gauge. */ - value?: number; - /** Specifies the appearance options of the value indicator. */ - valueIndicator?: BaseValueIndicator; - } - /** A gauge widget. */ - export class dxBaseGauge extends viz.core.BaseWidget { - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(): void; - /** Returns the main gauge value. */ - value(): number; - /** Updates a gauge value. */ - value(value: number): void; - /** Returns an array of gauge subvalues. */ - subvalues(): Array; - /** Updates gauge subvalues. */ - subvalues(subvalues: Array): void; - } - export interface LinearRangeContainer extends BaseRangeContainer { - /** Specifies the orientation of the range container on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - /** Specifies the orientation of a range container on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - /** Specifies the width of the range container's start and end boundaries in the dxLinearGauge widget. */ - width?: any; - /** Specifies an end width of a range container. */ - end?: number; - /** Specifies a start width of a range container. */ - start?: number; - } - export interface LinearScaleLabel extends BaseScaleLabel { - /** Specifies the spacing between scale labels and ticks. */ - indentFromTick?: number; - } - export interface LinearScale extends BaseScale { - /** Specifies the orientation of scale ticks on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - label?: LinearScaleLabel; - /** Specifies the orientation of scale ticks on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - } - export interface dxLinearGaugeOptions extends BaseGaugeOptions { - /** Specifies the options required to set the geometry of the dxLinearGauge widget. */ - geometry?: { - /** Indicates whether to display the dxLinearGauge widget vertically or horizontally. */ - orientation?: string; - }; - /** Specifies gauge range container options. */ - rangeContainer?: LinearRangeContainer; - scale?: LinearScale; - } - /** A widget that represents a gauge with a linear scale. */ - export class dxLinearGauge extends dxBaseGauge { - constructor(element: JQuery, options?: dxLinearGaugeOptions); - constructor(element: Element, options?: dxLinearGaugeOptions); - } - export interface CircularRangeContainer extends BaseRangeContainer { - /** Specifies the orientation of the range container in the dxCircularGauge widget. */ - orientation?: string; - /** Specifies the range container's width in pixels. */ - width?: number; - } - export interface CircularScaleLabel extends BaseScaleLabel { - /** Specifies the spacing between scale labels and ticks. */ - indentFromTick?: number; - } - export interface CircularScale extends BaseScale { - label?: CircularScaleLabel; - /** Specifies the orientation of scale ticks. */ - orientation?: string; - } - export interface dxCircularGaugeOptions extends BaseGaugeOptions { - /** Specifies the options required to set the geometry of the dxCircularGauge widget. */ - geometry?: { - /** Specifies the end angle of the circular gauge's arc. */ - endAngle?: number; - /** Specifies the start angle of the circular gauge's arc. */ - startAngle?: number; - }; - /** Specifies gauge range container options. */ - rangeContainer?: CircularRangeContainer; - scale?: CircularScale; - } - /** A widget that represents a gauge with a circular scale. */ - export class dxCircularGauge extends dxBaseGauge { - constructor(element: JQuery, options?: dxCircularGaugeOptions); - constructor(element: Element, options?: dxCircularGaugeOptions); - } - export interface dxBarGaugeOptions extends viz.core.BaseWidgetOptions, SharedGaugeOptions { - /** Specifies a color for the remaining segment of the bar's track. */ - backgroundColor?: string; - /** Specifies a distance between bars in pixels. */ - barSpacing?: number; - /** Specifies a base value for bars. */ - baseValue?: number; - /** Specifies an end value for the gauge's invisible scale. */ - endValue?: number; - /** Defines the shape of the gauge's arc. */ - geometry?: { - /** Specifies the end angle of the bar gauge's arc. */ - endAngle?: number; - /** Specifies the start angle of the bar gauge's arc. */ - startAngle?: number; - }; - /** Specifies the options of the labels that accompany gauge bars. */ - label?: { - /** Specifies a color for the label connector text. */ - connectorColor?: string; - /** Specifies the width of the label connector in pixels. */ - connectorWidth?: number; - /** Specifies a callback function that returns a text for labels. */ - customizeText?: (barValue: { value: number; valueText: string }) => string; - /** Specifies font options for bar labels. */ - font?: viz.core.Font; - /** Specifies a format for bar labels. */ - format?: string; - /** Specifies the distance between the upper bar and bar labels in pixels. */ - indent?: number; - /** Specifies a precision for the formatted value displayed by labels. */ - precision?: number; - /** Specifies whether bar labels appear on a gauge or not. */ - visible?: boolean; - }; - /** Sets the name of the palette or an array of colors to be used for coloring the gauge range container. */ - palette?: string; - /** Defines the radius of the bar that is closest to the center relatively to the radius of the topmost bar. */ - relativeInnerRadius?: number; - /** Specifies a start value for the gauge's invisible scale. */ - startValue?: number; - /** Specifies the array of values to be indicated on a bar gauge. */ - values?: Array; - } - /** A circular bar widget. */ - export class dxBarGauge extends viz.core.BaseWidget { - constructor(element: JQuery, options?: dxBarGaugeOptions); - constructor(element: Element, options?: dxBarGaugeOptions); - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws the widget. */ - render(): void; - /** Returns an array of gauge values. */ - values(): Array; - /** Updates the values displayed by a gauge. */ - values(values: Array): void; - } -} -interface JQuery { - dxLinearGauge(options?: DevExpress.viz.gauges.dxLinearGaugeOptions): JQuery; - dxLinearGauge(methodName: string, ...params: any[]): any; - dxLinearGauge(methodName: "instance"): DevExpress.viz.gauges.dxLinearGauge; - dxCircularGauge(options?: DevExpress.viz.gauges.dxCircularGaugeOptions): JQuery; - dxCircularGauge(methodName: string, ...params: any[]): any; - dxCircularGauge(methodName: "instance"): DevExpress.viz.gauges.dxCircularGauge; - dxBarGauge(options?: DevExpress.viz.gauges.dxBarGaugeOptions): JQuery; - dxBarGauge(methodName: string, ...params: any[]): any; - dxBarGauge(methodName: "instance"): DevExpress.viz.gauges.dxBarGauge; -} -declare namespace DevExpress.viz.rangeSelector { - export interface dxRangeSelectorOptions extends viz.core.BaseWidgetOptions { - /** Specifies the options for the range selector's background. */ - background?: { - /** Specifies the background color for the dxRangeSelector. */ - color?: string; - /** Specifies image options. */ - image?: { - /** Specifies a location for the image in the background of a range selector. */ - location?: string; - /** Specifies the image's URL. */ - url?: string; - }; - /** Indicates whether or not the background (background color and/or image) is visible. */ - visible?: boolean; - }; - /** Specifies a title for the range selector. */ - title?: viz.core.Title; - /** Specifies the dxRangeSelector's behavior options. */ - behavior?: { - /** Indicates whether or not you can swap sliders. */ - allowSlidersSwap?: boolean; - /** Indicates whether or not animation is enabled. */ - animationEnabled?: boolean; - /** Specifies when to call the onSelectedRangeChanged function. */ - callSelectedRangeChanged?: string; - /** Indicates whether or not an end user can specify the range using a mouse, without the use of sliders. */ - manualRangeSelectionEnabled?: boolean; - /** Indicates whether or not an end user can shift the selected range to the required location on a scale by clicking. */ - moveSelectedRangeByClick?: boolean; - /** Indicates whether to snap a slider to ticks. */ - snapToTicks?: boolean; - }; - /** Specifies the options required to display a chart as the range selector's background. */ - chart?: { - /** Specifies a coefficient for determining an indent from the bottom background boundary to the lowest chart point. */ - bottomIndent?: number; - /** An object defining the common configuration options for the chart’s series. */ - commonSeriesSettings?: viz.charts.CommonSeriesSettings; - /** An object providing options for managing data from a data source. */ - dataPrepareSettings?: { - /** Specifies whether or not to validate values from a data source. */ - checkTypeForAllData?: boolean; - /** Specifies whether or not to convert the values from a data source into the data type of an axis. */ - convertToAxisDataType?: boolean; - /** Specifies how to sort series points. */ - sortingMethod?: any; - }; - /** Specifies whether all bars in a series must have the same width, or may have different widths if any points in other series are missing. */ - equalBarWidth?: boolean; - /** Specifies a common bar width as a percentage from 0 to 1. */ - barWidth?: number; - /** Sets the name of the palette to be used in the range selector's chart. Alternatively, an array of colors can be set as a custom palette to be used within this chart. */ - palette?: any; - /** An object defining the chart’s series. */ - series?: Array; - /** Defines options for the series template. */ - seriesTemplate?: viz.charts.SeriesTemplate; - /** Specifies a coefficient for determining an indent from the background's top boundary to the topmost chart point. */ - topIndent?: number; - /** Specifies whether or not to filter the series points depending on their quantity. */ - useAggregation?: boolean; - /** Specifies options for the chart's value axis. */ - valueAxis?: { - /** Indicates whether or not the chart's value axis must be inverted. */ - inverted?: boolean; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic value axis. */ - logarithmBase?: number; - /** Specifies the maximum value of the chart's value axis. */ - max?: number; - /** Specifies the minimum value of the chart's value axis. */ - min?: number; - /** Specifies the type of the value axis. */ - type?: string; - /** Specifies the desired type of axis values. */ - valueType?: string; - }; - }; - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** Specifies a data source for the scale values and for the chart at the background. */ - dataSource?: any; - /** Specifies the data source field that provides data for the scale. */ - dataSourceField?: string; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies the blank space in pixels between the dxRangeSelector widget's extreme elements and the boundaries of the area provided for the widget (see size). */ - margin?: viz.core.Margins; - /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */ - redrawOnResize?: boolean; - /** Specifies options of the range selector's scale. */ - scale?: { - /** Specifies the scale's end value. */ - endValue?: any; - /** Specifies common options for scale labels. */ - label?: { - /** Specifies a callback function that returns the text to be displayed in scale labels. */ - customizeText?: (scaleValue: { value: any; valueText: string; }) => string; - /** Specifies font options for the text displayed in the range selector's scale labels. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in scale labels. */ - format?: string; - /** Specifies a precision for the formatted value displayed in the scale labels. */ - precision?: number; - /** Specifies a spacing between scale labels and the background bottom edge. */ - topIndent?: number; - /** Specifies whether or not the scale's labels are visible. */ - visible?: boolean; - }; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic scale. */ - logarithmBase?: number; - /** - * Specifies an interval between major ticks. - * @deprecated ..\tickInterval\tickInterval.md - */ - majorTickInterval?: any; - /** Specifies an interval between axis ticks. */ - tickInterval?: any; - /** Specifies options for the date-time scale's markers. */ - marker?: { - /** Defines the options that can be set for the text that is displayed by the scale markers. */ - label?: { - /** Specifies a callback function that returns the text to be displayed in scale markers. */ - customizeText?: (markerValue: { value: any; valueText: string }) => string; - /** Specifies a format for the text displayed in scale markers. */ - format?: string; - }; - /** Specifies the height of the marker's separator. */ - separatorHeight?: number; - /** Specifies the space between the marker label and the marker separator. */ - textLeftIndent?: number; - /** Specifies the space between the marker's label and the top edge of the marker's separator. */ - textTopIndent?: number; - /** Specified the indent between the marker and the scale lables. */ - topIndent?: number; - /** Indicates whether scale markers are visible. */ - visible?: boolean; - }; - /** Specifies the maximum range that can be selected. */ - maxRange?: any; - /** Specifies the number of minor ticks between neighboring major ticks. */ - minorTickCount?: number; - /** Specifies an interval between minor ticks. */ - minorTickInterval?: any; - /** Specifies the minimum range that can be selected. */ - minRange?: any; - /** Specifies the height of the space reserved for the scale in pixels. */ - placeholderHeight?: number; - /** Indicates whether or not to set ticks of a date-time scale at the beginning of each date-time interval. */ - setTicksAtUnitBeginning?: boolean; - /** Specifies whether or not to show ticks for the boundary scale values, when neither major ticks nor minor ticks are created for these values. */ - showCustomBoundaryTicks?: boolean; - /** - * Indicates whether or not to show minor ticks on the scale. - * @deprecated minorTick\visible.md - */ - showMinorTicks?: boolean; - /** Specifies the scale's start value. */ - startValue?: any; - /** Specifies options defining the appearance of scale ticks. */ - tick?: { - /** Specifies the color of scale ticks (both major and minor ticks). */ - color?: string; - /** Specifies the opacity of scale ticks (both major and minor ticks). */ - opacity?: number; - /** Specifies the width of the scale's ticks (both major and minor ticks). */ - width?: number; - }; - /** Specifies options of the range selector's minor ticks. */ - minorTick?: { - /** Specifies the color of the scale's minor ticks. */ - color?: string; - /** Specifies the opacity of the scale's minor ticks. */ - opacity?: number; - /** Specifies the width of the scale's minor ticks. */ - width?: number; - /** Indicates whether scale minor ticks are visible or not. */ - visible?: boolean; - }; - /** Specifies the type of the scale. */ - type?: string; - /** Specifies whether or not to expand the current tick interval if labels overlap each other. */ - useTicksAutoArrangement?: boolean; - /** Specifies the type of values on the scale. */ - valueType?: string; - /** Specifies the order of arguments on a discrete scale. */ - categories?: Array; - }; - /** Specifies the range to be selected when displaying the dxRangeSelector. */ - selectedRange?: { - /** Specifies the start value of the range to be selected when displaying the dxRangeSelector widget on a page. */ - startValue?: any; - /** Specifies the end value of the range to be selected when displaying the dxRangeSelector widget on a page. */ - endValue?: any; - }; - /** Specifies the color of the selected range. */ - selectedRangeColor?: string; - /** Range selector's indent options. */ - indent?: { - /** Specifies range selector's left indent. */ - left?: number; - /** Specifies range selector's right indent. */ - right?: number; - }; - /** A handler for the selectedRangeChanged event. */ - onSelectedRangeChanged?: (e: { - startValue: any; - endValue: any; - component: dxRangeSelector; - element: Element; - }) => void; - /** Specifies range selector shutter options. */ - shutter?: { - /** Specifies shutter color. */ - color?: string; - /** Specifies the opacity of the color of shutters. */ - opacity?: number; - }; - /** Specifies in pixels the size of the dxRangeSelector widget. */ - size?: viz.core.Size; - /** Specifies the appearance of the range selector's slider handles. */ - sliderHandle?: { - /** Specifies the color of the slider handles. */ - color?: string; - /** Specifies the opacity of the slider handles. */ - opacity?: number; - /** Specifies the width of the slider handles. */ - width?: number; - }; - /** Defines the options of the range selector slider markers. */ - sliderMarker?: { - /** Specifies the color of the slider markers. */ - color?: string; - /** Specifies a callback function that returns the text to be displayed by slider markers. */ - customizeText?: (scaleValue: { value: any; valueText: any; }) => string; - /** Specifies font options for the text displayed by the range selector slider markers. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in slider markers. */ - format?: string; - /** Specifies the color used for the slider marker text when the currently selected range does not match the minRange and maxRange values. */ - invalidRangeColor?: string; - /** - * Specifies the empty space between the marker's border and the marker’s text. - * @deprecated Use the 'paddingTopBottom' and 'paddingLeftRight' options instead - */ - padding?: number; - /** Specifies the empty space between the marker's top and bottom borders and the marker's text. */ - paddingTopBottom?: number; - /** Specifies the empty space between the marker's left and right borders and the marker's text. */ - paddingLeftRight?: number; - /** Specifies the placeholder height of the slider marker. */ - placeholderHeight?: number; - /** - * Specifies in pixels the height and width of the space reserved for the range selector slider markers. - * @deprecated Use the 'placeholderHeight' and 'indent' options instead - */ - placeholderSize?: { - /** Specifies the height of the placeholder for the left and right slider markers. */ - height?: number; - /** Specifies the width of the placeholder for the left and right slider markers. */ - width?: { - /** Specifies the width of the left slider marker's placeholder. */ - left?: number; - /** Specifies the width of the right slider marker's placeholder. */ - right?: number; - }; - }; - /** Specifies a precision for the formatted value displayed in slider markers. */ - precision?: number; - /** Indicates whether or not the slider markers are visible. */ - visible?: boolean; - }; - } - /** A widget that allows end users to select a range of values on a scale. */ - export class dxRangeSelector extends viz.core.BaseWidget { - constructor(element: JQuery, options?: dxRangeSelectorOptions); - constructor(element: Element, options?: dxRangeSelectorOptions); - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(skipChartAnimation?: boolean): void; - /** Returns the currently selected range. */ - getSelectedRange(): { startValue: any; endValue: any; }; - /** Sets a specified range. */ - setSelectedRange(selectedRange: { startValue: any; endValue: any; }): void; - } -} -interface JQuery { - dxRangeSelector(options?: DevExpress.viz.rangeSelector.dxRangeSelectorOptions): JQuery; - dxRangeSelector(methodName: string, ...params: any[]): any; - dxRangeSelector(methodName: "instance"): DevExpress.viz.rangeSelector.dxRangeSelector; -} -declare namespace DevExpress.viz.map { - /** This section describes the fields and methods that can be used in code to manipulate the Layer object. */ - export interface MapLayer { - /** The name of the layer. */ - name: string; - /** The layer index in the layers array. */ - index: number; - /** The layer type. Can be "area", "line" or "marker". */ - type: string; - /** The type of the layer elements. */ - elementType: string; - /** Gets all layer elements. */ - getElements(): Array; - /** Deselects all layer elements. */ - clearSelection(): void; - } - /** This section describes the fields and methods that can be used in code to manipulate the Layer Element object. */ - export interface MapLayerElement { - /** The parent layer of the layer element. */ - layer: MapLayer; - /** Gets the layer element coordinates. */ - coordinates(): Object; - /** Sets the value of an attribute. */ - attribute(name: string, value: any): void; - /** Gets the value of an attribute. */ - attribute(name: string): any; - /** Gets the selection state of the layer element. */ - selected(): boolean; - /** Sets the selection state of the layer element. */ - selected(state: boolean): void; - /** Applies the layer element settings and updates element appearance. */ - applySettings(settings: any): void; - } - /** - * This section describes the fields and methods that can be used in code to manipulate the Area object. - * @deprecated Use the "Layer Element" instead - */ - export interface Area { - /** - * Contains the element type. - * @deprecated ..\..\Layer\2 Fields\type.md - */ - type: string; - /** - * Return the value of an attribute. - * @deprecated ..\..\Layer Element\3 Methods\attribute(name_value).md - */ - attribute(name: string): any; - /** - * Provides information about the selection state of an area. - * @deprecated Use the "selected()" method of the Layer Element - */ - selected(): boolean; - /** - * Sets a new selection state for an area. - * @deprecated Use the "selected(state)" method of the Layer Element - */ - selected(state: boolean): void; - /** - * Applies the area settings specified as a parameter and updates the area appearance. - * @deprecated ..\..\Layer Element\3 Methods\applySettings(settings).md - */ - applySettings(settings: any): void; - } - /** - * This section describes the fields and methods that can be used in code to manipulate the Markers object. - * @deprecated Use the "Layer Element" instead - */ - export interface Marker { - /** - * Contains the descriptive text accompanying the map marker. - * @deprecated Get the text with the "attribute" method (using the "layers.label.dataField" value) - */ - text: string; - /** - * Contains the type of the element. - * @deprecated ..\..\Layer\2 Fields\type.md - */ - type: string; - /** - * Contains the URL of an image map marker. - * @deprecated Get the url with the "attribute" method (using the "layers.dataField" value) - */ - url: string; - /** - * Contains the value of a bubble map marker. - * @deprecated Get the value with the "attribute" method (using the "layers.dataField" value) - */ - value: number; - /** - * Contains the values of a pie map marker. - * @deprecated Get the values with the "attribute" method (using the "layers.dataField" value) - */ - values: Array; - /** - * Returns the value of an attribute. - * @deprecated ..\..\Layer Element\3 Methods\attribute(name_value).md - */ - attribute(name: string): any; - /** - * Returns the coordinates of a specific marker. - * @deprecated ..\..\Layer Element\3 Methods\coordinates().md - */ - coordinates(): Array; - /** - * Provides information about the selection state of a marker. - * @deprecated Use the "selected()" method of the Layer Element - */ - selected(): boolean; - /** - * Sets a new selection state for a marker. - * @deprecated Use the "selected(state)" method of the Layer Element - */ - selected(state: boolean): void; - /** - * Applies the marker settings specified as a parameter and updates marker appearance. - * @deprecated ..\..\Layer Element\3 Methods\applySettings(settings).md - */ - applySettings(settings: any): void; - } - export interface MapLayerSettings { - /** Specifies the layer name. */ - name?: string; - /** Specifies layer type. */ - type?: string; - /** Specifies the type of a marker element. Setting this option makes sense only if the layer type is "marker". */ - elementType?: string; - /** Specifies a data source for the layer. */ - data?: any; - /** Specifies the line width (for layers of a line type) or width of the layer elements border in pixels. */ - borderWidth?: number; - /** Specifies a color for the border of the layer elements. */ - borderColor?: string; - /** Specifies a color for layer elements. */ - color?: string; - /** Specifies a color for the border of the layer element when it is hovered over. */ - hoveredBorderColor?: string; - /** Specifies the pixel-measured line width (for layers of a line type) or width for the border of the layer element when it is hovered over. */ - hoveredBorderWidth?: number; - /** Specifies a color for a layer element when it is hovered over. */ - hoveredColor?: string; - /** Specifies a pixel-measured line width (for layers of a line type) or width for the border of the layer element when it is selected. */ - selectedBorderWidth?: number; - /** Specifies a color for the border of the layer element when it is selected. */ - selectedBorderColor?: string; - /** Specifies a color for the layer element when it is selected. */ - selectedColor?: string; - /** Specifies the layer opacity (from 0 to 1). */ - opacity?: number; - /** Specifies the size of markers. Setting this option makes sense only if the layer type is "marker" and the elementType is "dot", "pie" or "image". */ - size?: number; - /** Specifies the pixel-measured diameter of the marker that represents the smallest value. Setting this option makes sense only if the layer type is "marker". */ - minSize?: number; - /** Specifies the pixel-measured diameter of the marker that represents the biggest value. Setting this option makes sense only if the layer type is "marker". */ - maxSize?: number; - /** Specifies whether or not to change the appearance of a layer element when it is hovered over. */ - hoverEnabled?: boolean; - /** Specifies whether single or multiple map elements can be selected on a vector map. */ - selectionMode?: string; - /** Specifies the name of the palette or a custom range of colors to be used for coloring a layer. */ - palette?: any; - /** Specifies the number of colors in a palette. */ - paletteSize?: number; - /** Allows you to paint layer elements with similar attributes in the same color. */ - colorGroups?: Array; - /** Specifies the field that provides data to be used for coloring of layer elements. */ - colorGroupingField?: string; - /** Allows you to display bubbles with similar attributes in the same size. Setting this option makes sense only if the layer type is "marker" and the elementType is "bubble". */ - sizeGroups?: Array; - /** Specifies the field that provides data to be used for sizing bubble markers. Setting this option makes sense only if the layer type is "marker" and the elementType is "bubble". */ - sizeGroupingField?: string; - /** Specifies the name of the attribute containing marker data. Setting this option makes sense only if the layer type is "marker" and the elementType is "bubble", "pie" or "image". */ - dataField?: string; - /** Specifies the function that customizes each layer element individually. */ - customize?: (eleemnts: Array) => void; - /** Specifies marker label options. */ - label?: { - /** The name of the data attribute containing marker texts. */ - dataField?: string; - /** Enables marker labels. */ - enabled?: boolean; - /** Specifies font options for marker labels. */ - font?: viz.core.Font; - }; - } - export interface AreaSettings { - /** - * Specifies the width of the area border in pixels. - * @deprecated ..\layers\borderWidth.md - */ - borderWidth?: number; - /** - * Specifies a color for the area border. - * @deprecated ..\layers\borderColor.md - */ - borderColor?: string; - /** - * Specifies a color for an area. - * @deprecated ..\layers\color.md - */ - color?: string; - /** - * Specifies the function that customizes each area individually. - * @deprecated ..\layers\customize.md - */ - customize?: (areaInfo: Area) => AreaSettings; - /** - * Specifies a color for the area border when the area is hovered over. - * @deprecated ..\layers\hoveredBorderColor.md - */ - hoveredBorderColor?: string; - /** - * Specifies the pixel-measured width of the area border when the area is hovered over. - * @deprecated ..\layers\hoveredBorderWidth.md - */ - hoveredBorderWidth?: number; - /** - * Specifies a color for an area when this area is hovered over. - * @deprecated ..\layers\hoveredColor.md - */ - hoveredColor?: string; - /** - * Specifies whether or not to change the appearance of an area when it is hovered over. - * @deprecated ..\layers\hoverEnabled.md - */ - hoverEnabled?: boolean; - /** - * Configures area labels. - * @deprecated ..\..\layers\label\label.md - */ - label?: { - /** - * Specifies the data field that provides data for area labels. - * @deprecated ..\..\layers\label\dataField.md - */ - dataField?: string; - /** - * Enables area labels. - * @deprecated ..\..\layers\label\enabled.md - */ - enabled?: boolean; - /** - * Specifies font options for area labels. - * @deprecated ..\..\..\layers\label\font\font.md - */ - font?: viz.core.Font; - }; - /** - * Specifies the name of the palette or a custom range of colors to be used for coloring a map. - * @deprecated ..\layers\palette.md - */ - palette?: any; - /** - * Specifies the number of colors in a palette. - * @deprecated ..\layers\paletteSize.md - */ - paletteSize?: number; - /** - * Allows you to paint areas with similar attributes in the same color. - * @deprecated ..\layers\colorGroups.md - */ - colorGroups?: Array; - /** - * Specifies the field that provides data to be used for coloring areas. - * @deprecated ..\layers\colorGroupingField.md - */ - colorGroupingField?: string; - /** - * Specifies a color for the area border when the area is selected. - * @deprecated ..\layers\selectedBorderColor.md - */ - selectedBorderColor?: string; - /** - * Specifies a color for an area when this area is selected. - * @deprecated ..\layers\selectedColor.md - */ - selectedColor?: string; - /** - * Specifies the pixel-measured width of the area border when the area is selected. - * @deprecated ..\layers\selectedBorderWidth.md - */ - selectedBorderWidth?: number; - /** - * Specifies whether single or multiple areas can be selected on a vector map. - * @deprecated ..\layers\selectionMode.md - */ - selectionMode?: string; - } - export interface MarkerSettings { - /** - * Specifies a color for the marker border. - * @deprecated ..\layers\borderColor.md - */ - borderColor?: string; - /** - * Specifies the width of the marker border in pixels. - * @deprecated ..\layers\borderWidth.md - */ - borderWidth?: number; - /** - * Specifies a color for a marker of the dot or bubble type. - * @deprecated ..\layers\color.md - */ - color?: string; - /** - * Specifies the function that customizes each marker individually. - * @deprecated ..\layers\customize.md - */ - customize?: (markerInfo: Marker) => MarkerSettings; - /** - * Specifies the pixel-measured width of the marker border when the marker is hovered over. - * @deprecated ..\layers\hoveredBorderWidth.md - */ - hoveredBorderWidth?: number; - /** - * Specifies a color for the marker border when the marker is hovered over. - * @deprecated ..\layers\hoveredBorderColor.md - */ - hoveredBorderColor?: string; - /** - * Specifies a color for a marker of the dot or bubble type when this marker is hovered over. - * @deprecated ..\layers\hoveredColor.md - */ - hoveredColor?: string; - /** - * Specifies whether or not to change the appearance of a marker when it is hovered over. - * @deprecated ..\layers\hoverEnabled.md - */ - hoverEnabled?: boolean; - /** - * Specifies marker label options. - * @deprecated ..\..\layers\label\label.md - */ - label?: { - /** - * Enables marker labels. - * @deprecated ..\..\layers\label\enabled.md - */ - enabled?: boolean; - /** - * Specifies font options for marker labels. - * @deprecated ..\..\..\layers\label\font\font.md - */ - font?: viz.core.Font; - }; - /** - * Specifies the pixel-measured diameter of the marker that represents the biggest value. Setting this option makes sense only if you use markers of the bubble type. - * @deprecated ..\layers\maxSize.md - */ - maxSize?: number; - /** - * Specifies the pixel-measured diameter of the marker that represents the smallest value. Setting this option makes sense only if you use markers of the bubble type. - * @deprecated ..\layers\minSize.md - */ - minSize?: number; - /** - * Specifies the opacity of markers. Setting this option makes sense only if you use markers of the bubble type. - * @deprecated ..\layers\opacity.md - */ - opacity?: number; - /** - * Specifies the pixel-measured width of the marker border when the marker is selected. - * @deprecated ..\layers\selectedBorderWidth.md - */ - selectedBorderWidth?: number; - /** - * Specifies a color for the marker border when the marker is selected. - * @deprecated ..\layers\selectedBorderColor.md - */ - selectedBorderColor?: string; - /** - * Specifies a color for a marker of the dot or bubble type when this marker is selected. - * @deprecated ..\layers\selectedColor.md - */ - selectedColor?: string; - /** - * Specifies whether a single or multiple markers can be selected on a vector map. - * @deprecated ..\layers\selectionMode.md - */ - selectionMode?: string; - /** - * Specifies the size of markers. Setting this option makes sense for any type of marker except bubble. - * @deprecated ..\layers\size.md - */ - size?: number; - /** - * Specifies the type of markers to be used on the map. - * @deprecated ..\layers\elementType.md - */ - type?: string; - /** - * Specifies the name of a palette or a custom set of colors to be used for coloring markers of the pie type. - * @deprecated ..\layers\palette.md - */ - palette?: any; - /** - * Allows you to paint markers with similar attributes in the same color. - * @deprecated ..\layers\colorGroups.md - */ - colorGroups?: Array; - /** - * Specifies the field that provides data to be used for coloring markers. - * @deprecated ..\layers\colorGroupingField.md - */ - colorGroupingField?: string; - /** - * Allows you to display bubbles with similar attributes in the same size. - * @deprecated ..\layers\sizeGroups.md - */ - sizeGroups?: Array; - /** - * Specifies the field that provides data to be used for sizing bubble markers. - * @deprecated ..\layers\sizeGroupingField.md - */ - sizeGroupingField?: string; - } - export interface dxVectorMapOptions extends viz.core.BaseWidgetOptions { - /** - * An object specifying options for the map areas. - * @deprecated Use the 'layers' option instead - */ - areaSettings?: AreaSettings; - /** Specifies the options for the map background. */ - background?: { - /** Specifies a color for the background border. */ - borderColor?: string; - /** Specifies a color for the background. */ - color?: string; - }; - /** Specifies options for dxVectorMap widget layers. */ - layers?: Array; - /** Specifies the map projection. */ - projection?: Object; - /** Specifies the positioning of a map in geographical coordinates. */ - bounds?: Array; - /** Specifies the options of the control bar. */ - controlBar?: { - /** Specifies a color for the outline of the control bar elements. */ - borderColor?: string; - /** Specifies a color for the inner area of the control bar elements. */ - color?: string; - /** Specifies whether or not to display the control bar. */ - enabled?: boolean; - /** Specifies the margin of the control bar in pixels. */ - margin?: number; - /** Specifies the position of the control bar. */ - horizontalAlignment?: string; - /** Specifies the position of the control bar. */ - verticalAlignment?: string; - /** Specifies the opacity of the Control_Bar. */ - opacity?: number; - }; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** - * Specifies a data source for the map area. - * @deprecated Use the 'layers.data' option instead - */ - mapData?: any; - /** - * Specifies a data source for the map markers. - * @deprecated Use the 'layers.data' option instead - */ - markers?: any; - /** - * An object specifying options for the map markers. - * @deprecated Use the 'layers' option instead - */ - markerSettings?: MarkerSettings; - /** Specifies the size of the dxVectorMap widget. */ - size?: viz.core.Size; - /** Specifies a title for the vector map. */ - title?: viz.core.Title; - /** Specifies tooltip options. */ - tooltip?: viz.core.Tooltip; - /** Configures map legends. */ - legends?: Array; - /** Specifies whether or not the map should respond when a user rolls the mouse wheel. */ - wheelEnabled?: boolean; - /** Specifies whether the map should respond to touch gestures. */ - touchEnabled?: boolean; - /** Disables the zooming capability. */ - zoomingEnabled?: boolean; - /** Specifies the geographical coordinates of the center for a map. */ - center?: Array; - /** A handler for the centerChanged event. */ - onCenterChanged?: (e: { - center: Array; - component: dxVectorMap; - element: Element; - }) => void; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: dxVectorMap; - element: Element; - target: {}; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: dxVectorMap; - element: Element; - target: {}; - }) => void; - /** Specifies a number that is used to zoom a map initially. */ - zoomFactor?: number; - /** Specifies a map's maximum zoom factor. */ - maxZoomFactor?: number; - /** A handler for the zoomFactorChanged event. */ - onZoomFactorChanged?: (e: { - component: dxVectorMap; - element: Element; - zoomFactor: number; - }) => void; - /** A handler for the click event. */ - onClick?: any; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: (e: { - component: dxVectorMap; - element: Element; - target: MapLayerElement; - }) => void; - /** - * A handler for the areaClick event. - * @deprecated Use the 'onClick' option instead - */ - onAreaClick?: any; - /** - * A handler for the areaSelectionChanged event. - * @deprecated Use the 'onSelectionChanged' option instead - */ - onAreaSelectionChanged?: (e: { - target: Area; - component: dxVectorMap; - element: Element; - }) => void; - /** - * A handler for the markerClick event. - * @deprecated Use the 'onClick' option instead - */ - onMarkerClick?: any; - /** - * A handler for the markerSelectionChanged event. - * @deprecated Use the 'onSelecitonChanged' option instead - */ - onMarkerSelectionChanged?: (e: { - target: Marker; - component: dxVectorMap; - element: Element; - }) => void; - /** Disables the panning capability. */ - panningEnabled?: boolean; - } - export interface Legend extends viz.core.BaseLegend { - /** Specifies the color of item markers in the legend. The specified color applied only when the legend uses 'size' source. */ - markerColor?: string; - /** Specifies text for legend items. */ - customizeText?: (itemInfo: { start: number; end: number; index: number; color: string; size: number; }) => string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the text of a legend item. */ - customizeHint?: (itemInfo: { start: number; end: number; index: number; color: string; size: number }) => string; - /** Specifies the source of data for the legend. */ - source?: { - /** Specifies a layer to which the legend belongs. */ - layer?: string; - /** Specifies the type of the legend grouping. */ - grouping?: string; - } - } - /** A vector map widget. */ - export class dxVectorMap extends viz.core.BaseWidget { - constructor(element: JQuery, options?: dxVectorMapOptions); - constructor(element: Element, options?: dxVectorMapOptions); - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(): void; - /** Gets the current coordinates of the map center. */ - center(): Array; - /** Sets the coordinates of the map center. */ - center(centerCoordinates: Array): void; - /** - * Deselects all the selected areas on a map. The areas are displayed in their initial style after. - * @deprecated Use the 'clearSelection' method on a layer instead - */ - clearAreaSelection(): void; - /** - * Deselects all the selected markers on a map. The markers are displayed in their initial style after. - * @deprecated Use the 'clearSelection' method on a layer instead - */ - clearMarkerSelection(): void; - /** Deselects all the selected area and markers on a map at once. The areas and markers are displayed in their initial style after. */ - clearSelection(): void; - /** Converts client area coordinates into map coordinates. */ - convertCoordinates(x: number, y: number): Array; - /** Gets all map layers. */ - getLayers(): Array; - /** Gets the layer by its index. */ - getLayerByIndex(index: number): MapLayer; - /** Gets the layer by its name. */ - getLayerByName(name: string): MapLayer; - /** - * Returns an array with all the map areas. - * @deprecated Use the 'getElements' method on a layer instead - */ - getAreas(): Array; - /** - * Returns an array with all the map markers. - * @deprecated Use the 'getElements' method on a layer instead - */ - getMarkers(): Array; - /** Gets the current coordinates of the map viewport. */ - viewport(): Array; - /** Sets the coordinates of the map viewport. */ - viewport(viewportCoordinates: Array): void; - /** Gets the current value of the map zoom factor. */ - zoomFactor(): number; - /** Sets the value of the map zoom factor. */ - zoomFactor(zoomFactor: number): void; - } - export var projection: ProjectionCreator; - export interface ProjectionCreator { - /** Creates a new projection. */ - (data: { - to?: (coordinates: Array) => Array; - from?: (coordinates: Array) => Array; - aspectRatio?: number; - }): Object; - /** Gets the default or custom projection from the projection storage. */ - get(name: string): Object; - /** Adds a new projection to the internal projections storage. */ - add(name: string, projection: Object): void; - } -} -interface JQuery { - dxVectorMap(options?: DevExpress.viz.map.dxVectorMapOptions): JQuery; - dxVectorMap(methodName: string, ...params: any[]): any; - dxVectorMap(methodName: "instance"): DevExpress.viz.map.dxVectorMap; -} -declare namespace DevExpress.viz.sparklines { - export interface SparklineTooltip extends viz.core.Tooltip { - /** - * Specifies how a tooltip is horizontally aligned relative to the graph. - * @deprecated Tooltip alignment is no more available. - */ - horizontalAlignment?: string; - /** - * Specifies how a tooltip is vertically aligned relative to the graph. - * @deprecated Tooltip alignment is no more available. - */ - verticalAlignment?: string; - } - export interface BaseSparklineOptions extends viz.core.BaseWidgetOptions { - /** Specifies the blank space between the widget's extreme elements and the boundaries of the area provided for the widget in pixels. */ - margin?: viz.core.Margins; - /** Specifies the size of the widget. */ - size?: viz.core.Size; - /** Specifies tooltip options. */ - tooltip?: SparklineTooltip; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: BaseSparkline; - element: Element; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: BaseSparkline; - element: Element; - }) => void; - } - /** Overridden by descriptions for particular widgets. */ - export class BaseSparkline extends viz.core.BaseWidget { - /** Redraws a widget. */ - render(): void; - } - export interface dxBulletOptions extends BaseSparkline { - /** Specifies a color for the bullet bar. */ - color?: string; - /** Specifies an end value for the invisible scale. */ - endScaleValue?: number; - /** Specifies whether or not to show the target line. */ - showTarget?: boolean; - /** Specifies whether or not to show the line indicating zero on the invisible scale. */ - showZeroLevel?: boolean; - /** Specifies a start value for the invisible scale. */ - startScaleValue?: number; - /** Specifies the value indicated by the target line. */ - target?: number; - /** Specifies a color for both the target and zero level lines. */ - targetColor?: string; - /** Specifies the width of the target line. */ - targetWidth?: number; - /** Specifies the primary value indicated by the bullet bar. */ - value?: number; - } - /** A bullet graph widget. */ - export class dxBullet extends BaseSparkline { - constructor(element: JQuery, options?: dxBulletOptions); - constructor(element: Element, options?: dxBulletOptions); - } - export interface dxSparklineOptions extends BaseSparklineOptions { - /** Specifies the data source field that provides arguments for a sparkline. */ - argumentField?: string; - /** Sets a color for the bars indicating negative values. Available for a sparkline of the bar type only. */ - barNegativeColor?: string; - /** Sets a color for the bars indicating positive values. Available for a sparkline of the bar type only. */ - barPositiveColor?: string; - /** Specifies a data source for the sparkline. */ - dataSource?: Array; - /** Sets a color for the boundary of both the first and last points on a sparkline. */ - firstLastColor?: string; - /** Specifies whether a sparkline ignores null data points or not. */ - ignoreEmptyPoints?: boolean; - /** Sets a color for a line on a sparkline. Available for the sparklines of the line- and area-like types. */ - lineColor?: string; - /** Specifies a width for a line on a sparkline. Available for the sparklines of the line- and area-like types. */ - lineWidth?: number; - /** Sets a color for the bars indicating the values that are less than the winloss threshold. Available for a sparkline of the winloss type only. */ - lossColor?: string; - /** Sets a color for the boundary of the maximum point on a sparkline. */ - maxColor?: string; - /** Sets a color for the boundary of the minimum point on a sparkline. */ - minColor?: string; - /** Sets a color for points on a sparkline. Available for the sparklines of the line- and area-like types. */ - pointColor?: string; - /** Specifies the diameter of sparkline points in pixels. Available for the sparklines of line- and area-like types. */ - pointSize?: number; - /** Specifies a symbol to use as a point marker on a sparkline. Available for the sparklines of the line- and area-like types. */ - pointSymbol?: string; - /** Specifies whether or not to indicate both the first and last values on a sparkline. */ - showFirstLast?: boolean; - /** Specifies whether or not to indicate both the minimum and maximum values on a sparkline. */ - showMinMax?: boolean; - /** Determines the type of a sparkline. */ - type?: string; - /** Specifies the data source field that provides values for a sparkline. */ - valueField?: string; - /** Sets a color for the bars indicating the values greater than a winloss threshold. Available for a sparkline of the winloss type only. */ - winColor?: string; - /** Specifies a value that serves as a threshold for the sparkline of the winloss type. */ - winlossThreshold?: number; - /** Specifies the minimum value of the sparkline value axis. */ - minValue?: number; - /** Specifies the maximum value of the sparkline's value axis. */ - maxValue?: number; - } - /** A sparkline widget. */ - export class dxSparkline extends BaseSparkline { - constructor(element: JQuery, options?: dxSparklineOptions); - constructor(element: Element, options?: dxSparklineOptions); - } -} -interface JQuery { - dxBullet(options?: DevExpress.viz.sparklines.dxBulletOptions): JQuery; - dxBullet(methodName: string, ...params: any[]): any; - dxBullet(methodName: "instance"): DevExpress.viz.sparklines.dxBullet; - dxSparkline(options?: DevExpress.viz.sparklines.dxSparklineOptions): JQuery; - dxSparkline(methodName: string, ...params: any[]): any; - dxSparkline(methodName: "instance"): DevExpress.viz.sparklines.dxSparkline; -} diff --git a/devextreme/devextreme-15.2.7.d.ts b/devextreme/devextreme-15.2.7.d.ts deleted file mode 100644 index d12d4f4751..0000000000 --- a/devextreme/devextreme-15.2.7.d.ts +++ /dev/null @@ -1,7429 +0,0 @@ -// Type definitions for DevExtreme 15.2.7 -// Project: http://js.devexpress.com/ -// Definitions by: DevExpress Inc. -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -/// - -declare namespace DevExpress { - /** A mixin that provides a capability to fire and subscribe to events. */ - export interface EventsMixin { - /** Subscribes to a specified event. */ - on(eventName: string, eventHandler: Function): T; - /** Subscribes to the specified events. */ - on(events: { [eventName: string]: Function; }): T; - /** Detaches all event handlers from the specified event. */ - off(eventName: string): Object; - /** Detaches a particular event handler from the specified event. */ - off(eventName: string, eventHandler: Function): T; - } - /** An object that serves as a namespace for the methods required to perform validation. */ - export module validationEngine { - export interface IValidator { - validate(): ValidatorValidationResult; - reset(): void; - } - export interface ValidatorValidationResult { - isValid: boolean; - name?: string; - value: any; - brokenRule: any; - validationRules: any[]; - } - export interface ValidationGroupValidationResult { - isValid: boolean; - brokenRules: any[]; - validators: IValidator[]; - } - export interface GroupConfig extends EventsMixin { - group: any; - validators: IValidator[]; - validate(): ValidationGroupValidationResult; - reset(): void; - } - /** Provides access to the object that represents the specified validation group. */ - export function getGroupConfig(group: any): GroupConfig - /** Provides access to the object that represents the default validation group. */ - export function getGroupConfig(): GroupConfig - /** Validates rules of the validators that belong to the specified validation group. */ - export function validateGroup(group: any): ValidationGroupValidationResult; - /** Validates rules of the validators that belong to the default validation group. */ - export function validateGroup(): ValidationGroupValidationResult; - /** Resets the values and validation result of the editors that belong to the specified validation group. */ - export function resetGroup(group: any): void; - /** Resets the values and validation result of the editors that belong to the default validation group. */ - export function resetGroup(): void; - /** Validates the rules that are defined within the dxValidator objects that are registered for the specified ViewModel. */ - export function validateModel(model: Object): ValidationGroupValidationResult; - /** Registers all the dxValidator objects by which the fields of the specified ViewModel are extended. */ - export function registerModelForValidation(model: Object) : void; - } - export var hardwareBackButton: JQueryCallback; - /** Processes the hardware back button click. */ - export function processHardwareBackButton(): void; - /** Hides the last displayed overlay widget. */ - export function hideTopOverlay(): boolean; - /** Specifies whether or not the entire application/site supports right-to-left representation. */ - export var rtlEnabled: boolean; - /** Registers a new component in the DevExpress.ui namespace as a jQuery plugin, Angular directive and Knockout binding. */ - export function registerComponent(name: string, componentClass: Object): void; - /** Registers a new component in the specified namespace as a jQuery plugin, Angular directive and Knockout binding. */ - export function registerComponent(name: string, namespace: Object, componentClass: Object): void; - export function requestAnimationFrame(callback: Function): number; - export function cancelAnimationFrame(requestID: number): void; - /** Custom Knockout binding that links an HTML element with a specific action. */ - export class Action { } - /** Used to get URLs that vary in a locally running application and the application running on production. */ - export class EndpointSelector { - constructor(options: { - [key: string]: { - local?: string; - production?: string; - } - }); - /** Returns a local or a productional URL depending on how the application is currently running. */ - urlFor(key: string): string; - } - /** An object that serves as a namespace for the methods that are used to animate UI elements. */ - export module fx { - /** Defines animation options. */ - export interface AnimationOptions { - /** A function called after animation is completed. */ - complete?: (element: JQuery, config: AnimationOptions) => void; - /** A number specifying wait time before animation execution. */ - delay?: number; - /** A number specifying the time period to wait before the animation of the next stagger item starts. */ - staggerDelay?: number; - /** A number specifying the time in milliseconds spent on animation. */ - duration?: number; - /** A string specifying the type of an easing function used for animation. */ - easing?: string; - /** Specifies the initial animation state. */ - from?: any; - /** A function called before animation is started. */ - start?: (element: JQuery, config: AnimationOptions) => void; - /** Specifies a final animation state. */ - to?: any; - /** A string value specifying the animation type. */ - type?: string; - /** Specifies the animation direction for the "slideIn" and "slideOut" animation types. */ - direction?: string; - } - /** Animates the specified element. */ - export function animate(element: HTMLElement, config: AnimationOptions): Object; - /** Returns a value indicating whether the specified element is being animated. */ - export function isAnimating(element: HTMLElement): boolean; - /** Stops the animation. */ - export function stop(element: HTMLElement, jumpToEnd: boolean): void; - } - /** The manager that performs several specified animations at a time. */ - export class TransitionExecutor { - /** Deletes all the animations registered in the Transition Executor by using the enter(elements, animation) and leave(elements, animation) methods. */ - reset(): void; - /** Registers a set of elements that should be animated as "entering" using the specified animation configuration. */ - enter(elements: JQuery, animation: any): void; - /** Registers a set of elements that should be animated as "leaving" using the specified animation configuration. */ - leave(elements: JQuery, animation: any): void; - /** Starts all the animations registered using the enter(elements, animation) and leave(elements, animation) methods beforehand. */ - start(config: Object): JQueryPromise; - /** Stops all started animations. */ - stop(): void; - } - export class AnimationPresetCollection { - /** Resets all the changes made in the animation repository. */ - resetToDefaults(): void; - /** Deletes the specified animation or clears all the animation repository, if an animation name is not passed. */ - clear(name: string): void; - /** Adds the specified animation preset to the animation repository by the specified name. */ - registerPreset(name: string, config: any): void; - /** Applies the changes made in the animation repository. */ - applyChanges(): void; - /** Returns the configuration of the animation found in the animation repository by the specified name for the current device. */ - getPreset(name: string): void; - /** Registers predefined animations in the animation repository. */ - registerDefaultPresets(): void; - } - /** A repository of animations. */ - export var animationPresets: AnimationPresetCollection; - /** The device object defines the device on which the application is running. */ - export interface Device { - /** Indicates whether or not the device platform is Android. */ - android?: boolean; - /** Specifies the type of the device on which the application is running. */ - deviceType?: string; - /** Indicates whether or not the device platform is generic, which means that the application will look and behave according to a generic "light" or "dark" theme. */ - generic?: boolean; - /** Indicates whether or not the device platform is iOS. */ - ios?: boolean; - /** Indicates whether or not the device type is 'phone'. */ - phone?: boolean; - /** Specifies the platform of the device on which the application is running. */ - platform?: string; - /** Indicates whether or not the device type is 'tablet'. */ - tablet?: boolean; - /** Specifies an array with the major and minor versions of the device platform. */ - version?: Array; - /** Indicates whether or not the device platform is Windows. */ - win?: boolean; - /** Specifies a performance grade of the current device. */ - grade?: string; - } - export class Devices implements EventsMixin { - constructor(options: { window: Window }); - /** Overrides actual device information to force the application to operate as if it was running on the specified device. */ - current(deviceName: any): void; - /** Returns information about the current device. */ - current(): Device; - orientationChanged: JQueryCallback; - /** Returns the current device orientation. */ - orientation(): string; - /** Returns real information about the current device regardless of the value passed to the devices.current(deviceName) method. */ - real(): Device; - on(eventName: "orientationChanged", eventHandler: (e: { orientation: string }) => void): Devices; - on(eventName: string, eventHandler: Function): Devices; - on(events: { [eventName: string]: Function; }): Devices; - off(eventName: "orientationChanged"): Devices; - off(eventName: string): Devices; - off(eventName: "orientationChanged", eventHandler: (e: { orientation: string }) => void): Devices; - off(eventName: string, eventHandler: Function): Devices; - } - /** An object that serves as a namespace for the methods and events specifying information on the current device. */ - export var devices: Devices; - /** The position object specifies the widget positioning options. */ - export interface PositionOptions { - /** The target element position that the widget is positioned against. */ - at?: string; - /** The element within which the widget is positioned. */ - boundary?: Element; - /** A string value holding horizontal and vertical offset from the window's boundaries. */ - boundaryOffset?: string; - /** Specifies how to move the widget if it overflows the screen. */ - collision?: any; - /** The position of the widget to align against the target element. */ - my?: string; - /** The target element that the widget is positioned against. */ - of?: HTMLElement; - /** A string value holding horizontal and vertical offset in pixels, separated by a space (e.g., "5 -10"). */ - offset?: string; - } - export interface ComponentOptions { - /** A handler for the initialized event. */ - onInitialized?: Function; - /** A handler for the optionChanged event. */ - onOptionChanged?: Function; - /** A handler for the disposing event. */ - onDisposing?: Function; - } - /** A base class for all components and widgets. */ - export class Component { - constructor(options?: ComponentOptions) - /** Prevents the component from refreshing until the endUpdate method is called. */ - beginUpdate(): void; - /** Enables the component to refresh after the beginUpdate method call. */ - endUpdate(): void; - /** Returns an instance of this component class. */ - instance(): Component; - /** Returns the configuration options of this component. */ - option(): { - [optionKey: string]: any; - }; - /** Sets one or more options of this component. */ - option(options: { - [optionKey: string]: any; - }): void; - /** Gets the value of the specified configuration option of this component. */ - option(optionName: string): any; - /** Sets a value to the specified configuration option of this component. */ - option(optionName: string, optionValue: any): void; - } - export interface DOMComponentOptions extends ComponentOptions { - /** Specifies whether or not the current component supports a right-to-left representation. */ - rtlEnabled?: boolean; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies the width of the widget. */ - width?: any; - } - /** A base class for all components. */ - export class DOMComponent extends Component { - constructor(element: JQuery, options?: DOMComponentOptions); - constructor(element: HTMLElement, options?: DOMComponentOptions); - /** Returns the root HTML element of the widget. */ - element(): JQuery; - /** Specifies the device-dependent default configuration options for this component. */ - static defaultOptions(rule: { - device?: any; - options?: any; - }): void; - } - export module data { - export interface ODataError extends Error { - httpStatus?: number; - errorDetails?: any; - } - export interface StoreOptions { - /** A handler for the modified event. */ - onModified?: () => void; - /** A handler for the modifying event. */ - onModifying?: () => void; - /** A handler for the removed event. */ - onRemoved?: (key: any) => void; - /** A handler for the removing event. */ - onRemoving?: (key: any) => void; - /** A handler for the updated event. */ - onUpdated?: (key: any, values: Object) => void; - /** A handler for the updating event. */ - onUpdating?: (key: any, values: Object) => void; - /** A handler for the loaded event. */ - onLoaded?: (result: Array) => void; - /** A handler for the loading event. */ - onLoading?: (loadOptions: LoadOptions) => void; - /** A handler for the inserted event. */ - onInserted?: (values: Object, key: any) => void; - /** A handler for the inserting event. */ - onInserting?: (values: Object) => void; - /** Specifies the function called when the Store causes an error. */ - errorHandler?: (e: Error) => void; - /** Specifies the key properties within the data associated with the Store. */ - key?: any; - } - export interface LoadOptions { - filter?: Object; - sort?: Object; - select?: Object; - expand?: Object; - group?: Object; - skip?: number; - take?: number; - userData?: Object; - requireTotalCount?: boolean; - } - /** The base class for all Stores. */ - export class Store implements EventsMixin { - constructor(options?: StoreOptions); - /** Returns the data item specified by the key. */ - byKey(key: any): JQueryPromise; - /** Adds an item to the data associated with this Store. */ - insert(values: Object): JQueryPromise; - /** Returns the key expression specified via the key configuration option. */ - key(): any; - /** Returns the key of the Store item that matches the specified object. */ - keyOf(obj: Object): any; - /** Starts loading data. */ - load(obj?: LoadOptions): JQueryPromise; - /** Removes the data item specified by the key. */ - remove(key: any): JQueryPromise; - /** Obtains the total count of items that will be returned by the load() function. */ - totalCount(options?: { - filter?: Object; - group?: Object; - }): JQueryPromise; - /** Updates the data item specified by the key. */ - update(key: any, values: Object): JQueryPromise; - on(eventName: "removing", eventHandler: (key: any) => void): Store; - on(eventName: "removed", eventHandler: (key: any) => void): Store; - on(eventName: "updating", eventHandler: (key: any, values: Object) => void): Store; - on(eventName: "updated", eventHandler: (key: any, values: Object) => void): Store; - on(eventName: "inserting", eventHandler: (values: Object) => void): Store; - on(eventName: "inserted", eventHandler: (values: Object, key: any) => void): Store; - on(eventName: "modifying", eventHandler: () => void): Store; - on(eventName: "modified", eventHandler: () => void): Store; - on(eventName: "loading", eventHandler: (loadOptions: LoadOptions) => void): Store; - on(eventName: "loaded", eventHandler: (result: Array) => void): Store; - on(eventName: string, eventHandler: Function): Store; - on(events: { [eventName: string]: Function; }): Store; - off(eventName: "removing"): Store; - off(eventName: "removed"): Store; - off(eventName: "updating"): Store; - off(eventName: "updated"): Store; - off(eventName: "inserting"): Store; - off(eventName: "inserted"): Store; - off(eventName: "modifying"): Store; - off(eventName: "modified"): Store; - off(eventName: "loading"): Store; - off(eventName: "loaded"): Store; - off(eventName: string): Store; - off(eventName: "removing", eventHandler: (key: any) => void): Store; - off(eventName: "removed", eventHandler: (key: any) => void): Store; - off(eventName: "updating", eventHandler: (key: any, values: Object) => void): Store; - off(eventName: "updated", eventHandler: (key: any, values: Object) => void): Store; - off(eventName: "inserting", eventHandler: (values: Object) => void): Store; - off(eventName: "inserted", eventHandler: (values: Object, key: any) => void): Store; - off(eventName: "modifying", eventHandler: () => void): Store; - off(eventName: "modified", eventHandler: () => void): Store; - off(eventName: "loading", eventHandler: (loadOptions: LoadOptions) => void): Store; - off(eventName: "loaded", eventHandler: (result: Array) => void): Store; - off(eventName: string, eventHandler: Function): Store; - } - export interface ArrayStoreOptions extends StoreOptions { - /** Specifies the array associated with this Store. */ - data?: Array; - } - /** A Store accessing an in-memory array. */ - export class ArrayStore extends Store { - constructor(options?: ArrayStoreOptions); - /** Clears all data associated with the current ArrayStore. */ - clear(): void; - /** Creates the Query object for the underlying array. */ - createQuery(): Query; - } - interface Promise { - then(doneFn?: Function, failFn?: Function, progressFn?: Function): Promise; - } - export interface CustomStoreOptions extends StoreOptions { - /** The user implementation of the byKey(key, extraOptions) method. */ - byKey?: (key: any) => Promise; - /** The user implementation of the insert(values) method. */ - insert?: (values: Object) => Promise; - /** The user implementation of the load(options) method. */ - load?: (options?: LoadOptions) => Promise; - /** The user implementation of the remove(key) method. */ - remove?: (key: any) => Promise; - /** The user implementation of the totalCount(options) method. */ - totalCount?: (options?: { - filter?: Object; - group?: Object; - }) => Promise; - /** The user implementation of the update(key, values) method. */ - update?: (key: any, values: Object) => Promise; - } - /** A Store object that enables you to implement your own data access logic. */ - export class CustomStore extends Store { - constructor(options: CustomStoreOptions); - } - export interface DataSourceOptions { - /** Specifies data filtering conditions. */ - filter?: Object; - /** Specifies data grouping conditions. */ - group?: Object; - /** The item mapping function. */ - map?: (record: any) => any; - /** Specifies the maximum number of items the page can contain. */ - pageSize?: number; - /** Specifies whether a DataSource loads data by pages, or all items at once. */ - paginate?: boolean; - /** The data post processing function. */ - postProcess?: (data: any[]) => any[]; - /** Specifies a value by which the required items are searched. */ - searchExpr?: Object; - /** Specifies the comparison operation used to search for the required items. */ - searchOperation?: string; - /** Specifies the value to which the search expression is compared. */ - searchValue?: Object; - /** Specifies the initial select option value. */ - select?: Object; - /** An array of the strings that represent the names of the navigation properties to be loaded simultaneously with the OData store's entity. */ - expand?: Object; - /** Specifies whether or not the DataSource instance requests the total count of items available in the storage. */ - requireTotalCount?: boolean; - /** Specifies the initial sort option value. */ - sort?: Object; - /** Specifies the underlying Store instance used to access data. */ - store?: any; - /** A handler for the changed event. */ - onChanged?: () => void; - /** A handler for the loadingChanged event. */ - onLoadingChanged?: (isLoading: boolean) => void; - /** A handler for the loadError event. */ - onLoadError?: (e?: Error) => void; - } - /** An object that provides access to a data web service or local data storage for collection container widgets. */ - export class DataSource implements EventsMixin { - constructor(url: string); - constructor(data: Array); - constructor(options: CustomStoreOptions); - constructor(options: DataSourceOptions); - /** Disposes all resources associated with this DataSource. */ - dispose(): void; - /** Returns the current filter option value. */ - filter(): Object; - /** Sets the filter option value. */ - filter(filterExpr: Object): void; - /** Returns the current group option value. */ - group(): Object; - /** Sets the group option value. */ - group(groupExpr: Object): void; - /** Indicates whether or not the current page contains fewer items than the number of items specified by the pageSize configuration option. */ - isLastPage(): boolean; - /** Indicates whether or not at least one load() method execution has successfully finished. */ - isLoaded(): boolean; - /** Indicates whether or not the DataSource is currently being loaded. */ - isLoading(): boolean; - /** Returns the array of items currently operated by the DataSource. */ - items(): Array; - /** Returns the key expression. */ - key(): any; - /** Starts loading data. */ - load(): JQueryPromise>; - /** Clears currently loaded DataSource items and calls the load() method. */ - reload(): JQueryPromise>; - /** Returns an object that would be passed to the load() method of the underlying Store according to the current data shaping option values of the current DataSource instance. */ - loadOptions(): Object; - /** Returns the current pageSize option value. */ - pageSize(): number; - /** Sets the pageSize option value. */ - pageSize(value: number): void; - /** Specifies the index of the currently loaded page. */ - pageIndex(): number; - /** Specifies the index of the page to be loaded during the next load() method execution. */ - pageIndex(newIndex: number): void; - /** Returns the current paginate option value. */ - paginate(): boolean; - /** Sets the paginate option value. */ - paginate(value: boolean): void; - /** Returns the searchExpr option value. */ - searchExpr(): Object; - /** Sets the searchExpr option value. */ - searchExpr(expr: Object): void; - /** Returns the currently specified search operation. */ - searchOperation(): string; - /** Sets the current search operation. */ - searchOperation(op: string): void; - /** Returns the searchValue option value. */ - searchValue(): Object; - /** Sets the searchValue option value. */ - searchValue(value: Object): void; - /** Returns the current select option value. */ - select(): Object; - /** Sets the select option value. */ - select(expr: Object): void; - /** Returns the current requireTotalCount option value. */ - requireTotalCount(): boolean; - /** Sets the requireTotalCount option value. */ - requireTotalCount(value: boolean): void; - /** Returns the current sort option value. */ - sort(): Object; - /** Sets the sort option value. */ - sort(sortExpr: Object): void; - /** Returns the underlying Store instance. */ - store(): Store; - /** Returns the number of data items available in an underlying Store after the last load() operation without paging. */ - totalCount(): number; - on(eventName: "loadingChanged", eventHandler: (isLoading: boolean) => void): DataSource; - on(eventName: "loadError", eventHandler: (e?: Error) => void): DataSource; - on(eventName: "changed", eventHandler: () => void): DataSource; - on(eventName: string, eventHandler: Function): DataSource; - on(events: { [eventName: string]: Function; }): DataSource; - off(eventName: "loadingChanged"): DataSource; - off(eventName: "loadError"): DataSource; - off(eventName: "changed"): DataSource; - off(eventName: string): DataSource; - off(eventName: "loadingChanged", eventHandler: (isLoading: boolean) => void): DataSource; - off(eventName: "loadError", eventHandler: (e?: Error) => void): DataSource; - off(eventName: "changed", eventHandler: () => void): DataSource; - off(eventName: string, eventHandler: Function): DataSource; - } - /** An object used to work with primitive data types not supported by JavaScript when accessing an OData web service. */ - export class EdmLiteral { - /** Creates an EdmLiteral instance and assigns the specified value to it. */ - constructor(value: string); - /** Returns a string representation of the value associated with this EdmLiteral object. */ - valueOf(): string; - } - /** An object used to generate and hold the GUID. */ - export class Guid { - /** Creates a new Guid instance that holds the specified GUID. */ - constructor(value: string); - /** Creates a new Guid instance holding the generated GUID. */ - constructor(); - /** Returns a string representation of the Guid instance. */ - toString(): string; - /** Returns a string representation of the Guid instance. */ - valueOf(): string; - } - export interface LocalStoreOptions extends ArrayStoreOptions { - /** Specifies the time (in miliseconds) after the change operation, before the data is flushed. */ - flushInterval?: number; - /** Specifies whether the data is flushed immediatelly after each change operation, or after the delay specified via the flushInterval option. */ - immediate?: boolean; - /** The unique identifier used to distinguish the data within the HTML5 Web Storage. */ - name?: string; - } - /** A Store providing access to the HTML5 Web Storage. */ - export class LocalStore extends ArrayStore { - constructor(options?: LocalStoreOptions); - /** Removes all data associated with this Store. */ - clear(): void; - } - export interface ODataContextOptions extends ODataStoreOptions { - /** Specifies the list of entities to be accessed via the ODataContext. */ - entities?: Object; - /** Specifies the function called if the ODataContext causes an error. */ - errorHandler?: (e: Error) => void; - } - /** Provides access to the entire OData service. */ - export class ODataContext { - constructor(options?: ODataContextOptions); - /** Initiates the specified WebGet service operation that returns a value. For the information on service operations, refer to the OData documentation. */ - get(operationName: string, params: Object): JQueryPromise; - /** Initiates the specified WebGet service operation that returns nothing. For the information on service operations, refer to the OData documentation. */ - invoke(operationName: string, params: Object, httpMethod: Object): JQueryPromise; - /** Return a special proxy object to describe the entity link. */ - objectLink(entityAlias: string, key: any): Object; - } - export interface ODataStoreOptions extends StoreOptions { - /** A function used to customize a web request before it is sent. */ - beforeSend?: (request: { - url: string; - async: boolean; - method: string; - timeout: number; - params: Object; - payload: Object; - headers: Object; - }) => void; - /** Specifies whether the ODataStore uses the JSONP approach to access non-CORS-compatible remote services. */ - jsonp?: boolean; - /** Specifies the type of the ODataStore key property. The following key types are supported out of the box: String, Int32, Int64, and Guid. */ - keyType?: any; - /** Specifies whether or not dates found in the response are deserialized. */ - deserializeDates?: boolean; - /** Specifies the URL of the data service being accessed via the current ODataContext. */ - url?: string; - /** Specifies the version of the OData protocol used to interact with the data service. */ - version?: number; - /** Specifies the value of the withCredentials field of the underlying jqXHR object. */ - withCredentials?: boolean; - } - /** A Store providing access to a separate OData web service entity. */ - export class ODataStore extends Store { - constructor(options?: ODataStoreOptions); - /** Creates the Query object for the OData endpoint. */ - createQuery(loadOptions: Object): Object; - /** Returns the data item specified by the key. */ - byKey(key: any, extraOptions?: { expand?: Object }): JQueryPromise; - } - /** An universal chainable data query interface object. */ - export interface Query { - /** Calculates a custom summary for the items in the current Query. */ - aggregate(step: (accumulator: any, value: any) => any): JQueryPromise; - /** Calculates a custom summary for the items in the current Query. */ - aggregate(seed: any, step: (accumulator: any, value: any) => any, finalize: (result: any) => any): JQueryPromise; - /** Calculates the average item value for the current Query. */ - avg(getter: Object): JQueryPromise; - /** Finds the item with the maximum getter value. */ - max(getter: Object): JQueryPromise; - /** Finds the item with the maximum value in the Query. */ - max(): JQueryPromise; - /** Finds the item with the minimum value in the Query. */ - min(): JQueryPromise; - /** Finds the item with the minimum getter value. */ - min(getter: Object): JQueryPromise; - /** Calculates the average item value for the current Query, if each Query item has a numeric type. */ - avg(): JQueryPromise; - /** Returns the total count of items in the current Query. */ - count(): JQueryPromise; - /** Executes the Query. */ - enumerate(): JQueryPromise; - /** Filters the current Query data. */ - filter(criteria: Array): Query; - /** Filters the current Query data. */ - filter(predicate: (item: any) => boolean): Query; - /** Groups the current Query data. */ - groupBy(getter: Object): Query; - /** Applies the specified transformation to each item. */ - select(getter: Object): Query; - /** Limits the data item count. */ - slice(skip: number, take?: number): Query; - /** Sorts current Query data. */ - sortBy(getter: Object, desc: boolean): Query; - /** Sorts current Query data. */ - sortBy(getter: Object): Query; - /** Calculates the sum of item getter values in the current Query. */ - sum(getter: Object): JQueryPromise; - /** Calculates the sum of item values in the current Query. */ - sum(): JQueryPromise; - /** Adds one more sorting condition to the current Query. */ - thenBy(getter: Object): Query; - /** Adds one more sorting condition to the current Query. */ - thenBy(getter: Object, desc: boolean): Query; - /** Returns the array of current Query items. */ - toArray(): Array; - } - /** The global data layer error handler. */ - export var errorHandler: (e: Error) => void; - /** Encodes the specified string or array of bytes to base64 encoding. */ - export function base64_encode(input: any): string; - /** Creates a Query instance. */ - export function query(array: Array): Query; - /** Creates a Query instance for accessing the remote service specified by a URL. */ - export function query(url: string, queryOptions: Object): Query; - /** This section describes the utility objects provided by the DevExtreme data layer. */ - export var utils: { - /** Compiles a getter function from the getter expression. */ - compileGetter(expr: any): Function; - /** Compiles a setter function from the setter expression. */ - compileSetter(expr: any): Function; - odata: { - /** Holds key value converters for OData. */ - keyConverters: { - String(value: any): string; - Int32(value: any): number; - Int64(value: any): EdmLiteral; - Guid(value: any): Guid; - Boolean(value: any): boolean; - Single(value: any): EdmLiteral; - Decimal(value: any): EdmLiteral; - }; - } - } - } - /** An object that serves as a namespace for DevExtreme UI widgets as well as for methods implementing UI logic in DevExtreme sites/applications. */ - export module ui { - export interface WidgetOptions extends DOMComponentOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A Boolean value specifying whether or not the widget can respond to user interaction. */ - disabled?: boolean; - /** A Boolean value specifying whether or not the widget changes its state when being hovered by an end user. */ - hoverStateEnabled?: boolean; - /** Specifies whether or not the widget can be focused. */ - focusStateEnabled?: boolean; - /** Specifies a shortcut key that sets focus on the widget element. */ - accessKey?: string; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - /** Specifies the widget tab index. */ - tabIndex?: number; - /** Specifies the text of the hint displayed for the widget. */ - hint?: string; - } - /** The base class for widgets. */ - export class Widget extends DOMComponent { - constructor(options?: WidgetOptions); - /** Redraws the widget. */ - repaint(): void; - /** Sets focus on the widget. */ - focus(): void; - /** Registers a handler when a specified key is pressed. */ - registerKeyHandler(key: string, handler: Function): void; - } - export interface CollectionWidgetOptions extends WidgetOptions { - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** The time period in milliseconds before the onItemHold event is raised. */ - itemHoldTimeout?: number; - /** An array of items displayed by the widget. */ - items?: Array; - /** The template to be used for rendering items. */ - itemTemplate?: any; - loopItemFocus?: boolean; - /** The text or HTML markup displayed by the widget if the item collection is empty. */ - noDataText?: string; - onContentReady?: any; - /** A handler for the itemClick event. */ - onItemClick?: any; - /** A handler for the itemContextMenu event. */ - onItemContextMenu?: Function; - /** A handler for the itemHold event. */ - onItemHold?: Function; - /** A handler for the itemRendered event. */ - onItemRendered?: Function; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: Function; - /** The index of the currently selected widget item. */ - selectedIndex?: number; - /** The selected item object. */ - selectedItem?: Object; - /** An array of currently selected item objects. */ - selectedItems?: Array; - /** A handler for the itemDeleting event. */ - onItemDeleting?: Function; - /** A handler for the itemDeleted event. */ - onItemDeleted?: Function; - /** A handler for the itemReordered event. */ - onItemReordered?: Function; - } - /** The base class for widgets containing an item collection. */ - export class CollectionWidget extends Widget { - constructor(element: JQuery, options?: CollectionWidgetOptions); - constructor(element: HTMLElement, options?: CollectionWidgetOptions); - selectItem(itemElement: any): void; - unselectItem(itemElement: any): void; - deleteItem(itemElement: any): JQueryPromise; - isItemSelected(itemElement: any): boolean; - reorderItem(itemElement: any, toItemElement: any): JQueryPromise; - } - export interface DataExpressionMixinOptions { - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** Specifies the name of the data source item field whose value is displayed by the widget. */ - displayExpr?: any; - /** Specifies the name of a data source item field whose value is held in the value configuration option. */ - valueExpr?: any; - /** An array of items displayed by the widget. */ - items?: Array; - /** The template to be used for rendering items. */ - itemTemplate?: any; - /** The currently selected value in the widget. */ - value?: Object; - } - export interface EditorOptions extends WidgetOptions { - /** The currently specified value. */ - value?: Object; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - /** A Boolean value specifying whether or not the widget is read-only. */ - readOnly?: boolean; - /** Holds the object that defines the error that occurred during validation. */ - validationError?: Object; - /** Specifies whether the editor's value is valid. */ - isValid?: boolean; - /** Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed. */ - validationMessageMode?: string; - } - /** A base class for editors. */ - export class Editor extends Widget { - /** Resets the editor's value to undefined. */ - reset(): void; - } - /** An object that serves as a namespace for methods displaying a message in an application/site. */ - export var dialog: { - /** Creates an alert dialog message containing a single "OK" button. */ - alert(message: string, title: string): JQueryPromise; - /** Creates a confirm dialog that contains "Yes" and "No" buttons. */ - confirm(message: string, title: string): JQueryPromise; - /** Creates a custom dialog using the options specified by the passed configuration object. */ - custom(options: { title?: string; message?: string; buttons?: Array; }): { - show(): JQueryPromise; - hide(): void; - hide(value: any): void; - }; - }; - /** Creates a toast message. */ - export function notify(message: any, type: string, displayTime: number): void; - /** Creates a toast message. */ - export function notify(options: Object): void; - /** An object that serves as a namespace for the methods that work with DevExtreme CSS Themes. */ - export var themes: { - /** Returns the name of the currently applied theme. */ - current(): string; - /** Changes the current theme to the specified one. */ - current(themeName: string): void; - }; - /** Sets a specified template engine. */ - export function setTemplateEngine(name: string): void; - /** Sets a custom template engine defined via custom compile and render functions. */ - export function setTemplateEngine(options: Object): void; - } - /** An object that serves as a namespace for utility methods that can be helpful when working with the DevExtreme framework and UI widgets. */ - export var utils: { - /** Sets parameters for the viewport meta tag. */ - initMobileViewport(options: { allowZoom?: boolean; allowPan?: boolean; allowSelection?: boolean }): void; - /** Requests that the browser call a specified function to update animation before the next repaint. */ - requestAnimationFrame(callback: Function): number; - /** Cancels an animation frame request scheduled with the requestAnimationFrame method. */ - cancelAnimationFrame(requestID: number): void; - }; - /** An object that serves as a namespace for DevExtreme Data Visualization Widgets. */ - export module viz { - /** Applies a theme for the entire page with several DevExtreme visualization widgets. */ - export function currentTheme(theme: string): void; - /** Applies a new theme (with the color scheme defined separately) for the entire page with several DevExtreme visualization widgets. */ - export function currentTheme(platform: string, colorScheme: string): void; - /** Registers a new theme based on the existing one. */ - export function registerTheme(customTheme: Object, baseTheme: string): void; - /** Applies a predefined or registered custom palette to all visualization widgets at once. */ - export function currentPalette(paletteName: string): void; - /** Obtains the color sets of a predefined or registered palette. */ - export function getPalette(paletteName: string): Object; - /** Registers a new palette. */ - export function registerPalette(paletteName: string, palette: Object): void; - } -} -declare namespace DevExpress.ui { - export interface dxValidatorOptions extends DOMComponentOptions { - /** An array of validation rules to be checked for the editor with which the dxValidator object is associated. */ - validationRules?: Array; - /** Specifies the editor name to be used in the validation default messages. */ - name?: string; - /** An object that specifies what and when to validate and how to apply the validation result. */ - adapter?: Object; - /** Specifies the validation group the editor will be related to. */ - validationGroup?: string; - /** A handler for the validated event. */ - onValidated?: (params: validationEngine.ValidatorValidationResult) => void; - } - /** A widget that is used to validate the associated DevExtreme editors against the defined validation rules. */ - export class dxValidator extends DOMComponent implements validationEngine.IValidator { - constructor(element: JQuery, options?: dxValidatorOptions); - constructor(element: Element, options?: dxValidatorOptions); - /** Validates the value of the editor that is controlled by the current dxValidator object against the list of the specified validation rules. */ - validate(): validationEngine.ValidatorValidationResult; - /** Resets the value and validation result of the editor associated with the current dxValidator object. */ - reset(): void; - } - /** The widget that is used in the Knockout and Angular approaches to combine the editors to be validated. */ - export class dxValidationGroup extends DOMComponent { - constructor(element: JQuery); - constructor(element: Element); - /** Validates rules of the validators that belong to the current validation group. */ - validate(): validationEngine.ValidationGroupValidationResult; - /** Resets the value and validation result of the editors that are included to the current validation group. */ - reset(): void; - } - export interface dxValidationSummaryOptions extends CollectionWidgetOptions { - /** Specifies the validation group for which summary should be generated. */ - validationGroup?: string; - } - /** A widget for displaying the result of checking validation rules for editors. */ - export class dxValidationSummary extends CollectionWidget { - constructor(element: JQuery, options?: dxValidationSummaryOptions); - constructor(element: Element, options?: dxValidationSummaryOptions); - } - export interface dxResizableOptions extends DOMComponentOptions { - /** Specifies which borders of the widget element are used as a handle. */ - handles?: string; - /** Specifies the lower width boundary for resizing. */ - minWidth?: number; - /** Specifies the upper width boundary for resizing. */ - maxWidth?: number; - /** Specifies the lower height boundary for resizing. */ - minHeight?: number; - /** Specifies the upper height boundary for resizing. */ - maxHeight?: number; - /** A handler for the resizeStart event. */ - onResizeStart?: Function; - /** A handler for the resize event. */ - onResize?: Function; - /** A handler for the resizeEnd event. */ - onResizeEnd?: Function; - } - /** A widget that displays required content in a resizable element. */ - export class dxResizable extends DOMComponent { - constructor(element: JQuery, options?: dxResizableOptions); - constructor(element: Element, options?: dxResizableOptions); - } - export interface dxTooltipOptions extends dxPopoverOptions { - } - /** A tooltip widget. */ - export class dxTooltip extends dxPopover { - constructor(element: JQuery, options?: dxTooltipOptions); - constructor(element: Element, options?: dxTooltipOptions); - } - export interface dxDropDownListOptions extends dxDropDownEditorOptions, DataExpressionMixinOptions { - /** Returns the value currently displayed by the widget. */ - displayValue?: string; - /** The minimum number of characters that must be entered into the text box to begin a search. */ - minSearchLength?: number; - /** Specifies whether or not the widget displays unfiltered values until a user types a number of characters exceeding the minSearchLength option value. */ - showDataBeforeSearch?: boolean; - /** Specifies the name of a data source item field or an expression whose value is compared to the search criterion. */ - searchExpr?: Object; - /** Specifies the binary operation used to filter data. */ - searchMode?: string; - /** Specifies the time delay, in milliseconds, after the last character has been typed in, before a search is executed. */ - searchTimeout?: number; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - /** Specifies DOM event names that update a widget's value. */ - valueChangeEvent?: string; - /** Specifies whether or not the widget supports searching. */ - searchEnabled?: boolean; - /** - * Specifies whether or not the widget displays items by pages. - * @deprecated dataSource.paginate.md - */ - pagingEnabled?: boolean; - /** The text or HTML markup displayed by the widget if the item collection is empty. */ - noDataText?: string; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: Function; - /** A handler for the itemClick event. */ - onItemClick?: Function; - onContentReady?: Function; - } - /** A base class for drop-down list widgets. */ - export class dxDropDownList extends dxDropDownEditor { - constructor(element: JQuery, options?: dxDropDownListOptions); - constructor(element: Element, options?: dxDropDownListOptions); - } - export interface dxToolbarOptions extends CollectionWidgetOptions { - /** The template used to render menu items. */ - menuItemTemplate?: any; - /** Informs the widget about its location in a view HTML markup. */ - renderAs?: string; - } - /** A toolbar widget. */ - export class dxToolbar extends CollectionWidget { - constructor(element: JQuery, options?: dxToolbarOptions); - constructor(element: Element, options?: dxToolbarOptions); - } - export interface dxToastOptions extends dxOverlayOptions { - animation?: fx.AnimationOptions; - /** The time span in milliseconds during which the dxToast widget is visible. */ - displayTime?: number; - height?: any; - /** The dxToast message text. */ - message?: string; - position?: PositionOptions; - shading?: boolean; - /** Specifies the dxToast widget type. */ - type?: string; - width?: any; - closeOnBackButton?: boolean; - /** A Boolean value specifying whether or not the toast is closed if a user swipes it out of the screen boundaries. */ - closeOnSwipe?: boolean; - /** A Boolean value specifying whether or not the toast is closed if a user clicks it. */ - closeOnClick?: boolean; - } - /** The toast message widget. */ - export class dxToast extends dxOverlay { - constructor(element: JQuery, options?: dxToastOptions); - constructor(element: Element, options?: dxToastOptions); - } - export interface dxTextEditorOptions extends EditorOptions { - /** A handler for the change event. */ - onChange?: Function; - /** A handler for the copy event. */ - onCopy?: Function; - /** A handler for the cut event. */ - onCut?: Function; - /** A handler for the enterKey event. */ - onEnterKey?: Function; - /** A handler for the focusIn event. */ - onFocusIn?: Function; - /** A handler for the focusOut event. */ - onFocusOut?: Function; - /** A handler for the input event. */ - onInput?: Function; - /** A handler for the keyDown event. */ - onKeyDown?: Function; - /** A handler for the keyPress event. */ - onKeyPress?: Function; - /** A handler for the keyUp event. */ - onKeyUp?: Function; - /** A handler for the paste event. */ - onPaste?: Function; - /** The text displayed by the widget when the widget value is empty. */ - placeholder?: string; - /** Specifies whether to display the Clear button in the widget. */ - showClearButton?: boolean; - /** Specifies the current value displayed by the widget. */ - value?: any; - /** Specifies DOM event names that update a widget's value. */ - valueChangeEvent?: string; - /** Specifies whether or not the widget checks the inner text for spelling mistakes. */ - spellcheck?: boolean; - /** Specifies HTML attributes applied to the inner input element of the widget. */ - attr?: Object; - /** The read-only option that holds the text displayed by the widget input element. */ - text?: string; - focusStateEnabled?: boolean; - hoverStateEnabled?: boolean; - /** The editor mask that specifies the format of the entered string. */ - mask?: string; - /** Specifies a mask placeholder character. */ - maskChar?: string; - /** Specifies custom mask rules. */ - maskRules?: Object; - /** A message displayed when the entered text does not match the specified pattern. */ - maskInvalidMessage?: string; - /** Specifies whether the value option holds only characters entered by a user or prompt characters as well. */ - useMaskedValue?: boolean; - } - /** A base class for text editing widgets. */ - export class dxTextEditor extends Editor { - constructor(element: JQuery, options?: dxTextEditorOptions); - constructor(element: Element, options?: dxTextEditorOptions); - /** Removes focus from the input element. */ - blur(): void; - /** Sets focus to the input element representing the widget. */ - focus(): void; - } - export interface dxTextBoxOptions extends dxTextEditorOptions { - /** Specifies the maximum number of characters you can enter into the textbox. */ - maxLength?: any; - /** The "mode" attribute value of the actual HTML input element representing the text box. */ - mode?: string; - } - /** A single-line text box widget. */ - export class dxTextBox extends dxTextEditor { - constructor(element: JQuery, options?: dxTextBoxOptions); - constructor(element: Element, options?: dxTextBoxOptions); - } - export interface dxTextAreaOptions extends dxTextBoxOptions { - /** Specifies whether or not the widget checks the inner text for spelling mistakes. */ - spellcheck?: boolean; - } - /** A widget used to display and edit multi-line text. */ - export class dxTextArea extends dxTextBox { - constructor(element: JQuery, options?: dxTextAreaOptions); - constructor(element: Element, options?: dxTextAreaOptions); - } - export interface dxTabsOptions extends CollectionWidgetOptions { - /** Specifies whether the widget enables an end-user to select only a single item or multiple items. */ - selectionMode?: string; - /** Specifies whether or not an end-user can scroll tabs by swiping. */ - scrollByContent?: boolean; - /** Specifies whether or not an end-user can scroll tabs. */ - scrollingEnabled?: boolean; - /** A Boolean value that specifies the availability of navigation buttons. */ - showNavButtons?: boolean; - } - /** A tab strip used to switch between pages. */ - export class dxTabs extends CollectionWidget { - constructor(element: JQuery, options?: dxTabsOptions); - constructor(element: Element, options?: dxTabsOptions); - } - export interface dxTabPanelOptions extends dxMultiViewOptions { - /** A handler for the titleClick event. */ - onTitleClick?: any; - /** A handler for the titleHold event. */ - onTitleHold?: Function; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - /** The template to be used for rendering an item title. */ - itemTitleTemplate?: any; - /** A Boolean value specifying if the list is scrolled by content. */ - scrollByContent?: boolean; - /** A Boolean value specifying whether to enable or disable scrolling. */ - scrollingEnabled?: boolean; - /** A Boolean value that specifies the availability of navigation buttons. */ - showNavButtons?: boolean; - } - /** A widget used to display a view and to switch between several views by clicking the appropriate tabs. */ - export class dxTabPanel extends dxMultiView { - constructor(element: JQuery, options?: dxTabPanelOptions); - constructor(element: Element, options?: dxTabPanelOptions); - } - export interface dxSelectBoxOptions extends dxDropDownListOptions { - /** Specifies DOM event names that update a widget's value. */ - valueChangeEvent?: string; - /** The template to be used for rendering the widget text field. */ - fieldTemplate?: any; - /** The text that is provided as a hint in the select box editor. */ - placeholder?: string; - /** Specifies whether or not the widget allows an end-user to enter a custom value. */ - fieldEditEnabled?: boolean; - } - /** A widget that allows you to select an item in a dropdown list. */ - export class dxSelectBox extends dxDropDownList { - constructor(element: JQuery, options?: dxSelectBoxOptions); - constructor(element: Element, options?: dxSelectBoxOptions); - } - export interface dxTagBoxOptions extends dxSelectBoxOptions { - /** Holds the list of selected values. */ - values?: Array; - /** A read-only option that holds the last selected value. */ - value?: Object; - } - /** A widget that allows you to select multiple items from a dropdown list. */ - export class dxTagBox extends dxSelectBox { - constructor(element: JQuery, options?: dxTagBoxOptions); - constructor(element: Element, options?: dxTagBoxOptions); - } - export interface dxScrollViewOptions extends dxScrollableOptions { - /** A handler for the pullDown event. */ - onPullDown?: Function; - /** Specifies the text shown in the pullDown panel when pulling the content down lowers the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while pulling the content down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the reachBottom event. */ - onReachBottom?: Function; - /** Specifies the text shown in the pullDown panel displayed when content is scrolled to the bottom. */ - reachBottomText?: string; - /** Specifies the text shown in the pullDown panel displayed when the content is being refreshed. */ - refreshingText?: string; - /** Returns a value indicating if the scrollView content is larger then the widget container. */ - isFull(): boolean; - /** Locks the widget until the release(preventScrollBottom) method is called and executes the function passed to the onPullDown option and the handler assigned to the pullDown event. */ - refresh(): void; - /** Notifies the scroll view that data loading is finished. */ - release(preventScrollBottom: boolean): JQueryPromise; - /** Toggles the loading state of the widget. */ - toggleLoading(showOrHide: boolean): void; - } - /** A widget used to display scrollable content. */ - export class dxScrollView extends dxScrollable { - constructor(element: JQuery, options?: dxScrollViewOptions); - constructor(element: Element, options?: dxScrollViewOptions); - } - export interface dxScrollableLocation { - top?: number; - left?: number; - } - export interface dxScrollableOptions extends DOMComponentOptions { - /** A string value specifying the available scrolling directions. */ - direction?: string; - /** A Boolean value specifying whether or not the widget can respond to user interaction. */ - disabled?: boolean; - /** A handler for the scroll event. */ - onScroll?: Function; - /** Specifies when the widget shows the scrollbar. */ - showScrollbar?: string; - /** A handler for the update event. */ - onUpdated?: Function; - /** Indicates whether to use native or simulated scrolling. */ - useNative?: boolean; - /** A Boolean value specifying whether to enable or disable the bounce-back effect. */ - bounceEnabled?: boolean; - /** A Boolean value specifying whether or not an end-user can scroll the widget content swiping it up or down. */ - scrollByContent?: boolean; - /** A Boolean value specifying whether or not an end-user can scroll the widget content using the scrollbar. */ - scrollByThumb?: boolean; - } - /** A widget used to display scrollable content. */ - export class dxScrollable extends DOMComponent { - constructor(element: JQuery, options?: dxScrollableOptions); - constructor(element: Element, options?: dxScrollableOptions); - /** Returns the height of the scrollable widget in pixels. */ - clientHeight(): number; - /** Returns the width of the scrollable widget in pixels. */ - clientWidth(): number; - /** Returns an HTML element of the widget. */ - content(): JQuery; - /** Scrolls the widget content by the specified number of pixels. */ - scrollBy(distance: number): void; - /** Scrolls widget content by the specified number of pixels in horizontal and vertical directions. */ - scrollBy(distanceObject: dxScrollableLocation): void; - /** Returns the height of the scrollable content in pixels. */ - scrollHeight(): number; - /** Returns the current scroll position against the leftmost position. */ - scrollLeft(): number; - /** Returns how far the scrollable content is scrolled from the top and from the left. */ - scrollOffset(): dxScrollableLocation; - /** Scrolls widget content to the specified position. */ - scrollTo(targetLocation: number): void; - /** Scrolls widget content to a specified position. */ - scrollTo(targetLocation: dxScrollableLocation): void; - /** Scrolls widget content to the specified element. */ - scrollToElement(element: Element): void; - /** Returns the current scroll position against the topmost position. */ - scrollTop(): number; - /** Returns the width of the scrollable content in pixels. */ - scrollWidth(): number; - /** Updates the dimensions of the scrollable contents. */ - update(): void; - } - export interface dxRadioGroupOptions extends EditorOptions, DataExpressionMixinOptions { - activeStateEnabled?: boolean; - /** Specifies the radio group layout. */ - layout?: string; - } - /** A widget that enables a user to select one item within a list of items represented by radio buttons. */ - export class dxRadioGroup extends CollectionWidget { - constructor(element: JQuery, options?: dxRadioGroupOptions); - constructor(element: Element, options?: dxRadioGroupOptions); - } - export interface dxPopupOptions extends dxOverlayOptions { - animation?: fx.AnimationOptions; - /** Specifies whether or not to allow a user to drag the popup window. */ - dragEnabled?: boolean; - /** A Boolean value specifying whether or not to display the widget in full-screen mode. */ - fullScreen?: boolean; - position?: PositionOptions; - /** A Boolean value specifying whether or not to display the title in the popup window. */ - showTitle?: boolean; - /** The title in the overlay window. */ - title?: string; - /** A template to be used for rendering the widget title. */ - titleTemplate?: any; - width?: any; - /** Specifies items displayed on the top or bottom toolbar of the popup window. */ - buttons?: Array; - /** Specifies whether or not the widget displays the Close button. */ - showCloseButton?: boolean; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - } - /** A widget that displays required content in a popup window. */ - export class dxPopup extends dxOverlay { - constructor(element: JQuery, options?: dxPopupOptions); - constructor(element: Element, options?: dxPopupOptions); - } - export interface dxPopoverOptions extends dxPopupOptions { - /** An object defining animation options of the widget. */ - animation?: fx.AnimationOptions; - /** Specifies the height of the widget. */ - height?: any; - /** An object defining widget positioning options. */ - position?: PositionOptions; - shading?: boolean; - /** A Boolean value specifying whether or not to display the title in the overlay window. */ - showTitle?: boolean; - /** The target element associated with a popover. */ - target?: any; - /** Specifies the width of the widget. */ - width?: any; - } - /** A widget that displays the required content in a popup window. */ - export class dxPopover extends dxPopup { - constructor(element: JQuery, options?: dxPopoverOptions); - constructor(element: Element, options?: dxPopoverOptions); - /** Displays the widget for the specified target element. */ - show(target?: any): JQueryPromise; - } - export interface dxOverlayOptions extends WidgetOptions { - /** An object that defines the animation options of the widget. */ - animation?: fx.AnimationOptions; - /** A Boolean value specifying whether or not the widget is closed if a user presses the Back hardware button. */ - closeOnBackButton?: boolean; - /** A Boolean value specifying whether or not the widget is closed if a user clicks outside of the overlapping window. */ - closeOnOutsideClick?: any; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - /** Specifies whether or not an end-user can drag the widget. */ - dragEnabled?: boolean; - /** Specifies whether or not an end user can resize the widget. */ - resizeEnabled?: boolean; - /** The height of the widget in pixels. */ - height?: any; - /** Specifies the maximum height the widget can reach while resizing. */ - maxHeight?: any; - /** Specifies the maximum width the widget can reach while resizing. */ - maxWidth?: any; - /** Specifies the minimum height the widget can reach while resizing. */ - minHeight?: any; - /** Specifies the minimum width the widget can reach while resizing. */ - minWidth?: any; - /** A handler for the hidden event. */ - onHidden?: Function; - /** A handler for the resizeStart event. */ - onResizeStart?: Function; - /** A handler for the resize event. */ - onResize?: Function; - /** A handler for the resizeEnd event. */ - onResizeEnd?: Function; - /** A handler for the hiding event. */ - onHiding?: Function; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** A Boolean value specifying whether or not the main screen is inactive while the widget is active. */ - shading?: boolean; - /** Specifies the shading color. */ - shadingColor?: string; - /** A handler for the showing event. */ - onShowing?: Function; - /** A handler for the shown event. */ - onShown?: Function; - onContentReady?: Function; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - /** The widget width in pixels. */ - width?: any; - } - /** A widget displaying the required content in an overlay window. */ - export class dxOverlay extends Widget { - constructor(element: JQuery, options?: dxOverlayOptions); - constructor(element: Element, options?: dxOverlayOptions); - /** An HTML element of the widget. */ - content(): JQuery; - /** Hides the widget. */ - hide(): JQueryPromise; - /** Recalculates the overlay's size and position. */ - repaint(): void; - /** Shows the widget. */ - show(): JQueryPromise; - /** Toggles the visibility of the widget. */ - toggle(showing: boolean): JQueryPromise; - /** A static method that specifies the base z-index for all overlay widgets. */ - static baseZIndex(zIndex: number): void; - } - export interface dxNumberBoxOptions extends dxTextEditorOptions { - /** The maximum value accepted by the number box. */ - max?: number; - /** The minimum value accepted by the number box. */ - min?: number; - /** Specifies whether or not to show spin buttons. */ - showSpinButtons?: boolean; - useTouchSpinButtons?: boolean; - /** Specifies by which value the widget value changes when a spin button is clicked. */ - step?: number; - /** The current number box value. */ - value?: number; - /** The "mode" attribute value of the actual HTML input element representing the widget. */ - mode?: string; - } - /** A textbox widget that enables a user to enter numeric values. */ - export class dxNumberBox extends dxTextEditor { - constructor(element: JQuery, options?: dxNumberBoxOptions); - constructor(element: Element, options?: dxNumberBoxOptions); - } - export interface dxNavBarOptions extends dxTabsOptions { - scrollingEnabled?: boolean; - } - /** A widget that contains items used to navigate through application views. */ - export class dxNavBar extends dxTabs { - constructor(element: JQuery, options?: dxNavBarOptions); - constructor(element: Element, options?: dxNavBarOptions); - } - export interface dxMultiViewOptions extends CollectionWidgetOptions { - /** Specifies whether or not to animate the displayed item change. */ - animationEnabled?: boolean; - /** A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped. */ - loop?: boolean; - /** The index of the currently displayed item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to allow users to change the selected index by swiping. */ - swipeEnabled?: boolean; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - } - /** A widget used to display a view and to switch between several views. */ - export class dxMultiView extends CollectionWidget { - constructor(element: JQuery, options?: dxMultiViewOptions); - constructor(element: Element, options?: dxMultiViewOptions); - } - export interface dxMapOptions extends WidgetOptions { - /** Specifies whether or not the widget automatically adjusts center and zoom option values when adding a new marker or route or when creating a widget if it initially contains markers or routes. */ - autoAdjust?: boolean; - center?: { - /** The latitude location displayed in the center of the widget. */ - lat?: number; - /** The longitude location displayed in the center of the widget. */ - lng?: number; - }; - /** A handler for the click event. */ - onClick?: any; - /** Specifies whether or not map widget controls are available. */ - controls?: boolean; - /** Specifies the height of the widget. */ - height?: any; - /** A key used to authenticate the application within the required map provider. */ - key?: { - /** A key used to authenticate the application within the "Bing" map provider. */ - bing?: string; - /** A key used to authenticate the application within the "Google" map provider. */ - google?: string; - /** A key used to authenticate the application within the "Google Static" map provider. */ - googleStatic?: string; - } - /** A handler for the markerAdded event. */ - onMarkerAdded?: Function; - /** A URL pointing to the custom icon to be used for map markers. */ - markerIconSrc?: string; - /** A handler for the markerRemoved event. */ - onMarkerRemoved?: Function; - /** An array of markers displayed on a map. */ - markers?: Array; - /** The name of the current map data provider. */ - provider?: string; - /** A handler for the ready event. */ - onReady?: Function; - /** A handler for the routeAdded event. */ - onRouteAdded?: Function; - /** A handler for the routeRemoved event. */ - onRouteRemoved?: Function; - /** An array of routes shown on the map. */ - routes?: Array; - /** The type of a map to display. */ - type?: string; - /** Specifies the width of the widget. */ - width?: any; - /** The zoom level of the map. */ - zoom?: number; - } - /** An interactive map widget. */ - export class dxMap extends Widget { - constructor(element: JQuery, options?: dxMapOptions); - constructor(element: Element, options?: dxMapOptions); - /** Adds a marker to the map. */ - addMarker(markerOptions: Object): JQueryPromise; - /** Adds a route to the map. */ - addRoute(routeOptions: Object): JQueryPromise; - /** Removes a marker from the map. */ - removeMarker(marker: Object): JQueryPromise; - /** Removes a route from the map. */ - removeRoute(route: any): JQueryPromise; - } - export interface dxLookupOptions extends dxDropDownListOptions { - /** An object defining widget animation options. */ - animation?: fx.AnimationOptions; - /** The text displayed on the Cancel button. */ - cancelButtonText?: string; - /** The text displayed on the Clear button. */ - clearButtonText?: string; - /** Specifies whether or not the widget cleans the search box when the popup window is displayed. */ - cleanSearchOnOpening?: boolean; - /** A Boolean value specifying whether or not a widget is closed if a user clicks outside of the overlaying window. */ - closeOnOutsideClick?: any; - /** The text displayed on the Apply button. */ - applyButtonText?: string; - /** A Boolean value specifying whether or not to display the lookup in full-screen mode. */ - fullScreen?: boolean; - focusStateEnabled?: boolean; - /** A Boolean value specifying whether or not to group widget items. */ - grouped?: boolean; - /** The name of the template used to display a group header. */ - groupTemplate?: any; - /** The text displayed on the button used to load the next page from the data source. */ - nextButtonText?: string; - /** A handler for the pageLoading event. */ - onPageLoading?: Function; - /** Specifies whether the next page is loaded when a user scrolls the widget to the bottom or when the "next" button is clicked. */ - pageLoadMode?: string; - /** Specifies the text shown in the pullDown panel, which is displayed when the widget is scrolled to the bottom. */ - pageLoadingText?: string; - /** The text displayed by the widget when nothing is selected. */ - placeholder?: string; - /** The height of the widget popup element. */ - popupHeight?: any; - /** The width of the widget popup element. */ - popupWidth?: any; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** Specifies the text displayed in the pullDown panel when the widget is pulled below the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the pullRefresh event. */ - onPullRefresh?: Function; - /** A Boolean value specifying whether or not the widget supports the "pull down to refresh" gesture. */ - pullRefreshEnabled?: boolean; - /** Specifies the text displayed in the pullDown panel while the widget is being refreshed. */ - refreshingText?: string; - /** A handler for the scroll event. */ - onScroll?: Function; - /** A Boolean value specifying whether or not the search bar is visible. */ - searchEnabled?: boolean; - /** The text that is provided as a hint in the lookup's search bar. */ - searchPlaceholder?: string; - /** A Boolean value specifying whether or not the main screen is inactive while the lookup is active. */ - shading?: boolean; - /** Specifies whether to display the Cancel button in the lookup window. */ - showCancelButton?: boolean; - /** - * A Boolean value specifying whether the widget loads the next page automatically when you reach the bottom of the list or when a button is clicked. - * @deprecated pageLoadMode.md - */ - showNextButton?: boolean; - /** The title of the lookup window. */ - title?: string; - /** A template to be used for rendering the widget title. */ - titleTemplate?: any; - /** Specifies whether or not the widget uses native scrolling. */ - useNativeScrolling?: boolean; - /** Specifies whether or not to show lookup contents in a dxPopover widget. */ - usePopover?: boolean; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - /** A Boolean value specifying whether or not to display the title in the popup window. */ - showPopupTitle?: boolean; - /** The template to be used for rendering the widget text field. */ - fieldTemplate?: any; - } - /** A widget that allows a user to select predefined values from a lookup window. */ - export class dxLookup extends dxDropDownList { - constructor(element: JQuery, options?: dxLookupOptions); - constructor(element: Element, options?: dxLookupOptions); - /** This section lists the data source fields that are used in a default template for lookup drop-down items. */ - } - export interface dxLoadPanelOptions extends dxOverlayOptions { - /** An object defining the animation options of the widget. */ - animation?: fx.AnimationOptions; - /** The delay in milliseconds after which the load panel is displayed. */ - delay?: number; - /** The height of the widget. */ - height?: number; - /** A URL pointing to an image to be used as a load indicator. */ - indicatorSrc?: string; - /** The text displayed in the load panel. */ - message?: string; - /** A Boolean value specifying whether or not to show a load indicator. */ - showIndicator?: boolean; - /** A Boolean value specifying whether or not to show the pane behind the load indicator. */ - showPane?: boolean; - /** The width of the widget. */ - width?: number; - } - /** A widget used to indicate whether or not an element is loading. */ - export class dxLoadPanel extends dxOverlay { - constructor(element: JQuery, options?: dxLoadPanelOptions); - constructor(element: Element, options?: dxLoadPanelOptions); - } - export interface dxLoadIndicatorOptions extends WidgetOptions { - /** Specifies the path to an image used as the indicator. */ - indicatorSrc?: string; - } - /** The widget used to indicate the loading process. */ - export class dxLoadIndicator extends Widget { - constructor(element: JQuery, options?: dxLoadIndicatorOptions); - constructor(element: Element, options?: dxLoadIndicatorOptions); - } - export interface dxListOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not to display a grouped list. */ - grouped?: boolean; - /** The template to be used for rendering item groups. */ - groupTemplate?: any; - onItemDeleting?: Function; - /** A handler for the itemDeleted event. */ - onItemDeleted?: Function; - /** A handler for the groupRendered event. */ - onGroupRendered?: Function; - /** A handler for the itemReordered event. */ - onItemReordered?: Function; - /** A handler for the itemClick event. */ - onItemClick?: any; - /** A handler for the itemSwipe event. */ - onItemSwipe?: Function; - /** The text displayed on the button used to load the next page from the data source. */ - nextButtonText?: string; - /** A handler for the pageLoading event. */ - onPageLoading?: Function; - /** Specifies the text shown in the pullDown panel, which is displayed when the list is scrolled to the bottom. */ - pageLoadingText?: string; - /** Specifies the text displayed in the pullDown panel when the list is pulled below the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the pullRefresh event. */ - onPullRefresh?: Function; - /** A Boolean value specifying whether or not the widget supports the "pull down to refresh" gesture. */ - pullRefreshEnabled?: boolean; - /** Specifies the text displayed in the pullDown panel while the list is being refreshed. */ - refreshingText?: string; - /** A handler for the scroll event. */ - onScroll?: Function; - /** A Boolean value specifying whether to enable or disable list scrolling. */ - scrollingEnabled?: boolean; - /** Specifies when the widget shows the scrollbar. */ - showScrollbar?: string; - /** Specifies whether or not the widget uses native scrolling. */ - useNativeScrolling?: boolean; - /** A Boolean value specifying whether to enable or disable the bounce-back effect. */ - bounceEnabled?: boolean; - /** A Boolean value specifying if the list is scrolled by content. */ - scrollByContent?: boolean; - /** A Boolean value specifying if the list is scrolled using the scrollbar. */ - scrollByThumb?: boolean; - onItemContextMenu?: Function; - onItemHold?: Function; - /** Specifies whether or not an end-user can collapse groups. */ - collapsibleGroups?: boolean; - /** Specifies whether the next page is loaded when a user scrolls the widget to the bottom or when the "next" button is clicked. */ - pageLoadMode?: string; - /** Specifies whether or not to display controls used to select list items. */ - showSelectionControls?: boolean; - /** Specifies item selection mode. */ - selectionMode?: string; - selectAllText?: string; - onSelectAllChanged?: Function; - /** Specifies the array of items for a context menu called for a list item. */ - menuItems?: Array; - /** Specifies whether an item context menu is shown when a user holds or swipes an item. */ - menuMode?: string; - /** Specifies whether or not an end user can delete list items. */ - allowItemDeleting?: boolean; - /** Specifies the way a user can delete items from the list. */ - itemDeleteMode?: string; - /** Specifies whether or not an end user can reorder list items. */ - allowItemReordering?: boolean; - /** Specifies whether or not to show the loading panel when the DataSource bound to the widget is loading data. */ - indicateLoading?: boolean; - activeStateEnabled?: boolean; - } - /** A list widget. */ - export class dxList extends CollectionWidget { - constructor(element: JQuery, options?: dxListOptions); - constructor(element: Element, options?: dxListOptions); - /** Returns the height of the widget in pixels. */ - clientHeight(): number; - /** Removes the specified item from the list. */ - deleteItem(itemIndex: any): JQueryPromise; - /** Removes the specified item from the list. */ - deleteItem(itemElement: Element): JQueryPromise; - /** Returns a Boolean value that indicates whether or not the specified item is selected. */ - isItemSelected(itemIndex: any): boolean; - /** Returns a Boolean value that indicates whether or not the specified item is selected. */ - isItemSelected(itemElement: Element): boolean; - /** Reloads list data. */ - reload(): void; - /** Moves the specified item to the specified position in the list. */ - reorderItem(itemElement: Element, toItemElement: Element): JQueryPromise; - /** Moves the specified item to the specified position in the list. */ - reorderItem(itemIndex: any, toItemIndex: any): JQueryPromise; - /** Scrolls the list content by the specified number of pixels. */ - scrollBy(distance: number): void; - /** Returns the height of the list content in pixels. */ - scrollHeight(): number; - /** Scrolls list content to the specified position. */ - scrollTo(location: number): void; - /** Scrolls the list to the specified item. */ - scrollToItem(itemElement: Element): void; - /** Scrolls the list to the specified item. */ - scrollToItem(itemIndex: any): void; - /** Returns how far the list content is scrolled from the top. */ - scrollTop(): number; - /** Selects the specified item from the list. */ - selectItem(itemElement: Element): void; - /** Selects the specified item from the list. */ - selectItem(itemIndex: any): void; - /** Deselects the specified item from the list. */ - unselectItem(itemElement: Element): void; - /** Unselects the specified item from the list. */ - unselectItem(itemIndex: any): void; - /** Updates the widget scrollbar according to widget content size. */ - updateDimensions(): JQueryPromise; - /** Expands the specified group. */ - expandGroup(groupIndex: number): JQueryPromise; - /** Collapses the specified group. */ - collapseGroup(groupIndex: number): JQueryPromise; - } - export interface dxGalleryOptions extends CollectionWidgetOptions { - /** The time, in milliseconds, spent on slide animation. */ - animationDuration?: number; - /** Specifies whether or not to animate the displayed item change. */ - animationEnabled?: boolean; - /** A Boolean value specifying whether or not to allow users to switch between items by clicking an indicator. */ - indicatorEnabled?: boolean; - /** A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped. */ - loop?: boolean; - /** The index of the currently active gallery item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to display an indicator that points to the selected gallery item. */ - showIndicator?: boolean; - /** A Boolean value that specifies the availability of the "Forward" and "Back" navigation buttons. */ - showNavButtons?: boolean; - /** The time interval in milliseconds, after which the gallery switches to the next item. */ - slideshowDelay?: number; - /** A Boolean value specifying whether or not to allow users to switch between items by swiping. */ - swipeEnabled?: boolean; - /** Specifies whether or not to display parts of previous and next images along the sides of the current image. */ - wrapAround?: boolean; - /** Specifies if the widget stretches images to fit the total gallery width. */ - stretchImages?: boolean; - /** Specifies the width of an area used to display a single image. */ - initialItemWidth?: number; - } - /** An image gallery widget. */ - export class dxGallery extends CollectionWidget { - constructor(element: JQuery, options?: dxGalleryOptions); - constructor(element: Element, options?: dxGalleryOptions); - /** Shows the specified gallery item. */ - goToItem(itemIndex: number, animation: boolean): JQueryPromise; - /** Shows the next gallery item. */ - nextItem(animation: boolean): JQueryPromise; - /** Shows the previous gallery item. */ - prevItem(animation: boolean): JQueryPromise; - } - export interface dxDropDownEditorOptions extends dxTextBoxOptions { - /** Specifies the current value displayed by the widget. */ - value?: Object; - /** A handler for the closed event. */ - onClosed?: Function; - /** A handler for the opened event. */ - onOpened?: Function; - /** Specifies whether or not the drop-down editor is displayed. */ - opened?: boolean; - /** Specifies whether or not the widget allows an end-user to enter a custom value. */ - fieldEditEnabled?: boolean; - /** Specifies the way an end-user applies the selected value. */ - applyValueMode?: string; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - activeStateEnabled?: boolean; - } - /** A drop-down editor widget. */ - export class dxDropDownEditor extends dxTextBox { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - /** Closes the drop-down editor. */ - close(): void; - /** Opens the drop-down editor. */ - open(): void; - /** Resets the widget's value to null. */ - reset(): void; - /** Returns an <input> element of the widget. */ - field(): JQuery; - /** Returns an HTML element of the popup window content. */ - content(): JQuery; - } - export interface dxDateBoxOptions extends dxTextEditorOptions { - /** A format used to display date/time information. */ - format?: string; - /** A Globalize format string specifying the date display format. */ - formatString?: string; - /** The last date that can be selected within the widget. */ - max?: any; - /** The minimum date that can be selected within the widget. */ - min?: any; - /** The text displayed by the widget when the widget value is not yet specified. This text is also used as a title of the date picker. */ - placeholder?: string; - /** - * Specifies whether or not a user can pick out a date using the drop-down calendar. - * @deprecated Use 'pickerType' option instead. - */ - useCalendar?: boolean; - /** An object or a value, specifying the date and time currently selected using the date box. */ - value?: any; - /** - * Specifies whether or not the widget uses the native HTML input element. - * @deprecated Use 'pickerType' option instead. - */ - useNative?: boolean; - /** Specifies the interval between neighboring values in the popup list in minutes. */ - interval?: number; - /** Specifies the maximum zoom level of a calendar, which is used to pick the date. */ - maxZoomLevel?: string; - /** Specifies the minimal zoom level of a calendar, which is used to pick the date. */ - minZoomLevel?: string; - /** Specifies the type of date/time picker. */ - pickerType?: string; - /** Specifies the message displayed if the typed value is not a valid date or time. */ - invalidDateMessage?: string; - /** Specifies the message displayed if the specified date is later than the max value or earlier than the min value. */ - dateOutOfRangeMessage?: string; - /** The text displayed on the Apply button. */ - applyButtonText?: string; - /** The text displayed on the Cancel button. */ - cancelButtonText?: string; - } - /** A date box widget. */ - export class dxDateBox extends dxDropDownEditor { - constructor(element: JQuery, options?: dxDateBoxOptions); - constructor(element: Element, options?: dxDateBoxOptions); - } - export interface dxCheckBoxOptions extends EditorOptions { - activeStateEnabled?: boolean; - /** Specifies the widget state. */ - value?: boolean; - /** Specifies the text displayed by the check box. */ - text?: string; - } - /** A check box widget. */ - export class dxCheckBox extends Editor { - constructor(element: JQuery, options?: dxCheckBoxOptions); - constructor(element: Element, options?: dxCheckBoxOptions); - } - export interface dxCalendarOptions extends EditorOptions { - activeStateEnabled?: boolean; - /** Specifies a date displayed on the current calendar page. */ - currentDate?: Date; - /** Specifies the first day of a week. */ - firstDayOfWeek?: number; - /** The latest date the widget allows to select. */ - max?: Date; - /** The earliest date the widget allows to select. */ - min?: Date; - /** Specifies whether or not the widget displays a button that selects the current date. */ - showTodayButton?: boolean; - /** Specifies the current calendar zoom level. */ - zoomLevel?: string; - /** Specifies the maximum zoom level of the calendar. */ - maxZoomLevel?: string; - /** Specifies the minimum zoom level of the calendar. */ - minZoomLevel?: string; - /** The template to be used for rendering calendar cells. */ - cellTemplate?: any; - } - /** A calendar widget. */ - export class dxCalendar extends Editor { - constructor(element: JQuery, options?: dxCalendarOptions); - constructor(element: Element, options?: dxCalendarOptions); - } - export interface dxButtonOptions extends WidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A handler for the click event. */ - onClick?: any; - /** Specifies the icon to be displayed on the button. */ - icon?: string; - iconSrc?: string; - /** A template to be used for rendering the dxButton widget. */ - template?: any; - /** The text displayed on the button. */ - text?: string; - /** Specifies the button type. */ - type?: string; - /** Specifies the name of the validation group to be accessed in the click event handler. */ - validationGroup?: string; - } - /** A button widget. */ - export class dxButton extends Widget { - constructor(element: JQuery, options?: dxButtonOptions); - constructor(element: Element, options?: dxButtonOptions); - } - export interface dxBoxOptions extends CollectionWidget { - /** Specifies how widget items are aligned along the main direction. */ - align?: string; - /** Specifies the direction of item positioning in the widget. */ - direction?: string; - /** Specifies how widget items are aligned cross-wise. */ - crossAlign?: string; - } - /** A container widget used to arrange inner elements. */ - export class dxBox extends CollectionWidget { - constructor(element: JQuery, options?: dxBoxOptions); - constructor(element: Element, options?: dxBoxOptions); - } - export interface dxResponsiveBoxOptions extends CollectionWidgetOptions { - /** Specifies the collection of rows for the grid used to position layout elements. */ - rows?: Array; - /** Specifies the collection of columns for the grid used to position layout elements. */ - cols?: Array; - /** Specifies the function returning the screen factor depending on the screen width. */ - screenByWidth?: (width: number) => string; - /** Specifies the screen factor with which all elements are located in a single column. */ - singleColumnScreen?: string; - } - /** A widget used to build an adaptive markup that is dependent on screen resolution. */ - export class dxResponsiveBox extends CollectionWidget { - constructor(element: JQuery, options?: dxBoxOptions); - constructor(element: Element, options?: dxBoxOptions); - } - export interface dxAutocompleteOptions extends dxDropDownListOptions { - /** Specifies the current value displayed by the widget. */ - value?: string; - /** The minimum number of characters that must be entered into the text box to begin a search. */ - minSearchLength?: number; - /** Specifies the maximum count of items displayed by the widget. */ - maxItemCount?: number; - /** Gets the currently selected item. */ - selectedItem?: Object; - } - /** A textbox widget that supports autocompletion. */ - export class dxAutocomplete extends dxDropDownList { - constructor(element: JQuery, options?: dxAutocompleteOptions); - constructor(element: Element, options?: dxAutocompleteOptions); - /** Opens the drop-down editor. */ - open(): void; - /** Closes the drop-down editor. */ - close(): void; - } - export interface dxAccordionOptions extends CollectionWidgetOptions { - /** A number specifying the time in milliseconds spent on the animation of the expanding or collapsing of a panel. */ - animationDuration?: number; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies whether all items can be collapsed or whether at least one item must always be expanded. */ - collapsible?: boolean; - /** Specifies whether the widget can expand several items or only a single item at once. */ - multiple?: boolean; - /** The template to be used for rendering dxAccordion items. */ - itemTemplate?: any; - /** A handler for the itemTitleClick event. */ - onItemTitleClick?: any; - /** A handler for the itemTitleHold event. */ - onItemTitleHold?: Function; - /** The template to be used for rendering an item title. */ - itemTitleTemplate?: any; - /** The index number of the currently selected item. */ - selectedIndex?: number; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - } - /** A widget that displays data source items on collapsible panels. */ - export class dxAccordion extends CollectionWidget { - constructor(element: JQuery, options?: dxAccordionOptions); - constructor(element: Element, options?: dxAccordionOptions); - /** Collapses the specified item. */ - collapseItem(index: number): JQueryPromise; - /** Expands the specified item. */ - expandItem(index: number): JQueryPromise; - /** Updates the dimensions of the widget contents. */ - updateDimensions(): JQueryPromise; - } - export interface dxFileUploaderOptions extends EditorOptions { - /** A read-only option that holds a File instance representing the selected file. */ - value?: File; - /** Holds the File instances representing files selected in the widget. */ - values?: Array; - buttonText?: string; - /** The text displayed on the button that opens the file browser. */ - selectButtonText?: string; - /** The text displayed on the button that starts uploading. */ - uploadButtonText?: string; - /** Specifies the text displayed on the area to which an end-user can drop a file. */ - labelText?: string; - /** Specifies the value passed to the name attribute of the underlying input element. */ - name?: string; - /** Specifies whether the widget enables an end-user to select a single file or multiple files. */ - multiple?: boolean; - /** Specifies a file type or several types accepted by the widget. */ - accept?: string; - /** Specifies a target Url for the upload request. */ - uploadUrl?: string; - /** Specifies if an end user can remove a file from the selection and interrupt uploading. */ - allowCanceling?: boolean; - /** Specifies whether or not the widget displays the list of selected files. */ - showFileList?: boolean; - /** Gets the current progress in percentages. */ - progress?: number; - /** The message displayed by the widget when it is ready to upload the specified files. */ - readyToUploadMessage?: string; - /** The message displayed by the widget when uploading is finished. */ - uploadedMessage?: string; - /** The message displayed by the widget on uploading failure. */ - uploadFailedMessage?: string; - /** Specifies how the widget uploads files. */ - uploadMode?: string; - /** A handler for the uploaded event. */ - onUploaded?: Function; - /** A handler for the uploaded event. */ - onProgress?: Function; - /** A handler for the uploadError event. */ - onUploadError?: Function; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - } - /** A widget used to select and upload a file or multiple files. */ - export class dxFileUploader extends Editor { - constructor(element: JQuery, options?: dxFileUploaderOptions); - constructor(element: Element, options?: dxFileUploaderOptions); - } - export interface dxTrackBarOptions extends EditorOptions { - /** The minimum value the widget can accept. */ - min?: number; - /** The maximum value the widget can accept. */ - max?: number; - /** The current widget value. */ - value?: number; - } - /** A base class for track bar widgets. */ - export class dxTrackBar extends Editor { - constructor(element: JQuery, options?: dxTrackBarOptions); - constructor(element: Element, options?: dxTrackBarOptions); - } - export interface dxProgressBarOptions extends dxTrackBarOptions { - /** Specifies a format for the progress status. */ - statusFormat?: any; - /** Specifies whether or not the widget displays a progress status. */ - showStatus?: boolean; - /** A handler for the complete event. */ - onComplete?: Function; - } - /** A widget used to indicate progress. */ - export class dxProgressBar extends dxTrackBar { - constructor(element: JQuery, options?: dxProgressBarOptions); - constructor(element: Element, options?: dxProgressBarOptions); - } - export interface dxSliderOptions extends dxTrackBarOptions { - activeStateEnabled?: boolean; - /** The slider step size. */ - step?: number; - /** The current slider value. */ - value?: number; - /** Specifies whether or not to highlight a range selected within the widget. */ - showRange?: boolean; - /** Specifies the size of a step by which a slider handle is moved when a user uses the Page up or Page down keyboard shortcuts. */ - keyStep?: number; - /** Specifies options for the slider tooltip. */ - tooltip?: { - /** Specifies whether or not the tooltip is enabled. */ - enabled?: boolean; - /** Specifies format for the tooltip. */ - format?: any; - /** Specifies whether the tooltip is located over or under the slider. */ - position?: string; - /** Specifies whether the widget always shows a tooltip or only when a pointer is over the slider. */ - showMode?: string; - }; - /** Specifies options for labels displayed at the min and max values. */ - label?: { - /** Specifies whether or not slider labels are visible. */ - visible?: boolean; - /** Specifies whether labels are located over or under the scale. */ - position?: string; - /** Specifies a format for labels. */ - format?: any; - }; - } - /** A widget that allows a user to select a numeric value within a given range. */ - export class dxSlider extends dxTrackBar { - constructor(element: JQuery, options?: dxSliderOptions); - constructor(element: Element, options?: dxSliderOptions); - } - export interface dxRangeSliderOptions extends dxSliderOptions { - /** The left edge of the interval currently selected using the range slider. */ - start?: number; - /** The right edge of the interval currently selected using the range slider. */ - end?: number; - } - /** A widget that enables a user to select a range of numeric values. */ - export class dxRangeSlider extends dxSlider { - constructor(element: JQuery, options?: dxRangeSliderOptions); - constructor(element: Element, options?: dxRangeSliderOptions); - } - export interface dxFormItemLabel { - /** Specifies the label text. */ - text?: string; - /** Specifies whether or not the label is visible. */ - visible?: boolean; - /** Specifies whether or not a colon is displayed at the end of the current label. */ - showColon?: boolean; - /** Specifies the location of a label against the editor. */ - location?: string; - /** Specifies the label horizontal alignment. */ - alignment?: string; - } - export interface dxFormItem { - /** Specifies the type of the current item. */ - itemType?: string; - /** Specifies whether or not the current form item is visible. */ - visible?: boolean; - /** Specifies the sequence number of the item in a form, group or tab. */ - visibleIndex?: number; - /** Specifies a CSS class to be applied to the form item. */ - cssClass?: string; - /** Specifies the number of columns spanned by the item. */ - colSpan?: number; - } - export interface dxFormEmptyItem extends dxFormItem { - /** Specifies the form item name. */ - name?: string; - } - export interface dxFormSimpleItem extends dxFormItem { - /** Specifies the path to the formData object field bound to the current form item. */ - dataField?: string; - /** Specifies the form item name. */ - name?: string; - /** Specifies which editor widget is used to display and edit the form item value. */ - editorType?: string; - /** Specifies configuration options for the editor widget of the current form item. */ - editorOptions?: Object; - /** A template to be used for rendering the form item. */ - template?: any; - /** Specifies the help text displayed for the current form item. */ - helpText?: string; - /** Specifies whether the current form item is required. */ - isRequired?: boolean; - /** Specifies options for the form item label. */ - label?: dxFormItemLabel; - /** An array of validation rules to be checked for the form item editor. */ - validationRules?: Array; - } - export interface dxFormGroupItem extends dxFormItem { - /** Specifies the group caption. */ - caption?: string; - /** A template to be used for rendering the group item. */ - template?: any; - /** The count of columns in the group layout. */ - colCount?: number; - /** Specifies whether or not all group item labels are aligned. */ - alignItemLabels?: boolean; - /** Holds an array of form items displayed within the group. */ - items?: Array; - } - export interface dxFormTab { - /** Specifies the tab title. */ - title?: string; - /** The count of columns in the tab layout. */ - colCount?: number; - /** Specifies whether or not labels of items displayed within the current tab are aligned. */ - alignItemLabels?: boolean; - /** Holds an array of form items displayed within the tab. */ - items?: Array; - /** Specifies a badge text for the tab. */ - badge?: string; - /** A Boolean value specifying whether or not the tab can respond to user interaction. */ - disabled?: boolean; - /** Specifies the icon to be displayed on the tab. */ - icon?: string; - /** The template to be used for rendering the tab. */ - tabTemplate?: any; - /** The template to be used for rendering the tab content. */ - template?: any; - } - export interface dxFormTabbedItem extends dxFormItem { - /** Holds a configuration object for the dxTabPanel widget used to display the current form item. */ - tabPanelOptions?: Object; - /** An array of tab configuration objects. */ - tabs?: Array; - } - export interface dxFormOptions extends WidgetOptions { - /** An object providing data for the form. */ - formData?: Object; - /** The count of columns in the form layout. */ - colCount?: any; - /** Specifies the location of a label against the editor. */ - labelLocation?: string; - /** Specifies whether or not all editors on the form are read-only. */ - readOnly?: boolean; - /** A handler for the fieldDataChanged event. */ - onFieldDataChanged?: (e: Object) => void; - /** A handler for the editorEnterKey event. */ - onEditorEnterKey?: (e: Object) => void; - /** Specifies a function that customizes a form item after it has been created. */ - customizeItem?: Function; - /** The minimum column width used for calculating column count in the form layout. */ - minColWidth?: number; - /** Specifies whether or not all root item labels are aligned. */ - alignItemLabels?: boolean; - /** Specifies whether or not item labels in all groups are aligned. */ - alignItemLabelsInAllGroups?: boolean; - /** Specifies whether or not a colon is displayed at the end of form labels. */ - showColonAfterLabel?: boolean; - /** Specifies whether or not the required mark is displayed for required fields. */ - showRequiredMark?: boolean; - /** Specifies whether or not the optional mark is displayed for optional fields. */ - showOptionalMark?: boolean; - /** The text displayed for required fields. */ - requiredMark?: string; - /** The text displayed for optional fields. */ - optionalMark?: string; - /** Specifies the message that is shown for end-users a required field value is not specified. */ - requiredMessage?: string; - /** Specifies whether or not the total validation summary is displayed on the form. */ - showValidationSummary?: boolean; - /** Holds an array of form items. */ - items?: Array; - /** A Boolean value specifying whether to enable or disable form scrolling. */ - scrollingEnabled?: boolean; - onContentReady?: Function; - } - /** A form widget used to display and edit values of object fields. */ - export class dxForm extends Widget { - constructor(element: JQuery, options?: dxFormOptions); - constructor(element: Element, options?: dxFormOptions); - /** Updates the specified field of the formData object and the corresponding editor on the form. */ - updateData(dataField: string, value: any): void; - /** Updates the specified fields of the formData object and the corresponding editors on the form. */ - updateData(data: Object): void; - /** Updates the value of a form item option. */ - itemOption(field: string, option: string, value: any): void; - /** Updates the values of form item options. */ - itemOption(field: string, options: Object): void; - /** Returns an editor instance associated with the specified formData field. */ - getEditor(field: string): Object; - /** Updates the dimensions of the widget contents. */ - updateDimensions(): JQueryPromise; - /** Validates the values of all editors on the form against the list of the validation rules specified for each form item. */ - validate(): Object; - } -} -interface JQuery { - dxProgressBar(): JQuery; - dxProgressBar(options: "instance"): DevExpress.ui.dxProgressBar; - dxProgressBar(options: string): any; - dxProgressBar(options: string, ...params: any[]): any; - dxProgressBar(options: DevExpress.ui.dxProgressBarOptions): JQuery; - dxSlider(): JQuery; - dxSlider(options: "instance"): DevExpress.ui.dxSlider; - dxSlider(options: string): any; - dxSlider(options: string, ...params: any[]): any; - dxSlider(options: DevExpress.ui.dxSliderOptions): JQuery; - dxRangeSlider(): JQuery; - dxRangeSlider(options: "instance"): DevExpress.ui.dxRangeSlider; - dxRangeSlider(options: string): any; - dxRangeSlider(options: string, ...params: any[]): any; - dxRangeSlider(options: DevExpress.ui.dxRangeSliderOptions): JQuery; - dxFileUploader(): JQuery; - dxFileUploader(options: "instance"): DevExpress.ui.dxFileUploader; - dxFileUploader(options: string): any; - dxFileUploader(options: string, ...params: any[]): any; - dxFileUploader(options: DevExpress.ui.dxFileUploaderOptions): JQuery; - dxValidator(): JQuery; - dxValidator(options: "instance"): DevExpress.ui.dxValidator; - dxValidator(options: string): any; - dxValidator(options: string, ...params: any[]): any; - dxValidator(options: DevExpress.ui.dxValidatorOptions): JQuery; - dxValidationGroup(): JQuery; - dxValidationGroup(options: "instance"): DevExpress.ui.dxValidationGroup; - dxValidationGroup(options: string): any; - dxValidationGroup(options: string, ...params: any[]): any; - dxValidationSummary(): JQuery; - dxValidationSummary(options: "instance"): DevExpress.ui.dxValidationSummary; - dxValidationSummary(options: string): any; - dxValidationSummary(options: string, ...params: any[]): any; - dxValidationSummary(options: DevExpress.ui.dxValidationSummaryOptions): JQuery; - dxTooltip(): JQuery; - dxTooltip(options: "instance"): DevExpress.ui.dxTooltip; - dxTooltip(options: string): any; - dxTooltip(options: string, ...params: any[]): any; - dxTooltip(options: DevExpress.ui.dxTooltipOptions): JQuery; - dxResizable(): JQuery; - dxResizable(options: "instance"): DevExpress.ui.dxResizable; - dxResizable(options: string): any; - dxResizable(options: string, ...params: any[]): any; - dxResizable(options: DevExpress.ui.dxResizableOptions): JQuery; - dxDropDownList(): JQuery; - dxDropDownList(options: "instance"): DevExpress.ui.dxDropDownList; - dxDropDownList(options: string): any; - dxDropDownList(options: string, ...params: any[]): any; - dxDropDownList(options: DevExpress.ui.dxDropDownListOptions): JQuery; - dxToolbar(): JQuery; - dxToolbar(options: "instance"): DevExpress.ui.dxToolbar; - dxToolbar(options: string): any; - dxToolbar(options: string, ...params: any[]): any; - dxToolbar(options: DevExpress.ui.dxToolbarOptions): JQuery; - dxToast(): JQuery; - dxToast(options: "instance"): DevExpress.ui.dxToast; - dxToast(options: string): any; - dxToast(options: string, ...params: any[]): any; - dxToast(options: DevExpress.ui.dxToastOptions): JQuery; - dxTextEditor(): JQuery; - dxTextEditor(options: "instance"): DevExpress.ui.dxTextEditor; - dxTextEditor(options: string): any; - dxTextEditor(options: string, ...params: any[]): any; - dxTextEditor(options: DevExpress.ui.dxTextEditorOptions): JQuery; - dxTextBox(): JQuery; - dxTextBox(options: "instance"): DevExpress.ui.dxTextBox; - dxTextBox(options: string): any; - dxTextBox(options: string, ...params: any[]): any; - dxTextBox(options: DevExpress.ui.dxTextBoxOptions): JQuery; - dxTextArea(): JQuery; - dxTextArea(options: "instance"): DevExpress.ui.dxTextArea; - dxTextArea(options: string): any; - dxTextArea(options: string, ...params: any[]): any; - dxTextArea(options: DevExpress.ui.dxTextAreaOptions): JQuery; - dxTabs(): JQuery; - dxTabs(options: "instance"): DevExpress.ui.dxTabs; - dxTabs(options: string): any; - dxTabs(options: string, ...params: any[]): any; - dxTabs(options: DevExpress.ui.dxTabsOptions): JQuery; - dxTabPanel(): JQuery; - dxTabPanel(options: "instance"): DevExpress.ui.dxTabPanel; - dxTabPanel(options: string): any; - dxTabPanel(options: string, ...params: any[]): any; - dxTabPanel(options: DevExpress.ui.dxTabPanelOptions): JQuery; - dxSelectBox(): JQuery; - dxSelectBox(options: "instance"): DevExpress.ui.dxSelectBox; - dxSelectBox(options: string): any; - dxSelectBox(options: string, ...params: any[]): any; - dxSelectBox(options: DevExpress.ui.dxSelectBoxOptions): JQuery; - dxTagBox(): JQuery; - dxTagBox(options: "instance"): DevExpress.ui.dxTagBox; - dxTagBox(options: string): any; - dxTagBox(options: string, ...params: any[]): any; - dxTagBox(options: DevExpress.ui.dxTagBoxOptions): JQuery; - dxScrollView(): JQuery; - dxScrollView(options: "instance"): DevExpress.ui.dxScrollView; - dxScrollView(options: string): any; - dxScrollView(options: string, ...params: any[]): any; - dxScrollView(options: DevExpress.ui.dxScrollViewOptions): JQuery; - dxScrollable(): JQuery; - dxScrollable(options: "instance"): DevExpress.ui.dxScrollable; - dxScrollable(options: string): any; - dxScrollable(options: string, ...params: any[]): any; - dxScrollable(options: DevExpress.ui.dxScrollableOptions): JQuery; - dxRadioGroup(): JQuery; - dxRadioGroup(options: "instance"): DevExpress.ui.dxRadioGroup; - dxRadioGroup(options: string): any; - dxRadioGroup(options: string, ...params: any[]): any; - dxRadioGroup(options: DevExpress.ui.dxRadioGroupOptions): JQuery; - dxPopup(): JQuery; - dxPopup(options: "instance"): DevExpress.ui.dxPopup; - dxPopup(options: string): any; - dxPopup(options: string, ...params: any[]): any; - dxPopup(options: DevExpress.ui.dxPopupOptions): JQuery; - dxPopover(): JQuery; - dxPopover(options: "instance"): DevExpress.ui.dxPopover; - dxPopover(options: string): any; - dxPopover(options: string, ...params: any[]): any; - dxPopover(options: DevExpress.ui.dxPopoverOptions): JQuery; - dxOverlay(): JQuery; - dxOverlay(options: "instance"): DevExpress.ui.dxOverlay; - dxOverlay(options: string): any; - dxOverlay(options: string, ...params: any[]): any; - dxOverlay(options: DevExpress.ui.dxOverlayOptions): JQuery; - dxNumberBox(): JQuery; - dxNumberBox(options: "instance"): DevExpress.ui.dxNumberBox; - dxNumberBox(options: string): any; - dxNumberBox(options: string, ...params: any[]): any; - dxNumberBox(options: DevExpress.ui.dxNumberBoxOptions): JQuery; - dxNavBar(): JQuery; - dxNavBar(options: "instance"): DevExpress.ui.dxNavBar; - dxNavBar(options: string): any; - dxNavBar(options: string, ...params: any[]): any; - dxNavBar(options: DevExpress.ui.dxNavBarOptions): JQuery; - dxMultiView(): JQuery; - dxMultiView(options: "instance"): DevExpress.ui.dxMultiView; - dxMultiView(options: string): any; - dxMultiView(options: string, ...params: any[]): any; - dxMultiView(options: DevExpress.ui.dxMultiViewOptions): JQuery; - dxMap(): JQuery; - dxMap(options: "instance"): DevExpress.ui.dxMap; - dxMap(options: string): any; - dxMap(options: string, ...params: any[]): any; - dxMap(options: DevExpress.ui.dxMapOptions): JQuery; - dxLookup(): JQuery; - dxLookup(options: "instance"): DevExpress.ui.dxLookup; - dxLookup(options: string): any; - dxLookup(options: string, ...params: any[]): any; - dxLookup(options: DevExpress.ui.dxLookupOptions): JQuery; - dxLoadPanel(): JQuery; - dxLoadPanel(options: "instance"): DevExpress.ui.dxLoadPanel; - dxLoadPanel(options: string): any; - dxLoadPanel(options: string, ...params: any[]): any; - dxLoadPanel(options: DevExpress.ui.dxLoadPanelOptions): JQuery; - dxLoadIndicator(): JQuery; - dxLoadIndicator(options: "instance"): DevExpress.ui.dxLoadIndicator; - dxLoadIndicator(options: string): any; - dxLoadIndicator(options: string, ...params: any[]): any; - dxLoadIndicator(options: DevExpress.ui.dxLoadIndicatorOptions): JQuery; - dxList(): JQuery; - dxList(options: "instance"): DevExpress.ui.dxList; - dxList(options: string): any; - dxList(options: string, ...params: any[]): any; - dxList(options: DevExpress.ui.dxListOptions): JQuery; - dxGallery(): JQuery; - dxGallery(options: "instance"): DevExpress.ui.dxGallery; - dxGallery(options: string): any; - dxGallery(options: string, ...params: any[]): any; - dxGallery(options: DevExpress.ui.dxGalleryOptions): JQuery; - dxDropDownEditor(): JQuery; - dxDropDownEditor(options: "instance"): DevExpress.ui.dxDropDownEditor; - dxDropDownEditor(options: string): any; - dxDropDownEditor(options: string, ...params: any[]): any; - dxDropDownEditor(options: DevExpress.ui.dxDropDownEditorOptions): JQuery; - dxDateBox(): JQuery; - dxDateBox(options: "instance"): DevExpress.ui.dxDateBox; - dxDateBox(options: string): any; - dxDateBox(options: string, ...params: any[]): any; - dxDateBox(options: DevExpress.ui.dxDateBoxOptions): JQuery; - dxCheckBox(): JQuery; - dxCheckBox(options: "instance"): DevExpress.ui.dxCheckBox; - dxCheckBox(options: string): any; - dxCheckBox(options: string, ...params: any[]): any; - dxCheckBox(options: DevExpress.ui.dxCheckBoxOptions): JQuery; - dxBox(): JQuery; - dxBox(options: "instance"): DevExpress.ui.dxBox; - dxBox(options: string): any; - dxBox(options: string, ...params: any[]): any; - dxBox(options: DevExpress.ui.dxBoxOptions): JQuery; - dxButton(): JQuery; - dxButton(options: "instance"): DevExpress.ui.dxButton; - dxButton(options: string): any; - dxButton(options: string, ...params: any[]): any; - dxButton(options: DevExpress.ui.dxButtonOptions): JQuery; - dxCalendar(): JQuery; - dxCalendar(options: "instance"): DevExpress.ui.dxCalendar; - dxCalendar(options: string): any; - dxCalendar(options: string, ...params: any[]): any; - dxCalendar(options: DevExpress.ui.dxCalendarOptions): JQuery; - dxAccordion(): JQuery; - dxAccordion(options: "instance"): DevExpress.ui.dxAccordion; - dxAccordion(options: string): any; - dxAccordion(options: string, ...params: any[]): any; - dxAccordion(options: DevExpress.ui.dxAccordionOptions): JQuery; - dxResponsiveBox(): JQuery; - dxResponsiveBox(options: "instance"): DevExpress.ui.dxResponsiveBox; - dxResponsiveBox(options: string): any; - dxResponsiveBox(options: string, ...params: any[]): any; - dxResponsiveBox(options: DevExpress.ui.dxResponsiveBoxOptions): JQuery; - dxAutocomplete(): JQuery; - dxAutocomplete(options: "instance"): DevExpress.ui.dxAutocomplete; - dxAutocomplete(options: string): any; - dxAutocomplete(options: string, ...params: any[]): any; - dxAutocomplete(options: DevExpress.ui.dxAutocompleteOptions): JQuery; - dxForm(): JQuery; - dxForm(options: "instance"): DevExpress.ui.dxForm; - dxForm(options: string): any; - dxForm(options: string, ...params: any[]): any; - dxForm(options: DevExpress.ui.dxForm): JQuery; -} - -declare namespace DevExpress.ui { - export interface dxTileViewOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** Specifies the height of the base tile view item. */ - baseItemHeight?: number; - /** Specifies the width of the base tile view item. */ - baseItemWidth?: number; - /** Specifies whether tiles are placed horizontally or vertically. */ - direction?: string; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies the distance in pixels between adjacent tiles. */ - itemMargin?: number; - /** A Boolean value specifying whether or not to display a scrollbar. */ - showScrollbar?: boolean; - } - /** A widget displaying several blocks of data as tiles. */ - export class dxTileView extends CollectionWidget { - constructor(element: JQuery, options?: dxTileViewOptions); - constructor(element: Element, options?: dxTileViewOptions); - /** Returns the current scroll position of the widget content. */ - scrollPosition(): number; - } - export interface dxSwitchOptions extends EditorOptions { - activeStateEnabled?: boolean; - /** Text displayed when the widget is in a disabled state. */ - offText?: string; - /** Text displayed when the widget is in an enabled state. */ - onText?: string; - /** A Boolean value specifying whether the current switch state is "On" or "Off". */ - value?: boolean; - } - /** A switch widget. */ - export class dxSwitch extends Editor { - constructor(element: JQuery, options?: dxSwitchOptions); - constructor(element: Element, options?: dxSwitchOptions); - } - export interface dxSlideOutViewOptions extends WidgetOptions { - /** Specifies the current menu position. */ - menuPosition?: string; - /** Specifies whether or not the menu panel is visible. */ - menuVisible?: boolean; - /** Specifies whether or not the menu is shown when a user swipes the widget content. */ - swipeEnabled?: boolean; - /** A template to be used for rendering menu panel content. */ - menuTemplate?: any; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - } - /** The widget that allows you to slide-out the current view to reveal a custom menu. */ - export class dxSlideOutView extends Widget { - constructor(element: JQuery, options?: dxSlideOutViewOptions); - constructor(element: Element, options?: dxSlideOutViewOptions); - /** Returns an HTML element of the widget menu block. */ - menuContent(): JQuery; - /** Returns an HTML element of the widget content block. */ - content(): JQuery; - /** Displays the widget's menu block. */ - showMenu(): JQueryPromise; - /** Hides the widget's menu block. */ - hideMenu(): JQueryPromise; - /** Toggles the visibility of the widget's menu block. */ - toggleMenuVisibility(): JQueryPromise; - } - export interface dxSlideOutOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A Boolean value specifying whether or not to display a grouped menu. */ - menuGrouped?: boolean; - /** Specifies the current menu position. */ - menuPosition?: string; - /** The name of the template used to display a group header. */ - menuGroupTemplate?: any; - /** The template used to render menu items. */ - menuItemTemplate?: any; - /** A handler for the menuGroupRendered event. */ - onMenuGroupRendered?: Function; - /** A handler for the menuItemRendered event. */ - onMenuItemRendered?: Function; - /** Specifies whether or not the slide-out menu is displayed. */ - menuVisible?: boolean; - /** Indicates whether the menu can be shown/hidden by swiping the widget's main panel. */ - swipeEnabled?: boolean; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - } - /** The widget that allows you to slide-out the current view to reveal an item list. */ - export class dxSlideOut extends CollectionWidget { - constructor(element: JQuery, options?: dxSlideOutOptions); - constructor(element: Element, options?: dxSlideOutOptions); - /** Hides the widget's slide-out menu. */ - hideMenu(): JQueryPromise; - /** Displays the widget's slide-out menu. */ - showMenu(): JQueryPromise; - /** Toggles the visibility of the widget's slide-out menu. */ - toggleMenuVisibility(showing: boolean): JQueryPromise; - } - export interface dxPivotOptions extends CollectionWidgetOptions { - /** The index of the currently active pivot item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to allow users to switch between items by swiping. */ - swipeEnabled?: boolean; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - /** The template to be used for rendering an item title. */ - itemTitleTemplate?: any; - } - /** A widget that is similar to a traditional tab control, but optimized for the phone with simplified end-user interaction. */ - export class dxPivot extends CollectionWidget { - constructor(element: JQuery, options?: dxPivotOptions); - constructor(element: Element, options?: dxPivotOptions); - } - export interface dxPanoramaOptions extends CollectionWidgetOptions { - /** An object exposing options for setting a background image for the panorama. */ - backgroundImage?: { - /** Specifies the height of the panorama's background image. */ - height?: number; - /** Specifies the URL of the image that is used as the panorama's background image. */ - url?: string; - /** Specifies the width of the panorama's background image. */ - width?: number; - }; - /** The index of the currently active panorama item. */ - selectedIndex?: number; - /** Specifies the widget content title. */ - title?: string; - } - /** A widget displaying the required content in a long horizontal canvas that extends beyond the frames of the screen. */ - export class dxPanorama extends CollectionWidget { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - } - export interface dxDropDownMenuOptions extends WidgetOptions { - /** A handler for the buttonClick event. */ - onButtonClick?: any; - /** The name of the icon to be displayed by the DropDownMenu button. */ - buttonIcon?: string; - /** The text displayed in the DropDownMenu button. */ - buttonText?: string; - buttonIconSrc?: string; - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** A handler for the itemClick event. */ - onItemClick?: any; - /** An array of items displayed by the widget. */ - items?: Array; - /** The template to be used for rendering items. */ - itemTemplate?: any; - /** Specifies whether or not to show the drop down menu within a dxPopover widget. */ - usePopover?: boolean; - /** The width of the menu popup in pixels. */ - popupWidth?: any; - /** The height of the menu popup in pixels. */ - popupHeight?: any; - /** Specifies whether or not the drop-down menu is displayed. */ - opened?: boolean; - hoverStateEnabled?: boolean; - activeStateEnabled?: boolean; - } - /** A drop-down menu widget. */ - export class dxDropDownMenu extends Widget { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - /** This section lists the data source fields that are used in a default template for drop-down menu items. */ - /** Opens the drop-down menu. */ - open(): void; - /** Closes the drop-down menu. */ - close(): void; - } - export interface dxActionSheetOptions extends CollectionWidgetOptions { - /** A handler for the cancelClick event. */ - onCancelClick?: any; - /** The text displayed in the button that closes the action sheet. */ - cancelText?: string; - /** Specifies whether or not to display the Cancel button in action sheet. */ - showCancelButton?: boolean; - /** A Boolean value specifying whether or not the title of the action sheet is visible. */ - showTitle?: boolean; - /** Specifies the element the action sheet popover points at. */ - target?: any; - /** The title of the action sheet. */ - title?: string; - /** Specifies whether or not to show the action sheet within a dxPopover widget. */ - usePopover?: boolean; - /** A Boolean value specifying whether or not the dxActionSheet widget is visible. */ - visible?: boolean; - } - /** A widget consisting of a set of choices related to a certain task. */ - export class dxActionSheet extends CollectionWidget { - constructor(element: JQuery, options?: dxActionSheetOptions); - constructor(element: Element, options?: dxActionSheetOptions); - /** Hides the widget. */ - hide(): JQueryPromise; - /** Shows the widget. */ - show(): JQueryPromise; - /** Shows or hides the widget depending on the Boolean value passed as the parameter. */ - toggle(showing: boolean): JQueryPromise; - } -} -interface JQuery { - dxTileView(): JQuery; - dxTileView(options: "instance"): DevExpress.ui.dxTileView; - dxTileView(options: string): any; - dxTileView(options: string, ...params: any[]): any; - dxTileView(options: DevExpress.ui.dxTileViewOptions): JQuery; - dxSwitch(): JQuery; - dxSwitch(options: "instance"): DevExpress.ui.dxSwitch; - dxSwitch(options: string): any; - dxSwitch(options: string, ...params: any[]): any; - dxSwitch(options: DevExpress.ui.dxSwitchOptions): JQuery; - dxSlideOut(): JQuery; - dxSlideOut(options: "instance"): DevExpress.ui.dxSlideOut; - dxSlideOut(options: string): any; - dxSlideOut(options: string, ...params: any[]): any; - dxSlideOut(options: DevExpress.ui.dxSlideOutOptions): JQuery; - dxPivot(): JQuery; - dxPivot(options: "instance"): DevExpress.ui.dxPivot; - dxPivot(options: string): any; - dxPivot(options: string, ...params: any[]): any; - dxPivot(options: DevExpress.ui.dxPivotOptions): JQuery; - dxPanorama(): JQuery; - dxPanorama(options: "instance"): DevExpress.ui.dxPanorama; - dxPanorama(options: string): any; - dxPanorama(options: string, ...params: any[]): any; - dxPanorama(options: DevExpress.ui.dxPanoramaOptions): JQuery; - dxActionSheet(): JQuery; - dxActionSheet(options: "instance"): DevExpress.ui.dxActionSheet; - dxActionSheet(options: string): any; - dxActionSheet(options: string, ...params: any[]): any; - dxActionSheet(options: DevExpress.ui.dxActionSheetOptions): JQuery; - dxDropDownMenu(): JQuery; - dxDropDownMenu(options: "instance"): DevExpress.ui.dxDropDownMenu; - dxDropDownMenu(options: string): any; - dxDropDownMenu(options: string, ...params: any[]): any; - dxDropDownMenu(options: DevExpress.ui.dxDropDownMenuOptions): JQuery; -} -declare namespace DevExpress.data { - export interface XmlaStoreOptions { - /** The HTTP address to an XMLA OLAP server. */ - url?: string; - /** The name of the database associated with the Store. */ - catalog?: string; - /** The cube name. */ - cube?: string; - /** A function used to customize a web request before it is sent. */ - beforeSend?: (request: Object) => void; - } - /** A Store that provides access to an OLAP cube using the XMLA standard. */ - export class XmlaStore { - constructor(options: XmlaStoreOptions); - } - export interface PivotGridField { - index?: number; - /** A boolean value specifying whether or not the field is visible in the pivot grid and the Field Chooser. */ - visible?: boolean; - /** Name of the data source field containing data for the pivot grid field. */ - dataField?: string; - /** A caption that will be displayed in the pivot grid's field chooser to identify the field. */ - caption?: string; - /** Specifies a type of field values. */ - dataType?: string; - /** Specifies how the values of the current field are combined into groups. Cannot be used for the XmlaStore store type. */ - groupInterval?: any; - /** Specifies how to aggregate field data. Cannot be used for the XmlaStore store type. */ - summaryType?: string; - /** Allows you to use a custom aggregate function to calculate the summary values. Cannot be used for the XmlaStore store type. */ - calculateCustomSummary?: (options: { - summaryProcess?: string; - value?: any; - totalValue?: any; - }) => void; - /** Specifies the function that determines how to split data from the data source into ranges for header items. Cannot be used for the XmlaStore store type. */ - selector?: (data: Object) => any; - /** Type of the area where the field is located. */ - area?: string; - /** Index among the other fields displayed within the same area. */ - areaIndex?: number; - /** The name of the folder in which the field is located. */ - displayFolder?: string; - /** The name of the group to which the field belongs. */ - groupName?: string; - /** The index of the field within a group. */ - groupIndex?: number; - /** Specifies the initial sort order of field values. */ - sortOrder?: string; - /** Specifies how field data should be sorted. Can be used for the XmlaStore store type only. */ - sortBy?: string; - /** Specifies the data field against which the header items of this field should be sorted. */ - sortBySummaryField?: string; - /** The array of field names that specify a path to column/row whose summary field is used for sorting of this field's header items. */ - sortBySummaryPath?: Array; - /** The filter values for the current field. */ - filterValues?: Array; - /** The filter type for the current field. */ - filterType?: string; - /** Indicates whether all header items of the field's header level are expanded. */ - expanded?: boolean; - /** Specifies whether the field should be treated as a Data Field. */ - isMeasure?: boolean; - /** Specifies a display format for field values. */ - format?: string; - /** Specifies a callback function that returns the text to be displayed in the cells of a field. */ - customizeText?: (cellInfo: { value: any; valueText: string }) => string; - /** Specifies a precision for formatted field values. */ - precision?: number; - /** Specifies how to sort the header items. */ - sortingMethod?: (a: Object, b: Object) => number; - /** Allows an end-user to change sorting options. */ - allowSorting?: boolean; - /** Allows an end-user to sort columns by summary values. */ - allowSortingBySummary?: boolean; - /** Allows an end-user to change filtering options. */ - allowFiltering?: boolean; - /** Allows an end-user to expand/collapse all header items within a header level. */ - allowExpandAll?: boolean; - /** Specifies the absolute width of the field in the pivot grid. */ - width?: number; - /** Specifies the summary post-processing algorithm. */ - summaryDisplayMode?: string; - /** Specifies whether to summarize each next summary value with the previous one by rows or columns. */ - runningTotal?: string; - /** Specifies whether to allow the predefined summary post-processing functions ('absoluteVariation' and 'percentVariation') and runningTotal to take values of different groups into account. */ - allowCrossGroupCalculation?: boolean; - /** Specifies a callback function that allows you to modify summary values after they are calculated. */ - calculateSummaryValue?: (e: Object) => number; - /** Specifies whether or not to display Total values for the field. */ - showTotals?: boolean; - /** Specifies whether or not to display Grand Total values for the field. */ - showGrandTotals?: boolean; - } - export class SummaryCell { - /** Gets the parent cell in a specified direction. */ - parent(direction: string): SummaryCell; - /** Gets all children cells in a specified direction. */ - children(direction: string): Array; - /** Gets a partial Grand Total cell of a row or column. */ - grandTotal(direction: string): SummaryCell; - /** Gets the Grand Total of the entire pivot grid. */ - grandTotal(): SummaryCell; - /** Gets the cell next to the current one in a specified direction. */ - next(direction: string): SummaryCell; - /** Gets the cell next to current in a specified direction. */ - next(direction: string, allowCrossGroup: boolean): SummaryCell; - /** Gets the cell prior to the current one in a specified direction. */ - prev(direction: string): SummaryCell; - /** Gets the cell previous to current in a specified direction. */ - prev(direction: string, allowCrossGroup: boolean): SummaryCell; - /** Gets the child cell in a specified direction. */ - child(direction: string, fieldValue: any): SummaryCell; - /** Gets the cell located by the path of the source cell with one field value changed. */ - slice(field: PivotGridField, value: any): SummaryCell; - /** Gets the header cell of a row or column field to which the current cell belongs. */ - field(area: string): PivotGridField; - /** Gets the value of the current cell. */ - value(): any; - /** Gets the value of the current cell. */ - value(isCalculatedValue: boolean): any; - /** Gets the value of any field linked with the current cell. */ - value(field: PivotGridField): any; - /** Gets the value of any field linked with the current cell. */ - value(field: PivotGridField, isCalculatedValue: boolean): any; - } - export interface PivotGridDataSourceOptions { - /** Specifies the underlying Store instance used to access data. */ - store?: any; - /** Indicates whether or not the automatic field generation from data in the Store is enabled. */ - retrieveFields?: boolean; - /** Specifies data filtering conditions. Cannot be used for the XmlaStore store type. */ - filter?: Object; - /** An array of pivot grid fields. */ - fields?: Array; - /** A handler for the changed event. */ - onChanged?: () => void; - /** A handler for the loadingChanged event. */ - onLoadingChanged?: (isLoading: boolean) => void; - /** A handler for the loadError event. */ - onLoadError?: (e?: Object) => void; - /** A handler for the fieldsPrepared event. */ - onFieldsPrepared?: (e?: Array) => void; - } - /** An object that provides access to data for the dxPivotGrid widget. */ - export class PivotGridDataSource implements EventsMixin { - constructor(options?: PivotGridDataSource); - /** Starts reloading data from any store and updating the data source. */ - reload(): JQueryPromise; - /** Starts updating the data source. Reloads data from the XMLA store only. */ - load(): JQueryPromise; - /** Indicates whether or not the PivotGridDataSource is currently being loaded. */ - isLoading(): boolean; - /** Gets data displayed in a PivotGrid. */ - getData(): Object; - /** Gets all fields within a specified area. */ - getAreaFields(area: string, collectGroups: boolean): Array; - /** Gets all fields from the data source. */ - fields(): Array; - /** Sets the fields option. */ - fields(fields: Array): void; - /** Gets current options of a specified field. */ - field(id: any): PivotGridField; - /** Sets one or more options of a specified field. */ - field(id: any, field: PivotGridField): void; - /** Collapses a specified header item. */ - collapseHeaderItem(area: string, path: Array): void; - /** Expands a specified header item. */ - expandHeaderItem(area: string, path: Array): void; - /** Expands all header items of a field. */ - expandAll(id: any): void; - /** Collapses all header items of a field. */ - collapseAll(id: any): void; - /** Disposes of all resources associated with this PivotGridDataSource. */ - dispose(): void; - /** Gets the current filter expression. Cannot be used for the XmlaStore store type. */ - filter(): Object; - /** Applies a new filter expression. Cannot be used for the XmlaStore store type. */ - filter(filterExpr: Object): void; - /** Provides access to a list of records (facts) that were used to calculate a specific summary. */ - createDrillDownDataSource(options: { - columnPath?: Array; - rowPath?: Array; - dataIndex?: number; - maxRowCount?: number; - customColumns?: Array; - }): DevExpress.data.DataSource; - /** Gets the current PivotGridDataSource state (fields configuration, sorting, filters, expanded headers, etc.) */ - state(): Object; - /** Sets the PivotGridDataSource state. */ - state(state: Object): void; - on(eventName: string, eventHandler: Function): PivotGridDataSource; - on(events: { [eventName: string]: Function; }): PivotGridDataSource; - off(eventName: string): PivotGridDataSource; - off(eventName: string, eventHandler: Function): PivotGridDataSource; - } -} -declare namespace DevExpress.ui { - export interface dxSchedulerOptions extends WidgetOptions { - /** Specifies a date displayed on the current scheduler view by default. */ - currentDate?: Date; - /** The earliest date the widget allows you to select. */ - min?: Date; - /** The latest date the widget allows you to select. */ - max?: Date; - /** Specifies the view used in the scheduler by default. */ - currentView?: string; - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** Specifies the first day of a week. */ - firstDayOfWeek?: number; - /** The template to be used for rendering appointments. */ - appointmentTemplate?: any; - /** The template to be used for rendering an appointment tooltip. */ - appointmentTooltipTemplate?: any; - /** Lists the views to be available within the scheduler's View Selector. */ - views?: Array; - /** Specifies the resource kinds by which the scheduler's appointments are grouped in a timetable. */ - groups?: Array; - /** Specifies a start hour in the scheduler view's time interval. */ - startDayHour?: number; - /** Specifies an end hour in the scheduler view's time interval. */ - endDayHour?: number; - /** Specifies whether or not the "All-day" panel is visible. */ - showAllDayPanel?: boolean; - /** Specifies cell duration in minutes. */ - cellDuration?: number; - /** Specifies the edit mode for recurrent appointments. */ - recurrenceEditMode?: string; - /** Specifies which editing operations an end-user can perform on appointments. */ - editing?: { - /** Specifies whether or not an end-user can add appointments. */ - allowAdding?: boolean; - /** Specifies whether or not an end-user can change appointment options. */ - allowUpdating?: boolean; - /** Specifies whether or not an end-user can delete appointments. */ - allowDeleting?: boolean; - /** Specifies whether or not an end-user can change an appointment duration. */ - allowResizing?: boolean; - /** Specifies whether or not an end-user can drag appointments. */ - allowDragging?: boolean; - } - /** Specifies an array of resources available in the scheduler. */ - resources?: Array<{ - /** Indicates whether or not several resources of this kind can be assigned to an appointment. */ - allowMultiple?: boolean; - /** - * Indicates whether or not resources of this kind have priority in the color identification of the appointments that have resources of different kinds assigned. - * @deprecated Use the 'useColorAsDefault' property instead - */ - mainColor?: boolean; - /** Indicates whether or not resources of this kind have priority in the color identification of the appointments that have resources of different kinds assigned. */ - useColorAsDefault?: boolean; - /** A data source used to fetch resources to be available in the scheduler. */ - dataSource?: any; - /** Specifies the resource object field whose value is displayed by the Resource editor in the Appointment popup window. */ - displayExpr?: any; - /** Specifies the resource object field that is used as a value of the Resource editor in the Appointment popup window. */ - valueExpr?: any; - /** The name of the appointment object field that specifies a resource of this kind. */ - field?: string; - /** Specifies the label of the Appointment popup window field that allows end users to assign a resource of this kind. */ - label?: string; - }>; - /** A handler for the AppointmentAdding event. */ - onAppointmentAdding?: Function; - /** A handler for the appointmentAdded event. */ - onAppointmentAdded?: Function; - /** A handler for the AppointmentUpdating event. */ - onAppointmentUpdating?: Function; - /** A handler for the appointmentUpdated event. */ - onAppointmentUpdated?: Function; - /** A handler for the AppointmentDeleting event. */ - onAppointmentDeleting?: Function; - /** A handler for the appointmentDeleted event. */ - onAppointmentDeleted?: Function; - /** A handler for the appointmentRendered event. */ - onAppointmentRendered?: Function; - /** A handler for the appointmentClick event. */ - onAppointmentClick?: any; - /** A handler for the appointmentDblClick event. */ - onAppointmentDblClick?: any; - /** A handler for the cellClick event. */ - onCellClick?: any; - /** A handler for the appointmentFormCreated event. */ - onAppointmentFormCreated?: Function; - /** Specifies whether or not an end-user can scroll the view horizontally. */ - horizontalScrollingEnabled?: boolean; - /** Specifies whether a user can switch views using tabs or a drop-down menu. */ - useDropDownViewSwitcher?: boolean; - /** Specifies the name of the data source item field that defines the start of an appointment. */ - startDateExpr?: string; - /** Specifies the name of the data source item field that defines the ending of an appointment. */ - endDateExpr?: string; - /** Specifies the name of the data source item field that holds the subject of an appointment. */ - textExpr?: string; - /** Specifies the name of the data source item field whose value holds the description of the corresponding appointment. */ - descriptionExpr?: string; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding appointment is an all-day appointment. */ - allDayExpr?: string; - /** Specifies the name of the data source item field that defines a recurrence rule for generating recurring appointments. */ - recurrenceRuleExpr?: string; - /** Specifies the name of the data source item field that defines exceptions for the current recurring appointment. */ - recurrenceExceptionExpr?: string; - /** Specifies whether filtering is performed on the server or client side. */ - remoteFiltering?: boolean; - } - /** A widget that displays scheduled data using different views and provides the capability to load, add and edit appointments. */ - export class dxScheduler extends Widget { - constructor(element: JQuery, options?: dxSchedulerOptions); - constructor(element: Element, options?: dxSchedulerOptions); - /** Add the appointment defined by the object passed as a parameter to the data associated with the widget. */ - addAppointment(appointment: Object): void; - /** Updates the appointment specified by the first method parameter by the appointment object specified by the second method parameter in the the data associated with the widget. */ - updateAppointment(target: Object, appointment: Object): void; - /** Deletes the appointment defined by the parameter from the the data associated with the widget. */ - deleteAppointment(appointment: Object): void; - /** Scrolls the scheduler work space to the specified time. */ - scrollToTime(hours: number, minutes: number): void; - /** Displays the Appointment Details popup. */ - showAppointmentPopup(appointmentData: Object, createNewAppointment?: boolean): void; - } - export interface dxColorBoxOptions extends dxDropDownEditorOptions { - /** Specifies the text displayed on the button that applies changes and closes the drop-down editor. */ - applyButtonText?: string; - applyValueMode?: string; - /** Specifies the text displayed on the button that cancels changes and closes the drop-down editor. */ - cancelButtonText?: string; - /** Specifies whether or not the widget value includes the alpha channel component. */ - editAlphaChannel?: boolean; - /** Specifies the size of a step by which a handle is moved using a keyboard shortcut. */ - keyStep?: number; - } - /** A widget used to specify a color value. */ - export class dxColorBox extends dxDropDownEditor { - constructor(element: JQuery, options?: dxColorBoxOptions); - constructor(element: Element, options?: dxColorBoxOptions); - } - export interface HierarchicalCollectionWidgetOptions extends CollectionWidgetOptions { - /** Specifies the name of the data source item field whose value is displayed by the widget. */ - displayExpr?: any; - /** Specifies the name of the data source item field used as a key. */ - keyExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding widget items is selected. */ - selectedExpr?: any; - /** Specifies the name of the data source item field that contains an array of nested items. */ - itemsExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding widget item is disabled. */ - disabledExpr?: any; - /** Specifies the name of the data source item field that holds the key of the parent item. */ - parentIdExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding widget items is expanded. */ - expandedExpr?: any; - hoverStateEnabled?: boolean; - focusStateEnabled?: boolean; - } - export class HierarchicalCollectionWidget extends CollectionWidget { - } - export interface dxTreeViewOptions extends HierarchicalCollectionWidgetOptions { - /** Specifies whether or not to animate item collapsing and expanding. */ - animationEnabled?: boolean; - /** Specifies whether a nested or plain array is used as a data source. */ - dataStructure?: string; - /** Specifies whether or not a user can expand all tree view items by the "*" hot key. */ - expandAllEnabled?: boolean; - /** - * Specifies whether or not a check box is displayed at each tree view item. - * @deprecated Use the showCheckBoxesMode option instead. - */ - showCheckBoxes?: boolean; - /** Specifies the current check boxes display mode. */ - showCheckBoxesMode?: string; - /** Specifies whether or not to select nodes recursively. */ - selectNodesRecursive?: boolean; - /** Specifies whether or not all parent nodes of an initially expanded node are displayed expanded. */ - expandNodesRecursive?: boolean; - /** - * Specifies whether the "Select All" check box is displayed over the tree view. - * @deprecated Use the showCheckBoxesMode option instead. - */ - selectAllEnabled?: boolean; - /** Specifies the text displayed at the "Select All" check box. */ - selectAllText?: string; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding node includes child nodes. */ - hasItemsExpr?: any; - /** Specifies if the virtual mode is enabled. */ - virtualModeEnabled?: boolean; - /** Specifies the parent ID value of the root item. */ - rootValue?: any; - /** Specifies the current value used to filter tree view items. */ - searchValue?: string; - /** A string value specifying available scrolling directions. */ - scrollDirection?: string; - /** A handler for the itemSelected event. */ - onItemSelected?: Function; - /** A handler for the itemExpanded event. */ - onItemExpanded?: Function; - /** A handler for the itemCollapsed event. */ - onItemCollapsed?: Function; - onItemClick?: Function; - onItemContextMenu?: Function; - onItemRendered?: Function; - onItemHold?: Function; - } - /** A widget displaying specified data items as a tree. */ - export class dxTreeView extends HierarchicalCollectionWidget { - constructor(element: JQuery, options?: dxTreeViewOptions); - constructor(element: Element, options?: dxTreeViewOptions); - /** Updates the tree view scrollbars according to the current size of the widget content. */ - updateDimensions(): JQueryPromise; - /** Selects the specified item. */ - selectItem(itemElement: any): void; - /** Unselects the specified item. */ - unselectItem(itemElement: any): void; - /** Expands the specified item. */ - expandItem(itemElement: any): void; - /** Collapses the specified item. */ - collapseItem(itemElement: any): void; - /** Returns all nodes of the tree view. */ - getNodes(): Array; - /** Selects all widget items. */ - selectAll(): void; - /** Unselects all widget items. */ - unselectAll(): void; - } - export interface dxMenuBaseOptions extends HierarchicalCollectionWidgetOptions { - /** An object that defines the animation options of the widget. */ - animation?: fx.AnimationOptions; - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** Specifies the name of the CSS class associated with the menu. */ - cssClass?: string; - /** Holds an array of menu items. */ - items?: Array; - /** Specifies whether or not an item becomes selected if an end-user clicks it. */ - selectionByClick?: boolean; - /** Specifies the selection mode supported by the menu. */ - selectionMode?: string; - /** Specifies options of submenu showing and hiding. */ - showSubmenuMode?: { - /** Specifies the mode name. */ - name?: string; - /** Specifies the delay of submenu show and hiding. */ - delay?: { - /** The time span after which the submenu is shown. */ - show?: number; - /** The time span after which the submenu is hidden. */ - hide?: number; - }; - }; - } - export class dxMenuBase extends HierarchicalCollectionWidget { - constructor(element: JQuery, options?: dxMenuBaseOptions); - constructor(element: Element, options?: dxMenuBaseOptions); - /** Selects the specified item. */ - selectItem(itemElement: any): void; - /** Unselects the specified item. */ - unselectItem(itemElement: any): void; - } - export interface dxMenuOptions extends dxMenuBaseOptions { - /** Specifies whether or not the submenu is hidden when the mouse pointer leaves it. */ - hideSubmenuOnMouseLeave?: boolean; - /** Specifies whether the menu has horizontal or vertical orientation. */ - orientation?: string; - /** Specifies options for showing and hiding the first level submenu. */ - showFirstSubmenuMode?: { - /** Specifies the mode name. */ - name?: string; - /** Specifies the delay in submenu showing and hiding. */ - delay?: { - /** The time span after which the submenu is shown. */ - show?: number; - /** The time span after which the submenu is hidden. */ - hide?: number; - }; - }; - /** Specifies the direction at which the submenus are displayed. */ - submenuDirection?: string; - /** A handler for the submenuHidden event. */ - onSubmenuHidden?: Function; - /** A handler for the submenuHiding event. */ - onSubmenuHiding?: Function; - /** A handler for the submenuShowing event. */ - onSubmenuShowing?: Function; - /** A handler for the submenuShown event. */ - onSubmenuShown?: Function; - } - /** A menu widget. */ - export class dxMenu extends dxMenuBase { - constructor(element: JQuery, options?: dxMenuOptions); - constructor(element: Element, options?: dxMenuOptions); - } - export interface dxContextMenuOptions extends dxMenuBaseOptions { - /** Holds an object that specifies options of alternative menu invocation. */ - alternativeInvocationMode?: { - /** Specifies whether or not the standard context menu invocation (on a right mouse click or on a long tap) is disabled. */ - enabled?: Boolean; - /** Specifies the element used to invoke the context menu. */ - invokingElement?: any; - }; - /** A handler for the hidden event. */ - onHidden?: Function; - /** A handler for the hiding event. */ - onHiding?: Function; - /** A handler for the positioning event. */ - onPositioning?: Function; - /** A handler for the showing event. */ - onShowing?: Function; - /** A handler for the shown event. */ - onShown?: Function; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** Specifies the direction at which submenus are displayed. */ - submenuDirection?: string; - /** The target element associated with a popover. */ - target?: any; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - } - /** A context menu widget. */ - export class dxContextMenu extends dxMenuBase { - constructor(element: JQuery, options?: dxContextMenuOptions); - constructor(element: Element, options?: dxContextMenuOptions); - /** Toggles the visibility of the widget. */ - toggle(showing: boolean): JQueryPromise; - /** Shows the widget. */ - show(): JQueryPromise; - /** Hides the widget. */ - hide(): JQueryPromise; - } - export interface dxRemoteOperations { - /** Specifies whether or not filtering must be performed on the server side. */ - filtering?: boolean; - /** Specifies whether or not paging must be performed on the server side. */ - paging?: boolean; - /** Specifies whether or not sorting must be performed on the server side. */ - sorting?: boolean; - /** Specifies whether or not grouping must be performed on the server side. */ - grouping?: boolean; - /** Specifies whether or not summaries calculation must be performed on the server side. */ - summary?: boolean; - } - export interface dxDataGridRow { - /** The data object represented by the row. */ - data: Object; - /** The key of the data object represented by the row. */ - key: any; - /** The visible index of the row. */ - rowIndex: number; - /** The type of the row. */ - rowType: string; - } - export interface dxDataGridColumn { - /** Specifies the content alignment within column cells. */ - alignment?: string; - /** Specifies whether the values in a column can be edited at runtime. Setting this option makes sense only when editing is enabled for a grid. */ - allowEditing?: boolean; - /** Specifies whether or not a column can be used for filtering grid records. Setting this option makes sense only when the filter row and column header filtering are visible. */ - allowFiltering?: boolean; - /** Specifies whether or not to allow filtering by this column using its header. */ - allowHeaderFiltering?: boolean; - /** Specifies whether or not the column can be anchored to a grid edge by end users. Setting this option makes sense only when the columnFixing | enabled option is set to true. */ - allowFixing?: boolean; - /** Specifies if a column can be used for searching grid records. Setting this option makes sense only when the search panel is visible. */ - allowSearch?: boolean; - /** Specifies whether a column can be used for grouping grid records at runtime. Setting this option makes sense only when the group panel is visible. */ - allowGrouping?: boolean; - /** Specifies whether or not a column can be hidden by a user. Setting this option makes sense only when the column chooser is visible. */ - allowHiding?: boolean; - /** Specifies whether or not a particular column can be used in column reordering. Setting this option makes sense only when the allowColumnReordering option is set to true. */ - allowReordering?: boolean; - /** Specifies whether or not a particular column can be resized by a user. Setting this option makes sense only when the allowColumnResizing option is true. */ - allowResizing?: boolean; - /** Specifies whether grid records can be sorted by a specific column at runtime. Setting this option makes sense only when the sorting mode differs from none. */ - allowSorting?: boolean; - /** Specifies whether groups appear expanded or not when records are grouped by a specific column. Setting this option makes sense only when grouping is allowed for this column. */ - autoExpandGroup?: boolean; - /** Specifies a callback function that returns a value to be displayed in a column cell. */ - calculateCellValue?: (rowData: Object) => string; - /** Specifies a callback function to be invoked after the cell value is edited by an end-user and before the new value is saved to the data source. */ - setCellValue?: (rowData: Object, value: any) => void; - /** Specifies a callback function that defines filters for customary calculated grid cells. */ - calculateFilterExpression?: (filterValue: any, selectedFilterOperation: string, target: string) => Array; - /** Specifies a caption for a column. */ - caption?: string; - /** Specifies a custom template for grid column cells. */ - cellTemplate?: any; - /** Specifies a CSS class to be applied to a column. */ - cssClass?: string; - /** Specifies how to get a value to be displayed in a cell when it is not in an editing state. */ - calculateDisplayValue?: any; - /** Specifies a field name or a function that returns a field name or a value to be used for grouping column cells. */ - calculateGroupValue?: any; - /** Specifies a field name or a function that returns a field name or a value to be used for sorting column cells. */ - calculateSortValue?: any; - /** Specifies a callback function that returns the text to be displayed in the cells of a column. */ - customizeText?: (cellInfo: { value: any; valueText: string }) => string; - /** Specifies the field of a data source that provides data for a column. */ - dataField?: string; - /** Specifies the required type of column values. */ - dataType?: string; - /** Specifies a custom template for the cell of a grid column when it is in an editing state. */ - editCellTemplate?: any; - /** Specifies configuration options for the editor widget of the current column. */ - editorOptions?: Object; - /** Specifies whether HTML tags are displayed as plain text or applied to the values of the column. */ - encodeHtml?: boolean; - /** In a boolean column, replaces all false items with a specified text. */ - falseText?: string; - /** Specifies the set of available filter operations. */ - filterOperations?: Array; - /** Specifies a filter value for a column. */ - filterValue?: any; - /** Specifies initial filter values for the column's header filter. */ - filterValues?: Array; - /** Specifies whether to include or exclude the records with the values selected in the column's header filter. */ - filterType?: string; - /** Indicates whether the column takes part in horizontal grid scrolling or is anchored to a grid edge. */ - fixed?: boolean; - /** Specifies the grid edge to which the column is anchored. */ - fixedPosition?: string; - /** Specifies a format for the values displayed in a column. */ - format?: string; - /** Specifies a custom template for the group cell of a grid column. */ - groupCellTemplate?: any; - /** Specifies the index of a column when grid records are grouped by the values of this column. */ - groupIndex?: number; - /** Specifies a custom template for the header of a grid column. */ - headerCellTemplate?: any; - /** Specifies options of a lookup column. */ - lookup?: { - /** Specifies whether or not a user can nullify values of a lookup column. */ - allowClearing?: boolean; - /** Specifies the data source providing data for a lookup column. */ - dataSource?: any; - /** Specifies the expression defining the data source field whose values must be displayed. */ - displayExpr?: any; - /** Specifies the expression defining the data source field whose values must be replaced. */ - valueExpr?: string; - }; - /** Specifies column-level options for filtering using a column header filter. */ - headerFilter?: { - /** Specifies the data source to be used for the header filter. */ - dataSource?: any; - /** Specifies how header filter values should be combined into groups. */ - groupInterval?: any; - }; - /** Specifies a precision for formatted values displayed in a column. */ - precision?: number; - /** Specifies a filter operation applied to a column. */ - selectedFilterOperation?: string; - /** Specifies whether or not the column displays its values by using editors. */ - showEditorAlways?: boolean; - /** Specifies whether or not to display the column when grid records are grouped by it. */ - showWhenGrouped?: boolean; - /** Specifies the index of a column when grid records are sorted by the values of this column. */ - sortIndex?: number; - /** Specifies the initial sort order of column values. */ - sortOrder?: string; - /** In a boolean column, replaces all true items with a specified text. */ - trueText?: string; - /** Specifies whether a column is visible or not. */ - visible?: boolean; - /** Specifies the sequence number of the column in the grid. */ - visibleIndex?: number; - /** Specifies a column width in pixels or percentages. */ - width?: any; - /** Specifies an array of validation rules to be checked when updating column cell values. */ - validationRules?: Array; - /** Specifies whether or not to display the header of a hidden column in the column chooser. */ - showInColumnChooser?: boolean; - /** Specifies the identifier of the column. */ - name?: string; - /** The form item configuration object. Used only when the editing mode is "form". */ - formItem?: DevExpress.ui.dxFormItem; - } - export interface dxDataGridOptions extends WidgetOptions { - /** Specifies whether the outer borders of the grid are visible or not. */ - showBorders?: boolean; - /** Indicates whether to show the error row for the grid. */ - errorRowEnabled?: boolean; - /** A handler for the rowValidating event. */ - onRowValidating?: (e: Object) => void; - /** A handler for the contextMenuPreparing event. */ - onContextMenuPreparing?: (e: Object) => void; - /** A handler for the initNewRow event. */ - onInitNewRow?: (e: { data: Object }) => void; - /** A handler for the rowInserted event. */ - onRowInserted?: (e: { data: Object; key: any }) => void; - /** A handler for the rowInserting event. */ - onRowInserting?: (e: { data: Object; cancel: any }) => void; - /** A handler for the rowRemoved event. */ - onRowRemoved?: (e: { data: Object; key: any }) => void; - /** A handler for the rowRemoving event. */ - onRowRemoving?: (e: { data: Object; key: any; cancel: any }) => void; - /** A handler for the rowUpdated event. */ - onRowUpdated?: (e: { data: Object; key: any }) => void; - /** A handler for the rowUpdating event. */ - onRowUpdating?: (e: { oldData: Object; newData: Object; key: any; cancel: any }) => void; - /** Enables a hint that appears when a user hovers the mouse pointer over a cell with truncated content. */ - cellHintEnabled?: boolean; - /** Specifies whether or not grid columns can be reordered by a user. */ - allowColumnReordering?: boolean; - /** Specifies whether or not grid columns can be resized by a user. */ - allowColumnResizing?: boolean; - /** A handler for the cellClick event. */ - onCellClick?: any; - /** A handler for the cellHoverChanged event. */ - onCellHoverChanged?: (e: Object) => void; - /** A handler for the cellPrepared event. */ - onCellPrepared?: (e: Object) => void; - /** Specifies whether or not the width of grid columns depends on column content. */ - columnAutoWidth?: boolean; - /** Specifies the options of a column chooser. */ - columnChooser?: { - /** Specifies text displayed by the column chooser panel when it does not contain any columns. */ - emptyPanelText?: string; - /** Specifies whether a user can invoke the column chooser or not. */ - enabled?: boolean; - /** Specifies the height of the column chooser panel. */ - height?: number; - /** Specifies text displayed in the title of the column chooser panel. */ - title?: string; - /** Specifies the width of the column chooser panel. */ - width?: number; - }; - /** Specifies options for column fixing. */ - columnFixing?: { - /** Indicates if column fixing is enabled. */ - enabled?: boolean; - /** Contains options that specify texts for column-fixing related commands in the column header's context menu. */ - texts?: { - /** Specifies text for a context menu item that fixes the column for which the context menu is invoked. */ - fix?: string; - /** Specifies text for a context menu item that unfixes the column for which the context menu is invoked. */ - unfix?: string; - /** Specifies text for a context menu subitem that fixes a column, for which the context menu is invoked, to the left grid edge. */ - leftPosition?: string; - /** Specifies text for a context menu subitem that fixes a column, for which the context menu is invoked, to the right grid edge. */ - rightPosition?: string; - }; - }; - /** Specifies options for filtering using a column header filter. */ - headerFilter?: { - /** Indicates whether or not the column header filter button is visible. */ - visible?: boolean; - /** Specifies the height of the dropdown menu invoked when using a column header filter. */ - height?: number; - /** Specifies the width of the dropdown menu invoked when using a column header filter. */ - width?: number; - /** Contains options that specify texts for the dropdown menu invoked when you use a column header filter. */ - texts?: { - /** Specifies text for the item specifying an empty value in the column header filter's dropdown menu. */ - emptyValue?: string; - /** Specifies text for a button that closes the column header filter's dropdown menu and applies specified filtering. */ - ok?: string; - /** Specifies text for a button that closes the column header filter's dropdown menu without applying performed selection. */ - cancel?: string; - } - }; - /** An array of grid columns. */ - columns?: Array; - onContentReady?: Function; - /** Specifies a function that customizes grid columns after they are created. */ - customizeColumns?: (columns: Array) => void; - /** Specifies a data source for the grid. */ - dataSource?: any; - /** Specifies whether or not to enable data caching. */ - cacheEnabled?: boolean; - /** A handler for the editingStart event. */ - onEditingStart?: (e: { - data: Object; - key: any; - cancel: boolean; - column: dxDataGridColumn - }) => void; - /** A handler for the editorPrepared event. */ - onEditorPrepared?: (e: Object) => void; - /** A handler for the editorPreparing event. */ - onEditorPreparing?: (e: Object) => void; - /** Contains options that specify how grid content can be changed. */ - editing?: { - editMode?: string; - editEnabled?: boolean; - insertEnabled?: boolean; - removeEnabled?: boolean; - /** Specifies how grid values can be edited manually. */ - mode?: string; - /** Specifies whether or not grid records can be edited at runtime. */ - allowUpdating?: boolean; - /** Specifies whether or not new grid records can be added at runtime. */ - allowAdding?: boolean; - /** Specifies whether or not grid records can be deleted at runtime. */ - allowDeleting?: boolean; - /** The form configuration object. Used only when the editing mode is "form". */ - form?: DevExpress.ui.dxFormOptions; - /** Contains options that specify texts for editing-related grid controls. */ - texts?: { - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Save" button. Setting this option makes sense only when the editMode option is set to batch. */ - saveAllChanges?: string; - /** Specifies text for a cancel button displayed when a row is in the editing state. Setting this option makes sense only when the allowUpdating option is set to true. */ - cancelRowChanges?: string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Revert" button. Setting this option makes sense only when the editMode option is set to batch. */ - cancelAllChanges?: string; - /** Specifies a message to be displayed by a confirmation window. Setting this option makes sense only when the edit mode is "row". */ - confirmDeleteMessage?: string; - /** Specifies text to be displayed in the title of a confirmation window. Setting this option makes sense only when the edit mode is "row". */ - confirmDeleteTitle?: string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Cancel changes" button. Setting this option makes sense only when the editMode option is set to cell and the validation capabilities are enabled. */ - validationCancelChanges?: string; - /** Specifies text for a button that deletes a row from a grid. Setting this option makes sense only when the allowDeleting option is set to true. */ - deleteRow?: string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Add" button. Setting this option makes sense only when the allowAdding option is true. */ - addRow?: string; - /** Specifies text for a button that turns a row into the editing state. Setting this option makes sense only when the allowUpdating option is set to true. */ - editRow?: string; - /** Specifies text for a save button displayed when a row is in the editing state. Setting this option makes sense only when the allowUpdating option is set to true. */ - saveRowChanges?: string; - /** Specifies text for a button that recovers a deleted row. Setting this option makes sense only if the grid uses the batch edit mode and the allowDeleting option is set to true. */ - undeleteRow?: string; - }; - }; - /** Specifies filter row options. */ - filterRow?: { - /** Specifies when to apply a filter. */ - applyFilter?: string; - /** Specifies text for the hint that pops up when a user hovers the mouse pointer over the "Apply Filter" button. */ - applyFilterText?: string; - /** Specifies descriptions for filter operations. */ - operationDescriptions?: { - "=": string; - "<>": string; - "<": string; - "<=": string; - ">": string; - ">=": string; - "startswith": string; - "contains": string; - "notcontains": string; - "endswith": string; - }; - /** Specifies text for the reset operation in a filter list. */ - resetOperationText?: string; - /** Specifies text for the operation of clearing the applied filter when a select box is used. */ - showAllText?: string; - /** Specifies text for the range start in the 'between' filter type. */ - betweenStartText?: string; - /** Specifies text for the range end in the 'between' filter type. */ - betweenEndText?: string; - /** Specifies whether or not an icon that allows the user to choose a filter operation is visible. */ - showOperationChooser?: boolean; - /** Specifies whether the filter row is visible or not. */ - visible?: boolean; - }; - /** Specifies the behavior of grouped grid records. */ - grouping?: { - /** Specifies whether the user can collapse grouped records in a grid or not. */ - allowCollapsing?: boolean; - /** Specifies whether groups appear expanded or not. */ - autoExpandAll?: boolean; - /** Specifies the message displayed in a group row when the corresponding group is continued from the previous page. */ - groupContinuedMessage?: string; - /** Specifies the message displayed in a group row when the corresponding group continues on the next page. */ - groupContinuesMessage?: string; - }; - /** Specifies options that configure the group panel. */ - groupPanel?: { - /** Specifies whether columns can be dragged onto or from the group panel. */ - allowColumnDragging?: boolean; - /** Specifies text displayed by the group panel when it does not contain any columns. */ - emptyPanelText?: string; - /** Specifies whether the group panel is visible or not. */ - visible?: boolean; - }; - /** Specifies options configuring the load panel. */ - loadPanel?: { - /** Specifies whether to show the load panel or not. */ - enabled?: boolean; - /** Specifies the height of the load panel in pixels. */ - height?: number; - /** Specifies a URL pointing to an image to be used as a loading indicator. */ - indicatorSrc?: string; - /** Specifies whether or not a loading indicator must be displayed on the load panel. */ - showIndicator?: boolean; - /** Specifies whether or not the pane of the load panel must be displayed. */ - showPane?: boolean; - /** Specifies text displayed by the load panel. */ - text?: string; - /** Specifies the width of the load panel in pixels. */ - width?: number; - }; - /** Specifies text displayed when a grid does not contain any records. */ - noDataText?: string; - /** Specifies the options of a grid pager. */ - pager?: { - /** Specifies the page sizes that can be selected at runtime. */ - allowedPageSizes?: any; - /** Specifies whether to show the page size selector or not. */ - showPageSizeSelector?: boolean; - /** Specifies whether to show the pager or not. */ - visible?: any; - /** Specifies the text accompanying the page navigator. */ - infoText?: string; - /** Specifies whether or not to display the text accompanying the page navigator. This text is specified by the infoText option. */ - showInfo?: boolean; - /** Specifies whether or not to display buttons that switch the grid to the previous or next page. */ - showNavigationButtons?: boolean; - }; - /** Specifies paging options. */ - paging?: { - /** Specifies whether dxDataGrid loads data page by page or all at once. */ - enabled?: boolean; - /** Specifies the grid page that should be displayed by default. */ - pageIndex?: number; - /** Specifies the size of grid pages. */ - pageSize?: number; - }; - /** Specifies whether or not grid rows must be shaded in a different way. */ - rowAlternationEnabled?: boolean; - /** Specifies whether to enable two-way data binding. */ - twoWayBindingEnabled?: boolean; - /** A handler for the rowClick event. */ - onRowClick?: any; - /** A handler for the rowPrepared event. */ - onRowPrepared?: (e: Object) => void; - /** Specifies a custom template for grid rows. */ - rowTemplate?: any; - /** A configuration object specifying scrolling options. */ - scrolling?: { - /** Specifies the scrolling mode. */ - mode?: string; - /** Specifies whether or not a grid must preload pages adjacent to the current page when using virtual scrolling. */ - preloadEnabled?: boolean; - /** Specifies whether or not the widget uses native scrolling. */ - useNative?: any; - /** Specifies the scrollbar display policy. */ - showScrollbar?: string; - /** Specifies whether or not the scrolling by content is enabled. */ - scrollByContent?: boolean; - /** Specifies whether or not the scrollbar thumb scrolling enabled. */ - scrollByThumb?: boolean; - }; - /** Specifies options of the search panel. */ - searchPanel?: { - /** Specifies whether or not search strings in the located grid records should be highlighted. */ - highlightSearchText?: boolean; - /** Specifies text displayed by the search panel when no search string was typed. */ - placeholder?: string; - /** Specifies whether the search panel is visible or not. */ - visible?: boolean; - /** Specifies the width of the search panel in pixels. */ - width?: number; - /** Sets a search string for the search panel. */ - text?: string; - }; - /** Specifies the operations that must be performed on the server side. */ - remoteOperations?: any; - /** Allows you to sort groups according to the values of group summary items. */ - sortByGroupSummaryInfo?: Array<{ - /** Specifies the group summary item whose values must be used to sort groups. */ - summaryItem?: string; - /** Specifies the identifier of the column that must be used in grouping so that sorting by group summary item values be applied. */ - groupColumn?: string; - /** Specifies the sort order of group summary item values. */ - sortOrder?: string; - }>; - /** Allows you to build a master-detail interface in the grid. */ - masterDetail?: { - /** Enables an end-user to expand/collapse detail sections. */ - enabled?: boolean; - /** Specifies whether detail sections appear expanded or collapsed. */ - autoExpandAll?: boolean; - /** Specifies the template for detail sections. */ - template?: any; - }; - /** Specifies options for exporting grid data. */ - export?: { - /** Indicates if the export feature is enabled in the grid. */ - enabled?: boolean; - /** Specifies a default name for the file to which grid data is exported. */ - fileName?: string; - /** Specifies whether to enable Excel filtering for the exported data in the resulting XLSX file. */ - excelFilterEnabled?: boolean; - /** Specifies whether to enable word wrapping for the exported data in the resulting XLSX file. */ - excelWrapTextEnabled?: boolean; - /** Specifies the URL of the server-side proxy that streams the resulting file to the end user to enable export in IE8, IE9 and Safari browsers. */ - proxyUrl?: string; - /** Indicates whether to allow end users to export not only the data displayed in the grid, but the selected rows only. */ - allowExportSelectedData?: boolean; - /** Contains options that specify texts for the export-related commands and hints. */ - texts?: { - /** Specifies text for the Export button when this button invokes a dropdown menu so you can choose the required export format. */ - exportTo?: string; - /** Specifies text for the Export button's hint when this button exports to the XSLX format without invoking the drop-down menu. */ - exportToExcel?: string; - /** Specifies text for the item in the Export dropdown menu that exports grid data to Excel. */ - excelFormat?: string; - /** Specifies text for the option in the Export dropdown menu that allows you to choose whether to export all the grid data or the selected rows only. */ - selectedRows?: string; - } - }; - /** Specifies the keys of the records that must appear selected initially. */ - selectedRowKeys?: Array; - /** Specifies options of runtime selection. */ - selection?: { - /** Specifies the checkbox row display policy in the multiple mode. */ - showCheckBoxesMode?: string; - /** Specifies whether the user can select all grid records at once. */ - allowSelectAll?: boolean; - /** Specifies the selection mode. */ - mode?: string; - }; - /** A handler for the dataErrorOccured event. */ - onDataErrorOccurred?: (e: { error: Error }) => void; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: (e: { - currentSelectedRowKeys: Array; - currentDeselectedRowKeys: Array; - selectedRowKeys: Array; - selectedRowsData: Array; - }) => void; - /** A handler for the exporting event. */ - onExporting?: (e: { - fileName: string; - cancel: boolean; - }) => void; - /** A handler for the fileSaving event. */ - onFileSaving?: (e: { - fileName: string; - format: string; - data: any; - cancel: boolean; - }) => void; - /** A handler for the exported event. */ - onExported?: (e: Object) => void; - /** A handler for the keyDown event. */ - onKeyDown?: (e: Object) => void; - /** A handler for the rowExpanding event. */ - onRowExpanding?: (e: Object) => void; - /** A handler for the rowExpanded event. */ - onRowExpanded?: (e: Object) => void; - /** A handler for the rowCollapsing event. */ - onRowCollapsing?: (e: Object) => void; - /** A handler for the rowCollapsed event. */ - onRowCollapsed?: (e: Object) => void; - /** Specifies whether column headers are visible or not. */ - showColumnHeaders?: boolean; - /** Specifies whether or not vertical lines separating one grid column from another are visible. */ - showColumnLines?: boolean; - /** Specifies whether or not horizontal lines separating one grid row from another are visible. */ - showRowLines?: boolean; - /** Specifies options of runtime sorting. */ - sorting?: { - /** Specifies text for the context menu item that sets an ascending sort order in a column. */ - ascendingText?: string; - /** Specifies text for the context menu item that resets sorting settings for a column. */ - clearText?: string; - /** Specifies text for the context menu item that sets a descending sort order in a column. */ - descendingText?: string; - /** Specifies the runtime sorting mode. */ - mode?: string; - }; - /** Specifies options of state storing. */ - stateStoring?: { - /** Specifies a callback function that performs specific actions on state loading. */ - customLoad?: () => JQueryPromise; - /** Specifies a callback function that performs specific actions on state saving. */ - customSave?: (state: Object) => void; - /** Specifies whether or not a grid saves its state. */ - enabled?: boolean; - /** Specifies the delay between the last change of a grid state and the operation of saving this state in milliseconds. */ - savingTimeout?: number; - /** Specifies a unique key to be used for storing the grid state. */ - storageKey?: string; - /** Specifies the type of storage to be used for state storing. */ - type?: string; - }; - /** Specifies the options of the grid summary. */ - summary?: { - /** Contains options that specify text patterns for summary items. */ - texts?: { - /** Specifies a pattern for the 'sum' summary items when they are displayed in the parent column. */ - sum?: string; - /** Specifies a pattern for the 'sum' summary items displayed in a group row or in any other column rather than the parent one. */ - sumOtherColumn?: string; - /** Specifies a pattern for the 'min' summary items when they are displayed in the parent column. */ - min?: string; - /** Specifies a pattern for the 'min' summary items displayed in a group row or in any other column rather than the parent one. */ - minOtherColumn?: string; - /** Specifies a pattern for the 'max' summary items when they are displayed in the parent column. */ - max?: string; - /** Specifies a pattern for the 'max' summary items displayed in a group row or in any other column rather than the parent one. */ - maxOtherColumn?: string; - /** Specifies a pattern for the 'avg' summary items when they are displayed in the parent column. */ - avg?: string; - /** Specifies a pattern for the 'avg' summary items displayed in a group row or in any other column rather than the parent one. */ - avgOtherColumn?: string; - /** Specifies a pattern for the 'count' summary items. */ - count?: string; - }; - /** Specifies items of the group summary. */ - groupItems?: Array<{ - /** Specifies the identifier of a summary item. */ - name?: string; - /** Specifies the column that provides data for a group summary item. */ - column?: string; - /** Customizes the text to be displayed in the summary item. */ - customizeText?: (itemInfo: { - value: any; - valueText: string; - }) => string; - /** Specifies a pattern for the summary item text. */ - displayFormat?: string; - /** Specifies a precision for the summary item value of a numeric format. */ - precision?: number; - /** Specifies whether or not a summary item must be displayed in the group footer. */ - showInGroupFooter?: boolean; - /** Indicates whether to display group summary items in parentheses after the group row header or to align them by the corresponding columns within the group row. */ - alignByColumn?: boolean; - /** Specifies the column that must hold the summary item when this item is displayed in the group footer or aligned by a column in the group row. */ - showInColumn?: string; - /** Specifies how to aggregate data for a summary item. */ - summaryType?: string; - /** Specifies a format for the summary item value. */ - valueFormat?: string; - }>; - /** Specifies items of the total summary. */ - totalItems?: Array<{ - /** Specifies the identifier of a summary item. */ - name?: string; - /** Specifies the alignment of a summary item. */ - alignment?: string; - /** Specifies the column that provides data for a summary item. */ - column?: string; - /** Specifies a CSS class to be applied to a summary item. */ - cssClass?: string; - /** Customizes the text to be displayed in the summary item. */ - customizeText?: (itemInfo: { - value: any; - valueText: string; - }) => string; - /** Specifies a pattern for the summary item text. */ - displayFormat?: string; - /** Specifies a precision for the summary item value of a numeric format. */ - precision?: number; - /** Specifies the column that must hold the summary item. */ - showInColumn?: string; - /** Specifies how to aggregate data for a summary item. */ - summaryType?: string; - /** Specifies a format for the summary item value. */ - valueFormat?: string; - }>; - /** Allows you to use a custom aggregate function to calculate the value of a summary item. */ - calculateCustomSummary?: (options: { - component: dxDataGrid; - name?: string; - value: any; - totalValue: any; - summaryProcess: string - }) => void; - }; - /** Specifies whether text that does not fit into a column should be wrapped. */ - wordWrapEnabled?: boolean; - } - /** A data grid widget. */ - export class dxDataGrid extends Widget { - constructor(element: JQuery, options?: dxDataGridOptions); - constructor(element: Element, options?: dxDataGridOptions); - /** Ungroups grid records. */ - clearGrouping(): void; - /** Clears sorting settings of all grid columns at once. */ - clearSorting(): void; - /** Allows you to obtain a cell by its row index and the data field of its column. */ - getCellElement(rowIndex: number, dataField: string): any; - /** Allows you to obtain a cell by its row index and the visible index of its column. */ - getCellElement(rowIndex: number, visibleColumnIndex: number): any; - /** Returns the current state of the grid. */ - state(): Object; - /** Sets the grid state. */ - state(state: Object): void; - /** Allows you to obtain the row index by a data key. */ - getRowIndexByKey(key: any): number; - /** Allows you to obtain the data key by a row index. */ - getKeyByRowIndex(rowIndex: number): any; - /** Adds a new column to a grid. */ - addColumn(columnOptions: dxDataGridColumn): void; - /** Removes the column from the grid. */ - deleteColumn(id: any): void; - /** Displays the load panel. */ - beginCustomLoading(messageText: string): void; - /** Discards changes made in a grid. */ - cancelEditData(): void; - /** Checks whether or not the grid contains unsaved changes. */ - hasEditData(): boolean; - /** Clears all the filters of a specific type applied to grid records. */ - clearFilter(): void; - /** Deselects all grid records. */ - clearSelection(): void; - /** Draws the cell being edited from the editing state. Use this method when the edit mode is batch. */ - closeEditCell(): void; - /** Collapses groups or master rows in a grid. */ - collapseAll(groupIndex?: number): void; - /** Returns the number of data columns in a grid. */ - columnCount(): number; - /** Returns the value of a specific column option. */ - columnOption(id: any, optionName: string): any; - /** Sets an option of a specific column. */ - columnOption(id: any, optionName: string, optionValue: any): void; - /** Returns the options of a column by an identifier. */ - columnOption(id: any): Object; - /** Sets several options of a column at once. */ - columnOption(id: any, options: Object): void; - /** Sets a specific cell into the editing state. */ - editCell(rowIndex: number, visibleColumnIndex: number): void; - /** Sets a specific cell into the editing state. */ - editCell(rowIndex: number, dataField: string): void; - /** Sets a specific row into the editing state. */ - editRow(rowIndex: number): void; - /** Gets the cell value. */ - cellValue(rowIndex: number, dataField: string): any; - /** Gets the cell value. */ - cellValue(rowIndex: number, visibleColumnIndex: number): any; - /** Sets the cell value. */ - cellValue(rowIndex: number, dataField: string, value: any): void; - /** Sets the cell value. */ - cellValue(rowIndex: number, visibleColumnIndex: number, value: any): void; - /** Hides the load panel. */ - endCustomLoading(): void; - /** Expands groups or master rows in a grid. */ - expandAll(groupIndex: number): void; - /** Allows you to find out whether a specific group or master row is expanded or collapsed. */ - isRowExpanded(key: any): boolean; - /** Allows you to expand a specific group or master row by its key. */ - expandRow(key: any): void; - /** Allows you to collapse a specific group or master row by its key. */ - collapseRow(key: any): void; - /** Applies a filter to the grid's data source. */ - filter(filterExpr?: any): void; - /** Returns a filter expression applied to the grid's data source using the filter(filterExpr) method. */ - filter(): any; - /** Returns a filter expression applied to the grid using all possible scenarious. */ - getCombinedFilter(): any; - /** Gets the keys of currently selected grid records. */ - getSelectedRowKeys(): Array; - /** Gets the data objects of currently selected grid records. */ - getSelectedRowsData(): Array; - /** Hides the column chooser panel. */ - hideColumnChooser(): void; - /** Adds a new data row to a grid. */ - addRow(): void; - /** - * Adds a new data row to a grid. - * @deprecated Use the addRow() method instead. - */ - insertRow(): void; - /** Returns the key corresponding to the passed data object. */ - keyOf(obj: Object): any; - /** Switches a grid to a specified page. */ - pageIndex(newIndex: number): void; - /** Gets the index of the current page. */ - pageIndex(): number; - /** Sets the page size. */ - pageSize(value: number): void; - /** Gets the current page size. */ - pageSize(): number; - /** Refreshes grid data. */ - refresh(): void; - /** Removes a specific row from a grid. */ - deleteRow(rowIndex: number): void; - /** - * Removes a specific row from a grid. - * @deprecated Use the deleteRow() method instead. - */ - removeRow(rowIndex: number): void; - /** Saves changes made in a grid. */ - saveEditData(): void; - /** Searches grid records by a search string. */ - searchByText(text: string): void; - /** Selects all grid records. */ - selectAll(): void; - /** Deselects the rows that are currently selected within the applied filter. */ - deselectAll(): void; - /** Selects specific grid records. */ - selectRows(keys: Array, preserve: boolean): void; - /** Deselects specific grid records. */ - deselectRows(keys: Array): void; - /** Selects grid rows by indexes. */ - selectRowsByIndexes(indexes: Array): void; - /** Allows you to find out whether a row is selected or not. */ - isRowSelected(key: any): boolean; - /** Invokes the column chooser panel. */ - showColumnChooser(): void; - startSelectionWithCheckboxes(): boolean; - /** Returns the number of records currently held by a grid. */ - totalCount(): number; - /** Recovers a row deleted in the batch edit mode. */ - undeleteRow(rowIndex: number): void; - /** Allows you to obtain a data object by its key. */ - byKey(key: any): JQueryPromise; - /** Gets the value of a total summary item. */ - getTotalSummaryValue(summaryItemName: string): any; - /** Exports grid data to Excel. */ - exportToExcel(selectionOnly: boolean): void; - /** Updates the grid to the size of its content. */ - updateDimensions(): void; - /** Focuses the specified cell element in the grid. */ - focus(element?: JQuery): void; - } - export interface dxPivotGridOptions extends WidgetOptions { - onContentReady?: Function; - /** Specifies a data source for the pivot grid. */ - dataSource?: any; - useNativeScrolling?: any; - /** A configuration object specifying scrolling options. */ - scrolling?: { - /** Specifies the scrolling mode. */ - mode?: string; - /** Specifies whether or not the widget uses native scrolling. */ - useNative?: any; - }; - /** Allows an end-user to change sorting options. */ - allowSorting?: boolean; - /** Allows an end-user to sort columns by summary values. */ - allowSortingBySummary?: boolean; - /** Allows an end-user to change filtering options. */ - allowFiltering?: boolean; - /** Allows an end-user to expand/collapse all header items within a header level. */ - allowExpandAll?: boolean; - /** Specifies whether to display the Total rows. */ - showRowTotals?: boolean; - /** Specifies whether to display the Grand Total row. */ - showRowGrandTotals?: boolean; - /** Specifies whether to display the Total columns. */ - showColumnTotals?: boolean; - /** Specifies whether to display the Grand Total column. */ - showColumnGrandTotals?: boolean; - /** Specifies whether or not to hide rows and columns with no data. */ - hideEmptySummaryCells?: boolean; - /** Specifies where to show the total rows or columns. */ - showTotalsPrior?: string; - /** Specifies whether the outer borders of the grid are visible or not. */ - showBorders?: boolean; - /** The Field Chooser configuration options. */ - fieldChooser?: { - /** Enables or disables the field chooser. */ - enabled?: boolean; - /** Specifies the field chooser layout. */ - layout?: number; - /** Specifies the text to display as a title of the field chooser popup window. */ - title?: string; - /** Specifies the field chooser width. */ - width?: number; - /** Specifies the field chooser height. */ - height?: number; - /** Strings that can be changed or localized in the pivot grid's integrated Field Chooser. */ - texts?: { - /** The string to display instead of Row Fields. */ - rowFields?: string; - /** The string to display instead of Column Fields. */ - columnFields?: string; - /** The string to display instead of Data Fields. */ - dataFields?: string; - /** The string to display instead of Filter Fields. */ - filterFields?: string; - /** The string to display instead of All Fields. */ - allFields?: string; - }; - } - /** Strings that can be changed or localized in the dxPivotGrid widget. */ - texts?: { - /** The string to display as a header of the Grand Total row and column. */ - grandTotal?: string; - /** The string to display as a header of the Total row and column. */ - total?: string; - /** Specifies the text displayed when a pivot grid does not contain any fields. */ - noData?: string; - /** The string to display as a Show Field Chooser context menu item. */ - showFieldChooser?: string; - /** The string to display as an Expand All context menu item. */ - expandAll?: string; - /** The string to display as a Collapse All context menu item. */ - collapseAll?: string; - /** The string to display as a Sort Column by Summary Value context menu item. */ - sortColumnBySummary?: string; - /** The string to display as a Sort Row by Summary Value context menu item. */ - sortRowBySummary?: string; - /** The string to display as a Remove All Sorting context menu item. */ - removeAllSorting?: string; - /** The string to display as an Export to Excel file context menu item. */ - exportToExcel?: string; - }; - /** The Load panel configuration options. */ - loadPanel?: { - /** Enables or disables the load panel. */ - enabled?: boolean; - /** Specifies the height of the load panel. */ - height?: number; - /** Specifies the URL pointing to an image that will be used as a load indicator. */ - indicatorSrc?: string; - /** Specifies whether or not to show a load indicator. */ - showIndicator?: boolean; - /** Specifies whether or not to show load panel background. */ - showPane?: boolean; - /** Specifies the text to display inside a load panel. */ - text?: string; - /** Specifies the width of the load panel. */ - width?: number; - }; - /** A handler for the cellClick event. */ - onCellClick?: (e: any) => void; - /** A handler for the cellPrepared event. */ - onCellPrepared?: (e: any) => void; - /** A handler for the contextMenuPreparing event. */ - onContextMenuPreparing?: (e: Object) => void; - /** Specifies options for exporting pivot grid data. */ - export?: { - /** Indicates whether the export feature is enabled for the pivot grid. */ - enabled?: boolean; - /** Specifies a default name for the file to which grid data is exported. */ - fileName?: string; - /** Specifies the URL of the server-side proxy that streams the resulting file to the end user to enable export in IE8, IE9 and Safari browsers. */ - proxyUrl?: string; - }; - /** A handler for the exporting event. */ - onExporting?: (e: { - fileName: string; - cancel: boolean; - }) => void; - /** A handler for the fileSaving event. */ - onFileSaving?: (e: { - fileName: string; - format: string; - data: any; - cancel: boolean; - }) => void; - /** A handler for the exported event. */ - onExported?: (e: Object) => void; - /** A configuration object specifying options related to state storing. */ - stateStoring?: { - /** Specifies a callback function that performs specific actions on state loading. */ - customLoad?: () => JQueryPromise; - /** Specifies a callback function that performs specific actions on state saving. */ - customSave?: (gridState: Object) => void; - /** Specifies whether or not a grid saves its state. */ - enabled?: boolean; - /** Specifies the delay between the last change of a grid state and the operation of saving this state in milliseconds. */ - savingTimeout?: number; - /** Specifies a unique key to be used for storing the grid state. */ - storageKey?: string; - /** Specifies the type of storage to be used for state storing. */ - type?: string; - }; - } - /** A data summarization widget for multi-dimensional data analysis and data mining. */ - export class dxPivotGrid extends Widget { - constructor(element: JQuery, options?: dxPivotGridOptions); - constructor(element: Element, options?: dxPivotGridOptions); - /** Gets the PivotGridDataSource instance. */ - getDataSource(): DevExpress.data.PivotGridDataSource; - /** Gets the dxPopup instance of the field chooser window. */ - getFieldChooserPopup(): DevExpress.ui.dxPopup; - /** Updates the widget to the size of its content. */ - updateDimensions(): void; - /** Exports pivot grid data to the Excel file. */ - exportToExcel(): void; - } - export interface dxPivotGridFieldChooserOptions extends WidgetOptions { - /** Specifies the height of the widget. */ - height?: any; - /** Specifies the field chooser layout. */ - layout?: number; - /** The data source of a dxPivotGrid widget. */ - dataSource?: DevExpress.data.PivotGridDataSource; - onContentReady?: Function; - /** Strings that can be changed or localized in the dxPivotGridFieldChooser widget. */ - texts?: { - /** The string to display instead of Row Fields. */ - rowFields?: string; - /** The string to display instead of Column Fields. */ - columnFields?: string; - /** The string to display instead of Data Fields. */ - dataFields?: string; - /** The string to display instead of Filter Fields. */ - filterFields?: string; - /** The string to display instead of All Fields. */ - allFields?: string; - }; - } - /** A complementary widget for dxPivotGrid that allows you to manage data displayed in the dxPivotGrid. */ - export class dxPivotGridFieldChooser extends Widget { - constructor(element: JQuery, options?: dxPivotGridFieldChooserOptions); - constructor(element: Element, options?: dxPivotGridFieldChooserOptions); - /** Updates the widget to the size of its content. */ - updateDimensions(): void; - } -} -interface JQuery { - dxTreeView(): JQuery; - dxTreeView(options: "instance"): DevExpress.ui.dxTreeView; - dxTreeView(options: string): any; - dxTreeView(options: string, ...params: any[]): any; - dxTreeView(options: DevExpress.ui.dxTreeViewOptions): JQuery; - dxMenuBase(): JQuery; - dxMenuBase(options: "instance"): DevExpress.ui.dxMenuBase; - dxMenuBase(options: string): any; - dxMenuBase(options: string, ...params: any[]): any; - dxMenuBase(options: DevExpress.ui.dxMenuBaseOptions): JQuery; - dxMenu(): JQuery; - dxMenu(options: "instance"): DevExpress.ui.dxMenu; - dxMenu(options: string): any; - dxMenu(options: string, ...params: any[]): any; - dxMenu(options: DevExpress.ui.dxMenuOptions): JQuery; - dxContextMenu(): JQuery; - dxContextMenu(options: "instance"): DevExpress.ui.dxContextMenu; - dxContextMenu(options: string): any; - dxContextMenu(options: string, ...params: any[]): any; - dxContextMenu(options: DevExpress.ui.dxContextMenuOptions): JQuery; - dxColorBox(): JQuery; - dxColorBox(options: "instance"): DevExpress.ui.dxColorBox; - dxColorBox(options: string): any; - dxColorBox(options: string, ...params: any[]): any; - dxColorBox(options: DevExpress.ui.dxColorBoxOptions): JQuery; - dxDataGrid(): JQuery; - dxDataGrid(options: "instance"): DevExpress.ui.dxDataGrid; - dxDataGrid(options: string): any; - dxDataGrid(options: string, ...params: any[]): any; - dxDataGrid(options: DevExpress.ui.dxDataGridOptions): JQuery; - dxPivotGrid(): JQuery; - dxPivotGrid(options: "instance"): DevExpress.ui.dxPivotGrid; - dxPivotGrid(options: string): any; - dxPivotGrid(options: string, ...params: any[]): any; - dxPivotGrid(options: DevExpress.ui.dxPivotGridOptions): JQuery; - dxPivotGridFieldChooser(): JQuery; - dxPivotGridFieldChooser(options: "instance"): DevExpress.ui.dxPivotGridFieldChooser; - dxPivotGridFieldChooser(options: string): any; - dxPivotGridFieldChooser(options: string, ...params: any[]): any; - dxPivotGridFieldChooser(options: DevExpress.ui.dxPivotGridFieldChooserOptions): JQuery; - dxScheduler(): JQuery; - dxScheduler(options: "instance"): DevExpress.ui.dxScheduler; - dxScheduler(options: string): any; - dxScheduler(options: string, ...params: any[]): any; - dxScheduler(options: DevExpress.ui.dxSchedulerOptions): JQuery; -} -declare namespace DevExpress.framework { - /** An object used to store information on the views displayed in an application. */ - export class ViewCache { - viewRemoved: JQueryCallback; - /** Removes all the viewInfo objects from the cache. */ - clear(): void; - /** Obtains a viewInfo object from the cache by the specified key. */ - getView(key: string): Object; - /** Checks whether or not a viewInfo object is contained in the view cache under the specified key. */ - hasView(key: string): boolean; - /** Removes a viewInfo object from the cache by the specified key. */ - removeView(key: string): Object; - /** Adds the specified viewInfo object to the cache under the specified key. */ - setView(key: string, viewInfo: Object): void; - } - export interface dxCommandOptions extends DOMComponentOptions { - /** Specifies an action performed when the execute() method of the command is called. */ - onExecute?: any; - /** Indicates whether or not the widget that displays this command is disabled. */ - disabled?: boolean; - /** Specifies whether the current command is rendered when a view is being rendered or after a view is shown. */ - renderStage?: string; - /** Specifies the name of the icon shown inside the widget associated with this command. */ - icon?: string; - iconSrc?: string; - /** The identifier of the command. */ - id?: string; - /** Specifies the title of the widget associated with this command. */ - title?: string; - /** Specifies the type of the button, if the command is rendered as a dxButton widget. */ - type?: string; - /** A Boolean value specifying whether or not the widget associated with this command is visible. */ - visible?: boolean; - } - /** A markup component used to define markup options for a command. */ - export class dxCommand extends DOMComponent { - constructor(element: JQuery, options: dxCommandOptions); - constructor(options: dxCommandOptions); - /** Executes the action associated with this command. */ - execute(): void; - } - /** An object responsible for routing. */ - export class Router { - /** Adds a routing rule to the list of registered rules. */ - register(pattern: string, defaults?: Object, constraints?: Object): void; - /** Decodes the specified URI to an object using the registered routing rules. */ - parse(uri: string): Object; - /** Formats an object to a URI. */ - format(obj: Object): string; - } - export interface StateManagerOptions { - /** A storage to which the state manager saves the application state. */ - storage?: Object; - } - /** An object used to store the current application state. */ - export class StateManager { - constructor(options?: StateManagerOptions); - /** Adds an object that implements an interface of a state source to the state manager's collection of state sources. */ - addStateSource(stateSource: Object): void; - /** Removes a specified state source from the state manager's collection of state sources. */ - removeStateSource(stateSource: Object): void; - /** Saves the current application state. */ - saveState(): void; - /** Restores the application state that has been saved by the saveState() method to the state storage. */ - restoreState(): void; - /** Removes the application state that has been saved by the saveState() method to the state storage. */ - clearState(): void; - } - export module html { - export var layoutSets: Array; - export var animationSets: { [animationSetName: string]: AnimationSet }; - export interface AnimationSet { - [animationName: string]: any - } - export interface HtmlApplicationOptions { - /** Specifies where the commands that are defined in the application's views must be displayed. */ - commandMapping?: Object; - /** Specifies whether or not view caching is disabled. */ - disableViewCache?: boolean; - /** An array of layout controllers that should be used to show application views in the current navigation context. */ - layoutSet?: any; - /** Specifies the animation presets that are used to animate different UI elements in the current application. */ - animationSet?: AnimationSet; - /** Specifies whether the current application must behave as a mobile or web application. */ - mode?: string; - /** Specifies the object that represents a root namespace of the application. */ - namespace?: Object; - /** Specifies application behavior when the user navigates to a root view. */ - navigateToRootViewMode?: string; - /** An array of dxCommand configuration objects used to define commands available from the application's global navigation. */ - navigation?: Array; - /** A state manager to be used in the application. */ - stateManager?: StateManager; - /** Specifies the storage to be used by the application's state manager to store the application state. */ - stateStorage?: Object; - /** Indicates whether on not to use the title of the previously displayed view as text on the Back button. */ - useViewTitleAsBackText?: boolean; - /** A custom view cache to be used in the application. */ - viewCache?: Object; - /** Specifies a limit for the views that can be cached. */ - viewCacheSize?: number; - /** Specifies the current version of application templates. */ - templatesVersion?: string; - /** Specifies options for the viewport meta tag of a mobile browser. */ - viewPort?: JQuery; - /** A custom router to be used in the application. */ - router?: Router; - } - /** An object used to manage views, as well as control the application life cycle. */ - export class HtmlApplication implements EventsMixin { - constructor(options: HtmlApplicationOptions); - afterViewSetup: JQueryCallback; - beforeViewSetup: JQueryCallback; - initialized: JQueryCallback; - navigating: JQueryCallback; - navigatingBack: JQueryCallback; - resolveLayoutController: JQueryCallback; - resolveViewCacheKey: JQueryCallback; - viewDisposed: JQueryCallback; - viewDisposing: JQueryCallback; - viewHidden: JQueryCallback; - viewRendered: JQueryCallback; - viewShowing: JQueryCallback; - viewShown: JQueryCallback; - /** Provides access to the ViewCache object. */ - viewCache: ViewCache; - /** An array of dxCommand components that are created based on the application's navigation option value. */ - navigation: Array; - /** Provides access to the StateManager object. */ - stateManager: StateManager; - /** Provides access to the Router object. */ - router: Router; - /** Navigates to the URI preceding the current one in the navigation history. */ - back(): void; - /** Returns a Boolean value indicating whether or not backwards navigation is currently possible. */ - canBack(): boolean; - /** Calls the clearState() method of the application's StateManager object. */ - clearState(): void; - /** Creates global navigation commands. */ - createNavigation(navigationConfig: Array): void; - /** Returns an HTML template of the specified view. */ - getViewTemplate(viewName: string): JQuery; - /** Returns a configuration object used to create a dxView component for a specified view. */ - getViewTemplateInfo(viewName: string): Object; - /** Adds a specified HTML template to a collection of view or layout templates. */ - loadTemplates(source: any): JQueryPromise; - /** Navigates to the specified URI. */ - navigate(uri?: any, options?: Object): void; - /** Renders navigation commands to the navigation command containers that are located in the layouts used in the application. */ - renderNavigation(): void; - /** Calls the restoreState() method of the application's StateManager object. */ - restoreState(): void; - /** Calls the saveState method of the application's StateManager object. */ - saveState(): void; - /** Provides access to the object that defines the current context to be considered when choosing an appropriate template for a view. */ - templateContext(): Object; - on(eventName: "initialized", eventHandler: () => void): HtmlApplication; - on(eventName: "afterViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "beforeViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "navigating", eventHandler: (e: { - currentUri: string; - uri: string; - cancel: boolean; - options: { - root: boolean; - target: string; - direction: string; - rootInDetailPane: boolean; - modal: boolean; - }; - }) => void): HtmlApplication; - on(eventName: "navigatingBack", eventHandler: (e: { - cancel: boolean; - isHardwareButton: boolean; - }) => void): HtmlApplication; - on(eventName: "resolveLayoutController", eventHandler: (e: { - viewInfo: Object; - layoutController: Object; - availableLayoutControllers: Array; - }) => void): HtmlApplication; - on(eventName: "resolveViewCacheKey", eventHandler: (e: { - key: string; - navigationItem: Object; - routeData: Object; - }) => void): HtmlApplication; - on(eventName: "viewDisposed", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewDisposing", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewHidden", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewRendered", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewShowing", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - on(eventName: "viewShown", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - on(eventName: string, eventHandler: Function): HtmlApplication; - on(events: { [eventName: string]: Function; }): HtmlApplication; - off(eventName: "initialized"): HtmlApplication; - off(eventName: "afterViewSetup"): HtmlApplication; - off(eventName: "beforeViewSetup"): HtmlApplication; - off(eventName: "navigating"): HtmlApplication; - off(eventName: "navigatingBack"): HtmlApplication; - off(eventName: "resolveLayoutController"): HtmlApplication; - off(eventName: "resolveViewCacheKey"): HtmlApplication; - off(eventName: "viewDisposed"): HtmlApplication; - off(eventName: "viewDisposing"): HtmlApplication; - off(eventName: "viewHidden"): HtmlApplication; - off(eventName: "viewRendered"): HtmlApplication; - off(eventName: "viewShowing"): HtmlApplication; - off(eventName: "viewShown"): HtmlApplication; - off(eventName: string): HtmlApplication; - off(eventName: "initialized", eventHandler: () => void): HtmlApplication; - off(eventName: "afterViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "beforeViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "navigating", eventHandler: (e: { - currentUri: string; - uri: string; - cancel: boolean; - options: { - root: boolean; - target: string; - direction: string; - rootInDetailPane: boolean; - modal: boolean; - }; - }) => void): HtmlApplication; - off(eventName: "navigatingBack", eventHandler: (e: { - cancel: boolean; - isHardwareButton: boolean; - }) => void): HtmlApplication; - off(eventName: "resolveLayoutController", eventHandler: (e: { - viewInfo: Object; - layoutController: Object; - availableLayoutControllers: Array; - }) => void): HtmlApplication; - off(eventName: "resolveViewCacheKey", eventHandler: (e: { - key: string; - navigationItem: Object; - routeData: Object; - }) => void): HtmlApplication; - off(eventName: "viewDisposed", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewDisposing", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewHidden", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewRendered", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewShowing", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - off(eventName: "viewShown", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - off(eventName: string, eventHandler: Function): HtmlApplication; - } - } -} -declare namespace DevExpress.viz.core { - /** - * Applies a theme for the entire page with several DevExtreme visualization widgets. - * @deprecated Use the DevExpress.viz.currentTheme(theme) method instead. - */ - export function currentTheme(theme: string): void; - /** - * Applies a new theme (with the color scheme defined separately) for the entire page with several DevExtreme visualization widgets. - * @deprecated Use the DevExpress.viz.currentTheme(platform, colorScheme) method instead. - */ - export function currentTheme(platform: string, colorScheme: string): void; - /** - * Registers a new theme based on the existing one. - * @deprecated Use the DevExpress.viz.registerTheme(customTheme, baseTheme) method instead. - */ - export function registerTheme(customTheme: Object, baseTheme: string): void; - /** - * Applies a predefined or registered custom palette to all visualization widgets at once. - * @deprecated Use the DevExpress.viz.currentPalette(paletteName) method instead. - */ - export function currentPalette(paletteName: string): void; - /** - * Obtains the color sets of a predefined or registered palette. - * @deprecated Use the DevExpress.viz.getPalette(paletteName) method instead. - */ - export function getPalette(paletteName: string): Object; - /** - * Registers a new palette. - * @deprecated Use the DevExpress.viz.registerPalette(paletteName, palette) method instead. - */ - export function registerPalette(paletteName: string, palette: Object): void; - export interface Border { - /** Sets a border color for a selected series. */ - color?: string; - /** Sets border visibility for a selected series. */ - visible?: boolean; - /** Sets a border width for a selected series. */ - width?: number; - } - export interface DashedBorder extends Border { - /** Specifies a dash style for the border of a selected series point. */ - dashStyle?: string; - } - export interface DashedBorderWithOpacity extends DashedBorder { - /** Specifies the opacity of the tooltip's border. */ - opacity?: number; - } - export interface Font { - /** Specifies the font color for a strip label. */ - color?: string; - /** Specifies the font family for a strip label. */ - family?: string; - /** Specifies the font opacity for a strip label. */ - opacity?: number; - /** Specifies the font size for a strip label. */ - size?: any; - /** Specifies the font weight for the text displayed in strips. */ - weight?: number; - } - export interface Hatching { - direction?: string; - /** Specifies the opacity of hatching lines. */ - opacity?: number; - /** Specifies the distance between hatching lines in pixels. */ - step?: number; - /** Specifies the width of hatching lines in pixels. */ - width?: number; - } - export interface Margins { - /** Specifies the distance in pixels between the bottom side of the title and the surrounding widget elements. */ - bottom?: number; - /** Specifies the distance in pixels between the left side of the title and the surrounding widget elements. */ - left?: number; - /** Specifies the distance between the right side of the title and surrounding widget elements in pixels. */ - right?: number; - /** Specifies the distance between the top side of the title and surrounding widget elements in pixels. */ - top?: number; - } - export interface Size { - /** Specifies the width of the widget. */ - width?: number; - /** Specifies the height of the widget. */ - height?: number; - } - export interface Title { - /** Specifies font options for the title. */ - font?: viz.core.Font; - /** Specifies the widget title's horizontal position. */ - horizontalAlignment?: string; - /** Specifies the widget title's position in the vertical direction. */ - verticalAlignment?: string; - /** Specifies the distance between the title and surrounding widget elements in pixels. */ - margin?: viz.core.Margins; - /** Specifies the height of the space reserved for the title. */ - placeholderSize?: number; - /** Specifies text for the title. */ - text?: string; - /** Specifies a subtitle for the widget. */ - subtitle?: { - /** Specifies font options for the subtitle. */ - font?: viz.core.Font; - /** Specifies text for the subtitle. */ - text?: string; - } - } - export interface Tooltip { - /** Specifies the length of the tooltip's arrow in pixels. */ - arrowLength?: number; - /** Specifies the appearance of the tooltip's border. */ - border?: viz.core.DashedBorderWithOpacity; - /** Specifies a color for the tooltip. */ - color?: string; - /** Specifies the z-index for tooltips. */ - zIndex?: number; - /** Specifies the container to draw tooltips inside of it. */ - container?: any; - /** Specifies text and appearance of a set of tooltips. */ - customizeTooltip?: (arg: Object) => { color?: string; text?: string }; - /** Specifies whether or not the tooltip is enabled. */ - enabled?: boolean; - /** Specifies font options for the text displayed by the tooltip. */ - font?: Font; - /** Specifies a format for the text displayed by the tooltip. */ - format?: string; - /** Specifies the opacity of a tooltip. */ - opacity?: number; - /** Specifies a distance from the tooltip's left/right boundaries to the inner text in pixels. */ - paddingLeftRight?: number; - /** Specifies a distance from the tooltip's top/bottom boundaries to the inner text in pixels. */ - paddingTopBottom?: number; - /** Specifies a precision for formatted values displayed by the tooltip. */ - precision?: number; - /** Specifies options of the tooltip's shadow. */ - shadow?: { - /** Specifies the blur distance of the tooltip's shadow. */ - blur?: number; - /** Specifies the color of the tooltip's shadow. */ - color?: string; - /** Specifies the horizontal offset of the tooltip's shadow relative to the tooltip in pixels. */ - offsetX?: number; - /** Specifies the vertical offset of the tooltip's shadow relative to the tooltip in pixels. */ - offsetY?: number; - /** Specifies the opacity of the tooltip's shadow. */ - opacity?: number; - }; - } - export interface Animation { - /** Determines how long animation runs. */ - duration?: number; - /** Specifies the animation easing mode. */ - easing?: string; - /** Indicates whether or not animation is enabled. */ - enabled?: boolean; - } - export interface LoadingIndicator { - /** Specifies a color for the loading indicator background. */ - backgroundColor?: string; - /** Specifies font options for the loading indicator text. */ - font?: viz.core.Font; - /** Specifies whether to show the loading indicator or not. */ - show?: boolean; - /** Specifies a text to be displayed by the loading indicator. */ - text?: string; - } - export interface LegendBorder extends viz.core.DashedBorderWithOpacity { - /** Specifies a radius for the corners of the legend border. */ - cornerRadius?: number; - } - export interface BaseLegend { - /** Specifies the color of the legend's background. */ - backgroundColor?: string; - /** Specifies legend border settings. */ - border?: viz.core.LegendBorder; - /** Specifies how many columns must be taken to arrange legend items. */ - columnCount?: number; - /** Specifies the spacing between a pair of neighboring legend columns in pixels. */ - columnItemSpacing?: number; - /** Specifies font options for legend items. */ - font?: viz.core.Font; - /** Specifies the legend's position on the map. */ - horizontalAlignment?: string; - /** Specifies the alignment of legend items. */ - itemsAlignment?: string; - /** Specifies the position of text relative to the item marker. */ - itemTextPosition?: string; - /** Specifies the distance between the legend and the container borders in pixels. */ - margin?: viz.core.Margins; - /** Specifies the size of item markers in the legend in pixels. */ - markerSize?: number; - /** Specifies whether to arrange legend items horizontally or vertically. */ - orientation?: string; - /** Specifies the spacing between the legend left/right border and legend items in pixels. */ - paddingLeftRight?: number; - /** Specifies the spacing between the legend top/bottom border and legend items in pixels. */ - paddingTopBottom?: number; - /** Specifies how many rows must be taken to arrange legend items. */ - rowCount?: number; - /** Specifies the spacing between a pair of neighboring legend rows in pixels. */ - rowItemSpacing?: number; - /** Specifies the legend's position on the map. */ - verticalAlignment?: string; - /** Specifies whether or not the legend is visible on the map. */ - visible?: boolean; - } - export interface BaseWidgetOptions extends DOMComponentOptions { - /** A handler for the drawn event. */ - onDrawn?: (e: { - component: BaseWidget; - element: Element; - }) => void; - /** A handler for the incidentOccurred event. */ - onIncidentOccurred?: ( - component: BaseWidget, - element: Element, - target: { - id: string; - type: string; - args: any; - text: string; - widget: string; - version: string; - } - ) => void; - /** Notifies a widget that it is embedded into an HTML page that uses a path modifier. */ - pathModified?: boolean; - /** Specifies whether or not the widget supports right-to-left representation. */ - rtlEnabled?: boolean; - /** Sets the name of the theme to be used in the widget. */ - theme?: string; - } - /** This section describes options and methods that are common to all widgets. */ - export class BaseWidget extends DOMComponent { - /** Returns the widget's SVG markup. */ - svg(): string; - } -} -declare namespace DevExpress.viz.charts { - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface BaseSeries { - /** Provides information about the state of the series object. */ - fullState: number; - /** Returns the type of the series. */ - type: string; - /** Unselects all the selected points of the series. The points are displayed in an initial style. */ - clearSelection(): void; - /** Gets the color of a particular series. */ - getColor(): string; - /** Gets points from the series point collection based on the specified argument. */ - getPointsByArg(pointArg: any): Array; - /** Gets a point from the series point collection based on the specified point position. */ - getPointByPos(positionIndex: number): Object; - /** Selects the series. The series is displayed in a 'selected' style until another series is selected or the current series is deselected programmatically. */ - select(): void; - /** Selects the specified point. The point is displayed in a 'selected' style. */ - selectPoint(point: BasePoint): void; - /** Deselects the specified point. The point is displayed in an initial style. */ - deselectPoint(point: BasePoint): void; - /** Returns an array of all points in the series. */ - getAllPoints(): Array; - /** Returns visible series points. */ - getVisiblePoints(): Array; - /** Returns the name of the series. */ - name: string; - /** Returns the tag of the series. */ - tag: string; - /** Hides a series. */ - hide(): void; - /** Provides information about the hover state of a series. */ - isHovered(): boolean; - /** Provides information about the selection state of a series. */ - isSelected(): boolean; - /** Provides information about the visibility state of a series. */ - isVisible(): boolean; - /** Makes a particular series visible. */ - show(): void; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface BasePoint { - /** Provides information about the state of the point object. */ - fullState: number; - /** Returns the point's argument value that was set in the data source. */ - originalArgument: any; - /** Returns the point's value that was set in the data source. */ - originalValue: any; - /** Returns the tag of the point. */ - tag: string; - /** Deselects the point. */ - clearSelection(): void; - /** Gets the color of a particular point. */ - getColor(): string; - /** Hides the tooltip of the point. */ - hideTooltip(): void; - /** Provides information about the hover state of a point. */ - isHovered(): boolean; - /** Provides information about the selection state of a point. */ - isSelected(): boolean; - /** Selects the point. The point is displayed in a 'selected' style until another point is selected or the current point is deselected programmatically. */ - select(): void; - /** Shows the tooltip of the point. */ - showTooltip(): void; - /** Allows you to obtain the label of a series point. */ - getLabel(): any; - /** Returns the series object to which the point belongs. */ - series: BaseSeries; - } - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface ChartSeries extends BaseSeries { - /** Returns the name of the series pane. */ - pane: string; - /** Returns the name of the value axis of the series. */ - axis: string; - selectPoint(point: ChartPoint): void; - deselectPoint(point: ChartPoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface ChartPoint extends BasePoint { - /** Contains the close value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalCloseValue: any; - /** Contains the high value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalHighValue: any; - /** Contains the low value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalLowValue: any; - /** Contains the first value of the point. This field is useful for points belonging to a series of the range area or range bar type only. */ - originalMinValue: any; - /** Contains the open value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalOpenValue: any; - /** Contains the size of the bubble as it was set in the data source. This field is useful for points belonging to a series of the bubble type only. */ - size: any; - /** Gets the parameters of the point's minimum bounding rectangle (MBR). */ - getBoundingRect(): { x: number; y: number; width: number; height: number; }; - series: ChartSeries; - } - /** This section describes the methods that can be used in code to manipulate the Label object. */ - export interface Label { - /** Gets the parameters of the label's minimum bounding rectangle (MBR). */ - getBoundingRect(): { x: number; y: number; width: number; height: number; }; - /** Hides the point label. */ - hide(): void; - /** Shows the point label. */ - show(): void; - } - export interface PieSeries extends BaseSeries { - selectPoint(point: PiePoint): void; - deselectPoint(point: PiePoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface PiePoint extends BasePoint { - /** Gets the percentage value of the specific point. */ - percent: any; - /** Provides information about the visibility state of a point. */ - isVisible(): boolean; - /** Makes a specific point visible. */ - show(): void; - /** Hides a specific point. */ - hide(): void; - series: PieSeries; - } - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface PolarSeries extends BaseSeries { - /** Returns the name of the value axis of the series. */ - axis: string; - selectPoint(point: PolarPoint): void; - deselectPoint(point: PolarPoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface PolarPoint extends BasePoint { - series: PolarSeries; - } - export interface Strip { - /** Specifies a color for a strip. */ - color?: string; - /** An object that defines the label configuration options of a strip. */ - label?: { - /** Specifies the text displayed in a strip. */ - text?: string; - }; - /** Specifies a start value for a strip. */ - startValue?: any; - /** Specifies an end value for a strip. */ - endValue?: any; - } - export interface BaseSeriesConfigLabel { - /** Specifies a format for arguments displayed by point labels. */ - argumentFormat?: string; - /** Specifies a precision for formatted point arguments displayed in point labels. */ - argumentPrecision?: number; - /** Specifies a background color for point labels. */ - backgroundColor?: string; - /** Specifies border options for point labels. */ - border?: viz.core.DashedBorder; - /** Specifies connector options for series point labels. */ - connector?: { - /** Specifies the color of label connectors. */ - color?: string; - /** Indicates whether or not label connectors are visible. */ - visible?: boolean; - /** Specifies the width of label connectors. */ - width?: number; - }; - /** Specifies a callback function that returns the text to be displayed by point labels. */ - customizeText?: (pointInfo: Object) => string; - /** Specifies font options for the text displayed in point labels. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed by point labels. */ - format?: string; - position?: string; - /** Specifies a precision for formatted point values displayed in point labels. */ - precision?: number; - /** Specifies the angle used to rotate point labels from their initial position. */ - rotationAngle?: number; - /** Specifies the visibility of point labels. */ - visible?: boolean; - } - export interface SeriesConfigLabel extends BaseSeriesConfigLabel { - /** Specifies whether or not to show a label when the point has a zero value. */ - showForZeroValues?: boolean; - } - export interface ChartSeriesConfigLabel extends SeriesConfigLabel { - /** Specifies how to align point labels relative to the corresponding data points that they represent. */ - alignment?: string; - /** Specifies how to shift point labels horizontally from their initial positions. */ - horizontalOffset?: number; - /** Specifies how to shift point labels vertically from their initial positions. */ - verticalOffset?: number; - /** Specifies a precision for the percentage values displayed in the labels of a full-stacked-like series. */ - percentPrecision?: number; - } - export interface BaseCommonSeriesConfig { - /** Specifies the data source field that provides arguments for series points. */ - argumentField?: string; - axis?: string; - /** An object defining the label configuration options for a series in the dxChart widget. */ - label?: ChartSeriesConfigLabel; - /** Specifies border options for point labels. */ - border?: viz.core.DashedBorder; - /** Specifies a series color. */ - color?: string; - /** Specifies the dash style of the series' line. */ - dashStyle?: string; - hoverMode?: string; - hoverStyle?: { - /** An object defining the border options for a hovered series. */ - border?: viz.core.DashedBorder; - /**

Sets a color for a series when it is hovered over.

*/ - color?: string; - /** Specifies the dash style for the line in a hovered series. */ - dashStyle?: string; - hatching?: viz.core.Hatching; - /** Specifies the width of a line in a hovered series. */ - width?: number; - }; - /** Specifies whether a chart ignores null data points or not. */ - ignoreEmptyPoints?: boolean; - /** Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed. */ - maxLabelCount?: number; - /** Specifies the minimal length of a displayed bar in pixels. */ - minBarSize?: number; - /** Specifies opacity for a series. */ - opacity?: number; - /** Specifies the series elements to highlight when the series is selected. */ - selectionMode?: string; - selectionStyle?: { - /** An object defining the border options for a selected series. */ - border?: viz.core.DashedBorder; - /** Sets a color for a series when it is selected. */ - color?: string; - /** Specifies the dash style for the line in a selected series. */ - dashStyle?: string; - hatching?: viz.core.Hatching; - /** Specifies the width of a line in a selected series. */ - width?: number; - }; - /** Specifies whether or not to show the series in the chart's legend. */ - showInLegend?: boolean; - /** Specifies the name of the stack where the values of the _stackedBar_ series must be located. */ - stack?: string; - /** Specifies the name of the data source field that provides data about a point. */ - tagField?: string; - /** Specifies the data source field that provides values for series points. */ - valueField?: string; - /** Specifies the visibility of a series. */ - visible?: boolean; - /** Specifies a line width. */ - width?: number; - /** Configures error bars. */ - valueErrorBar?: { - /** Specifies whether error bars must be displayed in full or partially. */ - displayMode?: string; - /** Specifies the data field that provides data for low error values. */ - lowValueField?: string; - /** Specifies the data field that provides data for high error values. */ - highValueField?: string; - /** Specifies how error bar values must be calculated. */ - type?: string; - /** Specifies the value to be used for generating error bars. */ - value?: number; - /** Specifies the color of error bars. */ - color?: string; - /** Specifies the opacity of error bars. */ - opacity?: number; - /** Specifies the length of the lines that indicate the error bar edges. */ - edgeLength?: number; - /** Specifies the width of the error bar line. */ - lineWidth?: number; - }; - } - export interface CommonPointOptions { - /** Specifies border options for points in the line and area series. */ - border?: viz.core.Border; - /** Specifies the points color. */ - color?: string; - /** Specifies what series points to highlight when a point is hovered over. */ - hoverMode?: string; - /** An object defining configuration options for a hovered point. */ - hoverStyle?: { - /** An object defining the border options for a hovered point. */ - border?: viz.core.Border; - /** Sets a color for a point when it is hovered over. */ - color?: string; - /** Specifies the diameter of a hovered point in the series that represents data points as symbols (not as bars for instance). */ - size?: number; - }; - /** Specifies what series points to highlight when a point is selected. */ - selectionMode?: string; - /** An object defining configuration options for a selected point. */ - selectionStyle?: { - /** An object defining the border options for a selected point. */ - border?: viz.core.Border; - /**

Sets a color for a point when it is selected.

*/ - color?: string; - /** Specifies the diameter of a selected point in the series that represents data points as symbols (not as bars for instance). */ - size?: number; - }; - /** Specifies the point diameter in pixels for those series that represent data points as symbols (not as bars for instance). */ - size?: number; - /** Specifies a symbol for presenting points of the line and area series. */ - symbol?: string; - visible?: boolean; - } - export interface ChartCommonPointOptions extends CommonPointOptions { - /** An object specifying the parameters of an image that is used as a point marker. */ - image?: { - /** Specifies the height of an image that is used as a point marker. */ - height?: any; - /** Specifies a URL leading to the image to be used as a point marker. */ - url?: any; - /** Specifies the width of an image that is used as a point marker. */ - width?: any; - }; - } - export interface PolarCommonPointOptions extends CommonPointOptions { - /** An object specifying the parameters of an image that is used as a point marker. */ - image?: { - /** Specifies the height of an image that is used as a point marker. */ - height?: number; - /** Specifies a URL leading to the image to be used as a point marker. */ - url?: string; - /** Specifies the width of an image that is used as a point marker. */ - width?: number; - }; - } - /** An object that defines configuration options for chart series. */ - export interface CommonSeriesConfig extends BaseCommonSeriesConfig { - /** Specifies the data source field that provides a 'close' value for a _candleStick_ or _stock_ series. */ - closeValueField?: string; - /** Specifies a radius for bar corners. */ - cornerRadius?: number; - /** Specifies the data source field that provides a 'high' value for a _candleStick_ or _stock_ series. */ - highValueField?: string; - /** Specifies the color for the body (rectangle) of a _candleStick_ series. */ - innerColor?: string; - /** Specifies the data source field that provides a 'low' value for a _candleStick_ or _stock_ series. */ - lowValueField?: string; - /** Specifies the data source field that provides an 'open' value for a _candleStick_ or _stock_ series. */ - openValueField?: string; - /** Specifies the pane that will be used to display a series. */ - pane?: string; - /** An object defining configuration options for points in line-, scatter- and area-like series. */ - point?: ChartCommonPointOptions; - /** Specifies the data source field that provides values for one end of a range series. To set the data source field for the other end of the range series, use the rangeValue2Field property. */ - rangeValue1Field?: string; - /** Specifies the data source field that provides values for the second end of a range series. To set the data source field for the other end of the range series, use the rangeValue1Field property. */ - rangeValue2Field?: string; - /** Specifies reduction options for the stock or candleStick series. */ - reduction?: { - /** Specifies a color for the points whose reduction level price is lower in comparison to the value in the previous point. */ - color?: string; - /** Specifies for which price level (open, high, low or close) to enable reduction options in the series. */ - level?: string; - }; - /** Specifies the data source field that defines the size of bubbles. */ - sizeField?: string; - } - export interface CommonSeriesSettings extends CommonSeriesConfig { - /**

An object that specifies configuration options for all series of the area type in the chart.

*/ - area?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _bar_ type in the chart. */ - bar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the bubble type in the chart. */ - bubble?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _candleStick_ type in the chart. */ - candlestick?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _fullStackedArea_ type in the chart. */ - fullstackedarea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Full-Stacked Spline Area type in the chart. */ - fullstackedsplinearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _fullStackedBar_ type in the chart. */ - fullstackedbar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _fullStackedLine_ type in the chart. */ - fullstackedline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Full-Stacked Spline type in the chart. */ - fullstackedspline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _line_ type in the chart. */ - line?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _rangeArea_ type in the chart. */ - rangearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _rangeBar_ type in the chart. */ - rangebar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _scatter_ type in the chart. */ - scatter?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _spline_ type in the chart. */ - spline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _splineArea_ type in the chart. */ - splinearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedArea_ type in the chart. */ - stackedarea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Stacked Spline Area type in the chart. */ - stackedsplinearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedBar_ type in the chart. */ - stackedbar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedLine_ type in the chart. */ - stackedline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Stacked Spline type in the chart. */ - stackedspline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stepArea_ type in the chart. */ - steparea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stepLine_ type in the chart. */ - stepline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stock_ type in the chart. */ - stock?: CommonSeriesConfig; - /** Sets a series type. */ - type?: string; - } - export interface SeriesConfig extends CommonSeriesConfig { - /** Specifies the name that identifies the series. */ - name?: string; - /** Specifies data about a series. */ - tag?: any; - /** Sets the series type. */ - type?: string; - } - /** An object that defines configuration options for polar chart series. */ - export interface CommonPolarSeriesConfig extends BaseCommonSeriesConfig { - /** Specifies whether or not to close the chart by joining the end point with the first point. */ - closed?: boolean; - label?: SeriesConfigLabel; - point?: PolarCommonPointOptions; - } - export interface CommonPolarSeriesSettings extends CommonPolarSeriesConfig { - /** An object that specifies configuration options for all series of the area type in the chart. */ - area?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _bar_ type in the chart. */ - bar?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _line_ type in the chart. */ - line?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _scatter_ type in the chart. */ - scatter?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedBar_ type in the chart. */ - stackedbar?: CommonPolarSeriesConfig; - /** Sets a series type. */ - type?: string; - } - export interface PolarSeriesConfig extends CommonPolarSeriesConfig { - /** Specifies the name that identifies the series. */ - name?: string; - /** Specifies data about a series. */ - tag?: any; - /** Sets the series type. */ - type?: string; - } - export interface PieSeriesConfigLabel extends BaseSeriesConfigLabel { - /** Specifies how to shift labels from their initial position in a radial direction in pixels. */ - radialOffset?: number; - /** Specifies a precision for the percentage values displayed in labels. */ - percentPrecision?: number; - } - /** An object that defines configuration options for chart series. */ - export interface CommonPieSeriesConfig { - /** Specifies the data source field that provides arguments for series points. */ - argumentField?: string; - /** Specifies the required type for series arguments. */ - argumentType?: string; - /** An object defining the series border configuration options. */ - border?: viz.core.DashedBorder; - /** Specifies a series color. */ - color?: string; - /** Specifies the chart elements to highlight when a series is hovered over. */ - hoverMode?: string; - /** An object defining configuration options for a hovered series. */ - hoverStyle?: { - /** An object defining the border options for a hovered series. */ - border?: viz.core.DashedBorder; - /** Sets a color for the series when it is hovered over. */ - color?: string; - /** Specifies the hatching options to be applied when a point is hovered over. */ - hatching?: viz.core.Hatching; - }; - /** - * Specifies the fraction of the inner radius relative to the total radius in the series of the 'doughnut' type. - * @deprecated use the 'innerRadius' option instead - */ - innerRadius?: number; - /** An object defining the label configuration options. */ - label?: PieSeriesConfigLabel; - /** Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed. */ - maxLabelCount?: number; - /** Specifies a minimal size of a displayed pie segment. */ - minSegmentSize?: number; - /** - * Specifies the direction in which the dxPieChart series points are located. - * @deprecated use the 'segmentsDirection' option instead - */ - segmentsDirection?: string; - /**

Specifies the chart elements to highlight when the series is selected.

*/ - selectionMode?: string; - /** An object defining configuration options for the series when it is selected. */ - selectionStyle?: { - /** An object defining the border options for a selected series. */ - border?: viz.core.DashedBorder; - /** Sets a color for a series when it is selected. */ - color?: string; - /** Specifies the hatching options to be applied when a point is selected. */ - hatching?: viz.core.Hatching; - }; - /** Specifies chart segment grouping options. */ - smallValuesGrouping?: { - /** Specifies the name of the grouped chart segment. This name represents the segment in the chart legend. */ - groupName?: string; - /** Specifies the segment grouping mode. */ - mode?: string; - /** Specifies a threshold for segment values. */ - threshold?: number; - /** Specifies how many segments must not be grouped. */ - topCount?: number; - }; - /** - * Specifies a start angle for a pie chart in arc degrees. - * @deprecated use the 'startAngle' option instead - */ - startAngle?: number; - /**

Specifies the name of the data source field that provides data about a point.

*/ - tagField?: string; - /** Specifies the data source field that provides values for series points. */ - valueField?: string; - } - export interface CommonPieSeriesSettings extends CommonPieSeriesConfig { - /** - * Specifies the type of the pie chart series. - * @deprecated use the 'type' option instead - */ - type?: string; - } - export interface PieSeriesConfig extends CommonPieSeriesConfig { - /** - * Sets the series type. - * @deprecated use the 'type' option instead - */ - type?: string; - /** Specifies the name that identifies the series. */ - name?: string; - /** Specifies data about a series. */ - tag?: any; - } - export interface SeriesTemplate { - /** Specifies a callback function that returns a series object with individual series settings. */ - customizeSeries?: (seriesName: string) => SeriesConfig; - /** Specifies a data source field that represents the series name. */ - nameField?: string; - } - export interface PolarSeriesTemplate { - /** Specifies a callback function that returns a series object with individual series settings. */ - customizeSeries?: (seriesName: string) => PolarSeriesConfig; - /** Specifies a data source field that represents the series name. */ - nameField?: string; - } - export interface ChartCommonConstantLineLabel { - /** Specifies font options for a constant line label. */ - font?: viz.core.Font; - /** Specifies the position of the constant line label relative to the chart plot. */ - position?: string; - /** Indicates whether or not to display labels for the axis constant lines. */ - visible?: boolean; - } - export interface PolarCommonConstantLineLabel { - /** Indicates whether or not to display labels for the axis constant lines. */ - visible?: boolean; - /** Specifies font options for a constant line label. */ - font?: viz.core.Font; - } - export interface ConstantLineStyle { - /** Specifies a color for a constant line. */ - color?: string; - /** Specifies a dash style for a constant line. */ - dashStyle?: string; - /** Specifies a constant line width in pixels. */ - width?: number; - } - export interface ChartCommonConstantLineStyle extends ConstantLineStyle { - /** An object defining constant line label options. */ - label?: ChartCommonConstantLineLabel; - /** Specifies the space between the constant line label and the left/right side of the constant line. */ - paddingLeftRight?: number; - /** Specifies the space between the constant line label and the top/bottom side of the constant line. */ - paddingTopBottom?: number; - } - export interface PolarCommonConstantLineStyle extends ConstantLineStyle { - /** An object defining constant line label options. */ - label?: PolarCommonConstantLineLabel; - } - export interface CommonAxisLabel { - /** Specifies font options for axis labels. */ - font?: viz.core.Font; - /** Specifies the spacing between an axis and its labels in pixels. */ - indentFromAxis?: number; - /** Indicates whether or not axis labels are visible. */ - visible?: boolean; - } - export interface ChartCommonAxisLabel extends CommonAxisLabel { - /** Specifies the label's position relative to the tick (grid line). */ - alignment?: string; - /** Specifies the overlap resolving algorithm to be applied to axis labels. */ - overlappingBehavior?: { - /** Specifies how to arrange axis labels. */ - mode?: string; - /** Specifies the angle used to rotate axis labels. */ - rotationAngle?: number; - /** Specifies the spacing that must be set between staggered rows when the 'stagger' algorithm is applied. */ - staggeringSpacing?: number; - }; - } - export interface PolarCommonAxisLabel extends CommonAxisLabel { - /** Specifies the overlap resolving algorithm to be applied to axis labels. */ - overlappingBehavior?: string; - } - export interface CommonAxisTitle { - /** Specifies font options for an axis title. */ - font?: viz.core.Font; - /** Specifies a margin for an axis title in pixels. */ - margin?: number; - } - export interface BaseCommonAxisSettings { - /** Specifies the color of the line that represents an axis. */ - color?: string; - /** Specifies whether ticks/grid lines of a discrete axis are located between labels or cross the labels. */ - discreteAxisDivisionMode?: string; - /** An object defining the configuration options for the grid lines of an axis in the dxPolarChart widget. */ - grid?: { - /** Specifies a color for grid lines. */ - color?: string; - /** Specifies an opacity for grid lines. */ - opacity?: number; - /** Indicates whether or not the grid lines of an axis are visible. */ - visible?: boolean; - /** Specifies the width of grid lines. */ - width?: number; - }; - /** Specifies the options of the minor grid. */ - minorGrid?: { - /** Specifies a color for the lines of the minor grid. */ - color?: string; - /** Specifies an opacity for the lines of the minor grid. */ - opacity?: number; - /** Indicates whether the minor grid is visible or not. */ - visible?: boolean; - /** Specifies a width for the lines of the minor grid. */ - width?: number; - }; - /** Indicates whether or not an axis is inverted. */ - inverted?: boolean; - /** Specifies the opacity of the line that represents an axis. */ - opacity?: number; - /** Indicates whether or not to set ticks/grid lines of a continuous axis of the 'date-time' type at the beginning of each date-time interval. */ - setTicksAtUnitBeginning?: boolean; - /** An object defining the configuration options for axis ticks. */ - tick?: { - /** Specifies ticks color. */ - color?: string; - /** Specifies tick opacity. */ - opacity?: number; - /** Indicates whether or not ticks are visible on an axis. */ - visible?: boolean; - /** Specifies tick width. */ - width?: number; - /** Specifies tick length. */ - length?: number; - }; - /** Specifies the options of the minor ticks. */ - minorTick?: { - /** Specifies a color for the minor ticks. */ - color?: string; - /** Specifies an opacity for the minor ticks. */ - opacity?: number; - /** Indicates whether or not the minor ticks are displayed on an axis. */ - visible?: boolean; - /** Specifies minor tick width. */ - width?: number; - /** Specifies minor tick length. */ - length?: number; - }; - /** Indicates whether or not the line that represents an axis in a chart is visible. */ - visible?: boolean; - /** Specifies the width of the line that represents an axis in the chart. */ - width?: number; - } - export interface ChartCommonAxisSettings extends BaseCommonAxisSettings { - /** Specifies the appearance of all the widget's constant lines. */ - constantLineStyle?: ChartCommonConstantLineStyle; - /** An object defining the label configuration options that are common for all axes in the dxChart widget. */ - label?: ChartCommonAxisLabel; - /** Specifies a coefficient that determines the spacing between the maximum series point and the axis. */ - maxValueMargin?: number; - /** Specifies a coefficient that determines the spacing between the minimum series point and the axis. */ - minValueMargin?: number; - /** Specifies, in pixels, the space reserved for an axis. */ - placeholderSize?: number; - /** An object defining configuration options for strip style. */ - stripStyle?: { - /** An object defining the configuration options for a strip label style. */ - label?: { - /** Specifies font options for a strip label. */ - font?: viz.core.Font; - /** Specifies the label's position on a strip. */ - horizontalAlignment?: string; - /** Specifies a label's position on a strip. */ - verticalAlignment?: string; - }; - /** Specifies the spacing, in pixels, between the left/right strip border and the strip label. */ - paddingLeftRight?: number; - /** Specifies the spacing, in pixels, between the top/bottom strip borders and the strip label. */ - paddingTopBottom?: number; - }; - /** An object defining the title configuration options that are common for all axes in the dxChart widget. */ - title?: CommonAxisTitle; - /** Indicates whether or not to display series with indents from axis boundaries. */ - valueMarginsEnabled?: boolean; - } - export interface PolarCommonAxisSettings extends BaseCommonAxisSettings { - /** Specifies the appearance of all the widget's constant lines. */ - constantLineStyle?: PolarCommonConstantLineStyle; - /** An object defining the label configuration options that are common for all axes in the dxPolarChart widget. */ - label?: PolarCommonAxisLabel; - /** An object defining configuration options for strip style. */ - stripStyle?: { - /** An object defining the configuration options for a strip label style. */ - label?: { - /** Specifies font options for a strip label. */ - font?: viz.core.Font; - }; - }; - } - export interface ChartConstantLineLabel extends ChartCommonConstantLineLabel { - /** Specifies the horizontal alignment of a constant line label. */ - horizontalAlignment?: string; - /** Specifies the vertical alignment of a constant line label. */ - verticalAlignment?: string; - /** Specifies the text to be displayed in a constant line label. */ - text?: string; - } - export interface PolarConstantLineLabel extends PolarCommonConstantLineLabel { - /** Specifies the text to be displayed in a constant line label. */ - text?: string; - } - export interface AxisLabel { - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a label on the value axis. */ - customizeHint?: (argument: { value: any; valueText: string }) => string; - /** Specifies a callback function that returns the text to be displayed in value axis labels. */ - customizeText?: (argument: { value: any; valueText: string }) => string; - /** Specifies a format for the text displayed by axis labels. */ - format?: string; - /** Specifies a precision for the formatted value displayed in the axis labels. */ - precision?: number; - } - export interface ChartAxisLabel extends ChartCommonAxisLabel, AxisLabel { } - export interface PolarAxisLabel extends PolarCommonAxisLabel, AxisLabel { } - export interface AxisTitle extends CommonAxisTitle { - /** Specifies the text for the value axis title. */ - text?: string; - } - export interface ChartConstantLineStyle extends ChartCommonConstantLineStyle { - /** An object defining constant line label options. */ - label?: ChartConstantLineLabel; - } - export interface ChartConstantLine extends ChartConstantLineStyle { - /** An object defining constant line label options. */ - label?: ChartConstantLineLabel; - /** Specifies a value to be displayed by a constant line. */ - value?: any; - } - export interface PolarConstantLine extends PolarCommonConstantLineStyle { - /** An object defining constant line label options. */ - label?: PolarConstantLineLabel; - /** Specifies a value to be displayed by a constant line. */ - value?: any; - } - export interface Axis { - /** Specifies a coefficient for dividing the value axis. */ - axisDivisionFactor?: number; - /** Specifies the order in which discrete values are arranged on the value axis. */ - categories?: Array; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic axis. */ - logarithmBase?: number; - /** Specifies an interval between axis ticks/grid lines. */ - tickInterval?: any; - /** Specifies the interval between minor ticks. */ - minorTickInterval?: any; - /** Specifies the number of minor ticks between two neighboring major ticks. */ - minorTickCount?: number; - /** Specifies the required type of the value axis. */ - type?: string; - /** Specifies the pane on which the current value axis will be displayed. */ - pane?: string; - /** Specifies options for value axis strips. */ - strips?: Array; - } - export interface ChartAxis extends ChartCommonAxisSettings, Axis { - /** Defines an array of the value axis constant lines. */ - constantLines?: Array; - /** Specifies the appearance options for the constant lines of the value axis. */ - constantLineStyle?: ChartCommonConstantLineStyle; - /** Specifies options for value axis labels. */ - label?: ChartAxisLabel; - /** Specifies the maximum value on the value axis. */ - max?: any; - /** Specifies the minimum value on the value axis. */ - min?: any; - /** Specifies the position of the value axis on a chart. */ - position?: string; - /** Specifies the title for a value axis. */ - title?: AxisTitle; - } - export interface PolarAxis extends PolarCommonAxisSettings, Axis { - /** Defines an array of the value axis constant lines. */ - constantLines?: Array; - /** Specifies options for value axis labels. */ - label?: PolarAxisLabel; - } - export interface ArgumentAxis { - /** Specifies the desired type of axis values. */ - argumentType?: string; - /** Specifies the elements that will be highlighted when the argument axis is hovered over. */ - hoverMode?: string; - } - export interface ChartArgumentAxis extends ChartAxis, ArgumentAxis { } - export interface PolarArgumentAxis extends PolarAxis, ArgumentAxis { - /** Specifies the angle in arc degrees to which the argument axis should be rotated. The positive values rotate the axis clockwise. */ - startAngle?: number; - /** Specifies whether or not to display the first point at the angle specified by the startAngle option. */ - firstPointOnStartAngle?: boolean; - /** Specifies the value to be used as the origin for the argument axis. */ - originValue?: number; - /** Specifies the period of the argument values in the data source. */ - period?: number; - } - export interface ValueAxis { - /** Specifies the name of the value axis. */ - name?: string; - /** Specifies whether or not to indicate a zero value on the value axis. */ - showZero?: boolean; - /** Specifies the desired type of axis values. */ - valueType?: string; - } - export interface ChartValueAxis extends ChartAxis, ValueAxis { - /** Specifies the spacing, in pixels, between multiple value axes in a chart. */ - multipleAxesSpacing?: number; - /** Specifies the value by which the chart's value axes are synchronized. */ - synchronizedValue?: number; - } - export interface PolarValueAxis extends PolarAxis, ValueAxis { - /** Indicates whether to display series with indents from axis boundaries. */ - valueMarginsEnabled?: boolean; - /** Specifies a coefficient that determines the spacing between the maximum series point and the axis. */ - maxValueMargin?: number; - /** Specifies a coefficient that determines the spacing between the minimum series point and the axis. */ - minValueMargin?: number; - tick?: { - visible?: boolean; - } - } - export interface CommonPane { - /** Specifies a background color in a pane. */ - backgroundColor?: string; - /** Specifies the border options of a chart's pane. */ - border?: PaneBorder; - } - export interface Pane extends CommonPane { - /** Specifies the name of a pane. */ - name?: string; - } - export interface PaneBorder extends viz.core.DashedBorderWithOpacity { - /** Specifies the bottom border's visibility state in a pane. */ - bottom?: boolean; - /** Specifies the left border's visibility state in a pane. */ - left?: boolean; - /** Specifies the right border's visibility state in a pane. */ - right?: boolean; - /** Specifies the top border's visibility state in a pane. */ - top?: boolean; - } - export interface ChartAnimation extends viz.core.Animation { - /** Specifies the maximum series point count in the chart that the animation supports. */ - maxPointCountSupported?: number; - } - export interface BaseChartTooltip extends viz.core.Tooltip { - /** Specifies a format for arguments of the chart's series points. */ - argumentFormat?: string; - /** Specifies a precision for formatted arguments displayed in tooltips. */ - argumentPrecision?: number; - /** Specifies a precision for a percent value displayed in tooltips for stacked series and dxPieChart series. */ - percentPrecision?: number; - } - export interface BaseChartOptions extends viz.core.BaseWidgetOptions { - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - /** Specifies the width of the widget that is small enough for the layout to begin adapting. */ - width?: number; - /** Specifies the height of the widget that is small enough for the layout to begin adapting. */ - height?: number; - /** Specifies whether or not point labels can be hidden when the layout is adapting. */ - keepLabels?: boolean; - }; - /** Specifies animation options. */ - animation?: ChartAnimation; - /** Specifies a callback function that returns an object with options for a specific point label. */ - customizeLabel?: (labelInfo: Object) => Object; - /** Specifies a callback function that returns an object with options for a specific point. */ - customizePoint?: (pointInfo: Object) => Object; - /** Specifies a data source for the chart. */ - dataSource?: any; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies options of a dxChart's (dxPieChart's) legend. */ - legend?: core.BaseLegend; - /** Specifies the blank space between the chart's extreme elements and the boundaries of the area provided for the widget (see size) in pixels. */ - margin?: viz.core.Margins; - /** Sets the name of the palette to be used in the chart. Alternatively, an array of colors can be set as a custom palette to be used within this chart. */ - palette?: any; - /** A handler for the done event. */ - onDone?: (e: { - component: BaseChart; - element: Element; - }) => void; - /** A handler for the pointClick event. */ - onPointClick?: any; - /** A handler for the pointHoverChanged event. */ - onPointHoverChanged?: (e: { - component: BaseChart; - element: Element; - target: TPoint; - }) => void; - /** A handler for the pointSelectionChanged event. */ - onPointSelectionChanged?: (e: { - component: BaseChart; - element: Element; - target: TPoint; - }) => void; - /** Specifies whether a single point or multiple points can be selected in the chart. */ - pointSelectionMode?: string; - /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */ - redrawOnResize?: boolean; - /** Specifies options for the dxChart and dxPieChart widget series. */ - series?: any; - /** Specifies the size of the widget in pixels. */ - size?: viz.core.Size; - /** Specifies a title for the chart. */ - title?: viz.core.Title; - /** Specifies tooltip options. */ - tooltip?: BaseChartTooltip; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: BaseChart; - element: Element; - target: BasePoint; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: BaseChart; - element: Element; - target: BasePoint; - }) => void; - } - /** A base class for all chart widgets included in the ChartJS library. */ - export class BaseChart extends viz.core.BaseWidget { - /** Deselects the chart's selected series. The series is displayed in an initial style. */ - clearSelection(): void; - /** Gets the current size of the widget. */ - getSize(): { width: number; height: number }; - /** Returns an array of all series in the chart. */ - getAllSeries(): Array; - /** Gets a series within the chart's series collection by the specified name (see the name option). */ - getSeriesByName(seriesName: string): BaseSeries; - /** Gets a series within the chart's series collection by its position number. */ - getSeriesByPos(seriesIndex: number): BaseSeries; - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Hides all widget tooltips. */ - hideTooltip(): void; - /** Redraws a widget. */ - render(renderOptions?: { - force?: boolean; - animate?: boolean; - asyncSeriesRendering?: boolean; - }): void; - } - export interface AdvancedLegend extends core.BaseLegend { - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item. */ - customizeHint?: (seriesInfo: { seriesName: string; seriesIndex: number; seriesColor: string; }) => string; - /**

Specifies a callback function that returns the text to be displayed by legend items.

*/ - customizeText?: (seriesInfo: { seriesName: string; seriesIndex: number; seriesColor: string; }) => string; - /** Specifies what series elements to highlight when a corresponding item in the legend is hovered over. */ - hoverMode?: string; - } - export interface AdvancedOptions extends BaseChartOptions { - /** A handler for the argumentAxisClick event. */ - onArgumentAxisClick?: any; - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** An object providing options for managing data from a data source. */ - dataPrepareSettings?: { - /** Specifies whether or not to validate the values from a data source. */ - checkTypeForAllData?: boolean; - /** Specifies whether or not to convert the values from a data source into the data type of an axis. */ - convertToAxisDataType?: boolean; - /** Specifies how to sort the series points. */ - sortingMethod?: any; - }; - /** A handler for the legendClick event. */ - onLegendClick?: any; - /** A handler for the seriesClick event. */ - onSeriesClick?: any; - /** A handler for the seriesHoverChanged event. */ - onSeriesHoverChanged?: (e: { - component: BaseChart; - element: Element; - target: TSeries; - }) => void; - /** A handler for the seriesSelectionChanged event. */ - onSeriesSelectionChanged?: (e: { - component: BaseChart; - element: Element; - target: TSeries; - }) => void; - /** Specifies whether a single series or multiple series can be selected in the chart. */ - seriesSelectionMode?: string; - /** Specifies how the chart must behave when series point labels overlap. */ - resolveLabelOverlapping?: string; - /** Specifies whether or not all bars in a series must have the same angle, or may have different angles if any points in other series are missing. */ - equalBarWidth?: boolean; - /** Specifies a common bar width as a percentage from 0 to 1. */ - barWidth?: number; - } - export interface Legend extends AdvancedLegend { - /** Specifies whether the legend is located outside or inside the chart's plot. */ - position?: string; - } - export interface ChartTooltip extends BaseChartTooltip { - /** Specifies whether the tooltip must be located in the center of a bar or on its edge. Applies to the Bar and Bubble series. */ - location?: string; - /** Specifies the kind of information to display in a tooltip. */ - shared?: boolean; - } - export interface dxChartOptions extends AdvancedOptions { - adaptiveLayout?: { - keepLabels?: boolean; - }; - /** Indicates whether or not to synchronize value axes when they are displayed on a single pane. */ - synchronizeMultiAxes?: boolean; - /** Specifies whether or not to filter the series points depending on their quantity. */ - useAggregation?: boolean; - /** Indicates whether or not to adjust a value axis to the current minimum and maximum values of a zoomed chart. */ - adjustOnZoom?: boolean; - /** Specifies argument axis options for the dxChart widget. */ - argumentAxis?: ChartArgumentAxis; - /** An object defining the configuration options that are common for all axes of the dxChart widget. */ - commonAxisSettings?: ChartCommonAxisSettings; - /** An object defining the configuration options that are common for all panes in the dxChart widget. */ - commonPaneSettings?: CommonPane; - /** An object defining the configuration options that are common for all series of the dxChart widget. */ - commonSeriesSettings?: CommonSeriesSettings; - /** An object that specifies the appearance options of the chart crosshair. */ - crosshair?: { - /** Specifies a color for the crosshair lines. */ - color?: string; - /** Specifies a dash style for the crosshair lines. */ - dashStyle?: string; - /** Specifies whether to enable the crosshair or not. */ - enabled?: boolean; - /** Specifies the opacity of the crosshair lines. */ - opacity?: number; - /** Specifies the width of the crosshair lines. */ - width?: number; - /** Specifies the appearance of the horizontal crosshair line. */ - horizontalLine?: CrosshaierWithLabel; - /** Specifies the appearance of the vertical crosshair line. */ - verticalLine?: CrosshaierWithLabel; - /** Specifies the options of the crosshair labels. */ - label?: { - /** Specifies a color for the background of the crosshair labels. */ - backgroundColor?: string; - /** Specifies whether the crosshair labels are visible or not. */ - visible?: boolean; - /** Specifies font options for the text of the crosshair labels. */ - font?: viz.core.Font; - /** Specifies the format of the values displayed by crosshair labels. */ - format?: string; - /** Specifies a precision for formatted values. */ - precision?: number; - /** Customizes the text displayed by the crosshair labels. */ - customizeText?: (info: { value: any; valueText: string; point: ChartPoint; }) => string; - } - }; - /** Specifies a default pane for the chart's series. */ - defaultPane?: string; - /** Specifies a coefficient determining the diameter of the largest bubble. */ - maxBubbleSize?: number; - /** Specifies the diameter of the smallest bubble measured in pixels. */ - minBubbleSize?: number; - /** Defines the dxChart widget's pane(s). */ - panes?: Array; - /** Swaps the axes round so that the value axis becomes horizontal and the argument axes becomes vertical. */ - rotated?: boolean; - /** Specifies the options of a chart's legend. */ - legend?: Legend; - /** Specifies options for dxChart widget series. */ - series?: Array; - /** Defines options for the series template. */ - seriesTemplate?: SeriesTemplate; - /** Specifies tooltip options. */ - tooltip?: ChartTooltip; - /** Specifies value axis options for the dxChart widget. */ - valueAxis?: Array; - /** Enables scrolling in your chart. */ - scrollingMode?: string; - /** Enables zooming in your chart. */ - zoomingMode?: string; - /** Specifies the settings of the scroll bar. */ - scrollBar?: { - /** Specifies whether the scroll bar is visible or not. */ - visible?: boolean; - /** Specifies the spacing between the scroll bar and the chart's plot in pixels. */ - offset?: number; - /** Specifies the color of the scroll bar. */ - color?: string; - /** Specifies the width of the scroll bar in pixels. */ - width?: number; - /** Specifies the opacity of the scroll bar. */ - opacity?: number; - /** Specifies the position of the scroll bar in the chart. */ - position?: string; - }; - } - /** A widget used to embed charts into HTML JS applications. */ - export class dxChart extends BaseChart { - constructor(element: JQuery, options?: dxChartOptions); - constructor(element: Element, options?: dxChartOptions); - /** Sets the specified start and end values for the chart's argument axis. */ - zoomArgument(startValue: any, endValue: any): void; - } - interface CrosshaierWithLabel extends viz.core.DashedBorderWithOpacity { - /** Configures the label that belongs to the horizontal crosshair line. */ - label?: { - /** Specifies a color for the background of the label that belongs to the horizontal crosshair line. */ - backgroundColor?: string; - /** Specifies whether the label of the horizontal crosshair line is visible or not. */ - visible?: boolean; - /** Specifies font options for the text of the label that belongs to the horizontal crosshair line. */ - font?: viz.core.Font; - /** Specifies the format of the values displayed by crosshair labels. */ - format?: string; - /** Specifies a precision for formatted values. */ - precision?: number; - /** Customizes the text displayed by the crosshair label that accompany the horizontal line. */ - customizeText?: (info: { value: any; valueText: string; point: ChartPoint; }) => string; - } - } - export interface PolarChartTooltip extends BaseChartTooltip { - /** Specifies the kind of information to display in a tooltip. */ - shared?: boolean; - } - export interface dxPolarChartOptions extends AdvancedOptions { - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - width?: number; - height?: number; - /** Specifies whether or not point labels can be hidden when the layout is adapting. */ - keepLabels?: boolean; - }; - /** Indicates whether or not to display a "spider web". */ - useSpiderWeb?: boolean; - /** Specifies argument axis options for the dxPolarChart widget. */ - argumentAxis?: PolarArgumentAxis; - /** An object defining the configuration options that are common for all axes of the dxPolarChart widget. */ - commonAxisSettings?: PolarCommonAxisSettings; - /** An object defining the configuration options that are common for all series of the dxPolarChart widget. */ - commonSeriesSettings?: CommonPolarSeriesSettings; - /** Specifies the options of a chart's legend. */ - legend?: AdvancedLegend; - /** Specifies options for dxPolarChart widget series. */ - series?: Array; - /** Defines options for the series template. */ - seriesTemplate?: PolarSeriesTemplate; - /** Specifies tooltip options. */ - tooltip?: PolarChartTooltip; - /** Specifies value axis options for the dxPolarChart widget. */ - valueAxis?: PolarValueAxis; - } - /** A chart widget displaying data in a polar coordinate system. */ - export class dxPolarChart extends BaseChart { - constructor(element: JQuery, options?: dxPolarChartOptions); - constructor(element: Element, options?: dxPolarChartOptions); - } - export interface PieLegend extends core.BaseLegend { - /** Specifies what chart elements to highlight when a corresponding item in the legend is hovered over. */ - hoverMode?: string; - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item. */ - customizeHint?: (pointInfo: { pointName: string; pointIndex: number; pointColor: string; }) => string; - /** Specifies a callback function that returns the text to be displayed by a legend item. */ - customizeText?: (pointInfo: { pointName: string; pointIndex: number; pointColor: string; }) => string; - } - export interface dxPieChartOptions extends BaseChartOptions { - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - /** Specifies whether or not point labels can be hidden when the layout is adapting. */ - keepLabels?: boolean; - }; - /** Specifies dxPieChart legend options. */ - legend?: PieLegend; - /** Specifies options for the series of the dxPieChart widget. */ - series?: Array; - /** Specifies the diameter of the pie. */ - diameter?: number; - /** Specifies the direction that the pie chart segments will occupy. */ - segmentsDirection?: string; - /** Specifies the angle in arc degrees from which the first segment of a pie chart should start. */ - startAngle?: number; - /** Specifies the fraction of the inner radius relative to the total radius in the series of the 'doughnut' type. The value should be between 0 and 1. */ - innerRadius?: number; - /** A handler for the legendClick event. */ - onLegendClick?: any; - /** Specifies how a chart must behave when series point labels overlap. */ - resolveLabelOverlapping?: string; - /** An object defining the configuration options that are common for all series of the dxPieChart widget. */ - commonSeriesSettings?: CommonPieSeriesSettings; - /** Specifies the type of the pie chart series. */ - type?: string; - } - /** A circular chart widget for HTML JS applications. */ - export class dxPieChart extends BaseChart { - constructor(element: JQuery, options?: dxPieChartOptions); - constructor(element: Element, options?: dxPieChartOptions); - /** - * Provides access to the dxPieChart series. - * @deprecated ..\..\BaseChart\3 Methods\getAllSeries().md - */ - getSeries(): PieSeries; - } -} -interface JQuery { - dxChart(options?: DevExpress.viz.charts.dxChartOptions): JQuery; - dxChart(methodName: string, ...params: any[]): any; - dxChart(methodName: "instance"): DevExpress.viz.charts.dxChart; - dxPieChart(options?: DevExpress.viz.charts.dxPieChartOptions): JQuery; - dxPieChart(methodName: string, ...params: any[]): any; - dxPieChart(methodName: "instance"): DevExpress.viz.charts.dxPieChart; - dxPolarChart(options?: DevExpress.viz.charts.dxPolarChartOptions): JQuery; - dxPolarChart(methodName: string, ...params: any[]): any; - dxPolarChart(methodName: "instance"): DevExpress.viz.charts.dxPolarChart; -} -declare namespace DevExpress.viz.gauges { - export interface BaseRangeContainer { - /** Specifies a range container's background color. */ - backgroundColor?: string; - /** Specifies the offset of the range container from an invisible scale line in pixels. */ - offset?: number; - /** Sets the name of the palette or an array of colors to be used for coloring the gauge range container. */ - palette?: any; - /** An array of objects representing ranges contained in the range container. */ - ranges?: Array<{ startValue: number; endValue: number; color: string }>; - /** Specifies a color of a range. */ - color?: string; - /** Specifies an end value of a range. */ - endValue?: number; - /** Specifies a start value of a range. */ - startValue?: number; - } - export interface ScaleTick { - /** Specifies the color of the scale's minor ticks. */ - color?: string; - /** - * Specifies an array of custom minor ticks. - * @deprecated ..\customMinorTicks.md - */ - customTickValues?: Array; - /** Specifies the length of the scale's minor ticks. */ - length?: number; - /** - * Indicates whether automatically calculated minor ticks are visible or not. - * @deprecated This functionality in not more available - */ - showCalculatedTicks?: boolean; - /** - * Specifies an interval between minor ticks. - * @deprecated ..\minorTickInterval.md - */ - tickInterval?: number; - /** Indicates whether scale minor ticks are visible or not. */ - visible?: boolean; - /** Specifies the width of the scale's minor ticks. */ - width?: number; - } - export interface ScaleMajorTick extends ScaleTick { - /** - * Specifies whether or not to expand the current major tick interval if labels overlap each other. - * @deprecated ..\label\overlappingBehavior\useAutoArrangement.md - */ - useTicksAutoArrangement?: boolean; - } - export interface ScaleMinorTick extends ScaleTick { - /** Specifies the opacity of the scale's minor ticks. */ - opacity?: number; - } - export interface BaseScaleLabel { - /** Specifies whether or not scale labels should be colored similarly to their corresponding ranges in the range container. */ - useRangeColors?: boolean; - /** Specifies a callback function that returns the text to be displayed in scale labels. */ - customizeText?: (scaleValue: { value: number; valueText: string }) => string; - /** Specifies the overlap resolving options to be applied to scale labels. */ - overlappingBehavior?: { - /** Specifies whether or not to expand the current major tick interval if labels overlap each other. */ - useAutoArrangement?: boolean; - /** Specifies what label to hide in case of overlapping. */ - hideFirstOrLast?: string; - }; - /** Specifies font options for the text displayed in the scale labels of the gauge. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in scale labels. */ - format?: string; - /** Specifies a precision for the formatted value displayed in the scale labels. */ - precision?: number; - /** Specifies whether or not scale labels are visible on the gauge. */ - visible?: boolean; - } - export interface BaseScale { - /** Specifies the end value for the scale of the gauge. */ - endValue?: number; - /** - * Specifies whether or not to hide the first scale label. - * @deprecated This functionality in not more available - */ - hideFirstLabel?: boolean; - /** - * Specifies whether or not to hide the first major tick on the scale. - * @deprecated This functionality in not more available - */ - hideFirstTick?: boolean; - /** - * Specifies whether or not to hide the last scale label. - * @deprecated This functionality in not more available - */ - hideLastLabel?: boolean; - /** - * Specifies whether or not to hide the last major tick on the scale. - * @deprecated This functionality in not more available - */ - hideLastTick?: boolean; - /** Specifies an interval between major ticks. */ - tickInterval?: number; - /** Specifies an interval between minor ticks. */ - minorTickInterval?: number; - /** Specifies an array of custom major ticks. */ - customTicks?: Array; - /** Specifies an array of custom minor ticks. */ - customMinorTicks?: Array; - /** Specifies common options for scale labels. */ - label?: BaseScaleLabel; - /** - * Specifies options of the gauge's major ticks. - * @deprecated ..\tick\tick.md - */ - majorTick?: ScaleMajorTick; - /** Specifies options of the gauge's major ticks. */ - tick?: { - /** Specifies the color of the scale's major ticks. */ - color?: string; - /** Specifies the length of the scale's major ticks. */ - length?: number; - /** Indicates whether scale major ticks are visible or not. */ - visible?: boolean; - /** Specifies the width of the scale's major ticks. */ - width?: number; - /** Specifies the opacity of the scale's major ticks. */ - opacity?: number; - }; - /** Specifies options of the gauge's minor ticks. */ - minorTick?: ScaleMinorTick; - /** Specifies the start value for the scale of the gauge. */ - startValue?: number; - } - export interface BaseValueIndicator { - /** Specifies the type of subvalue indicators. */ - type?: string; - /** Specifies the background color for the indicator of the rangeBar type. */ - backgroundColor?: string; - /** Specifies the base value for the indicator of the rangeBar type. */ - baseValue?: number; - /** Specifies a color of the indicator. */ - color?: string; - /** Specifies the range bar size for an indicator of the rangeBar type. */ - size?: number; - text?: { - /** Specifies a callback function that returns the text to be displayed in an indicator. */ - customizeText?: (indicatedValue: { value: number; valueText: string }) => string; - font?: viz.core.Font; - /** Specifies a format for the text displayed in an indicator. */ - format?: string; - /** Specifies the range bar's label indent in pixels. */ - indent?: number; - /** Specifies a precision for the formatted value displayed by an indicator. */ - precision?: number; - }; - offset?: number; - length?: number; - width?: number; - /** Specifies the length of an arrow for the indicator of the textCloud type in pixels. */ - arrowLength?: number; - /** Sets the array of colors to be used for coloring subvalue indicators. */ - palette?: Array; - /** Specifies the distance between the needle and the center of a gauge for the indicator of a needle-like type. */ - indentFromCenter?: number; - /** Specifies the second color for the indicator of the twoColorNeedle type. */ - secondColor?: string; - /** Specifies the length of a twoNeedleColor type indicator tip as a percentage. */ - secondFraction?: number; - /** Specifies the spindle's diameter in pixels for the indicator of a needle-like type. */ - spindleSize?: number; - /** Specifies the inner diameter in pixels, so that the spindle has the shape of a ring. */ - spindleGapSize?: number; - /** Specifies the orientation of the rangeBar indicator on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - /** Specifies the orientation of the rangeBar indicator on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - } - export interface SharedGaugeOptions { - /** Specifies animation options. */ - animation?: viz.core.Animation; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */ - redrawOnResize?: boolean; - /** Specifies the size of the widget in pixels. */ - size?: viz.core.Size; - /** - * Specifies a subtitle for the widget. - * @deprecated ..\..\..\BaseGauge\1 Configuration\title\subtitle\subtitle.md - */ - subtitle?: { - /** - * Specifies font options for the subtitle. - * @deprecated ..\..\title\subtitle\font\font.md - */ - font?: viz.core.Font; - /** - * Specifies a text for the subtitle. - * @deprecated ..\title\subtitle\text.md - */ - text?: string; - }; - /** Specifies a title for a gauge. */ - title?: { - /** Specifies font options for the title. */ - font?: viz.core.Font; - /** - * Specifies a title's position on the gauge. - * @deprecated basegaugeoptions_title_verticalAlignment and basegaugeoptions_title_horizontalAlignment - */ - position?: string; - /** Specifies the distance between the title and surrounding gauge elements in pixels. */ - margin?: viz.core.Margins; - /** Specifies the height of the space reserved for the title. */ - placeholderSize?: number; - /** Specifies the gauge title's position in the vertical direction. */ - verticalAlignment?: string; - /** Specifies the gauge title's horizontal position. */ - horizontalAlignment?: string; - /** Specifies text for the title. */ - text?: string; - /** Specifies a subtitle for the widget. */ - subtitle?: { - /** Specifies font options for the subtitle. */ - font?: viz.core.Font; - /** Specifies text for the subtitle. */ - text?: string; - } - }; - /** Specifies options for gauge tooltips. */ - tooltip?: viz.core.Tooltip; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: dxBaseGauge; - element: Element; - target: {}; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: dxBaseGauge; - element: Element; - target: {}; - }) => void; - } - export interface BaseGaugeOptions extends viz.core.BaseWidgetOptions, SharedGaugeOptions { - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** Specifies the blank space in pixels between the widget's extreme elements and the boundaries of the area provided for the widget (see the size option). */ - margin?: viz.core.Margins; - /** Specifies options of the gauge's range container. */ - rangeContainer?: BaseRangeContainer; - /** Specifies a gauge's scale options. */ - scale?: BaseScale; - /** Specifies the appearance options of subvalue indicators. */ - subvalueIndicator?: BaseValueIndicator; - /** Specifies a set of subvalues to be designated by the subvalue indicators. */ - subvalues?: Array; - /** Specifies the main value on a gauge. */ - value?: number; - /** Specifies the appearance options of the value indicator. */ - valueIndicator?: BaseValueIndicator; - } - /** A gauge widget. */ - export class dxBaseGauge extends viz.core.BaseWidget { - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(): void; - /** Returns the main gauge value. */ - value(): number; - /** Updates a gauge value. */ - value(value: number): void; - /** Returns an array of gauge subvalues. */ - subvalues(): Array; - /** Updates gauge subvalues. */ - subvalues(subvalues: Array): void; - } - export interface LinearRangeContainer extends BaseRangeContainer { - /** Specifies the orientation of the range container on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - /** Specifies the orientation of a range container on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - /** Specifies the width of the range container's start and end boundaries in the dxLinearGauge widget. */ - width?: any; - /** Specifies an end width of a range container. */ - end?: number; - /** Specifies a start width of a range container. */ - start?: number; - } - export interface LinearScaleLabel extends BaseScaleLabel { - /** Specifies the spacing between scale labels and ticks. */ - indentFromTick?: number; - } - export interface LinearScale extends BaseScale { - /** Specifies the orientation of scale ticks on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - label?: LinearScaleLabel; - /** Specifies the orientation of scale ticks on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - } - export interface dxLinearGaugeOptions extends BaseGaugeOptions { - /** Specifies the options required to set the geometry of the dxLinearGauge widget. */ - geometry?: { - /** Indicates whether to display the dxLinearGauge widget vertically or horizontally. */ - orientation?: string; - }; - /** Specifies gauge range container options. */ - rangeContainer?: LinearRangeContainer; - scale?: LinearScale; - } - /** A widget that represents a gauge with a linear scale. */ - export class dxLinearGauge extends dxBaseGauge { - constructor(element: JQuery, options?: dxLinearGaugeOptions); - constructor(element: Element, options?: dxLinearGaugeOptions); - } - export interface CircularRangeContainer extends BaseRangeContainer { - /** Specifies the orientation of the range container in the dxCircularGauge widget. */ - orientation?: string; - /** Specifies the range container's width in pixels. */ - width?: number; - } - export interface CircularScaleLabel extends BaseScaleLabel { - /** Specifies the spacing between scale labels and ticks. */ - indentFromTick?: number; - } - export interface CircularScale extends BaseScale { - label?: CircularScaleLabel; - /** Specifies the orientation of scale ticks. */ - orientation?: string; - } - export interface dxCircularGaugeOptions extends BaseGaugeOptions { - /** Specifies the options required to set the geometry of the dxCircularGauge widget. */ - geometry?: { - /** Specifies the end angle of the circular gauge's arc. */ - endAngle?: number; - /** Specifies the start angle of the circular gauge's arc. */ - startAngle?: number; - }; - /** Specifies gauge range container options. */ - rangeContainer?: CircularRangeContainer; - scale?: CircularScale; - } - /** A widget that represents a gauge with a circular scale. */ - export class dxCircularGauge extends dxBaseGauge { - constructor(element: JQuery, options?: dxCircularGaugeOptions); - constructor(element: Element, options?: dxCircularGaugeOptions); - } - export interface dxBarGaugeOptions extends viz.core.BaseWidgetOptions, SharedGaugeOptions { - /** Specifies a color for the remaining segment of the bar's track. */ - backgroundColor?: string; - /** Specifies a distance between bars in pixels. */ - barSpacing?: number; - /** Specifies a base value for bars. */ - baseValue?: number; - /** Specifies an end value for the gauge's invisible scale. */ - endValue?: number; - /** Defines the shape of the gauge's arc. */ - geometry?: { - /** Specifies the end angle of the bar gauge's arc. */ - endAngle?: number; - /** Specifies the start angle of the bar gauge's arc. */ - startAngle?: number; - }; - /** Specifies the options of the labels that accompany gauge bars. */ - label?: { - /** Specifies a color for the label connector text. */ - connectorColor?: string; - /** Specifies the width of the label connector in pixels. */ - connectorWidth?: number; - /** Specifies a callback function that returns a text for labels. */ - customizeText?: (barValue: { value: number; valueText: string }) => string; - /** Specifies font options for bar labels. */ - font?: viz.core.Font; - /** Specifies a format for bar labels. */ - format?: string; - /** Specifies the distance between the upper bar and bar labels in pixels. */ - indent?: number; - /** Specifies a precision for the formatted value displayed by labels. */ - precision?: number; - /** Specifies whether bar labels appear on a gauge or not. */ - visible?: boolean; - }; - /** Sets the name of the palette or an array of colors to be used for coloring the gauge range container. */ - palette?: string; - /** Defines the radius of the bar that is closest to the center relatively to the radius of the topmost bar. */ - relativeInnerRadius?: number; - /** Specifies a start value for the gauge's invisible scale. */ - startValue?: number; - /** Specifies the array of values to be indicated on a bar gauge. */ - values?: Array; - } - /** A circular bar widget. */ - export class dxBarGauge extends viz.core.BaseWidget { - constructor(element: JQuery, options?: dxBarGaugeOptions); - constructor(element: Element, options?: dxBarGaugeOptions); - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws the widget. */ - render(): void; - /** Returns an array of gauge values. */ - values(): Array; - /** Updates the values displayed by a gauge. */ - values(values: Array): void; - } -} -interface JQuery { - dxLinearGauge(options?: DevExpress.viz.gauges.dxLinearGaugeOptions): JQuery; - dxLinearGauge(methodName: string, ...params: any[]): any; - dxLinearGauge(methodName: "instance"): DevExpress.viz.gauges.dxLinearGauge; - dxCircularGauge(options?: DevExpress.viz.gauges.dxCircularGaugeOptions): JQuery; - dxCircularGauge(methodName: string, ...params: any[]): any; - dxCircularGauge(methodName: "instance"): DevExpress.viz.gauges.dxCircularGauge; - dxBarGauge(options?: DevExpress.viz.gauges.dxBarGaugeOptions): JQuery; - dxBarGauge(methodName: string, ...params: any[]): any; - dxBarGauge(methodName: "instance"): DevExpress.viz.gauges.dxBarGauge; -} -declare namespace DevExpress.viz.rangeSelector { - export interface dxRangeSelectorOptions extends viz.core.BaseWidgetOptions { - /** Specifies the options for the range selector's background. */ - background?: { - /** Specifies the background color for the dxRangeSelector. */ - color?: string; - /** Specifies image options. */ - image?: { - /** Specifies a location for the image in the background of a range selector. */ - location?: string; - /** Specifies the image's URL. */ - url?: string; - }; - /** Indicates whether or not the background (background color and/or image) is visible. */ - visible?: boolean; - }; - /** Specifies a title for the range selector. */ - title?: viz.core.Title; - /** Specifies the dxRangeSelector's behavior options. */ - behavior?: { - /** Indicates whether or not you can swap sliders. */ - allowSlidersSwap?: boolean; - /** Indicates whether or not animation is enabled. */ - animationEnabled?: boolean; - /** Specifies when to call the onSelectedRangeChanged function. */ - callSelectedRangeChanged?: string; - /** Indicates whether or not an end user can specify the range using a mouse, without the use of sliders. */ - manualRangeSelectionEnabled?: boolean; - /** Indicates whether or not an end user can shift the selected range to the required location on a scale by clicking. */ - moveSelectedRangeByClick?: boolean; - /** Indicates whether to snap a slider to ticks. */ - snapToTicks?: boolean; - }; - /** Specifies the options required to display a chart as the range selector's background. */ - chart?: { - /** Specifies a coefficient for determining an indent from the bottom background boundary to the lowest chart point. */ - bottomIndent?: number; - /** An object defining the common configuration options for the chart’s series. */ - commonSeriesSettings?: viz.charts.CommonSeriesSettings; - /** An object providing options for managing data from a data source. */ - dataPrepareSettings?: { - /** Specifies whether or not to validate values from a data source. */ - checkTypeForAllData?: boolean; - /** Specifies whether or not to convert the values from a data source into the data type of an axis. */ - convertToAxisDataType?: boolean; - /** Specifies how to sort series points. */ - sortingMethod?: any; - }; - /** Specifies whether all bars in a series must have the same width, or may have different widths if any points in other series are missing. */ - equalBarWidth?: boolean; - /** Specifies a common bar width as a percentage from 0 to 1. */ - barWidth?: number; - /** Sets the name of the palette to be used in the range selector's chart. Alternatively, an array of colors can be set as a custom palette to be used within this chart. */ - palette?: any; - /** An object defining the chart’s series. */ - series?: Array; - /** Defines options for the series template. */ - seriesTemplate?: viz.charts.SeriesTemplate; - /** Specifies a coefficient for determining an indent from the background's top boundary to the topmost chart point. */ - topIndent?: number; - /** Specifies whether or not to filter the series points depending on their quantity. */ - useAggregation?: boolean; - /** Specifies options for the chart's value axis. */ - valueAxis?: { - /** Indicates whether or not the chart's value axis must be inverted. */ - inverted?: boolean; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic value axis. */ - logarithmBase?: number; - /** Specifies the maximum value of the chart's value axis. */ - max?: number; - /** Specifies the minimum value of the chart's value axis. */ - min?: number; - /** Specifies the type of the value axis. */ - type?: string; - /** Specifies the desired type of axis values. */ - valueType?: string; - }; - }; - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** Specifies a data source for the scale values and for the chart at the background. */ - dataSource?: any; - /** Specifies the data source field that provides data for the scale. */ - dataSourceField?: string; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies the blank space in pixels between the dxRangeSelector widget's extreme elements and the boundaries of the area provided for the widget (see size). */ - margin?: viz.core.Margins; - /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */ - redrawOnResize?: boolean; - /** Specifies options of the range selector's scale. */ - scale?: { - /** Specifies the scale's end value. */ - endValue?: any; - /** Specifies common options for scale labels. */ - label?: { - /** Specifies a callback function that returns the text to be displayed in scale labels. */ - customizeText?: (scaleValue: { value: any; valueText: string; }) => string; - /** Specifies font options for the text displayed in the range selector's scale labels. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in scale labels. */ - format?: string; - /** Specifies a precision for the formatted value displayed in the scale labels. */ - precision?: number; - /** Specifies a spacing between scale labels and the background bottom edge. */ - topIndent?: number; - /** Specifies whether or not the scale's labels are visible. */ - visible?: boolean; - }; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic scale. */ - logarithmBase?: number; - /** - * Specifies an interval between major ticks. - * @deprecated ..\tickInterval\tickInterval.md - */ - majorTickInterval?: any; - /** Specifies an interval between axis ticks. */ - tickInterval?: any; - /** Specifies options for the date-time scale's markers. */ - marker?: { - /** Defines the options that can be set for the text that is displayed by the scale markers. */ - label?: { - /** Specifies a callback function that returns the text to be displayed in scale markers. */ - customizeText?: (markerValue: { value: any; valueText: string }) => string; - /** Specifies a format for the text displayed in scale markers. */ - format?: string; - }; - /** Specifies the height of the marker's separator. */ - separatorHeight?: number; - /** Specifies the space between the marker label and the marker separator. */ - textLeftIndent?: number; - /** Specifies the space between the marker's label and the top edge of the marker's separator. */ - textTopIndent?: number; - /** Specified the indent between the marker and the scale lables. */ - topIndent?: number; - /** Indicates whether scale markers are visible. */ - visible?: boolean; - }; - /** Specifies the maximum range that can be selected. */ - maxRange?: any; - /** Specifies the number of minor ticks between neighboring major ticks. */ - minorTickCount?: number; - /** Specifies an interval between minor ticks. */ - minorTickInterval?: any; - /** Specifies the minimum range that can be selected. */ - minRange?: any; - /** Specifies the height of the space reserved for the scale in pixels. */ - placeholderHeight?: number; - /** Indicates whether or not to set ticks of a date-time scale at the beginning of each date-time interval. */ - setTicksAtUnitBeginning?: boolean; - /** Specifies whether or not to show ticks for the boundary scale values, when neither major ticks nor minor ticks are created for these values. */ - showCustomBoundaryTicks?: boolean; - /** - * Indicates whether or not to show minor ticks on the scale. - * @deprecated minorTick\visible.md - */ - showMinorTicks?: boolean; - /** Specifies the scale's start value. */ - startValue?: any; - /** Specifies options defining the appearance of scale ticks. */ - tick?: { - /** Specifies the color of scale ticks (both major and minor ticks). */ - color?: string; - /** Specifies the opacity of scale ticks (both major and minor ticks). */ - opacity?: number; - /** Specifies the width of the scale's ticks (both major and minor ticks). */ - width?: number; - }; - /** Specifies options of the range selector's minor ticks. */ - minorTick?: { - /** Specifies the color of the scale's minor ticks. */ - color?: string; - /** Specifies the opacity of the scale's minor ticks. */ - opacity?: number; - /** Specifies the width of the scale's minor ticks. */ - width?: number; - /** Indicates whether scale minor ticks are visible or not. */ - visible?: boolean; - }; - /** Specifies the type of the scale. */ - type?: string; - /** Specifies whether or not to expand the current tick interval if labels overlap each other. */ - useTicksAutoArrangement?: boolean; - /** Specifies the type of values on the scale. */ - valueType?: string; - /** Specifies the order of arguments on a discrete scale. */ - categories?: Array; - }; - /** Specifies the range to be selected when displaying the dxRangeSelector. */ - selectedRange?: { - /** Specifies the start value of the range to be selected when displaying the dxRangeSelector widget on a page. */ - startValue?: any; - /** Specifies the end value of the range to be selected when displaying the dxRangeSelector widget on a page. */ - endValue?: any; - }; - /** Specifies the color of the selected range. */ - selectedRangeColor?: string; - /** Range selector's indent options. */ - indent?: { - /** Specifies range selector's left indent. */ - left?: number; - /** Specifies range selector's right indent. */ - right?: number; - }; - /** A handler for the selectedRangeChanged event. */ - onSelectedRangeChanged?: (e: { - startValue: any; - endValue: any; - component: dxRangeSelector; - element: Element; - }) => void; - /** Specifies range selector shutter options. */ - shutter?: { - /** Specifies shutter color. */ - color?: string; - /** Specifies the opacity of the color of shutters. */ - opacity?: number; - }; - /** Specifies in pixels the size of the dxRangeSelector widget. */ - size?: viz.core.Size; - /** Specifies the appearance of the range selector's slider handles. */ - sliderHandle?: { - /** Specifies the color of the slider handles. */ - color?: string; - /** Specifies the opacity of the slider handles. */ - opacity?: number; - /** Specifies the width of the slider handles. */ - width?: number; - }; - /** Defines the options of the range selector slider markers. */ - sliderMarker?: { - /** Specifies the color of the slider markers. */ - color?: string; - /** Specifies a callback function that returns the text to be displayed by slider markers. */ - customizeText?: (scaleValue: { value: any; valueText: any; }) => string; - /** Specifies font options for the text displayed by the range selector slider markers. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in slider markers. */ - format?: string; - /** Specifies the color used for the slider marker text when the currently selected range does not match the minRange and maxRange values. */ - invalidRangeColor?: string; - /** - * Specifies the empty space between the marker's border and the marker’s text. - * @deprecated Use the 'paddingTopBottom' and 'paddingLeftRight' options instead - */ - padding?: number; - /** Specifies the empty space between the marker's top and bottom borders and the marker's text. */ - paddingTopBottom?: number; - /** Specifies the empty space between the marker's left and right borders and the marker's text. */ - paddingLeftRight?: number; - /** Specifies the placeholder height of the slider marker. */ - placeholderHeight?: number; - /** - * Specifies in pixels the height and width of the space reserved for the range selector slider markers. - * @deprecated Use the 'placeholderHeight' and 'indent' options instead - */ - placeholderSize?: { - /** Specifies the height of the placeholder for the left and right slider markers. */ - height?: number; - /** Specifies the width of the placeholder for the left and right slider markers. */ - width?: { - /** Specifies the width of the left slider marker's placeholder. */ - left?: number; - /** Specifies the width of the right slider marker's placeholder. */ - right?: number; - }; - }; - /** Specifies a precision for the formatted value displayed in slider markers. */ - precision?: number; - /** Indicates whether or not the slider markers are visible. */ - visible?: boolean; - }; - } - /** A widget that allows end users to select a range of values on a scale. */ - export class dxRangeSelector extends viz.core.BaseWidget { - constructor(element: JQuery, options?: dxRangeSelectorOptions); - constructor(element: Element, options?: dxRangeSelectorOptions); - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(skipChartAnimation?: boolean): void; - /** Returns the currently selected range. */ - getSelectedRange(): { startValue: any; endValue: any; }; - /** Sets a specified range. */ - setSelectedRange(selectedRange: { startValue: any; endValue: any; }): void; - } -} -interface JQuery { - dxRangeSelector(options?: DevExpress.viz.rangeSelector.dxRangeSelectorOptions): JQuery; - dxRangeSelector(methodName: string, ...params: any[]): any; - dxRangeSelector(methodName: "instance"): DevExpress.viz.rangeSelector.dxRangeSelector; -} -declare namespace DevExpress.viz.map { - /** This section describes the fields and methods that can be used in code to manipulate the Layer object. */ - export interface MapLayer { - /** The name of the layer. */ - name: string; - /** The layer index in the layers array. */ - index: number; - /** The layer type. Can be "area", "line" or "marker". */ - type: string; - /** The type of the layer elements. */ - elementType: string; - /** Gets all layer elements. */ - getElements(): Array; - /** Deselects all layer elements. */ - clearSelection(): void; - } - /** This section describes the fields and methods that can be used in code to manipulate the Layer Element object. */ - export interface MapLayerElement { - /** The parent layer of the layer element. */ - layer: MapLayer; - /** Gets the layer element coordinates. */ - coordinates(): Object; - /** Sets the value of an attribute. */ - attribute(name: string, value: any): void; - /** Gets the value of an attribute. */ - attribute(name: string): any; - /** Gets the selection state of the layer element. */ - selected(): boolean; - /** Sets the selection state of the layer element. */ - selected(state: boolean): void; - /** Applies the layer element settings and updates element appearance. */ - applySettings(settings: any): void; - } - /** - * This section describes the fields and methods that can be used in code to manipulate the Area object. - * @deprecated Use the "Layer Element" instead - */ - export interface Area { - /** - * Contains the element type. - * @deprecated ..\..\Layer\2 Fields\type.md - */ - type: string; - /** - * Return the value of an attribute. - * @deprecated ..\..\Layer Element\3 Methods\attribute(name_value).md - */ - attribute(name: string): any; - /** - * Provides information about the selection state of an area. - * @deprecated Use the "selected()" method of the Layer Element - */ - selected(): boolean; - /** - * Sets a new selection state for an area. - * @deprecated Use the "selected(state)" method of the Layer Element - */ - selected(state: boolean): void; - /** - * Applies the area settings specified as a parameter and updates the area appearance. - * @deprecated ..\..\Layer Element\3 Methods\applySettings(settings).md - */ - applySettings(settings: any): void; - } - /** - * This section describes the fields and methods that can be used in code to manipulate the Markers object. - * @deprecated Use the "Layer Element" instead - */ - export interface Marker { - /** - * Contains the descriptive text accompanying the map marker. - * @deprecated Get the text with the "attribute" method (using the "layers.label.dataField" value) - */ - text: string; - /** - * Contains the type of the element. - * @deprecated ..\..\Layer\2 Fields\type.md - */ - type: string; - /** - * Contains the URL of an image map marker. - * @deprecated Get the url with the "attribute" method (using the "layers.dataField" value) - */ - url: string; - /** - * Contains the value of a bubble map marker. - * @deprecated Get the value with the "attribute" method (using the "layers.dataField" value) - */ - value: number; - /** - * Contains the values of a pie map marker. - * @deprecated Get the values with the "attribute" method (using the "layers.dataField" value) - */ - values: Array; - /** - * Returns the value of an attribute. - * @deprecated ..\..\Layer Element\3 Methods\attribute(name_value).md - */ - attribute(name: string): any; - /** - * Returns the coordinates of a specific marker. - * @deprecated ..\..\Layer Element\3 Methods\coordinates().md - */ - coordinates(): Array; - /** - * Provides information about the selection state of a marker. - * @deprecated Use the "selected()" method of the Layer Element - */ - selected(): boolean; - /** - * Sets a new selection state for a marker. - * @deprecated Use the "selected(state)" method of the Layer Element - */ - selected(state: boolean): void; - /** - * Applies the marker settings specified as a parameter and updates marker appearance. - * @deprecated ..\..\Layer Element\3 Methods\applySettings(settings).md - */ - applySettings(settings: any): void; - } - export interface MapLayerSettings { - /** Specifies the layer name. */ - name?: string; - /** Specifies layer type. */ - type?: string; - /** Specifies the type of a marker element. Setting this option makes sense only if the layer type is "marker". */ - elementType?: string; - /** Specifies a data source for the layer. */ - data?: any; - /** Specifies the line width (for layers of a line type) or width of the layer elements border in pixels. */ - borderWidth?: number; - /** Specifies a color for the border of the layer elements. */ - borderColor?: string; - /** Specifies a color for layer elements. */ - color?: string; - /** Specifies a color for the border of the layer element when it is hovered over. */ - hoveredBorderColor?: string; - /** Specifies the pixel-measured line width (for layers of a line type) or width for the border of the layer element when it is hovered over. */ - hoveredBorderWidth?: number; - /** Specifies a color for a layer element when it is hovered over. */ - hoveredColor?: string; - /** Specifies a pixel-measured line width (for layers of a line type) or width for the border of the layer element when it is selected. */ - selectedBorderWidth?: number; - /** Specifies a color for the border of the layer element when it is selected. */ - selectedBorderColor?: string; - /** Specifies a color for the layer element when it is selected. */ - selectedColor?: string; - /** Specifies the layer opacity (from 0 to 1). */ - opacity?: number; - /** Specifies the size of markers. Setting this option makes sense only if the layer type is "marker" and the elementType is "dot", "pie" or "image". */ - size?: number; - /** Specifies the pixel-measured diameter of the marker that represents the smallest value. Setting this option makes sense only if the layer type is "marker". */ - minSize?: number; - /** Specifies the pixel-measured diameter of the marker that represents the biggest value. Setting this option makes sense only if the layer type is "marker". */ - maxSize?: number; - /** Specifies whether or not to change the appearance of a layer element when it is hovered over. */ - hoverEnabled?: boolean; - /** Specifies whether single or multiple map elements can be selected on a vector map. */ - selectionMode?: string; - /** Specifies the name of the palette or a custom range of colors to be used for coloring a layer. */ - palette?: any; - /** Specifies the number of colors in a palette. */ - paletteSize?: number; - /** Allows you to paint layer elements with similar attributes in the same color. */ - colorGroups?: Array; - /** Specifies the field that provides data to be used for coloring of layer elements. */ - colorGroupingField?: string; - /** Allows you to display bubbles with similar attributes in the same size. Setting this option makes sense only if the layer type is "marker" and the elementType is "bubble". */ - sizeGroups?: Array; - /** Specifies the field that provides data to be used for sizing bubble markers. Setting this option makes sense only if the layer type is "marker" and the elementType is "bubble". */ - sizeGroupingField?: string; - /** Specifies the name of the attribute containing marker data. Setting this option makes sense only if the layer type is "marker" and the elementType is "bubble", "pie" or "image". */ - dataField?: string; - /** Specifies the function that customizes each layer element individually. */ - customize?: (eleemnts: Array) => void; - /** Specifies marker label options. */ - label?: { - /** The name of the data attribute containing marker texts. */ - dataField?: string; - /** Enables marker labels. */ - enabled?: boolean; - /** Specifies font options for marker labels. */ - font?: viz.core.Font; - }; - } - export interface AreaSettings { - /** - * Specifies the width of the area border in pixels. - * @deprecated ..\layers\borderWidth.md - */ - borderWidth?: number; - /** - * Specifies a color for the area border. - * @deprecated ..\layers\borderColor.md - */ - borderColor?: string; - /** - * Specifies a color for an area. - * @deprecated ..\layers\color.md - */ - color?: string; - /** - * Specifies the function that customizes each area individually. - * @deprecated ..\layers\customize.md - */ - customize?: (areaInfo: Area) => AreaSettings; - /** - * Specifies a color for the area border when the area is hovered over. - * @deprecated ..\layers\hoveredBorderColor.md - */ - hoveredBorderColor?: string; - /** - * Specifies the pixel-measured width of the area border when the area is hovered over. - * @deprecated ..\layers\hoveredBorderWidth.md - */ - hoveredBorderWidth?: number; - /** - * Specifies a color for an area when this area is hovered over. - * @deprecated ..\layers\hoveredColor.md - */ - hoveredColor?: string; - /** - * Specifies whether or not to change the appearance of an area when it is hovered over. - * @deprecated ..\layers\hoverEnabled.md - */ - hoverEnabled?: boolean; - /** - * Configures area labels. - * @deprecated ..\..\layers\label\label.md - */ - label?: { - /** - * Specifies the data field that provides data for area labels. - * @deprecated ..\..\layers\label\dataField.md - */ - dataField?: string; - /** - * Enables area labels. - * @deprecated ..\..\layers\label\enabled.md - */ - enabled?: boolean; - /** - * Specifies font options for area labels. - * @deprecated ..\..\..\layers\label\font\font.md - */ - font?: viz.core.Font; - }; - /** - * Specifies the name of the palette or a custom range of colors to be used for coloring a map. - * @deprecated ..\layers\palette.md - */ - palette?: any; - /** - * Specifies the number of colors in a palette. - * @deprecated ..\layers\paletteSize.md - */ - paletteSize?: number; - /** - * Allows you to paint areas with similar attributes in the same color. - * @deprecated ..\layers\colorGroups.md - */ - colorGroups?: Array; - /** - * Specifies the field that provides data to be used for coloring areas. - * @deprecated ..\layers\colorGroupingField.md - */ - colorGroupingField?: string; - /** - * Specifies a color for the area border when the area is selected. - * @deprecated ..\layers\selectedBorderColor.md - */ - selectedBorderColor?: string; - /** - * Specifies a color for an area when this area is selected. - * @deprecated ..\layers\selectedColor.md - */ - selectedColor?: string; - /** - * Specifies the pixel-measured width of the area border when the area is selected. - * @deprecated ..\layers\selectedBorderWidth.md - */ - selectedBorderWidth?: number; - /** - * Specifies whether single or multiple areas can be selected on a vector map. - * @deprecated ..\layers\selectionMode.md - */ - selectionMode?: string; - } - export interface MarkerSettings { - /** - * Specifies a color for the marker border. - * @deprecated ..\layers\borderColor.md - */ - borderColor?: string; - /** - * Specifies the width of the marker border in pixels. - * @deprecated ..\layers\borderWidth.md - */ - borderWidth?: number; - /** - * Specifies a color for a marker of the dot or bubble type. - * @deprecated ..\layers\color.md - */ - color?: string; - /** - * Specifies the function that customizes each marker individually. - * @deprecated ..\layers\customize.md - */ - customize?: (markerInfo: Marker) => MarkerSettings; - /** - * Specifies the pixel-measured width of the marker border when the marker is hovered over. - * @deprecated ..\layers\hoveredBorderWidth.md - */ - hoveredBorderWidth?: number; - /** - * Specifies a color for the marker border when the marker is hovered over. - * @deprecated ..\layers\hoveredBorderColor.md - */ - hoveredBorderColor?: string; - /** - * Specifies a color for a marker of the dot or bubble type when this marker is hovered over. - * @deprecated ..\layers\hoveredColor.md - */ - hoveredColor?: string; - /** - * Specifies whether or not to change the appearance of a marker when it is hovered over. - * @deprecated ..\layers\hoverEnabled.md - */ - hoverEnabled?: boolean; - /** - * Specifies marker label options. - * @deprecated ..\..\layers\label\label.md - */ - label?: { - /** - * Enables marker labels. - * @deprecated ..\..\layers\label\enabled.md - */ - enabled?: boolean; - /** - * Specifies font options for marker labels. - * @deprecated ..\..\..\layers\label\font\font.md - */ - font?: viz.core.Font; - }; - /** - * Specifies the pixel-measured diameter of the marker that represents the biggest value. Setting this option makes sense only if you use markers of the bubble type. - * @deprecated ..\layers\maxSize.md - */ - maxSize?: number; - /** - * Specifies the pixel-measured diameter of the marker that represents the smallest value. Setting this option makes sense only if you use markers of the bubble type. - * @deprecated ..\layers\minSize.md - */ - minSize?: number; - /** - * Specifies the opacity of markers. Setting this option makes sense only if you use markers of the bubble type. - * @deprecated ..\layers\opacity.md - */ - opacity?: number; - /** - * Specifies the pixel-measured width of the marker border when the marker is selected. - * @deprecated ..\layers\selectedBorderWidth.md - */ - selectedBorderWidth?: number; - /** - * Specifies a color for the marker border when the marker is selected. - * @deprecated ..\layers\selectedBorderColor.md - */ - selectedBorderColor?: string; - /** - * Specifies a color for a marker of the dot or bubble type when this marker is selected. - * @deprecated ..\layers\selectedColor.md - */ - selectedColor?: string; - /** - * Specifies whether a single or multiple markers can be selected on a vector map. - * @deprecated ..\layers\selectionMode.md - */ - selectionMode?: string; - /** - * Specifies the size of markers. Setting this option makes sense for any type of marker except bubble. - * @deprecated ..\layers\size.md - */ - size?: number; - /** - * Specifies the type of markers to be used on the map. - * @deprecated ..\layers\elementType.md - */ - type?: string; - /** - * Specifies the name of a palette or a custom set of colors to be used for coloring markers of the pie type. - * @deprecated ..\layers\palette.md - */ - palette?: any; - /** - * Allows you to paint markers with similar attributes in the same color. - * @deprecated ..\layers\colorGroups.md - */ - colorGroups?: Array; - /** - * Specifies the field that provides data to be used for coloring markers. - * @deprecated ..\layers\colorGroupingField.md - */ - colorGroupingField?: string; - /** - * Allows you to display bubbles with similar attributes in the same size. - * @deprecated ..\layers\sizeGroups.md - */ - sizeGroups?: Array; - /** - * Specifies the field that provides data to be used for sizing bubble markers. - * @deprecated ..\layers\sizeGroupingField.md - */ - sizeGroupingField?: string; - } - export interface dxVectorMapOptions extends viz.core.BaseWidgetOptions { - /** - * An object specifying options for the map areas. - * @deprecated Use the 'layers' option instead - */ - areaSettings?: AreaSettings; - /** Specifies the options for the map background. */ - background?: { - /** Specifies a color for the background border. */ - borderColor?: string; - /** Specifies a color for the background. */ - color?: string; - }; - /** Specifies options for dxVectorMap widget layers. */ - layers?: Array; - /** Specifies the map projection. */ - projection?: Object; - /** Specifies the positioning of a map in geographical coordinates. */ - bounds?: Array; - /** Specifies the options of the control bar. */ - controlBar?: { - /** Specifies a color for the outline of the control bar elements. */ - borderColor?: string; - /** Specifies a color for the inner area of the control bar elements. */ - color?: string; - /** Specifies whether or not to display the control bar. */ - enabled?: boolean; - /** Specifies the margin of the control bar in pixels. */ - margin?: number; - /** Specifies the position of the control bar. */ - horizontalAlignment?: string; - /** Specifies the position of the control bar. */ - verticalAlignment?: string; - /** Specifies the opacity of the Control_Bar. */ - opacity?: number; - }; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** - * Specifies a data source for the map area. - * @deprecated Use the 'layers.data' option instead - */ - mapData?: any; - /** - * Specifies a data source for the map markers. - * @deprecated Use the 'layers.data' option instead - */ - markers?: any; - /** - * An object specifying options for the map markers. - * @deprecated Use the 'layers' option instead - */ - markerSettings?: MarkerSettings; - /** Specifies the size of the dxVectorMap widget. */ - size?: viz.core.Size; - /** Specifies a title for the vector map. */ - title?: viz.core.Title; - /** Specifies tooltip options. */ - tooltip?: viz.core.Tooltip; - /** Configures map legends. */ - legends?: Array; - /** Specifies whether or not the map should respond when a user rolls the mouse wheel. */ - wheelEnabled?: boolean; - /** Specifies whether the map should respond to touch gestures. */ - touchEnabled?: boolean; - /** Disables the zooming capability. */ - zoomingEnabled?: boolean; - /** Specifies the geographical coordinates of the center for a map. */ - center?: Array; - /** A handler for the centerChanged event. */ - onCenterChanged?: (e: { - center: Array; - component: dxVectorMap; - element: Element; - }) => void; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: dxVectorMap; - element: Element; - target: {}; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: dxVectorMap; - element: Element; - target: {}; - }) => void; - /** Specifies a number that is used to zoom a map initially. */ - zoomFactor?: number; - /** Specifies a map's maximum zoom factor. */ - maxZoomFactor?: number; - /** A handler for the zoomFactorChanged event. */ - onZoomFactorChanged?: (e: { - component: dxVectorMap; - element: Element; - zoomFactor: number; - }) => void; - /** A handler for the click event. */ - onClick?: any; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: (e: { - component: dxVectorMap; - element: Element; - target: MapLayerElement; - }) => void; - /** - * A handler for the areaClick event. - * @deprecated Use the 'onClick' option instead - */ - onAreaClick?: any; - /** - * A handler for the areaSelectionChanged event. - * @deprecated Use the 'onSelectionChanged' option instead - */ - onAreaSelectionChanged?: (e: { - target: Area; - component: dxVectorMap; - element: Element; - }) => void; - /** - * A handler for the markerClick event. - * @deprecated Use the 'onClick' option instead - */ - onMarkerClick?: any; - /** - * A handler for the markerSelectionChanged event. - * @deprecated Use the 'onSelecitonChanged' option instead - */ - onMarkerSelectionChanged?: (e: { - target: Marker; - component: dxVectorMap; - element: Element; - }) => void; - /** Disables the panning capability. */ - panningEnabled?: boolean; - } - export interface Legend extends viz.core.BaseLegend { - /** Specifies the color of item markers in the legend. The specified color applied only when the legend uses 'size' source. */ - markerColor?: string; - /** Specifies text for legend items. */ - customizeText?: (itemInfo: { start: number; end: number; index: number; color: string; size: number; }) => string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the text of a legend item. */ - customizeHint?: (itemInfo: { start: number; end: number; index: number; color: string; size: number }) => string; - /** Specifies the source of data for the legend. */ - source?: { - /** Specifies a layer to which the legend belongs. */ - layer?: string; - /** Specifies the type of the legend grouping. */ - grouping?: string; - } - } - /** A vector map widget. */ - export class dxVectorMap extends viz.core.BaseWidget { - constructor(element: JQuery, options?: dxVectorMapOptions); - constructor(element: Element, options?: dxVectorMapOptions); - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(): void; - /** Gets the current coordinates of the map center. */ - center(): Array; - /** Sets the coordinates of the map center. */ - center(centerCoordinates: Array): void; - /** - * Deselects all the selected areas on a map. The areas are displayed in their initial style after. - * @deprecated Use the 'clearSelection' method on a layer instead - */ - clearAreaSelection(): void; - /** - * Deselects all the selected markers on a map. The markers are displayed in their initial style after. - * @deprecated Use the 'clearSelection' method on a layer instead - */ - clearMarkerSelection(): void; - /** Deselects all the selected area and markers on a map at once. The areas and markers are displayed in their initial style after. */ - clearSelection(): void; - /** Converts client area coordinates into map coordinates. */ - convertCoordinates(x: number, y: number): Array; - /** Gets all map layers. */ - getLayers(): Array; - /** Gets the layer by its index. */ - getLayerByIndex(index: number): MapLayer; - /** Gets the layer by its name. */ - getLayerByName(name: string): MapLayer; - /** - * Returns an array with all the map areas. - * @deprecated Use the 'getElements' method on a layer instead - */ - getAreas(): Array; - /** - * Returns an array with all the map markers. - * @deprecated Use the 'getElements' method on a layer instead - */ - getMarkers(): Array; - /** Gets the current coordinates of the map viewport. */ - viewport(): Array; - /** Sets the coordinates of the map viewport. */ - viewport(viewportCoordinates: Array): void; - /** Gets the current value of the map zoom factor. */ - zoomFactor(): number; - /** Sets the value of the map zoom factor. */ - zoomFactor(zoomFactor: number): void; - } - export var projection: ProjectionCreator; - export interface ProjectionCreator { - /** Creates a new projection. */ - (data: { - to?: (coordinates: Array) => Array; - from?: (coordinates: Array) => Array; - aspectRatio?: number; - }): Object; - /** Gets the default or custom projection from the projection storage. */ - get(name: string): Object; - /** Adds a new projection to the internal projections storage. */ - add(name: string, projection: Object): void; - } -} -interface JQuery { - dxVectorMap(options?: DevExpress.viz.map.dxVectorMapOptions): JQuery; - dxVectorMap(methodName: string, ...params: any[]): any; - dxVectorMap(methodName: "instance"): DevExpress.viz.map.dxVectorMap; -} -declare namespace DevExpress.viz.sparklines { - export interface SparklineTooltip extends viz.core.Tooltip { - /** - * Specifies how a tooltip is horizontally aligned relative to the graph. - * @deprecated Tooltip alignment is no more available. - */ - horizontalAlignment?: string; - /** - * Specifies how a tooltip is vertically aligned relative to the graph. - * @deprecated Tooltip alignment is no more available. - */ - verticalAlignment?: string; - } - export interface BaseSparklineOptions extends viz.core.BaseWidgetOptions { - /** Specifies the blank space between the widget's extreme elements and the boundaries of the area provided for the widget in pixels. */ - margin?: viz.core.Margins; - /** Specifies the size of the widget. */ - size?: viz.core.Size; - /** Specifies tooltip options. */ - tooltip?: SparklineTooltip; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: BaseSparkline; - element: Element; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: BaseSparkline; - element: Element; - }) => void; - } - /** Overridden by descriptions for particular widgets. */ - export class BaseSparkline extends viz.core.BaseWidget { - /** Redraws a widget. */ - render(): void; - } - export interface dxBulletOptions extends BaseSparkline { - /** Specifies a color for the bullet bar. */ - color?: string; - /** Specifies an end value for the invisible scale. */ - endScaleValue?: number; - /** Specifies whether or not to show the target line. */ - showTarget?: boolean; - /** Specifies whether or not to show the line indicating zero on the invisible scale. */ - showZeroLevel?: boolean; - /** Specifies a start value for the invisible scale. */ - startScaleValue?: number; - /** Specifies the value indicated by the target line. */ - target?: number; - /** Specifies a color for both the target and zero level lines. */ - targetColor?: string; - /** Specifies the width of the target line. */ - targetWidth?: number; - /** Specifies the primary value indicated by the bullet bar. */ - value?: number; - } - /** A bullet graph widget. */ - export class dxBullet extends BaseSparkline { - constructor(element: JQuery, options?: dxBulletOptions); - constructor(element: Element, options?: dxBulletOptions); - } - export interface dxSparklineOptions extends BaseSparklineOptions { - /** Specifies the data source field that provides arguments for a sparkline. */ - argumentField?: string; - /** Sets a color for the bars indicating negative values. Available for a sparkline of the bar type only. */ - barNegativeColor?: string; - /** Sets a color for the bars indicating positive values. Available for a sparkline of the bar type only. */ - barPositiveColor?: string; - /** Specifies a data source for the sparkline. */ - dataSource?: Array; - /** Sets a color for the boundary of both the first and last points on a sparkline. */ - firstLastColor?: string; - /** Specifies whether a sparkline ignores null data points or not. */ - ignoreEmptyPoints?: boolean; - /** Sets a color for a line on a sparkline. Available for the sparklines of the line- and area-like types. */ - lineColor?: string; - /** Specifies a width for a line on a sparkline. Available for the sparklines of the line- and area-like types. */ - lineWidth?: number; - /** Sets a color for the bars indicating the values that are less than the winloss threshold. Available for a sparkline of the winloss type only. */ - lossColor?: string; - /** Sets a color for the boundary of the maximum point on a sparkline. */ - maxColor?: string; - /** Sets a color for the boundary of the minimum point on a sparkline. */ - minColor?: string; - /** Sets a color for points on a sparkline. Available for the sparklines of the line- and area-like types. */ - pointColor?: string; - /** Specifies the diameter of sparkline points in pixels. Available for the sparklines of line- and area-like types. */ - pointSize?: number; - /** Specifies a symbol to use as a point marker on a sparkline. Available for the sparklines of the line- and area-like types. */ - pointSymbol?: string; - /** Specifies whether or not to indicate both the first and last values on a sparkline. */ - showFirstLast?: boolean; - /** Specifies whether or not to indicate both the minimum and maximum values on a sparkline. */ - showMinMax?: boolean; - /** Determines the type of a sparkline. */ - type?: string; - /** Specifies the data source field that provides values for a sparkline. */ - valueField?: string; - /** Sets a color for the bars indicating the values greater than a winloss threshold. Available for a sparkline of the winloss type only. */ - winColor?: string; - /** Specifies a value that serves as a threshold for the sparkline of the winloss type. */ - winlossThreshold?: number; - /** Specifies the minimum value of the sparkline value axis. */ - minValue?: number; - /** Specifies the maximum value of the sparkline's value axis. */ - maxValue?: number; - } - /** A sparkline widget. */ - export class dxSparkline extends BaseSparkline { - constructor(element: JQuery, options?: dxSparklineOptions); - constructor(element: Element, options?: dxSparklineOptions); - } -} -interface JQuery { - dxBullet(options?: DevExpress.viz.sparklines.dxBulletOptions): JQuery; - dxBullet(methodName: string, ...params: any[]): any; - dxBullet(methodName: "instance"): DevExpress.viz.sparklines.dxBullet; - dxSparkline(options?: DevExpress.viz.sparklines.dxSparklineOptions): JQuery; - dxSparkline(methodName: string, ...params: any[]): any; - dxSparkline(methodName: "instance"): DevExpress.viz.sparklines.dxSparkline; -} diff --git a/devextreme/devextreme-15.2.9.d.ts b/devextreme/devextreme-15.2.9.d.ts deleted file mode 100644 index 0b70507a5d..0000000000 --- a/devextreme/devextreme-15.2.9.d.ts +++ /dev/null @@ -1,7443 +0,0 @@ -// Type definitions for DevExtreme 15.2.9 -// Project: http://js.devexpress.com/ -// Definitions by: DevExpress Inc. -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -/// - -declare module DevExpress { - /** A mixin that provides a capability to fire and subscribe to events. */ - export interface EventsMixin { - /** Subscribes to a specified event. */ - on(eventName: string, eventHandler: Function): T; - /** Subscribes to the specified events. */ - on(events: { [eventName: string]: Function; }): T; - /** Detaches all event handlers from the specified event. */ - off(eventName: string): Object; - /** Detaches a particular event handler from the specified event. */ - off(eventName: string, eventHandler: Function): T; - } - /** An object that serves as a namespace for the methods required to perform validation. */ - export module validationEngine { - export interface IValidator { - validate(): ValidatorValidationResult; - reset(): void; - } - export interface ValidatorValidationResult { - isValid: boolean; - name?: string; - value: any; - brokenRule: any; - validationRules: any[]; - } - export interface ValidationGroupValidationResult { - isValid: boolean; - brokenRules: any[]; - validators: IValidator[]; - } - export interface GroupConfig extends EventsMixin { - group: any; - validators: IValidator[]; - validate(): ValidationGroupValidationResult; - reset(): void; - } - /** Provides access to the object that represents the specified validation group. */ - export function getGroupConfig(group: any): GroupConfig - /** Provides access to the object that represents the default validation group. */ - export function getGroupConfig(): GroupConfig - /** Validates rules of the validators that belong to the specified validation group. */ - export function validateGroup(group: any): ValidationGroupValidationResult; - /** Validates rules of the validators that belong to the default validation group. */ - export function validateGroup(): ValidationGroupValidationResult; - /** Resets the values and validation result of the editors that belong to the specified validation group. */ - export function resetGroup(group: any): void; - /** Resets the values and validation result of the editors that belong to the default validation group. */ - export function resetGroup(): void; - /** Validates the rules that are defined within the dxValidator objects that are registered for the specified ViewModel. */ - export function validateModel(model: Object): ValidationGroupValidationResult; - /** Registers all the dxValidator objects by which the fields of the specified ViewModel are extended. */ - export function registerModelForValidation(model: Object) : void; - } - export var hardwareBackButton: JQueryCallback; - /** Processes the hardware back button click. */ - export function processHardwareBackButton(): void; - /** Hides the last displayed overlay widget. */ - export function hideTopOverlay(): boolean; - /** Specifies whether or not the entire application/site supports right-to-left representation. */ - export var rtlEnabled: boolean; - /** Registers a new component in the DevExpress.ui namespace as a jQuery plugin, Angular directive and Knockout binding. */ - export function registerComponent(name: string, componentClass: Object): void; - /** Registers a new component in the specified namespace as a jQuery plugin, Angular directive and Knockout binding. */ - export function registerComponent(name: string, namespace: Object, componentClass: Object): void; - export function requestAnimationFrame(callback: Function): number; - export function cancelAnimationFrame(requestID: number): void; - /** Custom Knockout binding that links an HTML element with a specific action. */ - export class Action { } - /** Used to get URLs that vary in a locally running application and the application running on production. */ - export class EndpointSelector { - constructor(options: { - [key: string]: { - local?: string; - production?: string; - } - }); - /** Returns a local or a productional URL depending on how the application is currently running. */ - urlFor(key: string): string; - } - /** An object that serves as a namespace for the methods that are used to animate UI elements. */ - export module fx { - /** Defines animation options. */ - export interface AnimationOptions { - /** A function called after animation is completed. */ - complete?: (element: JQuery, config: AnimationOptions) => void; - /** A number specifying wait time before animation execution. */ - delay?: number; - /** A number specifying the time period to wait before the animation of the next stagger item starts. */ - staggerDelay?: number; - /** A number specifying the time in milliseconds spent on animation. */ - duration?: number; - /** A string specifying the type of an easing function used for animation. */ - easing?: string; - /** Specifies the initial animation state. */ - from?: any; - /** A function called before animation is started. */ - start?: (element: JQuery, config: AnimationOptions) => void; - /** Specifies a final animation state. */ - to?: any; - /** A string value specifying the animation type. */ - type?: string; - /** Specifies the animation direction for the "slideIn" and "slideOut" animation types. */ - direction?: string; - } - /** Animates the specified element. */ - export function animate(element: HTMLElement, config: AnimationOptions): Object; - /** Returns a value indicating whether the specified element is being animated. */ - export function isAnimating(element: HTMLElement): boolean; - /** Stops the animation. */ - export function stop(element: HTMLElement, jumpToEnd: boolean): void; - } - /** The manager that performs several specified animations at a time. */ - export class TransitionExecutor { - /** Deletes all the animations registered in the Transition Executor by using the enter(elements, animation) and leave(elements, animation) methods. */ - reset(): void; - /** Registers a set of elements that should be animated as "entering" using the specified animation configuration. */ - enter(elements: JQuery, animation: any): void; - /** Registers a set of elements that should be animated as "leaving" using the specified animation configuration. */ - leave(elements: JQuery, animation: any): void; - /** Starts all the animations registered using the enter(elements, animation) and leave(elements, animation) methods beforehand. */ - start(config: Object): JQueryPromise; - /** Stops all started animations. */ - stop(): void; - } - export class AnimationPresetCollection { - /** Resets all the changes made in the animation repository. */ - resetToDefaults(): void; - /** Deletes the specified animation or clears all the animation repository, if an animation name is not passed. */ - clear(name: string): void; - /** Adds the specified animation preset to the animation repository by the specified name. */ - registerPreset(name: string, config: any): void; - /** Applies the changes made in the animation repository. */ - applyChanges(): void; - /** Returns the configuration of the animation found in the animation repository by the specified name for the current device. */ - getPreset(name: string): void; - /** Registers predefined animations in the animation repository. */ - registerDefaultPresets(): void; - } - /** A repository of animations. */ - export var animationPresets: AnimationPresetCollection; - /** The device object defines the device on which the application is running. */ - export interface Device { - /** Indicates whether or not the device platform is Android. */ - android?: boolean; - /** Specifies the type of the device on which the application is running. */ - deviceType?: string; - /** Indicates whether or not the device platform is generic, which means that the application will look and behave according to a generic "light" or "dark" theme. */ - generic?: boolean; - /** Indicates whether or not the device platform is iOS. */ - ios?: boolean; - /** Indicates whether or not the device type is 'phone'. */ - phone?: boolean; - /** Specifies the platform of the device on which the application is running. */ - platform?: string; - /** Indicates whether or not the device type is 'tablet'. */ - tablet?: boolean; - /** Specifies an array with the major and minor versions of the device platform. */ - version?: Array; - /** Indicates whether or not the device platform is Windows. */ - win?: boolean; - /** Specifies a performance grade of the current device. */ - grade?: string; - } - export class Devices implements EventsMixin { - constructor(options: { window: Window }); - /** Overrides actual device information to force the application to operate as if it was running on the specified device. */ - current(deviceName: any): void; - /** Returns information about the current device. */ - current(): Device; - orientationChanged: JQueryCallback; - /** Returns the current device orientation. */ - orientation(): string; - /** Returns real information about the current device regardless of the value passed to the devices.current(deviceName) method. */ - real(): Device; - on(eventName: "orientationChanged", eventHandler: (e: { orientation: string }) => void): Devices; - on(eventName: string, eventHandler: Function): Devices; - on(events: { [eventName: string]: Function; }): Devices; - off(eventName: "orientationChanged"): Devices; - off(eventName: string): Devices; - off(eventName: "orientationChanged", eventHandler: (e: { orientation: string }) => void): Devices; - off(eventName: string, eventHandler: Function): Devices; - } - /** An object that serves as a namespace for the methods and events specifying information on the current device. */ - export var devices: Devices; - /** The position object specifies the widget positioning options. */ - export interface PositionOptions { - /** The target element position that the widget is positioned against. */ - at?: string; - /** The element within which the widget is positioned. */ - boundary?: Element; - /** A string value holding horizontal and vertical offset from the window's boundaries. */ - boundaryOffset?: string; - /** Specifies how to move the widget if it overflows the screen. */ - collision?: any; - /** The position of the widget to align against the target element. */ - my?: string; - /** The target element that the widget is positioned against. */ - of?: HTMLElement; - /** A string value holding horizontal and vertical offset in pixels, separated by a space (e.g., "5 -10"). */ - offset?: string; - } - export interface ComponentOptions { - /** A handler for the initialized event. */ - onInitialized?: Function; - /** A handler for the optionChanged event. */ - onOptionChanged?: Function; - /** A handler for the disposing event. */ - onDisposing?: Function; - } - /** A base class for all components and widgets. */ - export class Component { - constructor(options?: ComponentOptions) - /** Prevents the component from refreshing until the endUpdate method is called. */ - beginUpdate(): void; - /** Enables the component to refresh after the beginUpdate method call. */ - endUpdate(): void; - /** Returns an instance of this component class. */ - instance(): Component; - /** Returns the configuration options of this component. */ - option(): { - [optionKey: string]: any; - }; - /** Sets one or more options of this component. */ - option(options: { - [optionKey: string]: any; - }): void; - /** Gets the value of the specified configuration option of this component. */ - option(optionName: string): any; - /** Sets a value to the specified configuration option of this component. */ - option(optionName: string, optionValue: any): void; - } - export interface DOMComponentOptions extends ComponentOptions { - /** Specifies whether or not the current component supports a right-to-left representation. */ - rtlEnabled?: boolean; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies the width of the widget. */ - width?: any; - } - /** A base class for all components. */ - export class DOMComponent extends Component { - constructor(element: JQuery, options?: DOMComponentOptions); - constructor(element: HTMLElement, options?: DOMComponentOptions); - /** Returns the root HTML element of the widget. */ - element(): JQuery; - /** Specifies the device-dependent default configuration options for this component. */ - static defaultOptions(rule: { - device?: any; - options?: any; - }): void; - } - export module data { - export interface ODataError extends Error { - httpStatus?: number; - errorDetails?: any; - } - export interface StoreOptions { - /** A handler for the modified event. */ - onModified?: () => void; - /** A handler for the modifying event. */ - onModifying?: () => void; - /** A handler for the removed event. */ - onRemoved?: (key: any) => void; - /** A handler for the removing event. */ - onRemoving?: (key: any) => void; - /** A handler for the updated event. */ - onUpdated?: (key: any, values: Object) => void; - /** A handler for the updating event. */ - onUpdating?: (key: any, values: Object) => void; - /** A handler for the loaded event. */ - onLoaded?: (result: Array) => void; - /** A handler for the loading event. */ - onLoading?: (loadOptions: LoadOptions) => void; - /** A handler for the inserted event. */ - onInserted?: (values: Object, key: any) => void; - /** A handler for the inserting event. */ - onInserting?: (values: Object) => void; - /** Specifies the function called when the Store causes an error. */ - errorHandler?: (e: Error) => void; - /** Specifies the key properties within the data associated with the Store. */ - key?: any; - } - export interface LoadOptions { - filter?: Object; - sort?: Object; - select?: Object; - expand?: Object; - group?: Object; - skip?: number; - take?: number; - userData?: Object; - requireTotalCount?: boolean; - } - /** The base class for all Stores. */ - export class Store implements EventsMixin { - constructor(options?: StoreOptions); - /** Returns the data item specified by the key. */ - byKey(key: any): JQueryPromise; - /** Adds an item to the data associated with this Store. */ - insert(values: Object): JQueryPromise; - /** Returns the key expression specified via the key configuration option. */ - key(): any; - /** Returns the key of the Store item that matches the specified object. */ - keyOf(obj: Object): any; - /** Starts loading data. */ - load(obj?: LoadOptions): JQueryPromise; - /** Removes the data item specified by the key. */ - remove(key: any): JQueryPromise; - /** Obtains the total count of items that will be returned by the load() function. */ - totalCount(options?: { - filter?: Object; - group?: Object; - }): JQueryPromise; - /** Updates the data item specified by the key. */ - update(key: any, values: Object): JQueryPromise; - on(eventName: "removing", eventHandler: (key: any) => void): Store; - on(eventName: "removed", eventHandler: (key: any) => void): Store; - on(eventName: "updating", eventHandler: (key: any, values: Object) => void): Store; - on(eventName: "updated", eventHandler: (key: any, values: Object) => void): Store; - on(eventName: "inserting", eventHandler: (values: Object) => void): Store; - on(eventName: "inserted", eventHandler: (values: Object, key: any) => void): Store; - on(eventName: "modifying", eventHandler: () => void): Store; - on(eventName: "modified", eventHandler: () => void): Store; - on(eventName: "loading", eventHandler: (loadOptions: LoadOptions) => void): Store; - on(eventName: "loaded", eventHandler: (result: Array) => void): Store; - on(eventName: string, eventHandler: Function): Store; - on(events: { [eventName: string]: Function; }): Store; - off(eventName: "removing"): Store; - off(eventName: "removed"): Store; - off(eventName: "updating"): Store; - off(eventName: "updated"): Store; - off(eventName: "inserting"): Store; - off(eventName: "inserted"): Store; - off(eventName: "modifying"): Store; - off(eventName: "modified"): Store; - off(eventName: "loading"): Store; - off(eventName: "loaded"): Store; - off(eventName: string): Store; - off(eventName: "removing", eventHandler: (key: any) => void): Store; - off(eventName: "removed", eventHandler: (key: any) => void): Store; - off(eventName: "updating", eventHandler: (key: any, values: Object) => void): Store; - off(eventName: "updated", eventHandler: (key: any, values: Object) => void): Store; - off(eventName: "inserting", eventHandler: (values: Object) => void): Store; - off(eventName: "inserted", eventHandler: (values: Object, key: any) => void): Store; - off(eventName: "modifying", eventHandler: () => void): Store; - off(eventName: "modified", eventHandler: () => void): Store; - off(eventName: "loading", eventHandler: (loadOptions: LoadOptions) => void): Store; - off(eventName: "loaded", eventHandler: (result: Array) => void): Store; - off(eventName: string, eventHandler: Function): Store; - } - export interface ArrayStoreOptions extends StoreOptions { - /** Specifies the array associated with this Store. */ - data?: Array; - } - /** A Store accessing an in-memory array. */ - export class ArrayStore extends Store { - constructor(options?: ArrayStoreOptions); - /** Clears all data associated with the current ArrayStore. */ - clear(): void; - /** Creates the Query object for the underlying array. */ - createQuery(): Query; - } - interface Promise { - then(doneFn?: Function, failFn?: Function, progressFn?: Function): Promise; - } - export interface CustomStoreOptions extends StoreOptions { - /** The user implementation of the byKey(key, extraOptions) method. */ - byKey?: (key: any) => Promise; - /** The user implementation of the insert(values) method. */ - insert?: (values: Object) => Promise; - /** The user implementation of the load(options) method. */ - load?: (options?: LoadOptions) => Promise; - /** The user implementation of the remove(key) method. */ - remove?: (key: any) => Promise; - /** The user implementation of the totalCount(options) method. */ - totalCount?: (options?: { - filter?: Object; - group?: Object; - }) => Promise; - /** The user implementation of the update(key, values) method. */ - update?: (key: any, values: Object) => Promise; - } - /** A Store object that enables you to implement your own data access logic. */ - export class CustomStore extends Store { - constructor(options: CustomStoreOptions); - } - export interface DataSourceOptions { - /** Specifies data filtering conditions. */ - filter?: Object; - /** Specifies data grouping conditions. */ - group?: Object; - /** The item mapping function. */ - map?: (record: any) => any; - /** Specifies the maximum number of items the page can contain. */ - pageSize?: number; - /** Specifies whether a DataSource loads data by pages, or all items at once. */ - paginate?: boolean; - /** The data post processing function. */ - postProcess?: (data: any[]) => any[]; - /** Specifies a value by which the required items are searched. */ - searchExpr?: Object; - /** Specifies the comparison operation used to search for the required items. */ - searchOperation?: string; - /** Specifies the value to which the search expression is compared. */ - searchValue?: Object; - /** Specifies the initial select option value. */ - select?: Object; - /** An array of the strings that represent the names of the navigation properties to be loaded simultaneously with the OData store's entity. */ - expand?: Object; - /** Specifies whether or not the DataSource instance requests the total count of items available in the storage. */ - requireTotalCount?: boolean; - /** Specifies the initial sort option value. */ - sort?: Object; - /** Specifies the underlying Store instance used to access data. */ - store?: any; - /** A handler for the changed event. */ - onChanged?: () => void; - /** A handler for the loadingChanged event. */ - onLoadingChanged?: (isLoading: boolean) => void; - /** A handler for the loadError event. */ - onLoadError?: (e?: Error) => void; - } - export interface OperationPromise extends JQueryPromise { - operationId: number; - } - /** An object that provides access to a data web service or local data storage for collection container widgets. */ - export class DataSource implements EventsMixin { - constructor(url: string); - constructor(data: Array); - constructor(options: CustomStoreOptions); - constructor(options: DataSourceOptions); - /** Disposes all resources associated with this DataSource. */ - dispose(): void; - /** Returns the current filter option value. */ - filter(): Object; - /** Sets the filter option value. */ - filter(filterExpr: Object): void; - /** Returns the current group option value. */ - group(): Object; - /** Sets the group option value. */ - group(groupExpr: Object): void; - /** Indicates whether or not the current page contains fewer items than the number of items specified by the pageSize configuration option. */ - isLastPage(): boolean; - /** Indicates whether or not at least one load() method execution has successfully finished. */ - isLoaded(): boolean; - /** Indicates whether or not the DataSource is currently being loaded. */ - isLoading(): boolean; - /** Returns the array of items currently operated by the DataSource. */ - items(): Array; - /** Returns the key expression. */ - key(): any; - /** Starts loading data. */ - load(): OperationPromise>; - /** Clears currently loaded DataSource items and calls the load() method. */ - reload(): OperationPromise>; - /** Returns an object that would be passed to the load() method of the underlying Store according to the current data shaping option values of the current DataSource instance. */ - loadOptions(): Object; - /** Returns the current pageSize option value. */ - pageSize(): number; - /** Sets the pageSize option value. */ - pageSize(value: number): void; - /** Specifies the index of the currently loaded page. */ - pageIndex(): number; - /** Specifies the index of the page to be loaded during the next load() method execution. */ - pageIndex(newIndex: number): void; - /** Returns the current paginate option value. */ - paginate(): boolean; - /** Sets the paginate option value. */ - paginate(value: boolean): void; - /** Returns the searchExpr option value. */ - searchExpr(): Object; - /** Sets the searchExpr option value. */ - searchExpr(expr: Object): void; - /** Returns the currently specified search operation. */ - searchOperation(): string; - /** Sets the current search operation. */ - searchOperation(op: string): void; - /** Returns the searchValue option value. */ - searchValue(): Object; - /** Sets the searchValue option value. */ - searchValue(value: Object): void; - /** Returns the current select option value. */ - select(): Object; - /** Sets the select option value. */ - select(expr: Object): void; - /** Returns the current requireTotalCount option value. */ - requireTotalCount(): boolean; - /** Sets the requireTotalCount option value. */ - requireTotalCount(value: boolean): void; - /** Returns the current sort option value. */ - sort(): Object; - /** Sets the sort option value. */ - sort(sortExpr: Object): void; - /** Returns the underlying Store instance. */ - store(): Store; - /** Returns the number of data items available in an underlying Store after the last load() operation without paging. */ - totalCount(): number; - cancel(operationId: number): boolean; - on(eventName: "loadingChanged", eventHandler: (isLoading: boolean) => void): DataSource; - on(eventName: "loadError", eventHandler: (e?: Error) => void): DataSource; - on(eventName: "changed", eventHandler: () => void): DataSource; - on(eventName: string, eventHandler: Function): DataSource; - on(events: { [eventName: string]: Function; }): DataSource; - off(eventName: "loadingChanged"): DataSource; - off(eventName: "loadError"): DataSource; - off(eventName: "changed"): DataSource; - off(eventName: string): DataSource; - off(eventName: "loadingChanged", eventHandler: (isLoading: boolean) => void): DataSource; - off(eventName: "loadError", eventHandler: (e?: Error) => void): DataSource; - off(eventName: "changed", eventHandler: () => void): DataSource; - off(eventName: string, eventHandler: Function): DataSource; - } - /** An object used to work with primitive data types not supported by JavaScript when accessing an OData web service. */ - export class EdmLiteral { - /** Creates an EdmLiteral instance and assigns the specified value to it. */ - constructor(value: string); - /** Returns a string representation of the value associated with this EdmLiteral object. */ - valueOf(): string; - } - /** An object used to generate and hold the GUID. */ - export class Guid { - /** Creates a new Guid instance that holds the specified GUID. */ - constructor(value: string); - /** Creates a new Guid instance holding the generated GUID. */ - constructor(); - /** Returns a string representation of the Guid instance. */ - toString(): string; - /** Returns a string representation of the Guid instance. */ - valueOf(): string; - } - export interface LocalStoreOptions extends ArrayStoreOptions { - /** Specifies the time (in miliseconds) after the change operation, before the data is flushed. */ - flushInterval?: number; - /** Specifies whether the data is flushed immediatelly after each change operation, or after the delay specified via the flushInterval option. */ - immediate?: boolean; - /** The unique identifier used to distinguish the data within the HTML5 Web Storage. */ - name?: string; - } - /** A Store providing access to the HTML5 Web Storage. */ - export class LocalStore extends ArrayStore { - constructor(options?: LocalStoreOptions); - /** Removes all data associated with this Store. */ - clear(): void; - } - export interface ODataContextOptions extends ODataStoreOptions { - /** Specifies the list of entities to be accessed via the ODataContext. */ - entities?: Object; - /** Specifies the function called if the ODataContext causes an error. */ - errorHandler?: (e: Error) => void; - } - /** Provides access to the entire OData service. */ - export class ODataContext { - constructor(options?: ODataContextOptions); - /** Initiates the specified WebGet service operation that returns a value. For the information on service operations, refer to the OData documentation. */ - get(operationName: string, params: Object): JQueryPromise; - /** Initiates the specified WebGet service operation that returns nothing. For the information on service operations, refer to the OData documentation. */ - invoke(operationName: string, params: Object, httpMethod: Object): JQueryPromise; - /** Return a special proxy object to describe the entity link. */ - objectLink(entityAlias: string, key: any): Object; - } - export interface ODataStoreOptions extends StoreOptions { - /** A function used to customize a web request before it is sent. */ - beforeSend?: (request: { - url: string; - async: boolean; - method: string; - timeout: number; - params: Object; - payload: Object; - headers: Object; - }) => void; - /** Specifies whether the ODataStore uses the JSONP approach to access non-CORS-compatible remote services. */ - jsonp?: boolean; - /** Specifies the type of the ODataStore key property. The following key types are supported out of the box: String, Int32, Int64, and Guid. */ - keyType?: any; - /** Specifies whether or not dates found in the response are deserialized. */ - deserializeDates?: boolean; - /** Specifies the URL of the data service being accessed via the current ODataContext. */ - url?: string; - /** Specifies the version of the OData protocol used to interact with the data service. */ - version?: number; - /** Specifies the value of the withCredentials field of the underlying jqXHR object. */ - withCredentials?: boolean; - } - /** A Store providing access to a separate OData web service entity. */ - export class ODataStore extends Store { - constructor(options?: ODataStoreOptions); - /** Creates the Query object for the OData endpoint. */ - createQuery(loadOptions: Object): Object; - /** Returns the data item specified by the key. */ - byKey(key: any, extraOptions?: { expand?: Object }): JQueryPromise; - } - /** An universal chainable data query interface object. */ - export interface Query { - /** Calculates a custom summary for the items in the current Query. */ - aggregate(step: (accumulator: any, value: any) => any): JQueryPromise; - /** Calculates a custom summary for the items in the current Query. */ - aggregate(seed: any, step: (accumulator: any, value: any) => any, finalize: (result: any) => any): JQueryPromise; - /** Calculates the average item value for the current Query. */ - avg(getter: Object): JQueryPromise; - /** Finds the item with the maximum getter value. */ - max(getter: Object): JQueryPromise; - /** Finds the item with the maximum value in the Query. */ - max(): JQueryPromise; - /** Finds the item with the minimum value in the Query. */ - min(): JQueryPromise; - /** Finds the item with the minimum getter value. */ - min(getter: Object): JQueryPromise; - /** Calculates the average item value for the current Query, if each Query item has a numeric type. */ - avg(): JQueryPromise; - /** Returns the total count of items in the current Query. */ - count(): JQueryPromise; - /** Executes the Query. */ - enumerate(): JQueryPromise; - /** Filters the current Query data. */ - filter(criteria: Array): Query; - /** Filters the current Query data. */ - filter(predicate: (item: any) => boolean): Query; - /** Groups the current Query data. */ - groupBy(getter: Object): Query; - /** Applies the specified transformation to each item. */ - select(getter: Object): Query; - /** Limits the data item count. */ - slice(skip: number, take?: number): Query; - /** Sorts current Query data. */ - sortBy(getter: Object, desc: boolean): Query; - /** Sorts current Query data. */ - sortBy(getter: Object): Query; - /** Calculates the sum of item getter values in the current Query. */ - sum(getter: Object): JQueryPromise; - /** Calculates the sum of item values in the current Query. */ - sum(): JQueryPromise; - /** Adds one more sorting condition to the current Query. */ - thenBy(getter: Object): Query; - /** Adds one more sorting condition to the current Query. */ - thenBy(getter: Object, desc: boolean): Query; - /** Returns the array of current Query items. */ - toArray(): Array; - } - /** The global data layer error handler. */ - export var errorHandler: (e: Error) => void; - /** Encodes the specified string or array of bytes to base64 encoding. */ - export function base64_encode(input: any): string; - /** Creates a Query instance. */ - export function query(array: Array): Query; - /** Creates a Query instance for accessing the remote service specified by a URL. */ - export function query(url: string, queryOptions: Object): Query; - /** This section describes the utility objects provided by the DevExtreme data layer. */ - export var utils: { - /** Compiles a getter function from the getter expression. */ - compileGetter(expr: any): Function; - /** Compiles a setter function from the setter expression. */ - compileSetter(expr: any): Function; - odata: { - /** Holds key value converters for OData. */ - keyConverters: { - String(value: any): string; - Int32(value: any): number; - Int64(value: any): EdmLiteral; - Guid(value: any): Guid; - Boolean(value: any): boolean; - Single(value: any): EdmLiteral; - Decimal(value: any): EdmLiteral; - }; - } - } - } - /** An object that serves as a namespace for DevExtreme UI widgets as well as for methods implementing UI logic in DevExtreme sites/applications. */ - export module ui { - export interface WidgetOptions extends DOMComponentOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A Boolean value specifying whether or not the widget can respond to user interaction. */ - disabled?: boolean; - /** A Boolean value specifying whether or not the widget changes its state when being hovered by an end user. */ - hoverStateEnabled?: boolean; - /** Specifies whether or not the widget can be focused. */ - focusStateEnabled?: boolean; - /** Specifies a shortcut key that sets focus on the widget element. */ - accessKey?: string; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - /** Specifies the widget tab index. */ - tabIndex?: number; - /** Specifies the text of the hint displayed for the widget. */ - hint?: string; - } - /** The base class for widgets. */ - export class Widget extends DOMComponent { - constructor(options?: WidgetOptions); - /** Redraws the widget. */ - repaint(): void; - /** Sets focus on the widget. */ - focus(): void; - /** Registers a handler when a specified key is pressed. */ - registerKeyHandler(key: string, handler: Function): void; - } - export interface CollectionWidgetOptions extends WidgetOptions { - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** The time period in milliseconds before the onItemHold event is raised. */ - itemHoldTimeout?: number; - /** An array of items displayed by the widget. */ - items?: Array; - /** The template to be used for rendering items. */ - itemTemplate?: any; - loopItemFocus?: boolean; - /** The text or HTML markup displayed by the widget if the item collection is empty. */ - noDataText?: string; - onContentReady?: any; - /** A handler for the itemClick event. */ - onItemClick?: any; - /** A handler for the itemContextMenu event. */ - onItemContextMenu?: Function; - /** A handler for the itemHold event. */ - onItemHold?: Function; - /** A handler for the itemRendered event. */ - onItemRendered?: Function; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: Function; - /** The index of the currently selected widget item. */ - selectedIndex?: number; - /** The selected item object. */ - selectedItem?: Object; - /** An array of currently selected item objects. */ - selectedItems?: Array; - /** A handler for the itemDeleting event. */ - onItemDeleting?: Function; - /** A handler for the itemDeleted event. */ - onItemDeleted?: Function; - /** A handler for the itemReordered event. */ - onItemReordered?: Function; - } - /** The base class for widgets containing an item collection. */ - export class CollectionWidget extends Widget { - constructor(element: JQuery, options?: CollectionWidgetOptions); - constructor(element: HTMLElement, options?: CollectionWidgetOptions); - selectItem(itemElement: any): void; - unselectItem(itemElement: any): void; - deleteItem(itemElement: any): JQueryPromise; - isItemSelected(itemElement: any): boolean; - reorderItem(itemElement: any, toItemElement: any): JQueryPromise; - } - export interface DataExpressionMixinOptions { - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** Specifies the name of the data source item field whose value is displayed by the widget. */ - displayExpr?: any; - /** Specifies the name of a data source item field whose value is held in the value configuration option. */ - valueExpr?: any; - /** An array of items displayed by the widget. */ - items?: Array; - /** The template to be used for rendering items. */ - itemTemplate?: any; - /** The currently selected value in the widget. */ - value?: Object; - } - export interface EditorOptions extends WidgetOptions { - /** The currently specified value. */ - value?: Object; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - /** A Boolean value specifying whether or not the widget is read-only. */ - readOnly?: boolean; - /** Holds the object that defines the error that occurred during validation. */ - validationError?: Object; - /** Specifies whether the editor's value is valid. */ - isValid?: boolean; - /** Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed. */ - validationMessageMode?: string; - } - /** A base class for editors. */ - export class Editor extends Widget { - /** Resets the editor's value to undefined. */ - reset(): void; - } - /** An object that serves as a namespace for methods displaying a message in an application/site. */ - export var dialog: { - /** Creates an alert dialog message containing a single "OK" button. */ - alert(message: string, title: string): JQueryPromise; - /** Creates a confirm dialog that contains "Yes" and "No" buttons. */ - confirm(message: string, title: string): JQueryPromise; - /** Creates a custom dialog using the options specified by the passed configuration object. */ - custom(options: { title?: string; message?: string; buttons?: Array; }): { - show(): JQueryPromise; - hide(): void; - hide(value: any): void; - }; - }; - /** Creates a toast message. */ - export function notify(message: any, type: string, displayTime: number): void; - /** Creates a toast message. */ - export function notify(options: Object): void; - /** An object that serves as a namespace for the methods that work with DevExtreme CSS Themes. */ - export var themes: { - /** Returns the name of the currently applied theme. */ - current(): string; - /** Changes the current theme to the specified one. */ - current(themeName: string): void; - }; - /** Sets a specified template engine. */ - export function setTemplateEngine(name: string): void; - /** Sets a custom template engine defined via custom compile and render functions. */ - export function setTemplateEngine(options: Object): void; - } - /** An object that serves as a namespace for utility methods that can be helpful when working with the DevExtreme framework and UI widgets. */ - export var utils: { - /** Sets parameters for the viewport meta tag. */ - initMobileViewport(options: { allowZoom?: boolean; allowPan?: boolean; allowSelection?: boolean }): void; - /** Requests that the browser call a specified function to update animation before the next repaint. */ - requestAnimationFrame(callback: Function): number; - /** Cancels an animation frame request scheduled with the requestAnimationFrame method. */ - cancelAnimationFrame(requestID: number): void; - }; - /** An object that serves as a namespace for DevExtreme Data Visualization Widgets. */ - export module viz { - /** Applies a theme for the entire page with several DevExtreme visualization widgets. */ - export function currentTheme(theme: string): void; - /** Applies a new theme (with the color scheme defined separately) for the entire page with several DevExtreme visualization widgets. */ - export function currentTheme(platform: string, colorScheme: string): void; - /** Registers a new theme based on the existing one. */ - export function registerTheme(customTheme: Object, baseTheme: string): void; - /** Applies a predefined or registered custom palette to all visualization widgets at once. */ - export function currentPalette(paletteName: string): void; - /** Obtains the color sets of a predefined or registered palette. */ - export function getPalette(paletteName: string): Object; - /** Registers a new palette. */ - export function registerPalette(paletteName: string, palette: Object): void; - } -} -declare module DevExpress.ui { - export interface dxValidatorOptions extends DOMComponentOptions { - /** An array of validation rules to be checked for the editor with which the dxValidator object is associated. */ - validationRules?: Array; - /** Specifies the editor name to be used in the validation default messages. */ - name?: string; - /** An object that specifies what and when to validate and how to apply the validation result. */ - adapter?: Object; - /** Specifies the validation group the editor will be related to. */ - validationGroup?: string; - /** A handler for the validated event. */ - onValidated?: (params: validationEngine.ValidatorValidationResult) => void; - } - /** A widget that is used to validate the associated DevExtreme editors against the defined validation rules. */ - export class dxValidator extends DOMComponent implements validationEngine.IValidator { - constructor(element: JQuery, options?: dxValidatorOptions); - constructor(element: Element, options?: dxValidatorOptions); - /** Validates the value of the editor that is controlled by the current dxValidator object against the list of the specified validation rules. */ - validate(): validationEngine.ValidatorValidationResult; - /** Resets the value and validation result of the editor associated with the current dxValidator object. */ - reset(): void; - } - /** The widget that is used in the Knockout and Angular approaches to combine the editors to be validated. */ - export class dxValidationGroup extends DOMComponent { - constructor(element: JQuery); - constructor(element: Element); - /** Validates rules of the validators that belong to the current validation group. */ - validate(): validationEngine.ValidationGroupValidationResult; - /** Resets the value and validation result of the editors that are included to the current validation group. */ - reset(): void; - } - export interface dxValidationSummaryOptions extends CollectionWidgetOptions { - /** Specifies the validation group for which summary should be generated. */ - validationGroup?: string; - } - /** A widget for displaying the result of checking validation rules for editors. */ - export class dxValidationSummary extends CollectionWidget { - constructor(element: JQuery, options?: dxValidationSummaryOptions); - constructor(element: Element, options?: dxValidationSummaryOptions); - } - export interface dxResizableOptions extends DOMComponentOptions { - /** Specifies which borders of the widget element are used as a handle. */ - handles?: string; - /** Specifies the lower width boundary for resizing. */ - minWidth?: number; - /** Specifies the upper width boundary for resizing. */ - maxWidth?: number; - /** Specifies the lower height boundary for resizing. */ - minHeight?: number; - /** Specifies the upper height boundary for resizing. */ - maxHeight?: number; - /** A handler for the resizeStart event. */ - onResizeStart?: Function; - /** A handler for the resize event. */ - onResize?: Function; - /** A handler for the resizeEnd event. */ - onResizeEnd?: Function; - } - /** A widget that displays required content in a resizable element. */ - export class dxResizable extends DOMComponent { - constructor(element: JQuery, options?: dxResizableOptions); - constructor(element: Element, options?: dxResizableOptions); - } - export interface dxTooltipOptions extends dxPopoverOptions { - } - /** A tooltip widget. */ - export class dxTooltip extends dxPopover { - constructor(element: JQuery, options?: dxTooltipOptions); - constructor(element: Element, options?: dxTooltipOptions); - } - export interface dxDropDownListOptions extends dxDropDownEditorOptions, DataExpressionMixinOptions { - /** Returns the value currently displayed by the widget. */ - displayValue?: string; - /** The minimum number of characters that must be entered into the text box to begin a search. */ - minSearchLength?: number; - /** Specifies whether or not the widget displays unfiltered values until a user types a number of characters exceeding the minSearchLength option value. */ - showDataBeforeSearch?: boolean; - /** Specifies the name of a data source item field or an expression whose value is compared to the search criterion. */ - searchExpr?: Object; - /** Specifies the binary operation used to filter data. */ - searchMode?: string; - /** Specifies the time delay, in milliseconds, after the last character has been typed in, before a search is executed. */ - searchTimeout?: number; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - /** Specifies DOM event names that update a widget's value. */ - valueChangeEvent?: string; - /** Specifies whether or not the widget supports searching. */ - searchEnabled?: boolean; - /** - * Specifies whether or not the widget displays items by pages. - * @deprecated dataSource.paginate.md - */ - pagingEnabled?: boolean; - /** The text or HTML markup displayed by the widget if the item collection is empty. */ - noDataText?: string; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: Function; - /** A handler for the itemClick event. */ - onItemClick?: Function; - onContentReady?: Function; - } - /** A base class for drop-down list widgets. */ - export class dxDropDownList extends dxDropDownEditor { - constructor(element: JQuery, options?: dxDropDownListOptions); - constructor(element: Element, options?: dxDropDownListOptions); - } - export interface dxToolbarOptions extends CollectionWidgetOptions { - /** The template used to render menu items. */ - menuItemTemplate?: any; - /** Informs the widget about its location in a view HTML markup. */ - renderAs?: string; - } - /** A toolbar widget. */ - export class dxToolbar extends CollectionWidget { - constructor(element: JQuery, options?: dxToolbarOptions); - constructor(element: Element, options?: dxToolbarOptions); - } - export interface dxToastOptions extends dxOverlayOptions { - animation?: fx.AnimationOptions; - /** The time span in milliseconds during which the dxToast widget is visible. */ - displayTime?: number; - height?: any; - /** The dxToast message text. */ - message?: string; - position?: PositionOptions; - shading?: boolean; - /** Specifies the dxToast widget type. */ - type?: string; - width?: any; - closeOnBackButton?: boolean; - /** A Boolean value specifying whether or not the toast is closed if a user swipes it out of the screen boundaries. */ - closeOnSwipe?: boolean; - /** A Boolean value specifying whether or not the toast is closed if a user clicks it. */ - closeOnClick?: boolean; - } - /** The toast message widget. */ - export class dxToast extends dxOverlay { - constructor(element: JQuery, options?: dxToastOptions); - constructor(element: Element, options?: dxToastOptions); - } - export interface dxTextEditorOptions extends EditorOptions { - /** A handler for the change event. */ - onChange?: Function; - /** A handler for the copy event. */ - onCopy?: Function; - /** A handler for the cut event. */ - onCut?: Function; - /** A handler for the enterKey event. */ - onEnterKey?: Function; - /** A handler for the focusIn event. */ - onFocusIn?: Function; - /** A handler for the focusOut event. */ - onFocusOut?: Function; - /** A handler for the input event. */ - onInput?: Function; - /** A handler for the keyDown event. */ - onKeyDown?: Function; - /** A handler for the keyPress event. */ - onKeyPress?: Function; - /** A handler for the keyUp event. */ - onKeyUp?: Function; - /** A handler for the paste event. */ - onPaste?: Function; - /** The text displayed by the widget when the widget value is empty. */ - placeholder?: string; - /** Specifies whether to display the Clear button in the widget. */ - showClearButton?: boolean; - /** Specifies the current value displayed by the widget. */ - value?: any; - /** Specifies DOM event names that update a widget's value. */ - valueChangeEvent?: string; - /** Specifies whether or not the widget checks the inner text for spelling mistakes. */ - spellcheck?: boolean; - /** Specifies HTML attributes applied to the inner input element of the widget. */ - attr?: Object; - /** The read-only option that holds the text displayed by the widget input element. */ - text?: string; - focusStateEnabled?: boolean; - hoverStateEnabled?: boolean; - /** The editor mask that specifies the format of the entered string. */ - mask?: string; - /** Specifies a mask placeholder character. */ - maskChar?: string; - /** Specifies custom mask rules. */ - maskRules?: Object; - /** A message displayed when the entered text does not match the specified pattern. */ - maskInvalidMessage?: string; - /** Specifies whether the value option holds only characters entered by a user or prompt characters as well. */ - useMaskedValue?: boolean; - } - /** A base class for text editing widgets. */ - export class dxTextEditor extends Editor { - constructor(element: JQuery, options?: dxTextEditorOptions); - constructor(element: Element, options?: dxTextEditorOptions); - /** Removes focus from the input element. */ - blur(): void; - /** Sets focus to the input element representing the widget. */ - focus(): void; - } - export interface dxTextBoxOptions extends dxTextEditorOptions { - /** Specifies the maximum number of characters you can enter into the textbox. */ - maxLength?: any; - /** The "mode" attribute value of the actual HTML input element representing the text box. */ - mode?: string; - } - /** A single-line text box widget. */ - export class dxTextBox extends dxTextEditor { - constructor(element: JQuery, options?: dxTextBoxOptions); - constructor(element: Element, options?: dxTextBoxOptions); - } - export interface dxTextAreaOptions extends dxTextBoxOptions { - /** Specifies whether or not the widget checks the inner text for spelling mistakes. */ - spellcheck?: boolean; - } - /** A widget used to display and edit multi-line text. */ - export class dxTextArea extends dxTextBox { - constructor(element: JQuery, options?: dxTextAreaOptions); - constructor(element: Element, options?: dxTextAreaOptions); - } - export interface dxTabsOptions extends CollectionWidgetOptions { - /** Specifies whether the widget enables an end-user to select only a single item or multiple items. */ - selectionMode?: string; - /** Specifies whether or not an end-user can scroll tabs by swiping. */ - scrollByContent?: boolean; - /** Specifies whether or not an end-user can scroll tabs. */ - scrollingEnabled?: boolean; - /** A Boolean value that specifies the availability of navigation buttons. */ - showNavButtons?: boolean; - } - /** A tab strip used to switch between pages. */ - export class dxTabs extends CollectionWidget { - constructor(element: JQuery, options?: dxTabsOptions); - constructor(element: Element, options?: dxTabsOptions); - } - export interface dxTabPanelOptions extends dxMultiViewOptions { - /** A handler for the titleClick event. */ - onTitleClick?: any; - /** A handler for the titleHold event. */ - onTitleHold?: Function; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - /** The template to be used for rendering an item title. */ - itemTitleTemplate?: any; - /** A Boolean value specifying if the list is scrolled by content. */ - scrollByContent?: boolean; - /** A Boolean value specifying whether to enable or disable scrolling. */ - scrollingEnabled?: boolean; - /** A Boolean value that specifies the availability of navigation buttons. */ - showNavButtons?: boolean; - } - /** A widget used to display a view and to switch between several views by clicking the appropriate tabs. */ - export class dxTabPanel extends dxMultiView { - constructor(element: JQuery, options?: dxTabPanelOptions); - constructor(element: Element, options?: dxTabPanelOptions); - } - export interface dxSelectBoxOptions extends dxDropDownListOptions { - /** Specifies DOM event names that update a widget's value. */ - valueChangeEvent?: string; - /** The template to be used for rendering the widget text field. */ - fieldTemplate?: any; - /** The text that is provided as a hint in the select box editor. */ - placeholder?: string; - /** Specifies whether or not the widget allows an end-user to enter a custom value. */ - fieldEditEnabled?: boolean; - } - /** A widget that allows you to select an item in a dropdown list. */ - export class dxSelectBox extends dxDropDownList { - constructor(element: JQuery, options?: dxSelectBoxOptions); - constructor(element: Element, options?: dxSelectBoxOptions); - } - export interface dxTagBoxOptions extends dxSelectBoxOptions { - /** Holds the list of selected values. */ - values?: Array; - /** A read-only option that holds the last selected value. */ - value?: Object; - } - /** A widget that allows you to select multiple items from a dropdown list. */ - export class dxTagBox extends dxSelectBox { - constructor(element: JQuery, options?: dxTagBoxOptions); - constructor(element: Element, options?: dxTagBoxOptions); - } - export interface dxScrollViewOptions extends dxScrollableOptions { - /** A handler for the pullDown event. */ - onPullDown?: Function; - /** Specifies the text shown in the pullDown panel when pulling the content down lowers the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while pulling the content down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the reachBottom event. */ - onReachBottom?: Function; - /** Specifies the text shown in the pullDown panel displayed when content is scrolled to the bottom. */ - reachBottomText?: string; - /** Specifies the text shown in the pullDown panel displayed when the content is being refreshed. */ - refreshingText?: string; - /** Returns a value indicating if the scrollView content is larger then the widget container. */ - isFull(): boolean; - /** Locks the widget until the release(preventScrollBottom) method is called and executes the function passed to the onPullDown option and the handler assigned to the pullDown event. */ - refresh(): void; - /** Notifies the scroll view that data loading is finished. */ - release(preventScrollBottom: boolean): JQueryPromise; - /** Toggles the loading state of the widget. */ - toggleLoading(showOrHide: boolean): void; - } - /** A widget used to display scrollable content. */ - export class dxScrollView extends dxScrollable { - constructor(element: JQuery, options?: dxScrollViewOptions); - constructor(element: Element, options?: dxScrollViewOptions); - } - export interface dxScrollableLocation { - top?: number; - left?: number; - } - export interface dxScrollableOptions extends DOMComponentOptions { - /** A string value specifying the available scrolling directions. */ - direction?: string; - /** A Boolean value specifying whether or not the widget can respond to user interaction. */ - disabled?: boolean; - /** A handler for the scroll event. */ - onScroll?: Function; - /** Specifies when the widget shows the scrollbar. */ - showScrollbar?: string; - /** A handler for the update event. */ - onUpdated?: Function; - /** Indicates whether to use native or simulated scrolling. */ - useNative?: boolean; - /** A Boolean value specifying whether to enable or disable the bounce-back effect. */ - bounceEnabled?: boolean; - /** A Boolean value specifying whether or not an end-user can scroll the widget content swiping it up or down. */ - scrollByContent?: boolean; - /** A Boolean value specifying whether or not an end-user can scroll the widget content using the scrollbar. */ - scrollByThumb?: boolean; - } - /** A widget used to display scrollable content. */ - export class dxScrollable extends DOMComponent { - constructor(element: JQuery, options?: dxScrollableOptions); - constructor(element: Element, options?: dxScrollableOptions); - /** Returns the height of the scrollable widget in pixels. */ - clientHeight(): number; - /** Returns the width of the scrollable widget in pixels. */ - clientWidth(): number; - /** Returns an HTML element of the widget. */ - content(): JQuery; - /** Scrolls the widget content by the specified number of pixels. */ - scrollBy(distance: number): void; - /** Scrolls widget content by the specified number of pixels in horizontal and vertical directions. */ - scrollBy(distanceObject: dxScrollableLocation): void; - /** Returns the height of the scrollable content in pixels. */ - scrollHeight(): number; - /** Returns the current scroll position against the leftmost position. */ - scrollLeft(): number; - /** Returns how far the scrollable content is scrolled from the top and from the left. */ - scrollOffset(): dxScrollableLocation; - /** Scrolls widget content to the specified position. */ - scrollTo(targetLocation: number): void; - /** Scrolls widget content to a specified position. */ - scrollTo(targetLocation: dxScrollableLocation): void; - /** Scrolls widget content to the specified element. */ - scrollToElement(element: Element): void; - /** Returns the current scroll position against the topmost position. */ - scrollTop(): number; - /** Returns the width of the scrollable content in pixels. */ - scrollWidth(): number; - /** Updates the dimensions of the scrollable contents. */ - update(): void; - } - export interface dxRadioGroupOptions extends EditorOptions, DataExpressionMixinOptions { - activeStateEnabled?: boolean; - /** Specifies the radio group layout. */ - layout?: string; - } - /** A widget that enables a user to select one item within a list of items represented by radio buttons. */ - export class dxRadioGroup extends CollectionWidget { - constructor(element: JQuery, options?: dxRadioGroupOptions); - constructor(element: Element, options?: dxRadioGroupOptions); - } - export interface dxPopupOptions extends dxOverlayOptions { - animation?: fx.AnimationOptions; - /** Specifies whether or not to allow a user to drag the popup window. */ - dragEnabled?: boolean; - /** A Boolean value specifying whether or not to display the widget in full-screen mode. */ - fullScreen?: boolean; - position?: PositionOptions; - /** A Boolean value specifying whether or not to display the title in the popup window. */ - showTitle?: boolean; - /** The title in the overlay window. */ - title?: string; - /** A template to be used for rendering the widget title. */ - titleTemplate?: any; - width?: any; - /** Specifies items displayed on the top or bottom toolbar of the popup window. */ - buttons?: Array; - /** Specifies whether or not the widget displays the Close button. */ - showCloseButton?: boolean; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - } - /** A widget that displays required content in a popup window. */ - export class dxPopup extends dxOverlay { - constructor(element: JQuery, options?: dxPopupOptions); - constructor(element: Element, options?: dxPopupOptions); - } - export interface dxPopoverOptions extends dxPopupOptions { - /** An object defining animation options of the widget. */ - animation?: fx.AnimationOptions; - /** Specifies the height of the widget. */ - height?: any; - /** An object defining widget positioning options. */ - position?: PositionOptions; - shading?: boolean; - /** A Boolean value specifying whether or not to display the title in the overlay window. */ - showTitle?: boolean; - /** The target element associated with a popover. */ - target?: any; - /** Specifies the width of the widget. */ - width?: any; - } - /** A widget that displays the required content in a popup window. */ - export class dxPopover extends dxPopup { - constructor(element: JQuery, options?: dxPopoverOptions); - constructor(element: Element, options?: dxPopoverOptions); - /** Displays the widget for the specified target element. */ - show(target?: any): JQueryPromise; - } - export interface dxOverlayOptions extends WidgetOptions { - /** An object that defines the animation options of the widget. */ - animation?: fx.AnimationOptions; - /** A Boolean value specifying whether or not the widget is closed if a user presses the Back hardware button. */ - closeOnBackButton?: boolean; - /** A Boolean value specifying whether or not the widget is closed if a user clicks outside of the overlapping window. */ - closeOnOutsideClick?: any; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - /** Specifies whether or not an end-user can drag the widget. */ - dragEnabled?: boolean; - /** Specifies whether or not an end user can resize the widget. */ - resizeEnabled?: boolean; - /** The height of the widget in pixels. */ - height?: any; - /** Specifies the maximum height the widget can reach while resizing. */ - maxHeight?: any; - /** Specifies the maximum width the widget can reach while resizing. */ - maxWidth?: any; - /** Specifies the minimum height the widget can reach while resizing. */ - minHeight?: any; - /** Specifies the minimum width the widget can reach while resizing. */ - minWidth?: any; - /** A handler for the hidden event. */ - onHidden?: Function; - /** A handler for the resizeStart event. */ - onResizeStart?: Function; - /** A handler for the resize event. */ - onResize?: Function; - /** A handler for the resizeEnd event. */ - onResizeEnd?: Function; - /** A handler for the hiding event. */ - onHiding?: Function; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** A Boolean value specifying whether or not the main screen is inactive while the widget is active. */ - shading?: boolean; - /** Specifies the shading color. */ - shadingColor?: string; - /** A handler for the showing event. */ - onShowing?: Function; - /** A handler for the shown event. */ - onShown?: Function; - onContentReady?: Function; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - /** The widget width in pixels. */ - width?: any; - } - /** A widget displaying the required content in an overlay window. */ - export class dxOverlay extends Widget { - constructor(element: JQuery, options?: dxOverlayOptions); - constructor(element: Element, options?: dxOverlayOptions); - /** An HTML element of the widget. */ - content(): JQuery; - /** Hides the widget. */ - hide(): JQueryPromise; - /** Recalculates the overlay's size and position. */ - repaint(): void; - /** Shows the widget. */ - show(): JQueryPromise; - /** Toggles the visibility of the widget. */ - toggle(showing: boolean): JQueryPromise; - /** A static method that specifies the base z-index for all overlay widgets. */ - static baseZIndex(zIndex: number): void; - } - export interface dxNumberBoxOptions extends dxTextEditorOptions { - /** The maximum value accepted by the number box. */ - max?: number; - /** The minimum value accepted by the number box. */ - min?: number; - /** Specifies whether or not to show spin buttons. */ - showSpinButtons?: boolean; - useTouchSpinButtons?: boolean; - /** Specifies by which value the widget value changes when a spin button is clicked. */ - step?: number; - /** The current number box value. */ - value?: number; - /** The "mode" attribute value of the actual HTML input element representing the widget. */ - mode?: string; - } - /** A textbox widget that enables a user to enter numeric values. */ - export class dxNumberBox extends dxTextEditor { - constructor(element: JQuery, options?: dxNumberBoxOptions); - constructor(element: Element, options?: dxNumberBoxOptions); - } - export interface dxNavBarOptions extends dxTabsOptions { - scrollingEnabled?: boolean; - } - /** A widget that contains items used to navigate through application views. */ - export class dxNavBar extends dxTabs { - constructor(element: JQuery, options?: dxNavBarOptions); - constructor(element: Element, options?: dxNavBarOptions); - } - export interface dxMultiViewOptions extends CollectionWidgetOptions { - /** Specifies whether or not to animate the displayed item change. */ - animationEnabled?: boolean; - /** A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped. */ - loop?: boolean; - /** The index of the currently displayed item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to allow users to change the selected index by swiping. */ - swipeEnabled?: boolean; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - } - /** A widget used to display a view and to switch between several views. */ - export class dxMultiView extends CollectionWidget { - constructor(element: JQuery, options?: dxMultiViewOptions); - constructor(element: Element, options?: dxMultiViewOptions); - } - export interface dxMapOptions extends WidgetOptions { - /** Specifies whether or not the widget automatically adjusts center and zoom option values when adding a new marker or route, or when creating a widget if it initially contains markers or routes. */ - autoAdjust?: boolean; - center?: { - /** The latitude location displayed in the center of the widget. */ - lat?: number; - /** The longitude location displayed in the center of the widget. */ - lng?: number; - }; - /** A handler for the click event. */ - onClick?: any; - /** Specifies whether or not map widget controls are available. */ - controls?: boolean; - /** Specifies the height of the widget. */ - height?: any; - /** A key used to authenticate the application within the required map provider. */ - key?: { - /** A key used to authenticate the application within the "Bing" map provider. */ - bing?: string; - /** A key used to authenticate the application within the "Google" map provider. */ - google?: string; - /** A key used to authenticate the application within the "Google Static" map provider. */ - googleStatic?: string; - } - /** A handler for the markerAdded event. */ - onMarkerAdded?: Function; - /** A URL pointing to the custom icon to be used for map markers. */ - markerIconSrc?: string; - /** A handler for the markerRemoved event. */ - onMarkerRemoved?: Function; - /** An array of markers displayed on a map. */ - markers?: Array; - /** The name of the current map data provider. */ - provider?: string; - /** A handler for the ready event. */ - onReady?: Function; - /** A handler for the routeAdded event. */ - onRouteAdded?: Function; - /** A handler for the routeRemoved event. */ - onRouteRemoved?: Function; - /** An array of routes shown on the map. */ - routes?: Array; - /** The type of a map to display. */ - type?: string; - /** Specifies the width of the widget. */ - width?: any; - /** The zoom level of the map. */ - zoom?: number; - } - /** An interactive map widget. */ - export class dxMap extends Widget { - constructor(element: JQuery, options?: dxMapOptions); - constructor(element: Element, options?: dxMapOptions); - /** Adds a marker to the map. */ - addMarker(markerOptions: Object): JQueryPromise; - /** Adds a route to the map. */ - addRoute(routeOptions: Object): JQueryPromise; - /** Removes a marker from the map. */ - removeMarker(marker: Object): JQueryPromise; - /** Removes a route from the map. */ - removeRoute(route: any): JQueryPromise; - } - export interface dxLookupOptions extends dxDropDownListOptions { - /** An object defining widget animation options. */ - animation?: fx.AnimationOptions; - /** The text displayed on the Cancel button. */ - cancelButtonText?: string; - /** The text displayed on the Clear button. */ - clearButtonText?: string; - /** Specifies whether or not the widget cleans the search box when the popup window is displayed. */ - cleanSearchOnOpening?: boolean; - /** A Boolean value specifying whether or not a widget is closed if a user clicks outside of the overlaying window. */ - closeOnOutsideClick?: any; - /** The text displayed on the Apply button. */ - applyButtonText?: string; - /** A Boolean value specifying whether or not to display the lookup in full-screen mode. */ - fullScreen?: boolean; - focusStateEnabled?: boolean; - /** A Boolean value specifying whether or not to group widget items. */ - grouped?: boolean; - /** The name of the template used to display a group header. */ - groupTemplate?: any; - /** The text displayed on the button used to load the next page from the data source. */ - nextButtonText?: string; - /** A handler for the pageLoading event. */ - onPageLoading?: Function; - /** Specifies whether the next page is loaded when a user scrolls the widget to the bottom or when the "next" button is clicked. */ - pageLoadMode?: string; - /** Specifies the text shown in the pullDown panel, which is displayed when the widget is scrolled to the bottom. */ - pageLoadingText?: string; - /** The text displayed by the widget when nothing is selected. */ - placeholder?: string; - /** The height of the widget popup element. */ - popupHeight?: any; - /** The width of the widget popup element. */ - popupWidth?: any; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** Specifies the text displayed in the pullDown panel when the widget is pulled below the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the pullRefresh event. */ - onPullRefresh?: Function; - /** A Boolean value specifying whether or not the widget supports the "pull down to refresh" gesture. */ - pullRefreshEnabled?: boolean; - /** Specifies the text displayed in the pullDown panel while the widget is being refreshed. */ - refreshingText?: string; - /** A handler for the scroll event. */ - onScroll?: Function; - /** A Boolean value specifying whether or not the search bar is visible. */ - searchEnabled?: boolean; - /** The text that is provided as a hint in the lookup's search bar. */ - searchPlaceholder?: string; - /** A Boolean value specifying whether or not the main screen is inactive while the lookup is active. */ - shading?: boolean; - /** Specifies whether to display the Cancel button in the lookup window. */ - showCancelButton?: boolean; - /** - * A Boolean value specifying whether the widget loads the next page automatically when you reach the bottom of the list or when a button is clicked. - * @deprecated pageLoadMode.md - */ - showNextButton?: boolean; - /** The title of the lookup window. */ - title?: string; - /** A template to be used for rendering the widget title. */ - titleTemplate?: any; - /** Specifies whether or not the widget uses native scrolling. */ - useNativeScrolling?: boolean; - /** Specifies whether or not to show lookup contents in a dxPopover widget. */ - usePopover?: boolean; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - /** A Boolean value specifying whether or not to display the title in the popup window. */ - showPopupTitle?: boolean; - /** The template to be used for rendering the widget text field. */ - fieldTemplate?: any; - } - /** A widget that allows a user to select predefined values from a lookup window. */ - export class dxLookup extends dxDropDownList { - constructor(element: JQuery, options?: dxLookupOptions); - constructor(element: Element, options?: dxLookupOptions); - /** This section lists the data source fields that are used in a default template for lookup drop-down items. */ - } - export interface dxLoadPanelOptions extends dxOverlayOptions { - /** An object defining the animation options of the widget. */ - animation?: fx.AnimationOptions; - /** The delay in milliseconds after which the load panel is displayed. */ - delay?: number; - /** The height of the widget. */ - height?: number; - /** A URL pointing to an image to be used as a load indicator. */ - indicatorSrc?: string; - /** The text displayed in the load panel. */ - message?: string; - /** A Boolean value specifying whether or not to show a load indicator. */ - showIndicator?: boolean; - /** A Boolean value specifying whether or not to show the pane behind the load indicator. */ - showPane?: boolean; - /** The width of the widget. */ - width?: number; - } - /** A widget used to indicate whether or not an element is loading. */ - export class dxLoadPanel extends dxOverlay { - constructor(element: JQuery, options?: dxLoadPanelOptions); - constructor(element: Element, options?: dxLoadPanelOptions); - } - export interface dxLoadIndicatorOptions extends WidgetOptions { - /** Specifies the path to an image used as the indicator. */ - indicatorSrc?: string; - } - /** The widget used to indicate the loading process. */ - export class dxLoadIndicator extends Widget { - constructor(element: JQuery, options?: dxLoadIndicatorOptions); - constructor(element: Element, options?: dxLoadIndicatorOptions); - } - export interface dxListOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not to display a grouped list. */ - grouped?: boolean; - /** The template to be used for rendering item groups. */ - groupTemplate?: any; - onItemDeleting?: Function; - /** A handler for the itemDeleted event. */ - onItemDeleted?: Function; - /** A handler for the groupRendered event. */ - onGroupRendered?: Function; - /** A handler for the itemReordered event. */ - onItemReordered?: Function; - /** A handler for the itemClick event. */ - onItemClick?: any; - /** A handler for the itemSwipe event. */ - onItemSwipe?: Function; - /** The text displayed on the button used to load the next page from the data source. */ - nextButtonText?: string; - /** A handler for the pageLoading event. */ - onPageLoading?: Function; - /** Specifies the text shown in the pullDown panel, which is displayed when the list is scrolled to the bottom. */ - pageLoadingText?: string; - /** Specifies the text displayed in the pullDown panel when the list is pulled below the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the pullRefresh event. */ - onPullRefresh?: Function; - /** A Boolean value specifying whether or not the widget supports the "pull down to refresh" gesture. */ - pullRefreshEnabled?: boolean; - /** Specifies the text displayed in the pullDown panel while the list is being refreshed. */ - refreshingText?: string; - /** A handler for the scroll event. */ - onScroll?: Function; - /** A Boolean value specifying whether to enable or disable list scrolling. */ - scrollingEnabled?: boolean; - /** Specifies when the widget shows the scrollbar. */ - showScrollbar?: string; - /** Specifies whether or not the widget uses native scrolling. */ - useNativeScrolling?: boolean; - /** A Boolean value specifying whether to enable or disable the bounce-back effect. */ - bounceEnabled?: boolean; - /** A Boolean value specifying if the list is scrolled by content. */ - scrollByContent?: boolean; - /** A Boolean value specifying if the list is scrolled using the scrollbar. */ - scrollByThumb?: boolean; - onItemContextMenu?: Function; - onItemHold?: Function; - /** Specifies whether or not an end-user can collapse groups. */ - collapsibleGroups?: boolean; - /** Specifies whether the next page is loaded when a user scrolls the widget to the bottom or when the "next" button is clicked. */ - pageLoadMode?: string; - /** Specifies whether or not to display controls used to select list items. */ - showSelectionControls?: boolean; - /** Specifies item selection mode. */ - selectionMode?: string; - selectAllText?: string; - onSelectAllChanged?: Function; - /** Specifies the array of items for a context menu called for a list item. */ - menuItems?: Array; - /** Specifies whether an item context menu is shown when a user holds or swipes an item. */ - menuMode?: string; - /** Specifies whether or not an end user can delete list items. */ - allowItemDeleting?: boolean; - /** Specifies the way a user can delete items from the list. */ - itemDeleteMode?: string; - /** Specifies whether or not an end user can reorder list items. */ - allowItemReordering?: boolean; - /** Specifies whether or not to show the loading panel when the DataSource bound to the widget is loading data. */ - indicateLoading?: boolean; - activeStateEnabled?: boolean; - } - /** A list widget. */ - export class dxList extends CollectionWidget { - constructor(element: JQuery, options?: dxListOptions); - constructor(element: Element, options?: dxListOptions); - /** Returns the height of the widget in pixels. */ - clientHeight(): number; - /** Removes the specified item from the list. */ - deleteItem(itemIndex: any): JQueryPromise; - /** Removes the specified item from the list. */ - deleteItem(itemElement: Element): JQueryPromise; - /** Returns a Boolean value that indicates whether or not the specified item is selected. */ - isItemSelected(itemIndex: any): boolean; - /** Returns a Boolean value that indicates whether or not the specified item is selected. */ - isItemSelected(itemElement: Element): boolean; - /** Reloads list data. */ - reload(): void; - /** Moves the specified item to the specified position in the list. */ - reorderItem(itemElement: Element, toItemElement: Element): JQueryPromise; - /** Moves the specified item to the specified position in the list. */ - reorderItem(itemIndex: any, toItemIndex: any): JQueryPromise; - /** Scrolls the list content by the specified number of pixels. */ - scrollBy(distance: number): void; - /** Returns the height of the list content in pixels. */ - scrollHeight(): number; - /** Scrolls list content to the specified position. */ - scrollTo(location: number): void; - /** Scrolls the list to the specified item. */ - scrollToItem(itemElement: Element): void; - /** Scrolls the list to the specified item. */ - scrollToItem(itemIndex: any): void; - /** Returns how far the list content is scrolled from the top. */ - scrollTop(): number; - /** Selects the specified item from the list. */ - selectItem(itemElement: Element): void; - /** Selects the specified item from the list. */ - selectItem(itemIndex: any): void; - /** Deselects the specified item from the list. */ - unselectItem(itemElement: Element): void; - /** Unselects the specified item from the list. */ - unselectItem(itemIndex: any): void; - /** Updates the widget scrollbar according to widget content size. */ - updateDimensions(): JQueryPromise; - /** Expands the specified group. */ - expandGroup(groupIndex: number): JQueryPromise; - /** Collapses the specified group. */ - collapseGroup(groupIndex: number): JQueryPromise; - } - export interface dxGalleryOptions extends CollectionWidgetOptions { - /** The time, in milliseconds, spent on slide animation. */ - animationDuration?: number; - /** Specifies whether or not to animate the displayed item change. */ - animationEnabled?: boolean; - /** A Boolean value specifying whether or not to allow users to switch between items by clicking an indicator. */ - indicatorEnabled?: boolean; - /** A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped. */ - loop?: boolean; - /** The index of the currently active gallery item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to display an indicator that points to the selected gallery item. */ - showIndicator?: boolean; - /** A Boolean value that specifies the availability of the "Forward" and "Back" navigation buttons. */ - showNavButtons?: boolean; - /** The time interval in milliseconds, after which the gallery switches to the next item. */ - slideshowDelay?: number; - /** A Boolean value specifying whether or not to allow users to switch between items by swiping. */ - swipeEnabled?: boolean; - /** Specifies whether or not to display parts of previous and next images along the sides of the current image. */ - wrapAround?: boolean; - /** Specifies if the widget stretches images to fit the total gallery width. */ - stretchImages?: boolean; - /** Specifies the width of an area used to display a single image. */ - initialItemWidth?: number; - } - /** An image gallery widget. */ - export class dxGallery extends CollectionWidget { - constructor(element: JQuery, options?: dxGalleryOptions); - constructor(element: Element, options?: dxGalleryOptions); - /** Shows the specified gallery item. */ - goToItem(itemIndex: number, animation: boolean): JQueryPromise; - /** Shows the next gallery item. */ - nextItem(animation: boolean): JQueryPromise; - /** Shows the previous gallery item. */ - prevItem(animation: boolean): JQueryPromise; - } - export interface dxDropDownEditorOptions extends dxTextBoxOptions { - /** Specifies the current value displayed by the widget. */ - value?: Object; - /** A handler for the closed event. */ - onClosed?: Function; - /** A handler for the opened event. */ - onOpened?: Function; - /** Specifies whether or not the drop-down editor is displayed. */ - opened?: boolean; - /** Specifies whether or not the widget allows an end-user to enter a custom value. */ - fieldEditEnabled?: boolean; - /** Specifies the way an end-user applies the selected value. */ - applyValueMode?: string; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - activeStateEnabled?: boolean; - } - /** A drop-down editor widget. */ - export class dxDropDownEditor extends dxTextBox { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - /** Closes the drop-down editor. */ - close(): void; - /** Opens the drop-down editor. */ - open(): void; - /** Resets the widget's value to null. */ - reset(): void; - /** Returns an <input> element of the widget. */ - field(): JQuery; - /** Returns an HTML element of the popup window content. */ - content(): JQuery; - } - export interface dxDateBoxOptions extends dxTextEditorOptions { - /** A format used to display date/time information. */ - format?: string; - /** A Globalize format string specifying the date display format. */ - formatString?: string; - /** The last date that can be selected within the widget. */ - max?: any; - /** The minimum date that can be selected within the widget. */ - min?: any; - /** The text displayed by the widget when the widget value is not yet specified. This text is also used as a title of the date picker. */ - placeholder?: string; - /** - * Specifies whether or not a user can pick out a date using the drop-down calendar. - * @deprecated Use 'pickerType' option instead. - */ - useCalendar?: boolean; - /** An object or a value, specifying the date and time currently selected using the date box. */ - value?: any; - /** - * Specifies whether or not the widget uses the native HTML input element. - * @deprecated Use 'pickerType' option instead. - */ - useNative?: boolean; - /** Specifies the interval between neighboring values in the popup list in minutes. */ - interval?: number; - /** Specifies the maximum zoom level of a calendar, which is used to pick the date. */ - maxZoomLevel?: string; - /** Specifies the minimal zoom level of a calendar, which is used to pick the date. */ - minZoomLevel?: string; - /** Specifies the type of date/time picker. */ - pickerType?: string; - /** Specifies the message displayed if the typed value is not a valid date or time. */ - invalidDateMessage?: string; - /** Specifies the message displayed if the specified date is later than the max value or earlier than the min value. */ - dateOutOfRangeMessage?: string; - /** The text displayed on the Apply button. */ - applyButtonText?: string; - /** The text displayed on the Cancel button. */ - cancelButtonText?: string; - } - /** A date box widget. */ - export class dxDateBox extends dxDropDownEditor { - constructor(element: JQuery, options?: dxDateBoxOptions); - constructor(element: Element, options?: dxDateBoxOptions); - } - export interface dxCheckBoxOptions extends EditorOptions { - activeStateEnabled?: boolean; - /** Specifies the widget state. */ - value?: boolean; - /** Specifies the text displayed by the check box. */ - text?: string; - } - /** A check box widget. */ - export class dxCheckBox extends Editor { - constructor(element: JQuery, options?: dxCheckBoxOptions); - constructor(element: Element, options?: dxCheckBoxOptions); - } - export interface dxCalendarOptions extends EditorOptions { - activeStateEnabled?: boolean; - /** Specifies a date displayed on the current calendar page. */ - currentDate?: Date; - /** Specifies the first day of a week. */ - firstDayOfWeek?: number; - /** The latest date the widget allows to select. */ - max?: Date; - /** The earliest date the widget allows to select. */ - min?: Date; - /** Specifies whether or not the widget displays a button that selects the current date. */ - showTodayButton?: boolean; - /** Specifies the current calendar zoom level. */ - zoomLevel?: string; - /** Specifies the maximum zoom level of the calendar. */ - maxZoomLevel?: string; - /** Specifies the minimum zoom level of the calendar. */ - minZoomLevel?: string; - /** The template to be used for rendering calendar cells. */ - cellTemplate?: any; - } - /** A calendar widget. */ - export class dxCalendar extends Editor { - constructor(element: JQuery, options?: dxCalendarOptions); - constructor(element: Element, options?: dxCalendarOptions); - } - export interface dxButtonOptions extends WidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A handler for the click event. */ - onClick?: any; - /** Specifies the icon to be displayed on the button. */ - icon?: string; - iconSrc?: string; - /** A template to be used for rendering the dxButton widget. */ - template?: any; - /** The text displayed on the button. */ - text?: string; - /** Specifies the button type. */ - type?: string; - /** Specifies the name of the validation group to be accessed in the click event handler. */ - validationGroup?: string; - } - /** A button widget. */ - export class dxButton extends Widget { - constructor(element: JQuery, options?: dxButtonOptions); - constructor(element: Element, options?: dxButtonOptions); - } - export interface dxBoxOptions extends CollectionWidget { - /** Specifies how widget items are aligned along the main direction. */ - align?: string; - /** Specifies the direction of item positioning in the widget. */ - direction?: string; - /** Specifies how widget items are aligned cross-wise. */ - crossAlign?: string; - } - /** A container widget used to arrange inner elements. */ - export class dxBox extends CollectionWidget { - constructor(element: JQuery, options?: dxBoxOptions); - constructor(element: Element, options?: dxBoxOptions); - } - export interface dxResponsiveBoxOptions extends CollectionWidgetOptions { - /** Specifies the collection of rows for the grid used to position layout elements. */ - rows?: Array; - /** Specifies the collection of columns for the grid used to position layout elements. */ - cols?: Array; - /** Specifies the function returning the screen factor depending on the screen width. */ - screenByWidth?: (width: number) => string; - /** Specifies the screen factor with which all elements are located in a single column. */ - singleColumnScreen?: string; - } - /** A widget used to build an adaptive markup that is dependent on screen resolution. */ - export class dxResponsiveBox extends CollectionWidget { - constructor(element: JQuery, options?: dxBoxOptions); - constructor(element: Element, options?: dxBoxOptions); - } - export interface dxAutocompleteOptions extends dxDropDownListOptions { - /** Specifies the current value displayed by the widget. */ - value?: string; - /** The minimum number of characters that must be entered into the text box to begin a search. */ - minSearchLength?: number; - /** Specifies the maximum count of items displayed by the widget. */ - maxItemCount?: number; - /** Gets the currently selected item. */ - selectedItem?: Object; - } - /** A textbox widget that supports autocompletion. */ - export class dxAutocomplete extends dxDropDownList { - constructor(element: JQuery, options?: dxAutocompleteOptions); - constructor(element: Element, options?: dxAutocompleteOptions); - /** Opens the drop-down editor. */ - open(): void; - /** Closes the drop-down editor. */ - close(): void; - } - export interface dxAccordionOptions extends CollectionWidgetOptions { - /** A number specifying the time in milliseconds spent on the animation of the expanding or collapsing of a panel. */ - animationDuration?: number; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies whether all items can be collapsed or whether at least one item must always be expanded. */ - collapsible?: boolean; - /** Specifies whether the widget can expand several items or only a single item at once. */ - multiple?: boolean; - /** The template to be used for rendering dxAccordion items. */ - itemTemplate?: any; - /** A handler for the itemTitleClick event. */ - onItemTitleClick?: any; - /** A handler for the itemTitleHold event. */ - onItemTitleHold?: Function; - /** The template to be used for rendering an item title. */ - itemTitleTemplate?: any; - /** The index number of the currently selected item. */ - selectedIndex?: number; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - } - /** A widget that displays data source items on collapsible panels. */ - export class dxAccordion extends CollectionWidget { - constructor(element: JQuery, options?: dxAccordionOptions); - constructor(element: Element, options?: dxAccordionOptions); - /** Collapses the specified item. */ - collapseItem(index: number): JQueryPromise; - /** Expands the specified item. */ - expandItem(index: number): JQueryPromise; - /** Updates the dimensions of the widget contents. */ - updateDimensions(): JQueryPromise; - } - export interface dxFileUploaderOptions extends EditorOptions { - /** A read-only option that holds a File instance representing the selected file. */ - value?: File; - /** Holds the File instances representing files selected in the widget. */ - values?: Array; - buttonText?: string; - /** The text displayed on the button that opens the file browser. */ - selectButtonText?: string; - /** The text displayed on the button that starts uploading. */ - uploadButtonText?: string; - /** Specifies the text displayed on the area to which an end-user can drop a file. */ - labelText?: string; - /** Specifies the value passed to the name attribute of the underlying input element. */ - name?: string; - /** Specifies whether the widget enables an end-user to select a single file or multiple files. */ - multiple?: boolean; - /** Specifies a file type or several types accepted by the widget. */ - accept?: string; - /** Specifies a target Url for the upload request. */ - uploadUrl?: string; - /** Specifies if an end user can remove a file from the selection and interrupt uploading. */ - allowCanceling?: boolean; - /** Specifies whether or not the widget displays the list of selected files. */ - showFileList?: boolean; - /** Gets the current progress in percentages. */ - progress?: number; - /** The message displayed by the widget when it is ready to upload the specified files. */ - readyToUploadMessage?: string; - /** The message displayed by the widget when uploading is finished. */ - uploadedMessage?: string; - /** The message displayed by the widget on uploading failure. */ - uploadFailedMessage?: string; - /** Specifies how the widget uploads files. */ - uploadMode?: string; - /** A handler for the uploaded event. */ - onUploaded?: Function; - /** A handler for the uploaded event. */ - onProgress?: Function; - /** A handler for the uploadError event. */ - onUploadError?: Function; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - } - /** A widget used to select and upload a file or multiple files. */ - export class dxFileUploader extends Editor { - constructor(element: JQuery, options?: dxFileUploaderOptions); - constructor(element: Element, options?: dxFileUploaderOptions); - } - export interface dxTrackBarOptions extends EditorOptions { - /** The minimum value the widget can accept. */ - min?: number; - /** The maximum value the widget can accept. */ - max?: number; - /** The current widget value. */ - value?: number; - } - /** A base class for track bar widgets. */ - export class dxTrackBar extends Editor { - constructor(element: JQuery, options?: dxTrackBarOptions); - constructor(element: Element, options?: dxTrackBarOptions); - } - export interface dxProgressBarOptions extends dxTrackBarOptions { - /** Specifies a format for the progress status. */ - statusFormat?: any; - /** Specifies whether or not the widget displays a progress status. */ - showStatus?: boolean; - /** A handler for the complete event. */ - onComplete?: Function; - } - /** A widget used to indicate progress. */ - export class dxProgressBar extends dxTrackBar { - constructor(element: JQuery, options?: dxProgressBarOptions); - constructor(element: Element, options?: dxProgressBarOptions); - } - export interface dxSliderOptions extends dxTrackBarOptions { - activeStateEnabled?: boolean; - /** The slider step size. */ - step?: number; - /** The current slider value. */ - value?: number; - /** Specifies whether or not to highlight a range selected within the widget. */ - showRange?: boolean; - /** Specifies the size of a step by which a slider handle is moved when a user uses the Page up or Page down keyboard shortcuts. */ - keyStep?: number; - /** Specifies options for the slider tooltip. */ - tooltip?: { - /** Specifies whether or not the tooltip is enabled. */ - enabled?: boolean; - /** Specifies format for the tooltip. */ - format?: any; - /** Specifies whether the tooltip is located over or under the slider. */ - position?: string; - /** Specifies whether the widget always shows a tooltip or only when a pointer is over the slider. */ - showMode?: string; - }; - /** Specifies options for labels displayed at the min and max values. */ - label?: { - /** Specifies whether or not slider labels are visible. */ - visible?: boolean; - /** Specifies whether labels are located over or under the scale. */ - position?: string; - /** Specifies a format for labels. */ - format?: any; - }; - } - /** A widget that allows a user to select a numeric value within a given range. */ - export class dxSlider extends dxTrackBar { - constructor(element: JQuery, options?: dxSliderOptions); - constructor(element: Element, options?: dxSliderOptions); - } - export interface dxRangeSliderOptions extends dxSliderOptions { - /** The left edge of the interval currently selected using the range slider. */ - start?: number; - /** The right edge of the interval currently selected using the range slider. */ - end?: number; - } - /** A widget that enables a user to select a range of numeric values. */ - export class dxRangeSlider extends dxSlider { - constructor(element: JQuery, options?: dxRangeSliderOptions); - constructor(element: Element, options?: dxRangeSliderOptions); - } - export interface dxFormItemLabel { - /** Specifies the label text. */ - text?: string; - /** Specifies whether or not the label is visible. */ - visible?: boolean; - /** Specifies whether or not a colon is displayed at the end of the current label. */ - showColon?: boolean; - /** Specifies the location of a label against the editor. */ - location?: string; - /** Specifies the label horizontal alignment. */ - alignment?: string; - } - export interface dxFormItem { - /** Specifies the type of the current item. */ - itemType?: string; - /** Specifies whether or not the current form item is visible. */ - visible?: boolean; - /** Specifies the sequence number of the item in a form, group or tab. */ - visibleIndex?: number; - /** Specifies a CSS class to be applied to the form item. */ - cssClass?: string; - /** Specifies the number of columns spanned by the item. */ - colSpan?: number; - } - export interface dxFormEmptyItem extends dxFormItem { - /** Specifies the form item name. */ - name?: string; - } - export interface dxFormSimpleItem extends dxFormItem { - /** Specifies the path to the formData object field bound to the current form item. */ - dataField?: string; - /** Specifies the form item name. */ - name?: string; - /** Specifies which editor widget is used to display and edit the form item value. */ - editorType?: string; - /** Specifies configuration options for the editor widget of the current form item. */ - editorOptions?: Object; - /** A template to be used for rendering the form item. */ - template?: any; - /** Specifies the help text displayed for the current form item. */ - helpText?: string; - /** Specifies whether the current form item is required. */ - isRequired?: boolean; - /** Specifies options for the form item label. */ - label?: dxFormItemLabel; - /** An array of validation rules to be checked for the form item editor. */ - validationRules?: Array; - } - export interface dxFormGroupItem extends dxFormItem { - /** Specifies the group caption. */ - caption?: string; - /** A template to be used for rendering the group item. */ - template?: any; - /** The count of columns in the group layout. */ - colCount?: number; - /** Specifies whether or not all group item labels are aligned. */ - alignItemLabels?: boolean; - /** Holds an array of form items displayed within the group. */ - items?: Array; - } - export interface dxFormTab { - /** Specifies the tab title. */ - title?: string; - /** The count of columns in the tab layout. */ - colCount?: number; - /** Specifies whether or not labels of items displayed within the current tab are aligned. */ - alignItemLabels?: boolean; - /** Holds an array of form items displayed within the tab. */ - items?: Array; - /** Specifies a badge text for the tab. */ - badge?: string; - /** A Boolean value specifying whether or not the tab can respond to user interaction. */ - disabled?: boolean; - /** Specifies the icon to be displayed on the tab. */ - icon?: string; - /** The template to be used for rendering the tab. */ - tabTemplate?: any; - /** The template to be used for rendering the tab content. */ - template?: any; - } - export interface dxFormTabbedItem extends dxFormItem { - /** Holds a configuration object for the dxTabPanel widget used to display the current form item. */ - tabPanelOptions?: Object; - /** An array of tab configuration objects. */ - tabs?: Array; - } - export interface dxFormOptions extends WidgetOptions { - /** An object providing data for the form. */ - formData?: Object; - /** The count of columns in the form layout. */ - colCount?: any; - /** Specifies the location of a label against the editor. */ - labelLocation?: string; - /** Specifies whether or not all editors on the form are read-only. */ - readOnly?: boolean; - /** A handler for the fieldDataChanged event. */ - onFieldDataChanged?: (e: Object) => void; - /** A handler for the editorEnterKey event. */ - onEditorEnterKey?: (e: Object) => void; - /** Specifies a function that customizes a form item after it has been created. */ - customizeItem?: Function; - /** The minimum column width used for calculating column count in the form layout. */ - minColWidth?: number; - /** Specifies whether or not all root item labels are aligned. */ - alignItemLabels?: boolean; - /** Specifies whether or not item labels in all groups are aligned. */ - alignItemLabelsInAllGroups?: boolean; - /** Specifies whether or not a colon is displayed at the end of form labels. */ - showColonAfterLabel?: boolean; - /** Specifies whether or not the required mark is displayed for required fields. */ - showRequiredMark?: boolean; - /** Specifies whether or not the optional mark is displayed for optional fields. */ - showOptionalMark?: boolean; - /** The text displayed for required fields. */ - requiredMark?: string; - /** The text displayed for optional fields. */ - optionalMark?: string; - /** Specifies the message that is shown for end-users if a required field value is not specified. */ - requiredMessage?: string; - /** Specifies whether or not the total validation summary is displayed on the form. */ - showValidationSummary?: boolean; - /** Holds an array of form items. */ - items?: Array; - /** A Boolean value specifying whether to enable or disable form scrolling. */ - scrollingEnabled?: boolean; - onContentReady?: Function; - } - /** A form widget used to display and edit values of object fields. */ - export class dxForm extends Widget { - constructor(element: JQuery, options?: dxFormOptions); - constructor(element: Element, options?: dxFormOptions); - /** Updates the specified field of the formData object and the corresponding editor on the form. */ - updateData(dataField: string, value: any): void; - /** Updates the specified fields of the formData object and the corresponding editors on the form. */ - updateData(data: Object): void; - /** Updates the value of a form item option. */ - itemOption(field: string, option: string, value: any): void; - /** Updates the values of form item options. */ - itemOption(field: string, options: Object): void; - /** Returns an editor instance associated with the specified formData field. */ - getEditor(field: string): Object; - /** Updates the dimensions of the widget contents. */ - updateDimensions(): JQueryPromise; - /** Validates the values of all editors on the form against the list of the validation rules specified for each form item. */ - validate(): Object; - } -} -interface JQuery { - dxProgressBar(): JQuery; - dxProgressBar(options: "instance"): DevExpress.ui.dxProgressBar; - dxProgressBar(options: string): any; - dxProgressBar(options: string, ...params: any[]): any; - dxProgressBar(options: DevExpress.ui.dxProgressBarOptions): JQuery; - dxSlider(): JQuery; - dxSlider(options: "instance"): DevExpress.ui.dxSlider; - dxSlider(options: string): any; - dxSlider(options: string, ...params: any[]): any; - dxSlider(options: DevExpress.ui.dxSliderOptions): JQuery; - dxRangeSlider(): JQuery; - dxRangeSlider(options: "instance"): DevExpress.ui.dxRangeSlider; - dxRangeSlider(options: string): any; - dxRangeSlider(options: string, ...params: any[]): any; - dxRangeSlider(options: DevExpress.ui.dxRangeSliderOptions): JQuery; - dxFileUploader(): JQuery; - dxFileUploader(options: "instance"): DevExpress.ui.dxFileUploader; - dxFileUploader(options: string): any; - dxFileUploader(options: string, ...params: any[]): any; - dxFileUploader(options: DevExpress.ui.dxFileUploaderOptions): JQuery; - dxValidator(): JQuery; - dxValidator(options: "instance"): DevExpress.ui.dxValidator; - dxValidator(options: string): any; - dxValidator(options: string, ...params: any[]): any; - dxValidator(options: DevExpress.ui.dxValidatorOptions): JQuery; - dxValidationGroup(): JQuery; - dxValidationGroup(options: "instance"): DevExpress.ui.dxValidationGroup; - dxValidationGroup(options: string): any; - dxValidationGroup(options: string, ...params: any[]): any; - dxValidationSummary(): JQuery; - dxValidationSummary(options: "instance"): DevExpress.ui.dxValidationSummary; - dxValidationSummary(options: string): any; - dxValidationSummary(options: string, ...params: any[]): any; - dxValidationSummary(options: DevExpress.ui.dxValidationSummaryOptions): JQuery; - dxTooltip(): JQuery; - dxTooltip(options: "instance"): DevExpress.ui.dxTooltip; - dxTooltip(options: string): any; - dxTooltip(options: string, ...params: any[]): any; - dxTooltip(options: DevExpress.ui.dxTooltipOptions): JQuery; - dxResizable(): JQuery; - dxResizable(options: "instance"): DevExpress.ui.dxResizable; - dxResizable(options: string): any; - dxResizable(options: string, ...params: any[]): any; - dxResizable(options: DevExpress.ui.dxResizableOptions): JQuery; - dxDropDownList(): JQuery; - dxDropDownList(options: "instance"): DevExpress.ui.dxDropDownList; - dxDropDownList(options: string): any; - dxDropDownList(options: string, ...params: any[]): any; - dxDropDownList(options: DevExpress.ui.dxDropDownListOptions): JQuery; - dxToolbar(): JQuery; - dxToolbar(options: "instance"): DevExpress.ui.dxToolbar; - dxToolbar(options: string): any; - dxToolbar(options: string, ...params: any[]): any; - dxToolbar(options: DevExpress.ui.dxToolbarOptions): JQuery; - dxToast(): JQuery; - dxToast(options: "instance"): DevExpress.ui.dxToast; - dxToast(options: string): any; - dxToast(options: string, ...params: any[]): any; - dxToast(options: DevExpress.ui.dxToastOptions): JQuery; - dxTextEditor(): JQuery; - dxTextEditor(options: "instance"): DevExpress.ui.dxTextEditor; - dxTextEditor(options: string): any; - dxTextEditor(options: string, ...params: any[]): any; - dxTextEditor(options: DevExpress.ui.dxTextEditorOptions): JQuery; - dxTextBox(): JQuery; - dxTextBox(options: "instance"): DevExpress.ui.dxTextBox; - dxTextBox(options: string): any; - dxTextBox(options: string, ...params: any[]): any; - dxTextBox(options: DevExpress.ui.dxTextBoxOptions): JQuery; - dxTextArea(): JQuery; - dxTextArea(options: "instance"): DevExpress.ui.dxTextArea; - dxTextArea(options: string): any; - dxTextArea(options: string, ...params: any[]): any; - dxTextArea(options: DevExpress.ui.dxTextAreaOptions): JQuery; - dxTabs(): JQuery; - dxTabs(options: "instance"): DevExpress.ui.dxTabs; - dxTabs(options: string): any; - dxTabs(options: string, ...params: any[]): any; - dxTabs(options: DevExpress.ui.dxTabsOptions): JQuery; - dxTabPanel(): JQuery; - dxTabPanel(options: "instance"): DevExpress.ui.dxTabPanel; - dxTabPanel(options: string): any; - dxTabPanel(options: string, ...params: any[]): any; - dxTabPanel(options: DevExpress.ui.dxTabPanelOptions): JQuery; - dxSelectBox(): JQuery; - dxSelectBox(options: "instance"): DevExpress.ui.dxSelectBox; - dxSelectBox(options: string): any; - dxSelectBox(options: string, ...params: any[]): any; - dxSelectBox(options: DevExpress.ui.dxSelectBoxOptions): JQuery; - dxTagBox(): JQuery; - dxTagBox(options: "instance"): DevExpress.ui.dxTagBox; - dxTagBox(options: string): any; - dxTagBox(options: string, ...params: any[]): any; - dxTagBox(options: DevExpress.ui.dxTagBoxOptions): JQuery; - dxScrollView(): JQuery; - dxScrollView(options: "instance"): DevExpress.ui.dxScrollView; - dxScrollView(options: string): any; - dxScrollView(options: string, ...params: any[]): any; - dxScrollView(options: DevExpress.ui.dxScrollViewOptions): JQuery; - dxScrollable(): JQuery; - dxScrollable(options: "instance"): DevExpress.ui.dxScrollable; - dxScrollable(options: string): any; - dxScrollable(options: string, ...params: any[]): any; - dxScrollable(options: DevExpress.ui.dxScrollableOptions): JQuery; - dxRadioGroup(): JQuery; - dxRadioGroup(options: "instance"): DevExpress.ui.dxRadioGroup; - dxRadioGroup(options: string): any; - dxRadioGroup(options: string, ...params: any[]): any; - dxRadioGroup(options: DevExpress.ui.dxRadioGroupOptions): JQuery; - dxPopup(): JQuery; - dxPopup(options: "instance"): DevExpress.ui.dxPopup; - dxPopup(options: string): any; - dxPopup(options: string, ...params: any[]): any; - dxPopup(options: DevExpress.ui.dxPopupOptions): JQuery; - dxPopover(): JQuery; - dxPopover(options: "instance"): DevExpress.ui.dxPopover; - dxPopover(options: string): any; - dxPopover(options: string, ...params: any[]): any; - dxPopover(options: DevExpress.ui.dxPopoverOptions): JQuery; - dxOverlay(): JQuery; - dxOverlay(options: "instance"): DevExpress.ui.dxOverlay; - dxOverlay(options: string): any; - dxOverlay(options: string, ...params: any[]): any; - dxOverlay(options: DevExpress.ui.dxOverlayOptions): JQuery; - dxNumberBox(): JQuery; - dxNumberBox(options: "instance"): DevExpress.ui.dxNumberBox; - dxNumberBox(options: string): any; - dxNumberBox(options: string, ...params: any[]): any; - dxNumberBox(options: DevExpress.ui.dxNumberBoxOptions): JQuery; - dxNavBar(): JQuery; - dxNavBar(options: "instance"): DevExpress.ui.dxNavBar; - dxNavBar(options: string): any; - dxNavBar(options: string, ...params: any[]): any; - dxNavBar(options: DevExpress.ui.dxNavBarOptions): JQuery; - dxMultiView(): JQuery; - dxMultiView(options: "instance"): DevExpress.ui.dxMultiView; - dxMultiView(options: string): any; - dxMultiView(options: string, ...params: any[]): any; - dxMultiView(options: DevExpress.ui.dxMultiViewOptions): JQuery; - dxMap(): JQuery; - dxMap(options: "instance"): DevExpress.ui.dxMap; - dxMap(options: string): any; - dxMap(options: string, ...params: any[]): any; - dxMap(options: DevExpress.ui.dxMapOptions): JQuery; - dxLookup(): JQuery; - dxLookup(options: "instance"): DevExpress.ui.dxLookup; - dxLookup(options: string): any; - dxLookup(options: string, ...params: any[]): any; - dxLookup(options: DevExpress.ui.dxLookupOptions): JQuery; - dxLoadPanel(): JQuery; - dxLoadPanel(options: "instance"): DevExpress.ui.dxLoadPanel; - dxLoadPanel(options: string): any; - dxLoadPanel(options: string, ...params: any[]): any; - dxLoadPanel(options: DevExpress.ui.dxLoadPanelOptions): JQuery; - dxLoadIndicator(): JQuery; - dxLoadIndicator(options: "instance"): DevExpress.ui.dxLoadIndicator; - dxLoadIndicator(options: string): any; - dxLoadIndicator(options: string, ...params: any[]): any; - dxLoadIndicator(options: DevExpress.ui.dxLoadIndicatorOptions): JQuery; - dxList(): JQuery; - dxList(options: "instance"): DevExpress.ui.dxList; - dxList(options: string): any; - dxList(options: string, ...params: any[]): any; - dxList(options: DevExpress.ui.dxListOptions): JQuery; - dxGallery(): JQuery; - dxGallery(options: "instance"): DevExpress.ui.dxGallery; - dxGallery(options: string): any; - dxGallery(options: string, ...params: any[]): any; - dxGallery(options: DevExpress.ui.dxGalleryOptions): JQuery; - dxDropDownEditor(): JQuery; - dxDropDownEditor(options: "instance"): DevExpress.ui.dxDropDownEditor; - dxDropDownEditor(options: string): any; - dxDropDownEditor(options: string, ...params: any[]): any; - dxDropDownEditor(options: DevExpress.ui.dxDropDownEditorOptions): JQuery; - dxDateBox(): JQuery; - dxDateBox(options: "instance"): DevExpress.ui.dxDateBox; - dxDateBox(options: string): any; - dxDateBox(options: string, ...params: any[]): any; - dxDateBox(options: DevExpress.ui.dxDateBoxOptions): JQuery; - dxCheckBox(): JQuery; - dxCheckBox(options: "instance"): DevExpress.ui.dxCheckBox; - dxCheckBox(options: string): any; - dxCheckBox(options: string, ...params: any[]): any; - dxCheckBox(options: DevExpress.ui.dxCheckBoxOptions): JQuery; - dxBox(): JQuery; - dxBox(options: "instance"): DevExpress.ui.dxBox; - dxBox(options: string): any; - dxBox(options: string, ...params: any[]): any; - dxBox(options: DevExpress.ui.dxBoxOptions): JQuery; - dxButton(): JQuery; - dxButton(options: "instance"): DevExpress.ui.dxButton; - dxButton(options: string): any; - dxButton(options: string, ...params: any[]): any; - dxButton(options: DevExpress.ui.dxButtonOptions): JQuery; - dxCalendar(): JQuery; - dxCalendar(options: "instance"): DevExpress.ui.dxCalendar; - dxCalendar(options: string): any; - dxCalendar(options: string, ...params: any[]): any; - dxCalendar(options: DevExpress.ui.dxCalendarOptions): JQuery; - dxAccordion(): JQuery; - dxAccordion(options: "instance"): DevExpress.ui.dxAccordion; - dxAccordion(options: string): any; - dxAccordion(options: string, ...params: any[]): any; - dxAccordion(options: DevExpress.ui.dxAccordionOptions): JQuery; - dxResponsiveBox(): JQuery; - dxResponsiveBox(options: "instance"): DevExpress.ui.dxResponsiveBox; - dxResponsiveBox(options: string): any; - dxResponsiveBox(options: string, ...params: any[]): any; - dxResponsiveBox(options: DevExpress.ui.dxResponsiveBoxOptions): JQuery; - dxAutocomplete(): JQuery; - dxAutocomplete(options: "instance"): DevExpress.ui.dxAutocomplete; - dxAutocomplete(options: string): any; - dxAutocomplete(options: string, ...params: any[]): any; - dxAutocomplete(options: DevExpress.ui.dxAutocompleteOptions): JQuery; - dxForm(): JQuery; - dxForm(options: "instance"): DevExpress.ui.dxForm; - dxForm(options: string): any; - dxForm(options: string, ...params: any[]): any; - dxForm(options: DevExpress.ui.dxFormOptions): JQuery; -} - -declare module DevExpress.ui { - export interface dxTileViewOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** Specifies the height of the base tile view item. */ - baseItemHeight?: number; - /** Specifies the width of the base tile view item. */ - baseItemWidth?: number; - /** Specifies whether tiles are placed horizontally or vertically. */ - direction?: string; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies the distance in pixels between adjacent tiles. */ - itemMargin?: number; - /** A Boolean value specifying whether or not to display a scrollbar. */ - showScrollbar?: boolean; - } - /** A widget displaying several blocks of data as tiles. */ - export class dxTileView extends CollectionWidget { - constructor(element: JQuery, options?: dxTileViewOptions); - constructor(element: Element, options?: dxTileViewOptions); - /** Returns the current scroll position of the widget content. */ - scrollPosition(): number; - } - export interface dxSwitchOptions extends EditorOptions { - activeStateEnabled?: boolean; - /** Text displayed when the widget is in a disabled state. */ - offText?: string; - /** Text displayed when the widget is in an enabled state. */ - onText?: string; - /** A Boolean value specifying whether the current switch state is "On" or "Off". */ - value?: boolean; - } - /** A switch widget. */ - export class dxSwitch extends Editor { - constructor(element: JQuery, options?: dxSwitchOptions); - constructor(element: Element, options?: dxSwitchOptions); - } - export interface dxSlideOutViewOptions extends WidgetOptions { - /** Specifies the current menu position. */ - menuPosition?: string; - /** Specifies whether or not the menu panel is visible. */ - menuVisible?: boolean; - /** Specifies whether or not the menu is shown when a user swipes the widget content. */ - swipeEnabled?: boolean; - /** A template to be used for rendering menu panel content. */ - menuTemplate?: any; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - } - /** The widget that allows you to slide-out the current view to reveal a custom menu. */ - export class dxSlideOutView extends Widget { - constructor(element: JQuery, options?: dxSlideOutViewOptions); - constructor(element: Element, options?: dxSlideOutViewOptions); - /** Returns an HTML element of the widget menu block. */ - menuContent(): JQuery; - /** Returns an HTML element of the widget content block. */ - content(): JQuery; - /** Displays the widget's menu block. */ - showMenu(): JQueryPromise; - /** Hides the widget's menu block. */ - hideMenu(): JQueryPromise; - /** Toggles the visibility of the widget's menu block. */ - toggleMenuVisibility(): JQueryPromise; - } - export interface dxSlideOutOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A Boolean value specifying whether or not to display a grouped menu. */ - menuGrouped?: boolean; - /** Specifies the current menu position. */ - menuPosition?: string; - /** The name of the template used to display a group header. */ - menuGroupTemplate?: any; - /** The template used to render menu items. */ - menuItemTemplate?: any; - /** A handler for the menuGroupRendered event. */ - onMenuGroupRendered?: Function; - /** A handler for the menuItemRendered event. */ - onMenuItemRendered?: Function; - /** Specifies whether or not the slide-out menu is displayed. */ - menuVisible?: boolean; - /** Indicates whether the menu can be shown/hidden by swiping the widget's main panel. */ - swipeEnabled?: boolean; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - } - /** The widget that allows you to slide-out the current view to reveal an item list. */ - export class dxSlideOut extends CollectionWidget { - constructor(element: JQuery, options?: dxSlideOutOptions); - constructor(element: Element, options?: dxSlideOutOptions); - /** Hides the widget's slide-out menu. */ - hideMenu(): JQueryPromise; - /** Displays the widget's slide-out menu. */ - showMenu(): JQueryPromise; - /** Toggles the visibility of the widget's slide-out menu. */ - toggleMenuVisibility(showing: boolean): JQueryPromise; - } - export interface dxPivotOptions extends CollectionWidgetOptions { - /** The index of the currently active pivot item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to allow users to switch between items by swiping. */ - swipeEnabled?: boolean; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - /** The template to be used for rendering an item title. */ - itemTitleTemplate?: any; - } - /** A widget that is similar to a traditional tab control, but optimized for the phone with simplified end-user interaction. */ - export class dxPivot extends CollectionWidget { - constructor(element: JQuery, options?: dxPivotOptions); - constructor(element: Element, options?: dxPivotOptions); - } - export interface dxPanoramaOptions extends CollectionWidgetOptions { - /** An object exposing options for setting a background image for the panorama. */ - backgroundImage?: { - /** Specifies the height of the panorama's background image. */ - height?: number; - /** Specifies the URL of the image that is used as the panorama's background image. */ - url?: string; - /** Specifies the width of the panorama's background image. */ - width?: number; - }; - /** The index of the currently active panorama item. */ - selectedIndex?: number; - /** Specifies the widget content title. */ - title?: string; - } - /** A widget displaying the required content in a long horizontal canvas that extends beyond the frames of the screen. */ - export class dxPanorama extends CollectionWidget { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - } - export interface dxDropDownMenuOptions extends WidgetOptions { - /** A handler for the buttonClick event. */ - onButtonClick?: any; - /** The name of the icon to be displayed by the DropDownMenu button. */ - buttonIcon?: string; - /** The text displayed in the DropDownMenu button. */ - buttonText?: string; - buttonIconSrc?: string; - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** A handler for the itemClick event. */ - onItemClick?: any; - /** An array of items displayed by the widget. */ - items?: Array; - /** The template to be used for rendering items. */ - itemTemplate?: any; - /** Specifies whether or not to show the drop down menu within a dxPopover widget. */ - usePopover?: boolean; - /** The width of the menu popup in pixels. */ - popupWidth?: any; - /** The height of the menu popup in pixels. */ - popupHeight?: any; - /** Specifies whether or not the drop-down menu is displayed. */ - opened?: boolean; - hoverStateEnabled?: boolean; - activeStateEnabled?: boolean; - } - /** A drop-down menu widget. */ - export class dxDropDownMenu extends Widget { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - /** This section lists the data source fields that are used in a default template for drop-down menu items. */ - /** Opens the drop-down menu. */ - open(): void; - /** Closes the drop-down menu. */ - close(): void; - } - export interface dxActionSheetOptions extends CollectionWidgetOptions { - /** A handler for the cancelClick event. */ - onCancelClick?: any; - /** The text displayed in the button that closes the action sheet. */ - cancelText?: string; - /** Specifies whether or not to display the Cancel button in action sheet. */ - showCancelButton?: boolean; - /** A Boolean value specifying whether or not the title of the action sheet is visible. */ - showTitle?: boolean; - /** Specifies the element the action sheet popover points at. */ - target?: any; - /** The title of the action sheet. */ - title?: string; - /** Specifies whether or not to show the action sheet within a dxPopover widget. */ - usePopover?: boolean; - /** A Boolean value specifying whether or not the dxActionSheet widget is visible. */ - visible?: boolean; - } - /** A widget consisting of a set of choices related to a certain task. */ - export class dxActionSheet extends CollectionWidget { - constructor(element: JQuery, options?: dxActionSheetOptions); - constructor(element: Element, options?: dxActionSheetOptions); - /** Hides the widget. */ - hide(): JQueryPromise; - /** Shows the widget. */ - show(): JQueryPromise; - /** Shows or hides the widget depending on the Boolean value passed as the parameter. */ - toggle(showing: boolean): JQueryPromise; - } -} -interface JQuery { - dxTileView(): JQuery; - dxTileView(options: "instance"): DevExpress.ui.dxTileView; - dxTileView(options: string): any; - dxTileView(options: string, ...params: any[]): any; - dxTileView(options: DevExpress.ui.dxTileViewOptions): JQuery; - dxSwitch(): JQuery; - dxSwitch(options: "instance"): DevExpress.ui.dxSwitch; - dxSwitch(options: string): any; - dxSwitch(options: string, ...params: any[]): any; - dxSwitch(options: DevExpress.ui.dxSwitchOptions): JQuery; - dxSlideOut(): JQuery; - dxSlideOut(options: "instance"): DevExpress.ui.dxSlideOut; - dxSlideOut(options: string): any; - dxSlideOut(options: string, ...params: any[]): any; - dxSlideOut(options: DevExpress.ui.dxSlideOutOptions): JQuery; - dxPivot(): JQuery; - dxPivot(options: "instance"): DevExpress.ui.dxPivot; - dxPivot(options: string): any; - dxPivot(options: string, ...params: any[]): any; - dxPivot(options: DevExpress.ui.dxPivotOptions): JQuery; - dxPanorama(): JQuery; - dxPanorama(options: "instance"): DevExpress.ui.dxPanorama; - dxPanorama(options: string): any; - dxPanorama(options: string, ...params: any[]): any; - dxPanorama(options: DevExpress.ui.dxPanoramaOptions): JQuery; - dxActionSheet(): JQuery; - dxActionSheet(options: "instance"): DevExpress.ui.dxActionSheet; - dxActionSheet(options: string): any; - dxActionSheet(options: string, ...params: any[]): any; - dxActionSheet(options: DevExpress.ui.dxActionSheetOptions): JQuery; - dxDropDownMenu(): JQuery; - dxDropDownMenu(options: "instance"): DevExpress.ui.dxDropDownMenu; - dxDropDownMenu(options: string): any; - dxDropDownMenu(options: string, ...params: any[]): any; - dxDropDownMenu(options: DevExpress.ui.dxDropDownMenuOptions): JQuery; -} -declare module DevExpress.data { - export interface XmlaStoreOptions { - /** The HTTP address to an XMLA OLAP server. */ - url?: string; - /** The name of the database associated with the Store. */ - catalog?: string; - /** The cube name. */ - cube?: string; - /** A function used to customize a web request before it is sent. */ - beforeSend?: (request: Object) => void; - } - /** A Store that provides access to an OLAP cube using the XMLA standard. */ - export class XmlaStore { - constructor(options: XmlaStoreOptions); - } - export interface PivotGridField { - index?: number; - /** A boolean value specifying whether or not the field is visible in the pivot grid and the Field Chooser. */ - visible?: boolean; - /** Name of the data source field containing data for the pivot grid field. */ - dataField?: string; - /** A caption that will be displayed in the pivot grid's field chooser to identify the field. */ - caption?: string; - /** Specifies a type of field values. */ - dataType?: string; - /** Specifies how the values of the current field are combined into groups. Cannot be used for the XmlaStore store type. */ - groupInterval?: any; - /** Specifies how to aggregate field data. Cannot be used for the XmlaStore store type. */ - summaryType?: string; - /** Allows you to use a custom aggregate function to calculate the summary values. Cannot be used for the XmlaStore store type. */ - calculateCustomSummary?: (options: { - summaryProcess?: string; - value?: any; - totalValue?: any; - }) => void; - /** Specifies the function that determines how to split data from the data source into ranges for header items. Cannot be used for the XmlaStore store type. */ - selector?: (data: Object) => any; - /** Type of the area where the field is located. */ - area?: string; - /** Index among the other fields displayed within the same area. */ - areaIndex?: number; - /** The name of the folder in which the field is located. */ - displayFolder?: string; - /** The name of the group to which the field belongs. */ - groupName?: string; - /** The index of the field within a group. */ - groupIndex?: number; - /** Specifies the sort order of field values. */ - sortOrder?: string; - /** Specifies how field data should be sorted. Can be used for the XmlaStore store type only. */ - sortBy?: string; - /** Sorts the header items of this field by the summary values of another field. */ - sortBySummaryField?: string; - /** The array of field names that specify a path to column/row whose summary field is used for sorting of this field's header items. */ - sortBySummaryPath?: Array; - /** The filter values for the current field. */ - filterValues?: Array; - /** The filter type for the current field. */ - filterType?: string; - /** Indicates whether all header items of the field's header level are expanded. */ - expanded?: boolean; - /** Specifies whether the field should be treated as a Data Field. */ - isMeasure?: boolean; - /** Specifies a display format for field values. */ - format?: string; - /** Specifies a callback function that returns the text to be displayed in the cells of a field. */ - customizeText?: (cellInfo: { value: any; valueText: string }) => string; - /** Specifies a precision for formatted field values. */ - precision?: number; - /** Specifies how to sort the header items. */ - sortingMethod?: (a: Object, b: Object) => number; - /** Allows an end-user to change sorting options. */ - allowSorting?: boolean; - /** Allows an end-user to sort columns by summary values. */ - allowSortingBySummary?: boolean; - /** Allows an end-user to change filtering options. */ - allowFiltering?: boolean; - /** Allows an end-user to expand/collapse all header items within a header level. */ - allowExpandAll?: boolean; - /** Specifies the absolute width of the field in the pivot grid. */ - width?: number; - /** Specifies the summary post-processing algorithm. */ - summaryDisplayMode?: string; - /** Specifies whether to summarize each next summary value with the previous one by rows or columns. */ - runningTotal?: string; - /** Specifies whether to allow the predefined summary post-processing functions ('absoluteVariation' and 'percentVariation') and runningTotal to take values of different groups into account. */ - allowCrossGroupCalculation?: boolean; - /** Specifies a callback function that allows you to modify summary values after they are calculated. */ - calculateSummaryValue?: (e: Object) => number; - /** Specifies whether or not to display Total values for the field. */ - showTotals?: boolean; - /** Specifies whether or not to display Grand Total values for the field. */ - showGrandTotals?: boolean; - } - export class SummaryCell { - /** Gets the parent cell in a specified direction. */ - parent(direction: string): SummaryCell; - /** Gets all children cells in a specified direction. */ - children(direction: string): Array; - /** Gets a partial Grand Total cell of a row or column. */ - grandTotal(direction: string): SummaryCell; - /** Gets the Grand Total of the entire pivot grid. */ - grandTotal(): SummaryCell; - /** Gets the cell next to the current one in a specified direction. */ - next(direction: string): SummaryCell; - /** Gets the cell next to current in a specified direction. */ - next(direction: string, allowCrossGroup: boolean): SummaryCell; - /** Gets the cell prior to the current one in a specified direction. */ - prev(direction: string): SummaryCell; - /** Gets the cell previous to current in a specified direction. */ - prev(direction: string, allowCrossGroup: boolean): SummaryCell; - /** Gets the child cell in a specified direction. */ - child(direction: string, fieldValue: any): SummaryCell; - /** Gets the cell located by the path of the source cell with one field value changed. */ - slice(field: PivotGridField, value: any): SummaryCell; - /** Gets the header cell of a row or column field to which the current cell belongs. */ - field(area: string): PivotGridField; - /** Gets the value of the current cell. */ - value(): any; - /** Gets the value of the current cell. */ - value(isCalculatedValue: boolean): any; - /** Gets the value of any field linked with the current cell. */ - value(field: PivotGridField): any; - /** Gets the value of any field linked with the current cell. */ - value(field: PivotGridField, isCalculatedValue: boolean): any; - } - export interface PivotGridDataSourceOptions { - /** Specifies the underlying Store instance used to access data. */ - store?: any; - /** Indicates whether or not the automatic field generation from data in the Store is enabled. */ - retrieveFields?: boolean; - /** Specifies data filtering conditions. Cannot be used for the XmlaStore store type. */ - filter?: Object; - /** An array of pivot grid fields. */ - fields?: Array; - /** A handler for the changed event. */ - onChanged?: () => void; - /** A handler for the loadingChanged event. */ - onLoadingChanged?: (isLoading: boolean) => void; - /** A handler for the loadError event. */ - onLoadError?: (e?: Object) => void; - /** A handler for the fieldsPrepared event. */ - onFieldsPrepared?: (e?: Array) => void; - } - /** An object that provides access to data for the dxPivotGrid widget. */ - export class PivotGridDataSource implements EventsMixin { - constructor(options?: PivotGridDataSource); - /** Starts reloading data from any store and updating the data source. */ - reload(): JQueryPromise; - /** Starts updating the data source. Reloads data from the XMLA store only. */ - load(): JQueryPromise; - /** Indicates whether or not the PivotGridDataSource is currently being loaded. */ - isLoading(): boolean; - /** Gets data displayed in a PivotGrid. */ - getData(): Object; - /** Gets all fields within a specified area. */ - getAreaFields(area: string, collectGroups: boolean): Array; - /** Gets all fields from the data source. */ - fields(): Array; - /** Sets the fields option. */ - fields(fields: Array): void; - /** Gets current options of a specified field. */ - field(id: any): PivotGridField; - /** Sets one or more options of a specified field. */ - field(id: any, field: PivotGridField): void; - /** Collapses a specified header item. */ - collapseHeaderItem(area: string, path: Array): void; - /** Expands a specified header item. */ - expandHeaderItem(area: string, path: Array): void; - /** Expands all header items of a field. */ - expandAll(id: any): void; - /** Collapses all header items of a field. */ - collapseAll(id: any): void; - /** Disposes of all resources associated with this PivotGridDataSource. */ - dispose(): void; - /** Gets the current filter expression. Cannot be used for the XmlaStore store type. */ - filter(): Object; - /** Applies a new filter expression. Cannot be used for the XmlaStore store type. */ - filter(filterExpr: Object): void; - /** Provides access to a list of records (facts) that were used to calculate a specific summary. */ - createDrillDownDataSource(options: { - columnPath?: Array; - rowPath?: Array; - dataIndex?: number; - maxRowCount?: number; - customColumns?: Array; - }): DevExpress.data.DataSource; - /** Gets the current PivotGridDataSource state (fields configuration, sorting, filters, expanded headers, etc.) */ - state(): Object; - /** Sets the PivotGridDataSource state. */ - state(state: Object): void; - on(eventName: string, eventHandler: Function): PivotGridDataSource; - on(events: { [eventName: string]: Function; }): PivotGridDataSource; - off(eventName: string): PivotGridDataSource; - off(eventName: string, eventHandler: Function): PivotGridDataSource; - } -} -declare module DevExpress.ui { - export interface dxSchedulerOptions extends WidgetOptions { - /** Specifies a date displayed on the current scheduler view by default. */ - currentDate?: Date; - /** The earliest date the widget allows you to select. */ - min?: Date; - /** The latest date the widget allows you to select. */ - max?: Date; - /** Specifies the view used in the scheduler by default. */ - currentView?: string; - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** Specifies the first day of a week. */ - firstDayOfWeek?: number; - /** The template to be used for rendering appointments. */ - appointmentTemplate?: any; - /** The template to be used for rendering an appointment tooltip. */ - appointmentTooltipTemplate?: any; - /** Lists the views to be available within the scheduler's View Selector. */ - views?: Array; - /** Specifies the resource kinds by which the scheduler's appointments are grouped in a timetable. */ - groups?: Array; - /** Specifies a start hour in the scheduler view's time interval. */ - startDayHour?: number; - /** Specifies an end hour in the scheduler view's time interval. */ - endDayHour?: number; - /** Specifies whether or not the "All-day" panel is visible. */ - showAllDayPanel?: boolean; - /** Specifies cell duration in minutes. */ - cellDuration?: number; - /** Specifies the edit mode for recurring appointments. */ - recurrenceEditMode?: string; - /** Specifies which editing operations an end-user can perform on appointments. */ - editing?: { - /** Specifies whether or not an end-user can add appointments. */ - allowAdding?: boolean; - /** Specifies whether or not an end-user can change appointment options. */ - allowUpdating?: boolean; - /** Specifies whether or not an end-user can delete appointments. */ - allowDeleting?: boolean; - /** Specifies whether or not an end-user can change an appointment duration. */ - allowResizing?: boolean; - /** Specifies whether or not an end-user can drag appointments. */ - allowDragging?: boolean; - } - /** Specifies an array of resources available in the scheduler. */ - resources?: Array<{ - /** Indicates whether or not several resources of this kind can be assigned to an appointment. */ - allowMultiple?: boolean; - /** - * Indicates whether or not resources of this kind have priority in the color identification of the appointments that have resources of different kinds assigned. - * @deprecated Use the 'useColorAsDefault' property instead - */ - mainColor?: boolean; - /** Indicates whether or not resources of this kind have priority in the color identification of the appointments that have resources of different kinds assigned. */ - useColorAsDefault?: boolean; - /** A data source used to fetch resources to be available in the scheduler. */ - dataSource?: any; - /** Specifies the resource object field whose value is displayed by the Resource editor in the Appointment popup window. */ - displayExpr?: any; - /** Specifies the resource object field that is used as a value of the Resource editor in the Appointment popup window. */ - valueExpr?: any; - /** The name of the appointment object field that specifies a resource of this kind. */ - field?: string; - /** Specifies the label of the Appointment popup window field that allows end users to assign a resource of this kind. */ - label?: string; - }>; - /** A handler for the AppointmentAdding event. */ - onAppointmentAdding?: Function; - /** A handler for the appointmentAdded event. */ - onAppointmentAdded?: Function; - /** A handler for the AppointmentUpdating event. */ - onAppointmentUpdating?: Function; - /** A handler for the appointmentUpdated event. */ - onAppointmentUpdated?: Function; - /** A handler for the AppointmentDeleting event. */ - onAppointmentDeleting?: Function; - /** A handler for the appointmentDeleted event. */ - onAppointmentDeleted?: Function; - /** A handler for the appointmentRendered event. */ - onAppointmentRendered?: Function; - /** A handler for the appointmentClick event. */ - onAppointmentClick?: any; - /** A handler for the appointmentDblClick event. */ - onAppointmentDblClick?: any; - /** A handler for the cellClick event. */ - onCellClick?: any; - /** A handler for the appointmentFormCreated event. */ - onAppointmentFormCreated?: Function; - /** Specifies whether or not an end-user can scroll the view horizontally. */ - horizontalScrollingEnabled?: boolean; - /** Specifies whether a user can switch views using tabs or a drop-down menu. */ - useDropDownViewSwitcher?: boolean; - /** Specifies the name of the data source item field that defines the start of an appointment. */ - startDateExpr?: string; - /** Specifies the name of the data source item field that defines the ending of an appointment. */ - endDateExpr?: string; - /** Specifies the name of the data source item field that holds the subject of an appointment. */ - textExpr?: string; - /** Specifies the name of the data source item field whose value holds the description of the corresponding appointment. */ - descriptionExpr?: string; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding appointment is an all-day appointment. */ - allDayExpr?: string; - /** Specifies the name of the data source item field that defines a recurrence rule for generating recurring appointments. */ - recurrenceRuleExpr?: string; - /** Specifies the name of the data source item field that defines exceptions for the current recurring appointment. */ - recurrenceExceptionExpr?: string; - /** Specifies whether filtering is performed on the server or client side. */ - remoteFiltering?: boolean; - } - /** A widget that displays scheduled data using different views and provides the capability to load, add and edit appointments. */ - export class dxScheduler extends Widget { - constructor(element: JQuery, options?: dxSchedulerOptions); - constructor(element: Element, options?: dxSchedulerOptions); - /** Add the appointment defined by the object passed as a parameter to the data associated with the widget. */ - addAppointment(appointment: Object): void; - /** Updates the appointment specified by the first method parameter by the appointment object specified by the second method parameter in the the data associated with the widget. */ - updateAppointment(target: Object, appointment: Object): void; - /** Deletes the appointment defined by the parameter from the the data associated with the widget. */ - deleteAppointment(appointment: Object): void; - /** Scrolls the scheduler work space to the specified time of the specified day. */ - scrollToTime(hours: number, minutes: number, date: Date): void; - /** Displayes the Appointment Details popup. */ - showAppointmentPopup(appointmentData: Object, createNewAppointment?: boolean, currentAppointmentData?: Object): void; - } - export interface dxColorBoxOptions extends dxDropDownEditorOptions { - /** Specifies the text displayed on the button that applies changes and closes the drop-down editor. */ - applyButtonText?: string; - applyValueMode?: string; - /** Specifies the text displayed on the button that cancels changes and closes the drop-down editor. */ - cancelButtonText?: string; - /** Specifies whether or not the widget value includes the alpha channel component. */ - editAlphaChannel?: boolean; - /** Specifies the size of a step by which a handle is moved using a keyboard shortcut. */ - keyStep?: number; - } - /** A widget used to specify a color value. */ - export class dxColorBox extends dxDropDownEditor { - constructor(element: JQuery, options?: dxColorBoxOptions); - constructor(element: Element, options?: dxColorBoxOptions); - } - export interface HierarchicalCollectionWidgetOptions extends CollectionWidgetOptions { - /** Specifies the name of the data source item field whose value is displayed by the widget. */ - displayExpr?: any; - /** Specifies the name of the data source item field used as a key. */ - keyExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding widget items is selected. */ - selectedExpr?: any; - /** Specifies the name of the data source item field that contains an array of nested items. */ - itemsExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding widget item is disabled. */ - disabledExpr?: any; - /** Specifies the name of the data source item field that holds the key of the parent item. */ - parentIdExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding widget items is expanded. */ - expandedExpr?: any; - hoverStateEnabled?: boolean; - focusStateEnabled?: boolean; - } - export class HierarchicalCollectionWidget extends CollectionWidget { - } - export interface dxTreeViewOptions extends HierarchicalCollectionWidgetOptions { - /** Specifies whether or not to animate item collapsing and expanding. */ - animationEnabled?: boolean; - /** Specifies whether a nested or plain array is used as a data source. */ - dataStructure?: string; - /** Specifies whether or not a user can expand all tree view items by the "*" hot key. */ - expandAllEnabled?: boolean; - /** - * Specifies whether or not a check box is displayed at each tree view item. - * @deprecated Use the showCheckBoxesMode option instead. - */ - showCheckBoxes?: boolean; - /** Specifies the current check boxes display mode. */ - showCheckBoxesMode?: string; - /** Specifies whether or not to select nodes recursively. */ - selectNodesRecursive?: boolean; - /** Specifies whether or not all parent nodes of an initially expanded node are displayed expanded. */ - expandNodesRecursive?: boolean; - /** - * Specifies whether the "Select All" check box is displayed over the tree view. - * @deprecated Use the showCheckBoxesMode option instead. - */ - selectAllEnabled?: boolean; - /** Specifies the text displayed at the "Select All" check box. */ - selectAllText?: string; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding node includes child nodes. */ - hasItemsExpr?: any; - /** Specifies if the virtual mode is enabled. */ - virtualModeEnabled?: boolean; - /** Specifies the parent ID value of the root item. */ - rootValue?: any; - /** Specifies the current value used to filter tree view items. */ - searchValue?: string; - /** A string value specifying available scrolling directions. */ - scrollDirection?: string; - /** A handler for the itemSelected event. */ - onItemSelected?: Function; - /** A handler for the itemExpanded event. */ - onItemExpanded?: Function; - /** A handler for the itemCollapsed event. */ - onItemCollapsed?: Function; - onItemClick?: Function; - onItemContextMenu?: Function; - onItemRendered?: Function; - onItemHold?: Function; - } - /** A widget displaying specified data items as a tree. */ - export class dxTreeView extends HierarchicalCollectionWidget { - constructor(element: JQuery, options?: dxTreeViewOptions); - constructor(element: Element, options?: dxTreeViewOptions); - /** Updates the tree view scrollbars according to the current size of the widget content. */ - updateDimensions(): JQueryPromise; - /** Selects the specified item. */ - selectItem(itemElement: any): void; - /** Unselects the specified item. */ - unselectItem(itemElement: any): void; - /** Expands the specified item. */ - expandItem(itemElement: any): void; - /** Collapses the specified item. */ - collapseItem(itemElement: any): void; - /** Returns all nodes of the tree view. */ - getNodes(): Array; - /** Selects all widget items. */ - selectAll(): void; - /** Unselects all widget items. */ - unselectAll(): void; - } - export interface dxMenuBaseOptions extends HierarchicalCollectionWidgetOptions { - /** An object that defines the animation options of the widget. */ - animation?: fx.AnimationOptions; - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** Specifies the name of the CSS class associated with the menu. */ - cssClass?: string; - /** Holds an array of menu items. */ - items?: Array; - /** Specifies whether or not an item becomes selected if an end-user clicks it. */ - selectionByClick?: boolean; - /** Specifies the selection mode supported by the menu. */ - selectionMode?: string; - /** Specifies options of submenu showing and hiding. */ - showSubmenuMode?: { - /** Specifies the mode name. */ - name?: string; - /** Specifies the delay of submenu show and hiding. */ - delay?: { - /** The time span after which the submenu is shown. */ - show?: number; - /** The time span after which the submenu is hidden. */ - hide?: number; - }; - }; - } - export class dxMenuBase extends HierarchicalCollectionWidget { - constructor(element: JQuery, options?: dxMenuBaseOptions); - constructor(element: Element, options?: dxMenuBaseOptions); - /** Selects the specified item. */ - selectItem(itemElement: any): void; - /** Unselects the specified item. */ - unselectItem(itemElement: any): void; - } - export interface dxMenuOptions extends dxMenuBaseOptions { - /** Specifies whether or not the submenu is hidden when the mouse pointer leaves it. */ - hideSubmenuOnMouseLeave?: boolean; - /** Specifies whether the menu has horizontal or vertical orientation. */ - orientation?: string; - /** Specifies options for showing and hiding the first level submenu. */ - showFirstSubmenuMode?: { - /** Specifies the mode name. */ - name?: string; - /** Specifies the delay in submenu showing and hiding. */ - delay?: { - /** The time span after which the submenu is shown. */ - show?: number; - /** The time span after which the submenu is hidden. */ - hide?: number; - }; - }; - /** Specifies the direction at which the submenus are displayed. */ - submenuDirection?: string; - /** A handler for the submenuHidden event. */ - onSubmenuHidden?: Function; - /** A handler for the submenuHiding event. */ - onSubmenuHiding?: Function; - /** A handler for the submenuShowing event. */ - onSubmenuShowing?: Function; - /** A handler for the submenuShown event. */ - onSubmenuShown?: Function; - } - /** A menu widget. */ - export class dxMenu extends dxMenuBase { - constructor(element: JQuery, options?: dxMenuOptions); - constructor(element: Element, options?: dxMenuOptions); - } - export interface dxContextMenuOptions extends dxMenuBaseOptions { - /** Holds an object that specifies options of alternative menu invocation. */ - alternativeInvocationMode?: { - /** Specifies whether or not the standard context menu invocation (on a right mouse click or on a long tap) is disabled. */ - enabled?: Boolean; - /** Specifies the element used to invoke the context menu. */ - invokingElement?: any; - }; - /** A handler for the hidden event. */ - onHidden?: Function; - /** A handler for the hiding event. */ - onHiding?: Function; - /** A handler for the positioning event. */ - onPositioning?: Function; - /** A handler for the showing event. */ - onShowing?: Function; - /** A handler for the shown event. */ - onShown?: Function; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** Specifies the direction at which submenus are displayed. */ - submenuDirection?: string; - /** The target element associated with a popover. */ - target?: any; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - } - /** A context menu widget. */ - export class dxContextMenu extends dxMenuBase { - constructor(element: JQuery, options?: dxContextMenuOptions); - constructor(element: Element, options?: dxContextMenuOptions); - /** Toggles the visibility of the widget. */ - toggle(showing: boolean): JQueryPromise; - /** Shows the widget. */ - show(): JQueryPromise; - /** Hides the widget. */ - hide(): JQueryPromise; - } - export interface dxRemoteOperations { - /** Specifies whether or not filtering must be performed on the server side. */ - filtering?: boolean; - /** Specifies whether or not paging must be performed on the server side. */ - paging?: boolean; - /** Specifies whether or not sorting must be performed on the server side. */ - sorting?: boolean; - /** Specifies whether or not grouping must be performed on the server side. */ - grouping?: boolean; - /** Specifies whether or not summaries calculation must be performed on the server side. */ - summary?: boolean; - } - export interface dxDataGridRow { - /** The data object represented by the row. */ - data: Object; - /** The key of the data object represented by the row. */ - key: any; - /** The visible index of the row. */ - rowIndex: number; - /** The type of the row. */ - rowType: string; - } - export interface dxDataGridColumn { - /** Specifies the content alignment within column cells. */ - alignment?: string; - /** Specifies whether the values in a column can be edited at runtime. Setting this option makes sense only when editing is enabled for a grid. */ - allowEditing?: boolean; - /** Specifies whether or not a column can be used for filtering grid records. Setting this option makes sense only when the filter row and column header filtering are visible. */ - allowFiltering?: boolean; - /** Specifies whether or not to allow filtering by this column using its header. */ - allowHeaderFiltering?: boolean; - /** Specifies whether or not the column can be anchored to a grid edge by end users. Setting this option makes sense only when the columnFixing | enabled option is set to true. */ - allowFixing?: boolean; - /** Specifies if a column can be used for searching grid records. Setting this option makes sense only when the search panel is visible. */ - allowSearch?: boolean; - /** Specifies whether a column can be used for grouping grid records at runtime. Setting this option makes sense only when the group panel is visible. */ - allowGrouping?: boolean; - /** Specifies whether or not a column can be hidden by a user. Setting this option makes sense only when the column chooser is visible. */ - allowHiding?: boolean; - /** Specifies whether or not a particular column can be used in column reordering. Setting this option makes sense only when the allowColumnReordering option is set to true. */ - allowReordering?: boolean; - /** Specifies whether or not a particular column can be resized by a user. Setting this option makes sense only when the allowColumnResizing option is true. */ - allowResizing?: boolean; - /** Specifies whether grid records can be sorted by a specific column at runtime. Setting this option makes sense only when the sorting mode differs from none. */ - allowSorting?: boolean; - /** Specifies whether groups appear expanded or not when records are grouped by a specific column. Setting this option makes sense only when grouping is allowed for this column. */ - autoExpandGroup?: boolean; - /** Specifies a callback function that returns a value to be displayed in a column cell. */ - calculateCellValue?: (rowData: Object) => string; - /** Specifies a callback function to be invoked after the cell value is edited by an end-user and before the new value is saved to the data source. */ - setCellValue?: (rowData: Object, value: any) => void; - /** Specifies a callback function that defines filters for customary calculated grid cells. */ - calculateFilterExpression?: (filterValue: any, selectedFilterOperation: string, target: string) => Array; - /** Specifies a caption for a column. */ - caption?: string; - /** Specifies a custom template for grid column cells. */ - cellTemplate?: any; - /** Specifies a CSS class to be applied to a column. */ - cssClass?: string; - /** Specifies how to get a value to be displayed in a cell when it is not in an editing state. */ - calculateDisplayValue?: any; - /** Specifies a field name or a function that returns a field name or a value to be used for grouping column cells. */ - calculateGroupValue?: any; - /** Specifies a field name or a function that returns a field name or a value to be used for sorting column cells. */ - calculateSortValue?: any; - /** Specifies a callback function that returns the text to be displayed in the cells of a column. */ - customizeText?: (cellInfo: { value: any; valueText: string }) => string; - /** Specifies the field of a data source that provides data for a column. */ - dataField?: string; - /** Specifies the required type of column values. */ - dataType?: string; - /** Specifies a custom template for the cell of a grid column when it is in an editing state. */ - editCellTemplate?: any; - /** Specifies configuration options for the editor widget of the current column. */ - editorOptions?: Object; - /** Specifies whether HTML tags are displayed as plain text or applied to the values of the column. */ - encodeHtml?: boolean; - /** In a boolean column, replaces all false items with a specified text. */ - falseText?: string; - /** Specifies the set of available filter operations. */ - filterOperations?: Array; - /** Specifies a filter value for a column. */ - filterValue?: any; - /** Specifies initial filter values for the column's header filter. */ - filterValues?: Array; - /** Specifies whether to include or exclude the records with the values selected in the column's header filter. */ - filterType?: string; - /** Indicates whether the column takes part in horizontal grid scrolling or is anchored to a grid edge. */ - fixed?: boolean; - /** Specifies the grid edge to which the column is anchored. */ - fixedPosition?: string; - /** Specifies a format for the values displayed in a column. */ - format?: string; - /** Specifies a custom template for the group cell of a grid column. */ - groupCellTemplate?: any; - /** Specifies the index of a column when grid records are grouped by the values of this column. */ - groupIndex?: number; - /** Specifies a custom template for the header of a grid column. */ - headerCellTemplate?: any; - /** Specifies options of a lookup column. */ - lookup?: { - /** Specifies whether or not a user can nullify values of a lookup column. */ - allowClearing?: boolean; - /** Specifies the data source providing data for a lookup column. */ - dataSource?: any; - /** Specifies the expression defining the data source field whose values must be displayed. */ - displayExpr?: any; - /** Specifies the expression defining the data source field whose values must be replaced. */ - valueExpr?: string; - }; - /** Specifies column-level options for filtering using a column header filter. */ - headerFilter?: { - /** Specifies the data source to be used for the header filter. */ - dataSource?: any; - /** Specifies how header filter values should be combined into groups. */ - groupInterval?: any; - }; - /** Specifies a precision for formatted values displayed in a column. */ - precision?: number; - /** Specifies a filter operation applied to a column. */ - selectedFilterOperation?: string; - /** Specifies whether or not the column displays its values by using editors. */ - showEditorAlways?: boolean; - /** Specifies whether or not to display the column when grid records are grouped by it. */ - showWhenGrouped?: boolean; - /** Specifies the index of a column when grid records are sorted by the values of this column. */ - sortIndex?: number; - /** Specifies the initial sort order of column values. */ - sortOrder?: string; - /** In a boolean column, replaces all true items with a specified text. */ - trueText?: string; - /** Specifies whether a column is visible or not. */ - visible?: boolean; - /** Specifies the sequence number of the column in the grid. */ - visibleIndex?: number; - /** Specifies a column width in pixels or percentages. */ - width?: any; - /** Specifies an array of validation rules to be checked when updating column cell values. */ - validationRules?: Array; - /** Specifies whether or not to display the header of a hidden column in the column chooser. */ - showInColumnChooser?: boolean; - /** Specifies the identifier of the column. */ - name?: string; - /** The form item configuration object. Used only when the editing mode is "form". */ - formItem?: DevExpress.ui.dxFormItem; - } - export interface dxDataGridOptions extends WidgetOptions { - /** Specifies whether the outer borders of the grid are visible or not. */ - showBorders?: boolean; - /** Indicates whether to show the error row for the grid. */ - errorRowEnabled?: boolean; - /** A handler for the rowValidating event. */ - onRowValidating?: (e: Object) => void; - /** A handler for the contextMenuPreparing event. */ - onContextMenuPreparing?: (e: Object) => void; - /** A handler for the initNewRow event. */ - onInitNewRow?: (e: { data: Object }) => void; - /** A handler for the rowInserted event. */ - onRowInserted?: (e: { data: Object; key: any }) => void; - /** A handler for the rowInserting event. */ - onRowInserting?: (e: { data: Object; cancel: any }) => void; - /** A handler for the rowRemoved event. */ - onRowRemoved?: (e: { data: Object; key: any }) => void; - /** A handler for the rowRemoving event. */ - onRowRemoving?: (e: { data: Object; key: any; cancel: any }) => void; - /** A handler for the rowUpdated event. */ - onRowUpdated?: (e: { data: Object; key: any }) => void; - /** A handler for the rowUpdating event. */ - onRowUpdating?: (e: { oldData: Object; newData: Object; key: any; cancel: any }) => void; - /** Enables a hint that appears when a user hovers the mouse pointer over a cell with truncated content. */ - cellHintEnabled?: boolean; - /** Specifies whether or not grid columns can be reordered by a user. */ - allowColumnReordering?: boolean; - /** Specifies whether or not grid columns can be resized by a user. */ - allowColumnResizing?: boolean; - /** A handler for the cellClick event. */ - onCellClick?: any; - /** A handler for the cellHoverChanged event. */ - onCellHoverChanged?: (e: Object) => void; - /** A handler for the cellPrepared event. */ - onCellPrepared?: (e: Object) => void; - /** Specifies whether or not the width of grid columns depends on column content. */ - columnAutoWidth?: boolean; - /** Specifies the options of a column chooser. */ - columnChooser?: { - /** Specifies text displayed by the column chooser panel when it does not contain any columns. */ - emptyPanelText?: string; - /** Specifies whether a user can invoke the column chooser or not. */ - enabled?: boolean; - /** Specifies the height of the column chooser panel. */ - height?: number; - /** Specifies text displayed in the title of the column chooser panel. */ - title?: string; - /** Specifies the width of the column chooser panel. */ - width?: number; - }; - /** Specifies options for column fixing. */ - columnFixing?: { - /** Indicates if column fixing is enabled. */ - enabled?: boolean; - /** Contains options that specify texts for column-fixing related commands in the column header's context menu. */ - texts?: { - /** Specifies text for a context menu item that fixes the column for which the context menu is invoked. */ - fix?: string; - /** Specifies text for a context menu item that unfixes the column for which the context menu is invoked. */ - unfix?: string; - /** Specifies text for a context menu subitem that fixes a column, for which the context menu is invoked, to the left grid edge. */ - leftPosition?: string; - /** Specifies text for a context menu subitem that fixes a column, for which the context menu is invoked, to the right grid edge. */ - rightPosition?: string; - }; - }; - /** Specifies options for filtering using a column header filter. */ - headerFilter?: { - /** Indicates whether or not the column header filter button is visible. */ - visible?: boolean; - /** Specifies the height of the dropdown menu invoked when using a column header filter. */ - height?: number; - /** Specifies the width of the dropdown menu invoked when using a column header filter. */ - width?: number; - /** Contains options that specify texts for the dropdown menu invoked when you use a column header filter. */ - texts?: { - /** Specifies text for the item specifying an empty value in the column header filter's dropdown menu. */ - emptyValue?: string; - /** Specifies text for a button that closes the column header filter's dropdown menu and applies specified filtering. */ - ok?: string; - /** Specifies text for a button that closes the column header filter's dropdown menu without applying performed selection. */ - cancel?: string; - } - }; - /** An array of grid columns. */ - columns?: Array; - onContentReady?: Function; - /** Specifies a function that customizes grid columns after they are created. */ - customizeColumns?: (columns: Array) => void; - /** Specifies a data source for the grid. */ - dataSource?: any; - /** Specifies whether or not to enable data caching. */ - cacheEnabled?: boolean; - /** A handler for the editingStart event. */ - onEditingStart?: (e: { - data: Object; - key: any; - cancel: boolean; - column: dxDataGridColumn - }) => void; - /** A handler for the editorPrepared event. */ - onEditorPrepared?: (e: Object) => void; - /** A handler for the editorPreparing event. */ - onEditorPreparing?: (e: Object) => void; - /** Contains options that specify how grid content can be changed. */ - editing?: { - editMode?: string; - editEnabled?: boolean; - insertEnabled?: boolean; - removeEnabled?: boolean; - /** Specifies how grid values can be edited manually. */ - mode?: string; - /** Specifies whether or not grid records can be edited at runtime. */ - allowUpdating?: boolean; - /** Specifies whether or not new grid records can be added at runtime. */ - allowAdding?: boolean; - /** Specifies whether or not grid records can be deleted at runtime. */ - allowDeleting?: boolean; - /** The form configuration object. Used only when the editing mode is "form". */ - form?: DevExpress.ui.dxFormOptions; - /** Contains options that specify texts for editing-related grid controls. */ - texts?: { - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Save" button. Setting this option makes sense only when the editMode option is set to batch. */ - saveAllChanges?: string; - /** Specifies text for a cancel button displayed when a row is in the editing state. Setting this option makes sense only when the allowUpdating option is set to true. */ - cancelRowChanges?: string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Revert" button. Setting this option makes sense only when the editMode option is set to batch. */ - cancelAllChanges?: string; - /** Specifies a message to be displayed by a confirmation window. Setting this option makes sense only when the edit mode is "row". */ - confirmDeleteMessage?: string; - /** Specifies text to be displayed in the title of a confirmation window. Setting this option makes sense only when the edit mode is "row". */ - confirmDeleteTitle?: string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Cancel changes" button. Setting this option makes sense only when the editMode option is set to cell and the validation capabilities are enabled. */ - validationCancelChanges?: string; - /** Specifies text for a button that deletes a row from a grid. Setting this option makes sense only when the allowDeleting option is set to true. */ - deleteRow?: string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Add" button. Setting this option makes sense only when the allowAdding option is true. */ - addRow?: string; - /** Specifies text for a button that turns a row into the editing state. Setting this option makes sense only when the allowUpdating option is set to true. */ - editRow?: string; - /** Specifies text for a save button displayed when a row is in the editing state. Setting this option makes sense only when the allowUpdating option is set to true. */ - saveRowChanges?: string; - /** Specifies text for a button that recovers a deleted row. Setting this option makes sense only if the grid uses the batch edit mode and the allowDeleting option is set to true. */ - undeleteRow?: string; - }; - }; - /** Specifies filter row options. */ - filterRow?: { - /** Specifies when to apply a filter. */ - applyFilter?: string; - /** Specifies text for the hint that pops up when a user hovers the mouse pointer over the "Apply Filter" button. */ - applyFilterText?: string; - /** Specifies descriptions for filter operations. */ - operationDescriptions?: { - "=": string; - "<>": string; - "<": string; - "<=": string; - ">": string; - ">=": string; - "startswith": string; - "contains": string; - "notcontains": string; - "endswith": string; - }; - /** Specifies text for the reset operation in a filter list. */ - resetOperationText?: string; - /** Specifies text for the operation of clearing the applied filter when a select box is used. */ - showAllText?: string; - /** Specifies text for the range start in the 'between' filter type. */ - betweenStartText?: string; - /** Specifies text for the range end in the 'between' filter type. */ - betweenEndText?: string; - /** Specifies whether or not an icon that allows the user to choose a filter operation is visible. */ - showOperationChooser?: boolean; - /** Specifies whether the filter row is visible or not. */ - visible?: boolean; - }; - /** Specifies the behavior of grouped grid records. */ - grouping?: { - /** Specifies whether the user can collapse grouped records in a grid or not. */ - allowCollapsing?: boolean; - /** Specifies whether groups appear expanded or not. */ - autoExpandAll?: boolean; - /** Specifies the message displayed in a group row when the corresponding group is continued from the previous page. */ - groupContinuedMessage?: string; - /** Specifies the message displayed in a group row when the corresponding group continues on the next page. */ - groupContinuesMessage?: string; - }; - /** Specifies options that configure the group panel. */ - groupPanel?: { - /** Specifies whether columns can be dragged onto or from the group panel. */ - allowColumnDragging?: boolean; - /** Specifies text displayed by the group panel when it does not contain any columns. */ - emptyPanelText?: string; - /** Specifies whether the group panel is visible or not. */ - visible?: boolean; - }; - /** Specifies options configuring the load panel. */ - loadPanel?: { - /** Specifies whether to show the load panel or not. */ - enabled?: boolean; - /** Specifies the height of the load panel in pixels. */ - height?: number; - /** Specifies a URL pointing to an image to be used as a loading indicator. */ - indicatorSrc?: string; - /** Specifies whether or not a loading indicator must be displayed on the load panel. */ - showIndicator?: boolean; - /** Specifies whether or not the pane of the load panel must be displayed. */ - showPane?: boolean; - /** Specifies text displayed by the load panel. */ - text?: string; - /** Specifies the width of the load panel in pixels. */ - width?: number; - }; - /** Specifies text displayed when a grid does not contain any records. */ - noDataText?: string; - /** Specifies the options of a grid pager. */ - pager?: { - /** Specifies the page sizes that can be selected at runtime. */ - allowedPageSizes?: any; - /** Specifies whether to show the page size selector or not. */ - showPageSizeSelector?: boolean; - /** Specifies whether to show the pager or not. */ - visible?: any; - /** Specifies the text accompanying the page navigator. */ - infoText?: string; - /** Specifies whether or not to display the text accompanying the page navigator. This text is specified by the infoText option. */ - showInfo?: boolean; - /** Specifies whether or not to display buttons that switch the grid to the previous or next page. */ - showNavigationButtons?: boolean; - }; - /** Specifies paging options. */ - paging?: { - /** Specifies whether dxDataGrid loads data page by page or all at once. */ - enabled?: boolean; - /** Specifies the grid page that should be displayed by default. */ - pageIndex?: number; - /** Specifies the size of grid pages. */ - pageSize?: number; - }; - /** Specifies whether or not grid rows must be shaded in a different way. */ - rowAlternationEnabled?: boolean; - /** Specifies whether to enable two-way data binding. */ - twoWayBindingEnabled?: boolean; - /** A handler for the rowClick event. */ - onRowClick?: any; - /** A handler for the rowPrepared event. */ - onRowPrepared?: (e: Object) => void; - /** Specifies a custom template for grid rows. */ - rowTemplate?: any; - /** A configuration object specifying scrolling options. */ - scrolling?: { - /** Specifies the scrolling mode. */ - mode?: string; - /** Specifies whether or not a grid must preload pages adjacent to the current page when using virtual scrolling. */ - preloadEnabled?: boolean; - /** Specifies whether or not the widget uses native scrolling. */ - useNative?: any; - /** Specifies the scrollbar display policy. */ - showScrollbar?: string; - /** Specifies whether or not the scrolling by content is enabled. */ - scrollByContent?: boolean; - /** Specifies whether or not the scrollbar thumb scrolling enabled. */ - scrollByThumb?: boolean; - }; - /** Specifies options of the search panel. */ - searchPanel?: { - /** Specifies whether or not search strings in the located grid records should be highlighted. */ - highlightSearchText?: boolean; - /** Specifies text displayed by the search panel when no search string was typed. */ - placeholder?: string; - /** Specifies whether the search panel is visible or not. */ - visible?: boolean; - /** Specifies the width of the search panel in pixels. */ - width?: number; - /** Sets a search string for the search panel. */ - text?: string; - }; - /** Specifies the operations that must be performed on the server side. */ - remoteOperations?: any; - /** Allows you to sort groups according to the values of group summary items. */ - sortByGroupSummaryInfo?: Array<{ - /** Specifies the group summary item whose values must be used to sort groups. */ - summaryItem?: string; - /** Specifies the identifier of the column that must be used in grouping so that sorting by group summary item values be applied. */ - groupColumn?: string; - /** Specifies the sort order of group summary item values. */ - sortOrder?: string; - }>; - /** Allows you to build a master-detail interface in the grid. */ - masterDetail?: { - /** Enables an end-user to expand/collapse detail sections. */ - enabled?: boolean; - /** Specifies whether detail sections appear expanded or collapsed. */ - autoExpandAll?: boolean; - /** Specifies the template for detail sections. */ - template?: any; - }; - /** Specifies options for exporting grid data. */ - export?: { - /** Indicates if the export feature is enabled in the grid. */ - enabled?: boolean; - /** Specifies a default name for the file to which grid data is exported. */ - fileName?: string; - /** Specifies whether to enable Excel filtering for the exported data in the resulting XLSX file. */ - excelFilterEnabled?: boolean; - /** Specifies whether to enable word wrapping for the exported data in the resulting XLSX file. */ - excelWrapTextEnabled?: boolean; - /** Specifies the URL of the server-side proxy that streams the resulting file to the end user to enable export in IE8, IE9 and Safari browsers. */ - proxyUrl?: string; - /** Indicates whether to allow end users to export not only the data displayed in the grid, but the selected rows only. */ - allowExportSelectedData?: boolean; - /** Contains options that specify texts for the export-related commands and hints. */ - texts?: { - /** Specifies text for the Export button when this button invokes a dropdown menu so you can choose the required export format. */ - exportTo?: string; - /** Specifies text for the Export button's hint when this button exports to the XSLX format without invoking the drop-down menu. */ - exportToExcel?: string; - /** Specifies text for the item in the Export dropdown menu that exports grid data to Excel. */ - excelFormat?: string; - /** Specifies text for the option in the Export dropdown menu that allows you to choose whether to export all the grid data or the selected rows only. */ - selectedRows?: string; - } - }; - /** Specifies the keys of the records that must appear selected initially. */ - selectedRowKeys?: Array; - /** Specifies options of runtime selection. */ - selection?: { - /** Specifies the checkbox row display policy in the multiple mode. */ - showCheckBoxesMode?: string; - /** Specifies whether the user can select all grid records at once. */ - allowSelectAll?: boolean; - /** Specifies the selection mode. */ - mode?: string; - }; - /** A handler for the dataErrorOccured event. */ - onDataErrorOccurred?: (e: { error: Error }) => void; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: (e: { - currentSelectedRowKeys: Array; - currentDeselectedRowKeys: Array; - selectedRowKeys: Array; - selectedRowsData: Array; - }) => void; - /** A handler for the exporting event. */ - onExporting?: (e: { - fileName: string; - cancel: boolean; - }) => void; - /** A handler for the fileSaving event. */ - onFileSaving?: (e: { - fileName: string; - format: string; - data: any; - cancel: boolean; - }) => void; - /** A handler for the exported event. */ - onExported?: (e: Object) => void; - /** A handler for the keyDown event. */ - onKeyDown?: (e: Object) => void; - /** A handler for the rowExpanding event. */ - onRowExpanding?: (e: Object) => void; - /** A handler for the rowExpanded event. */ - onRowExpanded?: (e: Object) => void; - /** A handler for the rowCollapsing event. */ - onRowCollapsing?: (e: Object) => void; - /** A handler for the rowCollapsed event. */ - onRowCollapsed?: (e: Object) => void; - /** Specifies whether column headers are visible or not. */ - showColumnHeaders?: boolean; - /** Specifies whether or not vertical lines separating one grid column from another are visible. */ - showColumnLines?: boolean; - /** Specifies whether or not horizontal lines separating one grid row from another are visible. */ - showRowLines?: boolean; - /** Specifies options of runtime sorting. */ - sorting?: { - /** Specifies text for the context menu item that sets an ascending sort order in a column. */ - ascendingText?: string; - /** Specifies text for the context menu item that resets sorting settings for a column. */ - clearText?: string; - /** Specifies text for the context menu item that sets a descending sort order in a column. */ - descendingText?: string; - /** Specifies the runtime sorting mode. */ - mode?: string; - }; - /** Specifies options of state storing. */ - stateStoring?: { - /** Specifies a callback function that performs specific actions on state loading. */ - customLoad?: () => JQueryPromise; - /** Specifies a callback function that performs specific actions on state saving. */ - customSave?: (state: Object) => void; - /** Specifies whether or not a grid saves its state. */ - enabled?: boolean; - /** Specifies the delay between the last change of a grid state and the operation of saving this state in milliseconds. */ - savingTimeout?: number; - /** Specifies a unique key to be used for storing the grid state. */ - storageKey?: string; - /** Specifies the type of storage to be used for state storing. */ - type?: string; - }; - /** Specifies the options of the grid summary. */ - summary?: { - /** Contains options that specify text patterns for summary items. */ - texts?: { - /** Specifies a pattern for the 'sum' summary items when they are displayed in the parent column. */ - sum?: string; - /** Specifies a pattern for the 'sum' summary items displayed in a group row or in any other column rather than the parent one. */ - sumOtherColumn?: string; - /** Specifies a pattern for the 'min' summary items when they are displayed in the parent column. */ - min?: string; - /** Specifies a pattern for the 'min' summary items displayed in a group row or in any other column rather than the parent one. */ - minOtherColumn?: string; - /** Specifies a pattern for the 'max' summary items when they are displayed in the parent column. */ - max?: string; - /** Specifies a pattern for the 'max' summary items displayed in a group row or in any other column rather than the parent one. */ - maxOtherColumn?: string; - /** Specifies a pattern for the 'avg' summary items when they are displayed in the parent column. */ - avg?: string; - /** Specifies a pattern for the 'avg' summary items displayed in a group row or in any other column rather than the parent one. */ - avgOtherColumn?: string; - /** Specifies a pattern for the 'count' summary items. */ - count?: string; - }; - /** Specifies items of the group summary. */ - groupItems?: Array<{ - /** Specifies the identifier of a summary item. */ - name?: string; - /** Specifies the column that provides data for a group summary item. */ - column?: string; - /** Customizes the text to be displayed in the summary item. */ - customizeText?: (itemInfo: { - value: any; - valueText: string; - }) => string; - /** Specifies a pattern for the summary item text. */ - displayFormat?: string; - /** Specifies a precision for the summary item value of a numeric format. */ - precision?: number; - /** Specifies whether or not a summary item must be displayed in the group footer. */ - showInGroupFooter?: boolean; - /** Indicates whether to display group summary items in parentheses after the group row header or to align them by the corresponding columns within the group row. */ - alignByColumn?: boolean; - /** Specifies the column that must hold the summary item when this item is displayed in the group footer or aligned by a column in the group row. */ - showInColumn?: string; - /** Specifies how to aggregate data for a summary item. */ - summaryType?: string; - /** Specifies a format for the summary item value. */ - valueFormat?: string; - /** Specifies whether or not to skip empty strings, null and undefined values when calculating a summary. */ - skipEmptyValues?: boolean; - }>; - /** Specifies items of the total summary. */ - totalItems?: Array<{ - /** Specifies the identifier of a summary item. */ - name?: string; - /** Specifies the alignment of a summary item. */ - alignment?: string; - /** Specifies the column that provides data for a summary item. */ - column?: string; - /** Specifies a CSS class to be applied to a summary item. */ - cssClass?: string; - /** Customizes the text to be displayed in the summary item. */ - customizeText?: (itemInfo: { - value: any; - valueText: string; - }) => string; - /** Specifies a pattern for the summary item text. */ - displayFormat?: string; - /** Specifies a precision for the summary item value of a numeric format. */ - precision?: number; - /** Specifies the column that must hold the summary item. */ - showInColumn?: string; - /** Specifies how to aggregate data for a summary item. */ - summaryType?: string; - /** Specifies a format for the summary item value. */ - valueFormat?: string; - /** Specifies whether or not to skip empty strings, null and undefined values when calculating a summary. */ - skipEmptyValues?: boolean; - }>; - /** Specifies whether or not to skip empty strings, null and undefined values when calculating a summary. */ - skipEmptyValues?: boolean; - /** Allows you to use a custom aggregate function to calculate the value of a summary item. */ - calculateCustomSummary?: (options: { - component: dxDataGrid; - name?: string; - value: any; - totalValue: any; - summaryProcess: string - }) => void; - }; - /** Specifies whether text that does not fit into a column should be wrapped. */ - wordWrapEnabled?: boolean; - } - /** A data grid widget. */ - export class dxDataGrid extends Widget { - constructor(element: JQuery, options?: dxDataGridOptions); - constructor(element: Element, options?: dxDataGridOptions); - /** Ungroups grid records. */ - clearGrouping(): void; - /** Clears sorting settings of all grid columns at once. */ - clearSorting(): void; - /** Allows you to obtain a cell by its row index and the data field of its column. */ - getCellElement(rowIndex: number, dataField: string): any; - /** Allows you to obtain a cell by its row index and the visible index of its column. */ - getCellElement(rowIndex: number, visibleColumnIndex: number): any; - /** Returns the current state of the grid. */ - state(): Object; - /** Sets the grid state. */ - state(state: Object): void; - /** Allows you to obtain the row index by a data key. */ - getRowIndexByKey(key: any): number; - /** Allows you to obtain the data key by a row index. */ - getKeyByRowIndex(rowIndex: number): any; - /** Adds a new column to a grid. */ - addColumn(columnOptions: dxDataGridColumn): void; - /** Removes the column from the grid. */ - deleteColumn(id: any): void; - /** Displays the load panel. */ - beginCustomLoading(messageText: string): void; - /** Discards changes made in a grid. */ - cancelEditData(): void; - /** Checks whether or not the grid contains unsaved changes. */ - hasEditData(): boolean; - /** Clears all the filters of a specific type applied to grid records. */ - clearFilter(): void; - /** Deselects all grid records. */ - clearSelection(): void; - /** Draws the cell being edited from the editing state. Use this method when the edit mode is batch. */ - closeEditCell(): void; - /** Collapses groups or master rows in a grid. */ - collapseAll(groupIndex?: number): void; - /** Returns the number of data columns in a grid. */ - columnCount(): number; - /** Returns the value of a specific column option. */ - columnOption(id: any, optionName: string): any; - /** Sets an option of a specific column. */ - columnOption(id: any, optionName: string, optionValue: any): void; - /** Returns the options of a column by an identifier. */ - columnOption(id: any): Object; - /** Sets several options of a column at once. */ - columnOption(id: any, options: Object): void; - /** Sets a specific cell into the editing state. */ - editCell(rowIndex: number, visibleColumnIndex: number): void; - /** Sets a specific cell into the editing state. */ - editCell(rowIndex: number, dataField: string): void; - /** Sets a specific row into the editing state. */ - editRow(rowIndex: number): void; - /** Gets the cell value. */ - cellValue(rowIndex: number, dataField: string): any; - /** Gets the cell value. */ - cellValue(rowIndex: number, visibleColumnIndex: number): any; - /** Sets the cell value. */ - cellValue(rowIndex: number, dataField: string, value: any): void; - /** Sets the cell value. */ - cellValue(rowIndex: number, visibleColumnIndex: number, value: any): void; - /** Hides the load panel. */ - endCustomLoading(): void; - /** Expands groups or master rows in a grid. */ - expandAll(groupIndex: number): void; - /** Allows you to find out whether a specific group or master row is expanded or collapsed. */ - isRowExpanded(key: any): boolean; - /** Allows you to expand a specific group or master row by its key. */ - expandRow(key: any): void; - /** Allows you to collapse a specific group or master row by its key. */ - collapseRow(key: any): void; - /** Applies a filter to the grid's data source. */ - filter(filterExpr?: any): void; - /** Returns a filter expression applied to the grid's data source using the filter(filterExpr) method. */ - filter(): any; - /** Returns a filter expression applied to the grid using all possible scenarious. */ - getCombinedFilter(): any; - /** Gets the keys of currently selected grid records. */ - getSelectedRowKeys(): Array; - /** Gets the data objects of currently selected grid records. */ - getSelectedRowsData(): Array; - /** Hides the column chooser panel. */ - hideColumnChooser(): void; - /** Adds a new data row to a grid. */ - addRow(): void; - /** - * Adds a new data row to a grid. - * @deprecated Use the addRow() method instead. - */ - insertRow(): void; - /** Returns the key corresponding to the passed data object. */ - keyOf(obj: Object): any; - /** Switches a grid to a specified page. */ - pageIndex(newIndex: number): void; - /** Gets the index of the current page. */ - pageIndex(): number; - /** Sets the page size. */ - pageSize(value: number): void; - /** Gets the current page size. */ - pageSize(): number; - /** Refreshes grid data. */ - refresh(): void; - /** Removes a specific row from a grid. */ - deleteRow(rowIndex: number): void; - /** - * Removes a specific row from a grid. - * @deprecated Use the deleteRow() method instead. - */ - removeRow(rowIndex: number): void; - /** Saves changes made in a grid. */ - saveEditData(): void; - /** Searches grid records by a search string. */ - searchByText(text: string): void; - /** Selects all grid records. */ - selectAll(): void; - /** Deselects the rows that are currently selected within the applied filter. */ - deselectAll(): void; - /** Selects specific grid records. */ - selectRows(keys: Array, preserve: boolean): void; - /** Deselects specific grid records. */ - deselectRows(keys: Array): void; - /** Selects grid rows by indexes. */ - selectRowsByIndexes(indexes: Array): void; - /** Allows you to find out whether a row is selected or not. */ - isRowSelected(key: any): boolean; - /** Invokes the column chooser panel. */ - showColumnChooser(): void; - startSelectionWithCheckboxes(): boolean; - /** Returns the number of records currently held by a grid. */ - totalCount(): number; - /** Recovers a row deleted in the batch edit mode. */ - undeleteRow(rowIndex: number): void; - /** Allows you to obtain a data object by its key. */ - byKey(key: any): JQueryPromise; - /** Gets the value of a total summary item. */ - getTotalSummaryValue(summaryItemName: string): any; - /** Exports grid data to Excel. */ - exportToExcel(selectionOnly: boolean): void; - /** Updates the grid to the size of its content. */ - updateDimensions(): void; - /** Focuses the specified cell element in the grid. */ - focus(element?: JQuery): void; - } - export interface dxPivotGridOptions extends WidgetOptions { - onContentReady?: Function; - /** Specifies a data source for the pivot grid. */ - dataSource?: any; - useNativeScrolling?: any; - /** A configuration object specifying scrolling options. */ - scrolling?: { - /** Specifies the scrolling mode. */ - mode?: string; - /** Specifies whether or not the widget uses native scrolling. */ - useNative?: any; - }; - /** Allows an end-user to change sorting options. */ - allowSorting?: boolean; - /** Allows an end-user to sort columns by summary values. */ - allowSortingBySummary?: boolean; - /** Allows an end-user to change filtering options. */ - allowFiltering?: boolean; - /** Allows an end-user to expand/collapse all header items within a header level. */ - allowExpandAll?: boolean; - /** Specifies whether to display the Total rows. */ - showRowTotals?: boolean; - /** Specifies whether to display the Grand Total row. */ - showRowGrandTotals?: boolean; - /** Specifies whether to display the Total columns. */ - showColumnTotals?: boolean; - /** Specifies whether to display the Grand Total column. */ - showColumnGrandTotals?: boolean; - /** Specifies whether or not to hide rows and columns with no data. */ - hideEmptySummaryCells?: boolean; - /** Specifies where to show the total rows or columns. */ - showTotalsPrior?: string; - /** Specifies whether the outer borders of the grid are visible or not. */ - showBorders?: boolean; - /** The Field Chooser configuration options. */ - fieldChooser?: { - /** Enables or disables the field chooser. */ - enabled?: boolean; - /** Specifies the field chooser layout. */ - layout?: number; - /** Specifies the text to display as a title of the field chooser popup window. */ - title?: string; - /** Specifies the field chooser width. */ - width?: number; - /** Specifies the field chooser height. */ - height?: number; - /** Strings that can be changed or localized in the pivot grid's integrated Field Chooser. */ - texts?: { - /** The string to display instead of Row Fields. */ - rowFields?: string; - /** The string to display instead of Column Fields. */ - columnFields?: string; - /** The string to display instead of Data Fields. */ - dataFields?: string; - /** The string to display instead of Filter Fields. */ - filterFields?: string; - /** The string to display instead of All Fields. */ - allFields?: string; - }; - } - /** Strings that can be changed or localized in the dxPivotGrid widget. */ - texts?: { - /** The string to display as a header of the Grand Total row and column. */ - grandTotal?: string; - /** The string to display as a header of the Total row and column. */ - total?: string; - /** Specifies the text displayed when a pivot grid does not contain any fields. */ - noData?: string; - /** The string to display as a Show Field Chooser context menu item. */ - showFieldChooser?: string; - /** The string to display as an Expand All context menu item. */ - expandAll?: string; - /** The string to display as a Collapse All context menu item. */ - collapseAll?: string; - /** The string to display as a Sort Column by Summary Value context menu item. */ - sortColumnBySummary?: string; - /** The string to display as a Sort Row by Summary Value context menu item. */ - sortRowBySummary?: string; - /** The string to display as a Remove All Sorting context menu item. */ - removeAllSorting?: string; - /** The string to display as an Export to Excel file context menu item. */ - exportToExcel?: string; - }; - /** Specifies options configuring the load panel. */ - loadPanel?: { - /** Enables or disables the load panel. */ - enabled?: boolean; - /** Specifies the height of the load panel. */ - height?: number; - /** Specifies the URL pointing to an image that will be used as a load indicator. */ - indicatorSrc?: string; - /** Specifies whether or not to show a load indicator. */ - showIndicator?: boolean; - /** Specifies whether or not to show load panel background. */ - showPane?: boolean; - /** Specifies the text to display inside a load panel. */ - text?: string; - /** Specifies the width of the load panel. */ - width?: number; - }; - /** A handler for the cellClick event. */ - onCellClick?: (e: any) => void; - /** A handler for the cellPrepared event. */ - onCellPrepared?: (e: any) => void; - /** A handler for the contextMenuPreparing event. */ - onContextMenuPreparing?: (e: Object) => void; - /** Specifies options for exporting pivot grid data. */ - export?: { - /** Indicates whether the export feature is enabled for the pivot grid. */ - enabled?: boolean; - /** Specifies a default name for the file to which grid data is exported. */ - fileName?: string; - /** Specifies the URL of the server-side proxy that streams the resulting file to the end user to enable export in IE8, IE9 and Safari browsers. */ - proxyUrl?: string; - }; - /** A handler for the exporting event. */ - onExporting?: (e: { - fileName: string; - cancel: boolean; - }) => void; - /** A handler for the fileSaving event. */ - onFileSaving?: (e: { - fileName: string; - format: string; - data: any; - cancel: boolean; - }) => void; - /** A handler for the exported event. */ - onExported?: (e: Object) => void; - /** A configuration object specifying options related to state storing. */ - stateStoring?: { - /** Specifies a callback function that performs specific actions on state loading. */ - customLoad?: () => JQueryPromise; - /** Specifies a callback function that performs specific actions on state saving. */ - customSave?: (gridState: Object) => void; - /** Specifies whether or not a grid saves its state. */ - enabled?: boolean; - /** Specifies the delay between the last change of a grid state and the operation of saving this state in milliseconds. */ - savingTimeout?: number; - /** Specifies a unique key to be used for storing the grid state. */ - storageKey?: string; - /** Specifies the type of storage to be used for state storing. */ - type?: string; - }; - } - /** A data summarization widget for multi-dimensional data analysis and data mining. */ - export class dxPivotGrid extends Widget { - constructor(element: JQuery, options?: dxPivotGridOptions); - constructor(element: Element, options?: dxPivotGridOptions); - /** Gets the PivotGridDataSource instance. */ - getDataSource(): DevExpress.data.PivotGridDataSource; - /** Gets the dxPopup instance of the field chooser window. */ - getFieldChooserPopup(): DevExpress.ui.dxPopup; - /** Updates the widget to the size of its content. */ - updateDimensions(): void; - /** Exports pivot grid data to the Excel file. */ - exportToExcel(): void; - } - export interface dxPivotGridFieldChooserOptions extends WidgetOptions { - /** Specifies the height of the widget. */ - height?: any; - /** Specifies the field chooser layout. */ - layout?: number; - /** The data source of a dxPivotGrid widget. */ - dataSource?: DevExpress.data.PivotGridDataSource; - onContentReady?: Function; - /** Strings that can be changed or localized in the dxPivotGridFieldChooser widget. */ - texts?: { - /** The string to display instead of Row Fields. */ - rowFields?: string; - /** The string to display instead of Column Fields. */ - columnFields?: string; - /** The string to display instead of Data Fields. */ - dataFields?: string; - /** The string to display instead of Filter Fields. */ - filterFields?: string; - /** The string to display instead of All Fields. */ - allFields?: string; - }; - } - /** A complementary widget for dxPivotGrid that allows you to manage data displayed in the dxPivotGrid. */ - export class dxPivotGridFieldChooser extends Widget { - constructor(element: JQuery, options?: dxPivotGridFieldChooserOptions); - constructor(element: Element, options?: dxPivotGridFieldChooserOptions); - /** Updates the widget to the size of its content. */ - updateDimensions(): void; - } -} -interface JQuery { - dxTreeView(): JQuery; - dxTreeView(options: "instance"): DevExpress.ui.dxTreeView; - dxTreeView(options: string): any; - dxTreeView(options: string, ...params: any[]): any; - dxTreeView(options: DevExpress.ui.dxTreeViewOptions): JQuery; - dxMenuBase(): JQuery; - dxMenuBase(options: "instance"): DevExpress.ui.dxMenuBase; - dxMenuBase(options: string): any; - dxMenuBase(options: string, ...params: any[]): any; - dxMenuBase(options: DevExpress.ui.dxMenuBaseOptions): JQuery; - dxMenu(): JQuery; - dxMenu(options: "instance"): DevExpress.ui.dxMenu; - dxMenu(options: string): any; - dxMenu(options: string, ...params: any[]): any; - dxMenu(options: DevExpress.ui.dxMenuOptions): JQuery; - dxContextMenu(): JQuery; - dxContextMenu(options: "instance"): DevExpress.ui.dxContextMenu; - dxContextMenu(options: string): any; - dxContextMenu(options: string, ...params: any[]): any; - dxContextMenu(options: DevExpress.ui.dxContextMenuOptions): JQuery; - dxColorBox(): JQuery; - dxColorBox(options: "instance"): DevExpress.ui.dxColorBox; - dxColorBox(options: string): any; - dxColorBox(options: string, ...params: any[]): any; - dxColorBox(options: DevExpress.ui.dxColorBoxOptions): JQuery; - dxDataGrid(): JQuery; - dxDataGrid(options: "instance"): DevExpress.ui.dxDataGrid; - dxDataGrid(options: string): any; - dxDataGrid(options: string, ...params: any[]): any; - dxDataGrid(options: DevExpress.ui.dxDataGridOptions): JQuery; - dxPivotGrid(): JQuery; - dxPivotGrid(options: "instance"): DevExpress.ui.dxPivotGrid; - dxPivotGrid(options: string): any; - dxPivotGrid(options: string, ...params: any[]): any; - dxPivotGrid(options: DevExpress.ui.dxPivotGridOptions): JQuery; - dxPivotGridFieldChooser(): JQuery; - dxPivotGridFieldChooser(options: "instance"): DevExpress.ui.dxPivotGridFieldChooser; - dxPivotGridFieldChooser(options: string): any; - dxPivotGridFieldChooser(options: string, ...params: any[]): any; - dxPivotGridFieldChooser(options: DevExpress.ui.dxPivotGridFieldChooserOptions): JQuery; - dxScheduler(): JQuery; - dxScheduler(options: "instance"): DevExpress.ui.dxScheduler; - dxScheduler(options: string): any; - dxScheduler(options: string, ...params: any[]): any; - dxScheduler(options: DevExpress.ui.dxSchedulerOptions): JQuery; -} -declare module DevExpress.framework { - /** An object used to store information on the views displayed in an application. */ - export class ViewCache { - viewRemoved: JQueryCallback; - /** Removes all the viewInfo objects from the cache. */ - clear(): void; - /** Obtains a viewInfo object from the cache by the specified key. */ - getView(key: string): Object; - /** Checks whether or not a viewInfo object is contained in the view cache under the specified key. */ - hasView(key: string): boolean; - /** Removes a viewInfo object from the cache by the specified key. */ - removeView(key: string): Object; - /** Adds the specified viewInfo object to the cache under the specified key. */ - setView(key: string, viewInfo: Object): void; - } - export interface dxCommandOptions extends DOMComponentOptions { - /** Specifies an action performed when the execute() method of the command is called. */ - onExecute?: any; - /** Indicates whether or not the widget that displays this command is disabled. */ - disabled?: boolean; - /** Specifies whether the current command is rendered when a view is being rendered or after a view is shown. */ - renderStage?: string; - /** Specifies the name of the icon shown inside the widget associated with this command. */ - icon?: string; - iconSrc?: string; - /** The identifier of the command. */ - id?: string; - /** Specifies the title of the widget associated with this command. */ - title?: string; - /** Specifies the type of the button, if the command is rendered as a dxButton widget. */ - type?: string; - /** A Boolean value specifying whether or not the widget associated with this command is visible. */ - visible?: boolean; - } - /** A markup component used to define markup options for a command. */ - export class dxCommand extends DOMComponent { - constructor(element: JQuery, options: dxCommandOptions); - constructor(options: dxCommandOptions); - /** Executes the action associated with this command. */ - execute(): void; - } - /** An object responsible for routing. */ - export class Router { - /** Adds a routing rule to the list of registered rules. */ - register(pattern: string, defaults?: Object, constraints?: Object): void; - /** Decodes the specified URI to an object using the registered routing rules. */ - parse(uri: string): Object; - /** Formats an object to a URI. */ - format(obj: Object): string; - } - export interface StateManagerOptions { - /** A storage to which the state manager saves the application state. */ - storage?: Object; - } - /** An object used to store the current application state. */ - export class StateManager { - constructor(options?: StateManagerOptions); - /** Adds an object that implements an interface of a state source to the state manager's collection of state sources. */ - addStateSource(stateSource: Object): void; - /** Removes a specified state source from the state manager's collection of state sources. */ - removeStateSource(stateSource: Object): void; - /** Saves the current application state. */ - saveState(): void; - /** Restores the application state that has been saved by the saveState() method to the state storage. */ - restoreState(): void; - /** Removes the application state that has been saved by the saveState() method to the state storage. */ - clearState(): void; - } - export module html { - export var layoutSets: Array; - export var animationSets: { [animationSetName: string]: AnimationSet }; - export interface AnimationSet { - [animationName: string]: any - } - export interface HtmlApplicationOptions { - /** Specifies where the commands that are defined in the application's views must be displayed. */ - commandMapping?: Object; - /** Specifies whether or not view caching is disabled. */ - disableViewCache?: boolean; - /** An array of layout controllers that should be used to show application views in the current navigation context. */ - layoutSet?: any; - /** Specifies the animation presets that are used to animate different UI elements in the current application. */ - animationSet?: AnimationSet; - /** Specifies whether the current application must behave as a mobile or web application. */ - mode?: string; - /** Specifies the object that represents a root namespace of the application. */ - namespace?: Object; - /** Specifies application behavior when the user navigates to a root view. */ - navigateToRootViewMode?: string; - /** An array of dxCommand configuration objects used to define commands available from the application's global navigation. */ - navigation?: Array; - /** A state manager to be used in the application. */ - stateManager?: StateManager; - /** Specifies the storage to be used by the application's state manager to store the application state. */ - stateStorage?: Object; - /** Indicates whether on not to use the title of the previously displayed view as text on the Back button. */ - useViewTitleAsBackText?: boolean; - /** A custom view cache to be used in the application. */ - viewCache?: Object; - /** Specifies a limit for the views that can be cached. */ - viewCacheSize?: number; - /** Specifies the current version of application templates. */ - templatesVersion?: string; - /** Specifies options for the viewport meta tag of a mobile browser. */ - viewPort?: JQuery; - /** A custom router to be used in the application. */ - router?: Router; - } - /** An object used to manage views, as well as control the application life cycle. */ - export class HtmlApplication implements EventsMixin { - constructor(options: HtmlApplicationOptions); - afterViewSetup: JQueryCallback; - beforeViewSetup: JQueryCallback; - initialized: JQueryCallback; - navigating: JQueryCallback; - navigatingBack: JQueryCallback; - resolveLayoutController: JQueryCallback; - resolveViewCacheKey: JQueryCallback; - viewDisposed: JQueryCallback; - viewDisposing: JQueryCallback; - viewHidden: JQueryCallback; - viewRendered: JQueryCallback; - viewShowing: JQueryCallback; - viewShown: JQueryCallback; - /** Provides access to the ViewCache object. */ - viewCache: ViewCache; - /** An array of dxCommand components that are created based on the application's navigation option value. */ - navigation: Array; - /** Provides access to the StateManager object. */ - stateManager: StateManager; - /** Provides access to the Router object. */ - router: Router; - /** Navigates to the URI preceding the current one in the navigation history. */ - back(): void; - /** Returns a Boolean value indicating whether or not backwards navigation is currently possible. */ - canBack(): boolean; - /** Calls the clearState() method of the application's StateManager object. */ - clearState(): void; - /** Creates global navigation commands. */ - createNavigation(navigationConfig: Array): void; - /** Returns an HTML template of the specified view. */ - getViewTemplate(viewName: string): JQuery; - /** Returns a configuration object used to create a dxView component for a specified view. */ - getViewTemplateInfo(viewName: string): Object; - /** Adds a specified HTML template to a collection of view or layout templates. */ - loadTemplates(source: any): JQueryPromise; - /** Navigates to the specified URI. */ - navigate(uri?: any, options?: Object): void; - /** Renders navigation commands to the navigation command containers that are located in the layouts used in the application. */ - renderNavigation(): void; - /** Calls the restoreState() method of the application's StateManager object. */ - restoreState(): void; - /** Calls the saveState method of the application's StateManager object. */ - saveState(): void; - /** Provides access to the object that defines the current context to be considered when choosing an appropriate template for a view. */ - templateContext(): Object; - on(eventName: "initialized", eventHandler: () => void): HtmlApplication; - on(eventName: "afterViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "beforeViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "navigating", eventHandler: (e: { - currentUri: string; - uri: string; - cancel: boolean; - options: { - root: boolean; - target: string; - direction: string; - rootInDetailPane: boolean; - modal: boolean; - }; - }) => void): HtmlApplication; - on(eventName: "navigatingBack", eventHandler: (e: { - cancel: boolean; - isHardwareButton: boolean; - }) => void): HtmlApplication; - on(eventName: "resolveLayoutController", eventHandler: (e: { - viewInfo: Object; - layoutController: Object; - availableLayoutControllers: Array; - }) => void): HtmlApplication; - on(eventName: "resolveViewCacheKey", eventHandler: (e: { - key: string; - navigationItem: Object; - routeData: Object; - }) => void): HtmlApplication; - on(eventName: "viewDisposed", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewDisposing", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewHidden", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewRendered", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewShowing", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - on(eventName: "viewShown", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - on(eventName: string, eventHandler: Function): HtmlApplication; - on(events: { [eventName: string]: Function; }): HtmlApplication; - off(eventName: "initialized"): HtmlApplication; - off(eventName: "afterViewSetup"): HtmlApplication; - off(eventName: "beforeViewSetup"): HtmlApplication; - off(eventName: "navigating"): HtmlApplication; - off(eventName: "navigatingBack"): HtmlApplication; - off(eventName: "resolveLayoutController"): HtmlApplication; - off(eventName: "resolveViewCacheKey"): HtmlApplication; - off(eventName: "viewDisposed"): HtmlApplication; - off(eventName: "viewDisposing"): HtmlApplication; - off(eventName: "viewHidden"): HtmlApplication; - off(eventName: "viewRendered"): HtmlApplication; - off(eventName: "viewShowing"): HtmlApplication; - off(eventName: "viewShown"): HtmlApplication; - off(eventName: string): HtmlApplication; - off(eventName: "initialized", eventHandler: () => void): HtmlApplication; - off(eventName: "afterViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "beforeViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "navigating", eventHandler: (e: { - currentUri: string; - uri: string; - cancel: boolean; - options: { - root: boolean; - target: string; - direction: string; - rootInDetailPane: boolean; - modal: boolean; - }; - }) => void): HtmlApplication; - off(eventName: "navigatingBack", eventHandler: (e: { - cancel: boolean; - isHardwareButton: boolean; - }) => void): HtmlApplication; - off(eventName: "resolveLayoutController", eventHandler: (e: { - viewInfo: Object; - layoutController: Object; - availableLayoutControllers: Array; - }) => void): HtmlApplication; - off(eventName: "resolveViewCacheKey", eventHandler: (e: { - key: string; - navigationItem: Object; - routeData: Object; - }) => void): HtmlApplication; - off(eventName: "viewDisposed", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewDisposing", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewHidden", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewRendered", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewShowing", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - off(eventName: "viewShown", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - off(eventName: string, eventHandler: Function): HtmlApplication; - } - } -} -declare module DevExpress.viz.core { - /** - * Applies a theme for the entire page with several DevExtreme visualization widgets. - * @deprecated Use the DevExpress.viz.currentTheme(theme) method instead. - */ - export function currentTheme(theme: string): void; - /** - * Applies a new theme (with the color scheme defined separately) for the entire page with several DevExtreme visualization widgets. - * @deprecated Use the DevExpress.viz.currentTheme(platform, colorScheme) method instead. - */ - export function currentTheme(platform: string, colorScheme: string): void; - /** - * Registers a new theme based on the existing one. - * @deprecated Use the DevExpress.viz.registerTheme(customTheme, baseTheme) method instead. - */ - export function registerTheme(customTheme: Object, baseTheme: string): void; - /** - * Applies a predefined or registered custom palette to all visualization widgets at once. - * @deprecated Use the DevExpress.viz.currentPalette(paletteName) method instead. - */ - export function currentPalette(paletteName: string): void; - /** - * Obtains the color sets of a predefined or registered palette. - * @deprecated Use the DevExpress.viz.getPalette(paletteName) method instead. - */ - export function getPalette(paletteName: string): Object; - /** - * Registers a new palette. - * @deprecated Use the DevExpress.viz.registerPalette(paletteName, palette) method instead. - */ - export function registerPalette(paletteName: string, palette: Object): void; - export interface Border { - /** Sets a border color for a selected series. */ - color?: string; - /** Sets border visibility for a selected series. */ - visible?: boolean; - /** Sets a border width for a selected series. */ - width?: number; - } - export interface DashedBorder extends Border { - /** Specifies a dash style for the border of a selected series point. */ - dashStyle?: string; - } - export interface DashedBorderWithOpacity extends DashedBorder { - /** Specifies the opacity of the tooltip's border. */ - opacity?: number; - } - export interface Font { - /** Specifies the font color for a strip label. */ - color?: string; - /** Specifies the font family for a strip label. */ - family?: string; - /** Specifies the font opacity for a strip label. */ - opacity?: number; - /** Specifies the font size for a strip label. */ - size?: any; - /** Specifies the font weight for the text displayed in strips. */ - weight?: number; - } - export interface Hatching { - direction?: string; - /** Specifies the opacity of hatching lines. */ - opacity?: number; - /** Specifies the distance between hatching lines in pixels. */ - step?: number; - /** Specifies the width of hatching lines in pixels. */ - width?: number; - } - export interface Margins { - /** Specifies the distance in pixels between the bottom side of the title and the surrounding widget elements. */ - bottom?: number; - /** Specifies the distance in pixels between the left side of the title and the surrounding widget elements. */ - left?: number; - /** Specifies the distance between the right side of the title and surrounding widget elements in pixels. */ - right?: number; - /** Specifies the distance between the top side of the title and surrounding widget elements in pixels. */ - top?: number; - } - export interface Size { - /** Specifies the width of the widget. */ - width?: number; - /** Specifies the height of the widget. */ - height?: number; - } - export interface Title { - /** Specifies font options for the title. */ - font?: viz.core.Font; - /** Specifies the widget title's horizontal position. */ - horizontalAlignment?: string; - /** Specifies the widget title's position in the vertical direction. */ - verticalAlignment?: string; - /** Specifies the distance between the title and surrounding widget elements in pixels. */ - margin?: viz.core.Margins; - /** Specifies the height of the space reserved for the title. */ - placeholderSize?: number; - /** Specifies text for the title. */ - text?: string; - /** Specifies a subtitle for the widget. */ - subtitle?: { - /** Specifies font options for the subtitle. */ - font?: viz.core.Font; - /** Specifies text for the subtitle. */ - text?: string; - } - } - export interface Tooltip { - /** Specifies the length of the tooltip's arrow in pixels. */ - arrowLength?: number; - /** Specifies the appearance of the tooltip's border. */ - border?: viz.core.DashedBorderWithOpacity; - /** Specifies a color for the tooltip. */ - color?: string; - /** Specifies the z-index for tooltips. */ - zIndex?: number; - /** Specifies the container to draw tooltips inside of it. */ - container?: any; - /** Specifies text and appearance of a set of tooltips. */ - customizeTooltip?: (arg: Object) => { color?: string; text?: string }; - /** Specifies whether or not the tooltip is enabled. */ - enabled?: boolean; - /** Specifies font options for the text displayed by the tooltip. */ - font?: Font; - /** Specifies a format for the text displayed by the tooltip. */ - format?: string; - /** Specifies the opacity of a tooltip. */ - opacity?: number; - /** Specifies a distance from the tooltip's left/right boundaries to the inner text in pixels. */ - paddingLeftRight?: number; - /** Specifies a distance from the tooltip's top/bottom boundaries to the inner text in pixels. */ - paddingTopBottom?: number; - /** Specifies a precision for formatted values displayed by the tooltip. */ - precision?: number; - /** Specifies options of the tooltip's shadow. */ - shadow?: { - /** Specifies the blur distance of the tooltip's shadow. */ - blur?: number; - /** Specifies the color of the tooltip's shadow. */ - color?: string; - /** Specifies the horizontal offset of the tooltip's shadow relative to the tooltip in pixels. */ - offsetX?: number; - /** Specifies the vertical offset of the tooltip's shadow relative to the tooltip in pixels. */ - offsetY?: number; - /** Specifies the opacity of the tooltip's shadow. */ - opacity?: number; - }; - } - export interface Animation { - /** Determines how long animation runs. */ - duration?: number; - /** Specifies the animation easing mode. */ - easing?: string; - /** Indicates whether or not animation is enabled. */ - enabled?: boolean; - } - export interface LoadingIndicator { - /** Specifies a color for the loading indicator background. */ - backgroundColor?: string; - /** Specifies font options for the loading indicator text. */ - font?: viz.core.Font; - /** Specifies whether to show the loading indicator or not. */ - show?: boolean; - /** Specifies a text to be displayed by the loading indicator. */ - text?: string; - } - export interface LegendBorder extends viz.core.DashedBorderWithOpacity { - /** Specifies a radius for the corners of the legend border. */ - cornerRadius?: number; - } - export interface BaseLegend { - /** Specifies the color of the legend's background. */ - backgroundColor?: string; - /** Specifies legend border settings. */ - border?: viz.core.LegendBorder; - /** Specifies how many columns must be taken to arrange legend items. */ - columnCount?: number; - /** Specifies the spacing between a pair of neighboring legend columns in pixels. */ - columnItemSpacing?: number; - /** Specifies font options for legend items. */ - font?: viz.core.Font; - /** Specifies the legend's position on the map. */ - horizontalAlignment?: string; - /** Specifies the alignment of legend items. */ - itemsAlignment?: string; - /** Specifies the position of text relative to the item marker. */ - itemTextPosition?: string; - /** Specifies the distance between the legend and the container borders in pixels. */ - margin?: viz.core.Margins; - /** Specifies the size of item markers in the legend in pixels. */ - markerSize?: number; - /** Specifies whether to arrange legend items horizontally or vertically. */ - orientation?: string; - /** Specifies the spacing between the legend left/right border and legend items in pixels. */ - paddingLeftRight?: number; - /** Specifies the spacing between the legend top/bottom border and legend items in pixels. */ - paddingTopBottom?: number; - /** Specifies how many rows must be taken to arrange legend items. */ - rowCount?: number; - /** Specifies the spacing between a pair of neighboring legend rows in pixels. */ - rowItemSpacing?: number; - /** Specifies the legend's position on the map. */ - verticalAlignment?: string; - /** Specifies whether or not the legend is visible on the map. */ - visible?: boolean; - } - export interface BaseWidgetOptions extends DOMComponentOptions { - /** A handler for the drawn event. */ - onDrawn?: (e: { - component: BaseWidget; - element: Element; - }) => void; - /** A handler for the incidentOccurred event. */ - onIncidentOccurred?: ( - component: BaseWidget, - element: Element, - target: { - id: string; - type: string; - args: any; - text: string; - widget: string; - version: string; - } - ) => void; - /** Notifies a widget that it is embedded into an HTML page that uses a path modifier. */ - pathModified?: boolean; - /** Specifies whether or not the widget supports right-to-left representation. */ - rtlEnabled?: boolean; - /** Sets the name of the theme to be used in the widget. */ - theme?: string; - } - /** This section describes options and methods that are common to all widgets. */ - export class BaseWidget extends DOMComponent { - /** Returns the widget's SVG markup. */ - svg(): string; - } -} -declare module DevExpress.viz.charts { - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface BaseSeries { - /** Provides information about the state of the series object. */ - fullState: number; - /** Returns the type of the series. */ - type: string; - /** Unselects all the selected points of the series. The points are displayed in an initial style. */ - clearSelection(): void; - /** Gets the color of a particular series. */ - getColor(): string; - /** Gets points from the series point collection based on the specified argument. */ - getPointsByArg(pointArg: any): Array; - /** Gets a point from the series point collection based on the specified point position. */ - getPointByPos(positionIndex: number): Object; - /** Selects the series. The series is displayed in a 'selected' style until another series is selected or the current series is deselected programmatically. */ - select(): void; - /** Selects the specified point. The point is displayed in a 'selected' style. */ - selectPoint(point: BasePoint): void; - /** Deselects the specified point. The point is displayed in an initial style. */ - deselectPoint(point: BasePoint): void; - /** Returns an array of all points in the series. */ - getAllPoints(): Array; - /** Returns visible series points. */ - getVisiblePoints(): Array; - /** Returns the name of the series. */ - name: string; - /** Returns the tag of the series. */ - tag: string; - /** Hides a series. */ - hide(): void; - /** Provides information about the hover state of a series. */ - isHovered(): boolean; - /** Provides information about the selection state of a series. */ - isSelected(): boolean; - /** Provides information about the visibility state of a series. */ - isVisible(): boolean; - /** Makes a particular series visible. */ - show(): void; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface BasePoint { - /** Provides information about the state of the point object. */ - fullState: number; - /** Returns the point's argument value that was set in the data source. */ - originalArgument: any; - /** Returns the point's value that was set in the data source. */ - originalValue: any; - /** Returns the tag of the point. */ - tag: string; - /** Deselects the point. */ - clearSelection(): void; - /** Gets the color of a particular point. */ - getColor(): string; - /** Hides the tooltip of the point. */ - hideTooltip(): void; - /** Provides information about the hover state of a point. */ - isHovered(): boolean; - /** Provides information about the selection state of a point. */ - isSelected(): boolean; - /** Selects the point. The point is displayed in a 'selected' style until another point is selected or the current point is deselected programmatically. */ - select(): void; - /** Shows the tooltip of the point. */ - showTooltip(): void; - /** Allows you to obtain the label of a series point. */ - getLabel(): any; - /** Returns the series object to which the point belongs. */ - series: BaseSeries; - } - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface ChartSeries extends BaseSeries { - /** Returns the name of the series pane. */ - pane: string; - /** Returns the name of the value axis of the series. */ - axis: string; - selectPoint(point: ChartPoint): void; - deselectPoint(point: ChartPoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface ChartPoint extends BasePoint { - /** Contains the close value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalCloseValue: any; - /** Contains the high value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalHighValue: any; - /** Contains the low value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalLowValue: any; - /** Contains the first value of the point. This field is useful for points belonging to a series of the range area or range bar type only. */ - originalMinValue: any; - /** Contains the open value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalOpenValue: any; - /** Contains the size of the bubble as it was set in the data source. This field is useful for points belonging to a series of the bubble type only. */ - size: any; - /** Gets the parameters of the point's minimum bounding rectangle (MBR). */ - getBoundingRect(): { x: number; y: number; width: number; height: number; }; - series: ChartSeries; - } - /** This section describes the methods that can be used in code to manipulate the Label object. */ - export interface Label { - /** Gets the parameters of the label's minimum bounding rectangle (MBR). */ - getBoundingRect(): { x: number; y: number; width: number; height: number; }; - /** Hides the point label. */ - hide(): void; - /** Shows the point label. */ - show(): void; - } - export interface PieSeries extends BaseSeries { - selectPoint(point: PiePoint): void; - deselectPoint(point: PiePoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface PiePoint extends BasePoint { - /** Gets the percentage value of the specific point. */ - percent: any; - /** Provides information about the visibility state of a point. */ - isVisible(): boolean; - /** Makes a specific point visible. */ - show(): void; - /** Hides a specific point. */ - hide(): void; - series: PieSeries; - } - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface PolarSeries extends BaseSeries { - /** Returns the name of the value axis of the series. */ - axis: string; - selectPoint(point: PolarPoint): void; - deselectPoint(point: PolarPoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface PolarPoint extends BasePoint { - series: PolarSeries; - } - export interface Strip { - /** Specifies a color for a strip. */ - color?: string; - /** An object that defines the label configuration options of a strip. */ - label?: { - /** Specifies the text displayed in a strip. */ - text?: string; - }; - /** Specifies a start value for a strip. */ - startValue?: any; - /** Specifies an end value for a strip. */ - endValue?: any; - } - export interface BaseSeriesConfigLabel { - /** Specifies a format for arguments displayed by point labels. */ - argumentFormat?: string; - /** Specifies a precision for formatted point arguments displayed in point labels. */ - argumentPrecision?: number; - /** Specifies a background color for point labels. */ - backgroundColor?: string; - /** Specifies border options for point labels. */ - border?: viz.core.DashedBorder; - /** Specifies connector options for series point labels. */ - connector?: { - /** Specifies the color of label connectors. */ - color?: string; - /** Indicates whether or not label connectors are visible. */ - visible?: boolean; - /** Specifies the width of label connectors. */ - width?: number; - }; - /** Specifies a callback function that returns the text to be displayed by point labels. */ - customizeText?: (pointInfo: Object) => string; - /** Specifies font options for the text displayed in point labels. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed by point labels. */ - format?: string; - position?: string; - /** Specifies a precision for formatted point values displayed in point labels. */ - precision?: number; - /** Specifies the angle used to rotate point labels from their initial position. */ - rotationAngle?: number; - /** Specifies the visibility of point labels. */ - visible?: boolean; - } - export interface SeriesConfigLabel extends BaseSeriesConfigLabel { - /** Specifies whether or not to show a label when the point has a zero value. */ - showForZeroValues?: boolean; - } - export interface ChartSeriesConfigLabel extends SeriesConfigLabel { - /** Specifies how to align point labels relative to the corresponding data points that they represent. */ - alignment?: string; - /** Specifies how to shift point labels horizontally from their initial positions. */ - horizontalOffset?: number; - /** Specifies how to shift point labels vertically from their initial positions. */ - verticalOffset?: number; - /** Specifies a precision for the percentage values displayed in the labels of a full-stacked-like series. */ - percentPrecision?: number; - } - export interface BaseCommonSeriesConfig { - /** Specifies the data source field that provides arguments for series points. */ - argumentField?: string; - axis?: string; - /** An object defining the label configuration options for a series in the dxChart widget. */ - label?: ChartSeriesConfigLabel; - /** Specifies border options for point labels. */ - border?: viz.core.DashedBorder; - /** Specifies a series color. */ - color?: string; - /** Specifies the dash style of the series' line. */ - dashStyle?: string; - hoverMode?: string; - hoverStyle?: { - /** An object defining the border options for a hovered series. */ - border?: viz.core.DashedBorder; - /**

Sets a color for a series when it is hovered over.

*/ - color?: string; - /** Specifies the dash style for the line in a hovered series. */ - dashStyle?: string; - hatching?: viz.core.Hatching; - /** Specifies the width of a line in a hovered series. */ - width?: number; - }; - /** Specifies whether a chart ignores null data points or not. */ - ignoreEmptyPoints?: boolean; - /** Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed. */ - maxLabelCount?: number; - /** Specifies the minimal length of a displayed bar in pixels. */ - minBarSize?: number; - /** Specifies opacity for a series. */ - opacity?: number; - /** Specifies the series elements to highlight when the series is selected. */ - selectionMode?: string; - selectionStyle?: { - /** An object defining the border options for a selected series. */ - border?: viz.core.DashedBorder; - /** Sets a color for a series when it is selected. */ - color?: string; - /** Specifies the dash style for the line in a selected series. */ - dashStyle?: string; - hatching?: viz.core.Hatching; - /** Specifies the width of a line in a selected series. */ - width?: number; - }; - /** Specifies whether or not to show the series in the chart's legend. */ - showInLegend?: boolean; - /** Specifies the name of the stack where the values of the _stackedBar_ series must be located. */ - stack?: string; - /** Specifies the name of the data source field that provides data about a point. */ - tagField?: string; - /** Specifies the data source field that provides values for series points. */ - valueField?: string; - /** Specifies the visibility of a series. */ - visible?: boolean; - /** Specifies a line width. */ - width?: number; - /** Configures error bars. */ - valueErrorBar?: { - /** Specifies whether error bars must be displayed in full or partially. */ - displayMode?: string; - /** Specifies the data field that provides data for low error values. */ - lowValueField?: string; - /** Specifies the data field that provides data for high error values. */ - highValueField?: string; - /** Specifies how error bar values must be calculated. */ - type?: string; - /** Specifies the value to be used for generating error bars. */ - value?: number; - /** Specifies the color of error bars. */ - color?: string; - /** Specifies the opacity of error bars. */ - opacity?: number; - /** Specifies the length of the lines that indicate the error bar edges. */ - edgeLength?: number; - /** Specifies the width of the error bar line. */ - lineWidth?: number; - }; - } - export interface CommonPointOptions { - /** Specifies border options for points in the line and area series. */ - border?: viz.core.Border; - /** Specifies the points color. */ - color?: string; - /** Specifies what series points to highlight when a point is hovered over. */ - hoverMode?: string; - /** An object defining configuration options for a hovered point. */ - hoverStyle?: { - /** An object defining the border options for a hovered point. */ - border?: viz.core.Border; - /** Sets a color for a point when it is hovered over. */ - color?: string; - /** Specifies the diameter of a hovered point in the series that represents data points as symbols (not as bars for instance). */ - size?: number; - }; - /** Specifies what series points to highlight when a point is selected. */ - selectionMode?: string; - /** An object defining configuration options for a selected point. */ - selectionStyle?: { - /** An object defining the border options for a selected point. */ - border?: viz.core.Border; - /**

Sets a color for a point when it is selected.

*/ - color?: string; - /** Specifies the diameter of a selected point in the series that represents data points as symbols (not as bars for instance). */ - size?: number; - }; - /** Specifies the point diameter in pixels for those series that represent data points as symbols (not as bars for instance). */ - size?: number; - /** Specifies a symbol for presenting points of the line and area series. */ - symbol?: string; - visible?: boolean; - } - export interface ChartCommonPointOptions extends CommonPointOptions { - /** An object specifying the parameters of an image that is used as a point marker. */ - image?: { - /** Specifies the height of an image that is used as a point marker. */ - height?: any; - /** Specifies a URL leading to the image to be used as a point marker. */ - url?: any; - /** Specifies the width of an image that is used as a point marker. */ - width?: any; - }; - } - export interface PolarCommonPointOptions extends CommonPointOptions { - /** An object specifying the parameters of an image that is used as a point marker. */ - image?: { - /** Specifies the height of an image that is used as a point marker. */ - height?: number; - /** Specifies a URL leading to the image to be used as a point marker. */ - url?: string; - /** Specifies the width of an image that is used as a point marker. */ - width?: number; - }; - } - /** An object that defines configuration options for chart series. */ - export interface CommonSeriesConfig extends BaseCommonSeriesConfig { - /** Specifies the data source field that provides a 'close' value for a _candleStick_ or _stock_ series. */ - closeValueField?: string; - /** Specifies a radius for bar corners. */ - cornerRadius?: number; - /** Specifies the data source field that provides a 'high' value for a _candleStick_ or _stock_ series. */ - highValueField?: string; - /** Specifies the color for the body (rectangle) of a _candleStick_ series. */ - innerColor?: string; - /** Specifies the data source field that provides a 'low' value for a _candleStick_ or _stock_ series. */ - lowValueField?: string; - /** Specifies the data source field that provides an 'open' value for a _candleStick_ or _stock_ series. */ - openValueField?: string; - /** Specifies the pane that will be used to display a series. */ - pane?: string; - /** An object defining configuration options for points in line-, scatter- and area-like series. */ - point?: ChartCommonPointOptions; - /** Specifies the data source field that provides values for one end of a range series. To set the data source field for the other end of the range series, use the rangeValue2Field property. */ - rangeValue1Field?: string; - /** Specifies the data source field that provides values for the second end of a range series. To set the data source field for the other end of the range series, use the rangeValue1Field property. */ - rangeValue2Field?: string; - /** Specifies reduction options for the stock or candleStick series. */ - reduction?: { - /** Specifies a color for the points whose reduction level price is lower in comparison to the value in the previous point. */ - color?: string; - /** Specifies for which price level (open, high, low or close) to enable reduction options in the series. */ - level?: string; - }; - /** Specifies the data source field that defines the size of bubbles. */ - sizeField?: string; - } - export interface CommonSeriesSettings extends CommonSeriesConfig { - /**

An object that specifies configuration options for all series of the area type in the chart.

*/ - area?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _bar_ type in the chart. */ - bar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the bubble type in the chart. */ - bubble?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _candleStick_ type in the chart. */ - candlestick?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _fullStackedArea_ type in the chart. */ - fullstackedarea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Full-Stacked Spline Area type in the chart. */ - fullstackedsplinearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _fullStackedBar_ type in the chart. */ - fullstackedbar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _fullStackedLine_ type in the chart. */ - fullstackedline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Full-Stacked Spline type in the chart. */ - fullstackedspline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _line_ type in the chart. */ - line?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _rangeArea_ type in the chart. */ - rangearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _rangeBar_ type in the chart. */ - rangebar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _scatter_ type in the chart. */ - scatter?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _spline_ type in the chart. */ - spline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _splineArea_ type in the chart. */ - splinearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedArea_ type in the chart. */ - stackedarea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Stacked Spline Area type in the chart. */ - stackedsplinearea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedBar_ type in the chart. */ - stackedbar?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedLine_ type in the chart. */ - stackedline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the Stacked Spline type in the chart. */ - stackedspline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stepArea_ type in the chart. */ - steparea?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stepLine_ type in the chart. */ - stepline?: CommonSeriesConfig; - /** An object that specifies configuration options for all series of the _stock_ type in the chart. */ - stock?: CommonSeriesConfig; - /** Sets a series type. */ - type?: string; - } - export interface SeriesConfig extends CommonSeriesConfig { - /** Specifies the name that identifies the series. */ - name?: string; - /** Specifies data about a series. */ - tag?: any; - /** Sets the series type. */ - type?: string; - } - /** An object that defines configuration options for polar chart series. */ - export interface CommonPolarSeriesConfig extends BaseCommonSeriesConfig { - /** Specifies whether or not to close the chart by joining the end point with the first point. */ - closed?: boolean; - label?: SeriesConfigLabel; - point?: PolarCommonPointOptions; - } - export interface CommonPolarSeriesSettings extends CommonPolarSeriesConfig { - /** An object that specifies configuration options for all series of the area type in the chart. */ - area?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _bar_ type in the chart. */ - bar?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _line_ type in the chart. */ - line?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _scatter_ type in the chart. */ - scatter?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedBar_ type in the chart. */ - stackedbar?: CommonPolarSeriesConfig; - /** Sets a series type. */ - type?: string; - } - export interface PolarSeriesConfig extends CommonPolarSeriesConfig { - /** Specifies the name that identifies the series. */ - name?: string; - /** Specifies data about a series. */ - tag?: any; - /** Sets the series type. */ - type?: string; - } - export interface PieSeriesConfigLabel extends BaseSeriesConfigLabel { - /** Specifies how to shift labels from their initial position in a radial direction in pixels. */ - radialOffset?: number; - /** Specifies a precision for the percentage values displayed in labels. */ - percentPrecision?: number; - } - /** An object that defines configuration options for chart series. */ - export interface CommonPieSeriesConfig { - /** Specifies the data source field that provides arguments for series points. */ - argumentField?: string; - /** Specifies the required type for series arguments. */ - argumentType?: string; - /** An object defining the series border configuration options. */ - border?: viz.core.DashedBorder; - /** Specifies a series color. */ - color?: string; - /** Specifies the chart elements to highlight when a series is hovered over. */ - hoverMode?: string; - /** An object defining configuration options for a hovered series. */ - hoverStyle?: { - /** An object defining the border options for a hovered series. */ - border?: viz.core.DashedBorder; - /** Sets a color for the series when it is hovered over. */ - color?: string; - /** Specifies the hatching options to be applied when a point is hovered over. */ - hatching?: viz.core.Hatching; - }; - /** - * Specifies the fraction of the inner radius relative to the total radius in the series of the 'doughnut' type. - * @deprecated use the 'innerRadius' option instead - */ - innerRadius?: number; - /** An object defining the label configuration options. */ - label?: PieSeriesConfigLabel; - /** Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed. */ - maxLabelCount?: number; - /** Specifies a minimal size of a displayed pie segment. */ - minSegmentSize?: number; - /** - * Specifies the direction in which the dxPieChart series points are located. - * @deprecated use the 'segmentsDirection' option instead - */ - segmentsDirection?: string; - /**

Specifies the chart elements to highlight when the series is selected.

*/ - selectionMode?: string; - /** An object defining configuration options for the series when it is selected. */ - selectionStyle?: { - /** An object defining the border options for a selected series. */ - border?: viz.core.DashedBorder; - /** Sets a color for a series when it is selected. */ - color?: string; - /** Specifies the hatching options to be applied when a point is selected. */ - hatching?: viz.core.Hatching; - }; - /** Specifies chart segment grouping options. */ - smallValuesGrouping?: { - /** Specifies the name of the grouped chart segment. This name represents the segment in the chart legend. */ - groupName?: string; - /** Specifies the segment grouping mode. */ - mode?: string; - /** Specifies a threshold for segment values. */ - threshold?: number; - /** Specifies how many segments must not be grouped. */ - topCount?: number; - }; - /** - * Specifies a start angle for a pie chart in arc degrees. - * @deprecated use the 'startAngle' option instead - */ - startAngle?: number; - /**

Specifies the name of the data source field that provides data about a point.

*/ - tagField?: string; - /** Specifies the data source field that provides values for series points. */ - valueField?: string; - } - export interface CommonPieSeriesSettings extends CommonPieSeriesConfig { - /** - * Specifies the type of the pie chart series. - * @deprecated use the 'type' option instead - */ - type?: string; - } - export interface PieSeriesConfig extends CommonPieSeriesConfig { - /** - * Sets the series type. - * @deprecated use the 'type' option instead - */ - type?: string; - /** Specifies the name that identifies the series. */ - name?: string; - /** Specifies data about a series. */ - tag?: any; - } - export interface SeriesTemplate { - /** Specifies a callback function that returns a series object with individual series settings. */ - customizeSeries?: (seriesName: string) => SeriesConfig; - /** Specifies a data source field that represents the series name. */ - nameField?: string; - } - export interface PolarSeriesTemplate { - /** Specifies a callback function that returns a series object with individual series settings. */ - customizeSeries?: (seriesName: string) => PolarSeriesConfig; - /** Specifies a data source field that represents the series name. */ - nameField?: string; - } - export interface ChartCommonConstantLineLabel { - /** Specifies font options for a constant line label. */ - font?: viz.core.Font; - /** Specifies the position of the constant line label relative to the chart plot. */ - position?: string; - /** Indicates whether or not to display labels for the axis constant lines. */ - visible?: boolean; - } - export interface PolarCommonConstantLineLabel { - /** Indicates whether or not to display labels for the axis constant lines. */ - visible?: boolean; - /** Specifies font options for a constant line label. */ - font?: viz.core.Font; - } - export interface ConstantLineStyle { - /** Specifies a color for a constant line. */ - color?: string; - /** Specifies a dash style for a constant line. */ - dashStyle?: string; - /** Specifies a constant line width in pixels. */ - width?: number; - } - export interface ChartCommonConstantLineStyle extends ConstantLineStyle { - /** An object defining constant line label options. */ - label?: ChartCommonConstantLineLabel; - /** Specifies the space between the constant line label and the left/right side of the constant line. */ - paddingLeftRight?: number; - /** Specifies the space between the constant line label and the top/bottom side of the constant line. */ - paddingTopBottom?: number; - } - export interface PolarCommonConstantLineStyle extends ConstantLineStyle { - /** An object defining constant line label options. */ - label?: PolarCommonConstantLineLabel; - } - export interface CommonAxisLabel { - /** Specifies font options for axis labels. */ - font?: viz.core.Font; - /** Specifies the spacing between an axis and its labels in pixels. */ - indentFromAxis?: number; - /** Indicates whether or not axis labels are visible. */ - visible?: boolean; - } - export interface ChartCommonAxisLabel extends CommonAxisLabel { - /** Specifies the label's position relative to the tick (grid line). */ - alignment?: string; - /** Specifies the overlap resolving algorithm to be applied to axis labels. */ - overlappingBehavior?: { - /** Specifies how to arrange axis labels. */ - mode?: string; - /** Specifies the angle used to rotate axis labels. */ - rotationAngle?: number; - /** Specifies the spacing that must be set between staggered rows when the 'stagger' algorithm is applied. */ - staggeringSpacing?: number; - }; - } - export interface PolarCommonAxisLabel extends CommonAxisLabel { - /** Specifies the overlap resolving algorithm to be applied to axis labels. */ - overlappingBehavior?: string; - } - export interface CommonAxisTitle { - /** Specifies font options for an axis title. */ - font?: viz.core.Font; - /** Specifies a margin for an axis title in pixels. */ - margin?: number; - } - export interface BaseCommonAxisSettings { - /** Specifies the color of the line that represents an axis. */ - color?: string; - /** Specifies whether ticks/grid lines of a discrete axis are located between labels or cross the labels. */ - discreteAxisDivisionMode?: string; - /** An object defining the configuration options for the grid lines of an axis in the dxPolarChart widget. */ - grid?: { - /** Specifies a color for grid lines. */ - color?: string; - /** Specifies an opacity for grid lines. */ - opacity?: number; - /** Indicates whether or not the grid lines of an axis are visible. */ - visible?: boolean; - /** Specifies the width of grid lines. */ - width?: number; - }; - /** Specifies the options of the minor grid. */ - minorGrid?: { - /** Specifies a color for the lines of the minor grid. */ - color?: string; - /** Specifies an opacity for the lines of the minor grid. */ - opacity?: number; - /** Indicates whether the minor grid is visible or not. */ - visible?: boolean; - /** Specifies a width for the lines of the minor grid. */ - width?: number; - }; - /** Indicates whether or not an axis is inverted. */ - inverted?: boolean; - /** Specifies the opacity of the line that represents an axis. */ - opacity?: number; - /** Indicates whether or not to set ticks/grid lines of a continuous axis of the 'date-time' type at the beginning of each date-time interval. */ - setTicksAtUnitBeginning?: boolean; - /** An object defining the configuration options for axis ticks. */ - tick?: { - /** Specifies ticks color. */ - color?: string; - /** Specifies tick opacity. */ - opacity?: number; - /** Indicates whether or not ticks are visible on an axis. */ - visible?: boolean; - /** Specifies tick width. */ - width?: number; - /** Specifies tick length. */ - length?: number; - }; - /** Specifies the options of the minor ticks. */ - minorTick?: { - /** Specifies a color for the minor ticks. */ - color?: string; - /** Specifies an opacity for the minor ticks. */ - opacity?: number; - /** Indicates whether or not the minor ticks are displayed on an axis. */ - visible?: boolean; - /** Specifies minor tick width. */ - width?: number; - /** Specifies minor tick length. */ - length?: number; - }; - /** Indicates whether or not the line that represents an axis in a chart is visible. */ - visible?: boolean; - /** Specifies the width of the line that represents an axis in the chart. */ - width?: number; - } - export interface ChartCommonAxisSettings extends BaseCommonAxisSettings { - /** Specifies the appearance of all the widget's constant lines. */ - constantLineStyle?: ChartCommonConstantLineStyle; - /** An object defining the label configuration options that are common for all axes in the dxChart widget. */ - label?: ChartCommonAxisLabel; - /** Specifies a coefficient that determines the spacing between the maximum series point and the axis. */ - maxValueMargin?: number; - /** Specifies a coefficient that determines the spacing between the minimum series point and the axis. */ - minValueMargin?: number; - /** Specifies, in pixels, the space reserved for an axis. */ - placeholderSize?: number; - /** An object defining configuration options for strip style. */ - stripStyle?: { - /** An object defining the configuration options for a strip label style. */ - label?: { - /** Specifies font options for a strip label. */ - font?: viz.core.Font; - /** Specifies the label's position on a strip. */ - horizontalAlignment?: string; - /** Specifies a label's position on a strip. */ - verticalAlignment?: string; - }; - /** Specifies the spacing, in pixels, between the left/right strip border and the strip label. */ - paddingLeftRight?: number; - /** Specifies the spacing, in pixels, between the top/bottom strip borders and the strip label. */ - paddingTopBottom?: number; - }; - /** An object defining the title configuration options that are common for all axes in the dxChart widget. */ - title?: CommonAxisTitle; - /** Indicates whether or not to display series with indents from axis boundaries. */ - valueMarginsEnabled?: boolean; - } - export interface PolarCommonAxisSettings extends BaseCommonAxisSettings { - /** Specifies the appearance of all the widget's constant lines. */ - constantLineStyle?: PolarCommonConstantLineStyle; - /** An object defining the label configuration options that are common for all axes in the dxPolarChart widget. */ - label?: PolarCommonAxisLabel; - /** An object defining configuration options for strip style. */ - stripStyle?: { - /** An object defining the configuration options for a strip label style. */ - label?: { - /** Specifies font options for a strip label. */ - font?: viz.core.Font; - }; - }; - } - export interface ChartConstantLineLabel extends ChartCommonConstantLineLabel { - /** Specifies the horizontal alignment of a constant line label. */ - horizontalAlignment?: string; - /** Specifies the vertical alignment of a constant line label. */ - verticalAlignment?: string; - /** Specifies the text to be displayed in a constant line label. */ - text?: string; - } - export interface PolarConstantLineLabel extends PolarCommonConstantLineLabel { - /** Specifies the text to be displayed in a constant line label. */ - text?: string; - } - export interface AxisLabel { - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a label on the value axis. */ - customizeHint?: (argument: { value: any; valueText: string }) => string; - /** Specifies a callback function that returns the text to be displayed in value axis labels. */ - customizeText?: (argument: { value: any; valueText: string }) => string; - /** Specifies a format for the text displayed by axis labels. */ - format?: string; - /** Specifies a precision for the formatted value displayed in the axis labels. */ - precision?: number; - } - export interface ChartAxisLabel extends ChartCommonAxisLabel, AxisLabel { } - export interface PolarAxisLabel extends PolarCommonAxisLabel, AxisLabel { } - export interface AxisTitle extends CommonAxisTitle { - /** Specifies the text for the value axis title. */ - text?: string; - } - export interface ChartConstantLineStyle extends ChartCommonConstantLineStyle { - /** An object defining constant line label options. */ - label?: ChartConstantLineLabel; - } - export interface ChartConstantLine extends ChartConstantLineStyle { - /** An object defining constant line label options. */ - label?: ChartConstantLineLabel; - /** Specifies a value to be displayed by a constant line. */ - value?: any; - } - export interface PolarConstantLine extends PolarCommonConstantLineStyle { - /** An object defining constant line label options. */ - label?: PolarConstantLineLabel; - /** Specifies a value to be displayed by a constant line. */ - value?: any; - } - export interface Axis { - /** Specifies a coefficient for dividing the value axis. */ - axisDivisionFactor?: number; - /** Specifies the order in which discrete values are arranged on the value axis. */ - categories?: Array; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic axis. */ - logarithmBase?: number; - /** Specifies an interval between axis ticks/grid lines. */ - tickInterval?: any; - /** Specifies the interval between minor ticks. */ - minorTickInterval?: any; - /** Specifies the number of minor ticks between two neighboring major ticks. */ - minorTickCount?: number; - /** Specifies the required type of the value axis. */ - type?: string; - /** Specifies the pane on which the current value axis will be displayed. */ - pane?: string; - /** Specifies options for value axis strips. */ - strips?: Array; - } - export interface ChartAxis extends ChartCommonAxisSettings, Axis { - /** Defines an array of the value axis constant lines. */ - constantLines?: Array; - /** Specifies the appearance options for the constant lines of the value axis. */ - constantLineStyle?: ChartCommonConstantLineStyle; - /** Specifies options for value axis labels. */ - label?: ChartAxisLabel; - /** Specifies the maximum value on the value axis. */ - max?: any; - /** Specifies the minimum value on the value axis. */ - min?: any; - /** Specifies the position of the value axis on a chart. */ - position?: string; - /** Specifies the title for a value axis. */ - title?: AxisTitle; - } - export interface PolarAxis extends PolarCommonAxisSettings, Axis { - /** Defines an array of the value axis constant lines. */ - constantLines?: Array; - /** Specifies options for value axis labels. */ - label?: PolarAxisLabel; - } - export interface ArgumentAxis { - /** Specifies the desired type of axis values. */ - argumentType?: string; - /** Specifies the elements that will be highlighted when the argument axis is hovered over. */ - hoverMode?: string; - } - export interface ChartArgumentAxis extends ChartAxis, ArgumentAxis { } - export interface PolarArgumentAxis extends PolarAxis, ArgumentAxis { - /** Specifies the angle in arc degrees to which the argument axis should be rotated. The positive values rotate the axis clockwise. */ - startAngle?: number; - /** Specifies whether or not to display the first point at the angle specified by the startAngle option. */ - firstPointOnStartAngle?: boolean; - /** Specifies the value to be used as the origin for the argument axis. */ - originValue?: number; - /** Specifies the period of the argument values in the data source. */ - period?: number; - } - export interface ValueAxis { - /** Specifies the name of the value axis. */ - name?: string; - /** Specifies whether or not to indicate a zero value on the value axis. */ - showZero?: boolean; - /** Specifies the desired type of axis values. */ - valueType?: string; - } - export interface ChartValueAxis extends ChartAxis, ValueAxis { - /** Specifies the spacing, in pixels, between multiple value axes in a chart. */ - multipleAxesSpacing?: number; - /** Specifies the value by which the chart's value axes are synchronized. */ - synchronizedValue?: number; - } - export interface PolarValueAxis extends PolarAxis, ValueAxis { - /** Indicates whether to display series with indents from axis boundaries. */ - valueMarginsEnabled?: boolean; - /** Specifies a coefficient that determines the spacing between the maximum series point and the axis. */ - maxValueMargin?: number; - /** Specifies a coefficient that determines the spacing between the minimum series point and the axis. */ - minValueMargin?: number; - tick?: { - visible?: boolean; - } - } - export interface CommonPane { - /** Specifies a background color in a pane. */ - backgroundColor?: string; - /** Specifies the border options of a chart's pane. */ - border?: PaneBorder; - } - export interface Pane extends CommonPane { - /** Specifies the name of a pane. */ - name?: string; - } - export interface PaneBorder extends viz.core.DashedBorderWithOpacity { - /** Specifies the bottom border's visibility state in a pane. */ - bottom?: boolean; - /** Specifies the left border's visibility state in a pane. */ - left?: boolean; - /** Specifies the right border's visibility state in a pane. */ - right?: boolean; - /** Specifies the top border's visibility state in a pane. */ - top?: boolean; - } - export interface ChartAnimation extends viz.core.Animation { - /** Specifies the maximum series point count in the chart that the animation supports. */ - maxPointCountSupported?: number; - } - export interface BaseChartTooltip extends viz.core.Tooltip { - /** Specifies a format for arguments of the chart's series points. */ - argumentFormat?: string; - /** Specifies a precision for formatted arguments displayed in tooltips. */ - argumentPrecision?: number; - /** Specifies a precision for a percent value displayed in tooltips for stacked series and dxPieChart series. */ - percentPrecision?: number; - } - export interface BaseChartOptions extends viz.core.BaseWidgetOptions { - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - /** Specifies the width of the widget that is small enough for the layout to begin adapting. */ - width?: number; - /** Specifies the height of the widget that is small enough for the layout to begin adapting. */ - height?: number; - /** Specifies whether or not point labels can be hidden when the layout is adapting. */ - keepLabels?: boolean; - }; - /** Specifies animation options. */ - animation?: ChartAnimation; - /** Specifies a callback function that returns an object with options for a specific point label. */ - customizeLabel?: (labelInfo: Object) => Object; - /** Specifies a callback function that returns an object with options for a specific point. */ - customizePoint?: (pointInfo: Object) => Object; - /** Specifies a data source for the chart. */ - dataSource?: any; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies options of a dxChart's (dxPieChart's) legend. */ - legend?: core.BaseLegend; - /** Specifies the blank space between the chart's extreme elements and the boundaries of the area provided for the widget (see size) in pixels. */ - margin?: viz.core.Margins; - /** Sets the name of the palette to be used in the chart. Alternatively, an array of colors can be set as a custom palette to be used within this chart. */ - palette?: any; - /** A handler for the done event. */ - onDone?: (e: { - component: BaseChart; - element: Element; - }) => void; - /** A handler for the pointClick event. */ - onPointClick?: any; - /** A handler for the pointHoverChanged event. */ - onPointHoverChanged?: (e: { - component: BaseChart; - element: Element; - target: TPoint; - }) => void; - /** A handler for the pointSelectionChanged event. */ - onPointSelectionChanged?: (e: { - component: BaseChart; - element: Element; - target: TPoint; - }) => void; - /** Specifies whether a single point or multiple points can be selected in the chart. */ - pointSelectionMode?: string; - /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */ - redrawOnResize?: boolean; - /** Specifies options for the dxChart and dxPieChart widget series. */ - series?: any; - /** Specifies the size of the widget in pixels. */ - size?: viz.core.Size; - /** Specifies a title for the chart. */ - title?: viz.core.Title; - /** Specifies tooltip options. */ - tooltip?: BaseChartTooltip; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: BaseChart; - element: Element; - target: BasePoint; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: BaseChart; - element: Element; - target: BasePoint; - }) => void; - } - /** A base class for all chart widgets included in the ChartJS library. */ - export class BaseChart extends viz.core.BaseWidget { - /** Deselects the chart's selected series. The series is displayed in an initial style. */ - clearSelection(): void; - /** Gets the current size of the widget. */ - getSize(): { width: number; height: number }; - /** Returns an array of all series in the chart. */ - getAllSeries(): Array; - /** Gets a series within the chart's series collection by the specified name (see the name option). */ - getSeriesByName(seriesName: string): BaseSeries; - /** Gets a series within the chart's series collection by its position number. */ - getSeriesByPos(seriesIndex: number): BaseSeries; - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Hides all widget tooltips. */ - hideTooltip(): void; - /** Redraws a widget. */ - render(renderOptions?: { - force?: boolean; - animate?: boolean; - asyncSeriesRendering?: boolean; - }): void; - } - export interface AdvancedLegend extends core.BaseLegend { - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item. */ - customizeHint?: (seriesInfo: { seriesName: string; seriesIndex: number; seriesColor: string; }) => string; - /**

Specifies a callback function that returns the text to be displayed by legend items.

*/ - customizeText?: (seriesInfo: { seriesName: string; seriesIndex: number; seriesColor: string; }) => string; - /** Specifies what series elements to highlight when a corresponding item in the legend is hovered over. */ - hoverMode?: string; - } - export interface AdvancedOptions extends BaseChartOptions { - /** A handler for the argumentAxisClick event. */ - onArgumentAxisClick?: any; - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** An object providing options for managing data from a data source. */ - dataPrepareSettings?: { - /** Specifies whether or not to validate the values from a data source. */ - checkTypeForAllData?: boolean; - /** Specifies whether or not to convert the values from a data source into the data type of an axis. */ - convertToAxisDataType?: boolean; - /** Specifies how to sort the series points. */ - sortingMethod?: any; - }; - /** A handler for the legendClick event. */ - onLegendClick?: any; - /** A handler for the seriesClick event. */ - onSeriesClick?: any; - /** A handler for the seriesHoverChanged event. */ - onSeriesHoverChanged?: (e: { - component: BaseChart; - element: Element; - target: TSeries; - }) => void; - /** A handler for the seriesSelectionChanged event. */ - onSeriesSelectionChanged?: (e: { - component: BaseChart; - element: Element; - target: TSeries; - }) => void; - /** Specifies whether a single series or multiple series can be selected in the chart. */ - seriesSelectionMode?: string; - /** Specifies how the chart must behave when series point labels overlap. */ - resolveLabelOverlapping?: string; - /** Specifies whether or not all bars in a series must have the same angle, or may have different angles if any points in other series are missing. */ - equalBarWidth?: boolean; - /** Specifies a common bar width as a percentage from 0 to 1. */ - barWidth?: number; - /** Forces the widget to treat negative values as zeroes. Applies to stacked-like series only. */ - negativesAsZeroes?: boolean; - } - export interface Legend extends AdvancedLegend { - /** Specifies whether the legend is located outside or inside the chart's plot. */ - position?: string; - } - export interface ChartTooltip extends BaseChartTooltip { - /** Specifies whether the tooltip must be located in the center of a bar or on its edge. Applies to the Bar and Bubble series. */ - location?: string; - /** Specifies the kind of information to display in a tooltip. */ - shared?: boolean; - } - export interface dxChartOptions extends AdvancedOptions { - adaptiveLayout?: { - keepLabels?: boolean; - }; - /** Indicates whether or not to synchronize value axes when they are displayed on a single pane. */ - synchronizeMultiAxes?: boolean; - /** Specifies whether or not to filter the series points depending on their quantity. */ - useAggregation?: boolean; - /** Indicates whether or not to adjust a value axis to the current minimum and maximum values of a zoomed chart. */ - adjustOnZoom?: boolean; - /** Specifies argument axis options for the dxChart widget. */ - argumentAxis?: ChartArgumentAxis; - /** An object defining the configuration options that are common for all axes of the dxChart widget. */ - commonAxisSettings?: ChartCommonAxisSettings; - /** An object defining the configuration options that are common for all panes in the dxChart widget. */ - commonPaneSettings?: CommonPane; - /** An object defining the configuration options that are common for all series of the dxChart widget. */ - commonSeriesSettings?: CommonSeriesSettings; - /** An object that specifies the appearance options of the chart crosshair. */ - crosshair?: { - /** Specifies a color for the crosshair lines. */ - color?: string; - /** Specifies a dash style for the crosshair lines. */ - dashStyle?: string; - /** Specifies whether to enable the crosshair or not. */ - enabled?: boolean; - /** Specifies the opacity of the crosshair lines. */ - opacity?: number; - /** Specifies the width of the crosshair lines. */ - width?: number; - /** Specifies the appearance of the horizontal crosshair line. */ - horizontalLine?: CrosshaierWithLabel; - /** Specifies the appearance of the vertical crosshair line. */ - verticalLine?: CrosshaierWithLabel; - /** Specifies the options of the crosshair labels. */ - label?: { - /** Specifies a color for the background of the crosshair labels. */ - backgroundColor?: string; - /** Specifies whether the crosshair labels are visible or not. */ - visible?: boolean; - /** Specifies font options for the text of the crosshair labels. */ - font?: viz.core.Font; - /** Specifies the format of the values displayed by crosshair labels. */ - format?: string; - /** Specifies a precision for formatted values. */ - precision?: number; - /** Customizes the text displayed by the crosshair labels. */ - customizeText?: (info: { value: any; valueText: string; point: ChartPoint; }) => string; - } - }; - /** Specifies a default pane for the chart series. */ - defaultPane?: string; - /** Specifies a coefficient determining the diameter of the largest bubble. */ - maxBubbleSize?: number; - /** Specifies the diameter of the smallest bubble measured in pixels. */ - minBubbleSize?: number; - /** Defines the dxChart widget's pane(s). */ - panes?: Array; - /** Swaps the axes round so that the value axis becomes horizontal and the argument axes becomes vertical. */ - rotated?: boolean; - /** Specifies the options of a chart's legend. */ - legend?: Legend; - /** Specifies options for dxChart widget series. */ - series?: Array; - /** Defines options for the series template. */ - seriesTemplate?: SeriesTemplate; - /** Specifies tooltip options. */ - tooltip?: ChartTooltip; - /** Specifies value axis options for the dxChart widget. */ - valueAxis?: Array; - /** Enables scrolling in your chart. */ - scrollingMode?: string; - /** Enables zooming in your chart. */ - zoomingMode?: string; - /** Specifies the settings of the scroll bar. */ - scrollBar?: { - /** Specifies whether the scroll bar is visible or not. */ - visible?: boolean; - /** Specifies the spacing between the scroll bar and the chart's plot in pixels. */ - offset?: number; - /** Specifies the color of the scroll bar. */ - color?: string; - /** Specifies the width of the scroll bar in pixels. */ - width?: number; - /** Specifies the opacity of the scroll bar. */ - opacity?: number; - /** Specifies the position of the scroll bar in the chart. */ - position?: string; - }; - } - /** A widget used to embed charts into HTML JS applications. */ - export class dxChart extends BaseChart { - constructor(element: JQuery, options?: dxChartOptions); - constructor(element: Element, options?: dxChartOptions); - /** Sets the specified start and end values for the chart's argument axis. */ - zoomArgument(startValue: any, endValue: any): void; - } - interface CrosshaierWithLabel extends viz.core.DashedBorderWithOpacity { - /** Configures the label that belongs to the horizontal crosshair line. */ - label?: { - /** Specifies a color for the background of the label that belongs to the horizontal crosshair line. */ - backgroundColor?: string; - /** Specifies whether the label of the horizontal crosshair line is visible or not. */ - visible?: boolean; - /** Specifies font options for the text of the label that belongs to the horizontal crosshair line. */ - font?: viz.core.Font; - /** Specifies the format of the values displayed by crosshair labels. */ - format?: string; - /** Specifies a precision for formatted values. */ - precision?: number; - /** Customizes the text displayed by the crosshair label that accompany the horizontal line. */ - customizeText?: (info: { value: any; valueText: string; point: ChartPoint; }) => string; - } - } - export interface PolarChartTooltip extends BaseChartTooltip { - /** Specifies the kind of information to display in a tooltip. */ - shared?: boolean; - } - export interface dxPolarChartOptions extends AdvancedOptions { - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - width?: number; - height?: number; - /** Specifies whether or not point labels can be hidden when the layout is adapting. */ - keepLabels?: boolean; - }; - /** Indicates whether or not to display a "spider web". */ - useSpiderWeb?: boolean; - /** Specifies argument axis options for the dxPolarChart widget. */ - argumentAxis?: PolarArgumentAxis; - /** An object defining the configuration options that are common for all axes of the dxPolarChart widget. */ - commonAxisSettings?: PolarCommonAxisSettings; - /** An object defining the configuration options that are common for all series of the dxPolarChart widget. */ - commonSeriesSettings?: CommonPolarSeriesSettings; - /** Specifies the options of a chart's legend. */ - legend?: AdvancedLegend; - /** Specifies options for dxPolarChart widget series. */ - series?: Array; - /** Defines options for the series template. */ - seriesTemplate?: PolarSeriesTemplate; - /** Specifies tooltip options. */ - tooltip?: PolarChartTooltip; - /** Specifies value axis options for the dxPolarChart widget. */ - valueAxis?: PolarValueAxis; - } - /** A chart widget displaying data in a polar coordinate system. */ - export class dxPolarChart extends BaseChart { - constructor(element: JQuery, options?: dxPolarChartOptions); - constructor(element: Element, options?: dxPolarChartOptions); - } - export interface PieLegend extends core.BaseLegend { - /** Specifies what chart elements to highlight when a corresponding item in the legend is hovered over. */ - hoverMode?: string; - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item. */ - customizeHint?: (pointInfo: { pointName: string; pointIndex: number; pointColor: string; }) => string; - /** Specifies a callback function that returns the text to be displayed by a legend item. */ - customizeText?: (pointInfo: { pointName: string; pointIndex: number; pointColor: string; }) => string; - } - export interface dxPieChartOptions extends BaseChartOptions { - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - /** Specifies whether or not point labels can be hidden when the layout is adapting. */ - keepLabels?: boolean; - }; - /** Specifies dxPieChart legend options. */ - legend?: PieLegend; - /** Specifies options for the series of the dxPieChart widget. */ - series?: Array; - /** Specifies the diameter of the pie. */ - diameter?: number; - /** Specifies the direction that the pie chart segments will occupy. */ - segmentsDirection?: string; - /** Specifies the angle in arc degrees from which the first segment of a pie chart should start. */ - startAngle?: number; - /** Specifies the fraction of the inner radius relative to the total radius in the series of the 'doughnut' type. The value should be between 0 and 1. */ - innerRadius?: number; - /** A handler for the legendClick event. */ - onLegendClick?: any; - /** Specifies how a chart must behave when series point labels overlap. */ - resolveLabelOverlapping?: string; - /** An object defining the configuration options that are common for all series of the dxPieChart widget. */ - commonSeriesSettings?: CommonPieSeriesSettings; - /** Specifies the type of the pie chart series. */ - type?: string; - } - /** A circular chart widget for HTML JS applications. */ - export class dxPieChart extends BaseChart { - constructor(element: JQuery, options?: dxPieChartOptions); - constructor(element: Element, options?: dxPieChartOptions); - /** - * Provides access to the dxPieChart series. - * @deprecated ..\..\BaseChart\3 Methods\getAllSeries().md - */ - getSeries(): PieSeries; - } -} -interface JQuery { - dxChart(options?: DevExpress.viz.charts.dxChartOptions): JQuery; - dxChart(methodName: string, ...params: any[]): any; - dxChart(methodName: "instance"): DevExpress.viz.charts.dxChart; - dxPieChart(options?: DevExpress.viz.charts.dxPieChartOptions): JQuery; - dxPieChart(methodName: string, ...params: any[]): any; - dxPieChart(methodName: "instance"): DevExpress.viz.charts.dxPieChart; - dxPolarChart(options?: DevExpress.viz.charts.dxPolarChartOptions): JQuery; - dxPolarChart(methodName: string, ...params: any[]): any; - dxPolarChart(methodName: "instance"): DevExpress.viz.charts.dxPolarChart; -} -declare module DevExpress.viz.gauges { - export interface BaseRangeContainer { - /** Specifies a range container's background color. */ - backgroundColor?: string; - /** Specifies the offset of the range container from an invisible scale line in pixels. */ - offset?: number; - /** Sets the name of the palette or an array of colors to be used for coloring the gauge range container. */ - palette?: any; - /** An array of objects representing ranges contained in the range container. */ - ranges?: Array<{ startValue: number; endValue: number; color: string }>; - /** Specifies a color of a range. */ - color?: string; - /** Specifies an end value of a range. */ - endValue?: number; - /** Specifies a start value of a range. */ - startValue?: number; - } - export interface ScaleTick { - /** Specifies the color of the scale's minor ticks. */ - color?: string; - /** - * Specifies an array of custom minor ticks. - * @deprecated ..\customMinorTicks.md - */ - customTickValues?: Array; - /** Specifies the length of the scale's minor ticks. */ - length?: number; - /** - * Indicates whether automatically calculated minor ticks are visible or not. - * @deprecated This functionality in not more available - */ - showCalculatedTicks?: boolean; - /** - * Specifies an interval between minor ticks. - * @deprecated ..\minorTickInterval.md - */ - tickInterval?: number; - /** Indicates whether scale minor ticks are visible or not. */ - visible?: boolean; - /** Specifies the width of the scale's minor ticks. */ - width?: number; - } - export interface ScaleMajorTick extends ScaleTick { - /** - * Specifies whether or not to expand the current major tick interval if labels overlap each other. - * @deprecated ..\label\overlappingBehavior\useAutoArrangement.md - */ - useTicksAutoArrangement?: boolean; - } - export interface ScaleMinorTick extends ScaleTick { - /** Specifies the opacity of the scale's minor ticks. */ - opacity?: number; - } - export interface BaseScaleLabel { - /** Specifies whether or not scale labels should be colored similarly to their corresponding ranges in the range container. */ - useRangeColors?: boolean; - /** Specifies a callback function that returns the text to be displayed in scale labels. */ - customizeText?: (scaleValue: { value: number; valueText: string }) => string; - /** Specifies the overlap resolving options to be applied to scale labels. */ - overlappingBehavior?: { - /** Specifies whether or not to expand the current major tick interval if labels overlap each other. */ - useAutoArrangement?: boolean; - /** Specifies what label to hide in case of overlapping. */ - hideFirstOrLast?: string; - }; - /** Specifies font options for the text displayed in the scale labels of the gauge. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in scale labels. */ - format?: string; - /** Specifies a precision for the formatted value displayed in the scale labels. */ - precision?: number; - /** Specifies whether or not scale labels are visible on the gauge. */ - visible?: boolean; - } - export interface BaseScale { - /** Specifies the end value for the scale of the gauge. */ - endValue?: number; - /** - * Specifies whether or not to hide the first scale label. - * @deprecated This functionality in not more available - */ - hideFirstLabel?: boolean; - /** - * Specifies whether or not to hide the first major tick on the scale. - * @deprecated This functionality in not more available - */ - hideFirstTick?: boolean; - /** - * Specifies whether or not to hide the last scale label. - * @deprecated This functionality in not more available - */ - hideLastLabel?: boolean; - /** - * Specifies whether or not to hide the last major tick on the scale. - * @deprecated This functionality in not more available - */ - hideLastTick?: boolean; - /** Specifies an interval between major ticks. */ - tickInterval?: number; - /** Specifies an interval between minor ticks. */ - minorTickInterval?: number; - /** Specifies an array of custom major ticks. */ - customTicks?: Array; - /** Specifies an array of custom minor ticks. */ - customMinorTicks?: Array; - /** Specifies common options for scale labels. */ - label?: BaseScaleLabel; - /** - * Specifies options of the gauge's major ticks. - * @deprecated ..\tick\tick.md - */ - majorTick?: ScaleMajorTick; - /** Specifies options of the gauge's major ticks. */ - tick?: { - /** Specifies the color of the scale's major ticks. */ - color?: string; - /** Specifies the length of the scale's major ticks. */ - length?: number; - /** Indicates whether scale major ticks are visible or not. */ - visible?: boolean; - /** Specifies the width of the scale's major ticks. */ - width?: number; - /** Specifies the opacity of the scale's major ticks. */ - opacity?: number; - }; - /** Specifies options of the gauge's minor ticks. */ - minorTick?: ScaleMinorTick; - /** Specifies the start value for the scale of the gauge. */ - startValue?: number; - } - export interface BaseValueIndicator { - /** Specifies the type of subvalue indicators. */ - type?: string; - /** Specifies the background color for the indicator of the rangeBar type. */ - backgroundColor?: string; - /** Specifies the base value for the indicator of the rangeBar type. */ - baseValue?: number; - /** Specifies a color of the indicator. */ - color?: string; - /** Specifies the range bar size for an indicator of the rangeBar type. */ - size?: number; - text?: { - /** Specifies a callback function that returns the text to be displayed in an indicator. */ - customizeText?: (indicatedValue: { value: number; valueText: string }) => string; - font?: viz.core.Font; - /** Specifies a format for the text displayed in an indicator. */ - format?: string; - /** Specifies the range bar's label indent in pixels. */ - indent?: number; - /** Specifies a precision for the formatted value displayed by an indicator. */ - precision?: number; - }; - offset?: number; - length?: number; - width?: number; - /** Specifies the length of an arrow for the indicator of the textCloud type in pixels. */ - arrowLength?: number; - /** Sets the array of colors to be used for coloring subvalue indicators. */ - palette?: Array; - /** Specifies the distance between the needle and the center of a gauge for the indicator of a needle-like type. */ - indentFromCenter?: number; - /** Specifies the second color for the indicator of the twoColorNeedle type. */ - secondColor?: string; - /** Specifies the length of a twoNeedleColor type indicator tip as a percentage. */ - secondFraction?: number; - /** Specifies the spindle's diameter in pixels for the indicator of a needle-like type. */ - spindleSize?: number; - /** Specifies the inner diameter in pixels, so that the spindle has the shape of a ring. */ - spindleGapSize?: number; - /** Specifies the orientation of the rangeBar indicator on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - /** Specifies the orientation of the rangeBar indicator on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - } - export interface SharedGaugeOptions { - /** Specifies animation options. */ - animation?: viz.core.Animation; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */ - redrawOnResize?: boolean; - /** Specifies the size of the widget in pixels. */ - size?: viz.core.Size; - /** - * Specifies a subtitle for the widget. - * @deprecated ..\..\..\BaseGauge\1 Configuration\title\subtitle\subtitle.md - */ - subtitle?: { - /** - * Specifies font options for the subtitle. - * @deprecated ..\..\title\subtitle\font\font.md - */ - font?: viz.core.Font; - /** - * Specifies a text for the subtitle. - * @deprecated ..\title\subtitle\text.md - */ - text?: string; - }; - /** Specifies a title for a gauge. */ - title?: { - /** Specifies font options for the title. */ - font?: viz.core.Font; - /** - * Specifies a title's position on the gauge. - * @deprecated basegaugeoptions_title_verticalAlignment and basegaugeoptions_title_horizontalAlignment - */ - position?: string; - /** Specifies the distance between the title and surrounding gauge elements in pixels. */ - margin?: viz.core.Margins; - /** Specifies the height of the space reserved for the title. */ - placeholderSize?: number; - /** Specifies the gauge title's position in the vertical direction. */ - verticalAlignment?: string; - /** Specifies the gauge title's horizontal position. */ - horizontalAlignment?: string; - /** Specifies text for the title. */ - text?: string; - /** Specifies a subtitle for the widget. */ - subtitle?: { - /** Specifies font options for the subtitle. */ - font?: viz.core.Font; - /** Specifies text for the subtitle. */ - text?: string; - } - }; - /** Specifies options for gauge tooltips. */ - tooltip?: viz.core.Tooltip; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: dxBaseGauge; - element: Element; - target: {}; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: dxBaseGauge; - element: Element; - target: {}; - }) => void; - } - export interface BaseGaugeOptions extends viz.core.BaseWidgetOptions, SharedGaugeOptions { - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** Specifies the blank space in pixels between the widget's extreme elements and the boundaries of the area provided for the widget (see the size option). */ - margin?: viz.core.Margins; - /** Specifies options of the gauge's range container. */ - rangeContainer?: BaseRangeContainer; - /** Specifies a gauge's scale options. */ - scale?: BaseScale; - /** Specifies the appearance options of subvalue indicators. */ - subvalueIndicator?: BaseValueIndicator; - /** Specifies a set of subvalues to be designated by the subvalue indicators. */ - subvalues?: Array; - /** Specifies the main value on a gauge. */ - value?: number; - /** Specifies the appearance options of the value indicator. */ - valueIndicator?: BaseValueIndicator; - } - /** A gauge widget. */ - export class dxBaseGauge extends viz.core.BaseWidget { - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(): void; - /** Returns the main gauge value. */ - value(): number; - /** Updates a gauge value. */ - value(value: number): void; - /** Returns an array of gauge subvalues. */ - subvalues(): Array; - /** Updates gauge subvalues. */ - subvalues(subvalues: Array): void; - } - export interface LinearRangeContainer extends BaseRangeContainer { - /** Specifies the orientation of the range container on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - /** Specifies the orientation of a range container on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - /** Specifies the width of the range container's start and end boundaries in the dxLinearGauge widget. */ - width?: any; - /** Specifies an end width of a range container. */ - end?: number; - /** Specifies a start width of a range container. */ - start?: number; - } - export interface LinearScaleLabel extends BaseScaleLabel { - /** Specifies the spacing between scale labels and ticks. */ - indentFromTick?: number; - } - export interface LinearScale extends BaseScale { - /** Specifies the orientation of scale ticks on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - label?: LinearScaleLabel; - /** Specifies the orientation of scale ticks on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - } - export interface dxLinearGaugeOptions extends BaseGaugeOptions { - /** Specifies the options required to set the geometry of the dxLinearGauge widget. */ - geometry?: { - /** Indicates whether to display the dxLinearGauge widget vertically or horizontally. */ - orientation?: string; - }; - /** Specifies gauge range container options. */ - rangeContainer?: LinearRangeContainer; - scale?: LinearScale; - } - /** A widget that represents a gauge with a linear scale. */ - export class dxLinearGauge extends dxBaseGauge { - constructor(element: JQuery, options?: dxLinearGaugeOptions); - constructor(element: Element, options?: dxLinearGaugeOptions); - } - export interface CircularRangeContainer extends BaseRangeContainer { - /** Specifies the orientation of the range container in the dxCircularGauge widget. */ - orientation?: string; - /** Specifies the range container's width in pixels. */ - width?: number; - } - export interface CircularScaleLabel extends BaseScaleLabel { - /** Specifies the spacing between scale labels and ticks. */ - indentFromTick?: number; - } - export interface CircularScale extends BaseScale { - label?: CircularScaleLabel; - /** Specifies the orientation of scale ticks. */ - orientation?: string; - } - export interface dxCircularGaugeOptions extends BaseGaugeOptions { - /** Specifies the options required to set the geometry of the dxCircularGauge widget. */ - geometry?: { - /** Specifies the end angle of the circular gauge's arc. */ - endAngle?: number; - /** Specifies the start angle of the circular gauge's arc. */ - startAngle?: number; - }; - /** Specifies gauge range container options. */ - rangeContainer?: CircularRangeContainer; - scale?: CircularScale; - } - /** A widget that represents a gauge with a circular scale. */ - export class dxCircularGauge extends dxBaseGauge { - constructor(element: JQuery, options?: dxCircularGaugeOptions); - constructor(element: Element, options?: dxCircularGaugeOptions); - } - export interface dxBarGaugeOptions extends viz.core.BaseWidgetOptions, SharedGaugeOptions { - /** Specifies a color for the remaining segment of the bar's track. */ - backgroundColor?: string; - /** Specifies a distance between bars in pixels. */ - barSpacing?: number; - /** Specifies a base value for bars. */ - baseValue?: number; - /** Specifies an end value for the gauge's invisible scale. */ - endValue?: number; - /** Defines the shape of the gauge's arc. */ - geometry?: { - /** Specifies the end angle of the bar gauge's arc. */ - endAngle?: number; - /** Specifies the start angle of the bar gauge's arc. */ - startAngle?: number; - }; - /** Specifies the options of the labels that accompany gauge bars. */ - label?: { - /** Specifies a color for the label connector text. */ - connectorColor?: string; - /** Specifies the width of the label connector in pixels. */ - connectorWidth?: number; - /** Specifies a callback function that returns a text for labels. */ - customizeText?: (barValue: { value: number; valueText: string }) => string; - /** Specifies font options for bar labels. */ - font?: viz.core.Font; - /** Specifies a format for bar labels. */ - format?: string; - /** Specifies the distance between the upper bar and bar labels in pixels. */ - indent?: number; - /** Specifies a precision for the formatted value displayed by labels. */ - precision?: number; - /** Specifies whether bar labels appear on a gauge or not. */ - visible?: boolean; - }; - /** Sets the name of the palette or an array of colors to be used for coloring the gauge range container. */ - palette?: string; - /** Defines the radius of the bar that is closest to the center relatively to the radius of the topmost bar. */ - relativeInnerRadius?: number; - /** Specifies a start value for the gauge's invisible scale. */ - startValue?: number; - /** Specifies the array of values to be indicated on a bar gauge. */ - values?: Array; - } - /** A circular bar widget. */ - export class dxBarGauge extends viz.core.BaseWidget { - constructor(element: JQuery, options?: dxBarGaugeOptions); - constructor(element: Element, options?: dxBarGaugeOptions); - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws the widget. */ - render(): void; - /** Returns an array of gauge values. */ - values(): Array; - /** Updates the values displayed by a gauge. */ - values(values: Array): void; - } -} -interface JQuery { - dxLinearGauge(options?: DevExpress.viz.gauges.dxLinearGaugeOptions): JQuery; - dxLinearGauge(methodName: string, ...params: any[]): any; - dxLinearGauge(methodName: "instance"): DevExpress.viz.gauges.dxLinearGauge; - dxCircularGauge(options?: DevExpress.viz.gauges.dxCircularGaugeOptions): JQuery; - dxCircularGauge(methodName: string, ...params: any[]): any; - dxCircularGauge(methodName: "instance"): DevExpress.viz.gauges.dxCircularGauge; - dxBarGauge(options?: DevExpress.viz.gauges.dxBarGaugeOptions): JQuery; - dxBarGauge(methodName: string, ...params: any[]): any; - dxBarGauge(methodName: "instance"): DevExpress.viz.gauges.dxBarGauge; -} -declare module DevExpress.viz.rangeSelector { - export interface dxRangeSelectorOptions extends viz.core.BaseWidgetOptions { - /** Specifies the options for the range selector's background. */ - background?: { - /** Specifies the background color for the dxRangeSelector. */ - color?: string; - /** Specifies image options. */ - image?: { - /** Specifies a location for the image in the background of a range selector. */ - location?: string; - /** Specifies the image's URL. */ - url?: string; - }; - /** Indicates whether or not the background (background color and/or image) is visible. */ - visible?: boolean; - }; - /** Specifies a title for the range selector. */ - title?: viz.core.Title; - /** Specifies the dxRangeSelector's behavior options. */ - behavior?: { - /** Indicates whether or not you can swap sliders. */ - allowSlidersSwap?: boolean; - /** Indicates whether or not animation is enabled. */ - animationEnabled?: boolean; - /** Specifies when to call the onSelectedRangeChanged function. */ - callSelectedRangeChanged?: string; - /** Indicates whether or not an end user can specify the range using a mouse, without the use of sliders. */ - manualRangeSelectionEnabled?: boolean; - /** Indicates whether or not an end user can shift the selected range to the required location on a scale by clicking. */ - moveSelectedRangeByClick?: boolean; - /** Indicates whether to snap a slider to ticks. */ - snapToTicks?: boolean; - }; - /** Specifies the options required to display a chart as the range selector's background. */ - chart?: { - /** Specifies a coefficient for determining an indent from the bottom background boundary to the lowest chart point. */ - bottomIndent?: number; - /** An object defining the common configuration options for the chart’s series. */ - commonSeriesSettings?: viz.charts.CommonSeriesSettings; - /** An object providing options for managing data from a data source. */ - dataPrepareSettings?: { - /** Specifies whether or not to validate values from a data source. */ - checkTypeForAllData?: boolean; - /** Specifies whether or not to convert the values from a data source into the data type of an axis. */ - convertToAxisDataType?: boolean; - /** Specifies how to sort series points. */ - sortingMethod?: any; - }; - /** Specifies whether all bars in a series must have the same width, or may have different widths if any points in other series are missing. */ - equalBarWidth?: boolean; - /** Specifies a common bar width as a percentage from 0 to 1. */ - barWidth?: number; - /** Forces the widget to treat negative values as zeroes. Applies to stacked-like series only. */ - negativesAsZeroes?: boolean; - /** Sets the name of the palette to be used in the range selector's chart. Alternatively, an array of colors can be set as a custom palette to be used within this chart. */ - palette?: any; - /** An object defining the chart’s series. */ - series?: Array; - /** Defines options for the series template. */ - seriesTemplate?: viz.charts.SeriesTemplate; - /** Specifies a coefficient for determining an indent from the background's top boundary to the topmost chart point. */ - topIndent?: number; - /** Specifies whether or not to filter the series points depending on their quantity. */ - useAggregation?: boolean; - /** Specifies options for the chart's value axis. */ - valueAxis?: { - /** Indicates whether or not the chart's value axis must be inverted. */ - inverted?: boolean; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic value axis. */ - logarithmBase?: number; - /** Specifies the maximum value of the chart's value axis. */ - max?: number; - /** Specifies the minimum value of the chart's value axis. */ - min?: number; - /** Specifies the type of the value axis. */ - type?: string; - /** Specifies the desired type of axis values. */ - valueType?: string; - }; - }; - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** Specifies a data source for the scale values and for the chart at the background. */ - dataSource?: any; - /** Specifies the data source field that provides data for the scale. */ - dataSourceField?: string; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** Specifies the blank space in pixels between the dxRangeSelector widget's extreme elements and the boundaries of the area provided for the widget (see size). */ - margin?: viz.core.Margins; - /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */ - redrawOnResize?: boolean; - /** Specifies options of the range selector's scale. */ - scale?: { - /** Specifies the scale's end value. */ - endValue?: any; - /** Specifies common options for scale labels. */ - label?: { - /** Specifies a callback function that returns the text to be displayed in scale labels. */ - customizeText?: (scaleValue: { value: any; valueText: string; }) => string; - /** Specifies font options for the text displayed in the range selector's scale labels. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in scale labels. */ - format?: string; - /** Specifies a precision for the formatted value displayed in the scale labels. */ - precision?: number; - /** Specifies a spacing between scale labels and the background bottom edge. */ - topIndent?: number; - /** Specifies whether or not the scale's labels are visible. */ - visible?: boolean; - }; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic scale. */ - logarithmBase?: number; - /** - * Specifies an interval between major ticks. - * @deprecated ..\tickInterval\tickInterval.md - */ - majorTickInterval?: any; - /** Specifies an interval between axis ticks. */ - tickInterval?: any; - /** Specifies options for the date-time scale's markers. */ - marker?: { - /** Defines the options that can be set for the text that is displayed by the scale markers. */ - label?: { - /** Specifies a callback function that returns the text to be displayed in scale markers. */ - customizeText?: (markerValue: { value: any; valueText: string }) => string; - /** Specifies a format for the text displayed in scale markers. */ - format?: string; - }; - /** Specifies the height of the marker's separator. */ - separatorHeight?: number; - /** Specifies the space between the marker label and the marker separator. */ - textLeftIndent?: number; - /** Specifies the space between the marker's label and the top edge of the marker's separator. */ - textTopIndent?: number; - /** Specified the indent between the marker and the scale lables. */ - topIndent?: number; - /** Indicates whether scale markers are visible. */ - visible?: boolean; - }; - /** Specifies the maximum range that can be selected. */ - maxRange?: any; - /** Specifies the number of minor ticks between neighboring major ticks. */ - minorTickCount?: number; - /** Specifies an interval between minor ticks. */ - minorTickInterval?: any; - /** Specifies the minimum range that can be selected. */ - minRange?: any; - /** Specifies the height of the space reserved for the scale in pixels. */ - placeholderHeight?: number; - /** Indicates whether or not to set ticks of a date-time scale at the beginning of each date-time interval. */ - setTicksAtUnitBeginning?: boolean; - /** Specifies whether or not to show ticks for the boundary scale values, when neither major ticks nor minor ticks are created for these values. */ - showCustomBoundaryTicks?: boolean; - /** - * Indicates whether or not to show minor ticks on the scale. - * @deprecated minorTick\visible.md - */ - showMinorTicks?: boolean; - /** Specifies the scale's start value. */ - startValue?: any; - /** Specifies options defining the appearance of scale ticks. */ - tick?: { - /** Specifies the color of scale ticks (both major and minor ticks). */ - color?: string; - /** Specifies the opacity of scale ticks (both major and minor ticks). */ - opacity?: number; - /** Specifies the width of the scale's ticks (both major and minor ticks). */ - width?: number; - }; - /** Specifies options of the range selector's minor ticks. */ - minorTick?: { - /** Specifies the color of the scale's minor ticks. */ - color?: string; - /** Specifies the opacity of the scale's minor ticks. */ - opacity?: number; - /** Specifies the width of the scale's minor ticks. */ - width?: number; - /** Indicates whether scale minor ticks are visible or not. */ - visible?: boolean; - }; - /** Specifies the type of the scale. */ - type?: string; - /** Specifies whether or not to expand the current tick interval if labels overlap each other. */ - useTicksAutoArrangement?: boolean; - /** Specifies the type of values on the scale. */ - valueType?: string; - /** Specifies the order of arguments on a discrete scale. */ - categories?: Array; - }; - /** Specifies the range to be selected when displaying the dxRangeSelector. */ - selectedRange?: { - /** Specifies the start value of the range to be selected when displaying the dxRangeSelector widget on a page. */ - startValue?: any; - /** Specifies the end value of the range to be selected when displaying the dxRangeSelector widget on a page. */ - endValue?: any; - }; - /** Specifies the color of the selected range. */ - selectedRangeColor?: string; - /** Range selector's indent options. */ - indent?: { - /** Specifies range selector's left indent. */ - left?: number; - /** Specifies range selector's right indent. */ - right?: number; - }; - /** A handler for the selectedRangeChanged event. */ - onSelectedRangeChanged?: (e: { - startValue: any; - endValue: any; - component: dxRangeSelector; - element: Element; - }) => void; - /** Specifies range selector shutter options. */ - shutter?: { - /** Specifies shutter color. */ - color?: string; - /** Specifies the opacity of the color of shutters. */ - opacity?: number; - }; - /** Specifies in pixels the size of the dxRangeSelector widget. */ - size?: viz.core.Size; - /** Specifies the appearance of the range selector's slider handles. */ - sliderHandle?: { - /** Specifies the color of the slider handles. */ - color?: string; - /** Specifies the opacity of the slider handles. */ - opacity?: number; - /** Specifies the width of the slider handles. */ - width?: number; - }; - /** Defines the options of the range selector slider markers. */ - sliderMarker?: { - /** Specifies the color of the slider markers. */ - color?: string; - /** Specifies a callback function that returns the text to be displayed by slider markers. */ - customizeText?: (scaleValue: { value: any; valueText: any; }) => string; - /** Specifies font options for the text displayed by the range selector slider markers. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in slider markers. */ - format?: string; - /** Specifies the color used for the slider marker text when the currently selected range does not match the minRange and maxRange values. */ - invalidRangeColor?: string; - /** - * Specifies the empty space between the marker's border and the marker’s text. - * @deprecated Use the 'paddingTopBottom' and 'paddingLeftRight' options instead - */ - padding?: number; - /** Specifies the empty space between the marker's top and bottom borders and the marker's text. */ - paddingTopBottom?: number; - /** Specifies the empty space between the marker's left and right borders and the marker's text. */ - paddingLeftRight?: number; - /** Specifies the placeholder height of the slider marker. */ - placeholderHeight?: number; - /** - * Specifies in pixels the height and width of the space reserved for the range selector slider markers. - * @deprecated Use the 'placeholderHeight' and 'indent' options instead - */ - placeholderSize?: { - /** Specifies the height of the placeholder for the left and right slider markers. */ - height?: number; - /** Specifies the width of the placeholder for the left and right slider markers. */ - width?: { - /** Specifies the width of the left slider marker's placeholder. */ - left?: number; - /** Specifies the width of the right slider marker's placeholder. */ - right?: number; - }; - }; - /** Specifies a precision for the formatted value displayed in slider markers. */ - precision?: number; - /** Indicates whether or not the slider markers are visible. */ - visible?: boolean; - }; - } - /** A widget that allows end users to select a range of values on a scale. */ - export class dxRangeSelector extends viz.core.BaseWidget { - constructor(element: JQuery, options?: dxRangeSelectorOptions); - constructor(element: Element, options?: dxRangeSelectorOptions); - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(skipChartAnimation?: boolean): void; - /** Returns the currently selected range. */ - getSelectedRange(): { startValue: any; endValue: any; }; - /** Sets a specified range. */ - setSelectedRange(selectedRange: { startValue: any; endValue: any; }): void; - } -} -interface JQuery { - dxRangeSelector(options?: DevExpress.viz.rangeSelector.dxRangeSelectorOptions): JQuery; - dxRangeSelector(methodName: string, ...params: any[]): any; - dxRangeSelector(methodName: "instance"): DevExpress.viz.rangeSelector.dxRangeSelector; -} -declare module DevExpress.viz.map { - /** This section describes the fields and methods that can be used in code to manipulate the Layer object. */ - export interface MapLayer { - /** The name of the layer. */ - name: string; - /** The layer index in the layers array. */ - index: number; - /** The layer type. Can be "area", "line" or "marker". */ - type: string; - /** The type of the layer elements. */ - elementType: string; - /** Gets all layer elements. */ - getElements(): Array; - /** Deselects all layer elements. */ - clearSelection(): void; - } - /** This section describes the fields and methods that can be used in code to manipulate the Layer Element object. */ - export interface MapLayerElement { - /** The parent layer of the layer element. */ - layer: MapLayer; - /** Gets the layer element coordinates. */ - coordinates(): Object; - /** Sets the value of an attribute. */ - attribute(name: string, value: any): void; - /** Gets the value of an attribute. */ - attribute(name: string): any; - /** Gets the selection state of the layer element. */ - selected(): boolean; - /** Sets the selection state of the layer element. */ - selected(state: boolean): void; - /** Applies the layer element settings and updates element appearance. */ - applySettings(settings: any): void; - } - /** - * This section describes the fields and methods that can be used in code to manipulate the Area object. - * @deprecated Use the "Layer Element" instead - */ - export interface Area { - /** - * Contains the element type. - * @deprecated ..\..\Layer\2 Fields\type.md - */ - type: string; - /** - * Return the value of an attribute. - * @deprecated ..\..\Layer Element\3 Methods\attribute(name_value).md - */ - attribute(name: string): any; - /** - * Provides information about the selection state of an area. - * @deprecated Use the "selected()" method of the Layer Element - */ - selected(): boolean; - /** - * Sets a new selection state for an area. - * @deprecated Use the "selected(state)" method of the Layer Element - */ - selected(state: boolean): void; - /** - * Applies the area settings specified as a parameter and updates the area appearance. - * @deprecated ..\..\Layer Element\3 Methods\applySettings(settings).md - */ - applySettings(settings: any): void; - } - /** - * This section describes the fields and methods that can be used in code to manipulate the Markers object. - * @deprecated Use the "Layer Element" instead - */ - export interface Marker { - /** - * Contains the descriptive text accompanying the map marker. - * @deprecated Get the text with the "attribute" method (using the "layers.label.dataField" value) - */ - text: string; - /** - * Contains the type of the element. - * @deprecated ..\..\Layer\2 Fields\type.md - */ - type: string; - /** - * Contains the URL of an image map marker. - * @deprecated Get the url with the "attribute" method (using the "layers.dataField" value) - */ - url: string; - /** - * Contains the value of a bubble map marker. - * @deprecated Get the value with the "attribute" method (using the "layers.dataField" value) - */ - value: number; - /** - * Contains the values of a pie map marker. - * @deprecated Get the values with the "attribute" method (using the "layers.dataField" value) - */ - values: Array; - /** - * Returns the value of an attribute. - * @deprecated ..\..\Layer Element\3 Methods\attribute(name_value).md - */ - attribute(name: string): any; - /** - * Returns the coordinates of a specific marker. - * @deprecated ..\..\Layer Element\3 Methods\coordinates().md - */ - coordinates(): Array; - /** - * Provides information about the selection state of a marker. - * @deprecated Use the "selected()" method of the Layer Element - */ - selected(): boolean; - /** - * Sets a new selection state for a marker. - * @deprecated Use the "selected(state)" method of the Layer Element - */ - selected(state: boolean): void; - /** - * Applies the marker settings specified as a parameter and updates marker appearance. - * @deprecated ..\..\Layer Element\3 Methods\applySettings(settings).md - */ - applySettings(settings: any): void; - } - export interface MapLayerSettings { - /** Specifies the layer name. */ - name?: string; - /** Specifies layer type. */ - type?: string; - /** Specifies the type of a marker element. Setting this option makes sense only if the layer type is "marker". */ - elementType?: string; - /** Specifies a data source for the layer. */ - data?: any; - /** Specifies the line width (for layers of a line type) or width of the layer elements border in pixels. */ - borderWidth?: number; - /** Specifies a color for the border of the layer elements. */ - borderColor?: string; - /** Specifies a color for layer elements. */ - color?: string; - /** Specifies a color for the border of the layer element when it is hovered over. */ - hoveredBorderColor?: string; - /** Specifies the pixel-measured line width (for layers of a line type) or width for the border of the layer element when it is hovered over. */ - hoveredBorderWidth?: number; - /** Specifies a color for a layer element when it is hovered over. */ - hoveredColor?: string; - /** Specifies a pixel-measured line width (for layers of a line type) or width for the border of the layer element when it is selected. */ - selectedBorderWidth?: number; - /** Specifies a color for the border of the layer element when it is selected. */ - selectedBorderColor?: string; - /** Specifies a color for the layer element when it is selected. */ - selectedColor?: string; - /** Specifies the layer opacity (from 0 to 1). */ - opacity?: number; - /** Specifies the size of markers. Setting this option makes sense only if the layer type is "marker" and the elementType is "dot", "pie" or "image". */ - size?: number; - /** Specifies the pixel-measured diameter of the marker that represents the smallest value. Setting this option makes sense only if the layer type is "marker". */ - minSize?: number; - /** Specifies the pixel-measured diameter of the marker that represents the biggest value. Setting this option makes sense only if the layer type is "marker". */ - maxSize?: number; - /** Specifies whether or not to change the appearance of a layer element when it is hovered over. */ - hoverEnabled?: boolean; - /** Specifies whether single or multiple map elements can be selected on a vector map. */ - selectionMode?: string; - /** Specifies the name of the palette or a custom range of colors to be used for coloring a layer. */ - palette?: any; - /** Specifies the number of colors in a palette. */ - paletteSize?: number; - /** Allows you to paint layer elements with similar attributes in the same color. */ - colorGroups?: Array; - /** Specifies the field that provides data to be used for coloring of layer elements. */ - colorGroupingField?: string; - /** Allows you to display bubbles with similar attributes in the same size. Setting this option makes sense only if the layer type is "marker" and the elementType is "bubble". */ - sizeGroups?: Array; - /** Specifies the field that provides data to be used for sizing bubble markers. Setting this option makes sense only if the layer type is "marker" and the elementType is "bubble". */ - sizeGroupingField?: string; - /** Specifies the name of the attribute containing marker data. Setting this option makes sense only if the layer type is "marker" and the elementType is "bubble", "pie" or "image". */ - dataField?: string; - /** Specifies the function that customizes each layer element individually. */ - customize?: (eleemnts: Array) => void; - /** Specifies marker label options. */ - label?: { - /** The name of the data attribute containing marker texts. */ - dataField?: string; - /** Enables marker labels. */ - enabled?: boolean; - /** Specifies font options for marker labels. */ - font?: viz.core.Font; - }; - } - export interface AreaSettings { - /** - * Specifies the width of the area border in pixels. - * @deprecated ..\layers\borderWidth.md - */ - borderWidth?: number; - /** - * Specifies a color for the area border. - * @deprecated ..\layers\borderColor.md - */ - borderColor?: string; - /** - * Specifies a color for an area. - * @deprecated ..\layers\color.md - */ - color?: string; - /** - * Specifies the function that customizes each area individually. - * @deprecated ..\layers\customize.md - */ - customize?: (areaInfo: Area) => AreaSettings; - /** - * Specifies a color for the area border when the area is hovered over. - * @deprecated ..\layers\hoveredBorderColor.md - */ - hoveredBorderColor?: string; - /** - * Specifies the pixel-measured width of the area border when the area is hovered over. - * @deprecated ..\layers\hoveredBorderWidth.md - */ - hoveredBorderWidth?: number; - /** - * Specifies a color for an area when this area is hovered over. - * @deprecated ..\layers\hoveredColor.md - */ - hoveredColor?: string; - /** - * Specifies whether or not to change the appearance of an area when it is hovered over. - * @deprecated ..\layers\hoverEnabled.md - */ - hoverEnabled?: boolean; - /** - * Configures area labels. - * @deprecated ..\..\layers\label\label.md - */ - label?: { - /** - * Specifies the data field that provides data for area labels. - * @deprecated ..\..\layers\label\dataField.md - */ - dataField?: string; - /** - * Enables area labels. - * @deprecated ..\..\layers\label\enabled.md - */ - enabled?: boolean; - /** - * Specifies font options for area labels. - * @deprecated ..\..\..\layers\label\font\font.md - */ - font?: viz.core.Font; - }; - /** - * Specifies the name of the palette or a custom range of colors to be used for coloring a map. - * @deprecated ..\layers\palette.md - */ - palette?: any; - /** - * Specifies the number of colors in a palette. - * @deprecated ..\layers\paletteSize.md - */ - paletteSize?: number; - /** - * Allows you to paint areas with similar attributes in the same color. - * @deprecated ..\layers\colorGroups.md - */ - colorGroups?: Array; - /** - * Specifies the field that provides data to be used for coloring areas. - * @deprecated ..\layers\colorGroupingField.md - */ - colorGroupingField?: string; - /** - * Specifies a color for the area border when the area is selected. - * @deprecated ..\layers\selectedBorderColor.md - */ - selectedBorderColor?: string; - /** - * Specifies a color for an area when this area is selected. - * @deprecated ..\layers\selectedColor.md - */ - selectedColor?: string; - /** - * Specifies the pixel-measured width of the area border when the area is selected. - * @deprecated ..\layers\selectedBorderWidth.md - */ - selectedBorderWidth?: number; - /** - * Specifies whether single or multiple areas can be selected on a vector map. - * @deprecated ..\layers\selectionMode.md - */ - selectionMode?: string; - } - export interface MarkerSettings { - /** - * Specifies a color for the marker border. - * @deprecated ..\layers\borderColor.md - */ - borderColor?: string; - /** - * Specifies the width of the marker border in pixels. - * @deprecated ..\layers\borderWidth.md - */ - borderWidth?: number; - /** - * Specifies a color for a marker of the dot or bubble type. - * @deprecated ..\layers\color.md - */ - color?: string; - /** - * Specifies the function that customizes each marker individually. - * @deprecated ..\layers\customize.md - */ - customize?: (markerInfo: Marker) => MarkerSettings; - /** - * Specifies the pixel-measured width of the marker border when the marker is hovered over. - * @deprecated ..\layers\hoveredBorderWidth.md - */ - hoveredBorderWidth?: number; - /** - * Specifies a color for the marker border when the marker is hovered over. - * @deprecated ..\layers\hoveredBorderColor.md - */ - hoveredBorderColor?: string; - /** - * Specifies a color for a marker of the dot or bubble type when this marker is hovered over. - * @deprecated ..\layers\hoveredColor.md - */ - hoveredColor?: string; - /** - * Specifies whether or not to change the appearance of a marker when it is hovered over. - * @deprecated ..\layers\hoverEnabled.md - */ - hoverEnabled?: boolean; - /** - * Specifies marker label options. - * @deprecated ..\..\layers\label\label.md - */ - label?: { - /** - * Enables marker labels. - * @deprecated ..\..\layers\label\enabled.md - */ - enabled?: boolean; - /** - * Specifies font options for marker labels. - * @deprecated ..\..\..\layers\label\font\font.md - */ - font?: viz.core.Font; - }; - /** - * Specifies the pixel-measured diameter of the marker that represents the biggest value. Setting this option makes sense only if you use markers of the bubble type. - * @deprecated ..\layers\maxSize.md - */ - maxSize?: number; - /** - * Specifies the pixel-measured diameter of the marker that represents the smallest value. Setting this option makes sense only if you use markers of the bubble type. - * @deprecated ..\layers\minSize.md - */ - minSize?: number; - /** - * Specifies the opacity of markers. Setting this option makes sense only if you use markers of the bubble type. - * @deprecated ..\layers\opacity.md - */ - opacity?: number; - /** - * Specifies the pixel-measured width of the marker border when the marker is selected. - * @deprecated ..\layers\selectedBorderWidth.md - */ - selectedBorderWidth?: number; - /** - * Specifies a color for the marker border when the marker is selected. - * @deprecated ..\layers\selectedBorderColor.md - */ - selectedBorderColor?: string; - /** - * Specifies a color for a marker of the dot or bubble type when this marker is selected. - * @deprecated ..\layers\selectedColor.md - */ - selectedColor?: string; - /** - * Specifies whether a single or multiple markers can be selected on a vector map. - * @deprecated ..\layers\selectionMode.md - */ - selectionMode?: string; - /** - * Specifies the size of markers. Setting this option makes sense for any type of marker except bubble. - * @deprecated ..\layers\size.md - */ - size?: number; - /** - * Specifies the type of markers to be used on the map. - * @deprecated ..\layers\elementType.md - */ - type?: string; - /** - * Specifies the name of a palette or a custom set of colors to be used for coloring markers of the pie type. - * @deprecated ..\layers\palette.md - */ - palette?: any; - /** - * Allows you to paint markers with similar attributes in the same color. - * @deprecated ..\layers\colorGroups.md - */ - colorGroups?: Array; - /** - * Specifies the field that provides data to be used for coloring markers. - * @deprecated ..\layers\colorGroupingField.md - */ - colorGroupingField?: string; - /** - * Allows you to display bubbles with similar attributes in the same size. - * @deprecated ..\layers\sizeGroups.md - */ - sizeGroups?: Array; - /** - * Specifies the field that provides data to be used for sizing bubble markers. - * @deprecated ..\layers\sizeGroupingField.md - */ - sizeGroupingField?: string; - } - export interface dxVectorMapOptions extends viz.core.BaseWidgetOptions { - /** - * An object specifying options for the map areas. - * @deprecated Use the 'layers' option instead - */ - areaSettings?: AreaSettings; - /** Specifies the options for the map background. */ - background?: { - /** Specifies a color for the background border. */ - borderColor?: string; - /** Specifies a color for the background. */ - color?: string; - }; - /** Specifies options for dxVectorMap widget layers. */ - layers?: Array; - /** Specifies the map projection. */ - projection?: Object; - /** Specifies the positioning of a map in geographical coordinates. */ - bounds?: Array; - /** Specifies the options of the control bar. */ - controlBar?: { - /** Specifies a color for the outline of the control bar elements. */ - borderColor?: string; - /** Specifies a color for the inner area of the control bar elements. */ - color?: string; - /** Specifies whether or not to display the control bar. */ - enabled?: boolean; - /** Specifies the margin of the control bar in pixels. */ - margin?: number; - /** Specifies the position of the control bar. */ - horizontalAlignment?: string; - /** Specifies the position of the control bar. */ - verticalAlignment?: string; - /** Specifies the opacity of the Control_Bar. */ - opacity?: number; - }; - /** Specifies the appearance of the loading indicator. */ - loadingIndicator?: viz.core.LoadingIndicator; - /** - * Specifies a data source for the map area. - * @deprecated Use the 'layers.data' option instead - */ - mapData?: any; - /** - * Specifies a data source for the map markers. - * @deprecated Use the 'layers.data' option instead - */ - markers?: any; - /** - * An object specifying options for the map markers. - * @deprecated Use the 'layers' option instead - */ - markerSettings?: MarkerSettings; - /** Specifies the size of the dxVectorMap widget. */ - size?: viz.core.Size; - /** Specifies a title for the vector map. */ - title?: viz.core.Title; - /** Specifies tooltip options. */ - tooltip?: viz.core.Tooltip; - /** Configures map legends. */ - legends?: Array; - /** Specifies whether or not the map should respond when a user rolls the mouse wheel. */ - wheelEnabled?: boolean; - /** Specifies whether the map should respond to touch gestures. */ - touchEnabled?: boolean; - /** Disables the zooming capability. */ - zoomingEnabled?: boolean; - /** Specifies the geographical coordinates of the center for a map. */ - center?: Array; - /** A handler for the centerChanged event. */ - onCenterChanged?: (e: { - center: Array; - component: dxVectorMap; - element: Element; - }) => void; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: dxVectorMap; - element: Element; - target: {}; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: dxVectorMap; - element: Element; - target: {}; - }) => void; - /** Specifies a number that is used to zoom a map initially. */ - zoomFactor?: number; - /** Specifies a map's maximum zoom factor. */ - maxZoomFactor?: number; - /** A handler for the zoomFactorChanged event. */ - onZoomFactorChanged?: (e: { - component: dxVectorMap; - element: Element; - zoomFactor: number; - }) => void; - /** A handler for the click event. */ - onClick?: any; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: (e: { - component: dxVectorMap; - element: Element; - target: MapLayerElement; - }) => void; - /** - * A handler for the areaClick event. - * @deprecated Use the 'onClick' option instead - */ - onAreaClick?: any; - /** - * A handler for the areaSelectionChanged event. - * @deprecated Use the 'onSelectionChanged' option instead - */ - onAreaSelectionChanged?: (e: { - target: Area; - component: dxVectorMap; - element: Element; - }) => void; - /** - * A handler for the markerClick event. - * @deprecated Use the 'onClick' option instead - */ - onMarkerClick?: any; - /** - * A handler for the markerSelectionChanged event. - * @deprecated Use the 'onSelecitonChanged' option instead - */ - onMarkerSelectionChanged?: (e: { - target: Marker; - component: dxVectorMap; - element: Element; - }) => void; - /** Disables the panning capability. */ - panningEnabled?: boolean; - } - export interface Legend extends viz.core.BaseLegend { - /** Specifies the color of item markers in the legend. The specified color applied only when the legend uses 'size' source. */ - markerColor?: string; - /** Specifies text for legend items. */ - customizeText?: (itemInfo: { start: number; end: number; index: number; color: string; size: number; }) => string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the text of a legend item. */ - customizeHint?: (itemInfo: { start: number; end: number; index: number; color: string; size: number }) => string; - /** Specifies the source of data for the legend. */ - source?: { - /** Specifies a layer to which the legend belongs. */ - layer?: string; - /** Specifies the type of the legend grouping. */ - grouping?: string; - } - } - /** A vector map widget. */ - export class dxVectorMap extends viz.core.BaseWidget { - constructor(element: JQuery, options?: dxVectorMapOptions); - constructor(element: Element, options?: dxVectorMapOptions); - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(): void; - /** Gets the current coordinates of the map center. */ - center(): Array; - /** Sets the coordinates of the map center. */ - center(centerCoordinates: Array): void; - /** - * Deselects all the selected areas on a map. The areas are displayed in their initial style after. - * @deprecated Use the 'clearSelection' method on a layer instead - */ - clearAreaSelection(): void; - /** - * Deselects all the selected markers on a map. The markers are displayed in their initial style after. - * @deprecated Use the 'clearSelection' method on a layer instead - */ - clearMarkerSelection(): void; - /** Deselects all the selected area and markers on a map at once. The areas and markers are displayed in their initial style after. */ - clearSelection(): void; - /** Converts client area coordinates into map coordinates. */ - convertCoordinates(x: number, y: number): Array; - /** Gets all map layers. */ - getLayers(): Array; - /** Gets the layer by its index. */ - getLayerByIndex(index: number): MapLayer; - /** Gets the layer by its name. */ - getLayerByName(name: string): MapLayer; - /** - * Returns an array with all the map areas. - * @deprecated Use the 'getElements' method on a layer instead - */ - getAreas(): Array; - /** - * Returns an array with all the map markers. - * @deprecated Use the 'getElements' method on a layer instead - */ - getMarkers(): Array; - /** Gets the current coordinates of the map viewport. */ - viewport(): Array; - /** Sets the coordinates of the map viewport. */ - viewport(viewportCoordinates: Array): void; - /** Gets the current value of the map zoom factor. */ - zoomFactor(): number; - /** Sets the value of the map zoom factor. */ - zoomFactor(zoomFactor: number): void; - } - export var projection: ProjectionCreator; - export interface ProjectionCreator { - /** Creates a new projection. */ - (data: { - to?: (coordinates: Array) => Array; - from?: (coordinates: Array) => Array; - aspectRatio?: number; - }): Object; - /** Gets the default or custom projection from the projection storage. */ - get(name: string): Object; - /** Adds a new projection to the internal projections storage. */ - add(name: string, projection: Object): void; - } -} -interface JQuery { - dxVectorMap(options?: DevExpress.viz.map.dxVectorMapOptions): JQuery; - dxVectorMap(methodName: string, ...params: any[]): any; - dxVectorMap(methodName: "instance"): DevExpress.viz.map.dxVectorMap; -} -declare module DevExpress.viz.sparklines { - export interface SparklineTooltip extends viz.core.Tooltip { - /** - * Specifies how a tooltip is horizontally aligned relative to the graph. - * @deprecated Tooltip alignment is no more available. - */ - horizontalAlignment?: string; - /** - * Specifies how a tooltip is vertically aligned relative to the graph. - * @deprecated Tooltip alignment is no more available. - */ - verticalAlignment?: string; - } - export interface BaseSparklineOptions extends viz.core.BaseWidgetOptions { - /** Specifies the blank space between the widget's extreme elements and the boundaries of the area provided for the widget in pixels. */ - margin?: viz.core.Margins; - /** Specifies the size of the widget. */ - size?: viz.core.Size; - /** Specifies tooltip options. */ - tooltip?: SparklineTooltip; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: BaseSparkline; - element: Element; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: BaseSparkline; - element: Element; - }) => void; - } - /** Overridden by descriptions for particular widgets. */ - export class BaseSparkline extends viz.core.BaseWidget { - /** Redraws a widget. */ - render(): void; - } - export interface dxBulletOptions extends BaseSparkline { - /** Specifies a color for the bullet bar. */ - color?: string; - /** Specifies an end value for the invisible scale. */ - endScaleValue?: number; - /** Specifies whether or not to show the target line. */ - showTarget?: boolean; - /** Specifies whether or not to show the line indicating zero on the invisible scale. */ - showZeroLevel?: boolean; - /** Specifies a start value for the invisible scale. */ - startScaleValue?: number; - /** Specifies the value indicated by the target line. */ - target?: number; - /** Specifies a color for both the target and zero level lines. */ - targetColor?: string; - /** Specifies the width of the target line. */ - targetWidth?: number; - /** Specifies the primary value indicated by the bullet bar. */ - value?: number; - } - /** A bullet graph widget. */ - export class dxBullet extends BaseSparkline { - constructor(element: JQuery, options?: dxBulletOptions); - constructor(element: Element, options?: dxBulletOptions); - } - export interface dxSparklineOptions extends BaseSparklineOptions { - /** Specifies the data source field that provides arguments for a sparkline. */ - argumentField?: string; - /** Sets a color for the bars indicating negative values. Available for a sparkline of the bar type only. */ - barNegativeColor?: string; - /** Sets a color for the bars indicating positive values. Available for a sparkline of the bar type only. */ - barPositiveColor?: string; - /** Specifies a data source for the sparkline. */ - dataSource?: Array; - /** Sets a color for the boundary of both the first and last points on a sparkline. */ - firstLastColor?: string; - /** Specifies whether a sparkline ignores null data points or not. */ - ignoreEmptyPoints?: boolean; - /** Sets a color for a line on a sparkline. Available for the sparklines of the line- and area-like types. */ - lineColor?: string; - /** Specifies a width for a line on a sparkline. Available for the sparklines of the line- and area-like types. */ - lineWidth?: number; - /** Sets a color for the bars indicating the values that are less than the winloss threshold. Available for a sparkline of the winloss type only. */ - lossColor?: string; - /** Sets a color for the boundary of the maximum point on a sparkline. */ - maxColor?: string; - /** Sets a color for the boundary of the minimum point on a sparkline. */ - minColor?: string; - /** Sets a color for points on a sparkline. Available for the sparklines of the line- and area-like types. */ - pointColor?: string; - /** Specifies the diameter of sparkline points in pixels. Available for the sparklines of line- and area-like types. */ - pointSize?: number; - /** Specifies a symbol to use as a point marker on a sparkline. Available for the sparklines of the line- and area-like types. */ - pointSymbol?: string; - /** Specifies whether or not to indicate both the first and last values on a sparkline. */ - showFirstLast?: boolean; - /** Specifies whether or not to indicate both the minimum and maximum values on a sparkline. */ - showMinMax?: boolean; - /** Determines the type of a sparkline. */ - type?: string; - /** Specifies the data source field that provides values for a sparkline. */ - valueField?: string; - /** Sets a color for the bars indicating the values greater than a winloss threshold. Available for a sparkline of the winloss type only. */ - winColor?: string; - /** Specifies a value that serves as a threshold for the sparkline of the winloss type. */ - winlossThreshold?: number; - /** Specifies the minimum value of the sparkline value axis. */ - minValue?: number; - /** Specifies the maximum value of the sparkline's value axis. */ - maxValue?: number; - } - /** A sparkline widget. */ - export class dxSparkline extends BaseSparkline { - constructor(element: JQuery, options?: dxSparklineOptions); - constructor(element: Element, options?: dxSparklineOptions); - } -} -interface JQuery { - dxBullet(options?: DevExpress.viz.sparklines.dxBulletOptions): JQuery; - dxBullet(methodName: string, ...params: any[]): any; - dxBullet(methodName: "instance"): DevExpress.viz.sparklines.dxBullet; - dxSparkline(options?: DevExpress.viz.sparklines.dxSparklineOptions): JQuery; - dxSparkline(methodName: string, ...params: any[]): any; - dxSparkline(methodName: "instance"): DevExpress.viz.sparklines.dxSparkline; -} diff --git a/devextreme/devextreme-16.1.6.d.ts b/devextreme/devextreme-16.1.6.d.ts deleted file mode 100644 index 7e612e69d1..0000000000 --- a/devextreme/devextreme-16.1.6.d.ts +++ /dev/null @@ -1,8043 +0,0 @@ -// Type definitions for DevExtreme 16.1.6 -// Project: http://js.devexpress.com/ -// Definitions by: DevExpress Inc. -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -/// - -declare module DevExpress { - /** Formats values. */ - export interface Format { - /** Specifies a predefined format. */ - type?: String; - /** Specifies the currency code for the 'currency' format. */ - currency?: String; - /** Specifies a precision for values of a numeric format. */ - precision?: number; - /** Parses string values into numeric or date-time values. */ - parser?: (value: any) => any; - /** Specifies a custom format. */ - formatter?: (value: any) => any; - } - /** A mixin that provides a capability to fire and subscribe to events. */ - export interface EventsMixin { - /** Subscribes to a specified event. */ - on(eventName: string, eventHandler: Function): T; - /** Subscribes to the specified events. */ - on(events: { [eventName: string]: Function; }): T; - /** Detaches all event handlers from the specified event. */ - off(eventName: string): Object; - /** Detaches a particular event handler from the specified event. */ - off(eventName: string, eventHandler: Function): T; - } - /** An object that serves as a namespace for the methods required to perform validation. */ - export module validationEngine { - export interface IValidator { - validate(): ValidatorValidationResult; - reset(): void; - } - export interface ValidatorValidationResult { - isValid: boolean; - name?: string; - value: any; - brokenRule: any; - validationRules: any[]; - } - export interface ValidationGroupValidationResult { - isValid: boolean; - brokenRules: any[]; - validators: IValidator[]; - } - export interface GroupConfig extends EventsMixin { - group: any; - validators: IValidator[]; - validate(): ValidationGroupValidationResult; - reset(): void; - } - /** Provides access to the object that represents the specified validation group. */ - export function getGroupConfig(group: any): GroupConfig - /** Provides access to the object that represents the default validation group. */ - export function getGroupConfig(): GroupConfig - /** Validates rules of the validators that belong to the specified validation group. */ - export function validateGroup(group: any): ValidationGroupValidationResult; - /** Validates rules of the validators that belong to the default validation group. */ - export function validateGroup(): ValidationGroupValidationResult; - /** Resets the values and validation result of the editors that belong to the specified validation group. */ - export function resetGroup(group: any): void; - /** Resets the values and validation result of the editors that belong to the default validation group. */ - export function resetGroup(): void; - /** Validates the rules that are defined within the dxValidator objects that are registered for the specified ViewModel. */ - export function validateModel(model: Object): ValidationGroupValidationResult; - /** Registers all the dxValidator objects extending fields of the specified ViewModel. */ - export function registerModelForValidation(model: Object): void; - /** Unregisters all the dxValidator objects extending fields of the specified ViewModel. */ - export function unregisterModelForValidation(model: Object): void; - } - export var hardwareBackButton: JQueryCallback; - /** Processes the hardware back button click. */ - export function processHardwareBackButton(): void; - /** Hides the last displayed overlay widget. */ - export function hideTopOverlay(): boolean; - /** - * Specifies whether or not the entire application/site supports right-to-left representation. - * @deprecated Use the config(config) method instead. - */ - export var rtlEnabled: boolean; - /** Gets the current global configuration object. */ - export function config(): Object; - /** Sets the global configuration object. */ - export function config(config: Object): void; - /** Registers a new component in the DevExpress.ui namespace as a jQuery plugin, Angular directive and Knockout binding. */ - export function registerComponent(name: string, componentClass: Object): void; - /** Registers a new component in the specified namespace as a jQuery plugin, Angular directive and Knockout binding. */ - export function registerComponent(name: string, namespace: Object, componentClass: Object): void; - export function requestAnimationFrame(callback: Function): number; - export function cancelAnimationFrame(requestID: number): void; - /** Custom Knockout binding that links an HTML element with a specific action. */ - export class Action { } - /** An object used to manage OData endpoints in your application. */ - export class EndpointSelector { - constructor(options: { - [key: string]: { - local?: string; - production?: string; - } - }); - /** Returns an endpoint for the specified key. */ - urlFor(key: string): string; - } - /** An object that serves as a namespace for the methods that are used to animate UI elements. */ - export module fx { - /** Defines animation options. */ - export interface AnimationOptions { - /** A function called after animation is completed. */ - complete?: (element: JQuery, config: AnimationOptions) => void; - /** A number specifying wait time before animation execution. */ - delay?: number; - /** A number specifying the time period to wait before the animation of the next stagger item starts. */ - staggerDelay?: number; - /** A number specifying the time in milliseconds spent on animation. */ - duration?: number; - /** A string specifying the type of an easing function used for animation. */ - easing?: string; - /** Specifies the initial animation state. */ - from?: any; - /** A function called before animation is started. */ - start?: (element: JQuery, config: AnimationOptions) => void; - /** Specifies a final animation state. */ - to?: any; - /** A string value specifying the animation type. */ - type?: string; - /** Specifies the animation direction for the "slideIn" and "slideOut" animation types. */ - direction?: string; - } - /** Animates the specified element. */ - export function animate(element: HTMLElement, config: AnimationOptions): Object; - /** Returns a value indicating whether the specified element is being animated. */ - export function isAnimating(element: HTMLElement): boolean; - /** Stops the animation. */ - export function stop(element: HTMLElement, jumpToEnd: boolean): void; - } - /** The manager that performs several specified animations at a time. */ - export class TransitionExecutor { - /** Deletes all the animations registered in the Transition Executor by using the enter(elements, animation) and leave(elements, animation) methods. */ - reset(): void; - /** Registers a set of elements that should be animated as "entering" using the specified animation configuration. */ - enter(elements: JQuery, animation: any): void; - /** Registers a set of elements that should be animated as "leaving" using the specified animation configuration. */ - leave(elements: JQuery, animation: any): void; - /** Starts all the animations registered using the enter(elements, animation) and leave(elements, animation) methods beforehand. */ - start(config: Object): JQueryPromise; - /** Stops all started animations. */ - stop(): void; - } - export class AnimationPresetCollection { - /** Resets all the changes made in the animation repository. */ - resetToDefaults(): void; - /** Deletes the specified animation or clears all the animation repository, if an animation name is not passed. */ - clear(name: string): void; - /** Adds the specified animation preset to the animation repository by the specified name. */ - registerPreset(name: string, config: any): void; - /** Applies the changes made in the animation repository. */ - applyChanges(): void; - /** Returns the configuration of the animation found in the animation repository by the specified name for the current device. */ - getPreset(name: string): void; - /** Registers predefined animations in the animation repository. */ - registerDefaultPresets(): void; - } - /** A repository of animations. */ - export var animationPresets: AnimationPresetCollection; - /** The device object defines the device on which the application is running. */ - export interface Device { - /** Indicates whether or not the device platform is Android. */ - android?: boolean; - /** Specifies the type of the device on which the application is running. */ - deviceType?: string; - /** Indicates whether or not the device platform is generic, which means that the application will look and behave according to a generic "light" or "dark" theme. */ - generic?: boolean; - /** Indicates whether or not the device platform is iOS. */ - ios?: boolean; - /** Indicates whether or not the device type is 'phone'. */ - phone?: boolean; - /** Specifies the platform of the device on which the application is running. */ - platform?: string; - /** Indicates whether or not the device type is 'tablet'. */ - tablet?: boolean; - /** Specifies an array with the major and minor versions of the device platform. */ - version?: Array; - /** Indicates whether or not the device platform is Windows. */ - win?: boolean; - /** Specifies a performance grade of the current device. */ - grade?: string; - } - export class Devices implements EventsMixin { - constructor(options: { window: Window }); - /** Overrides actual device information to force the application to operate as if it was running on a specified device. */ - current(deviceName: any): void; - /** Returns information about the current device. */ - current(): Device; - orientationChanged: JQueryCallback; - /** Returns the current device orientation. */ - orientation(): string; - /** Returns real information about the current device regardless of the value passed to the devices.current(deviceName) method. */ - real(): Device; - on(eventName: "orientationChanged", eventHandler: (e: { orientation: string }) => void): Devices; - on(eventName: string, eventHandler: Function): Devices; - on(events: { [eventName: string]: Function; }): Devices; - off(eventName: "orientationChanged"): Devices; - off(eventName: string): Devices; - off(eventName: "orientationChanged", eventHandler: (e: { orientation: string }) => void): Devices; - off(eventName: string, eventHandler: Function): Devices; - } - /** An object that serves as a namespace for the methods and events specifying information on the current device. */ - export var devices: Devices; - /** The position object specifies the widget positioning options. */ - export interface PositionOptions { - /** The target element position that the widget is positioned against. */ - at?: any; - /** The element within which the widget is positioned. */ - boundary?: Object; - /** Specifies the horizontal and vertical offset from the window's boundaries. */ - boundaryOffset?: any; - /** Specifies how to move the widget if it overflows the screen. */ - collision?: any; - /** The position of the widget to align against the target element. */ - my?: any; - /** The target element that the widget is positioned against. */ - of?: Object; - /** Specifies horizontal and vertical offset in pixels. */ - offset?: any; - } - export interface ComponentOptions { - /** A handler for the initialized event. */ - onInitialized?: Function; - /** A handler for the optionChanged event. */ - onOptionChanged?: Function; - /** A handler for the disposing event. */ - onDisposing?: Function; - } - /** A base class for all components and widgets. */ - export class Component { - constructor(options?: ComponentOptions) - /** Prevents the component from refreshing until the endUpdate() method is called. */ - beginUpdate(): void; - /** Enables the component to refresh after the beginUpdate() method call. */ - endUpdate(): void; - /** Returns an instance of this component class. */ - instance(): Component; - /** Returns the configuration options of this component. */ - option(): { - [optionKey: string]: any; - }; - /** Sets one or more options of this component. */ - option(options: { - [optionKey: string]: any; - }): void; - /** Gets the value of the specified configuration option of this component. */ - option(optionName: string): any; - /** Sets a value to the specified configuration option of this component. */ - option(optionName: string, optionValue: any): void; - } - export interface DOMComponentOptions extends ComponentOptions { - /** Specifies whether or not the current component supports a right-to-left representation. */ - rtlEnabled?: boolean; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies the width of the widget. */ - width?: any; - /** A bag for holding any options that require two-way binding (Angular approach specific) */ - bindingOptions?: { [key: string]: any; }; - } - /** A base class for all components. */ - export class DOMComponent extends Component { - constructor(element: JQuery, options?: DOMComponentOptions); - constructor(element: HTMLElement, options?: DOMComponentOptions); - /** Returns the root HTML element of the widget. */ - element(): JQuery; - /** Specifies the device-dependent default configuration options for this component. */ - static defaultOptions(rule: { - device?: any; - options?: any; - }): void; - } - export module data { - export interface ODataError extends Error { - httpStatus?: number; - errorDetails?: any; - } - export interface StoreOptions { - /** A handler for the modified event. */ - onModified?: () => void; - /** A handler for the modifying event. */ - onModifying?: () => void; - /** A handler for the removed event. */ - onRemoved?: (key: any) => void; - /** A handler for the removing event. */ - onRemoving?: (key: any) => void; - /** A handler for the updated event. */ - onUpdated?: (key: any, values: Object) => void; - /** A handler for the updating event. */ - onUpdating?: (key: any, values: Object) => void; - /** A handler for the loaded event. */ - onLoaded?: (result: Array) => void; - /** A handler for the loading event. */ - onLoading?: (loadOptions: LoadOptions) => void; - /** A handler for the inserted event. */ - onInserted?: (values: Object, key: any) => void; - /** A handler for the inserting event. */ - onInserting?: (values: Object) => void; - /** Specifies the function called when the Store causes an error. */ - errorHandler?: (e: Error) => void; - /** Specifies the key properties within the data associated with the Store. */ - key?: any; - } - export interface LoadOptions { - filter?: Object; - sort?: Object; - select?: Object; - expand?: Object; - group?: Object; - skip?: number; - take?: number; - userData?: Object; - requireTotalCount?: boolean; - } - /** The base class for all Stores. */ - export class Store implements EventsMixin { - constructor(options?: StoreOptions); - /** Returns the data item specified by the key. */ - byKey(key: any): JQueryPromise; - /** Adds an item to the data associated with this Store. */ - insert(values: Object): JQueryPromise; - /** Returns the key expression specified via the key configuration option. */ - key(): any; - /** Returns the key of the Store item that matches the specified object. */ - keyOf(obj: Object): any; - /** Starts loading data. */ - load(obj?: LoadOptions): JQueryPromise; - /** Removes the data item specified by the key. */ - remove(key: any): JQueryPromise; - /** Obtains the total count of items that will be returned by the load() function. */ - totalCount(options?: { - filter?: Object; - group?: Object; - }): JQueryPromise; - /** Updates the data item specified by the key. */ - update(key: any, values: Object): JQueryPromise; - on(eventName: "removing", eventHandler: (key: any) => void): Store; - on(eventName: "removed", eventHandler: (key: any) => void): Store; - on(eventName: "updating", eventHandler: (key: any, values: Object) => void): Store; - on(eventName: "updated", eventHandler: (key: any, values: Object) => void): Store; - on(eventName: "inserting", eventHandler: (values: Object) => void): Store; - on(eventName: "inserted", eventHandler: (values: Object, key: any) => void): Store; - on(eventName: "modifying", eventHandler: () => void): Store; - on(eventName: "modified", eventHandler: () => void): Store; - on(eventName: "loading", eventHandler: (loadOptions: LoadOptions) => void): Store; - on(eventName: "loaded", eventHandler: (result: Array) => void): Store; - on(eventName: string, eventHandler: Function): Store; - on(events: { [eventName: string]: Function; }): Store; - off(eventName: "removing"): Store; - off(eventName: "removed"): Store; - off(eventName: "updating"): Store; - off(eventName: "updated"): Store; - off(eventName: "inserting"): Store; - off(eventName: "inserted"): Store; - off(eventName: "modifying"): Store; - off(eventName: "modified"): Store; - off(eventName: "loading"): Store; - off(eventName: "loaded"): Store; - off(eventName: string): Store; - off(eventName: "removing", eventHandler: (key: any) => void): Store; - off(eventName: "removed", eventHandler: (key: any) => void): Store; - off(eventName: "updating", eventHandler: (key: any, values: Object) => void): Store; - off(eventName: "updated", eventHandler: (key: any, values: Object) => void): Store; - off(eventName: "inserting", eventHandler: (values: Object) => void): Store; - off(eventName: "inserted", eventHandler: (values: Object, key: any) => void): Store; - off(eventName: "modifying", eventHandler: () => void): Store; - off(eventName: "modified", eventHandler: () => void): Store; - off(eventName: "loading", eventHandler: (loadOptions: LoadOptions) => void): Store; - off(eventName: "loaded", eventHandler: (result: Array) => void): Store; - off(eventName: string, eventHandler: Function): Store; - } - export interface ArrayStoreOptions extends StoreOptions { - /** Specifies the array associated with this Store. */ - data?: Array; - } - /** A Store accessing an in-memory array. */ - export class ArrayStore extends Store { - constructor(options?: ArrayStoreOptions); - /** Clears all data associated with the current ArrayStore. */ - clear(): void; - /** Creates the Query object for the underlying array. */ - createQuery(): Query; - } - interface Promise { - then(doneFn?: Function, failFn?: Function, progressFn?: Function): Promise; - } - export interface CustomStoreOptions extends StoreOptions { - /** Specifies whether or not the store combines the search expression with the filter expression. */ - useDefaultSearch?: boolean; - /** The user implementation of the byKey(key, extraOptions) method. */ - byKey?: (key: any) => Promise; - /** The user implementation of the insert(values) method. */ - insert?: (values: Object) => Promise; - /** The user implementation of the load(options) method. */ - load?: (options?: LoadOptions) => Promise; - /** The user implementation of the remove(key) method. */ - remove?: (key: any) => Promise; - /** The user implementation of the totalCount(options) method. */ - totalCount?: (options?: { - filter?: Object; - group?: Object; - }) => Promise; - /** The user implementation of the update(key, values) method. */ - update?: (key: any, values: Object) => Promise; - } - /** A Store object that enables you to implement your own data access logic. */ - export class CustomStore extends Store { - constructor(options: CustomStoreOptions); - } - export interface DataSourceOptions { - /** Specifies data filtering conditions. */ - filter?: Object; - /** Specifies data grouping conditions. */ - group?: Object; - /** The item mapping function. */ - map?: (record: any) => any; - /** Specifies the maximum number of items the page can contain. */ - pageSize?: number; - /** Specifies whether a DataSource loads data by pages, or all items at once. */ - paginate?: boolean; - /** The data post processing function. */ - postProcess?: (data: any[]) => any[]; - /** Specifies a value by which the required items are searched. */ - searchExpr?: Object; - /** Specifies the comparison operation used to search for the required items. */ - searchOperation?: string; - /** Specifies the value to which the search expression is compared. */ - searchValue?: Object; - /** Specifies the initial select option value. */ - select?: Object; - /** An array of the strings that represent the names of the navigation properties to be loaded simultaneously with the OData store's entity. */ - expand?: Object; - /** The bag of custom parameters passed to the query executed when the DataSource load operation is invoked. */ - customQueryParams?: Object; - /** Specifies whether or not the DataSource instance requests the total count of items available in the storage. */ - requireTotalCount?: boolean; - /** Specifies the initial sort option value. */ - sort?: Object; - /** Specifies the underlying Store instance used to access data. */ - store?: any; - /** A handler for the changed event. */ - onChanged?: () => void; - /** A handler for the loadingChanged event. */ - onLoadingChanged?: (isLoading: boolean) => void; - /** A handler for the loadError event. */ - onLoadError?: (e?: Error) => void; - } - export interface OperationPromise extends JQueryPromise { - operationId: number; - } - /** An object that provides access to a data web service or local data storage for collection container widgets. */ - export class DataSource implements EventsMixin { - constructor(url: string); - constructor(data: Array); - constructor(options: CustomStoreOptions); - constructor(options: DataSourceOptions); - /** Disposes all resources associated with this DataSource. */ - dispose(): void; - /** Returns the current filter option value. */ - filter(): Object; - /** Sets the filter option value. */ - filter(filterExpr: Object): void; - /** Returns the current group option value. */ - group(): Object; - /** Sets the group option value. */ - group(groupExpr: Object): void; - /** Indicates whether or not the current page contains fewer items than the number of items specified by the pageSize configuration option. */ - isLastPage(): boolean; - /** Indicates whether or not at least one load() method execution has successfully finished. */ - isLoaded(): boolean; - /** Indicates whether or not the DataSource is currently being loaded. */ - isLoading(): boolean; - /** Returns the array of items currently operated by the DataSource. */ - items(): Array; - /** Returns the key expression. */ - key(): any; - /** Starts loading data. */ - load(): OperationPromise>; - /** Clears currently loaded DataSource items and calls the load() method. */ - reload(): OperationPromise>; - /** Returns an object that would be passed to the load() method of the underlying Store according to the current data shaping option values of the current DataSource instance. */ - loadOptions(): Object; - /** Returns the current pageSize option value. */ - pageSize(): number; - /** Sets the pageSize option value. */ - pageSize(value: number): void; - /** Specifies the index of the currently loaded page. */ - pageIndex(): number; - /** Specifies the index of the page to be loaded during the next load() method execution. */ - pageIndex(newIndex: number): void; - /** Returns the current paginate option value. */ - paginate(): boolean; - /** Sets the paginate option value. */ - paginate(value: boolean): void; - /** Returns the searchExpr option value. */ - searchExpr(): Object; - /** Sets the searchExpr option value. */ - searchExpr(...expr: Object[]): void; - /** Returns the currently specified search operation. */ - searchOperation(): string; - /** Sets the current search operation. */ - searchOperation(op: string): void; - /** Returns the searchValue option value. */ - searchValue(): Object; - /** Sets the searchValue option value. */ - searchValue(value: Object): void; - /** Returns the current select option value. */ - select(): Object; - /** Sets the select option value. */ - select(expr: Object): void; - /** Returns the current requireTotalCount option value. */ - requireTotalCount(): boolean; - /** Sets the requireTotalCount option value. */ - requireTotalCount(value: boolean): void; - /** Returns the current sort option value. */ - sort(): Object; - /** Sets the sort option value. */ - sort(sortExpr: Object): void; - /** Returns the underlying Store instance. */ - store(): Store; - /** Returns the number of data items available in an underlying Store after the last load() operation without paging. */ - totalCount(): number; - /** Cancels the load operation associated with the specified identifier. */ - cancel(operationId: number): boolean; - on(eventName: "loadingChanged", eventHandler: (isLoading: boolean) => void): DataSource; - on(eventName: "loadError", eventHandler: (e?: Error) => void): DataSource; - on(eventName: "changed", eventHandler: () => void): DataSource; - on(eventName: string, eventHandler: Function): DataSource; - on(events: { [eventName: string]: Function; }): DataSource; - off(eventName: "loadingChanged"): DataSource; - off(eventName: "loadError"): DataSource; - off(eventName: "changed"): DataSource; - off(eventName: string): DataSource; - off(eventName: "loadingChanged", eventHandler: (isLoading: boolean) => void): DataSource; - off(eventName: "loadError", eventHandler: (e?: Error) => void): DataSource; - off(eventName: "changed", eventHandler: () => void): DataSource; - off(eventName: string, eventHandler: Function): DataSource; - } - /** An object used to work with primitive data types not supported by JavaScript when accessing an OData web service. */ - export class EdmLiteral { - /** Creates an EdmLiteral instance and assigns the specified value to it. */ - constructor(value: string); - /** Returns a string representation of the value associated with this EdmLiteral object. */ - valueOf(): string; - } - /** An object used to generate and hold the GUID. */ - export class Guid { - /** Creates a new Guid instance that holds the specified GUID. */ - constructor(value: string); - /** Creates a new Guid instance holding the generated GUID. */ - constructor(); - /** Returns a string representation of the Guid instance. */ - toString(): string; - /** Returns a string representation of the Guid instance. */ - valueOf(): string; - } - export interface LocalStoreOptions extends ArrayStoreOptions { - /** Specifies the time (in miliseconds) after the change operation, before the data is flushed. */ - flushInterval?: number; - /** Specifies whether the data is flushed immediatelly after each change operation, or after the delay specified via the flushInterval option. */ - immediate?: boolean; - /** The unique identifier used to distinguish the data within the HTML5 Web Storage. */ - name?: string; - } - /** A Store providing access to the HTML5 Web Storage. */ - export class LocalStore extends ArrayStore { - constructor(options?: LocalStoreOptions); - /** Removes all data associated with this Store. */ - clear(): void; - } - export interface ODataContextOptions extends ODataStoreOptions { - /** Specifies the list of entities to be accessed via the ODataContext. */ - entities?: Object; - /** Specifies the function called if the ODataContext causes an error. */ - errorHandler?: (e: Error) => void; - } - /** Provides access to the entire OData service. */ - export class ODataContext { - constructor(options?: ODataContextOptions); - /** Initiates the specified WebGet service operation that returns a value. For the information on service operations, refer to the OData documentation. */ - get(operationName: string, params: Object): JQueryPromise; - /** Initiates the specified WebGet service operation that returns nothing. For the information on service operations, refer to the OData documentation. */ - invoke(operationName: string, params: Object, httpMethod: Object): JQueryPromise; - /** Return a special proxy object to describe the entity link. */ - objectLink(entityAlias: string, key: any): Object; - } - export interface ODataStoreOptions extends StoreOptions { - /** A function used to customize a web request before it is sent. */ - beforeSend?: (request: { - url: string; - async: boolean; - method: string; - timeout: number; - params: Object; - payload: Object; - headers: Object; - }) => void; - /** Specifies whether the ODataStore uses the JSONP approach to access non-CORS-compatible remote services. */ - jsonp?: boolean; - /** Specifies the type of the ODataStore key property. The following key types are supported out of the box: String, Int32, Int64, Boolean, Single, Decimal and Guid. */ - keyType?: any; - /** Specifies whether or not dates in a response are deserialized. */ - deserializeDates?: boolean; - /** Specifies the URL of the data service being accessed via the current ODataContext. */ - url?: string; - /** Specifies the version of the OData protocol used to interact with the data service. */ - version?: number; - /** Specifies the value of the withCredentials field of the underlying jqXHR object. */ - withCredentials?: boolean; - } - /** A Store providing access to a separate OData web service entity. */ - export class ODataStore extends Store { - constructor(options?: ODataStoreOptions); - /** Creates the Query object for the OData endpoint. */ - createQuery(loadOptions: Object): Object; - /** Returns the data item specified by the key. */ - byKey(key: any, extraOptions?: { expand?: Object }): JQueryPromise; - } - /** An universal chainable data query interface object. */ - export interface Query { - /** Calculates a custom summary for the items in the current Query. */ - aggregate(step: (accumulator: any, value: any) => any): JQueryPromise; - /** Calculates a custom summary for the items in the current Query. */ - aggregate(seed: any, step: (accumulator: any, value: any) => any, finalize: (result: any) => any): JQueryPromise; - /** Calculates the average item value for the current Query. */ - avg(getter: Object): JQueryPromise; - /** Finds the item with the maximum getter value. */ - max(getter: Object): JQueryPromise; - /** Finds the item with the maximum value in the Query. */ - max(): JQueryPromise; - /** Finds the item with the minimum value in the Query. */ - min(): JQueryPromise; - /** Finds the item with the minimum getter value. */ - min(getter: Object): JQueryPromise; - /** Calculates the average item value for the current Query, if each Query item has a numeric type. */ - avg(): JQueryPromise; - /** Returns the total count of items in the current Query. */ - count(): JQueryPromise; - /** Executes the Query. */ - enumerate(): JQueryPromise; - /** Filters the current Query data. */ - filter(criteria: Array): Query; - /** Filters the current Query data. */ - filter(predicate: (item: any) => boolean): Query; - /** Groups the current Query data. */ - groupBy(getter: Object): Query; - /** Applies the specified transformation to each item. */ - select(getter: Object): Query; - /** Limits the data item count. */ - slice(skip: number, take?: number): Query; - /** Sorts current Query data. */ - sortBy(getter: Object, desc: boolean): Query; - /** Sorts current Query data. */ - sortBy(getter: Object): Query; - /** Calculates the sum of item getter values in the current Query. */ - sum(getter: Object): JQueryPromise; - /** Calculates the sum of item values in the current Query. */ - sum(): JQueryPromise; - /** Adds one more sorting condition to the current Query. */ - thenBy(getter: Object): Query; - /** Adds one more sorting condition to the current Query. */ - thenBy(getter: Object, desc: boolean): Query; - /** Returns the array of current Query items. */ - toArray(): Array; - } - /** The global data layer error handler. */ - export var errorHandler: (e: Error) => void; - /** Encodes the specified string or array of bytes to base64 encoding. */ - export function base64_encode(input: any): string; - /** Creates a Query instance. */ - export function query(array: Array): Query; - /** Creates a Query instance for accessing the remote service specified by a URL. */ - export function query(url: string, queryOptions: Object): Query; - /** This section describes the utility objects provided by the DevExtreme data layer. */ - export var utils: { - /** Compiles a getter function from the getter expression. */ - compileGetter(expr: any): Function; - /** Compiles a setter function from the setter expression. */ - compileSetter(expr: any): Function; - odata: { - /** Holds key value converters for OData. */ - keyConverters: { - String(value: any): string; - Int32(value: any): number; - Int64(value: any): EdmLiteral; - Guid(value: any): Guid; - Boolean(value: any): boolean; - Single(value: any): EdmLiteral; - Decimal(value: any): EdmLiteral; - }; - } - } - } - /** An object that serves as a namespace for DevExtreme UI widgets as well as for methods implementing UI logic in DevExtreme sites/applications. */ - export module ui { - export interface WidgetOptions extends DOMComponentOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A Boolean value specifying whether or not the widget can respond to user interaction. */ - disabled?: boolean; - /** A Boolean value specifying whether or not the widget changes its state when being hovered by an end user. */ - hoverStateEnabled?: boolean; - /** Specifies whether or not the widget can be focused. */ - focusStateEnabled?: boolean; - /** Specifies a shortcut key that sets focus on the widget element. */ - accessKey?: string; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - /** Specifies the widget tab index. */ - tabIndex?: number; - /** Specifies the text of the hint displayed for the widget. */ - hint?: string; - } - /** The base class for widgets. */ - export class Widget extends DOMComponent { - constructor(options?: WidgetOptions); - /** Redraws the widget. */ - repaint(): void; - /** Sets focus on the widget. */ - focus(): void; - /** Registers a handler when a specified key is pressed. */ - registerKeyHandler(key: string, handler: Function): void; - } - export interface CollectionWidgetOptions extends WidgetOptions { - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** The time period in milliseconds before the onItemHold event is raised. */ - itemHoldTimeout?: number; - /** An array of items displayed by the widget. */ - items?: Array; - /** The template to be used for rendering items. */ - itemTemplate?: any; - loopItemFocus?: boolean; - /** The text or HTML markup displayed by the widget if the item collection is empty. */ - noDataText?: string; - onContentReady?: any; - /** A handler for the itemClick event. */ - onItemClick?: any; - /** A handler for the itemContextMenu event. */ - onItemContextMenu?: Function; - /** A handler for the itemHold event. */ - onItemHold?: Function; - /** A handler for the itemRendered event. */ - onItemRendered?: Function; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: Function; - /** The index of the currently selected widget item. */ - selectedIndex?: number; - /** The selected item object. */ - selectedItem?: Object; - /** An array of currently selected item objects. */ - selectedItems?: Array; - /** A handler for the itemDeleting event. */ - onItemDeleting?: Function; - /** A handler for the itemDeleted event. */ - onItemDeleted?: Function; - /** A handler for the itemReordered event. */ - onItemReordered?: Function; - } - /** The base class for widgets containing an item collection. */ - export class CollectionWidget extends Widget { - constructor(element: JQuery, options?: CollectionWidgetOptions); - constructor(element: HTMLElement, options?: CollectionWidgetOptions); - selectItem(itemElement: any): void; - unselectItem(itemElement: any): void; - deleteItem(itemElement: any): JQueryPromise; - isItemSelected(itemElement: any): boolean; - reorderItem(itemElement: any, toItemElement: any): JQueryPromise; - } - export interface DataExpressionMixinOptions { - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** Specifies the name of the data source item field whose value is displayed by the widget. */ - displayExpr?: any; - /** Specifies the name of a data source item field whose value is held in the value configuration option. */ - valueExpr?: any; - /** An array of items displayed by the widget. */ - items?: Array; - /** The template to be used for rendering items. */ - itemTemplate?: any; - /** The currently selected value in the widget. */ - value?: Object; - } - export interface EditorOptions extends WidgetOptions { - /** The currently specified value. */ - value?: Object; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - /** A Boolean value specifying whether or not the widget is read-only. */ - readOnly?: boolean; - /** Holds the object that defines the error that occurred during validation. */ - validationError?: Object; - /** Specifies whether the editor's value is valid. */ - isValid?: boolean; - /** Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed. */ - validationMessageMode?: string; - } - /** A base class for editors. */ - export class Editor extends Widget { - /** Resets the editor's value to undefined. */ - reset(): void; - } - /** An object that serves as a namespace for methods displaying a message in an application/site. */ - export var dialog: { - /** Creates an alert dialog message containing a single "OK" button. */ - alert(message: string, title: string): JQueryPromise; - /** Creates a confirm dialog that contains "Yes" and "No" buttons. */ - confirm(message: string, title: string): JQueryPromise; - /** Creates a custom dialog using the options specified by the passed configuration object. */ - custom(options: { title?: string; message?: string; buttons?: Array; }): { - show(): JQueryPromise; - hide(): void; - hide(value: any): void; - }; - }; - /** Creates a toast message. */ - export function notify(message: any, type: string, displayTime: number): void; - /** Creates a toast message. */ - export function notify(options: Object): void; - /** An object that serves as a namespace for the methods that work with DevExtreme CSS Themes. */ - export var themes: { - /** Returns the name of the currently applied theme. */ - current(): string; - /** Changes the current theme to the specified one. */ - current(themeName: string): void; - }; - /** Sets a specified template engine. */ - export function setTemplateEngine(name: string): void; - /** Sets a custom template engine defined via custom compile and render functions. */ - export function setTemplateEngine(options: Object): void; - } - /** An object that serves as a namespace for utility methods that can be helpful when working with the DevExtreme framework and UI widgets. */ - export var utils: { - /** Sets parameters for the viewport meta tag. */ - initMobileViewport(options: { allowZoom?: boolean; allowPan?: boolean; allowSelection?: boolean }): void; - /** Requests that the browser call a specified function to update animation before the next repaint. */ - requestAnimationFrame(callback: Function): number; - /** Cancels an animation frame request scheduled with the requestAnimationFrame method. */ - cancelAnimationFrame(requestID: number): void; - }; - /** An object that serves as a namespace for DevExtreme Data Visualization Widgets. */ - export module viz { - /** Applies a theme for the entire page with several DevExtreme visualization widgets. */ - export function currentTheme(theme: string): void; - /** Applies a new theme (with the color scheme defined separately) for the entire page with several DevExtreme visualization widgets. */ - export function currentTheme(platform: string, colorScheme: string): void; - /** Registers a new theme based on the existing one. */ - export function registerTheme(customTheme: Object, baseTheme: string): void; - /** Allows you to export widgets using their SVG markup. */ - export function exportFromMarkup(markup: string, options: Object): void; - /** Applies a predefined or registered custom palette to all visualization widgets at once. */ - export function currentPalette(paletteName: string): void; - /** Obtains the color sets of a predefined or registered palette. */ - export function getPalette(paletteName: string): Object; - /** Registers a new palette. */ - export function registerPalette(paletteName: string, palette: Object): void; - } -} -declare module DevExpress.ui { - export interface dxValidatorValidationAdapter { - /** A function that returns the value to be validated. */ - getValue?: Function; - /** The jQuery.Callbacks() object that is fired when the specified value should be validated. */ - validationRequestsCallbacks?: JQueryCallback; - /** A function that the dxValidator widget calls after validating a specified value. */ - applyValidationResults?: (params: validationEngine.ValidatorValidationResult) => void; - /** A function that resets the validated values. */ - reset?: Function; - /** A function that sets focus to the validated editors when the dxValidationSummary is focused. */ - focus?: Function; - /** A function that returns a Boolean value specifying whether or not to bypass validation. */ - bypass?: Function; - } - export interface dxValidatorOptions extends DOMComponentOptions { - /** An array of validation rules to be checked for the editor with which the dxValidator object is associated. */ - validationRules?: Array; - /** Specifies the editor name to be used in the validation default messages. */ - name?: string; - /** An object that specifies what and when to validate and how to apply the validation result. */ - adapter?: dxValidatorValidationAdapter; - /** Specifies the validation group the editor will be related to. */ - validationGroup?: string; - /** A handler for the validated event. */ - onValidated?: (params: validationEngine.ValidatorValidationResult) => void; - } - /** A widget that is used to validate the associated DevExtreme editors against the defined validation rules. */ - export class dxValidator extends DOMComponent implements validationEngine.IValidator { - constructor(element: JQuery, options?: dxValidatorOptions); - constructor(element: Element, options?: dxValidatorOptions); - /** Validates the value of the editor that is controlled by the current dxValidator object against the list of the specified validation rules. */ - validate(): validationEngine.ValidatorValidationResult; - /** Resets the value and validation result of the editor associated with the current dxValidator object. */ - reset(): void; - } - /** The widget that is used in the Knockout and Angular approaches to combine the editors to be validated. */ - export class dxValidationGroup extends DOMComponent { - constructor(element: JQuery); - constructor(element: Element); - /** Validates rules of the validators that belong to the current validation group. */ - validate(): validationEngine.ValidationGroupValidationResult; - /** Resets the value and validation result of the editors that are included to the current validation group. */ - reset(): void; - } - export interface dxValidationSummaryOptions extends CollectionWidgetOptions { - /** Specifies the validation group for which summary should be generated. */ - validationGroup?: string; - } - /** A widget for displaying the result of checking validation rules for editors. */ - export class dxValidationSummary extends CollectionWidget { - constructor(element: JQuery, options?: dxValidationSummaryOptions); - constructor(element: Element, options?: dxValidationSummaryOptions); - } - export interface dxResizableOptions extends DOMComponentOptions { - /** Specifies which borders of the widget element are used as a handle. */ - handles?: string; - /** Specifies the lower width boundary for resizing. */ - minWidth?: number; - /** Specifies the upper width boundary for resizing. */ - maxWidth?: number; - /** Specifies the lower height boundary for resizing. */ - minHeight?: number; - /** Specifies the upper height boundary for resizing. */ - maxHeight?: number; - /** A handler for the resizeStart event. */ - onResizeStart?: Function; - /** A handler for the resize event. */ - onResize?: Function; - /** A handler for the resizeEnd event. */ - onResizeEnd?: Function; - } - /** A widget that displays required content in a resizable element. */ - export class dxResizable extends DOMComponent { - constructor(element: JQuery, options?: dxResizableOptions); - constructor(element: Element, options?: dxResizableOptions); - } - export interface dxTooltipOptions extends dxPopoverOptions { - } - /** A tooltip widget. */ - export class dxTooltip extends dxPopover { - constructor(element: JQuery, options?: dxTooltipOptions); - constructor(element: Element, options?: dxTooltipOptions); - } - export interface dxDropDownListOptions extends dxDropDownEditorOptions, DataExpressionMixinOptions { - /** Returns the value currently displayed by the widget. */ - displayValue?: string; - /** The minimum number of characters that must be entered into the text box to begin a search. */ - minSearchLength?: number; - /** Specifies whether or not the widget displays unfiltered values until a user types a number of characters exceeding the minSearchLength option value. */ - showDataBeforeSearch?: boolean; - /** Specifies the name of a data source item field or an expression whose value is compared to the search criterion. */ - searchExpr?: any; - /** Specifies the binary operation used to filter data. */ - searchMode?: string; - /** Specifies the time delay, in milliseconds, after the last character has been typed in, before a search is executed. */ - searchTimeout?: number; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - /** Specifies DOM event names that update a widget's value. */ - valueChangeEvent?: string; - /** Specifies whether or not the widget supports searching. */ - searchEnabled?: boolean; - /** - * Specifies whether or not the widget displays items by pages. - * @deprecated Use the DataSource paging opportunities instead. - */ - pagingEnabled?: boolean; - /** The text or HTML markup displayed by the widget if the item collection is empty. */ - noDataText?: string; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: Function; - /** A handler for the itemClick event. */ - onItemClick?: Function; - onContentReady?: Function; - } - /** A base class for drop-down list widgets. */ - export class dxDropDownList extends dxDropDownEditor { - constructor(element: JQuery, options?: dxDropDownListOptions); - constructor(element: Element, options?: dxDropDownListOptions); - } - export interface dxToolbarOptions extends CollectionWidgetOptions { - /** The template used to render menu items. */ - menuItemTemplate?: any; - /** Informs the widget about its location in a view HTML markup. */ - renderAs?: string; - } - /** A toolbar widget. */ - export class dxToolbar extends CollectionWidget { - constructor(element: JQuery, options?: dxToolbarOptions); - constructor(element: Element, options?: dxToolbarOptions); - } - export interface dxToastOptions extends dxOverlayOptions { - animation?: { - /** An object that defines the animation options used when the widget is being shown. */ - show?: fx.AnimationOptions; - /** An object that defines the animation options used when the widget is being hidden. */ - hide?: fx.AnimationOptions; - }; - /** The time span in milliseconds during which the dxToast widget is visible. */ - displayTime?: number; - height?: any; - /** The dxToast message text. */ - message?: string; - position?: PositionOptions; - shading?: boolean; - /** Specifies the dxToast widget type. */ - type?: string; - width?: any; - closeOnBackButton?: boolean; - /** A Boolean value specifying whether or not the toast is closed if a user swipes it out of the screen boundaries. */ - closeOnSwipe?: boolean; - /** A Boolean value specifying whether or not the toast is closed if a user clicks it. */ - closeOnClick?: boolean; - } - /** The toast message widget. */ - export class dxToast extends dxOverlay { - constructor(element: JQuery, options?: dxToastOptions); - constructor(element: Element, options?: dxToastOptions); - } - export interface dxTextEditorOptions extends EditorOptions { - /** A handler for the change event. */ - onChange?: Function; - /** A handler for the copy event. */ - onCopy?: Function; - /** A handler for the cut event. */ - onCut?: Function; - /** A handler for the enterKey event. */ - onEnterKey?: Function; - /** A handler for the focusIn event. */ - onFocusIn?: Function; - /** A handler for the focusOut event. */ - onFocusOut?: Function; - /** A handler for the input event. */ - onInput?: Function; - /** A handler for the keyDown event. */ - onKeyDown?: Function; - /** A handler for the keyPress event. */ - onKeyPress?: Function; - /** A handler for the keyUp event. */ - onKeyUp?: Function; - /** A handler for the paste event. */ - onPaste?: Function; - /** The text displayed by the widget when the widget value is empty. */ - placeholder?: string; - /** Specifies whether to display the Clear button in the widget. */ - showClearButton?: boolean; - /** Specifies the current value displayed by the widget. */ - value?: any; - /** Specifies DOM event names that update a widget's value. */ - valueChangeEvent?: string; - /** Specifies whether or not the widget checks the inner text for spelling mistakes. */ - spellcheck?: boolean; - /** Specifies HTML attributes applied to the inner input element of the widget. */ - attr?: Object; - /** The read-only option that holds the text displayed by the widget input element. */ - text?: string; - focusStateEnabled?: boolean; - hoverStateEnabled?: boolean; - /** The editor mask that specifies the format of the entered string. */ - mask?: string; - /** Specifies a mask placeholder character. */ - maskChar?: string; - /** Specifies custom mask rules. */ - maskRules?: Object; - /** A message displayed when the entered text does not match the specified pattern. */ - maskInvalidMessage?: string; - /** Specifies whether the value option holds only characters entered by a user or prompt characters as well. */ - useMaskedValue?: boolean; - } - /** A base class for text editing widgets. */ - export class dxTextEditor extends Editor { - constructor(element: JQuery, options?: dxTextEditorOptions); - constructor(element: Element, options?: dxTextEditorOptions); - /** Removes focus from the input element. */ - blur(): void; - /** Sets focus to the input element representing the widget. */ - focus(): void; - } - export interface dxTextBoxOptions extends dxTextEditorOptions { - /** Specifies the maximum number of characters you can enter into the textbox. */ - maxLength?: any; - /** The "mode" attribute value of the actual HTML input element representing the text box. */ - mode?: string; - } - /** A single-line text box widget. */ - export class dxTextBox extends dxTextEditor { - constructor(element: JQuery, options?: dxTextBoxOptions); - constructor(element: Element, options?: dxTextBoxOptions); - } - export interface dxTextAreaOptions extends dxTextBoxOptions { - /** Specifies whether or not the widget checks the inner text for spelling mistakes. */ - spellcheck?: boolean; - /** Specifies the minimum height of the widget. */ - minHeight?: any; - /** Specifies the maximum height of the widget. */ - maxHeight?: any; - /** A Boolean value specifying whether or not the auto resizing mode is enabled. */ - autoResizeEnabled?: boolean; - } - /** A widget used to display and edit multi-line text. */ - export class dxTextArea extends dxTextBox { - constructor(element: JQuery, options?: dxTextAreaOptions); - constructor(element: Element, options?: dxTextAreaOptions); - } - export interface dxTabsOptions extends CollectionWidgetOptions { - /** Specifies whether the widget enables an end-user to select only a single item or multiple items. */ - selectionMode?: string; - /** Specifies whether or not an end-user can scroll tabs by swiping. */ - scrollByContent?: boolean; - /** Specifies whether or not an end-user can scroll tabs. */ - scrollingEnabled?: boolean; - /** A Boolean value that specifies the availability of navigation buttons. */ - showNavButtons?: boolean; - } - /** A tab strip used to switch between pages. */ - export class dxTabs extends CollectionWidget { - constructor(element: JQuery, options?: dxTabsOptions); - constructor(element: Element, options?: dxTabsOptions); - } - export interface dxTabPanelOptions extends dxMultiViewOptions { - /** A handler for the titleClick event. */ - onTitleClick?: any; - /** A handler for the titleHold event. */ - onTitleHold?: Function; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - /** The template to be used for rendering an item title. */ - itemTitleTemplate?: any; - /** A Boolean value specifying if tabs in the title are scrolled by content. */ - scrollByContent?: boolean; - /** A Boolean indicating whether or not to add scrolling support for tabs in the title. */ - scrollingEnabled?: boolean; - /** A Boolean value that specifies the availability of navigation buttons. */ - showNavButtons?: boolean; - } - /** A widget used to display a view and to switch between several views by clicking the appropriate tabs. */ - export class dxTabPanel extends dxMultiView { - constructor(element: JQuery, options?: dxTabPanelOptions); - constructor(element: Element, options?: dxTabPanelOptions); - } - export interface dxSelectBoxOptions extends dxDropDownListOptions { - /** Specifies DOM event names that update a widget's value. */ - valueChangeEvent?: string; - /** The template to be used for rendering the widget text field. */ - fieldTemplate?: any; - /** The text that is provided as a hint in the select box editor. */ - placeholder?: string; - /** Specifies whether or not the widget allows an end-user to enter a custom value. */ - acceptCustomValue?: boolean; - /** Specifies whether or not to display selection controls. */ - showSelectionControls?: boolean; - /** A handler for the customItemCreating event. */ - onCustomItemCreating?: Function; - } - /** A widget that allows you to select an item in a dropdown list. */ - export class dxSelectBox extends dxDropDownList { - constructor(element: JQuery, options?: dxSelectBoxOptions); - constructor(element: Element, options?: dxSelectBoxOptions); - } - export interface dxTagBoxOptions extends dxSelectBoxOptions { - values?: Array; - /** Specifies the selected items. */ - value?: Array; - /** Gets the currently selected items. */ - selectedItems?: Array; - /** Specifies how the widget applies values. */ - applyValueMode?: string; - /** A Boolean value specifying whether or not to hide selected items. */ - hideSelectedItems?: boolean; - /** A handler for the selectAllValueChanged event. */ - onSelectAllValueChanged?: Function; - /** A Boolean value specifying whether or not the widget is multiline. */ - multiline?: boolean; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: Function; - /** The template to be used for rendering tags. */ - tagTemplate?: any; - } - /** A widget that allows you to select multiple items from a dropdown list. */ - export class dxTagBox extends dxSelectBox { - constructor(element: JQuery, options?: dxTagBoxOptions); - constructor(element: Element, options?: dxTagBoxOptions); - } - export interface dxScrollViewOptions extends dxScrollableOptions { - /** A handler for the pullDown event. */ - onPullDown?: Function; - /** Specifies the text shown in the pullDown panel when pulling the content down lowers the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while pulling the content down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the reachBottom event. */ - onReachBottom?: Function; - /** Specifies the text shown in the pullDown panel displayed when content is scrolled to the bottom. */ - reachBottomText?: string; - /** Specifies the text shown in the pullDown panel displayed when the content is being refreshed. */ - refreshingText?: string; - } - /** A widget used to display scrollable content. */ - export class dxScrollView extends dxScrollable { - constructor(element: JQuery, options?: dxScrollViewOptions); - constructor(element: Element, options?: dxScrollViewOptions); - /** Returns a value indicating if the scrollView content is larger then the widget container. */ - isFull(): boolean; - /** Locks the widget until the release(preventScrollBottom) method is called and executes the function passed to the onPullDown option and the handler assigned to the pullDown event. */ - refresh(): void; - /** Notifies the scroll view that data loading is finished. */ - release(preventScrollBottom: boolean): JQueryPromise; - /** Toggles the loading state of the widget. */ - toggleLoading(showOrHide: boolean): void; - } - export interface dxScrollableLocation { - top?: number; - left?: number; - } - export interface dxScrollableOptions extends DOMComponentOptions { - /** A string value specifying the available scrolling directions. */ - direction?: string; - /** A Boolean value specifying whether or not the widget can respond to user interaction. */ - disabled?: boolean; - /** A handler for the scroll event. */ - onScroll?: Function; - /** Specifies when the widget shows the scrollbar. */ - showScrollbar?: string; - /** A handler for the update event. */ - onUpdated?: Function; - /** Indicates whether to use native or simulated scrolling. */ - useNative?: boolean; - /** A Boolean value specifying whether to enable or disable the bounce-back effect. */ - bounceEnabled?: boolean; - /** A Boolean value specifying whether or not an end-user can scroll the widget content swiping it up or down. */ - scrollByContent?: boolean; - /** A Boolean value specifying whether or not an end-user can scroll the widget content using the scrollbar. */ - scrollByThumb?: boolean; - } - /** A widget used to display scrollable content. */ - export class dxScrollable extends DOMComponent { - constructor(element: JQuery, options?: dxScrollableOptions); - constructor(element: Element, options?: dxScrollableOptions); - /** Returns the height of the scrollable widget in pixels. */ - clientHeight(): number; - /** Returns the width of the scrollable widget in pixels. */ - clientWidth(): number; - /** Returns an HTML element of the widget. */ - content(): JQuery; - /** Scrolls the widget content by the specified number of pixels. */ - scrollBy(distance: number): void; - /** Scrolls widget content by the specified number of pixels in horizontal and vertical directions. */ - scrollBy(distanceObject: dxScrollableLocation): void; - /** Returns the height of the scrollable content in pixels. */ - scrollHeight(): number; - /** Returns the current scroll position against the leftmost position. */ - scrollLeft(): number; - /** Returns how far the scrollable content is scrolled from the top and from the left. */ - scrollOffset(): dxScrollableLocation; - /** Scrolls widget content to the specified position. */ - scrollTo(targetLocation: number): void; - /** Scrolls widget content to a specified position. */ - scrollTo(targetLocation: dxScrollableLocation): void; - /** Scrolls widget content to the specified element. */ - scrollToElement(element: Element): void; - /** Returns the current scroll position against the topmost position. */ - scrollTop(): number; - /** Returns the width of the scrollable content in pixels. */ - scrollWidth(): number; - /** Updates the dimensions of the scrollable contents. */ - update(): void; - } - export interface dxRadioGroupOptions extends EditorOptions, DataExpressionMixinOptions { - activeStateEnabled?: boolean; - /** Specifies the radio group layout. */ - layout?: string; - } - /** A widget that enables a user to select one item within a list of items represented by radio buttons. */ - export class dxRadioGroup extends CollectionWidget { - constructor(element: JQuery, options?: dxRadioGroupOptions); - constructor(element: Element, options?: dxRadioGroupOptions); - } - export interface dxPopupToolbarItemOptions { - /** Specifies whether or not a toolbar item must be displayed disabled. */ - disabled?: boolean; - /** Specifies html code inserted into the toolbar item element. */ - html?: string; - /** Specifies a location for the item on the toolbar. */ - location?: string; - /** Specifies a configuration object for the widget that presents a toolbar item. */ - options?: Object; - /** Specifies an item template that should be used to render this item only. */ - template?: any; - /** Specifies text displayed for the toolbar item. */ - text?: string; - /** Specifies whether the item is displayed on a top or bottom toolbar. */ - toolbar?: string; - /** Specifies whether or not a widget item must be displayed. */ - visible?: boolean; - /** A widget that presents a toolbar item. */ - widget?: string; - } - export interface dxPopupOptions extends dxOverlayOptions { - /** Specifies whether or not to allow a user to drag the popup window. */ - dragEnabled?: boolean; - /** Specifies whether or not an end user can resize the widget. */ - resizeEnabled?: boolean; - /** A handler for the resizeStart event. */ - onResizeStart?: Function; - /** A handler for the resize event. */ - onResize?: Function; - /** A handler for the resizeEnd event. */ - onResizeEnd?: Function; - /** A Boolean value specifying whether or not to display the widget in full-screen mode. */ - fullScreen?: boolean; - position?: PositionOptions; - /** A Boolean value specifying whether or not to display the title in the popup window. */ - showTitle?: boolean; - /** The title in the overlay window. */ - title?: string; - /** A template to be used for rendering the widget title. */ - titleTemplate?: any; - width?: any; - /** Specifies items displayed on the top or bottom toolbar of the popup window. */ - toolbarItems?: Array; - /** Specifies whether or not the widget displays the Close button. */ - showCloseButton?: boolean; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - } - /** A widget that displays required content in a popup window. */ - export class dxPopup extends dxOverlay { - constructor(element: JQuery, options?: dxPopupOptions); - constructor(element: Element, options?: dxPopupOptions); - } - export interface dxPopoverOptions extends dxPopupOptions { - /** An object defining the animation options of the widget. */ - animation?: { - /** An object that defines the animation options used when the widget is being shown. */ - show?: fx.AnimationOptions; - /** An object that defines the animation options used when the widget is being hidden. */ - hide?: fx.AnimationOptions; - }; - /** Specifies the height of the widget. */ - height?: any; - /** An object defining widget positioning options. */ - position?: PositionOptions; - shading?: boolean; - /** A Boolean value specifying whether or not to display the title in the overlay window. */ - showTitle?: boolean; - /** The target element associated with a popover. */ - target?: any; - /** Specifies the width of the widget. */ - width?: any; - } - /** A widget that displays the required content in a popup window. */ - export class dxPopover extends dxPopup { - constructor(element: JQuery, options?: dxPopoverOptions); - constructor(element: Element, options?: dxPopoverOptions); - /** Displays the widget for the specified target element. */ - show(target?: any): JQueryPromise; - } - export interface dxOverlayOptions extends WidgetOptions { - /** An object defining the animation options of the widget. */ - animation?: { - /** An object that defines the animation options used when the widget is being shown. */ - show?: fx.AnimationOptions; - /** An object that defines the animation options used when the widget is being hidden. */ - hide?: fx.AnimationOptions; - }; - /** A Boolean value specifying whether or not the widget is closed if a user presses the Back hardware button. */ - closeOnBackButton?: boolean; - /** A Boolean value specifying whether or not the widget is closed if a user clicks outside of the overlapping window. */ - closeOnOutsideClick?: any; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - /** Specifies whether or not an end-user can drag the widget. */ - dragEnabled?: boolean; - /** The height of the widget in pixels. */ - height?: any; - /** Specifies the maximum height the widget can reach while resizing. */ - maxHeight?: any; - /** Specifies the maximum width the widget can reach while resizing. */ - maxWidth?: any; - /** Specifies the minimum height the widget can reach while resizing. */ - minHeight?: any; - /** Specifies the minimum width the widget can reach while resizing. */ - minWidth?: any; - /** A handler for the hidden event. */ - onHidden?: Function; - /** A handler for the hiding event. */ - onHiding?: Function; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** A Boolean value specifying whether or not the main screen is inactive while the widget is active. */ - shading?: boolean; - /** Specifies the shading color. */ - shadingColor?: string; - /** A handler for the showing event. */ - onShowing?: Function; - /** A handler for the shown event. */ - onShown?: Function; - onContentReady?: Function; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - /** The widget width in pixels. */ - width?: any; - } - /** A widget displaying the required content in an overlay window. */ - export class dxOverlay extends Widget { - constructor(element: JQuery, options?: dxOverlayOptions); - constructor(element: Element, options?: dxOverlayOptions); - /** An HTML element of the widget. */ - content(): JQuery; - /** Hides the widget. */ - hide(): JQueryPromise; - /** Recalculates the overlay's size and position. */ - repaint(): void; - /** Shows the widget. */ - show(): JQueryPromise; - /** Toggles the visibility of the widget. */ - toggle(showing: boolean): JQueryPromise; - /** A static method that specifies the base z-index for all overlay widgets. */ - static baseZIndex(zIndex: number): void; - } - export interface dxNumberBoxOptions extends dxTextEditorOptions { - /** The maximum value accepted by the number box. */ - max?: number; - /** The minimum value accepted by the number box. */ - min?: number; - /** Specifies whether or not to show spin buttons. */ - showSpinButtons?: boolean; - useTouchSpinButtons?: boolean; - /** Specifies by which value the widget value changes when a spin button is clicked. */ - step?: number; - /** The current number box value. */ - value?: number; - /** The "mode" attribute value of the actual HTML input element representing the widget. */ - mode?: string; - /** Specifies the text of the message displayed if the specified value is not a number. */ - invalidValueMessage?: string; - } - /** A textbox widget that enables a user to enter numeric values. */ - export class dxNumberBox extends dxTextEditor { - constructor(element: JQuery, options?: dxNumberBoxOptions); - constructor(element: Element, options?: dxNumberBoxOptions); - } - export interface dxNavBarOptions extends dxTabsOptions { - scrollingEnabled?: boolean; - } - /** A widget that contains items used to navigate through application views. */ - export class dxNavBar extends dxTabs { - constructor(element: JQuery, options?: dxNavBarOptions); - constructor(element: Element, options?: dxNavBarOptions); - } - export interface dxMultiViewOptions extends CollectionWidgetOptions { - /** Specifies whether or not to animate the displayed item change. */ - animationEnabled?: boolean; - /** A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped. */ - loop?: boolean; - /** The index of the currently displayed item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to allow users to change the selected index by swiping. */ - swipeEnabled?: boolean; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - } - /** A widget used to display a view and to switch between several views. */ - export class dxMultiView extends CollectionWidget { - constructor(element: JQuery, options?: dxMultiViewOptions); - constructor(element: Element, options?: dxMultiViewOptions); - } - export interface dxMapLocation { - /** The latitude location of the widget. */ - lat?: number; - /** The longitude location of the widget. */ - lng?: number; - } - export interface dxMapMarker { - /** A URL pointing to the custom icon to be used for the marker. */ - iconSrc?: string; - /** Specifies the marker location. */ - location?: dxMapLocation; - /** A callback function performed when the marker is clicked. */ - onClick?: Function; - /** A tooltip to be used for the marker. */ - tooltip?: { - /** Specifies whether a tooltip is visible by default or not. */ - isShown?: boolean; - /** Specifies the tooltip text. */ - text?: string; - } - } - export interface dxMapRoute { - /** Specifies the color of the line displaying the route. */ - color?: string; - /** Specifies a transportation mode to be used in the displayed route. */ - mode?: string; - /** Specifies the opacity of the line displaying the route. */ - opacity?: number; - /** Contains an array of objects making up the route. */ - locations?: Array; - /** Specifies the thickness of the line displaying the route in pixels. */ - weight?: number; - } - export interface dxMapOptions extends WidgetOptions { - /** Specifies whether or not the widget automatically adjusts center and zoom option values when adding a new marker or route, or when creating a widget if it initially contains markers or routes. */ - autoAdjust?: boolean; - center?: dxMapLocation; - /** A handler for the click event. */ - onClick?: any; - /** Specifies whether or not map widget controls are available. */ - controls?: boolean; - /** Specifies the height of the widget. */ - height?: any; - /** A key used to authenticate the application within the required map provider. */ - key?: { - /** A key used to authenticate the application within the "Bing" map provider. */ - bing?: string; - /** A key used to authenticate the application within the "Google" map provider. */ - google?: string; - /** A key used to authenticate the application within the "Google Static" map provider. */ - googleStatic?: string; - } - /** A handler for the markerAdded event. */ - onMarkerAdded?: Function; - /** A URL pointing to the custom icon to be used for map markers. */ - markerIconSrc?: string; - /** A handler for the markerRemoved event. */ - onMarkerRemoved?: Function; - /** An array of markers displayed on a map. */ - markers?: Array; - /** The name of the current map data provider. */ - provider?: string; - /** A handler for the ready event. */ - onReady?: Function; - /** A handler for the routeAdded event. */ - onRouteAdded?: Function; - /** A handler for the routeRemoved event. */ - onRouteRemoved?: Function; - /** An array of routes shown on the map. */ - routes?: Array; - /** The type of a map to display. */ - type?: string; - /** Specifies the width of the widget. */ - width?: any; - /** The zoom level of the map. */ - zoom?: number; - } - /** An interactive map widget. */ - export class dxMap extends Widget { - constructor(element: JQuery, options?: dxMapOptions); - constructor(element: Element, options?: dxMapOptions); - /** Adds a marker to the map. */ - addMarker(markerOptions: Object): JQueryPromise; - /** Adds a route to the map. */ - addRoute(routeOptions: Object): JQueryPromise; - /** Removes a marker from the map. */ - removeMarker(marker: Object): JQueryPromise; - /** Removes a route from the map. */ - removeRoute(route: any): JQueryPromise; - } - export interface dxLookupOptions extends dxDropDownListOptions { - applyValueMode?: string; - /** An object that defines widget animation options. */ - animation?: { - /** An object that defines the animation options used when the widget is being shown. */ - show?: fx.AnimationOptions; - /** An object that defines the animation options used when the widget is being hidden. */ - hide?: fx.AnimationOptions; - }; - /** The text displayed on the Cancel button. */ - cancelButtonText?: string; - /** The text displayed on the Clear button. */ - clearButtonText?: string; - /** Specifies whether or not the widget cleans the search box when the popup window is displayed. */ - cleanSearchOnOpening?: boolean; - /** A Boolean value specifying whether or not a widget is closed if a user clicks outside of the overlaying window. */ - closeOnOutsideClick?: any; - /** The text displayed on the Apply button. */ - applyButtonText?: string; - /** A Boolean value specifying whether or not to display the lookup in full-screen mode. */ - fullScreen?: boolean; - focusStateEnabled?: boolean; - /** A Boolean value specifying whether or not to group widget items. */ - grouped?: boolean; - /** The name of the template used to display a group header. */ - groupTemplate?: any; - /** The text displayed on the button used to load the next page from the data source. */ - nextButtonText?: string; - /** A handler for the pageLoading event. */ - onPageLoading?: Function; - /** Specifies whether the next page is loaded when a user scrolls the widget to the bottom or when the "next" button is clicked. */ - pageLoadMode?: string; - /** Specifies the text shown in the pullDown panel, which is displayed when the widget is scrolled to the bottom. */ - pageLoadingText?: string; - /** The text displayed by the widget when nothing is selected. */ - placeholder?: string; - /** The height of the widget popup element. */ - popupHeight?: any; - /** The width of the widget popup element. */ - popupWidth?: any; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** Specifies the text displayed in the pullDown panel when the widget is pulled below the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the pullRefresh event. */ - onPullRefresh?: Function; - /** A Boolean value specifying whether or not the widget supports the "pull down to refresh" gesture. */ - pullRefreshEnabled?: boolean; - /** Specifies the text displayed in the pullDown panel while the widget is being refreshed. */ - refreshingText?: string; - /** A handler for the scroll event. */ - onScroll?: Function; - /** A Boolean value specifying whether or not the search bar is visible. */ - searchEnabled?: boolean; - /** The text that is provided as a hint in the lookup's search bar. */ - searchPlaceholder?: string; - /** A Boolean value specifying whether or not the main screen is inactive while the lookup is active. */ - shading?: boolean; - /** Specifies whether to display the Cancel button in the lookup window. */ - showCancelButton?: boolean; - /** - * A Boolean value specifying whether the widget loads the next page automatically when you reach the bottom of the list or when a button is clicked. - * @deprecated Use the pageLoadMode option instead. - */ - showNextButton?: boolean; - /** The title of the lookup window. */ - title?: string; - /** A template to be used for rendering the widget title. */ - titleTemplate?: any; - /** Specifies whether or not the widget uses native scrolling. */ - useNativeScrolling?: boolean; - /** Specifies whether or not to show lookup contents in a dxPopover widget. */ - usePopover?: boolean; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - /** A Boolean value specifying whether or not to display the title in the popup window. */ - showPopupTitle?: boolean; - /** The template to be used for rendering the widget text field. */ - fieldTemplate?: any; - } - /** A widget that allows a user to select predefined values from a lookup window. */ - export class dxLookup extends dxDropDownList { - constructor(element: JQuery, options?: dxLookupOptions); - constructor(element: Element, options?: dxLookupOptions); - } - export interface dxLoadPanelOptions extends dxOverlayOptions { - /** An object defining the animation options of the widget. */ - animation?: fx.AnimationOptions; - /** The delay in milliseconds after which the load panel is displayed. */ - delay?: number; - /** The height of the widget. */ - height?: number; - /** A URL pointing to an image to be used as a load indicator. */ - indicatorSrc?: string; - /** The text displayed in the load panel. */ - message?: string; - /** A Boolean value specifying whether or not to show a load indicator. */ - showIndicator?: boolean; - /** A Boolean value specifying whether or not to show the pane behind the load indicator. */ - showPane?: boolean; - /** The width of the widget. */ - width?: number; - /** Specifies whether or not the widget can be focused. */ - focusStateEnabled?: boolean; - } - /** A widget used to indicate whether or not an element is loading. */ - export class dxLoadPanel extends dxOverlay { - constructor(element: JQuery, options?: dxLoadPanelOptions); - constructor(element: Element, options?: dxLoadPanelOptions); - } - export interface dxLoadIndicatorOptions extends WidgetOptions { - /** Specifies the path to an image used as the indicator. */ - indicatorSrc?: string; - } - /** The widget used to indicate the loading process. */ - export class dxLoadIndicator extends Widget { - constructor(element: JQuery, options?: dxLoadIndicatorOptions); - constructor(element: Element, options?: dxLoadIndicatorOptions); - } - export interface ListOptionsMenuItem { - /** Specifies the menu item text. */ - text?: string; - /** Holds on a function called when the item is clicked. */ - action?: (itemElement: Element, itemData: any) => void; - } - export interface dxListOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not to display a grouped list. */ - grouped?: boolean; - /** The template to be used for rendering item groups. */ - groupTemplate?: any; - onItemDeleting?: Function; - /** A handler for the itemDeleted event. */ - onItemDeleted?: Function; - /** A handler for the groupRendered event. */ - onGroupRendered?: Function; - /** A handler for the itemReordered event. */ - onItemReordered?: Function; - /** A handler for the itemClick event. */ - onItemClick?: any; - /** A handler for the itemSwipe event. */ - onItemSwipe?: Function; - /** The text displayed on the button used to load the next page from the data source. */ - nextButtonText?: string; - /** A handler for the pageLoading event. */ - onPageLoading?: Function; - /** Specifies the text shown in the pullDown panel, which is displayed when the list is scrolled to the bottom. */ - pageLoadingText?: string; - /** Specifies the text displayed in the pullDown panel when the list is pulled below the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the pullRefresh event. */ - onPullRefresh?: Function; - /** A Boolean value specifying whether or not the widget supports the "pull down to refresh" gesture. */ - pullRefreshEnabled?: boolean; - /** Specifies the text displayed in the pullDown panel while the list is being refreshed. */ - refreshingText?: string; - /** A handler for the scroll event. */ - onScroll?: Function; - /** A Boolean value specifying whether to enable or disable list scrolling. */ - scrollingEnabled?: boolean; - /** Specifies when the widget shows the scrollbar. */ - showScrollbar?: string; - /** Specifies whether or not the widget uses native scrolling. */ - useNativeScrolling?: boolean; - /** A Boolean value specifying whether to enable or disable the bounce-back effect. */ - bounceEnabled?: boolean; - /** A Boolean value specifying if the list is scrolled by content. */ - scrollByContent?: boolean; - /** A Boolean value specifying if the list is scrolled using the scrollbar. */ - scrollByThumb?: boolean; - onItemContextMenu?: Function; - onItemHold?: Function; - /** Specifies whether or not an end-user can collapse groups. */ - collapsibleGroups?: boolean; - /** Specifies whether the next page is loaded when a user scrolls the widget to the bottom or when the "next" button is clicked. */ - pageLoadMode?: string; - /** Specifies whether or not to display controls used to select list items. */ - showSelectionControls?: boolean; - /** Specifies item selection mode. */ - selectionMode?: string; - selectAllText?: string; - /** A handler for the selectAllValueChanged event. */ - onSelectAllValueChanged?: Function; - /** Specifies the array of items for a context menu called for a list item. */ - menuItems?: Array; - /** Specifies whether an item context menu is shown when a user holds or swipes an item. */ - menuMode?: string; - /** Specifies whether or not an end user can delete list items. */ - allowItemDeleting?: boolean; - /** Specifies the way a user can delete items from the list. */ - itemDeleteMode?: string; - /** Specifies whether or not an end user can reorder list items. */ - allowItemReordering?: boolean; - /** Specifies whether or not to show the loading panel when the DataSource bound to the widget is loading data. */ - indicateLoading?: boolean; - activeStateEnabled?: boolean; - } - /** A list widget. */ - export class dxList extends CollectionWidget { - constructor(element: JQuery, options?: dxListOptions); - constructor(element: Element, options?: dxListOptions); - /** Returns the height of the widget in pixels. */ - clientHeight(): number; - /** Removes the specified item from the list. */ - deleteItem(itemIndex: any): JQueryPromise; - /** Removes the specified item from the list. */ - deleteItem(itemElement: Element): JQueryPromise; - /** Returns a Boolean value that indicates whether or not the specified item is selected. */ - isItemSelected(itemIndex: any): boolean; - /** Returns a Boolean value that indicates whether or not the specified item is selected. */ - isItemSelected(itemElement: Element): boolean; - /** Reloads list data. */ - reload(): void; - /** Moves the specified item to the specified position in the list. */ - reorderItem(itemElement: Element, toItemElement: Element): JQueryPromise; - /** Moves the specified item to the specified position in the list. */ - reorderItem(itemIndex: any, toItemIndex: any): JQueryPromise; - /** Scrolls the list content by the specified number of pixels. */ - scrollBy(distance: number): void; - /** Returns the height of the list content in pixels. */ - scrollHeight(): number; - /** Scrolls list content to the specified position. */ - scrollTo(location: number): void; - /** Scrolls the list to the specified item. */ - scrollToItem(itemElement: Element): void; - /** Scrolls the list to the specified item. */ - scrollToItem(itemIndex: any): void; - /** Returns how far the list content is scrolled from the top. */ - scrollTop(): number; - /** Selects the specified item from the list. */ - selectItem(itemElement: Element): void; - /** Selects the specified item from the list. */ - selectItem(itemIndex: any): void; - /** Deselects the specified item from the list. */ - unselectItem(itemElement: Element): void; - /** Unselects the specified item from the list. */ - unselectItem(itemIndex: any): void; - /** Updates the widget scrollbar according to widget content size. */ - updateDimensions(): JQueryPromise; - /** Expands the specified group. */ - expandGroup(groupIndex: number): JQueryPromise; - /** Collapses the specified group. */ - collapseGroup(groupIndex: number): JQueryPromise; - } - export interface dxGalleryOptions extends CollectionWidgetOptions { - /** The time, in milliseconds, spent on slide animation. */ - animationDuration?: number; - /** Specifies whether or not to animate the displayed item change. */ - animationEnabled?: boolean; - /** A Boolean value specifying whether or not to allow users to switch between items by clicking an indicator. */ - indicatorEnabled?: boolean; - /** A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped. */ - loop?: boolean; - /** The index of the currently active gallery item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to display an indicator that points to the selected gallery item. */ - showIndicator?: boolean; - /** A Boolean value that specifies the availability of the "Forward" and "Back" navigation buttons. */ - showNavButtons?: boolean; - /** The time interval in milliseconds, after which the gallery switches to the next item. */ - slideshowDelay?: number; - /** A Boolean value specifying whether or not to allow users to switch between items by swiping. */ - swipeEnabled?: boolean; - /** Specifies whether or not to display parts of previous and next images along the sides of the current image. */ - wrapAround?: boolean; - /** Specifies if the widget stretches images to fit the total gallery width. */ - stretchImages?: boolean; - /** Specifies the width of an area used to display a single image. */ - initialItemWidth?: number; - } - /** An image gallery widget. */ - export class dxGallery extends CollectionWidget { - constructor(element: JQuery, options?: dxGalleryOptions); - constructor(element: Element, options?: dxGalleryOptions); - /** Shows the specified gallery item. */ - goToItem(itemIndex: number, animation: boolean): JQueryPromise; - /** Shows the next gallery item. */ - nextItem(animation: boolean): JQueryPromise; - /** Shows the previous gallery item. */ - prevItem(animation: boolean): JQueryPromise; - } - export interface dxDropDownEditorOptions extends dxTextBoxOptions { - /** Specifies the current value displayed by the widget. */ - value?: Object; - /** A handler for the closed event. */ - onClosed?: Function; - /** A handler for the opened event. */ - onOpened?: Function; - /** Specifies whether or not the drop-down editor is displayed. */ - opened?: boolean; - fieldEditEnabled?: boolean; - /** Specifies whether or not the widget allows an end-user to enter a custom value. */ - acceptCustomValue?: boolean; - /** Specifies the way an end-user applies the selected value. */ - applyValueMode?: string; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - activeStateEnabled?: boolean; - } - /** A drop-down editor widget. */ - export class dxDropDownEditor extends dxTextBox { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - /** Closes the drop-down editor. */ - close(): void; - /** Opens the drop-down editor. */ - open(): void; - /** Resets the widget's value to null. */ - reset(): void; - /** Returns an <input> element of the widget. */ - field(): JQuery; - /** Returns an HTML element of the popup window content. */ - content(): JQuery; - } - export interface dxDateBoxOptions extends dxTextEditorOptions { - formatString?: any; - /** Specifies the date display format. Applies only if the pickerType option is 'native' */ - displayFormat?: any; - format?: string; - /** A format used to display date/time information. */ - type?: string; - /** The last date that can be selected within the widget. */ - max?: any; - /** The minimum date that can be selected within the widget. */ - min?: any; - /** The text displayed by the widget when the widget value is not yet specified. This text is also used as a title of the date picker. */ - placeholder?: string; - /** - * Specifies whether or not a user can pick out a date using the drop-down calendar. - * @deprecated Use the pickerType option instead. - */ - useCalendar?: boolean; - /** An object or a value, specifying the date and time currently selected using the date box. */ - value?: any; - /** - * Specifies whether or not the widget uses the native HTML input element. - * @deprecated Use the pickerType option instead. - */ - useNative?: boolean; - /** Specifies the interval between neighboring values in the popup list in minutes. */ - interval?: number; - /** Specifies the maximum zoom level of a calendar, which is used to pick the date. */ - maxZoomLevel?: string; - /** Specifies the minimal zoom level of a calendar, which is used to pick the date. */ - minZoomLevel?: string; - /** Specifies the type of date/time picker. */ - pickerType?: string; - /** Specifies the message displayed if the typed value is not a valid date or time. */ - invalidDateMessage?: string; - /** Specifies the message displayed if the specified date is later than the max value or earlier than the min value. */ - dateOutOfRangeMessage?: string; - /** The text displayed on the Apply button. */ - applyButtonText?: string; - /** Specifies whether or not adaptive widget rendering is enabled on a small screen. */ - adaptivityEnabled?: boolean; - /** The text displayed on the Cancel button. */ - cancelButtonText?: string; - } - /** A date box widget. */ - export class dxDateBox extends dxDropDownEditor { - constructor(element: JQuery, options?: dxDateBoxOptions); - constructor(element: Element, options?: dxDateBoxOptions); - } - export interface dxCheckBoxOptions extends EditorOptions { - activeStateEnabled?: boolean; - /** Specifies the widget state. */ - value?: boolean; - /** Specifies the text displayed by the check box. */ - text?: string; - } - /** A check box widget. */ - export class dxCheckBox extends Editor { - constructor(element: JQuery, options?: dxCheckBoxOptions); - constructor(element: Element, options?: dxCheckBoxOptions); - } - export interface dxCalendarOptions extends EditorOptions { - activeStateEnabled?: boolean; - /** Specifies a date displayed on the current calendar page. */ - currentDate?: Date; - /** Specifies the first day of a week. */ - firstDayOfWeek?: number; - /** An object or a value, specifying the date and time currently selected in the calendar. */ - value?: any; - /** The latest date the widget allows to select. */ - max?: any; - /** The earliest date the widget allows to select. */ - min?: any; - /** Specifies whether or not the widget displays a button that selects the current date. */ - showTodayButton?: boolean; - /** Specifies the current calendar zoom level. */ - zoomLevel?: string; - /** Specifies the maximum zoom level of the calendar. */ - maxZoomLevel?: string; - /** Specifies the minimum zoom level of the calendar. */ - minZoomLevel?: string; - /** The template to be used for rendering calendar cells. */ - cellTemplate?: any; - } - /** A calendar widget. */ - export class dxCalendar extends Editor { - constructor(element: JQuery, options?: dxCalendarOptions); - constructor(element: Element, options?: dxCalendarOptions); - } - export interface dxButtonOptions extends WidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A handler for the click event. */ - onClick?: any; - /** Specifies the icon to be displayed on the button. */ - icon?: string; - iconSrc?: string; - /** A template to be used for rendering the dxButton widget. */ - template?: any; - /** The text displayed on the button. */ - text?: string; - /** Specifies the button type. */ - type?: string; - /** Specifies the name of the validation group to be accessed in the click event handler. */ - validationGroup?: string; - } - /** A button widget. */ - export class dxButton extends Widget { - constructor(element: JQuery, options?: dxButtonOptions); - constructor(element: Element, options?: dxButtonOptions); - } - export interface dxBoxOptions extends CollectionWidgetOptions { - /** Specifies how widget items are aligned along the main direction. */ - align?: string; - /** Specifies the direction of item positioning in the widget. */ - direction?: string; - /** Specifies how widget items are aligned cross-wise. */ - crossAlign?: string; - } - /** A container widget used to arrange inner elements. */ - export class dxBox extends CollectionWidget { - constructor(element: JQuery, options?: dxBoxOptions); - constructor(element: Element, options?: dxBoxOptions); - } - export interface dxResponsiveBoxOptions extends CollectionWidgetOptions { - /** Specifies the collection of rows for the grid used to position layout elements. */ - rows?: Array; - /** Specifies the collection of columns for the grid used to position layout elements. */ - cols?: Array; - /** Specifies the function returning the screen factor depending on the screen width. */ - screenByWidth?: (width: number) => string; - /** Specifies the screen factor with which all elements are located in a single column. */ - singleColumnScreen?: string; - } - /** A widget used to build an adaptive markup that is dependent on screen resolution. */ - export class dxResponsiveBox extends CollectionWidget { - constructor(element: JQuery, options?: dxBoxOptions); - constructor(element: Element, options?: dxBoxOptions); - } - export interface dxAutocompleteOptions extends dxDropDownListOptions { - /** Specifies the current value displayed by the widget. */ - value?: string; - /** The minimum number of characters that must be entered into the text box to begin a search. */ - minSearchLength?: number; - /** Specifies the maximum count of items displayed by the widget. */ - maxItemCount?: number; - /** Gets the currently selected item. */ - selectedItem?: Object; - } - /** A textbox widget that supports autocompletion. */ - export class dxAutocomplete extends dxDropDownList { - constructor(element: JQuery, options?: dxAutocompleteOptions); - constructor(element: Element, options?: dxAutocompleteOptions); - /** Opens the drop-down editor. */ - open(): void; - /** Closes the drop-down editor. */ - close(): void; - } - export interface dxAccordionOptions extends CollectionWidgetOptions { - /** A number specifying the time in milliseconds spent on the animation of the expanding or collapsing of a panel. */ - animationDuration?: number; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies whether all items can be collapsed or whether at least one item must always be expanded. */ - collapsible?: boolean; - /** Specifies whether the widget can expand several items or only a single item at once. */ - multiple?: boolean; - /** The template to be used for rendering dxAccordion items. */ - itemTemplate?: any; - /** A handler for the itemTitleClick event. */ - onItemTitleClick?: any; - /** The template to be used for rendering an item title. */ - itemTitleTemplate?: any; - /** The index number of the currently selected item. */ - selectedIndex?: number; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - } - /** A widget that displays data source items on collapsible panels. */ - export class dxAccordion extends CollectionWidget { - constructor(element: JQuery, options?: dxAccordionOptions); - constructor(element: Element, options?: dxAccordionOptions); - /** Collapses the specified item. */ - collapseItem(index: number): JQueryPromise; - /** Expands the specified item. */ - expandItem(index: number): JQueryPromise; - /** Updates the dimensions of the widget contents. */ - updateDimensions(): JQueryPromise; - } - export interface dxFileUploaderOptions extends EditorOptions { - /** A read-only option that holds a File instance representing the selected file. */ - value?: Array; - values?: Array; - buttonText?: string; - /** The text displayed on the button that opens the file browser. */ - selectButtonText?: string; - /** The text displayed on the button that starts uploading. */ - uploadButtonText?: string; - /** Specifies the text displayed on the area to which an end-user can drop a file. */ - labelText?: string; - /** Specifies the value passed to the name attribute of the underlying input element. */ - name?: string; - /** Specifies whether the widget enables an end-user to select a single file or multiple files. */ - multiple?: boolean; - /** Specifies a file type or several types accepted by the widget. */ - accept?: string; - /** Specifies a target Url for the upload request. */ - uploadUrl?: string; - /** Specifies if an end user can remove a file from the selection and interrupt uploading. */ - allowCanceling?: boolean; - /** Specifies whether or not the widget displays the list of selected files. */ - showFileList?: boolean; - /** Gets the current progress in percentages. */ - progress?: number; - /** The message displayed by the widget when it is ready to upload the specified files. */ - readyToUploadMessage?: string; - /** The message displayed by the widget when uploading is finished. */ - uploadedMessage?: string; - /** The message displayed by the widget on uploading failure. */ - uploadFailedMessage?: string; - /** Specifies how the widget uploads files. */ - uploadMode?: string; - /** Specifies the method for the upload request. */ - uploadMethod?: string; - /** Specifies headers for the upload request. */ - uploadHeaders?: Object; - /** A handler for the uploadStarted event. */ - onUploadStarted?: Function; - /** A handler for the uploaded event. */ - onUploaded?: Function; - /** A handler for the uploaded event. */ - onProgress?: Function; - /** A handler for the uploadError event. */ - onUploadError?: Function; - /** A handler for the uploadAborted event. */ - onUploadAborted?: Function; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - } - /** A widget used to select and upload a file or multiple files. */ - export class dxFileUploader extends Editor { - constructor(element: JQuery, options?: dxFileUploaderOptions); - constructor(element: Element, options?: dxFileUploaderOptions); - } - export interface dxTrackBarOptions extends EditorOptions { - /** The minimum value the widget can accept. */ - min?: number; - /** The maximum value the widget can accept. */ - max?: number; - /** The current widget value. */ - value?: number; - } - /** A base class for track bar widgets. */ - export class dxTrackBar extends Editor { - constructor(element: JQuery, options?: dxTrackBarOptions); - constructor(element: Element, options?: dxTrackBarOptions); - } - export interface dxProgressBarOptions extends dxTrackBarOptions { - /** Specifies a format for the progress status. */ - statusFormat?: any; - /** Specifies whether or not the widget displays a progress status. */ - showStatus?: boolean; - /** A handler for the complete event. */ - onComplete?: Function; - } - /** A widget used to indicate progress. */ - export class dxProgressBar extends dxTrackBar { - constructor(element: JQuery, options?: dxProgressBarOptions); - constructor(element: Element, options?: dxProgressBarOptions); - } - export interface dxSliderOptions extends dxTrackBarOptions { - activeStateEnabled?: boolean; - /** The slider step size. */ - step?: number; - /** The current slider value. */ - value?: number; - /** Specifies whether or not to highlight a range selected within the widget. */ - showRange?: boolean; - /** Specifies the size of a step by which a slider handle is moved when a user uses the Page up or Page down keyboard shortcuts. */ - keyStep?: number; - /** Specifies options for the slider tooltip. */ - tooltip?: { - /** Specifies whether or not the tooltip is enabled. */ - enabled?: boolean; - /** Specifies format for the tooltip. */ - format?: any; - /** Specifies whether the tooltip is located over or under the slider. */ - position?: string; - /** Specifies whether the widget always shows a tooltip or only when a pointer is over the slider. */ - showMode?: string; - }; - /** Specifies options for labels displayed at the min and max values. */ - label?: { - /** Specifies whether or not slider labels are visible. */ - visible?: boolean; - /** Specifies whether labels are located over or under the scale. */ - position?: string; - /** Specifies a format for labels. */ - format?: any; - }; - } - /** A widget that allows a user to select a numeric value within a given range. */ - export class dxSlider extends dxTrackBar { - constructor(element: JQuery, options?: dxSliderOptions); - constructor(element: Element, options?: dxSliderOptions); - } - export interface dxRangeSliderOptions extends dxSliderOptions { - /** The left edge of the interval currently selected using the range slider. */ - start?: number; - /** The right edge of the interval currently selected using the range slider. */ - end?: number; - } - /** A widget that enables a user to select a range of numeric values. */ - export class dxRangeSlider extends dxSlider { - constructor(element: JQuery, options?: dxRangeSliderOptions); - constructor(element: Element, options?: dxRangeSliderOptions); - } - export interface dxFormItemLabel { - /** Specifies the label text. */ - text?: string; - /** Specifies whether or not the label is visible. */ - visible?: boolean; - /** Specifies whether or not a colon is displayed at the end of the current label. */ - showColon?: boolean; - /** Specifies the location of a label against the editor. */ - location?: string; - /** Specifies the label horizontal alignment. */ - alignment?: string; - } - export interface dxFormItem { - /** Specifies the type of the current item. */ - itemType?: string; - /** Specifies whether or not the current form item is visible. */ - visible?: boolean; - /** Specifies the sequence number of the item in a form, group or tab. */ - visibleIndex?: number; - /** Specifies a CSS class to be applied to the form item. */ - cssClass?: string; - /** Specifies the number of columns spanned by the item. */ - colSpan?: number; - } - export interface dxFormEmptyItem extends dxFormItem { - /** Specifies the form item name. */ - name?: string; - } - export interface dxFormSimpleItem extends dxFormItem { - /** Specifies the path to the formData object field bound to the current form item. */ - dataField?: string; - /** Specifies the form item name. */ - name?: string; - /** Specifies which editor widget is used to display and edit the form item value. */ - editorType?: string; - /** Specifies configuration options for the editor widget of the current form item. */ - editorOptions?: Object; - /** A template to be used for rendering the form item. */ - template?: any; - /** Specifies the help text displayed for the current form item. */ - helpText?: string; - /** Specifies whether the current form item is required. */ - isRequired?: boolean; - /** Specifies options for the form item label. */ - label?: dxFormItemLabel; - /** An array of validation rules to be checked for the form item editor. */ - validationRules?: Array; - } - /** Specifies dependency between the screen factor and the count of columns. */ - export interface ColCountResponsible { - /** The count of columns for an extra small-sized screen. */ - xs?: number; - /** The count of columns for a small-sized screen. */ - sm?: number; - /** The count of columns for a middle-sized screen. */ - md?: number; - /** The count of columns for a large screen size. */ - lg?: number; - } - export interface dxFormGroupItem extends dxFormItem { - /** Specifies the group caption. */ - caption?: string; - /** A template to be used for rendering a group item. */ - template?: any; - /** The count of columns in the group layout. */ - colCount?: number; - /** Specifies dependency between the screen factor and the count of columns in the tab layout. */ - colCountByScreen?: ColCountResponsible; - /** Specifies whether or not all group item labels are aligned. */ - alignItemLabels?: boolean; - /** Holds an array of form items displayed within the group. */ - items?: Array; - } - export interface dxFormTab { - /** Specifies the tab title. */ - title?: string; - /** The count of columns in the tab layout. */ - colCount?: number; - /** Specifies dependency between the screen factor and the count of columns in the group layout. */ - colCountByScreen?: ColCountResponsible; - /** Specifies whether or not labels of items displayed within the current tab are aligned. */ - alignItemLabels?: boolean; - /** Holds an array of form items displayed within the tab. */ - items?: Array; - /** Specifies a badge text for the tab. */ - badge?: string; - /** A Boolean value specifying whether or not the tab can respond to user interaction. */ - disabled?: boolean; - /** Specifies the icon to be displayed on the tab. */ - icon?: string; - /** The template to be used for rendering the tab. */ - tabTemplate?: any; - /** The template to be used for rendering the tab content. */ - template?: any; - } - export interface dxFormTabbedItem extends dxFormItem { - /** Holds a configuration object for the dxTabPanel widget used to display the current form item. */ - tabPanelOptions?: Object; - /** An array of tab configuration objects. */ - tabs?: Array; - } - export interface dxFormOptions extends WidgetOptions { - /** An object providing data for the form. */ - formData?: Object; - /** The count of columns in the form layout. */ - colCount?: any; - /** Specifies dependency between the screen factor and the count of columns in the form layout. */ - colCountByScreen?: ColCountResponsible; - /** Specifies the function returning the screen factor depending on the screen width. */ - screenByWidth?: (width: number) => string; - /** Specifies the location of a label against the editor. */ - labelLocation?: string; - /** Specifies whether or not all editors on the form are read-only. */ - readOnly?: boolean; - /** A handler for the fieldDataChanged event. */ - onFieldDataChanged?: (e: Object) => void; - /** A handler for the editorEnterKey event. */ - onEditorEnterKey?: (e: Object) => void; - /** Specifies a function that customizes a form item after it has been created. */ - customizeItem?: Function; - /** The minimum column width used for calculating column count in the form layout. */ - minColWidth?: number; - /** Specifies whether or not all root item labels are aligned. */ - alignItemLabels?: boolean; - /** Specifies whether or not item labels in all groups are aligned. */ - alignItemLabelsInAllGroups?: boolean; - /** Specifies whether or not a colon is displayed at the end of form labels. */ - showColonAfterLabel?: boolean; - /** Specifies whether or not the required mark is displayed for required fields. */ - showRequiredMark?: boolean; - /** Specifies whether or not the optional mark is displayed for optional fields. */ - showOptionalMark?: boolean; - /** The text displayed for required fields. */ - requiredMark?: string; - /** The text displayed for optional fields. */ - optionalMark?: string; - /** Specifies the message that is shown for end-users if a required field value is not specified. */ - requiredMessage?: string; - /** Specifies whether or not the total validation summary is displayed on the form. */ - showValidationSummary?: boolean; - /** Holds an array of form items. */ - items?: Array; - /** A Boolean value specifying whether to enable or disable form scrolling. */ - scrollingEnabled?: boolean; - onContentReady?: Function; - } - /** A form widget used to display and edit values of object fields. */ - export class dxForm extends Widget { - constructor(element: JQuery, options?: dxFormOptions); - constructor(element: Element, options?: dxFormOptions); - /** Updates the specified field of the formData object and the corresponding editor on the form. */ - updateData(dataField: string, value: any): void; - /** Updates the specified fields of the formData object and the corresponding editors on the form. */ - updateData(data: Object): void; - /** Updates the value of a form item option. */ - itemOption(field: string, option: string, value: any): void; - /** Updates the values of form item options. */ - itemOption(field: string, options: Object): void; - /** Returns an editor instance associated with the specified formData field. */ - getEditor(field: string): Object; - /** Updates the dimensions of the widget contents. */ - updateDimensions(): JQueryPromise; - /** Validates the values of all editors on the form against the list of the validation rules specified for each form item. */ - validate(): Object; - /** Resets the editor's value to undefined. */ - resetValues(): void; - } - export interface dxDeferRenderingOptions extends WidgetOptions { - /** Indicates if a load indicator should be shown until the widget's content is rendered. */ - showLoadIndicator?: boolean; - /** Specifies the jQuery.Promise or boolean value, which when resolved, forces widget content to render. */ - renderWhen?: any; - /** Specifies the animation to be used to show the rendered content. */ - animation?: fx.AnimationOptions; - /** Specifies a jQuery selector of items that should be rendered using a staggered animation. */ - staggerItemSelector?: string; - /** Specifies a callback function that is called when the widget's content has finished rendering but is not yet shown. */ - onRendered?: Function; - /** Specifies a callback function that is called when widget content is shown and animation has completed. */ - onShown?: Function; - } - /** A container for elements that must be rendered at a specified moment. */ - export class dxDeferRendering extends Widget { - constructor(element: JQuery, options?: dxDeferRenderingOptions); - constructor(element: Element, options?: dxDeferRenderingOptions); - } -} -interface JQuery { - dxProgressBar(): JQuery; - dxProgressBar(options: "instance"): DevExpress.ui.dxProgressBar; - dxProgressBar(options: string): any; - dxProgressBar(options: string, ...params: any[]): any; - dxProgressBar(options: DevExpress.ui.dxProgressBarOptions): JQuery; - dxSlider(): JQuery; - dxSlider(options: "instance"): DevExpress.ui.dxSlider; - dxSlider(options: string): any; - dxSlider(options: string, ...params: any[]): any; - dxSlider(options: DevExpress.ui.dxSliderOptions): JQuery; - dxRangeSlider(): JQuery; - dxRangeSlider(options: "instance"): DevExpress.ui.dxRangeSlider; - dxRangeSlider(options: string): any; - dxRangeSlider(options: string, ...params: any[]): any; - dxRangeSlider(options: DevExpress.ui.dxRangeSliderOptions): JQuery; - dxFileUploader(): JQuery; - dxFileUploader(options: "instance"): DevExpress.ui.dxFileUploader; - dxFileUploader(options: string): any; - dxFileUploader(options: string, ...params: any[]): any; - dxFileUploader(options: DevExpress.ui.dxFileUploaderOptions): JQuery; - dxValidator(): JQuery; - dxValidator(options: "instance"): DevExpress.ui.dxValidator; - dxValidator(options: string): any; - dxValidator(options: string, ...params: any[]): any; - dxValidator(options: DevExpress.ui.dxValidatorOptions): JQuery; - dxValidationGroup(): JQuery; - dxValidationGroup(options: "instance"): DevExpress.ui.dxValidationGroup; - dxValidationGroup(options: string): any; - dxValidationGroup(options: string, ...params: any[]): any; - dxValidationSummary(): JQuery; - dxValidationSummary(options: "instance"): DevExpress.ui.dxValidationSummary; - dxValidationSummary(options: string): any; - dxValidationSummary(options: string, ...params: any[]): any; - dxValidationSummary(options: DevExpress.ui.dxValidationSummaryOptions): JQuery; - dxTooltip(): JQuery; - dxTooltip(options: "instance"): DevExpress.ui.dxTooltip; - dxTooltip(options: string): any; - dxTooltip(options: string, ...params: any[]): any; - dxTooltip(options: DevExpress.ui.dxTooltipOptions): JQuery; - dxResizable(): JQuery; - dxResizable(options: "instance"): DevExpress.ui.dxResizable; - dxResizable(options: string): any; - dxResizable(options: string, ...params: any[]): any; - dxResizable(options: DevExpress.ui.dxResizableOptions): JQuery; - dxDropDownList(): JQuery; - dxDropDownList(options: "instance"): DevExpress.ui.dxDropDownList; - dxDropDownList(options: string): any; - dxDropDownList(options: string, ...params: any[]): any; - dxDropDownList(options: DevExpress.ui.dxDropDownListOptions): JQuery; - dxToolbar(): JQuery; - dxToolbar(options: "instance"): DevExpress.ui.dxToolbar; - dxToolbar(options: string): any; - dxToolbar(options: string, ...params: any[]): any; - dxToolbar(options: DevExpress.ui.dxToolbarOptions): JQuery; - dxToast(): JQuery; - dxToast(options: "instance"): DevExpress.ui.dxToast; - dxToast(options: string): any; - dxToast(options: string, ...params: any[]): any; - dxToast(options: DevExpress.ui.dxToastOptions): JQuery; - dxTextEditor(): JQuery; - dxTextEditor(options: "instance"): DevExpress.ui.dxTextEditor; - dxTextEditor(options: string): any; - dxTextEditor(options: string, ...params: any[]): any; - dxTextEditor(options: DevExpress.ui.dxTextEditorOptions): JQuery; - dxTextBox(): JQuery; - dxTextBox(options: "instance"): DevExpress.ui.dxTextBox; - dxTextBox(options: string): any; - dxTextBox(options: string, ...params: any[]): any; - dxTextBox(options: DevExpress.ui.dxTextBoxOptions): JQuery; - dxTextArea(): JQuery; - dxTextArea(options: "instance"): DevExpress.ui.dxTextArea; - dxTextArea(options: string): any; - dxTextArea(options: string, ...params: any[]): any; - dxTextArea(options: DevExpress.ui.dxTextAreaOptions): JQuery; - dxTabs(): JQuery; - dxTabs(options: "instance"): DevExpress.ui.dxTabs; - dxTabs(options: string): any; - dxTabs(options: string, ...params: any[]): any; - dxTabs(options: DevExpress.ui.dxTabsOptions): JQuery; - dxTabPanel(): JQuery; - dxTabPanel(options: "instance"): DevExpress.ui.dxTabPanel; - dxTabPanel(options: string): any; - dxTabPanel(options: string, ...params: any[]): any; - dxTabPanel(options: DevExpress.ui.dxTabPanelOptions): JQuery; - dxSelectBox(): JQuery; - dxSelectBox(options: "instance"): DevExpress.ui.dxSelectBox; - dxSelectBox(options: string): any; - dxSelectBox(options: string, ...params: any[]): any; - dxSelectBox(options: DevExpress.ui.dxSelectBoxOptions): JQuery; - dxTagBox(): JQuery; - dxTagBox(options: "instance"): DevExpress.ui.dxTagBox; - dxTagBox(options: string): any; - dxTagBox(options: string, ...params: any[]): any; - dxTagBox(options: DevExpress.ui.dxTagBoxOptions): JQuery; - dxScrollView(): JQuery; - dxScrollView(options: "instance"): DevExpress.ui.dxScrollView; - dxScrollView(options: string): any; - dxScrollView(options: string, ...params: any[]): any; - dxScrollView(options: DevExpress.ui.dxScrollViewOptions): JQuery; - dxScrollable(): JQuery; - dxScrollable(options: "instance"): DevExpress.ui.dxScrollable; - dxScrollable(options: string): any; - dxScrollable(options: string, ...params: any[]): any; - dxScrollable(options: DevExpress.ui.dxScrollableOptions): JQuery; - dxRadioGroup(): JQuery; - dxRadioGroup(options: "instance"): DevExpress.ui.dxRadioGroup; - dxRadioGroup(options: string): any; - dxRadioGroup(options: string, ...params: any[]): any; - dxRadioGroup(options: DevExpress.ui.dxRadioGroupOptions): JQuery; - dxPopup(): JQuery; - dxPopup(options: "instance"): DevExpress.ui.dxPopup; - dxPopup(options: string): any; - dxPopup(options: string, ...params: any[]): any; - dxPopup(options: DevExpress.ui.dxPopupOptions): JQuery; - dxPopover(): JQuery; - dxPopover(options: "instance"): DevExpress.ui.dxPopover; - dxPopover(options: string): any; - dxPopover(options: string, ...params: any[]): any; - dxPopover(options: DevExpress.ui.dxPopoverOptions): JQuery; - dxOverlay(): JQuery; - dxOverlay(options: "instance"): DevExpress.ui.dxOverlay; - dxOverlay(options: string): any; - dxOverlay(options: string, ...params: any[]): any; - dxOverlay(options: DevExpress.ui.dxOverlayOptions): JQuery; - dxNumberBox(): JQuery; - dxNumberBox(options: "instance"): DevExpress.ui.dxNumberBox; - dxNumberBox(options: string): any; - dxNumberBox(options: string, ...params: any[]): any; - dxNumberBox(options: DevExpress.ui.dxNumberBoxOptions): JQuery; - dxNavBar(): JQuery; - dxNavBar(options: "instance"): DevExpress.ui.dxNavBar; - dxNavBar(options: string): any; - dxNavBar(options: string, ...params: any[]): any; - dxNavBar(options: DevExpress.ui.dxNavBarOptions): JQuery; - dxMultiView(): JQuery; - dxMultiView(options: "instance"): DevExpress.ui.dxMultiView; - dxMultiView(options: string): any; - dxMultiView(options: string, ...params: any[]): any; - dxMultiView(options: DevExpress.ui.dxMultiViewOptions): JQuery; - dxMap(): JQuery; - dxMap(options: "instance"): DevExpress.ui.dxMap; - dxMap(options: string): any; - dxMap(options: string, ...params: any[]): any; - dxMap(options: DevExpress.ui.dxMapOptions): JQuery; - dxLookup(): JQuery; - dxLookup(options: "instance"): DevExpress.ui.dxLookup; - dxLookup(options: string): any; - dxLookup(options: string, ...params: any[]): any; - dxLookup(options: DevExpress.ui.dxLookupOptions): JQuery; - dxLoadPanel(): JQuery; - dxLoadPanel(options: "instance"): DevExpress.ui.dxLoadPanel; - dxLoadPanel(options: string): any; - dxLoadPanel(options: string, ...params: any[]): any; - dxLoadPanel(options: DevExpress.ui.dxLoadPanelOptions): JQuery; - dxLoadIndicator(): JQuery; - dxLoadIndicator(options: "instance"): DevExpress.ui.dxLoadIndicator; - dxLoadIndicator(options: string): any; - dxLoadIndicator(options: string, ...params: any[]): any; - dxLoadIndicator(options: DevExpress.ui.dxLoadIndicatorOptions): JQuery; - dxList(): JQuery; - dxList(options: "instance"): DevExpress.ui.dxList; - dxList(options: string): any; - dxList(options: string, ...params: any[]): any; - dxList(options: DevExpress.ui.dxListOptions): JQuery; - dxGallery(): JQuery; - dxGallery(options: "instance"): DevExpress.ui.dxGallery; - dxGallery(options: string): any; - dxGallery(options: string, ...params: any[]): any; - dxGallery(options: DevExpress.ui.dxGalleryOptions): JQuery; - dxDropDownEditor(): JQuery; - dxDropDownEditor(options: "instance"): DevExpress.ui.dxDropDownEditor; - dxDropDownEditor(options: string): any; - dxDropDownEditor(options: string, ...params: any[]): any; - dxDropDownEditor(options: DevExpress.ui.dxDropDownEditorOptions): JQuery; - dxDateBox(): JQuery; - dxDateBox(options: "instance"): DevExpress.ui.dxDateBox; - dxDateBox(options: string): any; - dxDateBox(options: string, ...params: any[]): any; - dxDateBox(options: DevExpress.ui.dxDateBoxOptions): JQuery; - dxCheckBox(): JQuery; - dxCheckBox(options: "instance"): DevExpress.ui.dxCheckBox; - dxCheckBox(options: string): any; - dxCheckBox(options: string, ...params: any[]): any; - dxCheckBox(options: DevExpress.ui.dxCheckBoxOptions): JQuery; - dxBox(): JQuery; - dxBox(options: "instance"): DevExpress.ui.dxBox; - dxBox(options: string): any; - dxBox(options: string, ...params: any[]): any; - dxBox(options: DevExpress.ui.dxBoxOptions): JQuery; - dxButton(): JQuery; - dxButton(options: "instance"): DevExpress.ui.dxButton; - dxButton(options: string): any; - dxButton(options: string, ...params: any[]): any; - dxButton(options: DevExpress.ui.dxButtonOptions): JQuery; - dxCalendar(): JQuery; - dxCalendar(options: "instance"): DevExpress.ui.dxCalendar; - dxCalendar(options: string): any; - dxCalendar(options: string, ...params: any[]): any; - dxCalendar(options: DevExpress.ui.dxCalendarOptions): JQuery; - dxAccordion(): JQuery; - dxAccordion(options: "instance"): DevExpress.ui.dxAccordion; - dxAccordion(options: string): any; - dxAccordion(options: string, ...params: any[]): any; - dxAccordion(options: DevExpress.ui.dxAccordionOptions): JQuery; - dxResponsiveBox(): JQuery; - dxResponsiveBox(options: "instance"): DevExpress.ui.dxResponsiveBox; - dxResponsiveBox(options: string): any; - dxResponsiveBox(options: string, ...params: any[]): any; - dxResponsiveBox(options: DevExpress.ui.dxResponsiveBoxOptions): JQuery; - dxAutocomplete(): JQuery; - dxAutocomplete(options: "instance"): DevExpress.ui.dxAutocomplete; - dxAutocomplete(options: string): any; - dxAutocomplete(options: string, ...params: any[]): any; - dxAutocomplete(options: DevExpress.ui.dxAutocompleteOptions): JQuery; - dxForm(): JQuery; - dxForm(options: "instance"): DevExpress.ui.dxForm; - dxForm(options: string): any; - dxForm(options: string, ...params: any[]): any; - dxForm(options: DevExpress.ui.dxFormOptions): JQuery; -} - -declare module DevExpress.ui { - export interface dxTileViewOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** Specifies the height of the base tile view item. */ - baseItemHeight?: number; - /** Specifies the width of the base tile view item. */ - baseItemWidth?: number; - /** Specifies whether tiles are placed horizontally or vertically. */ - direction?: string; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies the distance in pixels between adjacent tiles. */ - itemMargin?: number; - /** A Boolean value specifying whether or not to display a scrollbar. */ - showScrollbar?: boolean; - } - /** A widget displaying several blocks of data as tiles. */ - export class dxTileView extends CollectionWidget { - constructor(element: JQuery, options?: dxTileViewOptions); - constructor(element: Element, options?: dxTileViewOptions); - /** Returns the current scroll position of the widget content. */ - scrollPosition(): number; - } - export interface dxSwitchOptions extends EditorOptions { - activeStateEnabled?: boolean; - /** Text displayed when the widget is in a disabled state. */ - offText?: string; - /** Text displayed when the widget is in an enabled state. */ - onText?: string; - /** A Boolean value specifying whether the current switch state is "On" or "Off". */ - value?: boolean; - } - /** A switch widget. */ - export class dxSwitch extends Editor { - constructor(element: JQuery, options?: dxSwitchOptions); - constructor(element: Element, options?: dxSwitchOptions); - } - export interface dxSlideOutViewOptions extends WidgetOptions { - /** Specifies the current menu position. */ - menuPosition?: string; - /** Specifies whether or not the menu panel is visible. */ - menuVisible?: boolean; - /** Specifies whether or not the menu is shown when a user swipes the widget content. */ - swipeEnabled?: boolean; - /** A template to be used for rendering menu panel content. */ - menuTemplate?: any; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - } - /** The widget that allows you to slide-out the current view to reveal a custom menu. */ - export class dxSlideOutView extends Widget { - constructor(element: JQuery, options?: dxSlideOutViewOptions); - constructor(element: Element, options?: dxSlideOutViewOptions); - /** Returns an HTML element of the widget menu block. */ - menuContent(): JQuery; - /** Returns an HTML element of the widget content block. */ - content(): JQuery; - /** Displays the widget's menu block. */ - showMenu(): JQueryPromise; - /** Hides the widget's menu block. */ - hideMenu(): JQueryPromise; - /** Toggles the visibility of the widget's menu block. */ - toggleMenuVisibility(): JQueryPromise; - } - export interface dxSlideOutOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A Boolean value specifying whether or not to display a grouped menu. */ - menuGrouped?: boolean; - /** Specifies the current menu position. */ - menuPosition?: string; - /** The name of the template used to display a group header. */ - menuGroupTemplate?: any; - /** The template used to render menu items. */ - menuItemTemplate?: any; - /** A handler for the menuGroupRendered event. */ - onMenuGroupRendered?: Function; - /** A handler for the menuItemRendered event. */ - onMenuItemRendered?: Function; - /** Specifies whether or not the slide-out menu is displayed. */ - menuVisible?: boolean; - /** Indicates whether the menu can be shown/hidden by swiping the widget's main panel. */ - swipeEnabled?: boolean; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - } - /** The widget that allows you to slide-out the current view to reveal an item list. */ - export class dxSlideOut extends CollectionWidget { - constructor(element: JQuery, options?: dxSlideOutOptions); - constructor(element: Element, options?: dxSlideOutOptions); - /** Hides the widget's slide-out menu. */ - hideMenu(): JQueryPromise; - /** Displays the widget's slide-out menu. */ - showMenu(): JQueryPromise; - /** Toggles the visibility of the widget's slide-out menu. */ - toggleMenuVisibility(showing: boolean): JQueryPromise; - } - export interface dxPivotOptions extends CollectionWidgetOptions { - /** The index of the currently active pivot item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to allow users to switch between items by swiping. */ - swipeEnabled?: boolean; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - /** The template to be used for rendering an item title. */ - itemTitleTemplate?: any; - } - /** A widget that is similar to a traditional tab control, but optimized for the phone with simplified end-user interaction. */ - export class dxPivot extends CollectionWidget { - constructor(element: JQuery, options?: dxPivotOptions); - constructor(element: Element, options?: dxPivotOptions); - } - export interface dxPanoramaOptions extends CollectionWidgetOptions { - /** An object exposing options for setting a background image for the panorama. */ - backgroundImage?: { - /** Specifies the height of the panorama's background image. */ - height?: number; - /** Specifies the URL of the image that is used as the panorama's background image. */ - url?: string; - /** Specifies the width of the panorama's background image. */ - width?: number; - }; - /** The index of the currently active panorama item. */ - selectedIndex?: number; - /** Specifies the widget content title. */ - title?: string; - } - /** A widget displaying the required content in a long horizontal canvas that extends beyond the frames of the screen. */ - export class dxPanorama extends CollectionWidget { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - } - export interface dxDropDownMenuOptions extends WidgetOptions { - /** A handler for the buttonClick event. */ - onButtonClick?: any; - /** The name of the icon to be displayed by the DropDownMenu button. */ - buttonIcon?: string; - /** The text displayed in the DropDownMenu button. */ - buttonText?: string; - buttonIconSrc?: string; - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** A handler for the itemClick event. */ - onItemClick?: any; - /** An array of items displayed by the widget. */ - items?: Array; - /** The template to be used for rendering items. */ - itemTemplate?: any; - /** Specifies whether or not to show the drop down menu within a dxPopover widget. */ - usePopover?: boolean; - /** The width of the menu popup in pixels. */ - popupWidth?: any; - /** The height of the menu popup in pixels. */ - popupHeight?: any; - /** Specifies whether or not the drop-down menu is displayed. */ - opened?: boolean; - hoverStateEnabled?: boolean; - activeStateEnabled?: boolean; - } - /** A drop-down menu widget. */ - export class dxDropDownMenu extends Widget { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - /** Opens the drop-down menu. */ - open(): void; - /** Closes the drop-down menu. */ - close(): void; - } - export interface dxActionSheetOptions extends CollectionWidgetOptions { - /** A handler for the cancelClick event. */ - onCancelClick?: any; - /** The text displayed in the button that closes the action sheet. */ - cancelText?: string; - /** Specifies whether or not to display the Cancel button in action sheet. */ - showCancelButton?: boolean; - /** A Boolean value specifying whether or not the title of the action sheet is visible. */ - showTitle?: boolean; - /** Specifies the element the action sheet popover points at. */ - target?: any; - /** The title of the action sheet. */ - title?: string; - /** Specifies whether or not to show the action sheet within a dxPopover widget. */ - usePopover?: boolean; - /** A Boolean value specifying whether or not the dxActionSheet widget is visible. */ - visible?: boolean; - } - /** A widget consisting of a set of choices related to a certain task. */ - export class dxActionSheet extends CollectionWidget { - constructor(element: JQuery, options?: dxActionSheetOptions); - constructor(element: Element, options?: dxActionSheetOptions); - /** Hides the widget. */ - hide(): JQueryPromise; - /** Shows the widget. */ - show(): JQueryPromise; - /** Shows or hides the widget depending on the Boolean value passed as the parameter. */ - toggle(showing: boolean): JQueryPromise; - } -} -interface JQuery { - dxTileView(): JQuery; - dxTileView(options: "instance"): DevExpress.ui.dxTileView; - dxTileView(options: string): any; - dxTileView(options: string, ...params: any[]): any; - dxTileView(options: DevExpress.ui.dxTileViewOptions): JQuery; - dxSwitch(): JQuery; - dxSwitch(options: "instance"): DevExpress.ui.dxSwitch; - dxSwitch(options: string): any; - dxSwitch(options: string, ...params: any[]): any; - dxSwitch(options: DevExpress.ui.dxSwitchOptions): JQuery; - dxSlideOut(): JQuery; - dxSlideOut(options: "instance"): DevExpress.ui.dxSlideOut; - dxSlideOut(options: string): any; - dxSlideOut(options: string, ...params: any[]): any; - dxSlideOut(options: DevExpress.ui.dxSlideOutOptions): JQuery; - dxPivot(): JQuery; - dxPivot(options: "instance"): DevExpress.ui.dxPivot; - dxPivot(options: string): any; - dxPivot(options: string, ...params: any[]): any; - dxPivot(options: DevExpress.ui.dxPivotOptions): JQuery; - dxPanorama(): JQuery; - dxPanorama(options: "instance"): DevExpress.ui.dxPanorama; - dxPanorama(options: string): any; - dxPanorama(options: string, ...params: any[]): any; - dxPanorama(options: DevExpress.ui.dxPanoramaOptions): JQuery; - dxActionSheet(): JQuery; - dxActionSheet(options: "instance"): DevExpress.ui.dxActionSheet; - dxActionSheet(options: string): any; - dxActionSheet(options: string, ...params: any[]): any; - dxActionSheet(options: DevExpress.ui.dxActionSheetOptions): JQuery; - dxDropDownMenu(): JQuery; - dxDropDownMenu(options: "instance"): DevExpress.ui.dxDropDownMenu; - dxDropDownMenu(options: string): any; - dxDropDownMenu(options: string, ...params: any[]): any; - dxDropDownMenu(options: DevExpress.ui.dxDropDownMenuOptions): JQuery; -} -declare module DevExpress.data { - export interface XmlaStoreOptions { - /** The HTTP address to an XMLA OLAP server. */ - url?: string; - /** The name of the database associated with the Store. */ - catalog?: string; - /** The cube name. */ - cube?: string; - /** A function used to customize a web request before it is sent. */ - beforeSend?: (request: Object) => void; - } - /** A Store that provides access to an OLAP cube using the XMLA standard. */ - export class XmlaStore { - constructor(options: XmlaStoreOptions); - } - export interface PivotGridField { - index?: number; - /** A boolean value specifying whether or not the field is visible in the pivot grid and the Field Chooser. */ - visible?: boolean; - /** Name of the data source field containing data for the pivot grid field. */ - dataField?: string; - /** A caption that will be displayed in the pivot grid's field chooser and field panel to identify the field. */ - caption?: string; - /** Specifies a type of field values. */ - dataType?: string; - /** Specifies how the values of the current field are combined into groups. Cannot be used for the XmlaStore store type. */ - groupInterval?: any; - /** Specifies how to aggregate field data. Cannot be used for the XmlaStore store type. */ - summaryType?: string; - /** Allows you to use a custom aggregate function to calculate the summary values. Cannot be used for the XmlaStore store type. */ - calculateCustomSummary?: (options: { - summaryProcess?: string; - value?: any; - totalValue?: any; - }) => void; - /** Specifies the function that determines how to split data from the data source into ranges for header items. Cannot be used for the XmlaStore store type. */ - selector?: (data: Object) => any; - /** Type of the area where the field is located. */ - area?: string; - /** Index among the other fields displayed within the same area. */ - areaIndex?: number; - /** The name of the folder in which the field is located. */ - displayFolder?: string; - /** The name of the group to which the field belongs. */ - groupName?: string; - /** The index of the field within a group. */ - groupIndex?: number; - /** Specifies the sort order of field values. */ - sortOrder?: string; - /** Specifies how field data should be sorted. Can be used for the XmlaStore store type only. */ - sortBy?: string; - /** Sorts the header items of this field by the summary values of another field. */ - sortBySummaryField?: string; - /** The array of field names that specify a path to column/row whose summary field is used for sorting of this field's header items. */ - sortBySummaryPath?: Array; - /** The filter values for the current field. */ - filterValues?: Array; - /** The filter type for the current field. */ - filterType?: string; - /** Indicates whether all header items of the field's header level are expanded. */ - expanded?: boolean; - /** Specifies whether the field should be treated as a Data Field. */ - isMeasure?: boolean; - /** Specifies whether or not long text in header items should be wrapped. */ - wordWrapEnabled?: boolean; - /** Specifies a display format for field values. */ - format?: any; - /** Specifies a callback function that returns the text to be displayed in the cells of a field. */ - customizeText?: (cellInfo: { value: any; valueText: string }) => string; - /** - * Specifies a precision for formatted field values. - * @deprecated Use the format | precision option instead. - */ - precision?: number; - /** Specifies how to sort the header items. */ - sortingMethod?: (a: Object, b: Object) => number; - /** Allows an end-user to change sorting options. */ - allowSorting?: boolean; - /** Allows an end-user to sort columns by summary values. */ - allowSortingBySummary?: boolean; - /** Allows an end-user to change filtering options. */ - allowFiltering?: boolean; - /** Allows an end-user to expand/collapse all header items within a header level. */ - allowExpandAll?: boolean; - /** Specifies the absolute width of the field in the pivot grid. */ - width?: number; - /** Specifies the summary post-processing algorithm. */ - summaryDisplayMode?: string; - /** Specifies whether to summarize each next summary value with the previous one by rows or columns. */ - runningTotal?: string; - /** Specifies whether to allow the predefined summary post-processing functions ('absoluteVariation' and 'percentVariation') and runningTotal to take values of different groups into account. */ - allowCrossGroupCalculation?: boolean; - /** Specifies a callback function that allows you to modify summary values after they are calculated. */ - calculateSummaryValue?: (e: Object) => number; - /** Specifies whether or not to display Total values for the field. */ - showTotals?: boolean; - /** Specifies whether or not to display Grand Total values for the field. */ - showGrandTotals?: boolean; - } - export class SummaryCell { - /** Gets the parent cell in a specified direction. */ - parent(direction: string): SummaryCell; - /** Gets all children cells in a specified direction. */ - children(direction: string): Array; - /** Gets a partial Grand Total cell of a row or column. */ - grandTotal(direction: string): SummaryCell; - /** Gets the Grand Total of the entire pivot grid. */ - grandTotal(): SummaryCell; - /** Gets the cell next to the current one in a specified direction. */ - next(direction: string): SummaryCell; - /** Gets the cell next to current in a specified direction. */ - next(direction: string, allowCrossGroup: boolean): SummaryCell; - /** Gets the cell prior to the current one in a specified direction. */ - prev(direction: string): SummaryCell; - /** Gets the cell previous to current in a specified direction. */ - prev(direction: string, allowCrossGroup: boolean): SummaryCell; - /** Gets the child cell in a specified direction. */ - child(direction: string, fieldValue: any): SummaryCell; - /** Gets the cell located by the path of the source cell with one field value changed. */ - slice(field: PivotGridField, value: any): SummaryCell; - /** Gets the row or column field to which the current cell belongs. */ - field(area: string): PivotGridField; - /** Gets the value of the current cell. */ - value(): any; - /** Gets the value of the current cell. */ - value(isCalculatedValue: boolean): any; - /** Gets the value of any field linked with the current cell. */ - value(field: PivotGridField): any; - /** Gets the value of any field linked with the current cell. */ - value(field: PivotGridField, isCalculatedValue: boolean): any; - } - export interface PivotGridDataSourceOptions { - /** Specifies the underlying Store instance used to access data. */ - store?: any; - /** Indicates whether or not the automatic field generation from data in the Store is enabled. */ - retrieveFields?: boolean; - /** Specifies data filtering conditions. Cannot be used for the XmlaStore store type. */ - filter?: Object; - /** An array of pivot grid fields. */ - fields?: Array; - /** A handler for the changed event. */ - onChanged?: () => void; - /** A handler for the loadingChanged event. */ - onLoadingChanged?: (isLoading: boolean) => void; - /** A handler for the loadError event. */ - onLoadError?: (e?: Object) => void; - /** A handler for the fieldsPrepared event. */ - onFieldsPrepared?: (e?: Array) => void; - } - /** An object that provides access to data for the dxPivotGrid widget. */ - export class PivotGridDataSource implements EventsMixin { - constructor(options?: PivotGridDataSource); - /** Starts reloading data from any store and updating the data source. */ - reload(): JQueryPromise; - /** Starts updating the data source. Reloads data from the XMLA store only. */ - load(): JQueryPromise; - /** Indicates whether or not the PivotGridDataSource is currently being loaded. */ - isLoading(): boolean; - /** Gets data displayed in a PivotGrid. */ - getData(): Object; - /** Gets all fields within a specified area. */ - getAreaFields(area: string, collectGroups: boolean): Array; - /** Gets all fields from the data source. */ - fields(): Array; - /** Sets the fields option. */ - fields(fields: Array): void; - /** Gets current options of a specified field. */ - field(id: any): PivotGridField; - /** Sets one or more options of a specified field. */ - field(id: any, field: PivotGridField): void; - /** Collapses a specified header item. */ - collapseHeaderItem(area: string, path: Array): void; - /** Expands a specified header item. */ - expandHeaderItem(area: string, path: Array): void; - /** Expands all header items of a field. */ - expandAll(id: any): void; - /** Collapses all header items of a field. */ - collapseAll(id: any): void; - /** Disposes of all resources associated with this PivotGridDataSource. */ - dispose(): void; - /** Gets the current filter expression. Cannot be used for the XmlaStore store type. */ - filter(): Object; - /** Applies a new filter expression. Cannot be used for the XmlaStore store type. */ - filter(filterExpr: Object): void; - /** Provides access to a list of records (facts) that were used to calculate a specific summary. */ - createDrillDownDataSource(options: { - columnPath?: Array; - rowPath?: Array; - dataIndex?: number; - maxRowCount?: number; - customColumns?: Array; - }): DevExpress.data.DataSource; - /** Gets the current PivotGridDataSource state (fields configuration, sorting, filters, expanded headers, etc.) */ - state(): Object; - /** Sets the PivotGridDataSource state. */ - state(state: Object): void; - on(eventName: string, eventHandler: Function): PivotGridDataSource; - on(events: { [eventName: string]: Function; }): PivotGridDataSource; - off(eventName: string): PivotGridDataSource; - off(eventName: string, eventHandler: Function): PivotGridDataSource; - } -} -declare module DevExpress.ui { - export interface dxSchedulerOptions extends WidgetOptions { - /** Specifies a date displayed on the current scheduler view by default. */ - currentDate?: any; - /** The earliest date the widget allows you to select. */ - min?: Date; - /** The latest date the widget allows you to select. */ - max?: Date; - /** Specifies the view used in the scheduler by default. */ - currentView?: string; - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** Specifies the first day of a week. */ - firstDayOfWeek?: number; - /** The template to be used for rendering appointments. */ - appointmentTemplate?: any; - /** The template to be used for rendering an appointment tooltip. */ - appointmentTooltipTemplate?: any; - /** Lists the views to be available within the scheduler's View Selector. */ - views?: Array; - /** Specifies the resource kinds by which the scheduler's appointments are grouped in a timetable. */ - groups?: Array; - /** Specifies a start hour in the scheduler view's time interval. */ - startDayHour?: number; - /** Specifies an end hour in the scheduler view's time interval. */ - endDayHour?: number; - /** Specifies whether or not the "All-day" panel is visible. */ - showAllDayPanel?: boolean; - /** Specifies cell duration in minutes. */ - cellDuration?: number; - /** Specifies the edit mode for recurring appointments. */ - recurrenceEditMode?: string; - /** Specifies which editing operations an end-user can perform on appointments. */ - editing?: { - /** Specifies whether or not an end-user can add appointments. */ - allowAdding?: boolean; - /** Specifies whether or not an end-user can change appointment options. */ - allowUpdating?: boolean; - /** Specifies whether or not an end-user can delete appointments. */ - allowDeleting?: boolean; - /** Specifies whether or not an end-user can change an appointment duration. */ - allowResizing?: boolean; - /** Specifies whether or not an end-user can drag appointments. */ - allowDragging?: boolean; - } - /** Specifies an array of resources available in the scheduler. */ - resources?: Array<{ - /** Indicates whether or not several resources of this kind can be assigned to an appointment. */ - allowMultiple?: boolean; - /** - * Indicates whether or not resources of this kind have priority in the color identification of the appointments that have resources of different kinds assigned. - * @deprecated Use the useColorAsDefault option instead. - */ - mainColor?: boolean; - /** Indicates whether or not resources of this kind have priority in the color identification of the appointments that have resources of different kinds assigned. */ - useColorAsDefault?: boolean; - /** A data source used to fetch resources to be available in the scheduler. */ - dataSource?: any; - /** Specifies the resource object field whose value is displayed by the Resource editor in the Appointment popup window. */ - displayExpr?: any; - /** Specifies the resource object field that is used as a value of the Resource editor in the Appointment popup window. */ - valueExpr?: any; - /** - * The name of the appointment object field that specifies a resource of this kind. - * @deprecated Use the fieldExpr option instead. - */ - field?: string; - /** The name of the appointment object field that specifies a resource of this kind. */ - fieldExpr?: string; - /** Specifies the label of the Appointment popup window field that allows end users to assign a resource of this kind. */ - label?: string; - }>; - /** A handler for the AppointmentAdding event. */ - onAppointmentAdding?: Function; - /** A handler for the appointmentAdded event. */ - onAppointmentAdded?: Function; - /** A handler for the AppointmentUpdating event. */ - onAppointmentUpdating?: Function; - /** A handler for the appointmentUpdated event. */ - onAppointmentUpdated?: Function; - /** A handler for the AppointmentDeleting event. */ - onAppointmentDeleting?: Function; - /** A handler for the appointmentDeleted event. */ - onAppointmentDeleted?: Function; - /** A handler for the appointmentRendered event. */ - onAppointmentRendered?: Function; - /** A handler for the appointmentClick event. */ - onAppointmentClick?: any; - /** A handler for the appointmentDblClick event. */ - onAppointmentDblClick?: any; - /** A handler for the cellClick event. */ - onCellClick?: any; - /** A handler for the appointmentFormCreated event. */ - onAppointmentFormCreated?: Function; - /** A handler for the contentReady event. */ - onContentReady?: Function; - horizontalScrollingEnabled?: boolean; - /** Specifies whether or not an end-user can scroll the view in both directions at the same time. */ - crossScrollingEnabled?: boolean; - /** Specifies whether a user can switch views using tabs or a drop-down menu. */ - useDropDownViewSwitcher?: boolean; - /** Specifies the name of the data source item field that defines the start of an appointment. */ - startDateExpr?: string; - /** Specifies the name of the data source item field that defines the ending of an appointment. */ - endDateExpr?: string; - /** Specifies the name of the data source item field that holds the subject of an appointment. */ - textExpr?: string; - /** Specifies the name of the data source item field whose value holds the description of the corresponding appointment. */ - descriptionExpr?: string; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding appointment is an all-day appointment. */ - allDayExpr?: string; - /** Specifies the name of the data source item field that defines a recurrence rule for generating recurring appointments. */ - recurrenceRuleExpr?: string; - /** Specifies the name of the data source item field that defines exceptions for the current recurring appointment. */ - recurrenceExceptionExpr?: string; - /** Specifies the name of the data source item field that defines the timezone of the appointment start date. */ - startDateTimeZoneExpr?: string; - /** Specifies the name of the data source item field that defines the timezone of the appointment end date. */ - endDateTimeZoneExpr?: string; - /** Specifies whether filtering is performed on the server or client side. */ - remoteFiltering?: boolean; - /** Specifies the timezone of the widget. */ - timeZone?: string; - /** The text or HTML markup displayed by the widget if the item collection is empty. Available for the Agenda view only. */ - noDataText?: string; - } - /** A widget that displays scheduled data using different views and provides the capability to load, add and edit appointments. */ - export class dxScheduler extends Widget { - constructor(element: JQuery, options?: dxSchedulerOptions); - constructor(element: Element, options?: dxSchedulerOptions); - /** Add the appointment defined by the object passed as a parameter to the data associated with the widget. */ - addAppointment(appointment: Object): void; - /** Updates the appointment specified by the first method parameter by the appointment object specified by the second method parameter in the the data associated with the widget. */ - updateAppointment(target: Object, appointment: Object): void; - /** Deletes the appointment defined by the parameter from the the data associated with the widget. */ - deleteAppointment(appointment: Object): void; - /** Scrolls the scheduler work space to the specified time of the specified day. */ - scrollToTime(hours: number, minutes: number, date: Date): void; - /** Displayes the Appointment Details popup. */ - showAppointmentPopup(appointmentData: Object, createNewAppointment?: boolean, currentAppointmentData?: Object): void; - /** Returns the start date of the current view. */ - getStartViewDate(): Date; - /** Returns the end date of the current view. */ - getEndViewDate(): Date; - } - export interface dxColorBoxOptions extends dxDropDownEditorOptions { - /** Specifies the text displayed on the button that applies changes and closes the drop-down editor. */ - applyButtonText?: string; - applyValueMode?: string; - /** Specifies the text displayed on the button that cancels changes and closes the drop-down editor. */ - cancelButtonText?: string; - /** Specifies whether or not the widget value includes the alpha channel component. */ - editAlphaChannel?: boolean; - /** Specifies the size of a step by which a handle is moved using a keyboard shortcut. */ - keyStep?: number; - } - /** A widget used to specify a color value. */ - export class dxColorBox extends dxDropDownEditor { - constructor(element: JQuery, options?: dxColorBoxOptions); - constructor(element: Element, options?: dxColorBoxOptions); - } - export interface HierarchicalCollectionWidgetOptions extends CollectionWidgetOptions { - /** Specifies the name of the data source item field whose value is displayed by the widget. */ - displayExpr?: any; - /** Specifies the name of the data source item field used as a key. */ - keyExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding widget items is selected. */ - selectedExpr?: any; - /** Specifies the name of the data source item field that contains an array of nested items. */ - itemsExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding widget item is disabled. */ - disabledExpr?: any; - hoverStateEnabled?: boolean; - focusStateEnabled?: boolean; - } - export class HierarchicalCollectionWidget extends CollectionWidget { - } - export interface dxTreeViewOptions extends HierarchicalCollectionWidgetOptions { - /** Specifies whether or not to animate item collapsing and expanding. */ - animationEnabled?: boolean; - /** Specifies whether a nested or plain array is used as a data source. */ - dataStructure?: string; - /** Specifies whether or not a user can expand all tree view items by the "*" hot key. */ - expandAllEnabled?: boolean; - /** - * Specifies whether or not a check box is displayed at each tree view item. - * @deprecated Use the showCheckBoxesMode options instead. - */ - showCheckBoxes?: boolean; - /** Specifies the current check boxes display mode. */ - showCheckBoxesMode?: string; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding widget item is displayed expanded. */ - expandedExpr?: any; - /** Specifies whether or not to select nodes recursively. */ - selectNodesRecursive?: boolean; - /** Specifies whether or not all parent nodes of an initially expanded node are displayed expanded. */ - expandNodesRecursive?: boolean; - /** - * Specifies whether the "Select All" check box is displayed over the tree view. - * @deprecated Use the showCheckBoxesMode options instead. - */ - selectAllEnabled?: boolean; - /** Specifies whether or not an item becomes selected if a user clicks it. */ - selectByClick?: boolean; - /** Specifies the text displayed at the "Select All" check box. */ - selectAllText?: string; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding node includes child nodes. */ - hasItemsExpr?: any; - /** Specifies the name of the data source item field for holding the parent key of the corresponding node. */ - parentIdExpr?: any; - /** Specifies if the virtual mode is enabled. */ - virtualModeEnabled?: boolean; - /** Specifies the parent ID value of the root item. */ - rootValue?: Object; - /** Specifies the current value used to filter tree view items. */ - searchValue?: string; - /** A string value specifying available scrolling directions. */ - scrollDirection?: string; - /** A handler for the itemSelectionChanged event. */ - onItemSelectionChanged?: Function; - /** A handler for the itemExpanded event. */ - onItemExpanded?: Function; - /** A handler for the itemCollapsed event. */ - onItemCollapsed?: Function; - onItemClick?: Function; - onItemContextMenu?: Function; - onItemRendered?: Function; - onItemHold?: Function; - } - /** A widget displaying specified data items as a tree. */ - export class dxTreeView extends HierarchicalCollectionWidget { - constructor(element: JQuery, options?: dxTreeViewOptions); - constructor(element: Element, options?: dxTreeViewOptions); - /** Updates the tree view scrollbars according to the current size of the widget content. */ - updateDimensions(): JQueryPromise; - /** Selects the specified item. */ - selectItem(itemElement: any): void; - /** Unselects the specified item. */ - unselectItem(itemElement: any): void; - /** Expands the specified item. */ - expandItem(itemElement: any): void; - /** Collapses the specified item. */ - collapseItem(itemElement: any): void; - /** Returns all nodes of the tree view. */ - getNodes(): Array; - /** Selects all widget items. */ - selectAll(): void; - /** Unselects all widget items. */ - unselectAll(): void; - } - export interface dxMenuBaseOptions extends HierarchicalCollectionWidgetOptions { - /** An object that defines the animation options of the widget. */ - animation?: { - /** An object that defines the animation options used when the widget is being shown. */ - show?: fx.AnimationOptions; - /** An object that defines the animation options used when the widget is being hidden. */ - hide?: fx.AnimationOptions; - }; - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** Specifies the name of the CSS class associated with the menu. */ - cssClass?: string; - /** Holds an array of menu items. */ - items?: Array; - /** - * Specifies whether or not an item becomes selected if an end-user clicks it. - * @deprecated Use the selectByClick option instead. - */ - selectionByClick?: boolean; - /** Specifies whether or not an item becomes selected if a user clicks it. */ - selectByClick?: boolean; - /** Specifies the selection mode supported by the menu. */ - selectionMode?: string; - /** Specifies options of submenu showing and hiding. */ - showSubmenuMode?: { - /** Specifies the mode name. */ - name?: string; - /** Specifies the delay of submenu show and hiding. */ - delay?: { - /** The time span after which the submenu is shown. */ - show?: number; - /** The time span after which the submenu is hidden. */ - hide?: number; - }; - }; - } - export class dxMenuBase extends HierarchicalCollectionWidget { - constructor(element: JQuery, options?: dxMenuBaseOptions); - constructor(element: Element, options?: dxMenuBaseOptions); - /** Selects the specified item. */ - selectItem(itemElement: any): void; - /** Unselects the specified item. */ - unselectItem(itemElement: any): void; - } - export interface dxMenuOptions extends dxMenuBaseOptions { - /** Specifies whether or not the submenu is hidden when the mouse pointer leaves it. */ - hideSubmenuOnMouseLeave?: boolean; - /** Specifies whether the menu has horizontal or vertical orientation. */ - orientation?: string; - /** Specifies options for showing and hiding the first level submenu. */ - showFirstSubmenuMode?: { - /** Specifies the mode name. */ - name?: string; - /** Specifies the delay in submenu showing and hiding. */ - delay?: { - /** The time span after which the submenu is shown. */ - show?: number; - /** The time span after which the submenu is hidden. */ - hide?: number; - }; - }; - /** Specifies the direction at which the submenus are displayed. */ - submenuDirection?: string; - /** A handler for the submenuHidden event. */ - onSubmenuHidden?: Function; - /** Specifies whether or not adaptive widget rendering is enabled on a small screen. */ - adaptivityEnabled?: boolean; - /** A handler for the submenuHiding event. */ - onSubmenuHiding?: Function; - /** A handler for the submenuShowing event. */ - onSubmenuShowing?: Function; - /** A handler for the submenuShown event. */ - onSubmenuShown?: Function; - } - /** A menu widget. */ - export class dxMenu extends dxMenuBase { - constructor(element: JQuery, options?: dxMenuOptions); - constructor(element: Element, options?: dxMenuOptions); - } - export interface dxContextMenuOptions extends dxMenuBaseOptions { - /** Holds an object that specifies options of alternative menu invocation. */ - alternativeInvocationMode?: { - /** Specifies whether or not the standard context menu invocation (on a right mouse click or on a long tap) is disabled. */ - enabled?: Boolean; - /** Specifies the element used to invoke the context menu. */ - invokingElement?: any; - }; - /** A handler for the hidden event. */ - onHidden?: Function; - /** A handler for the hiding event. */ - onHiding?: Function; - /** A handler for the positioning event. */ - onPositioning?: Function; - /** A handler for the showing event. */ - onShowing?: Function; - /** A handler for the shown event. */ - onShown?: Function; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** Specifies the direction at which submenus are displayed. */ - submenuDirection?: string; - /** The target element associated with a popover. */ - target?: any; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - } - /** A context menu widget. */ - export class dxContextMenu extends dxMenuBase { - constructor(element: JQuery, options?: dxContextMenuOptions); - constructor(element: Element, options?: dxContextMenuOptions); - /** Toggles the visibility of the widget. */ - toggle(showing: boolean): JQueryPromise; - /** Shows the widget. */ - show(): JQueryPromise; - /** Hides the widget. */ - hide(): JQueryPromise; - } - export interface dxRemoteOperations { - /** Specifies whether or not filtering must be performed on the server side. */ - filtering?: boolean; - /** Specifies whether or not paging must be performed on the server side. */ - paging?: boolean; - /** Specifies whether or not sorting must be performed on the server side. */ - sorting?: boolean; - /** Specifies whether or not grouping must be performed on the server side. */ - grouping?: boolean; - /** Specifies whether or not summaries calculation must be performed on the server side. */ - summary?: boolean; - } - export interface dxDataGridRow { - data: Object; - key: any; - rowIndex: number; - rowType: string; - groupIndex: number; - isExpanded: boolean; - isSelected: boolean; - values: Array; - } - export interface dxDataGridColumn { - /** Specifies the content alignment within column cells. */ - alignment?: string; - /** Specifies whether the values in a column can be edited at runtime. Setting this option makes sense only when editing is enabled for a grid. */ - allowEditing?: boolean; - /** Specifies whether or not a column can be used for filtering grid records. Setting this option makes sense only when the filter row and column header filtering are visible. */ - allowFiltering?: boolean; - /** Specifies whether or not to allow filtering by this column using its header. */ - allowHeaderFiltering?: boolean; - /** Specifies whether or not the column can be anchored to a grid edge by end users. Setting this option makes sense only when the columnFixing | enabled option is set to true. */ - allowFixing?: boolean; - /** Specifies if a column can be used for searching grid records. Setting this option makes sense only when the search panel is visible. */ - allowSearch?: boolean; - /** Specifies whether the user can group data by values of this column. Applies only when grouping is enabled. */ - allowGrouping?: boolean; - /** Specifies whether or not a column can be hidden by a user. Setting this option makes sense only when the column chooser is visible. */ - allowHiding?: boolean; - /** Specifies whether or not a particular column can be used in column reordering. Setting this option makes sense only when the allowColumnReordering option is set to true. */ - allowReordering?: boolean; - /** Specifies whether or not a particular column can be resized by a user. Setting this option makes sense only when the allowColumnResizing option is true. */ - allowResizing?: boolean; - /** Specifies whether grid records can be sorted by a specific column at runtime. Setting this option makes sense only when the sorting mode differs from none. */ - allowSorting?: boolean; - /** Specifies whether groups appear expanded or not when records are grouped by a specific column. Setting this option makes sense only when grouping is allowed for this column. */ - autoExpandGroup?: boolean; - /** Specifies a callback function that returns a value to be displayed in a column cell. */ - calculateCellValue?: (rowData: Object) => string; - /** Specifies a callback function to be invoked after the cell value is edited by an end-user and before the new value is saved to the data source. */ - setCellValue?: (rowData: Object, value: any) => void; - /** Specifies a callback function that defines filters for customary calculated grid cells. */ - calculateFilterExpression?: (filterValue: any, selectedFilterOperation: string, target: string) => Array; - /** Specifies a caption for a column. */ - caption?: string; - /** Specifies a custom template for grid column cells. */ - cellTemplate?: any; - /** Specifies a CSS class to be applied to a column. */ - cssClass?: string; - /** Specifies how to get a value to be displayed in a cell when it is not in an editing state. */ - calculateDisplayValue?: any; - /** Specifies a field name or a function that returns a field name or a value to be used for grouping column cells. */ - calculateGroupValue?: any; - /** Specifies a field name or a function that returns a field name or a value to be used for sorting column cells. */ - calculateSortValue?: any; - /** Specifies a callback function that returns the text to be displayed in the cells of a column. */ - customizeText?: (cellInfo: { value: any; valueText: string; target: string; groupInterval: any }) => string; - /** Specifies the field of a data source that provides data for a column. */ - dataField?: string; - /** Specifies the required type of column values. */ - dataType?: string; - /** Specifies a custom template for the cell of a grid column when it is in an editing state. */ - editCellTemplate?: any; - /** Specifies configuration options for the editor widget of the current column. */ - editorOptions?: Object; - /** Specifies whether HTML tags are displayed as plain text or applied to the values of the column. */ - encodeHtml?: boolean; - /** In a boolean column, replaces all false items with a specified text. */ - falseText?: string; - /** Specifies the set of available filter operations. */ - filterOperations?: Array; - /** Specifies a filter value for a column. */ - filterValue?: any; - /** Specifies initial filter values for the column's header filter. */ - filterValues?: Array; - /** Specifies whether to include or exclude the records with the values selected in the column's header filter. */ - filterType?: string; - /** Indicates whether the column takes part in horizontal grid scrolling or is anchored to a grid edge. */ - fixed?: boolean; - /** Specifies the order according to which grid columns must be concealed when the widget adapts to the screen or container size. */ - hidingPriority?: number; - /** Specifies the grid edge to which the column is anchored. */ - fixedPosition?: string; - /** Specifies a format for the values displayed in a column. */ - format?: any; - /** Specifies a custom template for the group cell of a grid column. */ - groupCellTemplate?: any; - /** Specifies the index of a column when grid records are grouped by the values of this column. */ - groupIndex?: number; - /** Specifies a custom template for the header of a grid column. */ - headerCellTemplate?: any; - /** Specifies options of a lookup column. */ - lookup?: { - /** Specifies whether or not a user can nullify values of a lookup column. */ - allowClearing?: boolean; - /** Specifies the data source providing data for a lookup column. */ - dataSource?: any; - /** Specifies the expression defining the data source field whose values must be displayed. */ - displayExpr?: any; - /** Specifies the expression defining the data source field whose values must be replaced. */ - valueExpr?: string; - }; - /** Specifies column-level options for filtering using a column header filter. */ - headerFilter?: { - /** Specifies the data source to be used for the header filter. */ - dataSource?: any; - /** Specifies how header filter values should be combined into groups. */ - groupInterval?: any; - }; - /** - * Specifies a precision for formatted values displayed in a column. - * @deprecated Use the format | precision option instead. - */ - precision?: number; - /** Specifies the default filter operation of a column. */ - selectedFilterOperation?: string; - /** Specifies whether or not the column displays its values by using editors. */ - showEditorAlways?: boolean; - /** Specifies whether or not to display the column when grid records are grouped by it. */ - showWhenGrouped?: boolean; - /** Specifies the index of a column when grid records are sorted by the values of this column. */ - sortIndex?: number; - /** Specifies the initial sort order of column values. */ - sortOrder?: string; - /** In a boolean column, replaces all true items with a specified text. */ - trueText?: string; - /** Specifies whether a column is visible or not. */ - visible?: boolean; - /** Specifies the sequence number of the column in the grid. */ - visibleIndex?: number; - /** Specifies a column width in pixels or percentages. */ - width?: any; - /** Specifies an array of validation rules to be checked when updating column cell values. */ - validationRules?: Array; - /** Specifies whether or not to display the header of a hidden column in the column chooser. */ - showInColumnChooser?: boolean; - /** Specifies the identifier of the column. */ - name?: string; - /** The form item configuration object. Used only when the editing mode is "form". */ - formItem?: DevExpress.ui.dxFormItem; - /** An array of grid columns. */ - columns?: Array; - /** Specifies the band column that owns the current column. Accepts the index of the band column in the columns array. */ - ownerBand?: number; - /** Specifies whether the column bands other columns or not. */ - isBand?: boolean; - } - export interface dxDataGridOptions extends WidgetOptions { - /** Specifies whether the outer borders of the grid are visible or not. */ - showBorders?: boolean; - /** Indicates whether to show the error row for the grid. */ - errorRowEnabled?: boolean; - /** A handler for the rowValidating event. */ - onRowValidating?: (e: Object) => void; - /** A handler for the contextMenuPreparing event. */ - onContextMenuPreparing?: (e: Object) => void; - /** A handler for the initNewRow event. */ - onInitNewRow?: (e: { data: Object }) => void; - /** A handler for the rowInserted event. */ - onRowInserted?: (e: { data: Object; key: any }) => void; - /** A handler for the rowInserting event. */ - onRowInserting?: (e: { data: Object; cancel: any }) => void; - /** A handler for the rowRemoved event. */ - onRowRemoved?: (e: { data: Object; key: any }) => void; - /** A handler for the rowRemoving event. */ - onRowRemoving?: (e: { data: Object; key: any; cancel: any }) => void; - /** A handler for the rowUpdated event. */ - onRowUpdated?: (e: { data: Object; key: any }) => void; - /** A handler for the rowUpdating event. */ - onRowUpdating?: (e: { oldData: Object; newData: Object; key: any; cancel: any }) => void; - /** Enables a hint that appears when a user hovers the mouse pointer over a cell with truncated content. */ - cellHintEnabled?: boolean; - /** Specifies whether or not the widget should hide columns in order to adapt to the screen or container size. */ - columnHidingEnabled?: boolean; - /** Specifies whether or not grid columns can be reordered by a user. */ - allowColumnReordering?: boolean; - /** Specifies whether or not grid columns can be resized by a user. */ - allowColumnResizing?: boolean; - /** A handler for the cellClick event. */ - onCellClick?: any; - /** A handler for the cellHoverChanged event. */ - onCellHoverChanged?: (e: Object) => void; - /** A handler for the cellPrepared event. */ - onCellPrepared?: (e: Object) => void; - /** A handler for the adaptiveDetailRowPreparing event. */ - onAdaptiveDetailRowPreparing?: (e: Object) => void; - /** Specifies whether or not the width of grid columns depends on column content. */ - columnAutoWidth?: boolean; - /** Specifies the options of a column chooser. */ - columnChooser?: { - /** Specifies text displayed by the column chooser panel when it does not contain any columns. */ - emptyPanelText?: string; - /** Specifies whether a user can invoke the column chooser or not. */ - enabled?: boolean; - /** Specifies how the end-user chooses columns. */ - mode?: string; - /** Specifies the height of the column chooser panel. */ - height?: number; - /** Specifies text displayed in the title of the column chooser panel. */ - title?: string; - /** Specifies the width of the column chooser panel. */ - width?: number; - }; - /** Specifies options for column fixing. */ - columnFixing?: { - /** Indicates if column fixing is enabled. */ - enabled?: boolean; - /** Contains options that specify texts for column-fixing related commands in the column header's context menu. */ - texts?: { - /** Specifies text for a context menu item that fixes the column for which the context menu is invoked. */ - fix?: string; - /** Specifies text for a context menu item that unfixes the column for which the context menu is invoked. */ - unfix?: string; - /** Specifies text for a context menu subitem that fixes a column, for which the context menu is invoked, to the left grid edge. */ - leftPosition?: string; - /** Specifies text for a context menu subitem that fixes a column, for which the context menu is invoked, to the right grid edge. */ - rightPosition?: string; - }; - }; - /** Specifies options for filtering using a column header filter. */ - headerFilter?: { - /** Indicates whether or not the column header filter button is visible. */ - visible?: boolean; - /** Specifies the height of the dropdown menu invoked when using a column header filter. */ - height?: number; - /** Specifies the width of the dropdown menu invoked when using a column header filter. */ - width?: number; - /** Contains options that specify texts for the dropdown menu invoked when you use a column header filter. */ - texts?: { - /** Specifies text for the item specifying an empty value in the column header filter's dropdown menu. */ - emptyValue?: string; - /** Specifies text for a button that closes the column header filter's dropdown menu and applies specified filtering. */ - ok?: string; - /** Specifies text for a button that closes the column header filter's dropdown menu without applying performed selection. */ - cancel?: string; - } - }; - /** An array of grid columns. */ - columns?: Array; - onContentReady?: Function; - /** Specifies a function that customizes grid columns after they are created. */ - customizeColumns?: (columns: Array) => void; - /** Customizes grid columns and data before exporting. */ - customizeExportData?: (columns: Array, rows: Array) => void; - /** Specifies a data source for the grid. */ - dataSource?: any; - /** Specifies whether or not to enable data caching. */ - cacheEnabled?: boolean; - /** A handler for the editingStart event. */ - onEditingStart?: (e: { - data: Object; - key: any; - cancel: boolean; - column: dxDataGridColumn - }) => void; - /** A handler for the editorPrepared event. */ - onEditorPrepared?: (e: Object) => void; - /** A handler for the editorPreparing event. */ - onEditorPreparing?: (e: Object) => void; - /** Contains options that specify how grid content can be changed. */ - editing?: { - editMode?: string; - editEnabled?: boolean; - insertEnabled?: boolean; - removeEnabled?: boolean; - /** Specifies how grid values can be edited manually. */ - mode?: string; - /** Specifies whether or not grid records can be edited at runtime. */ - allowUpdating?: boolean; - /** Specifies whether or not new grid records can be added at runtime. */ - allowAdding?: boolean; - /** Specifies whether or not grid records can be deleted at runtime. */ - allowDeleting?: boolean; - /** The form configuration object. Used only when the editing mode is "form". */ - form?: DevExpress.ui.dxFormOptions; - /** Contains options that specify texts for editing-related grid controls. */ - texts?: { - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Save" button. Setting this option makes sense only when the mode option is set to batch. */ - saveAllChanges?: string; - /** Specifies text for a cancel button displayed when a row is in the editing state. Setting this option makes sense only when the allowUpdating option is set to true. */ - cancelRowChanges?: string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Revert" button. Setting this option makes sense only when the mode option is set to batch. */ - cancelAllChanges?: string; - /** Specifies a message to be displayed by a confirmation window. Setting this option makes sense only when the edit mode is "row". */ - confirmDeleteMessage?: string; - /** Specifies text to be displayed in the title of a confirmation window. Setting this option makes sense only when the edit mode is "row". */ - confirmDeleteTitle?: string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Cancel changes" button. Setting this option makes sense only when the mode option is set to cell and the validation capabilities are enabled. */ - validationCancelChanges?: string; - /** Specifies text for a button that deletes a row from a grid. Setting this option makes sense only when the allowDeleting option is set to true. */ - deleteRow?: string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Add" button. Setting this option makes sense only when the allowAdding option is true. */ - addRow?: string; - /** Specifies text for a button that turns a row into the editing state. Setting this option makes sense only when the allowUpdating option is set to true. */ - editRow?: string; - /** Specifies text for a save button displayed when a row is in the editing state. Setting this option makes sense only when the allowUpdating option is set to true. */ - saveRowChanges?: string; - /** Specifies text for a button that recovers a deleted row. Setting this option makes sense only if the grid uses the batch edit mode and the allowDeleting option is set to true. */ - undeleteRow?: string; - }; - }; - /** Specifies filter row options. */ - filterRow?: { - /** Specifies when to apply a filter. */ - applyFilter?: string; - /** Specifies text for the hint that pops up when a user hovers the mouse pointer over the "Apply Filter" button. */ - applyFilterText?: string; - /** Specifies descriptions for filter operations. */ - operationDescriptions?: { - "=": string; - "<>": string; - "<": string; - "<=": string; - ">": string; - ">=": string; - "startswith": string; - "contains": string; - "notcontains": string; - "endswith": string; - }; - /** Specifies text for the reset operation in a filter list. */ - resetOperationText?: string; - /** Specifies text for the operation of clearing the applied filter when a select box is used. */ - showAllText?: string; - /** Specifies text for the range start in the 'between' filter type. */ - betweenStartText?: string; - /** Specifies text for the range end in the 'between' filter type. */ - betweenEndText?: string; - /** Specifies whether or not an icon that allows the user to choose a filter operation is visible. */ - showOperationChooser?: boolean; - /** Specifies whether the filter row is visible or not. */ - visible?: boolean; - }; - /** Specifies grouping settings and the behavior of grouped grid records. */ - grouping?: { - /** Specifies whether the user can collapse grouped records in a grid or not. */ - allowCollapsing?: boolean; - /** Specifies whether groups appear expanded or not. */ - autoExpandAll?: boolean; - /** Enables the user to group data using the context menu. */ - contextMenuEnabled?: boolean; - /** Specifies the event on which a group will be expanded/collapsed. */ - expandMode?: string; - groupContinuedMessage?: string; - groupContinuesMessage?: string; - /** Defines the texts of grouping-related visual elements. */ - texts?: { - /** Specifies the message displayed in a group row when the corresponding group is continued from the previous page. */ - groupContinuedMessage?: string; - /** Specifies the message displayed in a group row when the corresponding group continues on the next page. */ - groupContinuesMessage?: string; - /** Specifies the text of the context menu item that groups data by a specific column. */ - groupByThisColumn?: string; - /** Specifies the text of the context menu item that clears grouping settings of a specific column. */ - ungroup?: string; - /** Specifies the text of the context menu item that clears grouping settings of all columns. */ - ungroupAll?: string; - } - }; - /** Configures the group panel. */ - groupPanel?: { - /** Specifies whether columns can be dragged onto or from the group panel. */ - allowColumnDragging?: boolean; - /** Specifies text displayed by the group panel when it does not contain any columns. */ - emptyPanelText?: string; - /** Specifies whether the group panel is visible or not. */ - visible?: any; - }; - /** Specifies options configuring the load panel. */ - loadPanel?: { - /** Specifies whether to show the load panel or not. */ - enabled?: any; - /** Specifies the height of the load panel in pixels. */ - height?: number; - /** Specifies a URL pointing to an image to be used as a loading indicator. */ - indicatorSrc?: string; - /** Specifies whether or not a loading indicator must be displayed on the load panel. */ - showIndicator?: boolean; - /** Specifies whether or not the pane of the load panel must be displayed. */ - showPane?: boolean; - /** Specifies text displayed by the load panel. */ - text?: string; - /** Specifies the width of the load panel in pixels. */ - width?: number; - }; - /** Specifies text displayed when a grid does not contain any records. */ - noDataText?: string; - /** Specifies the options of a grid pager. */ - pager?: { - /** Specifies the page sizes that can be selected at runtime. */ - allowedPageSizes?: any; - /** Specifies whether to show the page size selector or not. */ - showPageSizeSelector?: boolean; - /** Specifies whether to show the pager or not. */ - visible?: any; - /** Specifies the text accompanying the page navigator. */ - infoText?: string; - /** Specifies whether or not to display the text accompanying the page navigator. This text is specified by the infoText option. */ - showInfo?: boolean; - /** Specifies whether or not to display buttons that switch the grid to the previous or next page. */ - showNavigationButtons?: boolean; - }; - /** Specifies paging options. */ - paging?: { - /** Specifies whether dxDataGrid loads data page by page or all at once. */ - enabled?: boolean; - /** Specifies the grid page that should be displayed by default. */ - pageIndex?: number; - /** Specifies the size of grid pages. */ - pageSize?: number; - }; - /** Specifies whether or not grid rows must be shaded in a different way. */ - rowAlternationEnabled?: boolean; - /** Specifies whether to enable two-way data binding. */ - twoWayBindingEnabled?: boolean; - /** A handler for the rowClick event. */ - onRowClick?: any; - /** A handler for the rowPrepared event. */ - onRowPrepared?: (e: Object) => void; - /** Specifies a custom template for grid rows. */ - rowTemplate?: any; - /** A configuration object specifying scrolling options. */ - scrolling?: { - /** Specifies the scrolling mode. */ - mode?: string; - /** Specifies whether or not a grid must preload pages adjacent to the current page when using virtual scrolling. */ - preloadEnabled?: boolean; - /** Specifies whether or not the widget uses native scrolling. */ - useNative?: any; - /** Specifies the scrollbar display policy. */ - showScrollbar?: string; - /** Specifies whether or not the scrolling by content is enabled. */ - scrollByContent?: boolean; - /** Specifies whether or not the scrollbar thumb scrolling enabled. */ - scrollByThumb?: boolean; - }; - /** Specifies options of the search panel. */ - searchPanel?: { - /** Specifies whether or not search strings in the located grid records should be highlighted. */ - highlightSearchText?: boolean; - /** Specifies text displayed by the search panel when no search string was typed. */ - placeholder?: string; - /** Specifies whether the search panel is visible or not. */ - visible?: boolean; - /** Specifies whether to search all columns or only visible ones. */ - searchVisibleColumnsOnly?: boolean; - /** Specifies the width of the search panel in pixels. */ - width?: number; - /** Sets a search string for the search panel. */ - text?: string; - }; - /** Specifies the operations that must be performed on the server side. */ - remoteOperations?: any; - /** Allows you to sort groups according to the values of group summary items. */ - sortByGroupSummaryInfo?: Array<{ - /** Specifies the group summary item whose values must be used to sort groups. */ - summaryItem?: string; - /** Specifies the identifier of the column that must be used in grouping so that sorting by group summary item values be applied. */ - groupColumn?: string; - /** Specifies the sort order of group summary item values. */ - sortOrder?: string; - }>; - /** Allows you to build a master-detail interface in the grid. */ - masterDetail?: { - /** Enables an end-user to expand/collapse detail sections. */ - enabled?: boolean; - /** Specifies whether detail sections appear expanded or collapsed. */ - autoExpandAll?: boolean; - /** Specifies the template for detail sections. */ - template?: any; - }; - /** Configures client-side export. */ - export?: { - /** Enables the client-side export feature. */ - enabled?: boolean; - /** Specifies a default name for the file to which grid data is exported. */ - fileName?: string; - /** Specifies whether to enable Excel filtering for the exported data in the resulting XLSX file. */ - excelFilterEnabled?: boolean; - /** Specifies whether to enable word wrapping for the exported data in the resulting XLSX file. */ - excelWrapTextEnabled?: boolean; - /** Specifies the URL of the server-side proxy that streams the resulting file to the end user to enable export in IE9 and Safari browsers. */ - proxyUrl?: string; - /** Allows an end user to export selected rows only. */ - allowExportSelectedData?: boolean; - /** Contains options that specify texts for the export-related commands and hints. */ - texts?: { - /** Specifies the hint of the Export button when the allowExportSelectedData option is true. */ - exportTo?: string; - exportToExcel?: string; - excelFormat?: string; - selectedRows?: string; - /** Specifies the text of the command that exports all data. */ - exportAll?: string; - /** Specifies the text of the drop-down menu command that exports selected rows. */ - exportSelectedRows?: string; - } - }; - /** Specifies the keys of the records that must appear selected initially. */ - selectedRowKeys?: Array; - /** Specifies options of runtime selection. */ - selection?: { - /** Specifies the checkbox row display policy in the multiple mode. */ - showCheckBoxesMode?: string; - /** Specifies whether the user can select all grid records at once. */ - allowSelectAll?: boolean; - /** Specifies the selection mode. */ - mode?: string; - }; - /** A handler for the dataErrorOccured event. */ - onDataErrorOccurred?: (e: { error: Error }) => void; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: (e: { - currentSelectedRowKeys: Array; - currentDeselectedRowKeys: Array; - selectedRowKeys: Array; - selectedRowsData: Array; - }) => void; - /** A handler for the exporting event. */ - onExporting?: (e: { - fileName: string; - cancel: boolean; - }) => void; - /** A handler for the fileSaving event. */ - onFileSaving?: (e: { - fileName: string; - format: string; - data: any; - cancel: boolean; - }) => void; - /** A handler for the exported event. */ - onExported?: (e: Object) => void; - /** A handler for the keyDown event. */ - onKeyDown?: (e: Object) => void; - /** A handler for the rowExpanding event. */ - onRowExpanding?: (e: Object) => void; - /** A handler for the rowExpanded event. */ - onRowExpanded?: (e: Object) => void; - /** A handler for the rowCollapsing event. */ - onRowCollapsing?: (e: Object) => void; - /** A handler for the rowCollapsed event. */ - onRowCollapsed?: (e: Object) => void; - /** Specifies whether column headers are visible or not. */ - showColumnHeaders?: boolean; - /** Specifies whether or not vertical lines separating one grid column from another are visible. */ - showColumnLines?: boolean; - /** Specifies whether or not horizontal lines separating one grid row from another are visible. */ - showRowLines?: boolean; - /** Specifies options of runtime sorting. */ - sorting?: { - /** Specifies text for the context menu item that sets an ascending sort order in a column. */ - ascendingText?: string; - /** Specifies text for the context menu item that resets sorting settings for a column. */ - clearText?: string; - /** Specifies text for the context menu item that sets a descending sort order in a column. */ - descendingText?: string; - /** Specifies the runtime sorting mode. */ - mode?: string; - }; - /** Specifies options of state storing. */ - stateStoring?: { - /** Specifies a callback function that performs specific actions on state loading. */ - customLoad?: () => JQueryPromise; - /** Specifies a callback function that performs specific actions on state saving. */ - customSave?: (state: Object) => void; - /** Specifies whether or not a grid saves its state. */ - enabled?: boolean; - /** Specifies the delay between the last change of a grid state and the operation of saving this state in milliseconds. */ - savingTimeout?: number; - /** Specifies a unique key to be used for storing the grid state. */ - storageKey?: string; - /** Specifies the type of storage to be used for state storing. */ - type?: string; - }; - /** Specifies the options of the grid summary. */ - summary?: { - /** Contains options that specify text patterns for summary items. */ - texts?: { - /** Specifies a pattern for the 'sum' summary items when they are displayed in the parent column. */ - sum?: string; - /** Specifies a pattern for the 'sum' summary items displayed in a group row or in any other column rather than the parent one. */ - sumOtherColumn?: string; - /** Specifies a pattern for the 'min' summary items when they are displayed in the parent column. */ - min?: string; - /** Specifies a pattern for the 'min' summary items displayed in a group row or in any other column rather than the parent one. */ - minOtherColumn?: string; - /** Specifies a pattern for the 'max' summary items when they are displayed in the parent column. */ - max?: string; - /** Specifies a pattern for the 'max' summary items displayed in a group row or in any other column rather than the parent one. */ - maxOtherColumn?: string; - /** Specifies a pattern for the 'avg' summary items when they are displayed in the parent column. */ - avg?: string; - /** Specifies a pattern for the 'avg' summary items displayed in a group row or in any other column rather than the parent one. */ - avgOtherColumn?: string; - /** Specifies a pattern for the 'count' summary items. */ - count?: string; - }; - /** Specifies items of the group summary. */ - groupItems?: Array<{ - /** Specifies the identifier of a summary item. */ - name?: string; - /** Specifies the column that provides data for a group summary item. */ - column?: string; - /** Customizes the text to be displayed in the summary item. */ - customizeText?: (itemInfo: { - value: any; - valueText: string; - }) => string; - /** Specifies a pattern for the summary item text. */ - displayFormat?: string; - /** - * Specifies a precision for the summary item value of a numeric format. - * @deprecated Use the valueFormat | precision option instead. - */ - precision?: number; - /** Specifies whether or not a summary item must be displayed in the group footer. */ - showInGroupFooter?: boolean; - /** Indicates whether to display group summary items in parentheses after the group row header or to align them by the corresponding columns within the group row. */ - alignByColumn?: boolean; - /** Specifies the column that must hold the summary item when this item is displayed in the group footer or aligned by a column in the group row. */ - showInColumn?: string; - /** Specifies how to aggregate data for a summary item. */ - summaryType?: string; - /** Specifies a format for the summary item value. */ - valueFormat?: any; - /** Specifies whether or not to skip empty strings, null and undefined values when calculating a summary. */ - skipEmptyValues?: boolean; - }>; - /** Specifies items of the total summary. */ - totalItems?: Array<{ - /** Specifies the identifier of a summary item. */ - name?: string; - /** Specifies the alignment of a summary item. */ - alignment?: string; - /** Specifies the column that provides data for a summary item. */ - column?: string; - /** Specifies a CSS class to be applied to a summary item. */ - cssClass?: string; - /** Customizes the text to be displayed in the summary item. */ - customizeText?: (itemInfo: { - value: any; - valueText: string; - }) => string; - /** Specifies a pattern for the summary item text. */ - displayFormat?: string; - /** - * Specifies a precision for the summary item value of a numeric format. - * @deprecated Use the valueFormat | precision option instead. - */ - precision?: number; - /** Specifies the column that must hold the summary item. */ - showInColumn?: string; - /** Specifies how to aggregate data for a summary item. */ - summaryType?: string; - /** Specifies a format for the summary item value. */ - valueFormat?: any; - /** Specifies whether or not to skip empty strings, null and undefined values when calculating a summary. */ - skipEmptyValues?: boolean; - }>; - /** Specifies whether or not to skip empty strings, null and undefined values when calculating a summary. */ - skipEmptyValues?: boolean; - /** Allows you to use a custom aggregate function to calculate the value of a summary item. */ - calculateCustomSummary?: (options: { - component: dxDataGrid; - name?: string; - value: any; - totalValue: any; - summaryProcess: string - }) => void; - }; - /** Specifies whether text that does not fit into a column should be wrapped. */ - wordWrapEnabled?: boolean; - } - /** A data grid widget. */ - export class dxDataGrid extends Widget { - constructor(element: JQuery, options?: dxDataGridOptions); - constructor(element: Element, options?: dxDataGridOptions); - /** Ungroups grid records. */ - clearGrouping(): void; - /** Clears sorting settings of all grid columns at once. */ - clearSorting(): void; - /** Allows you to obtain a cell by its row index and the data field of its column. */ - getCellElement(rowIndex: number, dataField: string): any; - /** Allows you to obtain a cell by its row index and the visible index of its column. */ - getCellElement(rowIndex: number, visibleColumnIndex: number): any; - /** Returns the current state of the grid. */ - state(): Object; - /** Sets the grid state. */ - state(state: Object): void; - /** Allows you to obtain the row index by a data key. */ - getRowIndexByKey(key: any): number; - /** Allows you to obtain the data key by a row index. */ - getKeyByRowIndex(rowIndex: number): any; - /** Adds a new column to a grid. */ - addColumn(columnOptions: dxDataGridColumn): void; - /** Removes the column from the grid. */ - deleteColumn(id: any): void; - /** Displays the load panel. */ - beginCustomLoading(messageText: string): void; - /** Discards changes made in a grid. */ - cancelEditData(): void; - /** Checks whether or not the grid contains unsaved changes. */ - hasEditData(): boolean; - /** Clears all the filters of a specific type applied to grid records. */ - clearFilter(): void; - /** Deselects all grid records. */ - clearSelection(): void; - /** Draws the cell being edited from the editing state. Use this method when the edit mode is batch. */ - closeEditCell(): void; - /** Collapses groups or master rows in a grid. */ - collapseAll(groupIndex?: number): void; - /** Returns the number of data columns in a grid. */ - columnCount(): number; - /** Returns the value of a specific column option. */ - columnOption(id: any, optionName: string): any; - /** Sets an option of a specific column. */ - columnOption(id: any, optionName: string, optionValue: any): void; - /** Returns the options of a column by an identifier. */ - columnOption(id: any): Object; - /** Sets several options of a column at once. */ - columnOption(id: any, options: Object): void; - /** Sets a specific cell into the editing state. */ - editCell(rowIndex: number, visibleColumnIndex: number): void; - /** Sets a specific cell into the editing state. */ - editCell(rowIndex: number, dataField: string): void; - /** Sets a specific row into the editing state. */ - editRow(rowIndex: number): void; - /** Gets the cell value. */ - cellValue(rowIndex: number, dataField: string): any; - /** Gets the cell value. */ - cellValue(rowIndex: number, visibleColumnIndex: number): any; - /** Sets the cell value. */ - cellValue(rowIndex: number, dataField: string, value: any): void; - /** Sets the cell value. */ - cellValue(rowIndex: number, visibleColumnIndex: number, value: any): void; - /** Hides the load panel. */ - endCustomLoading(): void; - /** Expands groups or master rows in a grid. */ - expandAll(groupIndex: number): void; - /** Allows you to find out whether a specific group or master row is expanded or collapsed. */ - isRowExpanded(key: any): boolean; - /** Allows you to expand a specific group or master row by its key. */ - expandRow(key: any): void; - /** Allows you to collapse a specific group or master row by its key. */ - collapseRow(key: any): void; - /** Checks whether a specific adaptive detail row is expanded or collapsed. */ - isAdaptiveDetailRowExpanded(key: any): void; - /** Expands an adaptive detail row by the key of its parent data row. */ - expandAdaptiveDetailRow(key: any): void; - /** Collapses the currently expanded adaptive detail row (if there is one). */ - collapseAdaptiveDetailRow(): void; - /** Applies a filter to the grid's data source. */ - filter(filterExpr?: any): void; - /** Returns a filter expression applied to the grid's data source using the filter(filterExpr) method. */ - filter(): any; - /** Returns a filter expression applied to the grid using all possible scenarious. */ - getCombinedFilter(): any; - /** Gets the keys of currently selected grid records. */ - getSelectedRowKeys(): Array; - /** Gets the data objects of currently selected grid records. */ - getSelectedRowsData(): Array; - /** Hides the column chooser panel. */ - hideColumnChooser(): void; - /** Adds a new data row to a grid. */ - addRow(): void; - /** - * Adds a new data row to a grid. - * @deprecated Use the addRow() method instead. - */ - insertRow(): void; - /** Returns the key corresponding to the passed data object. */ - keyOf(obj: Object): any; - /** Switches a grid to a specified page. */ - pageIndex(newIndex: number): void; - /** Gets the index of the current page. */ - pageIndex(): number; - /** Sets the page size. */ - pageSize(value: number): void; - /** Gets the current page size. */ - pageSize(): number; - /** Refreshes grid data. */ - refresh(): JQueryPromise; - /** Removes a specific row from a grid. */ - deleteRow(rowIndex: number): void; - /** - * Removes a specific row from a grid. - * @deprecated Use the deleteRow(rowIndex) method instead. - */ - removeRow(rowIndex: number): void; - /** Saves changes made in a grid. */ - saveEditData(): JQueryPromise; - /** Searches grid records by a search string. */ - searchByText(text: string): void; - /** Selects all grid records. */ - selectAll(): void; - /** Deselects the rows that are currently selected within the applied filter. */ - deselectAll(): void; - /** Selects specific grid records. */ - selectRows(keys: Array, preserve: boolean): void; - /** Deselects specific grid records. */ - deselectRows(keys: Array): void; - /** Selects grid rows by indexes. */ - selectRowsByIndexes(indexes: Array): void; - /** Allows you to find out whether a row is selected or not. */ - isRowSelected(key: any): boolean; - /** Invokes the column chooser panel. */ - showColumnChooser(): void; - startSelectionWithCheckboxes(): boolean; - /** Returns how many pages the grid contains. */ - pageCount(): number; - /** Returns the number of records currently held by a grid. */ - totalCount(): number; - /** Recovers a row deleted in the batch edit mode. */ - undeleteRow(rowIndex: number): void; - /** Allows you to obtain a data object by its key. */ - byKey(key: any): JQueryPromise; - /** Gets the value of a total summary item. */ - getTotalSummaryValue(summaryItemName: string): any; - /** Exports grid data to Excel. */ - exportToExcel(selectionOnly: boolean): void; - /** Updates the grid to the size of its content. */ - updateDimensions(): void; - /** Focuses the specified cell element in the grid. */ - focus(element?: JQuery): void; - } - export interface dxPivotGridOptions extends WidgetOptions { - onContentReady?: Function; - /** Specifies a data source for the pivot grid. */ - dataSource?: any; - useNativeScrolling?: any; - /** A configuration object specifying scrolling options. */ - scrolling?: { - /** Specifies the scrolling mode. */ - mode?: string; - /** Specifies whether or not the widget uses native scrolling. */ - useNative?: any; - }; - /** Allows an end-user to change sorting options. */ - allowSorting?: boolean; - /** Allows an end-user to sort columns by summary values. */ - allowSortingBySummary?: boolean; - /** Allows an end-user to change filtering options. */ - allowFiltering?: boolean; - /** Specifies the area to which data field headers must belong. */ - dataFieldArea?: string; - /** Configures the field panel. */ - fieldPanel?: { - /** Makes fields on the field panel draggable. */ - allowFieldDragging?: boolean; - /** Shows/hides filter fields on the field panel. */ - showFilterFields?: boolean; - /** Shows/hides data fields on the field panel. */ - showDataFields?: boolean; - /** Shows/hides column fields on the field panel. */ - showColumnFields?: boolean; - /** Shows/hides row fields on the field panel. */ - showRowFields?: boolean; - /** Shows/hides the field panel. */ - visible?: boolean; - /** Specifies the placeholders of the field areas. */ - texts?: { - /** Specifies the placeholder of the column field area. */ - columnFieldArea?: string; - /** Specifies the placeholder of the row field area. */ - rowFieldArea?: string; - /** Specifies the placeholder of the filter field area. */ - filterFieldArea?: string; - /** Specifies the placeholder of the data field area. */ - dataFieldArea?: string; - } - } - /** Allows an end-user to expand/collapse all header items within a header level. */ - allowExpandAll?: boolean; - /** Specifies whether long text in header items should be wrapped. */ - wordWrapEnabled?: boolean; - /** Specifies whether to display the Total rows. */ - showRowTotals?: boolean; - /** Specifies whether to display the Grand Total row. */ - showRowGrandTotals?: boolean; - /** Specifies whether to display the Total columns. */ - showColumnTotals?: boolean; - /** Specifies whether to display the Grand Total column. */ - showColumnGrandTotals?: boolean; - /** Specifies whether or not to hide rows and columns with no data. */ - hideEmptySummaryCells?: boolean; - /** Specifies where to show the total rows or columns. */ - showTotalsPrior?: string; - /** Specifies the layout of items in the row header. */ - rowHeaderLayout?: string; - /** Specifies whether the outer borders of the grid are visible or not. */ - showBorders?: boolean; - /** The Field Chooser configuration options. */ - fieldChooser?: { - /** Enables or disables the field chooser. */ - enabled?: boolean; - /** Specifies the field chooser layout. */ - layout?: number; - /** Specifies the text to display as a title of the field chooser popup window. */ - title?: string; - /** Specifies the field chooser width. */ - width?: number; - /** Specifies the field chooser height. */ - height?: number; - /** Strings that can be changed or localized in the pivot grid's integrated Field Chooser. */ - texts?: { - /** The string to display instead of Row Fields. */ - rowFields?: string; - /** The string to display instead of Column Fields. */ - columnFields?: string; - /** The string to display instead of Data Fields. */ - dataFields?: string; - /** The string to display instead of Filter Fields. */ - filterFields?: string; - /** The string to display instead of All Fields. */ - allFields?: string; - }; - } - /** Strings that can be changed or localized in the dxPivotGrid widget. */ - texts?: { - /** The string to display as a header of the Grand Total row and column. */ - grandTotal?: string; - /** The string to display as a header of the Total row and column. */ - total?: string; - /** Specifies the text displayed when a pivot grid does not contain any fields. */ - noData?: string; - /** The string to display as a Show Field Chooser context menu item. */ - showFieldChooser?: string; - /** The string to display as an Expand All context menu item. */ - expandAll?: string; - /** The string to display as a Collapse All context menu item. */ - collapseAll?: string; - /** The string to display as a Sort Column by Summary Value context menu item. */ - sortColumnBySummary?: string; - /** The string to display as a Sort Row by Summary Value context menu item. */ - sortRowBySummary?: string; - /** The string to display as a Remove All Sorting context menu item. */ - removeAllSorting?: string; - /** The string to display as an Export to Excel file context menu item. */ - exportToExcel?: string; - }; - /** Specifies options configuring the load panel. */ - loadPanel?: { - /** Enables or disables the load panel. */ - enabled?: boolean; - /** Specifies the height of the load panel. */ - height?: number; - /** Specifies the URL pointing to an image that will be used as a load indicator. */ - indicatorSrc?: string; - /** Specifies whether or not to show a load indicator. */ - showIndicator?: boolean; - /** Specifies whether or not to show load panel background. */ - showPane?: boolean; - /** Specifies the text to display inside a load panel. */ - text?: string; - /** Specifies the width of the load panel. */ - width?: number; - }; - /** A handler for the cellClick event. */ - onCellClick?: (e: any) => void; - /** A handler for the cellPrepared event. */ - onCellPrepared?: (e: any) => void; - /** A handler for the contextMenuPreparing event. */ - onContextMenuPreparing?: (e: Object) => void; - /** Configures client-side export. */ - export?: { - /** Enables client-side export. */ - enabled?: boolean; - /** Specifies a default name for the file to which grid data is exported. */ - fileName?: string; - /** Specifies the URL of the server-side proxy that streams the resulting file to the end user to enable export in IE9 and Safari browsers. */ - proxyUrl?: string; - }; - /** A handler for the exporting event. */ - onExporting?: (e: { - fileName: string; - cancel: boolean; - }) => void; - /** A handler for the fileSaving event. */ - onFileSaving?: (e: { - fileName: string; - format: string; - data: any; - cancel: boolean; - }) => void; - /** A handler for the exported event. */ - onExported?: (e: Object) => void; - /** A configuration object specifying options related to state storing. */ - stateStoring?: { - /** Specifies a callback function that performs specific actions on state loading. */ - customLoad?: () => JQueryPromise; - /** Specifies a callback function that performs specific actions on state saving. */ - customSave?: (gridState: Object) => void; - /** Specifies whether or not a grid saves its state. */ - enabled?: boolean; - /** Specifies the delay between the last change of a grid state and the operation of saving this state in milliseconds. */ - savingTimeout?: number; - /** Specifies a unique key to be used for storing the grid state. */ - storageKey?: string; - /** Specifies the type of storage to be used for state storing. */ - type?: string; - }; - } - /** A data summarization widget for multi-dimensional data analysis and data mining. */ - export class dxPivotGrid extends Widget { - constructor(element: JQuery, options?: dxPivotGridOptions); - constructor(element: Element, options?: dxPivotGridOptions); - /** Gets the PivotGridDataSource instance. */ - getDataSource(): DevExpress.data.PivotGridDataSource; - /** Gets the dxPopup instance of the field chooser window. */ - getFieldChooserPopup(): DevExpress.ui.dxPopup; - /** Updates the widget to the size of its content. */ - updateDimensions(): void; - /** Exports pivot grid data to the Excel file. */ - exportToExcel(): void; - /** Binds a dxChart to the dxPivotGrid. */ - bindChart(chart: any, integrationOptions?: { - inverted?: boolean; - dataFieldsDisplayMode?: string; - putDataFieldsInto?: string; - alternateDataFields?: boolean; - processCell?: Function; - customizeChart?: Function; - customizeSeries?: Function; - }): any; - } - export interface dxPivotGridFieldChooserOptions extends WidgetOptions { - /** Specifies the height of the widget. */ - height?: any; - /** Specifies the field chooser layout. */ - layout?: number; - /** The data source of a dxPivotGrid widget. */ - dataSource?: DevExpress.data.PivotGridDataSource; - onContentReady?: Function; - /** A handler for the contextMenuPreparing event. */ - onContextMenuPreparing?: (e: Object) => void; - /** Strings that can be changed or localized in the dxPivotGridFieldChooser widget. */ - texts?: { - /** The string to display instead of Row Fields. */ - rowFields?: string; - /** The string to display instead of Column Fields. */ - columnFields?: string; - /** The string to display instead of Data Fields. */ - dataFields?: string; - /** The string to display instead of Filter Fields. */ - filterFields?: string; - /** The string to display instead of All Fields. */ - allFields?: string; - }; - } - /** A complementary widget for dxPivotGrid that allows you to manage data displayed in the dxPivotGrid. */ - export class dxPivotGridFieldChooser extends Widget { - constructor(element: JQuery, options?: dxPivotGridFieldChooserOptions); - constructor(element: Element, options?: dxPivotGridFieldChooserOptions); - /** Updates the widget to the size of its content. */ - updateDimensions(): void; - /** Gets the PivotGridDataSource instance. */ - getDataSource(): DevExpress.data.PivotGridDataSource; - } -} -interface JQuery { - dxTreeView(): JQuery; - dxTreeView(options: "instance"): DevExpress.ui.dxTreeView; - dxTreeView(options: string): any; - dxTreeView(options: string, ...params: any[]): any; - dxTreeView(options: DevExpress.ui.dxTreeViewOptions): JQuery; - dxMenuBase(): JQuery; - dxMenuBase(options: "instance"): DevExpress.ui.dxMenuBase; - dxMenuBase(options: string): any; - dxMenuBase(options: string, ...params: any[]): any; - dxMenuBase(options: DevExpress.ui.dxMenuBaseOptions): JQuery; - dxMenu(): JQuery; - dxMenu(options: "instance"): DevExpress.ui.dxMenu; - dxMenu(options: string): any; - dxMenu(options: string, ...params: any[]): any; - dxMenu(options: DevExpress.ui.dxMenuOptions): JQuery; - dxContextMenu(): JQuery; - dxContextMenu(options: "instance"): DevExpress.ui.dxContextMenu; - dxContextMenu(options: string): any; - dxContextMenu(options: string, ...params: any[]): any; - dxContextMenu(options: DevExpress.ui.dxContextMenuOptions): JQuery; - dxColorBox(): JQuery; - dxColorBox(options: "instance"): DevExpress.ui.dxColorBox; - dxColorBox(options: string): any; - dxColorBox(options: string, ...params: any[]): any; - dxColorBox(options: DevExpress.ui.dxColorBoxOptions): JQuery; - dxDataGrid(): JQuery; - dxDataGrid(options: "instance"): DevExpress.ui.dxDataGrid; - dxDataGrid(options: string): any; - dxDataGrid(options: string, ...params: any[]): any; - dxDataGrid(options: DevExpress.ui.dxDataGridOptions): JQuery; - dxPivotGrid(): JQuery; - dxPivotGrid(options: "instance"): DevExpress.ui.dxPivotGrid; - dxPivotGrid(options: string): any; - dxPivotGrid(options: string, ...params: any[]): any; - dxPivotGrid(options: DevExpress.ui.dxPivotGridOptions): JQuery; - dxPivotGridFieldChooser(): JQuery; - dxPivotGridFieldChooser(options: "instance"): DevExpress.ui.dxPivotGridFieldChooser; - dxPivotGridFieldChooser(options: string): any; - dxPivotGridFieldChooser(options: string, ...params: any[]): any; - dxPivotGridFieldChooser(options: DevExpress.ui.dxPivotGridFieldChooserOptions): JQuery; - dxScheduler(): JQuery; - dxScheduler(options: "instance"): DevExpress.ui.dxScheduler; - dxScheduler(options: string): any; - dxScheduler(options: string, ...params: any[]): any; - dxScheduler(options: DevExpress.ui.dxSchedulerOptions): JQuery; -} -declare module DevExpress.framework { - /** An object used to store information on the views displayed in an application. */ - export class ViewCache { - viewRemoved: JQueryCallback; - /** Removes all the viewInfo objects from the cache. */ - clear(): void; - /** Obtains a viewInfo object from the cache by the specified key. */ - getView(key: string): Object; - /** Checks whether or not a viewInfo object is contained in the view cache under the specified key. */ - hasView(key: string): boolean; - /** Removes a viewInfo object from the cache by the specified key. */ - removeView(key: string): Object; - /** Adds the specified viewInfo object to the cache under the specified key. */ - setView(key: string, viewInfo: Object): void; - } - export interface dxCommandOptions extends DOMComponentOptions { - /** Specifies an action performed when the execute() method of the command is called. */ - onExecute?: any; - /** Indicates whether or not the widget that displays this command is disabled. */ - disabled?: boolean; - /** Specifies whether the current command is rendered when a view is being rendered or after a view is shown. */ - renderStage?: string; - /** Specifies the name of the icon shown inside the widget associated with this command. */ - icon?: string; - iconSrc?: string; - /** The identifier of the command. */ - id?: string; - /** Specifies the title of the widget associated with this command. */ - title?: string; - /** Specifies the type of the button, if the command is rendered as a dxButton widget. */ - type?: string; - /** A Boolean value specifying whether or not the widget associated with this command is visible. */ - visible?: boolean; - } - /** A markup component used to define markup options for a command. */ - export class dxCommand extends DOMComponent { - constructor(element: JQuery, options: dxCommandOptions); - constructor(options: dxCommandOptions); - /** Executes the action associated with this command. */ - execute(): void; - } - /** An object responsible for routing. */ - export class Router { - /** Adds a routing rule to the list of registered rules. */ - register(pattern: string, defaults?: Object, constraints?: Object): void; - /** Decodes the specified URI to an object using the registered routing rules. */ - parse(uri: string): Object; - /** Formats an object to a URI. */ - format(obj: Object): string; - } - export interface StateManagerOptions { - /** A storage to which the state manager saves the application state. */ - storage?: Object; - } - /** An object used to store the current application state. */ - export class StateManager { - constructor(options?: StateManagerOptions); - /** Adds an object that implements an interface of a state source to the state manager's collection of state sources. */ - addStateSource(stateSource: Object): void; - /** Removes a specified state source from the state manager's collection of state sources. */ - removeStateSource(stateSource: Object): void; - /** Saves the current application state. */ - saveState(): void; - /** Restores the application state that has been saved by the saveState() method to the state storage. */ - restoreState(): void; - /** Removes the application state that has been saved by the saveState() method to the state storage. */ - clearState(): void; - } - export module html { - export var layoutSets: Array; - export var animationSets: { [animationSetName: string]: AnimationSet }; - export interface AnimationSet { - [animationName: string]: any - } - export interface HtmlApplicationOptions { - /** Specifies where the commands that are defined in the application's views must be displayed. */ - commandMapping?: Object; - /** Specifies whether or not view caching is disabled. */ - disableViewCache?: boolean; - /** An array of layout controllers that should be used to show application views in the current navigation context. */ - layoutSet?: any; - /** Specifies the animation presets that are used to animate different UI elements in the current application. */ - animationSet?: AnimationSet; - /** Specifies whether the current application must behave as a mobile or web application. */ - mode?: string; - /** Specifies the object that represents a root namespace of the application. */ - namespace?: Object; - /** Specifies application behavior when the user navigates to a root view. */ - navigateToRootViewMode?: string; - /** An array of dxCommand configuration objects used to define commands available from the application's global navigation. */ - navigation?: Array; - /** A state manager to be used in the application. */ - stateManager?: StateManager; - /** Specifies the storage to be used by the application's state manager to store the application state. */ - stateStorage?: Object; - /** Indicates whether on not to use the title of the previously displayed view as text on the Back button. */ - useViewTitleAsBackText?: boolean; - /** A custom view cache to be used in the application. */ - viewCache?: Object; - /** Specifies a limit for the views that can be cached. */ - viewCacheSize?: number; - /** Specifies the current version of application templates. */ - templatesVersion?: string; - /** Specifies options for the viewport meta tag of a mobile browser. */ - viewPort?: JQuery; - /** A custom router to be used in the application. */ - router?: Router; - } - /** An object used to manage views, as well as control the application life cycle. */ - export class HtmlApplication implements EventsMixin { - constructor(options: HtmlApplicationOptions); - afterViewSetup: JQueryCallback; - beforeViewSetup: JQueryCallback; - initialized: JQueryCallback; - navigating: JQueryCallback; - navigatingBack: JQueryCallback; - resolveLayoutController: JQueryCallback; - resolveViewCacheKey: JQueryCallback; - viewDisposed: JQueryCallback; - viewDisposing: JQueryCallback; - viewHidden: JQueryCallback; - viewRendered: JQueryCallback; - viewShowing: JQueryCallback; - viewShown: JQueryCallback; - /** Provides access to the ViewCache object. */ - viewCache: ViewCache; - /** An array of dxCommand components that are created based on the application's navigation option value. */ - navigation: Array; - /** Provides access to the StateManager object. */ - stateManager: StateManager; - /** Provides access to the Router object. */ - router: Router; - /** Navigates to the URI preceding the current one in the navigation history. */ - back(): void; - /** Returns a Boolean value indicating whether or not backwards navigation is currently possible. */ - canBack(): boolean; - /** Calls the clearState() method of the application's StateManager object. */ - clearState(): void; - /** Creates global navigation commands. */ - createNavigation(navigationConfig: Array): void; - /** Returns an HTML template of the specified view. */ - getViewTemplate(viewName: string): JQuery; - /** Returns a configuration object used to create a dxView component for a specified view. */ - getViewTemplateInfo(viewName: string): Object; - /** Adds a specified HTML template to a collection of view or layout templates. */ - loadTemplates(source: any): JQueryPromise; - /** Navigates to the specified URI. */ - navigate(uri?: any, options?: Object): void; - /** Renders navigation commands to the navigation command containers that are located in the layouts used in the application. */ - renderNavigation(): void; - /** Calls the restoreState() method of the application's StateManager object. */ - restoreState(): void; - /** Calls the saveState method of the application's StateManager object. */ - saveState(): void; - /** Provides access to the object that defines the current context to be considered when choosing an appropriate template for a view. */ - templateContext(): Object; - on(eventName: "initialized", eventHandler: () => void): HtmlApplication; - on(eventName: "afterViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "beforeViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "navigating", eventHandler: (e: { - currentUri: string; - uri: string; - cancel: boolean; - options: { - root: boolean; - target: string; - direction: string; - rootInDetailPane: boolean; - modal: boolean; - }; - }) => void): HtmlApplication; - on(eventName: "navigatingBack", eventHandler: (e: { - cancel: boolean; - isHardwareButton: boolean; - }) => void): HtmlApplication; - on(eventName: "resolveLayoutController", eventHandler: (e: { - viewInfo: Object; - layoutController: Object; - availableLayoutControllers: Array; - }) => void): HtmlApplication; - on(eventName: "resolveViewCacheKey", eventHandler: (e: { - key: string; - navigationItem: Object; - routeData: Object; - }) => void): HtmlApplication; - on(eventName: "viewDisposed", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewDisposing", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewHidden", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewRendered", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewShowing", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - on(eventName: "viewShown", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - on(eventName: string, eventHandler: Function): HtmlApplication; - on(events: { [eventName: string]: Function; }): HtmlApplication; - off(eventName: "initialized"): HtmlApplication; - off(eventName: "afterViewSetup"): HtmlApplication; - off(eventName: "beforeViewSetup"): HtmlApplication; - off(eventName: "navigating"): HtmlApplication; - off(eventName: "navigatingBack"): HtmlApplication; - off(eventName: "resolveLayoutController"): HtmlApplication; - off(eventName: "resolveViewCacheKey"): HtmlApplication; - off(eventName: "viewDisposed"): HtmlApplication; - off(eventName: "viewDisposing"): HtmlApplication; - off(eventName: "viewHidden"): HtmlApplication; - off(eventName: "viewRendered"): HtmlApplication; - off(eventName: "viewShowing"): HtmlApplication; - off(eventName: "viewShown"): HtmlApplication; - off(eventName: string): HtmlApplication; - off(eventName: "initialized", eventHandler: () => void): HtmlApplication; - off(eventName: "afterViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "beforeViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "navigating", eventHandler: (e: { - currentUri: string; - uri: string; - cancel: boolean; - options: { - root: boolean; - target: string; - direction: string; - rootInDetailPane: boolean; - modal: boolean; - }; - }) => void): HtmlApplication; - off(eventName: "navigatingBack", eventHandler: (e: { - cancel: boolean; - isHardwareButton: boolean; - }) => void): HtmlApplication; - off(eventName: "resolveLayoutController", eventHandler: (e: { - viewInfo: Object; - layoutController: Object; - availableLayoutControllers: Array; - }) => void): HtmlApplication; - off(eventName: "resolveViewCacheKey", eventHandler: (e: { - key: string; - navigationItem: Object; - routeData: Object; - }) => void): HtmlApplication; - off(eventName: "viewDisposed", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewDisposing", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewHidden", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewRendered", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewShowing", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - off(eventName: "viewShown", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - off(eventName: string, eventHandler: Function): HtmlApplication; - } - } -} -declare module DevExpress.viz.core { - export interface Border { - /** Sets a border color for a selected series. */ - color?: string; - /** Sets border visibility for a selected series. */ - visible?: boolean; - /** Sets a border width for a selected series. */ - width?: number; - } - export interface DashedBorder extends Border { - /** Specifies a dash style for the border of a selected series point. */ - dashStyle?: string; - } - export interface DashedBorderWithOpacity extends DashedBorder { - /** Specifies how transparent the vertical crosshair line should be. */ - opacity?: number; - } - export interface Font { - /** Colors the text displayed by the group labels. */ - color?: string; - /** Specifies the font family of the text displayed by the group labels. */ - family?: string; - /** Specifies how transparent the text displayed by the group labels should be. */ - opacity?: number; - /** Specifies the size of the text displayed by the group labels. */ - size?: any; - /** Specifies the font weight of the text displayed by the group labels. */ - weight?: number; - } - export interface Hatching { - direction?: string; - /** Specifies the opacity of hatching lines. */ - opacity?: number; - /** Specifies the distance between hatching lines in pixels. */ - step?: number; - /** Specifies the width of hatching lines in pixels. */ - width?: number; - } - export interface Margins { - /** Specifies the legend's bottom margin in pixels. */ - bottom?: number; - /** Specifies the legend's left margin in pixels. */ - left?: number; - /** Specifies the legend's right margin in pixels. */ - right?: number; - /** Specifies the legend's bottom margin in pixels. */ - top?: number; - } - export interface MarginOptions { - /** Generates space around the widget. */ - margin?: Margins; - } - export interface RedrawOnResizeOptions { - /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */ - redrawOnResize?: boolean; - } - export interface TitleOptions { - /** Specifies the widget title. */ - title?: Title; - } - export interface ExportOptions { - /** Configures the exporting and printing features. */ - export?: Export; - } - export interface LoadingIndicatorOptions { - /** Configures the loading indicator. */ - loadingIndicator?: LoadingIndicator; - } - export interface LoadingIndicatorMethods { - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - } - export interface Size { - /** Specifies the width of the widget in pixels. */ - width?: number; - /** Specifies the height of the widget in pixels. */ - height?: number; - } - export interface Title { - /** Specifies font options for the title. */ - font?: viz.core.Font; - /** Specifies the title's alignment in a horizontal direction. */ - horizontalAlignment?: string; - /** Specifies the title's alignment in a vertical direction. */ - verticalAlignment?: string; - /** Generates space around the title. */ - margin?: Margins; - /** Specifies the minimum height that the title occupies. */ - placeholderSize?: number; - /** Specifies the title text. */ - text?: string; - /** Specifies the widget subtitle. */ - subtitle?: { - /** Specifies font options for the subtitle. */ - font?: viz.core.Font; - /** Specifies text for the subtitle. */ - text?: string; - } - } - export interface Export { - /** Enables the client-side exporting in the widget. */ - enabled?: boolean; - /** Enables the printing feature in the widget. Applies only if the export | enabled option is true. */ - printingEnabled?: boolean; - /** Specifies a set of formats available for exporting into. */ - formats?: Array; - /** Specifies a default name for the file to which the widget will be exported. */ - fileName?: string; - /** Specifies the URL of the server-side proxy that streams the resulting file to the end user to enable exporting in IE9 and Safari browsers. */ - proxyUrl?: string; - /** Specifies the color that will fill transparent regions in the resulting file or document. */ - backgroundColor?: string; - } - export interface Tooltip { - /** Specifies the length of the tooltip's arrow in pixels. */ - arrowLength?: number; - /** Specifies the appearance of the tooltip's border. */ - border?: DashedBorderWithOpacity; - /** Specifies the color of tooltips. */ - color?: string; - /** Specifies the z-index of tooltips. */ - zIndex?: number; - /** Specifies the container to draw tooltips inside of it. */ - container?: any; - /** Allows you to change tooltip appearance. */ - customizeTooltip?: (arg: Object) => { color?: string; text?: string }; - enabled?: boolean; - /** Specifies the font of the text displayed by a tooltip. */ - font?: Font; - /** Specifies the format of the value displayed by a tooltip. */ - format?: any; - /** Specifies the opacity of tooltips. */ - opacity?: number; - /** Generates space on the left and the right of the text displayed by a tooltip. */ - paddingLeftRight?: number; - /** Generates space above and below the text displayed by a tooltip. */ - paddingTopBottom?: number; - /** - * Specifies the precision of formatted values in a tooltip. - * @deprecated Use the tooltip | format | precision option instead. - */ - precision?: number; - /** Specifies the appearance of the tooltip's shadow. */ - shadow?: { - /** Specifies the blur distance of the tooltip's shadow. */ - blur?: number; - /** Specifies the color of the tooltip's shadow. */ - color?: string; - /** Specifies the horizontal offset of the tooltip's shadow relative to the tooltip itself measured in pixels. */ - offsetX?: number; - /** Specifies the vertical offset of the tooltip's shadow relative to the tooltip itself measured in pixels. */ - offsetY?: number; - /** Specifies the opacity of the tooltip's shadow. */ - opacity?: number; - }; - } - export interface Animation { - /** Determines how long animation runs. */ - duration?: number; - /** Specifies the animation easing mode. */ - easing?: string; - /** Indicates whether or not animation is enabled. */ - enabled?: boolean; - } - export interface LoadingIndicator { - /** Colors the background of the loading indicator. */ - backgroundColor?: string; - /** Specifies font options for the loading indicator. */ - font?: viz.core.Font; - /** Specifies whether to show the loading indicator or not. */ - show?: boolean; - /** Specifies the text to be displayed by the loading indicator. */ - text?: string; - } - export interface LegendBorder extends viz.core.DashedBorderWithOpacity { - /** Specifies a radius for the corners of the legend border. */ - cornerRadius?: number; - } - export interface BaseLegend { - /** Specifies the color of the legend's background. */ - backgroundColor?: string; - /** Specifies legend border settings. */ - border?: viz.core.LegendBorder; - /** Specifies how many columns must be taken to arrange legend items. */ - columnCount?: number; - /** Specifies the spacing between a pair of neighboring legend columns in pixels. */ - columnItemSpacing?: number; - /** Specifies font options for legend items. */ - font?: viz.core.Font; - /** Specifies the legend's position on the map. */ - horizontalAlignment?: string; - /** Specifies the alignment of legend items. */ - itemsAlignment?: string; - /** Specifies the position of text relative to the item marker. */ - itemTextPosition?: string; - /** Specifies the distance between the legend and the container borders in pixels. */ - margin?: viz.core.Margins; - /** Specifies the size of item markers in the legend in pixels. */ - markerSize?: number; - /** Specifies whether to arrange legend items horizontally or vertically. */ - orientation?: string; - /** Specifies the spacing between the legend left/right border and legend items in pixels. */ - paddingLeftRight?: number; - /** Specifies the spacing between the legend top/bottom border and legend items in pixels. */ - paddingTopBottom?: number; - /** Specifies how many rows must be taken to arrange legend items. */ - rowCount?: number; - /** Specifies the spacing between a pair of neighboring legend rows in pixels. */ - rowItemSpacing?: number; - /** Specifies the legend's position on the map. */ - verticalAlignment?: string; - /** Specifies whether or not the legend is visible on the map. */ - visible?: boolean; - } - export interface BaseWidgetOptions extends DOMComponentOptions { - /** Specifies the size of the widget in pixels. */ - size?: Size; - /** A handler for the drawn event. */ - onDrawn?: (e: { - component: BaseWidget; - element: Element; - }) => void; - /** A handler for the incidentOccurred event. */ - onIncidentOccurred?: ( - component: BaseWidget, - element: Element, - target: { - id: string; - type: string; - args: any; - text: string; - widget: string; - version: string; - } - ) => void; - /** A handler for the exporting event. */ - onExporting?: (e: { - fileName: string; - cancel: boolean; - }) => void; - /** A handler for the fileSaving event. */ - onFileSaving?: (e: { - fileName: string; - format: string; - data: any; - cancel: boolean; - }) => void; - /** A handler for the exported event. */ - onExported?: (e: Object) => void; - /** Notifies a widget that it is embedded into an HTML page that uses a path modifier. */ - pathModified?: boolean; - /** Specifies whether or not the widget supports right-to-left representation. */ - rtlEnabled?: boolean; - /** Sets the name of the theme to be used in the widget. */ - theme?: string; - } - /** This section describes options and methods that are common to all widgets. */ - export class BaseWidget extends DOMComponent { - /** Returns the widget's SVG markup. */ - svg(): string; - /** Exports the widget into a document with a specified name and format. */ - exportTo(): void; - /** Opens the browser's print window. */ - print(): void; - /** Redraws the widget. */ - render(): void; - } -} -declare module DevExpress.viz { - /** - * Applies a theme for the entire page with several DevExtreme visualization widgets. - * @deprecated Use the DevExpress.viz.currentTheme(theme) method instead. - */ - export function currentTheme(theme: string): void; - /** - * Applies a new theme (with the color scheme defined separately) for the entire page with several DevExtreme visualization widgets. - * @deprecated Use the DevExpress.viz.currentTheme(platform, colorScheme) method instead. - */ - export function currentTheme(platform: string, colorScheme: string): void; - /** - * Registers a new theme based on the existing one. - * @deprecated Use the DevExpress.viz.registerTheme(customTheme, baseTheme) method instead. - */ - export function registerTheme(customTheme: Object, baseTheme: string): void; - /** - * Applies a predefined or registered custom palette to all visualization widgets at once. - * @deprecated Use the DevExpress.viz.currentPalette(paletteName) method instead. - */ - export function currentPalette(paletteName: string): void; - /** - * Obtains the color sets of a predefined or registered palette. - * @deprecated Use the DevExpress.viz.getPalette(paletteName) method instead. - */ - export function getPalette(paletteName: string): Object; - /** - * Registers a new palette. - * @deprecated Use the DevExpress.viz.registerPalette(paletteName, palette) method instead. - */ - export function registerPalette(paletteName: string, palette: Object): void; -} -declare module DevExpress.viz.charts { - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface BaseSeries { - /** Provides information about the state of the series object. */ - fullState: number; - /** Returns the type of the series. */ - type: string; - /** Unselects all the selected points of the series. The points are displayed in an initial style. */ - clearSelection(): void; - /** Gets the color of a particular series. */ - getColor(): string; - /** Gets points from the series point collection based on the specified argument. */ - getPointsByArg(pointArg: any): Array; - /** Gets a point from the series point collection based on the specified point position. */ - getPointByPos(positionIndex: number): Object; - /** Selects the series. The series is displayed in a 'selected' style until another series is selected or the current series is deselected programmatically. */ - select(): void; - /** Selects the specified point. The point is displayed in a 'selected' style. */ - selectPoint(point: BasePoint): void; - /** Deselects the specified point. The point is displayed in an initial style. */ - deselectPoint(point: BasePoint): void; - /** Returns an array of all points in the series. */ - getAllPoints(): Array; - /** Returns visible series points. */ - getVisiblePoints(): Array; - /** Returns the name of the series. */ - name: string; - /** Returns the tag of the series. */ - tag: string; - /** Hides a series. */ - hide(): void; - /** Provides information about the hover state of a series. */ - isHovered(): boolean; - /** Provides information about the selection state of a series. */ - isSelected(): boolean; - /** Provides information about the visibility state of a series. */ - isVisible(): boolean; - /** Makes a particular series visible. */ - show(): void; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface BasePoint { - /** Provides information about the state of the point object. */ - fullState: number; - /** Returns the point's argument value that was set in the data source. */ - originalArgument: any; - /** Returns the point's value that was set in the data source. */ - originalValue: any; - /** Returns the tag of the point. */ - tag: string; - /** Deselects the point. */ - clearSelection(): void; - /** Gets the color of a particular point. */ - getColor(): string; - /** Hides the tooltip of the point. */ - hideTooltip(): void; - /** Provides information about the hover state of a point. */ - isHovered(): boolean; - /** Provides information about the selection state of a point. */ - isSelected(): boolean; - /** Selects the point. The point is displayed in a 'selected' style until another point is selected or the current point is deselected programmatically. */ - select(): void; - /** Shows the tooltip of the point. */ - showTooltip(): void; - /** Allows you to obtain the label of a series point. */ - getLabel(): any; - /** Returns the series object to which the point belongs. */ - series: BaseSeries; - } - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface ChartSeries extends BaseSeries { - /** Returns the name of the series pane. */ - pane: string; - /** Returns the name of the value axis of the series. */ - axis: string; - selectPoint(point: ChartPoint): void; - deselectPoint(point: ChartPoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface ChartPoint extends BasePoint { - /** Contains the close value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalCloseValue: any; - /** Contains the high value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalHighValue: any; - /** Contains the low value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalLowValue: any; - /** Contains the first value of the point. This field is useful for points belonging to a series of the range area or range bar type only. */ - originalMinValue: any; - /** Contains the open value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalOpenValue: any; - /** Contains the size of the bubble as it was set in the data source. This field is useful for points belonging to a series of the bubble type only. */ - size: any; - /** Gets the parameters of the point's minimum bounding rectangle (MBR). */ - getBoundingRect(): { x: number; y: number; width: number; height: number; }; - series: ChartSeries; - } - /** This section describes the methods that can be used in code to manipulate the Label object. */ - export interface Label { - /** Gets the parameters of the label's minimum bounding rectangle (MBR). */ - getBoundingRect(): { x: number; y: number; width: number; height: number; }; - /** Hides the point label. */ - hide(): void; - /** Shows the point label. */ - show(): void; - } - export interface PieSeries extends BaseSeries { - selectPoint(point: PiePoint): void; - deselectPoint(point: PiePoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface PiePoint extends BasePoint { - /** Gets the percentage value of the specific point. */ - percent: any; - /** Provides information about the visibility state of a point. */ - isVisible(): boolean; - /** Makes a specific point visible. */ - show(): void; - /** Hides a specific point. */ - hide(): void; - series: PieSeries; - } - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface PolarSeries extends BaseSeries { - /** Returns the name of the value axis of the series. */ - axis: string; - selectPoint(point: PolarPoint): void; - deselectPoint(point: PolarPoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface PolarPoint extends BasePoint { - series: PolarSeries; - } - export interface Strip { - /** Specifies a color for a strip. */ - color?: string; - /** An object that defines the label configuration options of a strip. */ - label?: { - /** Specifies the text displayed in a strip. */ - text?: string; - }; - /** Specifies a start value for a strip. */ - startValue?: any; - /** Specifies an end value for a strip. */ - endValue?: any; - } - export interface BaseSeriesConfigLabel { - /** Specifies a format for arguments displayed by point labels. */ - argumentFormat?: any; - /** - * Specifies a precision for formatted point arguments displayed in point labels. - * @deprecated Use the series | label | argumentFormat | precision instead. - */ - argumentPrecision?: number; - /** Specifies a background color for point labels. */ - backgroundColor?: string; - /** Specifies border options for point labels. */ - border?: viz.core.DashedBorder; - /** Specifies connector options for series point labels. */ - connector?: { - /** Specifies the color of label connectors. */ - color?: string; - /** Indicates whether or not label connectors are visible. */ - visible?: boolean; - /** Specifies the width of label connectors. */ - width?: number; - }; - /** Specifies a callback function that returns the text to be displayed by point labels. */ - customizeText?: (pointInfo: Object) => string; - /** Specifies font options for the text displayed in point labels. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed by point labels. */ - format?: any; - position?: string; - /** - * Specifies a precision for formatted point values displayed in point labels. - * @deprecated Use the series | label | format | precision option instead. - */ - precision?: number; - /** Specifies the angle used to rotate point labels from their initial position. */ - rotationAngle?: number; - /** Specifies the visibility of point labels. */ - visible?: boolean; - } - export interface SeriesConfigLabel extends BaseSeriesConfigLabel { - /** Specifies whether or not to show labels for points with zero value. Applies only to bar-like series. */ - showForZeroValues?: boolean; - } - export interface ChartSeriesConfigLabel extends SeriesConfigLabel { - /** Aligns point labels in relation to their points. */ - alignment?: string; - /** Along with verticalOffset, shifts point labels from their initial positions. */ - horizontalOffset?: number; - /** Along with horizontalOffset, shifts point labels from their initial positions. */ - verticalOffset?: number; - /** - * Specifies a precision for the percentage values displayed in the labels of a full-stacked-like series. - * @deprecated Use the series | label | format | percentPrecision instead. - */ - percentPrecision?: number; - } - export interface BaseCommonSeriesConfig { - /** Specifies the data source field that provides arguments for series points. */ - argumentField?: string; - axis?: string; - label?: ChartSeriesConfigLabel; - border?: viz.core.DashedBorder; - /** Specifies a series color. */ - color?: string; - /** Specifies the dash style of the series' line. */ - dashStyle?: string; - hoverMode?: string; - hoverStyle?: { - border?: viz.core.DashedBorder; - /**

Sets a color for a series when it is hovered over.

*/ - color?: string; - /** Specifies the dash style for the line in a hovered series. */ - dashStyle?: string; - hatching?: viz.core.Hatching; - /** Specifies the width of a line in a hovered series. */ - width?: number; - }; - /** Specifies whether a chart ignores null data points or not. */ - ignoreEmptyPoints?: boolean; - /** Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed. */ - maxLabelCount?: number; - /** Specifies the minimal length of a displayed bar in pixels. */ - minBarSize?: number; - /** Specifies opacity for a series. */ - opacity?: number; - /** Specifies series elements to be highlighted when a user selects a point. */ - selectionMode?: string; - selectionStyle?: { - border?: viz.core.DashedBorder; - /** Sets a color for a series when it is selected. */ - color?: string; - /** Specifies the dash style for the line in a selected series. */ - dashStyle?: string; - hatching?: viz.core.Hatching; - /** Specifies the width of a line in a selected series. */ - width?: number; - }; - /** Specifies whether or not to show the series in the chart's legend. */ - showInLegend?: boolean; - /** Specifies the name of the stack where the values of the _stackedBar_ series must be located. */ - stack?: string; - /** Specifies the name of the data source field that provides data about a point. */ - tagField?: string; - /** Specifies the data source field that provides values for series points. */ - valueField?: string; - /** Specifies the visibility of a series. */ - visible?: boolean; - /** Specifies a line width. */ - width?: number; - /** Configures error bars. */ - valueErrorBar?: { - /** Specifies whether error bars must be displayed in full or partially. */ - displayMode?: string; - /** Specifies the data field that provides data for low error values. */ - lowValueField?: string; - /** Specifies the data field that provides data for high error values. */ - highValueField?: string; - /** Specifies how error bar values must be calculated. */ - type?: string; - /** Specifies the value to be used for generating error bars. */ - value?: number; - /** Specifies the color of error bars. */ - color?: string; - /** Specifies the opacity of error bars. */ - opacity?: number; - /** Specifies the length of the lines that indicate the error bar edges. */ - edgeLength?: number; - /** Specifies the width of the error bar line. */ - lineWidth?: number; - }; - } - export interface CommonPointOptions { - /** Specifies border options for points in the line and area series. */ - border?: viz.core.Border; - /** Specifies the points color. */ - color?: string; - /** Specifies what series points to highlight when a point is hovered over. */ - hoverMode?: string; - /** An object defining configuration options for a hovered point. */ - hoverStyle?: { - /** An object defining the border options for a hovered point. */ - border?: viz.core.Border; - /** Sets a color for a point when it is hovered over. */ - color?: string; - /** Specifies the diameter of a hovered point in the series that represents data points as symbols (not as bars for instance). */ - size?: number; - }; - /** Specifies what series points to highlight when a point is selected. */ - selectionMode?: string; - /** An object defining configuration options for a selected point. */ - selectionStyle?: { - /** An object defining the border options for a selected point. */ - border?: viz.core.Border; - /**

Sets a color for a point when it is selected.

*/ - color?: string; - /** Specifies the diameter of a selected point in the series that represents data points as symbols (not as bars for instance). */ - size?: number; - }; - /** Specifies the point diameter in pixels for those series that represent data points as symbols (not as bars for instance). */ - size?: number; - /** Specifies a symbol for presenting points of the line and area series. */ - symbol?: string; - visible?: boolean; - } - export interface ChartCommonPointOptions extends CommonPointOptions { - /** Substitutes the standard point symbols with an image. */ - image?: { - /** Specifies the height of the image used instead of a point marker. */ - height?: any; - /** Specifies the URL of the image to be used as a point marker. */ - url?: any; - /** Specifies the width of an image that is used as a point marker. */ - width?: any; - }; - } - export interface PolarCommonPointOptions extends CommonPointOptions { - /** An object specifying the parameters of an image that is used as a point marker. */ - image?: { - /** Specifies the height of an image that is used as a point marker. */ - height?: number; - /** Specifies a URL leading to the image to be used as a point marker. */ - url?: string; - /** Specifies the width of an image that is used as a point marker. */ - width?: number; - }; - } - /** An object that defines configuration options for chart series. */ - export interface CommonSeriesConfig extends BaseCommonSeriesConfig { - /** Specifies which data source field provides close values for points of a financial series. */ - closeValueField?: string; - /** Makes bars look rounded. Applies only to bar-like series. */ - cornerRadius?: number; - /** Specifies which data source field provides high values for points of a financial series. */ - highValueField?: string; - /** Specifies a filling color for the body of a series point that visualizes a non-reduced value. Applies only to candlestick series. */ - innerColor?: string; - /** Specifies which data source field provides low values for points of a financial series. */ - lowValueField?: string; - /** Specifies which data source field provides open values for points of a financial series. */ - openValueField?: string; - /** Specifies which pane the series should belong to. Accepts the name of the pane. */ - pane?: string; - point?: ChartCommonPointOptions; - /** Coupled with the rangeValue2Field option, specifies which data source field provides values for a range-like series. */ - rangeValue1Field?: string; - /** Coupled with the rangeValue1Field option, specifies which data source field provides values for a range-like series. */ - rangeValue2Field?: string; - /** Specifies reduction options for financial series. */ - reduction?: { - /** Specifies a color for the points whose price has decreased in comparison to the price of the previous point. */ - color?: string; - /** Specifies whether high, low, open or close prices of points should be compared. */ - level?: string; - }; - /** Specifies which data source field provides size values for bubbles. Required by and applies only to bubble series. */ - sizeField?: string; - } - export interface CommonSeriesSettings extends CommonSeriesConfig { - /** Defines common settings for all area series. */ - area?: CommonSeriesConfig; - /** Defines common settings for all bar series. */ - bar?: CommonSeriesConfig; - /** Defines common settings for all bubble series. */ - bubble?: CommonSeriesConfig; - /** Defines common settings for all candlestick series. */ - candlestick?: CommonSeriesConfig; - /** Defines common settings for all full-stacked area series. */ - fullstackedarea?: CommonSeriesConfig; - /** Defines common settings for all full-stacked spline area series. */ - fullstackedsplinearea?: CommonSeriesConfig; - /** Defines common settings for all full-stacked bar series. */ - fullstackedbar?: CommonSeriesConfig; - /** Defines common settings for all full-stacked line series. */ - fullstackedline?: CommonSeriesConfig; - /** Defines common settings for all full-stacked spline series. */ - fullstackedspline?: CommonSeriesConfig; - /** Defines common settings for all line series. */ - line?: CommonSeriesConfig; - /** Defines common settings for all range area series. */ - rangearea?: CommonSeriesConfig; - /** Defines common settings for all range bar series. */ - rangebar?: CommonSeriesConfig; - /** Defines common settings for all scatter series. */ - scatter?: CommonSeriesConfig; - /** Defines common settings for all spline series. */ - spline?: CommonSeriesConfig; - /** Defines common settings for all spline area series. */ - splinearea?: CommonSeriesConfig; - /** Defines common settings for all stacked area series. */ - stackedarea?: CommonSeriesConfig; - /** Defines common settings for all stacked spline area series. */ - stackedsplinearea?: CommonSeriesConfig; - /** Defines common settings for all stacked bar series. */ - stackedbar?: CommonSeriesConfig; - /** Defines common settings for all stacked line series. */ - stackedline?: CommonSeriesConfig; - /** Defines common settings for all stacked spline series. */ - stackedspline?: CommonSeriesConfig; - /** Defines common settings for all step area series. */ - steparea?: CommonSeriesConfig; - /** Defines common settings for all step line series. */ - stepline?: CommonSeriesConfig; - /** Defines common settings for all stock series. */ - stock?: CommonSeriesConfig; - /** Specifies the type of the series. */ - type?: string; - } - export interface SeriesConfig extends CommonSeriesConfig { - /** Specifies the name that identifies the series. */ - name?: string; - /** Specifies data about a series. */ - tag?: any; - /** Sets the series type. */ - type?: string; - } - /** An object that defines configuration options for polar chart series. */ - export interface CommonPolarSeriesConfig extends BaseCommonSeriesConfig { - /** Specifies whether or not to close the chart by joining the end point with the first point. */ - closed?: boolean; - label?: SeriesConfigLabel; - point?: PolarCommonPointOptions; - } - export interface CommonPolarSeriesSettings extends CommonPolarSeriesConfig { - /** An object that specifies configuration options for all series of the area type in the chart. */ - area?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _bar_ type in the chart. */ - bar?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _line_ type in the chart. */ - line?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _scatter_ type in the chart. */ - scatter?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedBar_ type in the chart. */ - stackedbar?: CommonPolarSeriesConfig; - /** Sets a series type. */ - type?: string; - } - export interface PolarSeriesConfig extends CommonPolarSeriesConfig { - /** Specifies the name that identifies the series. */ - name?: string; - /** Specifies data about a series. */ - tag?: any; - /** Sets the series type. */ - type?: string; - } - export interface PieSeriesConfigLabel extends BaseSeriesConfigLabel { - /** Specifies how to shift labels from their initial position in a radial direction in pixels. */ - radialOffset?: number; - /** - * Specifies a precision for the percentage values displayed in labels. - * @deprecated Use the series | label | format | percentPrecision instead. - */ - percentPrecision?: number; - } - /** An object that defines configuration options for chart series. */ - export interface CommonPieSeriesConfig { - /** Specifies the data source field that provides arguments for series points. */ - argumentField?: string; - /** Specifies the required type for series arguments. */ - argumentType?: string; - /** An object defining the series border configuration options. */ - border?: viz.core.DashedBorder; - /** Specifies a series color. */ - color?: string; - /** Specifies the chart elements to highlight when a series is hovered over. */ - hoverMode?: string; - /** An object defining configuration options for a hovered series. */ - hoverStyle?: { - /** An object defining the border options for a hovered series. */ - border?: viz.core.DashedBorder; - /** Sets a color for the series when it is hovered over. */ - color?: string; - /** Specifies the hatching options to be applied when a point is hovered over. */ - hatching?: viz.core.Hatching; - }; - /** - * Specifies the fraction of the inner radius relative to the total radius in the series of the 'doughnut' type. - * @deprecated Use the innerRadius option instead. - */ - innerRadius?: number; - /** An object defining the label configuration options. */ - label?: PieSeriesConfigLabel; - /** Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed. */ - maxLabelCount?: number; - /** Specifies a minimal size of a displayed pie segment. */ - minSegmentSize?: number; - /** - * Specifies the direction in which the dxPieChart series points are located. - * @deprecated Use the segmentsDirection option instead. - */ - segmentsDirection?: string; - /**

Specifies the chart elements to highlight when the series is selected.

*/ - selectionMode?: string; - /** An object defining configuration options for the series when it is selected. */ - selectionStyle?: { - /** An object defining the border options for a selected series. */ - border?: viz.core.DashedBorder; - /** Sets a color for a series when it is selected. */ - color?: string; - /** Specifies the hatching options to be applied when a point is selected. */ - hatching?: viz.core.Hatching; - }; - /** Specifies chart segment grouping options. */ - smallValuesGrouping?: { - /** Specifies the name of the grouped chart segment. This name represents the segment in the chart legend. */ - groupName?: string; - /** Specifies the segment grouping mode. */ - mode?: string; - /** Specifies a threshold for segment values. */ - threshold?: number; - /** Specifies how many segments must not be grouped. */ - topCount?: number; - }; - /** - * Specifies a start angle for a pie chart in arc degrees. - * @deprecated Use the startAngle option instead. - */ - startAngle?: number; - /**

Specifies the name of the data source field that provides data about a point.

*/ - tagField?: string; - /** Specifies the data source field that provides values for series points. */ - valueField?: string; - } - export interface CommonPieSeriesSettings extends CommonPieSeriesConfig { - /** - * Specifies the type of the pie chart series. - * @deprecated Use the type option instead. - */ - type?: string; - } - export interface PieSeriesConfig extends CommonPieSeriesConfig { - /** - * Sets the series type. - * @deprecated Use the type option instead. - */ - type?: string; - /** Specifies the name that identifies the series. */ - name?: string; - /** Specifies data about a series. */ - tag?: any; - } - export interface SeriesTemplate { - /** Specifies a callback function that returns a series object with individual series settings. */ - customizeSeries?: (seriesName: string) => SeriesConfig; - /** Specifies a data source field that represents the series name. */ - nameField?: string; - } - export interface PolarSeriesTemplate { - /** Specifies a callback function that returns a series object with individual series settings. */ - customizeSeries?: (seriesName: string) => PolarSeriesConfig; - /** Specifies a data source field that represents the series name. */ - nameField?: string; - } - export interface ChartCommonConstantLineLabel { - /** Specifies font options for constant line labels. */ - font?: viz.core.Font; - /** Specifies the position of constant line labels on the chart plot. */ - position?: string; - /** Makes constant line labels visible. */ - visible?: boolean; - } - export interface PolarCommonConstantLineLabel { - /** Indicates whether or not to display labels for the axis constant lines. */ - visible?: boolean; - /** Specifies font options for a constant line label. */ - font?: viz.core.Font; - } - export interface ConstantLineStyle { - /** Specifies a color for a constant line. */ - color?: string; - /** Specifies a dash style for a constant line. */ - dashStyle?: string; - /** Specifies a constant line width in pixels. */ - width?: number; - } - export interface ChartCommonConstantLineStyle extends ConstantLineStyle { - /** Configures constant line labels. */ - label?: ChartCommonConstantLineLabel; - /** Generates a pixel-measured empty space between the left/right side of a constant line and the constant line label. */ - paddingLeftRight?: number; - /** Generates a pixel-measured empty space between the top/bottom side of a constant line and the constant line label. */ - paddingTopBottom?: number; - } - export interface PolarCommonConstantLineStyle extends ConstantLineStyle { - /** An object defining constant line label options. */ - label?: PolarCommonConstantLineLabel; - } - export interface CommonAxisLabel { - /** Specifies font options for axis labels. */ - font?: viz.core.Font; - /** Specifies the spacing between an axis and its labels in pixels. */ - indentFromAxis?: number; - /** Indicates whether or not axis labels are visible. */ - visible?: boolean; - } - export interface ChartCommonAxisLabel extends CommonAxisLabel { - /** Aligns axis labels in relation to ticks. */ - alignment?: string; - /** Decides how to arrange axis labels when there is not enough space to keep all of them. */ - overlappingBehavior?: { - /** Decides how to arrange axis labels when there is not enough space to keep all of them. */ - mode?: string; - /** Specifies the rotation angle of axis labels. Applies only if the mode option is "rotate". */ - rotationAngle?: number; - /** Adds a pixel-measured empty space between two staggered rows of axis labels. Applies only if the mode option is "stagger". */ - staggeringSpacing?: number; - }; - } - export interface PolarCommonAxisLabel extends CommonAxisLabel { - /** Specifies the overlap resolving algorithm to be applied to axis labels. */ - overlappingBehavior?: string; - } - export interface CommonAxisTitle { - /** Specifies font options for the axis title. */ - font?: viz.core.Font; - /** Adds a pixel-measured empty space between the axis title and axis labels. */ - margin?: number; - } - export interface BaseCommonAxisSettings { - /** Specifies the color of the line that represents an axis. */ - color?: string; - /** Specifies whether ticks/grid lines of a discrete axis are located between labels or cross the labels. */ - discreteAxisDivisionMode?: string; - /** An object defining the configuration options for the grid lines of an axis in the dxPolarChart widget. */ - grid?: { - /** Specifies a color for grid lines. */ - color?: string; - /** Specifies an opacity for grid lines. */ - opacity?: number; - /** Indicates whether or not the grid lines of an axis are visible. */ - visible?: boolean; - /** Specifies the width of grid lines. */ - width?: number; - }; - /** Specifies the options of the minor grid. */ - minorGrid?: { - /** Specifies a color for the lines of the minor grid. */ - color?: string; - /** Specifies an opacity for the lines of the minor grid. */ - opacity?: number; - /** Indicates whether the minor grid is visible or not. */ - visible?: boolean; - /** Specifies a width for the lines of the minor grid. */ - width?: number; - }; - /** Indicates whether or not an axis is inverted. */ - inverted?: boolean; - /** Specifies the opacity of the line that represents an axis. */ - opacity?: number; - /** Indicates whether or not to set ticks/grid lines of a continuous axis of the 'date-time' type at the beginning of each date-time interval. */ - setTicksAtUnitBeginning?: boolean; - /** An object defining the configuration options for axis ticks. */ - tick?: { - /** Specifies ticks color. */ - color?: string; - /** Specifies tick opacity. */ - opacity?: number; - /** Indicates whether or not ticks are visible on an axis. */ - visible?: boolean; - /** Specifies tick width. */ - width?: number; - /** Specifies tick length. */ - length?: number; - }; - /** Specifies the options of the minor ticks. */ - minorTick?: { - /** Specifies a color for the minor ticks. */ - color?: string; - /** Specifies an opacity for the minor ticks. */ - opacity?: number; - /** Indicates whether or not the minor ticks are displayed on an axis. */ - visible?: boolean; - /** Specifies minor tick width. */ - width?: number; - /** Specifies minor tick length. */ - length?: number; - }; - /** Indicates whether or not the line that represents an axis in a chart is visible. */ - visible?: boolean; - /** Specifies the width of the line that represents an axis in the chart. */ - width?: number; - } - export interface ChartCommonAxisSettings extends BaseCommonAxisSettings { - /** Configures the appearance of all constant lines in the widget. */ - constantLineStyle?: ChartCommonConstantLineStyle; - /** Configures axis labels. */ - label?: ChartCommonAxisLabel; - /** Controls the empty space between the maximum series points and the axis. Applies only to the axes of the "continuous" and "logarithmic" type. */ - maxValueMargin?: number; - /** Controls the empty space between the minimum series points and the axis. Applies only to the axes of the "continuous" and "logarithmic" type. */ - minValueMargin?: number; - /** Reserves a pixel-measured space for the axis. */ - placeholderSize?: number; - /** Configures the appearance of strips. */ - stripStyle?: { - /** Configures the appearance of strip labels. */ - label?: { - /** Specifies font options for strip labels. */ - font?: viz.core.Font; - /** Aligns strip labels in the horizontal direction. */ - horizontalAlignment?: string; - /** Aligns strip labels in the vertical direction. */ - verticalAlignment?: string; - }; - /** Generates a pixel-measured empty space between the left/right border of a strip and the strip label. */ - paddingLeftRight?: number; - /** Generates a pixel-measured empty space between the top/bottom border of a strip and the strip label. */ - paddingTopBottom?: number; - }; - /** Configures axis titles. */ - title?: CommonAxisTitle; - /** Adds an empty space between the axis and the minimum and maximum series points. */ - valueMarginsEnabled?: boolean; - } - export interface PolarCommonAxisSettings extends BaseCommonAxisSettings { - /** Specifies the appearance of all the widget's constant lines. */ - constantLineStyle?: PolarCommonConstantLineStyle; - /** An object defining the label configuration options that are common for all axes in the dxPolarChart widget. */ - label?: PolarCommonAxisLabel; - /** An object defining configuration options for strip style. */ - stripStyle?: { - /** An object defining the configuration options for a strip label style. */ - label?: { - /** Specifies font options for a strip label. */ - font?: viz.core.Font; - }; - }; - } - export interface ChartConstantLineLabel extends ChartCommonConstantLineLabel { - /** Aligns constant line labels in the horizontal direction. */ - horizontalAlignment?: string; - /** Aligns constant line labels in the vertical direction. */ - verticalAlignment?: string; - /** Specifies the text of a constant line label. By default, equals to the value of the constant line. */ - text?: string; - } - export interface PolarConstantLineLabel extends PolarCommonConstantLineLabel { - /** Specifies the text to be displayed in a constant line label. */ - text?: string; - } - export interface AxisLabel { - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a label on the value axis. */ - customizeHint?: (argument: { value: any; valueText: string }) => string; - /** Specifies a callback function that returns the text to be displayed in value axis labels. */ - customizeText?: (argument: { value: any; valueText: string }) => string; - /** Specifies a format for the text displayed by axis labels. */ - format?: any; - /** - * Specifies a precision for the formatted value displayed in the axis labels. - * @deprecated Use the valueAxis | label | format | precision option instead. - */ - precision?: number; - } - export interface ChartAxisLabel extends ChartCommonAxisLabel, AxisLabel { } - export interface PolarAxisLabel extends PolarCommonAxisLabel, AxisLabel { } - export interface AxisTitle extends CommonAxisTitle { - /** Specifies the text of the axis title. */ - text?: string; - } - export interface ChartConstantLineStyle extends ChartCommonConstantLineStyle { - /** Specifies the appearance of the labels of those constant lines that belong to the value axis. */ - label?: ChartConstantLineLabel; - } - export interface ChartConstantLine extends ChartConstantLineStyle { - /** Configures the constant line label. */ - label?: ChartConstantLineLabel; - /** Specifies the value indicated by a constant line. Setting this option is necessary. */ - value?: any; - } - export interface PolarConstantLine extends PolarCommonConstantLineStyle { - /** An object defining constant line label options. */ - label?: PolarConstantLineLabel; - /** Specifies a value to be displayed by a constant line. */ - value?: any; - } - export interface Axis { - /** Specifies a coefficient for dividing the value axis. */ - axisDivisionFactor?: number; - /** Specifies the order in which discrete values are arranged on the value axis. */ - categories?: Array; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic axis. */ - logarithmBase?: number; - /** Specifies an interval between axis ticks/grid lines. */ - tickInterval?: any; - /** Specifies the interval between minor ticks. */ - minorTickInterval?: any; - /** Specifies the number of minor ticks between two neighboring major ticks. */ - minorTickCount?: number; - /** Specifies the required type of the value axis. */ - type?: string; - /** Binds the value axis to a pane. */ - pane?: string; - /** Specifies options for value axis strips. */ - strips?: Array; - } - export interface ChartAxis extends ChartCommonAxisSettings, Axis { - /** Declares a collection of constant lines belonging to the value axis. */ - constantLines?: Array; - /** Specifies the appearance of those constant lines that belong to the value axis. */ - constantLineStyle?: ChartCommonConstantLineStyle; - /** Configures the labels of the value axis. */ - label?: ChartAxisLabel; - /** Coupled with the min option, focuses the widget on a specific chart segment. Applies only to the axes of the "continuous" and "logarithmic" type. */ - max?: any; - /** Coupled with the max option, focuses the widget on a specific chart segment. Applies only to the axes of the "continuous" and "logarithmic" type. */ - min?: any; - /** Relocates the value axis. */ - position?: string; - /** Configures the axis title. */ - title?: any; - } - export interface PolarAxis extends PolarCommonAxisSettings, Axis { - /** Defines an array of the value axis constant lines. */ - constantLines?: Array; - /** Specifies options for value axis labels. */ - label?: PolarAxisLabel; - } - export interface ArgumentAxis { - /** Specifies the desired type of axis values. */ - argumentType?: string; - /** Specifies the elements that will be highlighted when the argument axis is hovered over. */ - hoverMode?: string; - } - export interface ChartArgumentAxis extends ChartAxis, ArgumentAxis { } - export interface PolarArgumentAxis extends PolarAxis, ArgumentAxis { - /** Specifies the angle in arc degrees to which the argument axis should be rotated. The positive values rotate the axis clockwise. */ - startAngle?: number; - /** Specifies whether or not to display the first point at the angle specified by the startAngle option. */ - firstPointOnStartAngle?: boolean; - /** Specifies the value to be used as the origin for the argument axis. */ - originValue?: number; - /** Specifies the period of the argument values in the data source. */ - period?: number; - } - export interface ValueAxis { - /** Specifies the name of the value axis. */ - name?: string; - /** Specifies whether or not to indicate a zero value on the value axis. */ - showZero?: boolean; - /** Specifies the desired type of axis values. */ - valueType?: string; - } - export interface ChartValueAxis extends ChartAxis, ValueAxis { - /** Adds a pixel-measured empty space between two side-by-side value axes. Applies if several value axes are located on one side of the chart. */ - multipleAxesSpacing?: number; - /** Synchronizes two or more value axes with each other at a specific value. */ - synchronizedValue?: number; - } - export interface PolarValueAxis extends PolarAxis, ValueAxis { - /** Indicates whether to display series with indents from axis boundaries. */ - valueMarginsEnabled?: boolean; - /** Specifies a coefficient that determines the spacing between the maximum series point and the axis. */ - maxValueMargin?: number; - /** Specifies a coefficient that determines the spacing between the minimum series point and the axis. */ - minValueMargin?: number; - tick?: { - visible?: boolean; - } - } - export interface CommonPane { - /** Specifies the color of the pane's background. */ - backgroundColor?: string; - /** Configures the pane border. */ - border?: PaneBorder; - } - export interface Pane extends CommonPane { - /** Specifies the name of the pane. */ - name?: string; - } - export interface PaneBorder extends viz.core.DashedBorderWithOpacity { - /** Shows/hides the bottom border of the pane. Applies only when the border | visible option is true. */ - bottom?: boolean; - /** Shows/hides the left border of the pane. Applies only when the border | visible option is true. */ - left?: boolean; - /** Shows/hides the right border of the pane. Applies only when the border | visible option is true. */ - right?: boolean; - /** Shows/hides the top border of the pane. Applies only when the border | visible option is true. */ - top?: boolean; - } - export interface ChartAnimation extends viz.core.Animation { - /** Specifies how many series points the widget should have before the animation will be disabled. */ - maxPointCountSupported?: number; - } - export interface BaseChartTooltip extends viz.core.Tooltip { - /** Specifies a format for arguments of the chart's series points. */ - argumentFormat?: any; - /** - * Specifies a precision for formatted arguments displayed in tooltips. - * @deprecated Use the tooltip | argumentFormat | precision option instead. - */ - argumentPrecision?: number; - /** - * Specifies a precision for a percent value displayed in tooltips for stacked series and dxPieChart series. - * @deprecated Use the tooltip | format | percentPrecision option instead. - */ - percentPrecision?: number; - } - export interface BaseChartOptions extends viz.core.BaseWidgetOptions, viz.core.MarginOptions, viz.core.RedrawOnResizeOptions, viz.core.TitleOptions, viz.core.LoadingIndicatorOptions, viz.core.ExportOptions { - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - /** Specifies the widget's width small enough for the layout to begin adapting. */ - width?: number; - /** Specifies the widget's height small enough for the layout to begin adapting. */ - height?: number; - /** Specifies whether or not point labels should be kept when the layout is adapting. */ - keepLabels?: boolean; - }; - /** Specifies animation options. */ - animation?: ChartAnimation; - /** Customizes the appearance of an individual point label. */ - customizeLabel?: (pointInfo: Object) => Object; - /** Customizes the appearance of an individual series point. */ - customizePoint?: (pointInfo: Object) => Object; - /** Specifies the origin of data for the widget. */ - dataSource?: any; - /** Specifies options of a dxChart's (dxPieChart's) legend. */ - legend?: core.BaseLegend; - /** Sets the name of the palette to be used in the chart. Alternatively, an array of colors can be set as a custom palette to be used within this chart. */ - palette?: any; - /** A handler for the done event. */ - onDone?: (e: { - component: BaseChart; - element: Element; - }) => void; - /** A handler for the pointClick event. */ - onPointClick?: any; - /** A handler for the pointHoverChanged event. */ - onPointHoverChanged?: (e: { - component: BaseChart; - element: Element; - target: TPoint; - }) => void; - /** A handler for the pointSelectionChanged event. */ - onPointSelectionChanged?: (e: { - component: BaseChart; - element: Element; - target: TPoint; - }) => void; - /** Specifies whether a single point or multiple points can be selected in the chart. */ - pointSelectionMode?: string; - /** Specifies options for the dxChart and dxPieChart widget series. */ - series?: any; - /** Configures tooltips. */ - tooltip?: BaseChartTooltip; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: BaseChart; - element: Element; - target: BasePoint; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: BaseChart; - element: Element; - target: BasePoint; - }) => void; - } - /** A base class for all chart widgets included in the ChartJS library. */ - export class BaseChart extends viz.core.BaseWidget implements viz.core.LoadingIndicatorMethods { - /** Deselects the chart's selected series. The series is displayed in an initial style. */ - clearSelection(): void; - /** Gets the current size of the widget. */ - getSize(): { width: number; height: number }; - /** Returns an array of all series in the chart. */ - getAllSeries(): Array; - /** Gets a series within the chart's series collection by the specified name (see the name option). */ - getSeriesByName(seriesName: string): BaseSeries; - /** Gets a series within the chart's series collection by its position number. */ - getSeriesByPos(seriesIndex: number): BaseSeries; - /** Hides all widget tooltips. */ - hideTooltip(): void; - showLoadingIndicator(): void; - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(renderOptions?: { - force?: boolean; - animate?: boolean; - asyncSeriesRendering?: boolean; - }): void; - } - export interface AdvancedLegend extends core.BaseLegend { - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item. */ - customizeHint?: (seriesInfo: { seriesName: string; seriesIndex: number; seriesColor: string; }) => string; - /**

Specifies a callback function that returns the text to be displayed by legend items.

*/ - customizeText?: (seriesInfo: { seriesName: string; seriesIndex: number; seriesColor: string; }) => string; - /** Specifies what series elements to highlight when a corresponding item in the legend is hovered over. */ - hoverMode?: string; - } - export interface AdvancedOptions extends BaseChartOptions { - /** A handler for the argumentAxisClick event. */ - onArgumentAxisClick?: any; - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** An object providing options for managing data from a data source. */ - dataPrepareSettings?: { - /** Specifies whether or not to validate the values from a data source. */ - checkTypeForAllData?: boolean; - /** Specifies whether or not to convert the values from a data source into the data type of an axis. */ - convertToAxisDataType?: boolean; - /** Specifies how to sort the series points. */ - sortingMethod?: any; - }; - /** A handler for the legendClick event. */ - onLegendClick?: any; - /** A handler for the seriesClick event. */ - onSeriesClick?: any; - /** A handler for the seriesHoverChanged event. */ - onSeriesHoverChanged?: (e: { - component: BaseChart; - element: Element; - target: TSeries; - }) => void; - /** A handler for the seriesSelectionChanged event. */ - onSeriesSelectionChanged?: (e: { - component: BaseChart; - element: Element; - target: TSeries; - }) => void; - /** Specifies whether a single series or multiple series can be selected in the chart. */ - seriesSelectionMode?: string; - /** Specifies how the chart must behave when series point labels overlap. */ - resolveLabelOverlapping?: string; - /** Specifies whether or not all bars in a series must have the same angle, or may have different angles if any points in other series are missing. */ - equalBarWidth?: boolean; - /** Specifies a common bar width as a percentage from 0 to 1. */ - barWidth?: number; - /** Forces the widget to treat negative values as zeroes. Applies to stacked-like series only. */ - negativesAsZeroes?: boolean; - } - export interface Legend extends AdvancedLegend { - /** Specifies whether the legend is located outside or inside the chart's plot. */ - position?: string; - } - export interface ChartTooltip extends BaseChartTooltip { - /** Specifies whether the tooltip must be located in the center of a series point or on its edge. Applies to bar-like and bubble series only. */ - location?: string; - /** Specifies the kind of information to display in a tooltip. */ - shared?: boolean; - } - export interface dxChartOptions extends AdvancedOptions { - /** Indicates whether or not to synchronize value axes when they are displayed on a single pane. */ - synchronizeMultiAxes?: boolean; - /** Specifies whether or not to filter the series points depending on their quantity. */ - useAggregation?: boolean; - /** Specifies whether or not to adjust the value axis when zooming the widget. */ - adjustOnZoom?: boolean; - /** Configures the argument axis. */ - argumentAxis?: ChartArgumentAxis; - /** Defines common settings for both the argument and value axis in a chart. */ - commonAxisSettings?: ChartCommonAxisSettings; - /** Defines common settings for all panes in a chart. */ - commonPaneSettings?: CommonPane; - /** Specifies settings common for all series in the chart. */ - commonSeriesSettings?: CommonSeriesSettings; - /** Configures the crosshair feature. */ - crosshair?: { - /** Specifies the color of the crosshair lines. */ - color?: string; - /** Specifies the dash style of the crosshair lines. */ - dashStyle?: string; - /** Enables the crosshair. */ - enabled?: boolean; - /** Specifies how transparent the crosshair lines should be. */ - opacity?: number; - /** Specifies the width of the crosshair lines. */ - width?: number; - /** Configures the horizontal crosshair line individually. */ - horizontalLine?: CrosshaierWithLabel; - /** Configures the vertical crosshair line individually. */ - verticalLine?: CrosshaierWithLabel; - /** Configures the crosshair labels. */ - label?: { - /** Paints the background of the crosshair labels. */ - backgroundColor?: string; - /** Makes the crosshair labels visible. Applies only if the crosshair feature is enabled. */ - visible?: boolean; - /** Specifies font options for the crosshair labels. */ - font?: viz.core.Font; - /** Formats the point value/argument before it will be displayed in the crosshair label. */ - format?: any; - /** - * Specifies a precision for formatted values. - * @deprecated Use the crosshair | label | format | precision option instead. - */ - precision?: number; - /** Customizes the text displayed by the crosshair labels. */ - customizeText?: (info: { value: any; valueText: string; point: ChartPoint; }) => string; - } - }; - /** Specifies which pane should be used by default. */ - defaultPane?: string; - /** Specifies a coefficient determining the diameter of the largest bubble. */ - maxBubbleSize?: number; - /** Specifies the diameter of the smallest bubble measured in pixels. */ - minBubbleSize?: number; - /** Declares a collection of panes. */ - panes?: Array; - /** Swaps the axes around making the value axis horizontal and the argument axis vertical. */ - rotated?: boolean; - /** Specifies the options of a chart's legend. */ - legend?: Legend; - onZoomStart?: (e: { - component: BaseChart; - element: Element; - }) => void; - onZoomEnd?: (e: { - component: BaseChart; - element: Element; - rangeStart: any; - rangeEnd: any; - }) => void; - /** Specifies options for dxChart widget series. */ - series?: Array; - /** Defines options for the series template. */ - seriesTemplate?: SeriesTemplate; - tooltip?: ChartTooltip; - /** Configures the value axis. */ - valueAxis?: Array; - /** Enables scrolling in your chart. */ - scrollingMode?: string; - /** Enables zooming in your chart. */ - zoomingMode?: string; - /** Specifies the settings of the scroll bar. */ - scrollBar?: { - /** Specifies whether the scroll bar is visible or not. */ - visible?: boolean; - /** Specifies the spacing between the scroll bar and the chart's plot in pixels. */ - offset?: number; - /** Specifies the color of the scroll bar. */ - color?: string; - /** Specifies the width of the scroll bar in pixels. */ - width?: number; - /** Specifies the opacity of the scroll bar. */ - opacity?: number; - /** Specifies the position of the scroll bar in the chart. */ - position?: string; - }; - } - interface CrosshaierWithLabel extends viz.core.DashedBorderWithOpacity { - /** Configures the label that belongs to the horizontal crosshair line. */ - label?: { - /** Paints the background of the label that belongs to the horizontal crosshair line. */ - backgroundColor?: string; - /** Makes the label of the horizontal crosshair line visible. Applies only if the crosshair feature is enabled and the horizontal line is visible. */ - visible?: boolean; - /** Specifies font options for the label of the horizontal crosshair line. */ - font?: viz.core.Font; - /** Formats the point value before it will be displayed in the crosshair label. */ - format?: any; - /** - * Specifies a precision for formatted values. - * @deprecated Use the crosshair | horizontalLine | label | format | precision option instead. - */ - precision?: number; - /** Customizes the text displayed by the label that belongs to the horizontal crosshair line. */ - customizeText?: (info: { value: any; valueText: string; point: ChartPoint; }) => string; - } - } - export interface PolarChartTooltip extends BaseChartTooltip { - /** Specifies the kind of information to display in a tooltip. */ - shared?: boolean; - } - export interface dxPolarChartOptions extends AdvancedOptions { - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - width?: number; - height?: number; - }; - /** Indicates whether or not to display a "spider web". */ - useSpiderWeb?: boolean; - /** Specifies argument axis options for the dxPolarChart widget. */ - argumentAxis?: PolarArgumentAxis; - /** An object defining the configuration options that are common for all axes of the dxPolarChart widget. */ - commonAxisSettings?: PolarCommonAxisSettings; - /** An object defining the configuration options that are common for all series of the dxPolarChart widget. */ - commonSeriesSettings?: CommonPolarSeriesSettings; - /** Specifies the options of a chart's legend. */ - legend?: AdvancedLegend; - /** Specifies options for dxPolarChart widget series. */ - series?: Array; - /** Defines options for the series template. */ - seriesTemplate?: PolarSeriesTemplate; - tooltip?: PolarChartTooltip; - /** Specifies value axis options for the dxPolarChart widget. */ - valueAxis?: PolarValueAxis; - } - export interface PieLegend extends core.BaseLegend { - /** Specifies what chart elements to highlight when a corresponding item in the legend is hovered over. */ - hoverMode?: string; - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item. */ - customizeHint?: (pointInfo: { pointName: string; pointIndex: number; pointColor: string; }) => string; - /** Specifies a callback function that returns the text to be displayed by a legend item. */ - customizeText?: (pointInfo: { pointName: string; pointIndex: number; pointColor: string; }) => string; - } - export interface dxPieChartOptions extends BaseChartOptions { - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - keepLabels?: boolean; - }; - /** Specifies dxPieChart legend options. */ - legend?: PieLegend; - /** Specifies options for the series of the dxPieChart widget. */ - series?: Array; - /** Specifies the diameter of the pie. */ - diameter?: number; - /** Specifies the direction that the pie chart segments will occupy. */ - segmentsDirection?: string; - /** Specifies the angle in arc degrees from which the first segment of a pie chart should start. */ - startAngle?: number; - /** Specifies the fraction of the inner radius relative to the total radius in the series of the 'doughnut' type. The value should be between 0 and 1. */ - innerRadius?: number; - /** A handler for the legendClick event. */ - onLegendClick?: any; - /** Specifies how a chart must behave when series point labels overlap. */ - resolveLabelOverlapping?: string; - /** An object defining the configuration options that are common for all series of the dxPieChart widget. */ - commonSeriesSettings?: CommonPieSeriesSettings; - /** Specifies the type of the pie chart series. */ - type?: string; - } -} -declare module DevExpress.viz { - /** A widget providing charts of various types for web applications. */ - export class dxChart extends DevExpress.viz.charts.BaseChart { - constructor(element: JQuery, options?: DevExpress.viz.charts.dxChartOptions); - constructor(element: Element, options?: DevExpress.viz.charts.dxChartOptions); - /** Sets the specified start and end values for the chart's argument axis. */ - zoomArgument(startValue: any, endValue: any): void; - } - /** A circular chart widget for web applications. */ - export class dxPieChart extends DevExpress.viz.charts.BaseChart { - constructor(element: JQuery, options?: DevExpress.viz.charts.dxPieChartOptions); - constructor(element: Element, options?: DevExpress.viz.charts.dxPieChartOptions); - /** - * Provides access to the dxPieChart series. - * @deprecated Use the getAllSeries() method instead. - */ - getSeries(): DevExpress.viz.charts.PieSeries; - } - /** A chart widget displaying data in a polar coordinate system. */ - export class dxPolarChart extends DevExpress.viz.charts.BaseChart { - constructor(element: JQuery, options?: DevExpress.viz.charts.dxPolarChartOptions); - constructor(element: Element, options?: DevExpress.viz.charts.dxPolarChartOptions); - } -} -interface JQuery { - dxChart(options?: DevExpress.viz.charts.dxChartOptions): JQuery; - dxChart(methodName: string, ...params: any[]): any; - dxChart(methodName: "instance"): DevExpress.viz.dxChart; - dxPieChart(options?: DevExpress.viz.charts.dxPieChartOptions): JQuery; - dxPieChart(methodName: string, ...params: any[]): any; - dxPieChart(methodName: "instance"): DevExpress.viz.dxPieChart; - dxPolarChart(options?: DevExpress.viz.charts.dxPolarChartOptions): JQuery; - dxPolarChart(methodName: string, ...params: any[]): any; - dxPolarChart(methodName: "instance"): DevExpress.viz.dxPolarChart; -} -declare module DevExpress.viz.gauges { - export interface BaseRangeContainer { - /** Specifies a range container's background color. */ - backgroundColor?: string; - /** Specifies the offset of the range container from an invisible scale line in pixels. */ - offset?: number; - /** Sets the name of the palette or an array of colors to be used for coloring the gauge range container. */ - palette?: any; - /** An array of objects representing ranges contained in the range container. */ - ranges?: Array<{ startValue: number; endValue: number; color: string }>; - /** Specifies a color of a range. */ - color?: string; - /** Specifies an end value of a range. */ - endValue?: number; - /** Specifies a start value of a range. */ - startValue?: number; - } - export interface ScaleTick { - /** Specifies the color of the scale's minor ticks. */ - color?: string; - /** - * Specifies an array of custom minor ticks. - * @deprecated Use the scale | customMinorTicks option instead. - */ - customTickValues?: Array; - /** Specifies the length of the scale's minor ticks. */ - length?: number; - /** - * Indicates whether automatically calculated minor ticks are visible or not. - * @deprecated This feature is no longer available. - */ - showCalculatedTicks?: boolean; - /** - * Specifies an interval between minor ticks. - * @deprecated Use the scale | minorTickInterval option instead. - */ - tickInterval?: number; - /** Indicates whether scale minor ticks are visible or not. */ - visible?: boolean; - /** Specifies the width of the scale's minor ticks. */ - width?: number; - } - export interface ScaleMajorTick extends ScaleTick { - /** - * Specifies whether or not to expand the current major tick interval if labels overlap each other. - * @deprecated Use the overlappingBehavior | useAutoArrangement option instead. - */ - useTicksAutoArrangement?: boolean; - } - export interface ScaleMinorTick extends ScaleTick { - /** Specifies the opacity of the scale's minor ticks. */ - opacity?: number; - } - export interface BaseScaleLabel { - /** Specifies whether or not scale labels should be colored similarly to their corresponding ranges in the range container. */ - useRangeColors?: boolean; - /** Specifies a callback function that returns the text to be displayed in scale labels. */ - customizeText?: (scaleValue: { value: number; valueText: string }) => string; - /** Specifies the overlap resolving options to be applied to scale labels. */ - overlappingBehavior?: { - /** Specifies whether or not to expand the current major tick interval if labels overlap each other. */ - useAutoArrangement?: boolean; - /** Specifies what label to hide in case of overlapping. */ - hideFirstOrLast?: string; - }; - /** Specifies font options for the text displayed in the scale labels of the gauge. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in scale labels. */ - format?: any; - /** - * Specifies a precision for the formatted value displayed in the scale labels. - * @deprecated Use the scale | label | format | precision option instead. - */ - precision?: number; - /** Specifies whether or not scale labels are visible on the gauge. */ - visible?: boolean; - } - export interface BaseScale { - /** Specifies the end value for the scale of the gauge. */ - endValue?: number; - /** - * Specifies whether or not to hide the first scale label. - * @deprecated This feature is no longer available. - */ - hideFirstLabel?: boolean; - /** - * Specifies whether or not to hide the first major tick on the scale. - * @deprecated This feature is no longer available. - */ - hideFirstTick?: boolean; - /** - * Specifies whether or not to hide the last scale label. - * @deprecated This feature is no longer available. - */ - hideLastLabel?: boolean; - /** - * Specifies whether or not to hide the last major tick on the scale. - * @deprecated This feature is no longer available. - */ - hideLastTick?: boolean; - /** Specifies an interval between major ticks. */ - tickInterval?: number; - /** Specifies an interval between minor ticks. */ - minorTickInterval?: number; - /** Specifies an array of custom major ticks. */ - customTicks?: Array; - /** Specifies an array of custom minor ticks. */ - customMinorTicks?: Array; - /** Specifies common options for scale labels. */ - label?: BaseScaleLabel; - /** - * Specifies options of the gauge's major ticks. - * @deprecated Use the tick option instead. - */ - majorTick?: ScaleMajorTick; - /** Specifies options of the gauge's major ticks. */ - tick?: { - /** Specifies the color of the scale's major ticks. */ - color?: string; - /** Specifies the length of the scale's major ticks. */ - length?: number; - /** Indicates whether scale major ticks are visible or not. */ - visible?: boolean; - /** Specifies the width of the scale's major ticks. */ - width?: number; - /** Specifies the opacity of the scale's major ticks. */ - opacity?: number; - }; - /** Specifies options of the gauge's minor ticks. */ - minorTick?: ScaleMinorTick; - /** Specifies the start value for the scale of the gauge. */ - startValue?: number; - } - export interface BaseValueIndicator { - /** Specifies the type of subvalue indicators. */ - type?: string; - /** Specifies the background color for the indicator of the rangeBar type. */ - backgroundColor?: string; - /** Specifies the base value for the indicator of the rangeBar type. */ - baseValue?: number; - /** Specifies a color of the indicator. */ - color?: string; - /** Specifies the range bar size for an indicator of the rangeBar type. */ - size?: number; - text?: { - /** Specifies a callback function that returns the text to be displayed in an indicator. */ - customizeText?: (indicatedValue: { value: number; valueText: string }) => string; - font?: viz.core.Font; - /** Specifies a format for the text displayed in an indicator. */ - format?: any; - /** Specifies the range bar's label indent in pixels. */ - indent?: number; - /** - * Specifies a precision for the formatted value displayed by an indicator. - * @deprecated Use the text | format | precision option instead. - */ - precision?: number; - }; - offset?: number; - length?: number; - width?: number; - /** Specifies the length of an arrow for the indicator of the textCloud type in pixels. */ - arrowLength?: number; - /** Sets the array of colors to be used for coloring subvalue indicators. */ - palette?: any; - /** Specifies the distance between the needle and the center of a gauge for the indicator of a needle-like type. */ - indentFromCenter?: number; - /** Specifies the second color for the indicator of the twoColorNeedle type. */ - secondColor?: string; - /** Specifies the length of a twoNeedleColor type indicator tip as a percentage. */ - secondFraction?: number; - /** Specifies the spindle's diameter in pixels for the indicator of a needle-like type. */ - spindleSize?: number; - /** Specifies the inner diameter in pixels, so that the spindle has the shape of a ring. */ - spindleGapSize?: number; - /** Specifies the orientation of the rangeBar indicator on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - /** Specifies the orientation of the rangeBar indicator on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - } - export interface SharedGaugeOptions extends viz.core.MarginOptions, viz.core.RedrawOnResizeOptions, viz.core.TitleOptions, viz.core.LoadingIndicatorOptions, viz.core.ExportOptions { - /** Specifies animation options. */ - animation?: viz.core.Animation; - /** - * Specifies a subtitle for the widget. - * @deprecated Use the title | subtitle option instead. - */ - subtitle?: { - /** - * Specifies font options for the subtitle. - * @deprecated Use the title | subtitle | font option instead. - */ - font?: viz.core.Font; - /** - * Specifies a text for the subtitle. - * @deprecated Use the title | subtitle | text option instead. - */ - text?: string; - }; - /** Configures tooltips. */ - tooltip?: viz.core.Tooltip; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: dxBaseGauge; - element: Element; - target: {}; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: dxBaseGauge; - element: Element; - target: {}; - }) => void; - } - export interface BaseGaugeOptions extends viz.core.BaseWidgetOptions, SharedGaugeOptions { - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** Specifies options of the gauge's range container. */ - rangeContainer?: BaseRangeContainer; - /** Specifies a gauge's scale options. */ - scale?: BaseScale; - /** Specifies the appearance options of subvalue indicators. */ - subvalueIndicator?: BaseValueIndicator; - /** Specifies a set of subvalues to be designated by the subvalue indicators. */ - subvalues?: Array; - /** Specifies the main value on a gauge. */ - value?: number; - /** Specifies the appearance options of the value indicator. */ - valueIndicator?: BaseValueIndicator; - } - /** A gauge widget. */ - export class dxBaseGauge extends viz.core.BaseWidget implements viz.core.LoadingIndicatorMethods { - showLoadingIndicator(): void; - hideLoadingIndicator(): void; - /** Returns the main gauge value. */ - value(): number; - /** Updates a gauge value. */ - value(value: number): void; - /** Returns an array of gauge subvalues. */ - subvalues(): Array; - /** Updates gauge subvalues. */ - subvalues(subvalues: Array): void; - } - export interface LinearRangeContainer extends BaseRangeContainer { - /** Specifies the orientation of the range container on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - /** Specifies the orientation of a range container on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - /** Specifies the width of the range container's start and end boundaries in the dxLinearGauge widget. */ - width?: any; - /** Specifies an end width of a range container. */ - end?: number; - /** Specifies a start width of a range container. */ - start?: number; - } - export interface LinearScaleLabel extends BaseScaleLabel { - /** Specifies the spacing between scale labels and ticks. */ - indentFromTick?: number; - } - export interface LinearScale extends BaseScale { - /** Specifies the orientation of scale ticks on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - label?: LinearScaleLabel; - /** Specifies the orientation of scale ticks on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - } - export interface dxLinearGaugeOptions extends BaseGaugeOptions { - /** Specifies the options required to set the geometry of the dxLinearGauge widget. */ - geometry?: { - /** Indicates whether to display the dxLinearGauge widget vertically or horizontally. */ - orientation?: string; - }; - /** Specifies gauge range container options. */ - rangeContainer?: LinearRangeContainer; - scale?: LinearScale; - } - export interface CircularRangeContainer extends BaseRangeContainer { - /** Specifies the orientation of the range container in the dxCircularGauge widget. */ - orientation?: string; - /** Specifies the range container's width in pixels. */ - width?: number; - } - export interface CircularScaleLabel extends BaseScaleLabel { - /** Specifies the spacing between scale labels and ticks. */ - indentFromTick?: number; - } - export interface CircularScale extends BaseScale { - label?: CircularScaleLabel; - /** Specifies the orientation of scale ticks. */ - orientation?: string; - } - export interface dxCircularGaugeOptions extends BaseGaugeOptions { - /** Specifies the options required to set the geometry of the dxCircularGauge widget. */ - geometry?: { - /** Specifies the end angle of the circular gauge's arc. */ - endAngle?: number; - /** Specifies the start angle of the circular gauge's arc. */ - startAngle?: number; - }; - /** Specifies gauge range container options. */ - rangeContainer?: CircularRangeContainer; - scale?: CircularScale; - } - export interface dxBarGaugeOptions extends viz.core.BaseWidgetOptions, SharedGaugeOptions { - /** Specifies a color for the remaining segment of the bar's track. */ - backgroundColor?: string; - /** Specifies a distance between bars in pixels. */ - barSpacing?: number; - /** Specifies a base value for bars. */ - baseValue?: number; - /** Specifies an end value for the gauge's invisible scale. */ - endValue?: number; - /** Defines the shape of the gauge's arc. */ - geometry?: { - /** Specifies the end angle of the bar gauge's arc. */ - endAngle?: number; - /** Specifies the start angle of the bar gauge's arc. */ - startAngle?: number; - }; - /** Specifies the options of the labels that accompany gauge bars. */ - label?: { - /** Specifies a color for the label connector text. */ - connectorColor?: string; - /** Specifies the width of the label connector in pixels. */ - connectorWidth?: number; - /** Specifies a callback function that returns a text for labels. */ - customizeText?: (barValue: { value: number; valueText: string }) => string; - /** Specifies font options for bar labels. */ - font?: viz.core.Font; - /** Specifies a format for bar labels. */ - format?: any; - /** Specifies the distance between the upper bar and bar labels in pixels. */ - indent?: number; - /** - * Specifies a precision for the formatted value displayed by labels. - * @deprecated Use the label | format | precision option instead. - */ - precision?: number; - /** Specifies whether bar labels appear on a gauge or not. */ - visible?: boolean; - }; - /** Sets the name of the palette or an array of colors to be used for coloring the gauge range container. */ - palette?: any; - /** Defines the radius of the bar that is closest to the center relatively to the radius of the topmost bar. */ - relativeInnerRadius?: number; - /** Specifies a start value for the gauge's invisible scale. */ - startValue?: number; - /** Specifies the array of values to be indicated on a bar gauge. */ - values?: Array; - } -} -declare module DevExpress.viz { - /** A widget that represents a gauge with a linear scale. */ - export class dxLinearGauge extends DevExpress.viz.gauges.dxBaseGauge { - constructor(element: JQuery, options?: DevExpress.viz.gauges.dxLinearGaugeOptions); - constructor(element: Element, options?: DevExpress.viz.gauges.dxLinearGaugeOptions); - } - /** A widget that represents a gauge with a circular scale. */ - export class dxCircularGauge extends DevExpress.viz.gauges.dxBaseGauge { - constructor(element: JQuery, options?: DevExpress.viz.gauges.dxCircularGaugeOptions); - constructor(element: Element, options?: DevExpress.viz.gauges.dxCircularGaugeOptions); - } - /** A circular bar widget. */ - export class dxBarGauge extends viz.core.BaseWidget implements viz.core.LoadingIndicatorMethods { - constructor(element: JQuery, options?: DevExpress.viz.gauges.dxBarGaugeOptions); - constructor(element: Element, options?: DevExpress.viz.gauges.dxBarGaugeOptions); - showLoadingIndicator(): void; - hideLoadingIndicator(): void; - /** Returns an array of gauge values. */ - values(): Array; - /** Updates the values displayed by a gauge. */ - values(values: Array): void; - } -} -interface JQuery { - dxLinearGauge(options?: DevExpress.viz.gauges.dxLinearGaugeOptions): JQuery; - dxLinearGauge(methodName: string, ...params: any[]): any; - dxLinearGauge(methodName: "instance"): DevExpress.viz.dxLinearGauge; - dxCircularGauge(options?: DevExpress.viz.gauges.dxCircularGaugeOptions): JQuery; - dxCircularGauge(methodName: string, ...params: any[]): any; - dxCircularGauge(methodName: "instance"): DevExpress.viz.dxCircularGauge; - dxBarGauge(options?: DevExpress.viz.gauges.dxBarGaugeOptions): JQuery; - dxBarGauge(methodName: string, ...params: any[]): any; - dxBarGauge(methodName: "instance"): DevExpress.viz.dxBarGauge; -} -declare module DevExpress.viz.rangeSelector { - export interface dxRangeSelectorOptions extends viz.core.BaseWidgetOptions, viz.core.MarginOptions, viz.core.RedrawOnResizeOptions, viz.core.TitleOptions, viz.core.LoadingIndicatorOptions, viz.core.ExportOptions { - /** Specifies the options for the range selector's background. */ - background?: { - /** Specifies the background color for the dxRangeSelector. */ - color?: string; - /** Specifies image options. */ - image?: { - /** Specifies a location for the image in the background of a range selector. */ - location?: string; - /** Specifies the image's URL. */ - url?: string; - }; - /** Indicates whether or not the background (background color and/or image) is visible. */ - visible?: boolean; - }; - /** Specifies the dxRangeSelector's behavior options. */ - behavior?: { - /** Indicates whether or not you can swap sliders. */ - allowSlidersSwap?: boolean; - /** Indicates whether or not animation is enabled. */ - animationEnabled?: boolean; - /** Specifies when to call the onSelectedRangeChanged function. */ - callSelectedRangeChanged?: string; - /** Indicates whether or not an end user can specify the range using a mouse, without the use of sliders. */ - manualRangeSelectionEnabled?: boolean; - /** Indicates whether or not an end user can shift the selected range to the required location on a scale by clicking. */ - moveSelectedRangeByClick?: boolean; - /** Indicates whether to snap a slider to ticks. */ - snapToTicks?: boolean; - }; - /** Specifies the options required to display a chart as the range selector's background. */ - chart?: { - /** Specifies a coefficient for determining an indent from the bottom background boundary to the lowest chart point. */ - bottomIndent?: number; - /** An object defining the common configuration options for the chart’s series. */ - commonSeriesSettings?: viz.charts.CommonSeriesSettings; - /** An object providing options for managing data from a data source. */ - dataPrepareSettings?: { - /** Specifies whether or not to validate values from a data source. */ - checkTypeForAllData?: boolean; - /** Specifies whether or not to convert the values from a data source into the data type of an axis. */ - convertToAxisDataType?: boolean; - /** Specifies how to sort series points. */ - sortingMethod?: any; - }; - /** Specifies whether all bars in a series must have the same width, or may have different widths if any points in other series are missing. */ - equalBarWidth?: boolean; - /** Specifies a common bar width as a percentage from 0 to 1. */ - barWidth?: number; - /** Forces the widget to treat negative values as zeroes. Applies to stacked-like series only. */ - negativesAsZeroes?: boolean; - /** Sets the name of the palette to be used in the range selector's chart. Alternatively, an array of colors can be set as a custom palette to be used within this chart. */ - palette?: any; - /** An object defining the chart’s series. */ - series?: Array; - /** Defines options for the series template. */ - seriesTemplate?: viz.charts.SeriesTemplate; - /** Specifies a coefficient for determining an indent from the background's top boundary to the topmost chart point. */ - topIndent?: number; - /** Specifies whether or not to filter the series points depending on their quantity. */ - useAggregation?: boolean; - /** Specifies options for the chart's value axis. */ - valueAxis?: { - /** Indicates whether or not the chart's value axis must be inverted. */ - inverted?: boolean; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic value axis. */ - logarithmBase?: number; - /** Specifies the maximum value of the chart's value axis. */ - max?: number; - /** Specifies the minimum value of the chart's value axis. */ - min?: number; - /** Specifies the type of the value axis. */ - type?: string; - /** Specifies the desired type of axis values. */ - valueType?: string; - }; - }; - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** Specifies a data source for the scale values and for the chart at the background. */ - dataSource?: any; - /** Specifies the data source field that provides data for the scale. */ - dataSourceField?: string; - /** Specifies options of the range selector's scale. */ - scale?: { - /** Specifies the scale's end value. */ - endValue?: any; - /** Specifies common options for scale labels. */ - label?: { - /** Specifies a callback function that returns the text to be displayed in scale labels. */ - customizeText?: (scaleValue: { value: any; valueText: string; }) => string; - /** Specifies font options for the text displayed in the range selector's scale labels. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in scale labels. */ - format?: any; - /** - * Specifies a precision for the formatted value displayed in the scale labels. - * @deprecated Use the scale | label | format | precision option instead. - */ - precision?: number; - /** Specifies a spacing between scale labels and the background bottom edge. */ - topIndent?: number; - /** Specifies whether or not the scale's labels are visible. */ - visible?: boolean; - }; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic scale. */ - logarithmBase?: number; - /** - * Specifies an interval between major ticks. - * @deprecated Use the tickInterval option instead. - */ - majorTickInterval?: any; - /** Specifies an interval between axis ticks. */ - tickInterval?: any; - /** Specifies options for the date-time scale's markers. */ - marker?: { - /** Defines the options that can be set for the text that is displayed by the scale markers. */ - label?: { - /** Specifies a callback function that returns the text to be displayed in scale markers. */ - customizeText?: (markerValue: { value: any; valueText: string }) => string; - /** Specifies a format for the text displayed in scale markers. */ - format?: any; - }; - /** Specifies the height of the marker's separator. */ - separatorHeight?: number; - /** Specifies the space between the marker label and the marker separator. */ - textLeftIndent?: number; - /** Specifies the space between the marker's label and the top edge of the marker's separator. */ - textTopIndent?: number; - /** Specified the indent between the marker and the scale lables. */ - topIndent?: number; - /** Indicates whether scale markers are visible. */ - visible?: boolean; - }; - /** Specifies the maximum range that can be selected. */ - maxRange?: any; - /** Specifies the number of minor ticks between neighboring major ticks. */ - minorTickCount?: number; - /** Specifies an interval between minor ticks. */ - minorTickInterval?: any; - /** Specifies the minimum range that can be selected. */ - minRange?: any; - /** Specifies the height of the space reserved for the scale in pixels. */ - placeholderHeight?: number; - /** Indicates whether or not to set ticks of a date-time scale at the beginning of each date-time interval. */ - setTicksAtUnitBeginning?: boolean; - /** Specifies whether or not to show ticks for the boundary scale values, when neither major ticks nor minor ticks are created for these values. */ - showCustomBoundaryTicks?: boolean; - /** - * Indicates whether or not to show minor ticks on the scale. - * @deprecated Use the minorTick | visible option instead. - */ - showMinorTicks?: boolean; - /** Specifies the scale's start value. */ - startValue?: any; - /** Specifies options defining the appearance of scale ticks. */ - tick?: { - /** Specifies the color of scale ticks (both major and minor ticks). */ - color?: string; - /** Specifies the opacity of scale ticks (both major and minor ticks). */ - opacity?: number; - /** Specifies the width of the scale's ticks (both major and minor ticks). */ - width?: number; - }; - /** Specifies options of the range selector's minor ticks. */ - minorTick?: { - /** Specifies the color of the scale's minor ticks. */ - color?: string; - /** Specifies the opacity of the scale's minor ticks. */ - opacity?: number; - /** Specifies the width of the scale's minor ticks. */ - width?: number; - /** Indicates whether scale minor ticks are visible or not. */ - visible?: boolean; - }; - /** Specifies the type of the scale. */ - type?: string; - /** Specifies whether or not to expand the current tick interval if labels overlap each other. */ - useTicksAutoArrangement?: boolean; - /** Specifies the type of values on the scale. */ - valueType?: string; - /** Specifies the order of arguments on a discrete scale. */ - categories?: Array; - }; - /** Specifies the range to be selected when displaying the dxRangeSelector. */ - selectedRange?: { - /** Specifies the start value of the range to be selected when displaying the dxRangeSelector widget on a page. */ - startValue?: any; - /** Specifies the end value of the range to be selected when displaying the dxRangeSelector widget on a page. */ - endValue?: any; - }; - /** Specifies the color of the selected range. */ - selectedRangeColor?: string; - /** Range selector's indent options. */ - indent?: { - /** Specifies range selector's left indent. */ - left?: number; - /** Specifies range selector's right indent. */ - right?: number; - }; - /** A handler for the selectedRangeChanged event. */ - onSelectedRangeChanged?: (e: { - startValue: any; - endValue: any; - component: dxRangeSelector; - element: Element; - }) => void; - /** Specifies range selector shutter options. */ - shutter?: { - /** Specifies shutter color. */ - color?: string; - /** Specifies the opacity of the color of shutters. */ - opacity?: number; - }; - /** Specifies the appearance of the range selector's slider handles. */ - sliderHandle?: { - /** Specifies the color of the slider handles. */ - color?: string; - /** Specifies the opacity of the slider handles. */ - opacity?: number; - /** Specifies the width of the slider handles. */ - width?: number; - }; - /** Defines the options of the range selector slider markers. */ - sliderMarker?: { - /** Specifies the color of the slider markers. */ - color?: string; - /** Specifies a callback function that returns the text to be displayed by slider markers. */ - customizeText?: (scaleValue: { value: any; valueText: any; }) => string; - /** Specifies font options for the text displayed by the range selector slider markers. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in slider markers. */ - format?: any; - /** Specifies the color used for the slider marker text when the currently selected range does not match the minRange and maxRange values. */ - invalidRangeColor?: string; - /** - * Specifies the empty space between the marker's border and the marker’s text. - * @deprecated Use the paddingTopBottom and paddingLeftRight options instead. - */ - padding?: number; - /** Specifies the empty space between the marker's top and bottom borders and the marker's text. */ - paddingTopBottom?: number; - /** Specifies the empty space between the marker's left and right borders and the marker's text. */ - paddingLeftRight?: number; - /** Specifies the placeholder height of the slider marker. */ - placeholderHeight?: number; - /** - * Specifies in pixels the height and width of the space reserved for the range selector slider markers. - * @deprecated Use the placeholderHeight and indent options instead. - */ - placeholderSize?: { - /** Specifies the height of the placeholder for the left and right slider markers. */ - height?: number; - /** Specifies the width of the placeholder for the left and right slider markers. */ - width?: { - /** Specifies the width of the left slider marker's placeholder. */ - left?: number; - /** Specifies the width of the right slider marker's placeholder. */ - right?: number; - }; - }; - /** - * Specifies a precision for the formatted value displayed in slider markers. - * @deprecated Use the sliderMarker | format | precision option instead. - */ - precision?: number; - /** Indicates whether or not the slider markers are visible. */ - visible?: boolean; - }; - } -} -declare module DevExpress.viz { - /** A widget that allows end users to select a range of values on a scale. */ - export class dxRangeSelector extends viz.core.BaseWidget implements viz.core.LoadingIndicatorMethods { - constructor(element: JQuery, options?: DevExpress.viz.rangeSelector.dxRangeSelectorOptions); - constructor(element: Element, options?: DevExpress.viz.rangeSelector.dxRangeSelectorOptions); - showLoadingIndicator(): void; - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(skipChartAnimation?: boolean): void; - /** Returns the currently selected range. */ - getSelectedRange(): { startValue: any; endValue: any; }; - /** Sets a specified range. */ - setSelectedRange(selectedRange: { startValue: any; endValue: any; }): void; - } -} -interface JQuery { - dxRangeSelector(options?: DevExpress.viz.rangeSelector.dxRangeSelectorOptions): JQuery; - dxRangeSelector(methodName: string, ...params: any[]): any; - dxRangeSelector(methodName: "instance"): DevExpress.viz.dxRangeSelector; -} -declare module DevExpress.viz.map { - /** This section describes the fields and methods that can be used in code to manipulate the Layer object. */ - export interface MapLayer { - /** The name of the layer. */ - name: string; - /** The layer index in the layers array. */ - index: number; - /** The layer type. Can be "area", "line" or "marker". */ - type: string; - /** The type of the layer elements. */ - elementType: string; - /** Gets all layer elements. */ - getElements(): Array; - /** Deselects all layer elements. */ - clearSelection(): void; - } - /** This section describes the fields and methods that can be used in code to manipulate the Layer Element object. */ - export interface MapLayerElement { - /** The parent layer of the layer element. */ - layer: MapLayer; - /** Gets the layer element coordinates. */ - coordinates(): Object; - /** Sets the value of an attribute. */ - attribute(name: string, value: any): void; - /** Gets the value of an attribute. */ - attribute(name: string): any; - /** Gets the selection state of the layer element. */ - selected(): boolean; - /** Sets the selection state of the layer element. */ - selected(state: boolean): void; - /** Applies the layer element settings and updates element appearance. */ - applySettings(settings: any): void; - } - /** - * This section describes the fields and methods that can be used in code to manipulate the Area object. - * @deprecated Use the Layer Element instead. - */ - export interface Area { - /** - * Contains the element type. - * @deprecated Use the Layer | type instead. - */ - type: string; - /** - * Return the value of an attribute. - * @deprecated Use the Layer Element | attribute(name, value) method instead. - */ - attribute(name: string): any; - /** - * Provides information about the selection state of an area. - * @deprecated Use the Layer Element | selected() method instead. - */ - selected(): boolean; - /** - * Sets a new selection state for an area. - * @deprecated Use the Layer Element | selected(state) method instead. - */ - selected(state: boolean): void; - /** - * Applies the area settings specified as a parameter and updates the area appearance. - * @deprecated Use the Layer Element | applySettings(settings) method instead. - */ - applySettings(settings: any): void; - } - /** - * This section describes the fields and methods that can be used in code to manipulate the Markers object. - * @deprecated Use the Layer Element instead. - */ - export interface Marker { - /** - * Contains the descriptive text accompanying the map marker. - * @deprecated Get the text using the Layer Element | attribute(name) method. The name parameter value for text is set at the dataField option. - */ - text: string; - /** - * Contains the type of the element. - * @deprecated Use the Layer | type instead. - */ - type: string; - /** - * Contains the URL of an image map marker. - * @deprecated Get the image URL using the Layer Element | attribute(name) method. The name parameter value for the image URL is set at the dataField option. - */ - url: string; - /** - * Contains the value of a bubble map marker. - * @deprecated Get the bubble value using the Layer Element | attribute(name) method. The name parameter for the bubble value is set at the dataField option. - */ - value: number; - /** - * Contains the values of a pie map marker. - * @deprecated Get the pie values using the Layer Element | attribute(name) method. The name parameter for pie values is set at the dataField option. - */ - values: Array; - /** - * Returns the value of an attribute. - * @deprecated Use the Layer Element | attribute(name, value) method instead. - */ - attribute(name: string): any; - /** - * Returns the coordinates of a specific marker. - * @deprecated Use the Layer Element | coordinates() method instead. - */ - coordinates(): Array; - /** - * Provides information about the selection state of a marker. - * @deprecated Use the Layer Element | selected() method instead. - */ - selected(): boolean; - /** - * Sets a new selection state for a marker. - * @deprecated Use the Layer Element | selected(state) method instead. - */ - selected(state: boolean): void; - /** - * Applies the marker settings specified as a parameter and updates marker appearance. - * @deprecated Use the Layer Element | applySettings(settings) method instead. - */ - applySettings(settings: any): void; - } - export interface MapLayerSettings { - /** Specifies the layer name. */ - name?: string; - /** Specifies layer type. */ - type?: string; - /** Specifies the type of a marker element. Setting this option makes sense only if the layer type is "marker". */ - elementType?: string; - /** Specifies a data source for the layer. */ - dataSource?: any; - /** Specifies the line width (for layers of a line type) or width of the layer elements border in pixels. */ - borderWidth?: number; - /** Specifies a color for the border of the layer elements. */ - borderColor?: string; - /** Specifies a color for layer elements. */ - color?: string; - /** Specifies a color for the border of the layer element when it is hovered over. */ - hoveredBorderColor?: string; - /** Specifies the pixel-measured line width (for layers of a line type) or width for the border of the layer element when it is hovered over. */ - hoveredBorderWidth?: number; - /** Specifies a color for a layer element when it is hovered over. */ - hoveredColor?: string; - /** Specifies a pixel-measured line width (for layers of a line type) or width for the border of the layer element when it is selected. */ - selectedBorderWidth?: number; - /** Specifies a color for the border of the layer element when it is selected. */ - selectedBorderColor?: string; - /** Specifies a color for the layer element when it is selected. */ - selectedColor?: string; - /** Specifies the layer opacity (from 0 to 1). */ - opacity?: number; - /** Specifies the size of markers. Setting this option makes sense only if the layer type is "marker" and the elementType is "dot", "pie" or "image". */ - size?: number; - /** Specifies the pixel-measured diameter of the marker that represents the smallest value. Setting this option makes sense only if the layer type is "marker". */ - minSize?: number; - /** Specifies the pixel-measured diameter of the marker that represents the biggest value. Setting this option makes sense only if the layer type is "marker". */ - maxSize?: number; - /** Specifies whether or not to change the appearance of a layer element when it is hovered over. */ - hoverEnabled?: boolean; - /** Specifies whether single or multiple map elements can be selected on a vector map. */ - selectionMode?: string; - /** Specifies the name of the palette or a custom range of colors to be used for coloring a layer. */ - palette?: any; - /** Specifies the number of colors in a palette. */ - paletteSize?: number; - /** Allows you to paint layer elements with similar attributes in the same color. */ - colorGroups?: Array; - /** Specifies the field that provides data to be used for coloring of layer elements. */ - colorGroupingField?: string; - /** Allows you to display bubbles with similar attributes in the same size. Setting this option makes sense only if the layer type is "marker" and the elementType is "bubble". */ - sizeGroups?: Array; - /** Specifies the field that provides data to be used for sizing bubble markers. Setting this option makes sense only if the layer type is "marker" and the elementType is "bubble". */ - sizeGroupingField?: string; - /** Specifies the name of the attribute containing marker data. Setting this option makes sense only if the layer type is "marker" and the elementType is "bubble", "pie" or "image". */ - dataField?: string; - /** Specifies the function that customizes each layer element individually. */ - customize?: (eleemnts: Array) => void; - /** Specifies marker label options. */ - label?: { - /** The name of the data source attribute containing marker texts. */ - dataField?: string; - /** Enables marker labels. */ - enabled?: boolean; - /** Specifies font options for marker labels. */ - font?: viz.core.Font; - }; - } - export interface AreaSettings { - /** - * Specifies the width of the area border in pixels. - * @deprecated Use the layers | borderWidth option instead. - */ - borderWidth?: number; - /** - * Specifies a color for the area border. - * @deprecated Use the layers | borderColor option instead. - */ - borderColor?: string; - /** - * Specifies a color for an area. - * @deprecated Use the layers | color option instead. - */ - color?: string; - /** - * Specifies the function that customizes each area individually. - * @deprecated Use the layers | customize option instead. - */ - customize?: (areaInfo: Area) => AreaSettings; - /** - * Specifies a color for the area border when the area is hovered over. - * @deprecated Use the layers | hoveredBorderColor option instead. - */ - hoveredBorderColor?: string; - /** - * Specifies the pixel-measured width of the area border when the area is hovered over. - * @deprecated Use the layers | hoveredBorderWidth option instead. - */ - hoveredBorderWidth?: number; - /** - * Specifies a color for an area when this area is hovered over. - * @deprecated Use the layers | hoveredColor option instead. - */ - hoveredColor?: string; - /** - * Specifies whether or not to change the appearance of an area when it is hovered over. - * @deprecated Use the layers | hoverEnabled option instead. - */ - hoverEnabled?: boolean; - /** - * Configures area labels. - * @deprecated Use the layers | label option instead. - */ - label?: { - /** - * Specifies the data field that provides data for area labels. - * @deprecated Use the layers | label | dataField option instead. - */ - dataField?: string; - /** - * Enables area labels. - * @deprecated Use the layers | label | enabled option instead. - */ - enabled?: boolean; - /** - * Specifies font options for area labels. - * @deprecated Use the layers | label | font option instead. - */ - font?: viz.core.Font; - }; - /** - * Specifies the name of the palette or a custom range of colors to be used for coloring a map. - * @deprecated Use the layers | palette option instead. - */ - palette?: any; - /** - * Specifies the number of colors in a palette. - * @deprecated Use the layers | paletteSize option instead. - */ - paletteSize?: number; - /** - * Allows you to paint areas with similar attributes in the same color. - * @deprecated Use the layers | colorGroups option instead. - */ - colorGroups?: Array; - /** - * Specifies the field that provides data to be used for coloring areas. - * @deprecated Use the layers | colorGroupingField option instead. - */ - colorGroupingField?: string; - /** - * Specifies a color for the area border when the area is selected. - * @deprecated Use the layers | selectedBorderColor option instead. - */ - selectedBorderColor?: string; - /** - * Specifies a color for an area when this area is selected. - * @deprecated Use the layers | selectedColor option instead. - */ - selectedColor?: string; - /** - * Specifies the pixel-measured width of the area border when the area is selected. - * @deprecated Use the layers | selectedBorderWidth option instead. - */ - selectedBorderWidth?: number; - /** - * Specifies whether single or multiple areas can be selected on a vector map. - * @deprecated Use the layers | selectionMode option instead. - */ - selectionMode?: string; - } - export interface MarkerSettings { - /** - * Specifies a color for the marker border. - * @deprecated Use the layers | borderColor option instead. - */ - borderColor?: string; - /** - * Specifies the width of the marker border in pixels. - * @deprecated Use the layers | borderWidth option instead. - */ - borderWidth?: number; - /** - * Specifies a color for a marker of the dot or bubble type. - * @deprecated Use the layers | color option instead. - */ - color?: string; - /** - * Specifies the function that customizes each marker individually. - * @deprecated Use the layers | customize option instead. - */ - customize?: (markerInfo: Marker) => MarkerSettings; - /** - * Specifies the pixel-measured width of the marker border when the marker is hovered over. - * @deprecated Use the layers | hoveredBorderWidth option instead. - */ - hoveredBorderWidth?: number; - /** - * Specifies a color for the marker border when the marker is hovered over. - * @deprecated Use the layers | hoveredBorderColor option instead. - */ - hoveredBorderColor?: string; - /** - * Specifies a color for a marker of the dot or bubble type when this marker is hovered over. - * @deprecated Use the layers | hoveredColor option instead. - */ - hoveredColor?: string; - /** - * Specifies whether or not to change the appearance of a marker when it is hovered over. - * @deprecated Use the layers | hoverEnabled option instead. - */ - hoverEnabled?: boolean; - /** - * Specifies marker label options. - * @deprecated Use the layers | label option instead. - */ - label?: { - /** - * Enables marker labels. - * @deprecated Use the layers | label | enabled option instead. - */ - enabled?: boolean; - /** - * Specifies font options for marker labels. - * @deprecated Use the layers | label | font option instead. - */ - font?: viz.core.Font; - }; - /** - * Specifies the pixel-measured diameter of the marker that represents the biggest value. Setting this option makes sense only if you use markers of the bubble type. - * @deprecated Use the layers | maxSize option instead. - */ - maxSize?: number; - /** - * Specifies the pixel-measured diameter of the marker that represents the smallest value. Setting this option makes sense only if you use markers of the bubble type. - * @deprecated Use the layers | minSize option instead. - */ - minSize?: number; - /** - * Specifies the opacity of markers. Setting this option makes sense only if you use markers of the bubble type. - * @deprecated Use the layers | opacity option instead. - */ - opacity?: number; - /** - * Specifies the pixel-measured width of the marker border when the marker is selected. - * @deprecated Use the layers | selectedBorderWidth option instead. - */ - selectedBorderWidth?: number; - /** - * Specifies a color for the marker border when the marker is selected. - * @deprecated Use the layers | selectedBorderColor option instead. - */ - selectedBorderColor?: string; - /** - * Specifies a color for a marker of the dot or bubble type when this marker is selected. - * @deprecated Use the layers | selectedColor option instead. - */ - selectedColor?: string; - /** - * Specifies whether a single or multiple markers can be selected on a vector map. - * @deprecated Use the layers | selectionMode option instead. - */ - selectionMode?: string; - /** - * Specifies the size of markers. Setting this option makes sense for any type of marker except bubble. - * @deprecated Use the layers | size option instead. - */ - size?: number; - /** - * Specifies the type of markers to be used on the map. - * @deprecated Use the layers | elementType option instead. - */ - type?: string; - /** - * Specifies the name of a palette or a custom set of colors to be used for coloring markers of the pie type. - * @deprecated Use the layers | palette option instead. - */ - palette?: any; - /** - * Allows you to paint markers with similar attributes in the same color. - * @deprecated Use the layers | colorGroups option instead. - */ - colorGroups?: Array; - /** - * Specifies the field that provides data to be used for coloring markers. - * @deprecated Use the layers | colorGroupingField option instead. - */ - colorGroupingField?: string; - /** - * Allows you to display bubbles with similar attributes in the same size. - * @deprecated Use the layers | sizeGroups option instead. - */ - sizeGroups?: Array; - /** - * Specifies the field that provides data to be used for sizing bubble markers. - * @deprecated Use the layers | sizeGroupingField option instead. - */ - sizeGroupingField?: string; - } - export interface dxVectorMapOptions extends viz.core.BaseWidgetOptions, viz.core.RedrawOnResizeOptions, viz.core.TitleOptions, viz.core.LoadingIndicatorOptions, viz.core.ExportOptions { - /** - * An object specifying options for the map areas. - * @deprecated Use the "area" type element of the layers array. - */ - areaSettings?: AreaSettings; - /** Specifies the options for the map background. */ - background?: { - /** Specifies a color for the background border. */ - borderColor?: string; - /** Specifies a color for the background. */ - color?: string; - }; - /** Specifies options for dxVectorMap widget layers. */ - layers?: Array; - /** Specifies the map projection. */ - projection?: Object; - /** Specifies the positioning of a map in geographical coordinates. */ - bounds?: Array; - /** Specifies the options of the control bar. */ - controlBar?: { - /** Specifies a color for the outline of the control bar elements. */ - borderColor?: string; - /** Specifies a color for the inner area of the control bar elements. */ - color?: string; - /** Specifies whether or not to display the control bar. */ - enabled?: boolean; - /** Specifies the margin of the control bar in pixels. */ - margin?: number; - /** Specifies the position of the control bar. */ - horizontalAlignment?: string; - /** Specifies the position of the control bar. */ - verticalAlignment?: string; - /** Specifies the opacity of the control bar. */ - opacity?: number; - }; - /** - * Specifies a data source for the map area. - * @deprecated Use the layers | dataSource option instead. - */ - mapData?: any; - /** - * Specifies a data source for the map markers. - * @deprecated Use the layers | dataSource option instead. - */ - markers?: any; - /** - * An object specifying options for the map markers. - * @deprecated Use the "marker" type element of the layers array. - */ - markerSettings?: MarkerSettings; - /** Configures tooltips. */ - tooltip?: viz.core.Tooltip; - /** Configures map legends. */ - legends?: Array; - /** Specifies whether or not the map should respond when a user rolls the mouse wheel. */ - wheelEnabled?: boolean; - /** Specifies whether the map should respond to touch gestures. */ - touchEnabled?: boolean; - /** Disables the zooming capability. */ - zoomingEnabled?: boolean; - /** Specifies the geographical coordinates of the center for a map. */ - center?: Array; - /** A handler for the centerChanged event. */ - onCenterChanged?: (e: { - center: Array; - component: dxVectorMap; - element: Element; - }) => void; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: dxVectorMap; - element: Element; - target: {}; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: dxVectorMap; - element: Element; - target: {}; - }) => void; - /** Specifies a number that is used to zoom a map initially. */ - zoomFactor?: number; - /** Specifies a map's maximum zoom factor. */ - maxZoomFactor?: number; - /** A handler for the zoomFactorChanged event. */ - onZoomFactorChanged?: (e: { - component: dxVectorMap; - element: Element; - zoomFactor: number; - }) => void; - /** A handler for the click event. */ - onClick?: any; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: (e: { - component: dxVectorMap; - element: Element; - target: MapLayerElement; - }) => void; - /** - * A handler for the areaClick event. - * @deprecated Use the onClick option instead. - */ - onAreaClick?: any; - /** - * A handler for the areaSelectionChanged event. - * @deprecated Use the onSelectionChanged option instead. - */ - onAreaSelectionChanged?: (e: { - target: Area; - component: dxVectorMap; - element: Element; - }) => void; - /** - * A handler for the markerClick event. - * @deprecated Use the onClick option instead. - */ - onMarkerClick?: any; - /** - * A handler for the markerSelectionChanged event. - * @deprecated Use the onSelecitonChanged option instead. - */ - onMarkerSelectionChanged?: (e: { - target: Marker; - component: dxVectorMap; - element: Element; - }) => void; - /** Disables the panning capability. */ - panningEnabled?: boolean; - } - export interface Legend extends viz.core.BaseLegend { - /** Specifies the color of item markers in the legend. The specified color applied only when the legend uses 'size' source. */ - markerColor?: string; - /** Specifies the shape of item markers. */ - markerShape?: string; - /** Specifies text for legend items. */ - customizeText?: (itemInfo: { start: number; end: number; index: number; color: string; size: number; }) => string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the text of a legend item. */ - customizeHint?: (itemInfo: { start: number; end: number; index: number; color: string; size: number }) => string; - /** Specifies the source of data for the legend. */ - source?: { - /** Specifies a layer to which the legend belongs. */ - layer?: string; - /** Specifies the type of the legend grouping. */ - grouping?: string; - } - } - export var projection: ProjectionCreator; - export interface ProjectionCreator { - /** Creates a new projection. */ - (data: { - to?: (coordinates: Array) => Array; - from?: (coordinates: Array) => Array; - aspectRatio?: number; - }): Object; - /** Gets the default or custom projection from the projection storage. */ - get(name: string): Object; - /** Adds a new projection to the internal projections storage. */ - add(name: string, projection: Object): void; - } -} -declare module DevExpress.viz{ - /** A vector map widget. */ - export class dxVectorMap extends viz.core.BaseWidget implements viz.core.LoadingIndicatorMethods { - constructor(element: JQuery, options?: DevExpress.viz.map.dxVectorMapOptions); - constructor(element: Element, options?: DevExpress.viz.map.dxVectorMapOptions); - showLoadingIndicator(): void; - hideLoadingIndicator(): void; - /** Gets the current coordinates of the map center. */ - center(): Array; - /** Sets the coordinates of the map center. */ - center(centerCoordinates: Array): void; - /** - * Deselects all the selected areas on a map. The areas are displayed in their initial style after. - * @deprecated Use the layer's clearSelection() method instead. - */ - clearAreaSelection(): void; - /** - * Deselects all the selected markers on a map. The markers are displayed in their initial style after. - * @deprecated Use the layer's clearSelection() method instead. - */ - clearMarkerSelection(): void; - /** Deselects all the selected area and markers on a map at once. The areas and markers are displayed in their initial style after. */ - clearSelection(): void; - /** Converts client area coordinates into map coordinates. */ - convertCoordinates(x: number, y: number): Array; - /** Gets all map layers. */ - getLayers(): Array; - /** Gets the layer by its index. */ - getLayerByIndex(index: number): DevExpress.viz.map.MapLayer; - /** Gets the layer by its name. */ - getLayerByName(name: string): DevExpress.viz.map.MapLayer; - /** - * Returns an array with all the map areas. - * @deprecated Use the layer's getElements() method instead. - */ - getAreas(): Array; - /** - * Returns an array with all the map markers. - * @deprecated Use the layer's getElements() method instead. - */ - getMarkers(): Array; - /** Gets the current coordinates of the map viewport. */ - viewport(): Array; - /** Sets the coordinates of the map viewport. */ - viewport(viewportCoordinates: Array): void; - /** Gets the current value of the map zoom factor. */ - zoomFactor(): number; - /** Sets the value of the map zoom factor. */ - zoomFactor(zoomFactor: number): void; - } -} -interface JQuery { - dxVectorMap(options?: DevExpress.viz.map.dxVectorMapOptions): JQuery; - dxVectorMap(methodName: string, ...params: any[]): any; - dxVectorMap(methodName: "instance"): DevExpress.viz.dxVectorMap; -} -declare module DevExpress.viz.sparklines { - export interface SparklineTooltip extends viz.core.Tooltip { - /** - * Specifies how a tooltip is horizontally aligned relative to the graph. - * @deprecated Tooltip alignment is no longer useful because the tooltips are aligned automatically. - */ - horizontalAlignment?: string; - /** - * Specifies how a tooltip is vertically aligned relative to the graph. - * @deprecated Tooltip alignment is no longer useful because the tooltips are aligned automatically. - */ - verticalAlignment?: string; - } - export interface BaseSparklineOptions extends viz.core.BaseWidgetOptions, viz.core.MarginOptions { - /** Configures the tooltip. */ - tooltip?: SparklineTooltip; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: BaseSparkline; - element: Element; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: BaseSparkline; - element: Element; - }) => void; - } - /** Overridden by descriptions for particular widgets. */ - export class BaseSparkline extends viz.core.BaseWidget { - } - export interface dxBulletOptions extends BaseSparklineOptions { - /** Specifies a color for the bullet bar. */ - color?: string; - /** Specifies an end value for the invisible scale. */ - endScaleValue?: number; - /** Specifies whether or not to show the target line. */ - showTarget?: boolean; - /** Specifies whether or not to show the line indicating zero on the invisible scale. */ - showZeroLevel?: boolean; - /** Specifies a start value for the invisible scale. */ - startScaleValue?: number; - /** Specifies the value indicated by the target line. */ - target?: number; - /** Specifies a color for both the target and zero level lines. */ - targetColor?: string; - /** Specifies the width of the target line. */ - targetWidth?: number; - /** Specifies the primary value indicated by the bullet bar. */ - value?: number; - } - export interface dxSparklineOptions extends BaseSparklineOptions { - /** Specifies the data source field that provides arguments for a sparkline. */ - argumentField?: string; - /** Sets a color for the bars indicating negative values. Available for a sparkline of the bar type only. */ - barNegativeColor?: string; - /** Sets a color for the bars indicating positive values. Available for a sparkline of the bar type only. */ - barPositiveColor?: string; - /** Specifies a data source for the sparkline. */ - dataSource?: any; - /** Sets a color for the boundary of both the first and last points on a sparkline. */ - firstLastColor?: string; - /** Specifies whether a sparkline ignores null data points or not. */ - ignoreEmptyPoints?: boolean; - /** Sets a color for a line on a sparkline. Available for the sparklines of the line- and area-like types. */ - lineColor?: string; - /** Specifies a width for a line on a sparkline. Available for the sparklines of the line- and area-like types. */ - lineWidth?: number; - /** Sets a color for the bars indicating the values that are less than the winloss threshold. Available for a sparkline of the winloss type only. */ - lossColor?: string; - /** Sets a color for the boundary of the maximum point on a sparkline. */ - maxColor?: string; - /** Sets a color for the boundary of the minimum point on a sparkline. */ - minColor?: string; - /** Sets a color for points on a sparkline. Available for the sparklines of the line- and area-like types. */ - pointColor?: string; - /** Specifies the diameter of sparkline points in pixels. Available for the sparklines of line- and area-like types. */ - pointSize?: number; - /** Specifies a symbol to use as a point marker on a sparkline. Available for the sparklines of the line- and area-like types. */ - pointSymbol?: string; - /** Specifies whether or not to indicate both the first and last values on a sparkline. */ - showFirstLast?: boolean; - /** Specifies whether or not to indicate both the minimum and maximum values on a sparkline. */ - showMinMax?: boolean; - /** Determines the type of a sparkline. */ - type?: string; - /** Specifies the data source field that provides values for a sparkline. */ - valueField?: string; - /** Sets a color for the bars indicating the values greater than a winloss threshold. Available for a sparkline of the winloss type only. */ - winColor?: string; - /** Specifies a value that serves as a threshold for the sparkline of the winloss type. */ - winlossThreshold?: number; - /** Specifies the minimum value of the sparkline value axis. */ - minValue?: number; - /** Specifies the maximum value of the sparkline's value axis. */ - maxValue?: number; - } -} -declare module DevExpress.viz { - /** A bullet graph widget. */ - export class dxBullet extends DevExpress.viz.sparklines.BaseSparkline { - constructor(element: JQuery, options?: DevExpress.viz.sparklines.dxBulletOptions); - constructor(element: Element, options?: DevExpress.viz.sparklines.dxBulletOptions); - } - /** A sparkline widget. */ - export class dxSparkline extends DevExpress.viz.sparklines.BaseSparkline { - constructor(element: JQuery, options?: DevExpress.viz.sparklines.dxSparklineOptions); - constructor(element: Element, options?: DevExpress.viz.sparklines.dxSparklineOptions); - } -} -interface JQuery { - dxBullet(options?: DevExpress.viz.sparklines.dxBulletOptions): JQuery; - dxBullet(methodName: string, ...params: any[]): any; - dxBullet(methodName: "instance"): DevExpress.viz.dxBullet; - dxSparkline(options?: DevExpress.viz.sparklines.dxSparklineOptions): JQuery; - dxSparkline(methodName: string, ...params: any[]): any; - dxSparkline(methodName: "instance"): DevExpress.viz.dxSparkline; -} -declare module DevExpress.viz.treeMap { - export interface dxTreeMapOptions extends viz.core.BaseWidgetOptions, viz.core.RedrawOnResizeOptions, viz.core.TitleOptions, viz.core.LoadingIndicatorOptions, viz.core.ExportOptions { - /** Specifies the origin of data for the widget. */ - dataSource?: any; - /** Specifies the name of the data source field that provides nested items for a group. Applies to hierarchical data sources only. */ - childrenField?: string; - /** Specifies the name of the data source field that provides values for tiles. */ - valueField?: string; - /** Specifies the name of the data source field that provides colors for tiles. */ - colorField?: string; - /** Specifies the name of the data source field that provides texts for tile and group labels. */ - labelField?: string; - /** Specifies the name of the data source field that provides IDs for items. Applies to flat data sources only. */ - idField?: string; - /** Specifies the name of the data source field that provides parent IDs for items. Applies to flat data sources only. */ - parentField?: string; - /** Specifies the layout algorithm. */ - layoutAlgorithm?: any; - /** Specifies the direction in which the items will be laid out. */ - layoutDirection?: string; - /** Configures tiles. */ - tile?: { - /** Configures the tile borders. */ - border?: { - /** Specifies the width of the tile borders in pixels. */ - width?: number; - /** Colors the tile borders. */ - color?: string; - }; - /** Specifies a single color for all tiles. */ - color?: string; - /** Specifies the appearance of tiles in the hover state. */ - hoverStyle?: { - /** Configures the appearance of the tile borders in the hover state. */ - border?: { - /** Specifies the width of the tile borders in pixels. Applies to a tile in the hover state. */ - width?: number; - /** Colors the tile borders in the hover state. */ - color?: string; - }; - /** Colors tiles in the hover state. */ - color?: string; - }; - /** Specifies the appearance of tiles in the selected state. */ - selectionStyle?: { - /** Configures the appearance of the tile borders in the selected state. */ - border?: { - /** Specifies the width of the tile borders in pixels. Applies to a tile in the selected state. */ - width?: number; - /** Colors the tile borders in the selected state. */ - color?: string; - }; - /** Colors tiles in the selected state. */ - color?: string; - }; - /** Configures the tile labels. */ - label?: { - /** Changes the visibility of the tile labels. */ - visible?: boolean; - /** Specifies the font settings of the tile labels. */ - font?: viz.core.Font; - }; - }; - /** Configures groups. */ - group?: { - /** Specifies the height of the group headers in pixels. */ - headerHeight?: number; - /** Configures the group borders. */ - border?: { - /** Specifies the width of the group borders in pixels. */ - width?: number; - /** Colors the group borders. */ - color?: string; - }; - /** Colors the group headers. */ - color?: string; - /** Specifies the appearance of groups in the hover state. */ - hoverStyle?: { - /** Configures the appearance of the group borders in the hover state. */ - border?: { - /** Specifies the width of the group borders in pixels. Applies to a group in the hover state. */ - width?: number; - /** Colors the group borders in the hover state. */ - color?: string; - }; - /** Colors the group headers in the hover state. */ - color?: string; - }; - /** Specifies the appearance of groups in the selected state. */ - selectionStyle?: { - /** Configures the appearance of the group borders in the selected state. */ - border?: { - /** Specifies the width of the group borders in pixels. Applies to a group in the selected state. */ - width?: number; - /** Colors the group borders in the selected state. */ - color?: string; - }; - /** Colors the group headers in the selected state. */ - color?: string; - }; - /** Configures the group labels. */ - label?: { - /** Changes the visibility of the group labels. */ - visible?: boolean; - /** Specifies the font settings of the group labels. */ - font?: viz.core.Font; - }; - }; - /** Manages the color settings. */ - colorizer?: { - /** Specifies the colorizing algorithm. */ - type?: string; - /** Sets the palette to be used for colorizing tiles. */ - palette?: any; - /** Specifies whether or not all tiles in a group must be colored uniformly. Applies only if the type option is "discrete". */ - colorizeGroups?: boolean; - /** Allows you to paint tiles with similar values uniformly. Applies only if the type option is "gradient" or "range". */ - range?: Array; - /** Specifies the name of the data source field whose values define the color of a tile. Applies only if the type option is "gradient" or "range". */ - colorCodeField?: string; - }; - /** Specifies whether tiles and groups change their style in the hover state. */ - hoverEnabled?: boolean; - /** Specifies whether a single or multiple nodes can be in the selected state simultaneously. */ - selectionMode?: string; - /** Specifies how many hierarchical levels must be visualized. */ - maxDepth?: number; - /** Specifies whether the user will interact with a single tile or its group. */ - interactWithGroup?: boolean; - tooltip?: viz.core.Tooltip; - /** A handler for the nodesInitialized event. */ - onNodesInitialized?: (e: { - component: dxTreeMap; - element: Element; - root: TreeMapNode - }) => void; - /** A handler for the nodesRendering event. */ - onNodesRendering?: (e: { - component: dxTreeMap; - element: Element; - node: TreeMapNode - }) => void; - /** A handler for the click event. */ - onClick?: any; - /** A handler for the hoverChanged event. */ - onHoverChanged?: (e: { - component: dxTreeMap; - element: Element; - node: TreeMapNode; - }) => void; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: (e: { - component: dxTreeMap; - element: Element; - node: TreeMapNode; - }) => void; - /** A handler for the drill event. */ - onDrill?: (e: { - component: dxTreeMap; - element: Element; - node: TreeMapNode - }) => void; - } - /** This section describes fields and methods that can be used in code to manipulate a Node object. */ - export interface TreeMapNode { - /** The level that the current node occupies in the hierarchy of nodes. */ - level: number; - /** The index of the current node in the array of all nodes on the same level. */ - index: number; - /** The object from the data source visualized by the node. */ - data: Object; - /** Returns the parent node of the current node. */ - getParent(): TreeMapNode; - /** Indicates how many direct descendants the current node has. */ - getChildrenCount(): number; - /** Returns all nodes nested in the current node. */ - getAllChildren(): Array; - /** Returns all descendant nodes. */ - getAllNodes(): Array; - /** Gets a specific node from a collection of direct descendants. */ - getChild(index: number): TreeMapNode; - /** Gets the raw value of the node. */ - value(): number; - /** Returns the label of the node. */ - label(): string; - /** Sets the label to the node. */ - label(label: string): void; - /** Customizes the node. */ - customize(options: any): void; - /** Reverts the appearance of the node to the initial state. */ - resetCustomization(): void; - /** Indicates whether the node is in the hover state or not. */ - isHovered(): boolean; - /** Sets the selection state of a node. */ - select(state: boolean): void; - /** Indicates whether the node is selected or not. */ - isSelected(): boolean; - /** Indicates whether the node is visualized by a tile or a group of tiles. */ - isLeaf(): boolean; - /** Indicates whether the current node is active. */ - isActive(): boolean; - /** Shows the tooltip. */ - showTooltip(): void; - /** Drills down into the node. */ - drillDown(): void; - } -} -declare module DevExpress.viz { - /** A widget for displaying hierarchical data by using nested rectangles. */ - export class dxTreeMap extends viz.core.BaseWidget implements viz.core.LoadingIndicatorMethods { - constructor(element: JQuery, options?: DevExpress.viz.treeMap.dxTreeMapOptions); - constructor(element: Element, options?: DevExpress.viz.treeMap.dxTreeMapOptions); - /** Returns the root node. */ - getRootNode(): DevExpress.viz.treeMap.TreeMapNode; - /** Returns the current node. */ - getCurrentNode(): DevExpress.viz.treeMap.TreeMapNode; - /** Deselects all nodes in the widget. */ - clearSelection(): void; - /** Hides the tooltip. */ - hideTooltip(): void; - /** Drills one level up. */ - drillUp(): void; - /** Resets the drill down level. */ - resetDrillDown(): void; - showLoadingIndicator(): void; - hideLoadingIndicator(): void; - } -} -interface JQuery { - dxTreeMap(options?: DevExpress.viz.treeMap.dxTreeMapOptions): JQuery; - dxTreeMap(methodName: string, ...params: any[]): any; - dxTreeMap(methodName: "instance"): DevExpress.viz.dxTreeMap; -} diff --git a/devextreme/devextreme-16.1.7.d.ts b/devextreme/devextreme-16.1.7.d.ts deleted file mode 100644 index a3273c19dd..0000000000 --- a/devextreme/devextreme-16.1.7.d.ts +++ /dev/null @@ -1,8052 +0,0 @@ -// Type definitions for DevExtreme 16.1.7 -// Project: http://js.devexpress.com/ -// Definitions by: DevExpress Inc. -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -/// - -declare module DevExpress { - /** Formats values. */ - export interface Format { - /** Specifies a predefined format. */ - type?: String; - /** Specifies the currency code for the 'currency' format. */ - currency?: String; - /** Specifies a precision for values of a numeric format. */ - precision?: number; - /** Parses string values into numeric or date-time values. */ - parser?: (value: any) => any; - /** Specifies a custom format. */ - formatter?: (value: any) => any; - } - /** A mixin that provides a capability to fire and subscribe to events. */ - export interface EventsMixin { - /** Subscribes to a specified event. */ - on(eventName: string, eventHandler: Function): T; - /** Subscribes to the specified events. */ - on(events: { [eventName: string]: Function; }): T; - /** Detaches all event handlers from the specified event. */ - off(eventName: string): Object; - /** Detaches a particular event handler from the specified event. */ - off(eventName: string, eventHandler: Function): T; - } - /** An object that serves as a namespace for the methods required to perform validation. */ - export module validationEngine { - export interface IValidator { - validate(): ValidatorValidationResult; - reset(): void; - } - export interface ValidatorValidationResult { - isValid: boolean; - name?: string; - value: any; - brokenRule: any; - validationRules: any[]; - } - export interface ValidationGroupValidationResult { - isValid: boolean; - brokenRules: any[]; - validators: IValidator[]; - } - export interface GroupConfig extends EventsMixin { - group: any; - validators: IValidator[]; - validate(): ValidationGroupValidationResult; - reset(): void; - } - /** Provides access to the object that represents the specified validation group. */ - export function getGroupConfig(group: any): GroupConfig - /** Provides access to the object that represents the default validation group. */ - export function getGroupConfig(): GroupConfig - /** Validates rules of the validators that belong to the specified validation group. */ - export function validateGroup(group: any): ValidationGroupValidationResult; - /** Validates rules of the validators that belong to the default validation group. */ - export function validateGroup(): ValidationGroupValidationResult; - /** Resets the values and validation result of the editors that belong to the specified validation group. */ - export function resetGroup(group: any): void; - /** Resets the values and validation result of the editors that belong to the default validation group. */ - export function resetGroup(): void; - /** Validates the rules that are defined within the dxValidator objects that are registered for the specified ViewModel. */ - export function validateModel(model: Object): ValidationGroupValidationResult; - /** Registers all the dxValidator objects extending fields of the specified ViewModel. */ - export function registerModelForValidation(model: Object): void; - /** Unregisters all the dxValidator objects extending fields of the specified ViewModel. */ - export function unregisterModelForValidation(model: Object): void; - } - export var hardwareBackButton: JQueryCallback; - /** Processes the hardware back button click. */ - export function processHardwareBackButton(): void; - /** Hides the last displayed overlay widget. */ - export function hideTopOverlay(): boolean; - /** - * Specifies whether or not the entire application/site supports right-to-left representation. - * @deprecated Use the config(config) method instead. - */ - export var rtlEnabled: boolean; - /** Gets the current global configuration object. */ - export function config(): Object; - /** Sets the global configuration object. */ - export function config(config: Object): void; - /** Registers a new component in the DevExpress.ui namespace as a jQuery plugin, Angular directive and Knockout binding. */ - export function registerComponent(name: string, componentClass: Object): void; - /** Registers a new component in the specified namespace as a jQuery plugin, Angular directive and Knockout binding. */ - export function registerComponent(name: string, namespace: Object, componentClass: Object): void; - export function requestAnimationFrame(callback: Function): number; - export function cancelAnimationFrame(requestID: number): void; - /** Custom Knockout binding that links an HTML element with a specific action. */ - export class Action { } - /** An object used to manage OData endpoints in your application. */ - export class EndpointSelector { - constructor(options: { - [key: string]: { - local?: string; - production?: string; - } - }); - /** Returns an endpoint for the specified key. */ - urlFor(key: string): string; - } - /** An object that serves as a namespace for the methods that are used to animate UI elements. */ - export module fx { - /** Defines animation options. */ - export interface AnimationOptions { - /** A function called after animation is completed. */ - complete?: (element: JQuery, config: AnimationOptions) => void; - /** A number specifying wait time before animation execution. */ - delay?: number; - /** A number specifying the time period to wait before the animation of the next stagger item starts. */ - staggerDelay?: number; - /** A number specifying the time in milliseconds spent on animation. */ - duration?: number; - /** A string specifying the type of an easing function used for animation. */ - easing?: string; - /** Specifies the initial animation state. */ - from?: any; - /** A function called before animation is started. */ - start?: (element: JQuery, config: AnimationOptions) => void; - /** Specifies a final animation state. */ - to?: any; - /** A string value specifying the animation type. */ - type?: string; - /** Specifies the animation direction for the "slideIn" and "slideOut" animation types. */ - direction?: string; - } - /** Animates the specified element. */ - export function animate(element: HTMLElement, config: AnimationOptions): Object; - /** Returns a value indicating whether the specified element is being animated. */ - export function isAnimating(element: HTMLElement): boolean; - /** Stops the animation. */ - export function stop(element: HTMLElement, jumpToEnd: boolean): void; - } - /** The manager that performs several specified animations at a time. */ - export class TransitionExecutor { - /** Deletes all the animations registered in the Transition Executor by using the enter(elements, animation) and leave(elements, animation) methods. */ - reset(): void; - /** Registers a set of elements that should be animated as "entering" using the specified animation configuration. */ - enter(elements: JQuery, animation: any): void; - /** Registers a set of elements that should be animated as "leaving" using the specified animation configuration. */ - leave(elements: JQuery, animation: any): void; - /** Starts all the animations registered using the enter(elements, animation) and leave(elements, animation) methods beforehand. */ - start(config: Object): JQueryPromise; - /** Stops all started animations. */ - stop(): void; - } - export class AnimationPresetCollection { - /** Resets all the changes made in the animation repository. */ - resetToDefaults(): void; - /** Deletes the specified animation or clears all the animation repository, if an animation name is not passed. */ - clear(name: string): void; - /** Adds the specified animation preset to the animation repository by the specified name. */ - registerPreset(name: string, config: any): void; - /** Applies the changes made in the animation repository. */ - applyChanges(): void; - /** Returns the configuration of the animation found in the animation repository by the specified name for the current device. */ - getPreset(name: string): void; - /** Registers predefined animations in the animation repository. */ - registerDefaultPresets(): void; - } - /** A repository of animations. */ - export var animationPresets: AnimationPresetCollection; - /** The device object defines the device on which the application is running. */ - export interface Device { - /** Indicates whether or not the device platform is Android. */ - android?: boolean; - /** Specifies the type of the device on which the application is running. */ - deviceType?: string; - /** Indicates whether or not the device platform is generic, which means that the application will look and behave according to a generic "light" or "dark" theme. */ - generic?: boolean; - /** Indicates whether or not the device platform is iOS. */ - ios?: boolean; - /** Indicates whether or not the device type is 'phone'. */ - phone?: boolean; - /** Specifies the platform of the device on which the application is running. */ - platform?: string; - /** Indicates whether or not the device type is 'tablet'. */ - tablet?: boolean; - /** Specifies an array with the major and minor versions of the device platform. */ - version?: Array; - /** Indicates whether or not the device platform is Windows. */ - win?: boolean; - /** Specifies a performance grade of the current device. */ - grade?: string; - } - export class Devices implements EventsMixin { - constructor(options: { window: Window }); - /** Overrides actual device information to force the application to operate as if it was running on a specified device. */ - current(deviceName: any): void; - /** Returns information about the current device. */ - current(): Device; - orientationChanged: JQueryCallback; - /** Returns the current device orientation. */ - orientation(): string; - /** Returns real information about the current device regardless of the value passed to the devices.current(deviceName) method. */ - real(): Device; - on(eventName: "orientationChanged", eventHandler: (e: { orientation: string }) => void): Devices; - on(eventName: string, eventHandler: Function): Devices; - on(events: { [eventName: string]: Function; }): Devices; - off(eventName: "orientationChanged"): Devices; - off(eventName: string): Devices; - off(eventName: "orientationChanged", eventHandler: (e: { orientation: string }) => void): Devices; - off(eventName: string, eventHandler: Function): Devices; - } - /** An object that serves as a namespace for the methods and events specifying information on the current device. */ - export var devices: Devices; - /** The position object specifies the widget positioning options. */ - export interface PositionOptions { - /** The target element position that the widget is positioned against. */ - at?: any; - /** The element within which the widget is positioned. */ - boundary?: Object; - /** Specifies the horizontal and vertical offset from the window's boundaries. */ - boundaryOffset?: any; - /** Specifies how to move the widget if it overflows the screen. */ - collision?: any; - /** The position of the widget to align against the target element. */ - my?: any; - /** The target element that the widget is positioned against. */ - of?: Object; - /** Specifies horizontal and vertical offset in pixels. */ - offset?: any; - } - export interface ComponentOptions { - /** A handler for the initialized event. */ - onInitialized?: Function; - /** A handler for the optionChanged event. */ - onOptionChanged?: Function; - /** A handler for the disposing event. */ - onDisposing?: Function; - } - /** A base class for all components and widgets. */ - export class Component { - constructor(options?: ComponentOptions) - /** Prevents the component from refreshing until the endUpdate() method is called. */ - beginUpdate(): void; - /** Enables the component to refresh after the beginUpdate() method call. */ - endUpdate(): void; - /** Returns an instance of this component class. */ - instance(): Component; - /** Returns the configuration options of this component. */ - option(): { - [optionKey: string]: any; - }; - /** Sets one or more options of this component. */ - option(options: { - [optionKey: string]: any; - }): void; - /** Gets the value of the specified configuration option of this component. */ - option(optionName: string): any; - /** Sets a value to the specified configuration option of this component. */ - option(optionName: string, optionValue: any): void; - } - export interface DOMComponentOptions extends ComponentOptions { - /** Specifies whether or not the current component supports a right-to-left representation. */ - rtlEnabled?: boolean; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies the width of the widget. */ - width?: any; - /** A bag for holding any options that require two-way binding (Angular approach specific) */ - bindingOptions?: { [key: string]: any; }; - } - /** A base class for all components. */ - export class DOMComponent extends Component { - constructor(element: JQuery, options?: DOMComponentOptions); - constructor(element: HTMLElement, options?: DOMComponentOptions); - /** Returns the root HTML element of the widget. */ - element(): JQuery; - /** Specifies the device-dependent default configuration options for this component. */ - static defaultOptions(rule: { - device?: any; - options?: any; - }): void; - } - export module data { - export interface ODataError extends Error { - httpStatus?: number; - errorDetails?: any; - } - export interface StoreOptions { - /** A handler for the modified event. */ - onModified?: () => void; - /** A handler for the modifying event. */ - onModifying?: () => void; - /** A handler for the removed event. */ - onRemoved?: (key: any) => void; - /** A handler for the removing event. */ - onRemoving?: (key: any) => void; - /** A handler for the updated event. */ - onUpdated?: (key: any, values: Object) => void; - /** A handler for the updating event. */ - onUpdating?: (key: any, values: Object) => void; - /** A handler for the loaded event. */ - onLoaded?: (result: Array) => void; - /** A handler for the loading event. */ - onLoading?: (loadOptions: LoadOptions) => void; - /** A handler for the inserted event. */ - onInserted?: (values: Object, key: any) => void; - /** A handler for the inserting event. */ - onInserting?: (values: Object) => void; - /** Specifies the function called when the Store causes an error. */ - errorHandler?: (e: Error) => void; - /** Specifies the key properties within the data associated with the Store. */ - key?: any; - } - export interface LoadOptions { - filter?: Object; - sort?: Object; - select?: Object; - expand?: Object; - group?: Object; - skip?: number; - take?: number; - userData?: Object; - requireTotalCount?: boolean; - } - /** The base class for all Stores. */ - export class Store implements EventsMixin { - constructor(options?: StoreOptions); - /** Returns the data item specified by the key. */ - byKey(key: any): JQueryPromise; - /** Adds an item to the data associated with this Store. */ - insert(values: Object): JQueryPromise; - /** Returns the key expression specified via the key configuration option. */ - key(): any; - /** Returns the key of the Store item that matches the specified object. */ - keyOf(obj: Object): any; - /** Starts loading data. */ - load(obj?: LoadOptions): JQueryPromise; - /** Removes the data item specified by the key. */ - remove(key: any): JQueryPromise; - /** Obtains the total count of items that will be returned by the load() function. */ - totalCount(options?: { - filter?: Object; - group?: Object; - }): JQueryPromise; - /** Updates the data item specified by the key. */ - update(key: any, values: Object): JQueryPromise; - on(eventName: "removing", eventHandler: (key: any) => void): Store; - on(eventName: "removed", eventHandler: (key: any) => void): Store; - on(eventName: "updating", eventHandler: (key: any, values: Object) => void): Store; - on(eventName: "updated", eventHandler: (key: any, values: Object) => void): Store; - on(eventName: "inserting", eventHandler: (values: Object) => void): Store; - on(eventName: "inserted", eventHandler: (values: Object, key: any) => void): Store; - on(eventName: "modifying", eventHandler: () => void): Store; - on(eventName: "modified", eventHandler: () => void): Store; - on(eventName: "loading", eventHandler: (loadOptions: LoadOptions) => void): Store; - on(eventName: "loaded", eventHandler: (result: Array) => void): Store; - on(eventName: string, eventHandler: Function): Store; - on(events: { [eventName: string]: Function; }): Store; - off(eventName: "removing"): Store; - off(eventName: "removed"): Store; - off(eventName: "updating"): Store; - off(eventName: "updated"): Store; - off(eventName: "inserting"): Store; - off(eventName: "inserted"): Store; - off(eventName: "modifying"): Store; - off(eventName: "modified"): Store; - off(eventName: "loading"): Store; - off(eventName: "loaded"): Store; - off(eventName: string): Store; - off(eventName: "removing", eventHandler: (key: any) => void): Store; - off(eventName: "removed", eventHandler: (key: any) => void): Store; - off(eventName: "updating", eventHandler: (key: any, values: Object) => void): Store; - off(eventName: "updated", eventHandler: (key: any, values: Object) => void): Store; - off(eventName: "inserting", eventHandler: (values: Object) => void): Store; - off(eventName: "inserted", eventHandler: (values: Object, key: any) => void): Store; - off(eventName: "modifying", eventHandler: () => void): Store; - off(eventName: "modified", eventHandler: () => void): Store; - off(eventName: "loading", eventHandler: (loadOptions: LoadOptions) => void): Store; - off(eventName: "loaded", eventHandler: (result: Array) => void): Store; - off(eventName: string, eventHandler: Function): Store; - } - export interface ArrayStoreOptions extends StoreOptions { - /** Specifies the array associated with this Store. */ - data?: Array; - } - /** A Store accessing an in-memory array. */ - export class ArrayStore extends Store { - constructor(options?: ArrayStoreOptions); - /** Clears all data associated with the current ArrayStore. */ - clear(): void; - /** Creates the Query object for the underlying array. */ - createQuery(): Query; - } - interface Promise { - then(doneFn?: Function, failFn?: Function, progressFn?: Function): Promise; - } - export interface CustomStoreOptions extends StoreOptions { - /** Specifies whether or not the store combines the search expression with the filter expression. */ - useDefaultSearch?: boolean; - /** The user implementation of the byKey(key, extraOptions) method. */ - byKey?: (key: any) => Promise; - /** The user implementation of the insert(values) method. */ - insert?: (values: Object) => Promise; - /** The user implementation of the load(options) method. */ - load?: (options?: LoadOptions) => Promise; - /** The user implementation of the remove(key) method. */ - remove?: (key: any) => Promise; - /** The user implementation of the totalCount(options) method. */ - totalCount?: (options?: { - filter?: Object; - group?: Object; - }) => Promise; - /** The user implementation of the update(key, values) method. */ - update?: (key: any, values: Object) => Promise; - } - /** A Store object that enables you to implement your own data access logic. */ - export class CustomStore extends Store { - constructor(options: CustomStoreOptions); - } - export interface DataSourceOptions { - /** Specifies data filtering conditions. */ - filter?: Object; - /** Specifies data grouping conditions. */ - group?: Object; - /** The item mapping function. */ - map?: (record: any) => any; - /** Specifies the maximum number of items the page can contain. */ - pageSize?: number; - /** Specifies whether a DataSource loads data by pages, or all items at once. */ - paginate?: boolean; - /** The data post processing function. */ - postProcess?: (data: any[]) => any[]; - /** Specifies a value by which the required items are searched. */ - searchExpr?: Object; - /** Specifies the comparison operation used to search for the required items. */ - searchOperation?: string; - /** Specifies the value to which the search expression is compared. */ - searchValue?: Object; - /** Specifies the initial select option value. */ - select?: Object; - /** An array of the strings that represent the names of the navigation properties to be loaded simultaneously with the OData store's entity. */ - expand?: Object; - /** The bag of custom parameters passed to the query executed when the DataSource load operation is invoked. */ - customQueryParams?: Object; - /** Specifies whether or not the DataSource instance requests the total count of items available in the storage. */ - requireTotalCount?: boolean; - /** Specifies the initial sort option value. */ - sort?: Object; - /** Specifies the underlying Store instance used to access data. */ - store?: any; - /** A handler for the changed event. */ - onChanged?: () => void; - /** A handler for the loadingChanged event. */ - onLoadingChanged?: (isLoading: boolean) => void; - /** A handler for the loadError event. */ - onLoadError?: (e?: Error) => void; - } - export interface OperationPromise extends JQueryPromise { - operationId: number; - } - /** An object that provides access to a data web service or local data storage for collection container widgets. */ - export class DataSource implements EventsMixin { - constructor(url: string); - constructor(data: Array); - constructor(options: CustomStoreOptions); - constructor(options: DataSourceOptions); - /** Disposes all resources associated with this DataSource. */ - dispose(): void; - /** Returns the current filter option value. */ - filter(): Object; - /** Sets the filter option value. */ - filter(filterExpr: Object): void; - /** Returns the current group option value. */ - group(): Object; - /** Sets the group option value. */ - group(groupExpr: Object): void; - /** Indicates whether or not the current page contains fewer items than the number of items specified by the pageSize configuration option. */ - isLastPage(): boolean; - /** Indicates whether or not at least one load() method execution has successfully finished. */ - isLoaded(): boolean; - /** Indicates whether or not the DataSource is currently being loaded. */ - isLoading(): boolean; - /** Returns the array of items currently operated by the DataSource. */ - items(): Array; - /** Returns the key expression. */ - key(): any; - /** Starts loading data. */ - load(): OperationPromise>; - /** Clears currently loaded DataSource items and calls the load() method. */ - reload(): OperationPromise>; - /** Returns an object that would be passed to the load() method of the underlying Store according to the current data shaping option values of the current DataSource instance. */ - loadOptions(): Object; - /** Returns the current pageSize option value. */ - pageSize(): number; - /** Sets the pageSize option value. */ - pageSize(value: number): void; - /** Specifies the index of the currently loaded page. */ - pageIndex(): number; - /** Specifies the index of the page to be loaded during the next load() method execution. */ - pageIndex(newIndex: number): void; - /** Returns the current paginate option value. */ - paginate(): boolean; - /** Sets the paginate option value. */ - paginate(value: boolean): void; - /** Returns the searchExpr option value. */ - searchExpr(): Object; - /** Sets the searchExpr option value. */ - searchExpr(...expr: Object[]): void; - /** Returns the currently specified search operation. */ - searchOperation(): string; - /** Sets the current search operation. */ - searchOperation(op: string): void; - /** Returns the searchValue option value. */ - searchValue(): Object; - /** Sets the searchValue option value. */ - searchValue(value: Object): void; - /** Returns the current select option value. */ - select(): Object; - /** Sets the select option value. */ - select(expr: Object): void; - /** Returns the current requireTotalCount option value. */ - requireTotalCount(): boolean; - /** Sets the requireTotalCount option value. */ - requireTotalCount(value: boolean): void; - /** Returns the current sort option value. */ - sort(): Object; - /** Sets the sort option value. */ - sort(sortExpr: Object): void; - /** Returns the underlying Store instance. */ - store(): Store; - /** Returns the number of data items available in an underlying Store after the last load() operation without paging. */ - totalCount(): number; - /** Cancels the load operation associated with the specified identifier. */ - cancel(operationId: number): boolean; - on(eventName: "loadingChanged", eventHandler: (isLoading: boolean) => void): DataSource; - on(eventName: "loadError", eventHandler: (e?: Error) => void): DataSource; - on(eventName: "changed", eventHandler: () => void): DataSource; - on(eventName: string, eventHandler: Function): DataSource; - on(events: { [eventName: string]: Function; }): DataSource; - off(eventName: "loadingChanged"): DataSource; - off(eventName: "loadError"): DataSource; - off(eventName: "changed"): DataSource; - off(eventName: string): DataSource; - off(eventName: "loadingChanged", eventHandler: (isLoading: boolean) => void): DataSource; - off(eventName: "loadError", eventHandler: (e?: Error) => void): DataSource; - off(eventName: "changed", eventHandler: () => void): DataSource; - off(eventName: string, eventHandler: Function): DataSource; - } - /** An object used to work with primitive data types not supported by JavaScript when accessing an OData web service. */ - export class EdmLiteral { - /** Creates an EdmLiteral instance and assigns the specified value to it. */ - constructor(value: string); - /** Returns a string representation of the value associated with this EdmLiteral object. */ - valueOf(): string; - } - /** An object used to generate and hold the GUID. */ - export class Guid { - /** Creates a new Guid instance that holds the specified GUID. */ - constructor(value: string); - /** Creates a new Guid instance holding the generated GUID. */ - constructor(); - /** Returns a string representation of the Guid instance. */ - toString(): string; - /** Returns a string representation of the Guid instance. */ - valueOf(): string; - } - export interface LocalStoreOptions extends ArrayStoreOptions { - /** Specifies the time (in miliseconds) after the change operation, before the data is flushed. */ - flushInterval?: number; - /** Specifies whether the data is flushed immediatelly after each change operation, or after the delay specified via the flushInterval option. */ - immediate?: boolean; - /** The unique identifier used to distinguish the data within the HTML5 Web Storage. */ - name?: string; - } - /** A Store providing access to the HTML5 Web Storage. */ - export class LocalStore extends ArrayStore { - constructor(options?: LocalStoreOptions); - /** Removes all data associated with this Store. */ - clear(): void; - } - export interface ODataContextOptions extends ODataStoreOptions { - /** Specifies the list of entities to be accessed via the ODataContext. */ - entities?: Object; - /** Specifies the function called if the ODataContext causes an error. */ - errorHandler?: (e: Error) => void; - } - /** Provides access to the entire OData service. */ - export class ODataContext { - constructor(options?: ODataContextOptions); - /** Initiates the specified WebGet service operation that returns a value. For the information on service operations, refer to the OData documentation. */ - get(operationName: string, params: Object): JQueryPromise; - /** Initiates the specified WebGet service operation that returns nothing. For the information on service operations, refer to the OData documentation. */ - invoke(operationName: string, params: Object, httpMethod: Object): JQueryPromise; - /** Return a special proxy object to describe the entity link. */ - objectLink(entityAlias: string, key: any): Object; - } - export interface ODataStoreOptions extends StoreOptions { - /** A function used to customize a web request before it is sent. */ - beforeSend?: (request: { - url: string; - async: boolean; - method: string; - timeout: number; - params: Object; - payload: Object; - headers: Object; - }) => void; - /** Specifies whether the ODataStore uses the JSONP approach to access non-CORS-compatible remote services. */ - jsonp?: boolean; - /** Specifies the type of the ODataStore key property. The following key types are supported out of the box: String, Int32, Int64, Boolean, Single, Decimal and Guid. */ - keyType?: any; - /** Specifies whether or not dates in a response are deserialized. */ - deserializeDates?: boolean; - /** Specifies the URL of the data service being accessed via the current ODataContext. */ - url?: string; - /** Specifies the version of the OData protocol used to interact with the data service. */ - version?: number; - /** Specifies the value of the withCredentials field of the underlying jqXHR object. */ - withCredentials?: boolean; - } - /** A Store providing access to a separate OData web service entity. */ - export class ODataStore extends Store { - constructor(options?: ODataStoreOptions); - /** Creates the Query object for the OData endpoint. */ - createQuery(loadOptions: Object): Object; - /** Returns the data item specified by the key. */ - byKey(key: any, extraOptions?: { expand?: Object }): JQueryPromise; - } - /** An universal chainable data query interface object. */ - export interface Query { - /** Calculates a custom summary for the items in the current Query. */ - aggregate(step: (accumulator: any, value: any) => any): JQueryPromise; - /** Calculates a custom summary for the items in the current Query. */ - aggregate(seed: any, step: (accumulator: any, value: any) => any, finalize: (result: any) => any): JQueryPromise; - /** Calculates the average item value for the current Query. */ - avg(getter: Object): JQueryPromise; - /** Finds the item with the maximum getter value. */ - max(getter: Object): JQueryPromise; - /** Finds the item with the maximum value in the Query. */ - max(): JQueryPromise; - /** Finds the item with the minimum value in the Query. */ - min(): JQueryPromise; - /** Finds the item with the minimum getter value. */ - min(getter: Object): JQueryPromise; - /** Calculates the average item value for the current Query, if each Query item has a numeric type. */ - avg(): JQueryPromise; - /** Returns the total count of items in the current Query. */ - count(): JQueryPromise; - /** Executes the Query. */ - enumerate(): JQueryPromise; - /** Filters the current Query data. */ - filter(criteria: Array): Query; - /** Filters the current Query data. */ - filter(predicate: (item: any) => boolean): Query; - /** Groups the current Query data. */ - groupBy(getter: Object): Query; - /** Applies the specified transformation to each item. */ - select(getter: Object): Query; - /** Limits the data item count. */ - slice(skip: number, take?: number): Query; - /** Sorts current Query data. */ - sortBy(getter: Object, desc: boolean): Query; - /** Sorts current Query data. */ - sortBy(getter: Object): Query; - /** Calculates the sum of item getter values in the current Query. */ - sum(getter: Object): JQueryPromise; - /** Calculates the sum of item values in the current Query. */ - sum(): JQueryPromise; - /** Adds one more sorting condition to the current Query. */ - thenBy(getter: Object): Query; - /** Adds one more sorting condition to the current Query. */ - thenBy(getter: Object, desc: boolean): Query; - /** Returns the array of current Query items. */ - toArray(): Array; - } - /** The global data layer error handler. */ - export var errorHandler: (e: Error) => void; - /** Encodes the specified string or array of bytes to base64 encoding. */ - export function base64_encode(input: any): string; - /** Creates a Query instance. */ - export function query(array: Array): Query; - /** Creates a Query instance for accessing the remote service specified by a URL. */ - export function query(url: string, queryOptions: Object): Query; - /** This section describes the utility objects provided by the DevExtreme data layer. */ - export var utils: { - /** Compiles a getter function from the getter expression. */ - compileGetter(expr: any): Function; - /** Compiles a setter function from the setter expression. */ - compileSetter(expr: any): Function; - odata: { - /** Holds key value converters for OData. */ - keyConverters: { - String(value: any): string; - Int32(value: any): number; - Int64(value: any): EdmLiteral; - Guid(value: any): Guid; - Boolean(value: any): boolean; - Single(value: any): EdmLiteral; - Decimal(value: any): EdmLiteral; - }; - } - } - } - /** An object that serves as a namespace for DevExtreme UI widgets as well as for methods implementing UI logic in DevExtreme sites/applications. */ - export module ui { - export interface WidgetOptions extends DOMComponentOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A Boolean value specifying whether or not the widget can respond to user interaction. */ - disabled?: boolean; - /** A Boolean value specifying whether or not the widget changes its state when being hovered by an end user. */ - hoverStateEnabled?: boolean; - /** Specifies whether or not the widget can be focused. */ - focusStateEnabled?: boolean; - /** Specifies a shortcut key that sets focus on the widget element. */ - accessKey?: string; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - /** Specifies the widget tab index. */ - tabIndex?: number; - /** Specifies the text of the hint displayed for the widget. */ - hint?: string; - } - /** The base class for widgets. */ - export class Widget extends DOMComponent { - constructor(options?: WidgetOptions); - /** Redraws the widget. */ - repaint(): void; - /** Sets focus on the widget. */ - focus(): void; - /** Registers a handler when a specified key is pressed. */ - registerKeyHandler(key: string, handler: Function): void; - } - export interface CollectionWidgetOptions extends WidgetOptions { - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** The time period in milliseconds before the onItemHold event is raised. */ - itemHoldTimeout?: number; - /** An array of items displayed by the widget. */ - items?: Array; - /** The template to be used for rendering items. */ - itemTemplate?: any; - loopItemFocus?: boolean; - /** The text or HTML markup displayed by the widget if the item collection is empty. */ - noDataText?: string; - onContentReady?: any; - /** A handler for the itemClick event. */ - onItemClick?: any; - /** A handler for the itemContextMenu event. */ - onItemContextMenu?: Function; - /** A handler for the itemHold event. */ - onItemHold?: Function; - /** A handler for the itemRendered event. */ - onItemRendered?: Function; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: Function; - /** The index of the currently selected widget item. */ - selectedIndex?: number; - /** The selected item object. */ - selectedItem?: Object; - /** An array of currently selected item objects. */ - selectedItems?: Array; - /** A handler for the itemDeleting event. */ - onItemDeleting?: Function; - /** A handler for the itemDeleted event. */ - onItemDeleted?: Function; - /** A handler for the itemReordered event. */ - onItemReordered?: Function; - } - /** The base class for widgets containing an item collection. */ - export class CollectionWidget extends Widget { - constructor(element: JQuery, options?: CollectionWidgetOptions); - constructor(element: HTMLElement, options?: CollectionWidgetOptions); - selectItem(itemElement: any): void; - unselectItem(itemElement: any): void; - deleteItem(itemElement: any): JQueryPromise; - isItemSelected(itemElement: any): boolean; - reorderItem(itemElement: any, toItemElement: any): JQueryPromise; - } - export interface DataExpressionMixinOptions { - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** Specifies the name of the data source item field whose value is displayed by the widget. */ - displayExpr?: any; - /** Specifies the name of a data source item field whose value is held in the value configuration option. */ - valueExpr?: any; - /** An array of items displayed by the widget. */ - items?: Array; - /** The template to be used for rendering items. */ - itemTemplate?: any; - /** The currently selected value in the widget. */ - value?: Object; - } - export interface EditorOptions extends WidgetOptions { - /** The currently specified value. */ - value?: Object; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - /** A Boolean value specifying whether or not the widget is read-only. */ - readOnly?: boolean; - /** Holds the object that defines the error that occurred during validation. */ - validationError?: Object; - /** Specifies whether the editor's value is valid. */ - isValid?: boolean; - /** Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed. */ - validationMessageMode?: string; - } - /** A base class for editors. */ - export class Editor extends Widget { - /** Resets the editor's value to undefined. */ - reset(): void; - } - /** An object that serves as a namespace for methods displaying a message in an application/site. */ - export var dialog: { - /** Creates an alert dialog message containing a single "OK" button. */ - alert(message: string, title: string): JQueryPromise; - /** Creates a confirm dialog that contains "Yes" and "No" buttons. */ - confirm(message: string, title: string): JQueryPromise; - /** Creates a custom dialog using the options specified by the passed configuration object. */ - custom(options: { title?: string; message?: string; buttons?: Array; }): { - show(): JQueryPromise; - hide(): void; - hide(value: any): void; - }; - }; - /** Creates a toast message. */ - export function notify(message: any, type: string, displayTime: number): void; - /** Creates a toast message. */ - export function notify(options: Object): void; - /** An object that serves as a namespace for the methods that work with DevExtreme CSS Themes. */ - export var themes: { - /** Returns the name of the currently applied theme. */ - current(): string; - /** Changes the current theme to the specified one. */ - current(themeName: string): void; - }; - /** Sets a specified template engine. */ - export function setTemplateEngine(name: string): void; - /** Sets a custom template engine defined via custom compile and render functions. */ - export function setTemplateEngine(options: Object): void; - } - /** An object that serves as a namespace for utility methods that can be helpful when working with the DevExtreme framework and UI widgets. */ - export var utils: { - /** Sets parameters for the viewport meta tag. */ - initMobileViewport(options: { allowZoom?: boolean; allowPan?: boolean; allowSelection?: boolean }): void; - /** Requests that the browser call a specified function to update animation before the next repaint. */ - requestAnimationFrame(callback: Function): number; - /** Cancels an animation frame request scheduled with the requestAnimationFrame method. */ - cancelAnimationFrame(requestID: number): void; - }; - /** An object that serves as a namespace for DevExtreme Data Visualization Widgets. */ - export module viz { - /** Applies a theme for the entire page with several DevExtreme visualization widgets. */ - export function currentTheme(theme: string): void; - /** Applies a new theme (with the color scheme defined separately) for the entire page with several DevExtreme visualization widgets. */ - export function currentTheme(platform: string, colorScheme: string): void; - /** Registers a new theme based on the existing one. */ - export function registerTheme(customTheme: Object, baseTheme: string): void; - /** Allows you to export widgets using their SVG markup. */ - export function exportFromMarkup(markup: string, options: Object): void; - /** Applies a predefined or registered custom palette to all visualization widgets at once. */ - export function currentPalette(paletteName: string): void; - /** Obtains the color sets of a predefined or registered palette. */ - export function getPalette(paletteName: string): Object; - /** Registers a new palette. */ - export function registerPalette(paletteName: string, palette: Object): void; - } -} -declare module DevExpress.ui { - export interface dxValidatorValidationAdapter { - /** A function that returns the value to be validated. */ - getValue?: Function; - /** The jQuery.Callbacks() object that is fired when the specified value should be validated. */ - validationRequestsCallbacks?: JQueryCallback; - /** A function that the dxValidator widget calls after validating a specified value. */ - applyValidationResults?: (params: validationEngine.ValidatorValidationResult) => void; - /** A function that resets the validated values. */ - reset?: Function; - /** A function that sets focus to the validated editors when the dxValidationSummary is focused. */ - focus?: Function; - /** A function that returns a Boolean value specifying whether or not to bypass validation. */ - bypass?: Function; - } - export interface dxValidatorOptions extends DOMComponentOptions { - /** An array of validation rules to be checked for the editor with which the dxValidator object is associated. */ - validationRules?: Array; - /** Specifies the editor name to be used in the validation default messages. */ - name?: string; - /** An object that specifies what and when to validate, and how to apply the validation result. */ - adapter?: dxValidatorValidationAdapter; - /** Specifies the validation group the editor will be related to. */ - validationGroup?: string; - /** A handler for the validated event. */ - onValidated?: (params: validationEngine.ValidatorValidationResult) => void; - } - /** A widget that is used to validate the associated DevExtreme editors against the defined validation rules. */ - export class dxValidator extends DOMComponent implements validationEngine.IValidator { - constructor(element: JQuery, options?: dxValidatorOptions); - constructor(element: Element, options?: dxValidatorOptions); - /** Validates the value of the editor that is controlled by the current dxValidator object against the list of the specified validation rules. */ - validate(): validationEngine.ValidatorValidationResult; - /** Resets the value and validation result of the editor associated with the current dxValidator object. */ - reset(): void; - } - /** The widget that is used in the Knockout and Angular approaches to combine the editors to be validated. */ - export class dxValidationGroup extends DOMComponent { - constructor(element: JQuery); - constructor(element: Element); - /** Validates rules of the validators that belong to the current validation group. */ - validate(): validationEngine.ValidationGroupValidationResult; - /** Resets the value and validation result of the editors that are included to the current validation group. */ - reset(): void; - } - export interface dxValidationSummaryOptions extends CollectionWidgetOptions { - /** Specifies the validation group for which summary should be generated. */ - validationGroup?: string; - } - /** A widget for displaying the result of checking validation rules for editors. */ - export class dxValidationSummary extends CollectionWidget { - constructor(element: JQuery, options?: dxValidationSummaryOptions); - constructor(element: Element, options?: dxValidationSummaryOptions); - } - export interface dxResizableOptions extends DOMComponentOptions { - /** Specifies which borders of the widget element are used as a handle. */ - handles?: string; - /** Specifies the lower width boundary for resizing. */ - minWidth?: number; - /** Specifies the upper width boundary for resizing. */ - maxWidth?: number; - /** Specifies the lower height boundary for resizing. */ - minHeight?: number; - /** Specifies the upper height boundary for resizing. */ - maxHeight?: number; - /** A handler for the resizeStart event. */ - onResizeStart?: Function; - /** A handler for the resize event. */ - onResize?: Function; - /** A handler for the resizeEnd event. */ - onResizeEnd?: Function; - } - /** A widget that displays required content in a resizable element. */ - export class dxResizable extends DOMComponent { - constructor(element: JQuery, options?: dxResizableOptions); - constructor(element: Element, options?: dxResizableOptions); - } - export interface dxTooltipOptions extends dxPopoverOptions { - } - /** A tooltip widget. */ - export class dxTooltip extends dxPopover { - constructor(element: JQuery, options?: dxTooltipOptions); - constructor(element: Element, options?: dxTooltipOptions); - } - export interface dxDropDownListOptions extends dxDropDownEditorOptions, DataExpressionMixinOptions { - /** Returns the value currently displayed by the widget. */ - displayValue?: string; - /** The minimum number of characters that must be entered into the text box to begin a search. */ - minSearchLength?: number; - /** Specifies whether or not the widget displays unfiltered values until a user types a number of characters exceeding the minSearchLength option value. */ - showDataBeforeSearch?: boolean; - /** Specifies the name of a data source item field or an expression whose value is compared to the search criterion. */ - searchExpr?: any; - /** Specifies the binary operation used to filter data. */ - searchMode?: string; - /** Specifies the time delay, in milliseconds, after the last character has been typed in, before a search is executed. */ - searchTimeout?: number; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - /** Specifies DOM event names that update a widget's value. */ - valueChangeEvent?: string; - /** Specifies whether or not the widget supports searching. */ - searchEnabled?: boolean; - /** - * Specifies whether or not the widget displays items by pages. - * @deprecated Use the DataSource paging opportunities instead. - */ - pagingEnabled?: boolean; - /** The text or HTML markup displayed by the widget if the item collection is empty. */ - noDataText?: string; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: Function; - /** A handler for the itemClick event. */ - onItemClick?: Function; - onContentReady?: Function; - } - /** A base class for drop-down list widgets. */ - export class dxDropDownList extends dxDropDownEditor { - constructor(element: JQuery, options?: dxDropDownListOptions); - constructor(element: Element, options?: dxDropDownListOptions); - } - export interface dxToolbarOptions extends CollectionWidgetOptions { - /** The template used to render menu items. */ - menuItemTemplate?: any; - /** Informs the widget about its location in a view HTML markup. */ - renderAs?: string; - } - /** A toolbar widget. */ - export class dxToolbar extends CollectionWidget { - constructor(element: JQuery, options?: dxToolbarOptions); - constructor(element: Element, options?: dxToolbarOptions); - } - export interface dxToastOptions extends dxOverlayOptions { - animation?: { - /** An object that defines the animation options used when the widget is being shown. */ - show?: fx.AnimationOptions; - /** An object that defines the animation options used when the widget is being hidden. */ - hide?: fx.AnimationOptions; - }; - /** The time span in milliseconds during which the dxToast widget is visible. */ - displayTime?: number; - height?: any; - /** The dxToast message text. */ - message?: string; - position?: PositionOptions; - shading?: boolean; - /** Specifies the dxToast widget type. */ - type?: string; - width?: any; - closeOnBackButton?: boolean; - /** A Boolean value specifying whether or not the toast is closed if a user swipes it out of the screen boundaries. */ - closeOnSwipe?: boolean; - /** A Boolean value specifying whether or not the toast is closed if a user clicks it. */ - closeOnClick?: boolean; - } - /** The toast message widget. */ - export class dxToast extends dxOverlay { - constructor(element: JQuery, options?: dxToastOptions); - constructor(element: Element, options?: dxToastOptions); - } - export interface dxTextEditorOptions extends EditorOptions { - /** A handler for the change event. */ - onChange?: Function; - /** A handler for the copy event. */ - onCopy?: Function; - /** A handler for the cut event. */ - onCut?: Function; - /** A handler for the enterKey event. */ - onEnterKey?: Function; - /** A handler for the focusIn event. */ - onFocusIn?: Function; - /** A handler for the focusOut event. */ - onFocusOut?: Function; - /** A handler for the input event. */ - onInput?: Function; - /** A handler for the keyDown event. */ - onKeyDown?: Function; - /** A handler for the keyPress event. */ - onKeyPress?: Function; - /** A handler for the keyUp event. */ - onKeyUp?: Function; - /** A handler for the paste event. */ - onPaste?: Function; - /** The text displayed by the widget when the widget value is empty. */ - placeholder?: string; - /** Specifies whether to display the Clear button in the widget. */ - showClearButton?: boolean; - /** Specifies the current value displayed by the widget. */ - value?: any; - /** Specifies DOM event names that update a widget's value. */ - valueChangeEvent?: string; - /** Specifies whether or not the widget checks the inner text for spelling mistakes. */ - spellcheck?: boolean; - /** Specifies HTML attributes applied to the inner input element of the widget. */ - attr?: Object; - /** The read-only option that holds the text displayed by the widget input element. */ - text?: string; - focusStateEnabled?: boolean; - hoverStateEnabled?: boolean; - /** The editor mask that specifies the format of the entered string. */ - mask?: string; - /** Specifies a mask placeholder character. */ - maskChar?: string; - /** Specifies custom mask rules. */ - maskRules?: Object; - /** A message displayed when the entered text does not match the specified pattern. */ - maskInvalidMessage?: string; - /** Specifies whether the value option holds only characters entered by a user or prompt characters as well. */ - useMaskedValue?: boolean; - } - /** A base class for text editing widgets. */ - export class dxTextEditor extends Editor { - constructor(element: JQuery, options?: dxTextEditorOptions); - constructor(element: Element, options?: dxTextEditorOptions); - /** Removes focus from the input element. */ - blur(): void; - /** Sets focus to the input element representing the widget. */ - focus(): void; - } - export interface dxTextBoxOptions extends dxTextEditorOptions { - /** Specifies the maximum number of characters you can enter into the textbox. */ - maxLength?: any; - /** The "mode" attribute value of the actual HTML input element representing the text box. */ - mode?: string; - } - /** A single-line text box widget. */ - export class dxTextBox extends dxTextEditor { - constructor(element: JQuery, options?: dxTextBoxOptions); - constructor(element: Element, options?: dxTextBoxOptions); - } - export interface dxTextAreaOptions extends dxTextBoxOptions { - /** Specifies whether or not the widget checks the inner text for spelling mistakes. */ - spellcheck?: boolean; - /** Specifies the minimum height of the widget. */ - minHeight?: any; - /** Specifies the maximum height of the widget. */ - maxHeight?: any; - /** A Boolean value specifying whether or not the auto resizing mode is enabled. */ - autoResizeEnabled?: boolean; - } - /** A widget used to display and edit multi-line text. */ - export class dxTextArea extends dxTextBox { - constructor(element: JQuery, options?: dxTextAreaOptions); - constructor(element: Element, options?: dxTextAreaOptions); - } - export interface dxTabsOptions extends CollectionWidgetOptions { - /** Specifies whether the widget enables an end-user to select only a single item or multiple items. */ - selectionMode?: string; - /** Specifies whether or not an end-user can scroll tabs by swiping. */ - scrollByContent?: boolean; - /** Specifies whether or not an end-user can scroll tabs. */ - scrollingEnabled?: boolean; - /** A Boolean value that specifies the availability of navigation buttons. */ - showNavButtons?: boolean; - } - /** A tab strip used to switch between pages. */ - export class dxTabs extends CollectionWidget { - constructor(element: JQuery, options?: dxTabsOptions); - constructor(element: Element, options?: dxTabsOptions); - } - export interface dxTabPanelOptions extends dxMultiViewOptions { - /** A handler for the titleClick event. */ - onTitleClick?: any; - /** A handler for the titleHold event. */ - onTitleHold?: Function; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - /** The template to be used for rendering an item title. */ - itemTitleTemplate?: any; - /** A Boolean value specifying if tabs in the title are scrolled by content. */ - scrollByContent?: boolean; - /** A Boolean indicating whether or not to add scrolling support for tabs in the title. */ - scrollingEnabled?: boolean; - /** A Boolean value that specifies the availability of navigation buttons. */ - showNavButtons?: boolean; - } - /** A widget used to display a view and to switch between several views by clicking the appropriate tabs. */ - export class dxTabPanel extends dxMultiView { - constructor(element: JQuery, options?: dxTabPanelOptions); - constructor(element: Element, options?: dxTabPanelOptions); - } - export interface dxSelectBoxOptions extends dxDropDownListOptions { - /** Specifies DOM event names that update a widget's value. */ - valueChangeEvent?: string; - /** The template to be used for rendering the widget text field. */ - fieldTemplate?: any; - /** The text that is provided as a hint in the select box editor. */ - placeholder?: string; - /** Specifies whether or not the widget allows an end-user to enter a custom value. */ - acceptCustomValue?: boolean; - /** Specifies whether or not to display selection controls. */ - showSelectionControls?: boolean; - /** A handler for the customItemCreating event. */ - onCustomItemCreating?: Function; - } - /** A widget that allows you to select an item in a dropdown list. */ - export class dxSelectBox extends dxDropDownList { - constructor(element: JQuery, options?: dxSelectBoxOptions); - constructor(element: Element, options?: dxSelectBoxOptions); - } - export interface dxTagBoxOptions extends dxSelectBoxOptions { - values?: Array; - /** Specifies the selected items. */ - value?: Array; - /** Gets the currently selected items. */ - selectedItems?: Array; - /** Specifies how the widget applies values. */ - applyValueMode?: string; - /** A Boolean value specifying whether or not to hide selected items. */ - hideSelectedItems?: boolean; - /** A handler for the selectAllValueChanged event. */ - onSelectAllValueChanged?: Function; - /** A Boolean value specifying whether or not the widget is multiline. */ - multiline?: boolean; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: Function; - /** The template to be used for rendering tags. */ - tagTemplate?: any; - } - /** A widget that allows you to select multiple items from a dropdown list. */ - export class dxTagBox extends dxSelectBox { - constructor(element: JQuery, options?: dxTagBoxOptions); - constructor(element: Element, options?: dxTagBoxOptions); - } - export interface dxScrollViewOptions extends dxScrollableOptions { - /** A handler for the pullDown event. */ - onPullDown?: Function; - /** Specifies the text shown in the pullDown panel when pulling the content down lowers the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while pulling the content down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the reachBottom event. */ - onReachBottom?: Function; - /** Specifies the text shown in the pullDown panel displayed when content is scrolled to the bottom. */ - reachBottomText?: string; - /** Specifies the text shown in the pullDown panel displayed when the content is being refreshed. */ - refreshingText?: string; - } - /** A widget used to display scrollable content. */ - export class dxScrollView extends dxScrollable { - constructor(element: JQuery, options?: dxScrollViewOptions); - constructor(element: Element, options?: dxScrollViewOptions); - /** Returns a value indicating if the scrollView content is larger then the widget container. */ - isFull(): boolean; - /** Locks the widget until the release(preventScrollBottom) method is called and executes the function passed to the onPullDown option and the handler assigned to the pullDown event. */ - refresh(): void; - /** Notifies the scroll view that data loading is finished. */ - release(preventScrollBottom: boolean): JQueryPromise; - /** Toggles the loading state of the widget. */ - toggleLoading(showOrHide: boolean): void; - } - export interface dxScrollableLocation { - top?: number; - left?: number; - } - export interface dxScrollableOptions extends DOMComponentOptions { - /** A string value specifying the available scrolling directions. */ - direction?: string; - /** A Boolean value specifying whether or not the widget can respond to user interaction. */ - disabled?: boolean; - /** A handler for the scroll event. */ - onScroll?: Function; - /** Specifies when the widget shows the scrollbar. */ - showScrollbar?: string; - /** A handler for the update event. */ - onUpdated?: Function; - /** Indicates whether to use native or simulated scrolling. */ - useNative?: boolean; - /** A Boolean value specifying whether to enable or disable the bounce-back effect. */ - bounceEnabled?: boolean; - /** A Boolean value specifying whether or not an end-user can scroll the widget content swiping it up or down. */ - scrollByContent?: boolean; - /** A Boolean value specifying whether or not an end-user can scroll the widget content using the scrollbar. */ - scrollByThumb?: boolean; - } - /** A widget used to display scrollable content. */ - export class dxScrollable extends DOMComponent { - constructor(element: JQuery, options?: dxScrollableOptions); - constructor(element: Element, options?: dxScrollableOptions); - /** Returns the height of the scrollable widget in pixels. */ - clientHeight(): number; - /** Returns the width of the scrollable widget in pixels. */ - clientWidth(): number; - /** Returns an HTML element of the widget. */ - content(): JQuery; - /** Scrolls the widget content by the specified number of pixels. */ - scrollBy(distance: number): void; - /** Scrolls widget content by the specified number of pixels in horizontal and vertical directions. */ - scrollBy(distanceObject: dxScrollableLocation): void; - /** Returns the height of the scrollable content in pixels. */ - scrollHeight(): number; - /** Returns the current scroll position against the leftmost position. */ - scrollLeft(): number; - /** Returns how far the scrollable content is scrolled from the top and from the left. */ - scrollOffset(): dxScrollableLocation; - /** Scrolls widget content to the specified position. */ - scrollTo(targetLocation: number): void; - /** Scrolls widget content to a specified position. */ - scrollTo(targetLocation: dxScrollableLocation): void; - /** Scrolls widget content to the specified element. */ - scrollToElement(element: Element): void; - /** Returns the current scroll position against the topmost position. */ - scrollTop(): number; - /** Returns the width of the scrollable content in pixels. */ - scrollWidth(): number; - /** Updates the dimensions of the scrollable contents. */ - update(): void; - } - export interface dxRadioGroupOptions extends EditorOptions, DataExpressionMixinOptions { - activeStateEnabled?: boolean; - /** Specifies the radio group layout. */ - layout?: string; - } - /** A widget that enables a user to select one item within a list of items represented by radio buttons. */ - export class dxRadioGroup extends CollectionWidget { - constructor(element: JQuery, options?: dxRadioGroupOptions); - constructor(element: Element, options?: dxRadioGroupOptions); - } - export interface dxPopupToolbarItemOptions { - /** Specifies whether or not a toolbar item must be displayed disabled. */ - disabled?: boolean; - /** Specifies html code inserted into the toolbar item element. */ - html?: string; - /** Specifies a location for the item on the toolbar. */ - location?: string; - /** Specifies a configuration object for the widget that presents a toolbar item. */ - options?: Object; - /** Specifies an item template that should be used to render this item only. */ - template?: any; - /** Specifies text displayed for the toolbar item. */ - text?: string; - /** Specifies whether the item is displayed on a top or bottom toolbar. */ - toolbar?: string; - /** Specifies whether or not a widget item must be displayed. */ - visible?: boolean; - /** A widget that presents a toolbar item. */ - widget?: string; - } - export interface dxPopupOptions extends dxOverlayOptions { - /** Specifies whether or not to allow a user to drag the popup window. */ - dragEnabled?: boolean; - /** Specifies whether or not an end user can resize the widget. */ - resizeEnabled?: boolean; - /** A handler for the resizeStart event. */ - onResizeStart?: Function; - /** A handler for the resize event. */ - onResize?: Function; - /** A handler for the resizeEnd event. */ - onResizeEnd?: Function; - /** A Boolean value specifying whether or not to display the widget in full-screen mode. */ - fullScreen?: boolean; - position?: PositionOptions; - /** A Boolean value specifying whether or not to display the title in the popup window. */ - showTitle?: boolean; - /** The title in the overlay window. */ - title?: string; - /** A template to be used for rendering the widget title. */ - titleTemplate?: any; - width?: any; - /** Specifies items displayed on the top or bottom toolbar of the popup window. */ - toolbarItems?: Array; - /** Specifies whether or not the widget displays the Close button. */ - showCloseButton?: boolean; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - } - /** A widget that displays required content in a popup window. */ - export class dxPopup extends dxOverlay { - constructor(element: JQuery, options?: dxPopupOptions); - constructor(element: Element, options?: dxPopupOptions); - } - export interface dxPopoverOptions extends dxPopupOptions { - /** An object defining the animation options of the widget. */ - animation?: { - /** An object that defines the animation options used when the widget is being shown. */ - show?: fx.AnimationOptions; - /** An object that defines the animation options used when the widget is being hidden. */ - hide?: fx.AnimationOptions; - }; - /** Specifies the height of the widget. */ - height?: any; - /** An object defining widget positioning options. */ - position?: PositionOptions; - shading?: boolean; - /** A Boolean value specifying whether or not to display the title in the overlay window. */ - showTitle?: boolean; - /** The target element associated with a popover. */ - target?: any; - /** Specifies the width of the widget. */ - width?: any; - } - /** A widget that displays the required content in a popup window. */ - export class dxPopover extends dxPopup { - constructor(element: JQuery, options?: dxPopoverOptions); - constructor(element: Element, options?: dxPopoverOptions); - /** Displays the widget for the specified target element. */ - show(target?: any): JQueryPromise; - } - export interface dxOverlayOptions extends WidgetOptions { - /** An object defining the animation options of the widget. */ - animation?: { - /** An object that defines the animation options used when the widget is being shown. */ - show?: fx.AnimationOptions; - /** An object that defines the animation options used when the widget is being hidden. */ - hide?: fx.AnimationOptions; - }; - /** A Boolean value specifying whether or not the widget is closed if a user presses the Back hardware button. */ - closeOnBackButton?: boolean; - /** A Boolean value specifying whether or not the widget is closed if a user clicks outside of the overlapping window. */ - closeOnOutsideClick?: any; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - /** Specifies whether or not an end-user can drag the widget. */ - dragEnabled?: boolean; - /** The height of the widget in pixels. */ - height?: any; - /** Specifies the maximum height the widget can reach while resizing. */ - maxHeight?: any; - /** Specifies the maximum width the widget can reach while resizing. */ - maxWidth?: any; - /** Specifies the minimum height the widget can reach while resizing. */ - minHeight?: any; - /** Specifies the minimum width the widget can reach while resizing. */ - minWidth?: any; - /** A handler for the hidden event. */ - onHidden?: Function; - /** A handler for the hiding event. */ - onHiding?: Function; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** A Boolean value specifying whether or not the main screen is inactive while the widget is active. */ - shading?: boolean; - /** Specifies the shading color. */ - shadingColor?: string; - /** A handler for the showing event. */ - onShowing?: Function; - /** A handler for the shown event. */ - onShown?: Function; - onContentReady?: Function; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - /** The widget width in pixels. */ - width?: any; - } - /** A widget displaying the required content in an overlay window. */ - export class dxOverlay extends Widget { - constructor(element: JQuery, options?: dxOverlayOptions); - constructor(element: Element, options?: dxOverlayOptions); - /** An HTML element of the widget. */ - content(): JQuery; - /** Hides the widget. */ - hide(): JQueryPromise; - /** Recalculates the overlay's size and position. */ - repaint(): void; - /** Shows the widget. */ - show(): JQueryPromise; - /** Toggles the visibility of the widget. */ - toggle(showing: boolean): JQueryPromise; - /** A static method that specifies the base z-index for all overlay widgets. */ - static baseZIndex(zIndex: number): void; - } - export interface dxNumberBoxOptions extends dxTextEditorOptions { - /** The maximum value accepted by the number box. */ - max?: number; - /** The minimum value accepted by the number box. */ - min?: number; - /** Specifies whether or not to show spin buttons. */ - showSpinButtons?: boolean; - useTouchSpinButtons?: boolean; - /** Specifies by which value the widget value changes when a spin button is clicked. */ - step?: number; - /** The current number box value. */ - value?: number; - /** The "mode" attribute value of the actual HTML input element representing the widget. */ - mode?: string; - /** Specifies the text of the message displayed if the specified value is not a number. */ - invalidValueMessage?: string; - } - /** A textbox widget that enables a user to enter numeric values. */ - export class dxNumberBox extends dxTextEditor { - constructor(element: JQuery, options?: dxNumberBoxOptions); - constructor(element: Element, options?: dxNumberBoxOptions); - } - export interface dxNavBarOptions extends dxTabsOptions { - scrollingEnabled?: boolean; - } - /** A widget that contains items used to navigate through application views. */ - export class dxNavBar extends dxTabs { - constructor(element: JQuery, options?: dxNavBarOptions); - constructor(element: Element, options?: dxNavBarOptions); - } - export interface dxMultiViewOptions extends CollectionWidgetOptions { - /** Specifies whether or not to animate the displayed item change. */ - animationEnabled?: boolean; - /** A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped. */ - loop?: boolean; - /** The index of the currently displayed item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to allow users to change the selected index by swiping. */ - swipeEnabled?: boolean; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - } - /** A widget used to display a view and to switch between several views. */ - export class dxMultiView extends CollectionWidget { - constructor(element: JQuery, options?: dxMultiViewOptions); - constructor(element: Element, options?: dxMultiViewOptions); - } - export interface dxMapLocation { - /** The latitude location of the widget. */ - lat?: number; - /** The longitude location of the widget. */ - lng?: number; - } - export interface dxMapMarker { - /** A URL pointing to the custom icon to be used for the marker. */ - iconSrc?: string; - /** Specifies the marker location. */ - location?: dxMapLocation; - /** A callback function performed when the marker is clicked. */ - onClick?: Function; - /** A tooltip to be used for the marker. */ - tooltip?: { - /** Specifies whether a tooltip is visible by default or not. */ - isShown?: boolean; - /** Specifies the tooltip text. */ - text?: string; - } - } - export interface dxMapRoute { - /** Specifies the color of the line displaying the route. */ - color?: string; - /** Specifies a transportation mode to be used in the displayed route. */ - mode?: string; - /** Specifies the opacity of the line displaying the route. */ - opacity?: number; - /** Contains an array of objects making up the route. */ - locations?: Array; - /** Specifies the thickness of the line displaying the route in pixels. */ - weight?: number; - } - export interface dxMapOptions extends WidgetOptions { - /** Specifies whether or not the widget automatically adjusts center and zoom option values when adding a new marker or route, or when creating a widget if it initially contains markers or routes. */ - autoAdjust?: boolean; - center?: dxMapLocation; - /** A handler for the click event. */ - onClick?: any; - /** Specifies whether or not map widget controls are available. */ - controls?: boolean; - /** Specifies the height of the widget. */ - height?: any; - /** A key used to authenticate the application within the required map provider. */ - key?: { - /** A key used to authenticate the application within the "Bing" map provider. */ - bing?: string; - /** A key used to authenticate the application within the "Google" map provider. */ - google?: string; - /** A key used to authenticate the application within the "Google Static" map provider. */ - googleStatic?: string; - } - /** A handler for the markerAdded event. */ - onMarkerAdded?: Function; - /** A URL pointing to the custom icon to be used for map markers. */ - markerIconSrc?: string; - /** A handler for the markerRemoved event. */ - onMarkerRemoved?: Function; - /** An array of markers displayed on a map. */ - markers?: Array; - /** The name of the current map data provider. */ - provider?: string; - /** A handler for the ready event. */ - onReady?: Function; - /** A handler for the routeAdded event. */ - onRouteAdded?: Function; - /** A handler for the routeRemoved event. */ - onRouteRemoved?: Function; - /** An array of routes shown on the map. */ - routes?: Array; - /** The type of a map to display. */ - type?: string; - /** Specifies the width of the widget. */ - width?: any; - /** The zoom level of the map. */ - zoom?: number; - } - /** An interactive map widget. */ - export class dxMap extends Widget { - constructor(element: JQuery, options?: dxMapOptions); - constructor(element: Element, options?: dxMapOptions); - /** Adds a marker to the map. */ - addMarker(markerOptions: Object): JQueryPromise; - /** Adds a route to the map. */ - addRoute(routeOptions: Object): JQueryPromise; - /** Removes a marker from the map. */ - removeMarker(marker: Object): JQueryPromise; - /** Removes a route from the map. */ - removeRoute(route: any): JQueryPromise; - } - export interface dxLookupOptions extends dxDropDownListOptions { - applyValueMode?: string; - /** An object that defines widget animation options. */ - animation?: { - /** An object that defines the animation options used when the widget is being shown. */ - show?: fx.AnimationOptions; - /** An object that defines the animation options used when the widget is being hidden. */ - hide?: fx.AnimationOptions; - }; - /** The text displayed on the Cancel button. */ - cancelButtonText?: string; - /** The text displayed on the Clear button. */ - clearButtonText?: string; - /** Specifies whether or not the widget cleans the search box when the popup window is displayed. */ - cleanSearchOnOpening?: boolean; - /** A Boolean value specifying whether or not a widget is closed if a user clicks outside of the overlaying window. */ - closeOnOutsideClick?: any; - /** The text displayed on the Apply button. */ - applyButtonText?: string; - /** A Boolean value specifying whether or not to display the lookup in full-screen mode. */ - fullScreen?: boolean; - focusStateEnabled?: boolean; - /** A Boolean value specifying whether or not to group widget items. */ - grouped?: boolean; - /** The name of the template used to display a group header. */ - groupTemplate?: any; - /** The text displayed on the button used to load the next page from the data source. */ - nextButtonText?: string; - /** A handler for the pageLoading event. */ - onPageLoading?: Function; - /** Specifies whether the next page is loaded when a user scrolls the widget to the bottom or when the "next" button is clicked. */ - pageLoadMode?: string; - /** Specifies the text shown in the pullDown panel, which is displayed when the widget is scrolled to the bottom. */ - pageLoadingText?: string; - /** The text displayed by the widget when nothing is selected. */ - placeholder?: string; - /** The height of the widget popup element. */ - popupHeight?: any; - /** The width of the widget popup element. */ - popupWidth?: any; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** Specifies the text displayed in the pullDown panel when the widget is pulled below the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the pullRefresh event. */ - onPullRefresh?: Function; - /** A Boolean value specifying whether or not the widget supports the "pull down to refresh" gesture. */ - pullRefreshEnabled?: boolean; - /** Specifies the text displayed in the pullDown panel while the widget is being refreshed. */ - refreshingText?: string; - /** A handler for the scroll event. */ - onScroll?: Function; - /** A Boolean value specifying whether or not the search bar is visible. */ - searchEnabled?: boolean; - /** The text that is provided as a hint in the lookup's search bar. */ - searchPlaceholder?: string; - /** A Boolean value specifying whether or not the main screen is inactive while the lookup is active. */ - shading?: boolean; - /** Specifies whether to display the Cancel button in the lookup window. */ - showCancelButton?: boolean; - /** - * A Boolean value specifying whether the widget loads the next page automatically when you reach the bottom of the list or when a button is clicked. - * @deprecated Use the pageLoadMode option instead. - */ - showNextButton?: boolean; - /** The title of the lookup window. */ - title?: string; - /** A template to be used for rendering the widget title. */ - titleTemplate?: any; - /** Specifies whether or not the widget uses native scrolling. */ - useNativeScrolling?: boolean; - /** Specifies whether or not to show lookup contents in a dxPopover widget. */ - usePopover?: boolean; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - /** A handler for the titleRendered event. */ - onTitleRendered?: Function; - /** A Boolean value specifying whether or not to display the title in the popup window. */ - showPopupTitle?: boolean; - /** The template to be used for rendering the widget text field. */ - fieldTemplate?: any; - } - /** A widget that allows a user to select predefined values from a lookup window. */ - export class dxLookup extends dxDropDownList { - constructor(element: JQuery, options?: dxLookupOptions); - constructor(element: Element, options?: dxLookupOptions); - } - export interface dxLoadPanelOptions extends dxOverlayOptions { - /** An object defining the animation options of the widget. */ - animation?: fx.AnimationOptions; - /** The delay in milliseconds after which the load panel is displayed. */ - delay?: number; - /** The height of the widget. */ - height?: number; - /** A URL pointing to an image to be used as a load indicator. */ - indicatorSrc?: string; - /** The text displayed in the load panel. */ - message?: string; - /** A Boolean value specifying whether or not to show a load indicator. */ - showIndicator?: boolean; - /** A Boolean value specifying whether or not to show the pane behind the load indicator. */ - showPane?: boolean; - /** The width of the widget. */ - width?: number; - /** Specifies whether or not the widget can be focused. */ - focusStateEnabled?: boolean; - } - /** A widget used to indicate whether or not an element is loading. */ - export class dxLoadPanel extends dxOverlay { - constructor(element: JQuery, options?: dxLoadPanelOptions); - constructor(element: Element, options?: dxLoadPanelOptions); - } - export interface dxLoadIndicatorOptions extends WidgetOptions { - /** Specifies the path to an image used as the indicator. */ - indicatorSrc?: string; - } - /** The widget used to indicate the loading process. */ - export class dxLoadIndicator extends Widget { - constructor(element: JQuery, options?: dxLoadIndicatorOptions); - constructor(element: Element, options?: dxLoadIndicatorOptions); - } - export interface ListOptionsMenuItem { - /** Specifies the menu item text. */ - text?: string; - /** Holds on a function called when the item is clicked. */ - action?: (itemElement: Element, itemData: any) => void; - } - export interface dxListOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not to display a grouped list. */ - grouped?: boolean; - /** The template to be used for rendering item groups. */ - groupTemplate?: any; - onItemDeleting?: Function; - /** A handler for the itemDeleted event. */ - onItemDeleted?: Function; - /** A handler for the groupRendered event. */ - onGroupRendered?: Function; - /** A handler for the itemReordered event. */ - onItemReordered?: Function; - /** A handler for the itemClick event. */ - onItemClick?: any; - /** A handler for the itemSwipe event. */ - onItemSwipe?: Function; - /** The text displayed on the button used to load the next page from the data source. */ - nextButtonText?: string; - /** A handler for the pageLoading event. */ - onPageLoading?: Function; - /** Specifies the text shown in the pullDown panel, which is displayed when the list is scrolled to the bottom. */ - pageLoadingText?: string; - /** Specifies the text displayed in the pullDown panel when the list is pulled below the refresh threshold. */ - pulledDownText?: string; - /** Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold. */ - pullingDownText?: string; - /** A handler for the pullRefresh event. */ - onPullRefresh?: Function; - /** A Boolean value specifying whether or not the widget supports the "pull down to refresh" gesture. */ - pullRefreshEnabled?: boolean; - /** Specifies the text displayed in the pullDown panel while the list is being refreshed. */ - refreshingText?: string; - /** A handler for the scroll event. */ - onScroll?: Function; - /** A Boolean value specifying whether to enable or disable list scrolling. */ - scrollingEnabled?: boolean; - /** Specifies when the widget shows the scrollbar. */ - showScrollbar?: string; - /** Specifies whether or not the widget uses native scrolling. */ - useNativeScrolling?: boolean; - /** A Boolean value specifying whether to enable or disable the bounce-back effect. */ - bounceEnabled?: boolean; - /** A Boolean value specifying if the list is scrolled by content. */ - scrollByContent?: boolean; - /** A Boolean value specifying if the list is scrolled using the scrollbar. */ - scrollByThumb?: boolean; - onItemContextMenu?: Function; - onItemHold?: Function; - /** Specifies whether or not an end-user can collapse groups. */ - collapsibleGroups?: boolean; - /** Specifies whether the next page is loaded when a user scrolls the widget to the bottom or when the "next" button is clicked. */ - pageLoadMode?: string; - /** Specifies whether or not to display controls used to select list items. */ - showSelectionControls?: boolean; - /** Specifies item selection mode. */ - selectionMode?: string; - selectAllText?: string; - /** A handler for the selectAllValueChanged event. */ - onSelectAllValueChanged?: Function; - /** Specifies the array of items for a context menu called for a list item. */ - menuItems?: Array; - /** Specifies whether an item context menu is shown when a user holds or swipes an item. */ - menuMode?: string; - /** Specifies whether or not an end user can delete list items. */ - allowItemDeleting?: boolean; - /** Specifies the way a user can delete items from the list. */ - itemDeleteMode?: string; - /** Specifies whether or not an end user can reorder list items. */ - allowItemReordering?: boolean; - /** Specifies whether or not to show the loading panel when the DataSource bound to the widget is loading data. */ - indicateLoading?: boolean; - activeStateEnabled?: boolean; - } - /** A list widget. */ - export class dxList extends CollectionWidget { - constructor(element: JQuery, options?: dxListOptions); - constructor(element: Element, options?: dxListOptions); - /** Returns the height of the widget in pixels. */ - clientHeight(): number; - /** Removes the specified item from the list. */ - deleteItem(itemIndex: any): JQueryPromise; - /** Removes the specified item from the list. */ - deleteItem(itemElement: Element): JQueryPromise; - /** Returns a Boolean value that indicates whether or not the specified item is selected. */ - isItemSelected(itemIndex: any): boolean; - /** Returns a Boolean value that indicates whether or not the specified item is selected. */ - isItemSelected(itemElement: Element): boolean; - /** Reloads list data. */ - reload(): void; - /** Moves the specified item to the specified position in the list. */ - reorderItem(itemElement: Element, toItemElement: Element): JQueryPromise; - /** Moves the specified item to the specified position in the list. */ - reorderItem(itemIndex: any, toItemIndex: any): JQueryPromise; - /** Scrolls the list content by the specified number of pixels. */ - scrollBy(distance: number): void; - /** Returns the height of the list content in pixels. */ - scrollHeight(): number; - /** Scrolls list content to the specified position. */ - scrollTo(location: number): void; - /** Scrolls the list to the specified item. */ - scrollToItem(itemElement: Element): void; - /** Scrolls the list to the specified item. */ - scrollToItem(itemIndex: any): void; - /** Returns how far the list content is scrolled from the top. */ - scrollTop(): number; - /** Selects the specified item from the list. */ - selectItem(itemElement: Element): void; - /** Selects the specified item from the list. */ - selectItem(itemIndex: any): void; - /** Deselects the specified item from the list. */ - unselectItem(itemElement: Element): void; - /** Unselects the specified item from the list. */ - unselectItem(itemIndex: any): void; - /** Updates the widget scrollbar according to widget content size. */ - updateDimensions(): JQueryPromise; - /** Expands the specified group. */ - expandGroup(groupIndex: number): JQueryPromise; - /** Collapses the specified group. */ - collapseGroup(groupIndex: number): JQueryPromise; - } - export interface dxGalleryOptions extends CollectionWidgetOptions { - /** The time, in milliseconds, spent on slide animation. */ - animationDuration?: number; - /** Specifies whether or not to animate the displayed item change. */ - animationEnabled?: boolean; - /** A Boolean value specifying whether or not to allow users to switch between items by clicking an indicator. */ - indicatorEnabled?: boolean; - /** A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped. */ - loop?: boolean; - /** The index of the currently active gallery item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to display an indicator that points to the selected gallery item. */ - showIndicator?: boolean; - /** A Boolean value that specifies the availability of the "Forward" and "Back" navigation buttons. */ - showNavButtons?: boolean; - /** The time interval in milliseconds, after which the gallery switches to the next item. */ - slideshowDelay?: number; - /** A Boolean value specifying whether or not to allow users to switch between items by swiping. */ - swipeEnabled?: boolean; - /** Specifies whether or not to display parts of previous and next images along the sides of the current image. */ - wrapAround?: boolean; - /** Specifies if the widget stretches images to fit the total gallery width. */ - stretchImages?: boolean; - /** Specifies the width of an area used to display a single image. */ - initialItemWidth?: number; - } - /** An image gallery widget. */ - export class dxGallery extends CollectionWidget { - constructor(element: JQuery, options?: dxGalleryOptions); - constructor(element: Element, options?: dxGalleryOptions); - /** Shows the specified gallery item. */ - goToItem(itemIndex: number, animation: boolean): JQueryPromise; - /** Shows the next gallery item. */ - nextItem(animation: boolean): JQueryPromise; - /** Shows the previous gallery item. */ - prevItem(animation: boolean): JQueryPromise; - } - export interface dxDropDownEditorOptions extends dxTextBoxOptions { - /** Specifies the current value displayed by the widget. */ - value?: Object; - /** A handler for the closed event. */ - onClosed?: Function; - /** A handler for the opened event. */ - onOpened?: Function; - /** Specifies whether or not the drop-down editor is displayed. */ - opened?: boolean; - fieldEditEnabled?: boolean; - /** Specifies whether or not the widget allows an end-user to enter a custom value. */ - acceptCustomValue?: boolean; - /** Specifies the way an end-user applies the selected value. */ - applyValueMode?: string; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - activeStateEnabled?: boolean; - } - /** A drop-down editor widget. */ - export class dxDropDownEditor extends dxTextBox { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - /** Closes the drop-down editor. */ - close(): void; - /** Opens the drop-down editor. */ - open(): void; - /** Resets the widget's value to null. */ - reset(): void; - /** Returns an <input> element of the widget. */ - field(): JQuery; - /** Returns an HTML element of the popup window content. */ - content(): JQuery; - } - export interface dxDateBoxOptions extends dxTextEditorOptions { - formatString?: any; - /** Specifies the date display format. Applies only if the pickerType option is 'native' */ - displayFormat?: any; - format?: string; - /** A format used to display date/time information. */ - type?: string; - /** The last date that can be selected within the widget. */ - max?: any; - /** The minimum date that can be selected within the widget. */ - min?: any; - /** The text displayed by the widget when the widget value is not yet specified. This text is also used as a title of the date picker. */ - placeholder?: string; - /** - * Specifies whether or not a user can pick out a date using the drop-down calendar. - * @deprecated Use the pickerType option instead. - */ - useCalendar?: boolean; - /** An object or a value, specifying the date and time currently selected using the date box. */ - value?: any; - /** - * Specifies whether or not the widget uses the native HTML input element. - * @deprecated Use the pickerType option instead. - */ - useNative?: boolean; - /** Specifies the interval between neighboring values in the popup list in minutes. */ - interval?: number; - /** Specifies the maximum zoom level of a calendar, which is used to pick the date. */ - maxZoomLevel?: string; - /** Specifies the minimal zoom level of a calendar, which is used to pick the date. */ - minZoomLevel?: string; - /** Specifies the type of date/time picker. */ - pickerType?: string; - /** Specifies the message displayed if the typed value is not a valid date or time. */ - invalidDateMessage?: string; - /** Specifies the message displayed if the specified date is later than the max value or earlier than the min value. */ - dateOutOfRangeMessage?: string; - /** The text displayed on the Apply button. */ - applyButtonText?: string; - /** Specifies whether or not adaptive widget rendering is enabled on a small screen. */ - adaptivityEnabled?: boolean; - /** The text displayed on the Cancel button. */ - cancelButtonText?: string; - } - /** A date box widget. */ - export class dxDateBox extends dxDropDownEditor { - constructor(element: JQuery, options?: dxDateBoxOptions); - constructor(element: Element, options?: dxDateBoxOptions); - } - export interface dxCheckBoxOptions extends EditorOptions { - activeStateEnabled?: boolean; - /** Specifies the widget state. */ - value?: boolean; - /** Specifies the text displayed by the check box. */ - text?: string; - } - /** A check box widget. */ - export class dxCheckBox extends Editor { - constructor(element: JQuery, options?: dxCheckBoxOptions); - constructor(element: Element, options?: dxCheckBoxOptions); - } - export interface dxCalendarOptions extends EditorOptions { - activeStateEnabled?: boolean; - /** Specifies a date displayed on the current calendar page. */ - currentDate?: Date; - /** Specifies the first day of a week. */ - firstDayOfWeek?: number; - /** An object or a value, specifying the date and time currently selected in the calendar. */ - value?: any; - /** The latest date the widget allows to select. */ - max?: any; - /** The earliest date the widget allows to select. */ - min?: any; - /** Specifies whether or not the widget displays a button that selects the current date. */ - showTodayButton?: boolean; - /** Specifies the current calendar zoom level. */ - zoomLevel?: string; - /** Specifies the maximum zoom level of the calendar. */ - maxZoomLevel?: string; - /** Specifies the minimum zoom level of the calendar. */ - minZoomLevel?: string; - /** The template to be used for rendering calendar cells. */ - cellTemplate?: any; - } - /** A calendar widget. */ - export class dxCalendar extends Editor { - constructor(element: JQuery, options?: dxCalendarOptions); - constructor(element: Element, options?: dxCalendarOptions); - } - export interface dxButtonOptions extends WidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A handler for the click event. */ - onClick?: any; - /** Specifies the icon to be displayed on the button. */ - icon?: string; - iconSrc?: string; - /** A template to be used for rendering the dxButton widget. */ - template?: any; - /** The text displayed on the button. */ - text?: string; - /** Specifies the button type. */ - type?: string; - /** Specifies the name of the validation group to be accessed in the click event handler. */ - validationGroup?: string; - } - /** A button widget. */ - export class dxButton extends Widget { - constructor(element: JQuery, options?: dxButtonOptions); - constructor(element: Element, options?: dxButtonOptions); - } - export interface dxBoxOptions extends CollectionWidgetOptions { - /** Specifies how widget items are aligned along the main direction. */ - align?: string; - /** Specifies the direction of item positioning in the widget. */ - direction?: string; - /** Specifies how widget items are aligned cross-wise. */ - crossAlign?: string; - } - /** A container widget used to arrange inner elements. */ - export class dxBox extends CollectionWidget { - constructor(element: JQuery, options?: dxBoxOptions); - constructor(element: Element, options?: dxBoxOptions); - } - export interface dxResponsiveBoxOptions extends CollectionWidgetOptions { - /** Specifies the collection of rows for the grid used to position layout elements. */ - rows?: Array; - /** Specifies the collection of columns for the grid used to position layout elements. */ - cols?: Array; - /** Specifies the function returning the screen factor depending on the screen width. */ - screenByWidth?: (width: number) => string; - /** Specifies the screen factor with which all elements are located in a single column. */ - singleColumnScreen?: string; - } - /** A widget used to build an adaptive markup that is dependent on screen resolution. */ - export class dxResponsiveBox extends CollectionWidget { - constructor(element: JQuery, options?: dxBoxOptions); - constructor(element: Element, options?: dxBoxOptions); - } - export interface dxAutocompleteOptions extends dxDropDownListOptions { - /** Specifies the current value displayed by the widget. */ - value?: string; - /** The minimum number of characters that must be entered into the text box to begin a search. */ - minSearchLength?: number; - /** Specifies the maximum count of items displayed by the widget. */ - maxItemCount?: number; - /** Gets the currently selected item. */ - selectedItem?: Object; - } - /** A textbox widget that supports autocompletion. */ - export class dxAutocomplete extends dxDropDownList { - constructor(element: JQuery, options?: dxAutocompleteOptions); - constructor(element: Element, options?: dxAutocompleteOptions); - /** Opens the drop-down editor. */ - open(): void; - /** Closes the drop-down editor. */ - close(): void; - } - export interface dxAccordionOptions extends CollectionWidgetOptions { - /** A number specifying the time in milliseconds spent on the animation of the expanding or collapsing of a panel. */ - animationDuration?: number; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies whether all items can be collapsed or whether at least one item must always be expanded. */ - collapsible?: boolean; - /** Specifies whether the widget can expand several items or only a single item at once. */ - multiple?: boolean; - /** The template to be used for rendering dxAccordion items. */ - itemTemplate?: any; - /** A handler for the itemTitleClick event. */ - onItemTitleClick?: any; - /** The template to be used for rendering an item title. */ - itemTitleTemplate?: any; - /** The index number of the currently selected item. */ - selectedIndex?: number; - /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */ - deferRendering?: boolean; - } - /** A widget that displays data source items on collapsible panels. */ - export class dxAccordion extends CollectionWidget { - constructor(element: JQuery, options?: dxAccordionOptions); - constructor(element: Element, options?: dxAccordionOptions); - /** Collapses the specified item. */ - collapseItem(index: number): JQueryPromise; - /** Expands the specified item. */ - expandItem(index: number): JQueryPromise; - /** Updates the dimensions of the widget contents. */ - updateDimensions(): JQueryPromise; - } - export interface dxFileUploaderOptions extends EditorOptions { - /** A read-only option that holds a File instance representing the selected file. */ - value?: Array; - values?: Array; - buttonText?: string; - /** The text displayed on the button that opens the file browser. */ - selectButtonText?: string; - /** The text displayed on the button that starts uploading. */ - uploadButtonText?: string; - /** Specifies the text displayed on the area to which an end-user can drop a file. */ - labelText?: string; - /** Specifies the value passed to the name attribute of the underlying input element. */ - name?: string; - /** Specifies whether the widget enables an end-user to select a single file or multiple files. */ - multiple?: boolean; - /** Specifies a file type or several types accepted by the widget. */ - accept?: string; - /** Specifies a target Url for the upload request. */ - uploadUrl?: string; - /** Specifies if an end user can remove a file from the selection and interrupt uploading. */ - allowCanceling?: boolean; - /** Specifies whether or not the widget displays the list of selected files. */ - showFileList?: boolean; - /** Gets the current progress in percentages. */ - progress?: number; - /** The message displayed by the widget when it is ready to upload the specified files. */ - readyToUploadMessage?: string; - /** The message displayed by the widget when uploading is finished. */ - uploadedMessage?: string; - /** The message displayed by the widget on uploading failure. */ - uploadFailedMessage?: string; - /** Specifies how the widget uploads files. */ - uploadMode?: string; - /** Specifies the method for the upload request. */ - uploadMethod?: string; - /** Specifies headers for the upload request. */ - uploadHeaders?: Object; - /** A handler for the uploadStarted event. */ - onUploadStarted?: Function; - /** A handler for the uploaded event. */ - onUploaded?: Function; - /** A handler for the uploaded event. */ - onProgress?: Function; - /** A handler for the uploadError event. */ - onUploadError?: Function; - /** A handler for the uploadAborted event. */ - onUploadAborted?: Function; - /** A handler for the valueChanged event. */ - onValueChanged?: Function; - } - /** A widget used to select and upload a file or multiple files. */ - export class dxFileUploader extends Editor { - constructor(element: JQuery, options?: dxFileUploaderOptions); - constructor(element: Element, options?: dxFileUploaderOptions); - } - export interface dxTrackBarOptions extends EditorOptions { - /** The minimum value the widget can accept. */ - min?: number; - /** The maximum value the widget can accept. */ - max?: number; - /** The current widget value. */ - value?: number; - } - /** A base class for track bar widgets. */ - export class dxTrackBar extends Editor { - constructor(element: JQuery, options?: dxTrackBarOptions); - constructor(element: Element, options?: dxTrackBarOptions); - } - export interface dxProgressBarOptions extends dxTrackBarOptions { - /** Specifies a format for the progress status. */ - statusFormat?: any; - /** Specifies whether or not the widget displays a progress status. */ - showStatus?: boolean; - /** A handler for the complete event. */ - onComplete?: Function; - } - /** A widget used to indicate progress. */ - export class dxProgressBar extends dxTrackBar { - constructor(element: JQuery, options?: dxProgressBarOptions); - constructor(element: Element, options?: dxProgressBarOptions); - } - export interface dxSliderOptions extends dxTrackBarOptions { - activeStateEnabled?: boolean; - /** The slider step size. */ - step?: number; - /** The current slider value. */ - value?: number; - /** Specifies whether or not to highlight a range selected within the widget. */ - showRange?: boolean; - /** Specifies the size of a step by which a slider handle is moved when a user uses the Page up or Page down keyboard shortcuts. */ - keyStep?: number; - /** Specifies options for the slider tooltip. */ - tooltip?: { - /** Specifies whether or not the tooltip is enabled. */ - enabled?: boolean; - /** Specifies format for the tooltip. */ - format?: any; - /** Specifies whether the tooltip is located over or under the slider. */ - position?: string; - /** Specifies whether the widget always shows a tooltip or only when a pointer is over the slider. */ - showMode?: string; - }; - /** Specifies options for labels displayed at the min and max values. */ - label?: { - /** Specifies whether or not slider labels are visible. */ - visible?: boolean; - /** Specifies whether labels are located over or under the scale. */ - position?: string; - /** Specifies a format for labels. */ - format?: any; - }; - } - /** A widget that allows a user to select a numeric value within a given range. */ - export class dxSlider extends dxTrackBar { - constructor(element: JQuery, options?: dxSliderOptions); - constructor(element: Element, options?: dxSliderOptions); - } - export interface dxRangeSliderOptions extends dxSliderOptions { - /** The left edge of the interval currently selected using the range slider. */ - start?: number; - /** The right edge of the interval currently selected using the range slider. */ - end?: number; - } - /** A widget that enables a user to select a range of numeric values. */ - export class dxRangeSlider extends dxSlider { - constructor(element: JQuery, options?: dxRangeSliderOptions); - constructor(element: Element, options?: dxRangeSliderOptions); - } - export interface dxFormItemLabel { - /** Specifies the label text. */ - text?: string; - /** Specifies whether or not the label is visible. */ - visible?: boolean; - /** Specifies whether or not a colon is displayed at the end of the current label. */ - showColon?: boolean; - /** Specifies the location of a label against the editor. */ - location?: string; - /** Specifies the label horizontal alignment. */ - alignment?: string; - } - export interface dxFormItem { - /** Specifies the type of the current item. */ - itemType?: string; - /** Specifies whether or not the current form item is visible. */ - visible?: boolean; - /** Specifies the sequence number of the item in a form, group or tab. */ - visibleIndex?: number; - /** Specifies a CSS class to be applied to the form item. */ - cssClass?: string; - /** Specifies the number of columns spanned by the item. */ - colSpan?: number; - } - export interface dxFormEmptyItem extends dxFormItem { - /** Specifies the form item name. */ - name?: string; - } - export interface dxFormSimpleItem extends dxFormItem { - /** Specifies the path to the formData object field bound to the current form item. */ - dataField?: string; - /** Specifies the form item name. */ - name?: string; - /** Specifies which editor widget is used to display and edit the form item value. */ - editorType?: string; - /** Specifies configuration options for the editor widget of the current form item. */ - editorOptions?: Object; - /** A template to be used for rendering the form item. */ - template?: any; - /** Specifies the help text displayed for the current form item. */ - helpText?: string; - /** Specifies whether the current form item is required. */ - isRequired?: boolean; - /** Specifies options for the form item label. */ - label?: dxFormItemLabel; - /** An array of validation rules to be checked for the form item editor. */ - validationRules?: Array; - } - /** Specifies dependency between the screen factor and the count of columns. */ - export interface ColCountResponsible { - /** The count of columns for an extra small-sized screen. */ - xs?: number; - /** The count of columns for a small-sized screen. */ - sm?: number; - /** The count of columns for a middle-sized screen. */ - md?: number; - /** The count of columns for a large screen size. */ - lg?: number; - } - export interface dxFormGroupItem extends dxFormItem { - /** Specifies the group caption. */ - caption?: string; - /** A template to be used for rendering a group item. */ - template?: any; - /** The count of columns in the group layout. */ - colCount?: number; - /** Specifies dependency between the screen factor and the count of columns in the tab layout. */ - colCountByScreen?: ColCountResponsible; - /** Specifies whether or not all group item labels are aligned. */ - alignItemLabels?: boolean; - /** Holds an array of form items displayed within the group. */ - items?: Array; - } - export interface dxFormTab { - /** Specifies the tab title. */ - title?: string; - /** The count of columns in the tab layout. */ - colCount?: number; - /** Specifies dependency between the screen factor and the count of columns in the group layout. */ - colCountByScreen?: ColCountResponsible; - /** Specifies whether or not labels of items displayed within the current tab are aligned. */ - alignItemLabels?: boolean; - /** Holds an array of form items displayed within the tab. */ - items?: Array; - /** Specifies a badge text for the tab. */ - badge?: string; - /** A Boolean value specifying whether or not the tab can respond to user interaction. */ - disabled?: boolean; - /** Specifies the icon to be displayed on the tab. */ - icon?: string; - /** The template to be used for rendering the tab. */ - tabTemplate?: any; - /** The template to be used for rendering the tab content. */ - template?: any; - } - export interface dxFormTabbedItem extends dxFormItem { - /** Holds a configuration object for the dxTabPanel widget used to display the current form item. */ - tabPanelOptions?: Object; - /** An array of tab configuration objects. */ - tabs?: Array; - } - export interface dxFormOptions extends WidgetOptions { - /** An object providing data for the form. */ - formData?: Object; - /** The count of columns in the form layout. */ - colCount?: any; - /** Specifies dependency between the screen factor and the count of columns in the form layout. */ - colCountByScreen?: ColCountResponsible; - /** Specifies the function returning the screen factor depending on the screen width. */ - screenByWidth?: (width: number) => string; - /** Specifies the location of a label against the editor. */ - labelLocation?: string; - /** Specifies whether or not all editors on the form are read-only. */ - readOnly?: boolean; - /** A handler for the fieldDataChanged event. */ - onFieldDataChanged?: (e: Object) => void; - /** A handler for the editorEnterKey event. */ - onEditorEnterKey?: (e: Object) => void; - /** Specifies a function that customizes a form item after it has been created. */ - customizeItem?: Function; - /** The minimum column width used for calculating column count in the form layout. */ - minColWidth?: number; - /** Specifies whether or not all root item labels are aligned. */ - alignItemLabels?: boolean; - /** Specifies whether or not item labels in all groups are aligned. */ - alignItemLabelsInAllGroups?: boolean; - /** Specifies whether or not a colon is displayed at the end of form labels. */ - showColonAfterLabel?: boolean; - /** Specifies whether or not the required mark is displayed for required fields. */ - showRequiredMark?: boolean; - /** Specifies whether or not the optional mark is displayed for optional fields. */ - showOptionalMark?: boolean; - /** The text displayed for required fields. */ - requiredMark?: string; - /** The text displayed for optional fields. */ - optionalMark?: string; - /** Specifies the message that is shown for end-users if a required field value is not specified. */ - requiredMessage?: string; - /** Specifies whether or not the total validation summary is displayed on the form. */ - showValidationSummary?: boolean; - /** Holds an array of form items. */ - items?: Array; - /** A Boolean value specifying whether to enable or disable form scrolling. */ - scrollingEnabled?: boolean; - onContentReady?: Function; - } - /** A form widget used to display and edit values of object fields. */ - export class dxForm extends Widget { - constructor(element: JQuery, options?: dxFormOptions); - constructor(element: Element, options?: dxFormOptions); - /** Updates the specified field of the formData object and the corresponding editor on the form. */ - updateData(dataField: string, value: any): void; - /** Updates the specified fields of the formData object and the corresponding editors on the form. */ - updateData(data: Object): void; - /** Updates the value of a form item option. */ - itemOption(field: string, option: string, value: any): void; - /** Updates the values of form item options. */ - itemOption(field: string, options: Object): void; - /** Gets the value of the form item option. */ - itemOption(field: string): any; - /** Returns an editor instance associated with the specified formData field or name of the form item. */ - getEditor(field: string): Object; - /** Updates the dimensions of the widget contents. */ - updateDimensions(): JQueryPromise; - /** Validates the values of all editors on the form against the list of the validation rules specified for each form item. */ - validate(): Object; - /** Resets the editor's value to undefined. */ - resetValues(): void; - } - export interface dxDeferRenderingOptions extends WidgetOptions { - /** Indicates if a load indicator should be shown until the widget's content is rendered. */ - showLoadIndicator?: boolean; - /** Specifies the jQuery.Promise or boolean value, which when resolved, forces widget content to render. */ - renderWhen?: any; - /** Specifies the animation to be used to show the rendered content. */ - animation?: fx.AnimationOptions; - /** Specifies a jQuery selector of items that should be rendered using a staggered animation. */ - staggerItemSelector?: string; - /** Specifies a callback function that is called when the widget's content has finished rendering but is not yet shown. */ - onRendered?: Function; - /** Specifies a callback function that is called when widget content is shown and animation has completed. */ - onShown?: Function; - } - /** A container for elements that must be rendered at a specified moment. */ - export class dxDeferRendering extends Widget { - constructor(element: JQuery, options?: dxDeferRenderingOptions); - constructor(element: Element, options?: dxDeferRenderingOptions); - } -} -interface JQuery { - dxProgressBar(): JQuery; - dxProgressBar(options: "instance"): DevExpress.ui.dxProgressBar; - dxProgressBar(options: string): any; - dxProgressBar(options: string, ...params: any[]): any; - dxProgressBar(options: DevExpress.ui.dxProgressBarOptions): JQuery; - dxSlider(): JQuery; - dxSlider(options: "instance"): DevExpress.ui.dxSlider; - dxSlider(options: string): any; - dxSlider(options: string, ...params: any[]): any; - dxSlider(options: DevExpress.ui.dxSliderOptions): JQuery; - dxRangeSlider(): JQuery; - dxRangeSlider(options: "instance"): DevExpress.ui.dxRangeSlider; - dxRangeSlider(options: string): any; - dxRangeSlider(options: string, ...params: any[]): any; - dxRangeSlider(options: DevExpress.ui.dxRangeSliderOptions): JQuery; - dxFileUploader(): JQuery; - dxFileUploader(options: "instance"): DevExpress.ui.dxFileUploader; - dxFileUploader(options: string): any; - dxFileUploader(options: string, ...params: any[]): any; - dxFileUploader(options: DevExpress.ui.dxFileUploaderOptions): JQuery; - dxValidator(): JQuery; - dxValidator(options: "instance"): DevExpress.ui.dxValidator; - dxValidator(options: string): any; - dxValidator(options: string, ...params: any[]): any; - dxValidator(options: DevExpress.ui.dxValidatorOptions): JQuery; - dxValidationGroup(): JQuery; - dxValidationGroup(options: "instance"): DevExpress.ui.dxValidationGroup; - dxValidationGroup(options: string): any; - dxValidationGroup(options: string, ...params: any[]): any; - dxValidationSummary(): JQuery; - dxValidationSummary(options: "instance"): DevExpress.ui.dxValidationSummary; - dxValidationSummary(options: string): any; - dxValidationSummary(options: string, ...params: any[]): any; - dxValidationSummary(options: DevExpress.ui.dxValidationSummaryOptions): JQuery; - dxTooltip(): JQuery; - dxTooltip(options: "instance"): DevExpress.ui.dxTooltip; - dxTooltip(options: string): any; - dxTooltip(options: string, ...params: any[]): any; - dxTooltip(options: DevExpress.ui.dxTooltipOptions): JQuery; - dxResizable(): JQuery; - dxResizable(options: "instance"): DevExpress.ui.dxResizable; - dxResizable(options: string): any; - dxResizable(options: string, ...params: any[]): any; - dxResizable(options: DevExpress.ui.dxResizableOptions): JQuery; - dxDropDownList(): JQuery; - dxDropDownList(options: "instance"): DevExpress.ui.dxDropDownList; - dxDropDownList(options: string): any; - dxDropDownList(options: string, ...params: any[]): any; - dxDropDownList(options: DevExpress.ui.dxDropDownListOptions): JQuery; - dxToolbar(): JQuery; - dxToolbar(options: "instance"): DevExpress.ui.dxToolbar; - dxToolbar(options: string): any; - dxToolbar(options: string, ...params: any[]): any; - dxToolbar(options: DevExpress.ui.dxToolbarOptions): JQuery; - dxToast(): JQuery; - dxToast(options: "instance"): DevExpress.ui.dxToast; - dxToast(options: string): any; - dxToast(options: string, ...params: any[]): any; - dxToast(options: DevExpress.ui.dxToastOptions): JQuery; - dxTextEditor(): JQuery; - dxTextEditor(options: "instance"): DevExpress.ui.dxTextEditor; - dxTextEditor(options: string): any; - dxTextEditor(options: string, ...params: any[]): any; - dxTextEditor(options: DevExpress.ui.dxTextEditorOptions): JQuery; - dxTextBox(): JQuery; - dxTextBox(options: "instance"): DevExpress.ui.dxTextBox; - dxTextBox(options: string): any; - dxTextBox(options: string, ...params: any[]): any; - dxTextBox(options: DevExpress.ui.dxTextBoxOptions): JQuery; - dxTextArea(): JQuery; - dxTextArea(options: "instance"): DevExpress.ui.dxTextArea; - dxTextArea(options: string): any; - dxTextArea(options: string, ...params: any[]): any; - dxTextArea(options: DevExpress.ui.dxTextAreaOptions): JQuery; - dxTabs(): JQuery; - dxTabs(options: "instance"): DevExpress.ui.dxTabs; - dxTabs(options: string): any; - dxTabs(options: string, ...params: any[]): any; - dxTabs(options: DevExpress.ui.dxTabsOptions): JQuery; - dxTabPanel(): JQuery; - dxTabPanel(options: "instance"): DevExpress.ui.dxTabPanel; - dxTabPanel(options: string): any; - dxTabPanel(options: string, ...params: any[]): any; - dxTabPanel(options: DevExpress.ui.dxTabPanelOptions): JQuery; - dxSelectBox(): JQuery; - dxSelectBox(options: "instance"): DevExpress.ui.dxSelectBox; - dxSelectBox(options: string): any; - dxSelectBox(options: string, ...params: any[]): any; - dxSelectBox(options: DevExpress.ui.dxSelectBoxOptions): JQuery; - dxTagBox(): JQuery; - dxTagBox(options: "instance"): DevExpress.ui.dxTagBox; - dxTagBox(options: string): any; - dxTagBox(options: string, ...params: any[]): any; - dxTagBox(options: DevExpress.ui.dxTagBoxOptions): JQuery; - dxScrollView(): JQuery; - dxScrollView(options: "instance"): DevExpress.ui.dxScrollView; - dxScrollView(options: string): any; - dxScrollView(options: string, ...params: any[]): any; - dxScrollView(options: DevExpress.ui.dxScrollViewOptions): JQuery; - dxScrollable(): JQuery; - dxScrollable(options: "instance"): DevExpress.ui.dxScrollable; - dxScrollable(options: string): any; - dxScrollable(options: string, ...params: any[]): any; - dxScrollable(options: DevExpress.ui.dxScrollableOptions): JQuery; - dxRadioGroup(): JQuery; - dxRadioGroup(options: "instance"): DevExpress.ui.dxRadioGroup; - dxRadioGroup(options: string): any; - dxRadioGroup(options: string, ...params: any[]): any; - dxRadioGroup(options: DevExpress.ui.dxRadioGroupOptions): JQuery; - dxPopup(): JQuery; - dxPopup(options: "instance"): DevExpress.ui.dxPopup; - dxPopup(options: string): any; - dxPopup(options: string, ...params: any[]): any; - dxPopup(options: DevExpress.ui.dxPopupOptions): JQuery; - dxPopover(): JQuery; - dxPopover(options: "instance"): DevExpress.ui.dxPopover; - dxPopover(options: string): any; - dxPopover(options: string, ...params: any[]): any; - dxPopover(options: DevExpress.ui.dxPopoverOptions): JQuery; - dxOverlay(): JQuery; - dxOverlay(options: "instance"): DevExpress.ui.dxOverlay; - dxOverlay(options: string): any; - dxOverlay(options: string, ...params: any[]): any; - dxOverlay(options: DevExpress.ui.dxOverlayOptions): JQuery; - dxNumberBox(): JQuery; - dxNumberBox(options: "instance"): DevExpress.ui.dxNumberBox; - dxNumberBox(options: string): any; - dxNumberBox(options: string, ...params: any[]): any; - dxNumberBox(options: DevExpress.ui.dxNumberBoxOptions): JQuery; - dxNavBar(): JQuery; - dxNavBar(options: "instance"): DevExpress.ui.dxNavBar; - dxNavBar(options: string): any; - dxNavBar(options: string, ...params: any[]): any; - dxNavBar(options: DevExpress.ui.dxNavBarOptions): JQuery; - dxMultiView(): JQuery; - dxMultiView(options: "instance"): DevExpress.ui.dxMultiView; - dxMultiView(options: string): any; - dxMultiView(options: string, ...params: any[]): any; - dxMultiView(options: DevExpress.ui.dxMultiViewOptions): JQuery; - dxMap(): JQuery; - dxMap(options: "instance"): DevExpress.ui.dxMap; - dxMap(options: string): any; - dxMap(options: string, ...params: any[]): any; - dxMap(options: DevExpress.ui.dxMapOptions): JQuery; - dxLookup(): JQuery; - dxLookup(options: "instance"): DevExpress.ui.dxLookup; - dxLookup(options: string): any; - dxLookup(options: string, ...params: any[]): any; - dxLookup(options: DevExpress.ui.dxLookupOptions): JQuery; - dxLoadPanel(): JQuery; - dxLoadPanel(options: "instance"): DevExpress.ui.dxLoadPanel; - dxLoadPanel(options: string): any; - dxLoadPanel(options: string, ...params: any[]): any; - dxLoadPanel(options: DevExpress.ui.dxLoadPanelOptions): JQuery; - dxLoadIndicator(): JQuery; - dxLoadIndicator(options: "instance"): DevExpress.ui.dxLoadIndicator; - dxLoadIndicator(options: string): any; - dxLoadIndicator(options: string, ...params: any[]): any; - dxLoadIndicator(options: DevExpress.ui.dxLoadIndicatorOptions): JQuery; - dxList(): JQuery; - dxList(options: "instance"): DevExpress.ui.dxList; - dxList(options: string): any; - dxList(options: string, ...params: any[]): any; - dxList(options: DevExpress.ui.dxListOptions): JQuery; - dxGallery(): JQuery; - dxGallery(options: "instance"): DevExpress.ui.dxGallery; - dxGallery(options: string): any; - dxGallery(options: string, ...params: any[]): any; - dxGallery(options: DevExpress.ui.dxGalleryOptions): JQuery; - dxDropDownEditor(): JQuery; - dxDropDownEditor(options: "instance"): DevExpress.ui.dxDropDownEditor; - dxDropDownEditor(options: string): any; - dxDropDownEditor(options: string, ...params: any[]): any; - dxDropDownEditor(options: DevExpress.ui.dxDropDownEditorOptions): JQuery; - dxDateBox(): JQuery; - dxDateBox(options: "instance"): DevExpress.ui.dxDateBox; - dxDateBox(options: string): any; - dxDateBox(options: string, ...params: any[]): any; - dxDateBox(options: DevExpress.ui.dxDateBoxOptions): JQuery; - dxCheckBox(): JQuery; - dxCheckBox(options: "instance"): DevExpress.ui.dxCheckBox; - dxCheckBox(options: string): any; - dxCheckBox(options: string, ...params: any[]): any; - dxCheckBox(options: DevExpress.ui.dxCheckBoxOptions): JQuery; - dxBox(): JQuery; - dxBox(options: "instance"): DevExpress.ui.dxBox; - dxBox(options: string): any; - dxBox(options: string, ...params: any[]): any; - dxBox(options: DevExpress.ui.dxBoxOptions): JQuery; - dxButton(): JQuery; - dxButton(options: "instance"): DevExpress.ui.dxButton; - dxButton(options: string): any; - dxButton(options: string, ...params: any[]): any; - dxButton(options: DevExpress.ui.dxButtonOptions): JQuery; - dxCalendar(): JQuery; - dxCalendar(options: "instance"): DevExpress.ui.dxCalendar; - dxCalendar(options: string): any; - dxCalendar(options: string, ...params: any[]): any; - dxCalendar(options: DevExpress.ui.dxCalendarOptions): JQuery; - dxAccordion(): JQuery; - dxAccordion(options: "instance"): DevExpress.ui.dxAccordion; - dxAccordion(options: string): any; - dxAccordion(options: string, ...params: any[]): any; - dxAccordion(options: DevExpress.ui.dxAccordionOptions): JQuery; - dxResponsiveBox(): JQuery; - dxResponsiveBox(options: "instance"): DevExpress.ui.dxResponsiveBox; - dxResponsiveBox(options: string): any; - dxResponsiveBox(options: string, ...params: any[]): any; - dxResponsiveBox(options: DevExpress.ui.dxResponsiveBoxOptions): JQuery; - dxAutocomplete(): JQuery; - dxAutocomplete(options: "instance"): DevExpress.ui.dxAutocomplete; - dxAutocomplete(options: string): any; - dxAutocomplete(options: string, ...params: any[]): any; - dxAutocomplete(options: DevExpress.ui.dxAutocompleteOptions): JQuery; - dxForm(): JQuery; - dxForm(options: "instance"): DevExpress.ui.dxForm; - dxForm(options: string): any; - dxForm(options: string, ...params: any[]): any; - dxForm(options: DevExpress.ui.dxFormOptions): JQuery; -} - -declare module DevExpress.ui { - export interface dxTileViewOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** Specifies the height of the base tile view item. */ - baseItemHeight?: number; - /** Specifies the width of the base tile view item. */ - baseItemWidth?: number; - /** Specifies whether tiles are placed horizontally or vertically. */ - direction?: string; - /** Specifies the height of the widget. */ - height?: any; - /** Specifies the distance in pixels between adjacent tiles. */ - itemMargin?: number; - /** A Boolean value specifying whether or not to display a scrollbar. */ - showScrollbar?: boolean; - } - /** A widget displaying several blocks of data as tiles. */ - export class dxTileView extends CollectionWidget { - constructor(element: JQuery, options?: dxTileViewOptions); - constructor(element: Element, options?: dxTileViewOptions); - /** Returns the current scroll position of the widget content. */ - scrollPosition(): number; - } - export interface dxSwitchOptions extends EditorOptions { - activeStateEnabled?: boolean; - /** Text displayed when the widget is in a disabled state. */ - offText?: string; - /** Text displayed when the widget is in an enabled state. */ - onText?: string; - /** A Boolean value specifying whether the current switch state is "On" or "Off". */ - value?: boolean; - } - /** A switch widget. */ - export class dxSwitch extends Editor { - constructor(element: JQuery, options?: dxSwitchOptions); - constructor(element: Element, options?: dxSwitchOptions); - } - export interface dxSlideOutViewOptions extends WidgetOptions { - /** Specifies the current menu position. */ - menuPosition?: string; - /** Specifies whether or not the menu panel is visible. */ - menuVisible?: boolean; - /** Specifies whether or not the menu is shown when a user swipes the widget content. */ - swipeEnabled?: boolean; - /** A template to be used for rendering menu panel content. */ - menuTemplate?: any; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - } - /** The widget that allows you to slide-out the current view to reveal a custom menu. */ - export class dxSlideOutView extends Widget { - constructor(element: JQuery, options?: dxSlideOutViewOptions); - constructor(element: Element, options?: dxSlideOutViewOptions); - /** Returns an HTML element of the widget menu block. */ - menuContent(): JQuery; - /** Returns an HTML element of the widget content block. */ - content(): JQuery; - /** Displays the widget's menu block. */ - showMenu(): JQueryPromise; - /** Hides the widget's menu block. */ - hideMenu(): JQueryPromise; - /** Toggles the visibility of the widget's menu block. */ - toggleMenuVisibility(): JQueryPromise; - } - export interface dxSlideOutOptions extends CollectionWidgetOptions { - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** A Boolean value specifying whether or not to display a grouped menu. */ - menuGrouped?: boolean; - /** Specifies the current menu position. */ - menuPosition?: string; - /** The name of the template used to display a group header. */ - menuGroupTemplate?: any; - /** The template used to render menu items. */ - menuItemTemplate?: any; - /** A handler for the menuGroupRendered event. */ - onMenuGroupRendered?: Function; - /** A handler for the menuItemRendered event. */ - onMenuItemRendered?: Function; - /** Specifies whether or not the slide-out menu is displayed. */ - menuVisible?: boolean; - /** Indicates whether the menu can be shown/hidden by swiping the widget's main panel. */ - swipeEnabled?: boolean; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - } - /** The widget that allows you to slide-out the current view to reveal an item list. */ - export class dxSlideOut extends CollectionWidget { - constructor(element: JQuery, options?: dxSlideOutOptions); - constructor(element: Element, options?: dxSlideOutOptions); - /** Hides the widget's slide-out menu. */ - hideMenu(): JQueryPromise; - /** Displays the widget's slide-out menu. */ - showMenu(): JQueryPromise; - /** Toggles the visibility of the widget's slide-out menu. */ - toggleMenuVisibility(showing: boolean): JQueryPromise; - } - export interface dxPivotOptions extends CollectionWidgetOptions { - /** The index of the currently active pivot item. */ - selectedIndex?: number; - /** A Boolean value specifying whether or not to allow users to switch between items by swiping. */ - swipeEnabled?: boolean; - /** A template to be used for rendering widget content. */ - contentTemplate?: any; - /** The template to be used for rendering an item title. */ - itemTitleTemplate?: any; - } - /** A widget that is similar to a traditional tab control, but optimized for the phone with simplified end-user interaction. */ - export class dxPivot extends CollectionWidget { - constructor(element: JQuery, options?: dxPivotOptions); - constructor(element: Element, options?: dxPivotOptions); - } - export interface dxPanoramaOptions extends CollectionWidgetOptions { - /** An object exposing options for setting a background image for the panorama. */ - backgroundImage?: { - /** Specifies the height of the panorama's background image. */ - height?: number; - /** Specifies the URL of the image that is used as the panorama's background image. */ - url?: string; - /** Specifies the width of the panorama's background image. */ - width?: number; - }; - /** The index of the currently active panorama item. */ - selectedIndex?: number; - /** Specifies the widget content title. */ - title?: string; - } - /** A widget displaying the required content in a long horizontal canvas that extends beyond the frames of the screen. */ - export class dxPanorama extends CollectionWidget { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - } - export interface dxDropDownMenuOptions extends WidgetOptions { - /** A handler for the buttonClick event. */ - onButtonClick?: any; - /** The name of the icon to be displayed by the DropDownMenu button. */ - buttonIcon?: string; - /** The text displayed in the DropDownMenu button. */ - buttonText?: string; - buttonIconSrc?: string; - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** A handler for the itemClick event. */ - onItemClick?: any; - /** An array of items displayed by the widget. */ - items?: Array; - /** The template to be used for rendering items. */ - itemTemplate?: any; - /** Specifies whether or not to show the drop down menu within a dxPopover widget. */ - usePopover?: boolean; - /** The width of the menu popup in pixels. */ - popupWidth?: any; - /** The height of the menu popup in pixels. */ - popupHeight?: any; - /** Specifies whether or not the drop-down menu is displayed. */ - opened?: boolean; - hoverStateEnabled?: boolean; - activeStateEnabled?: boolean; - } - /** A drop-down menu widget. */ - export class dxDropDownMenu extends Widget { - constructor(element: JQuery, options?: dxDropDownEditorOptions); - constructor(element: Element, options?: dxDropDownEditorOptions); - /** Opens the drop-down menu. */ - open(): void; - /** Closes the drop-down menu. */ - close(): void; - } - export interface dxActionSheetOptions extends CollectionWidgetOptions { - /** A handler for the cancelClick event. */ - onCancelClick?: any; - /** The text displayed in the button that closes the action sheet. */ - cancelText?: string; - /** Specifies whether or not to display the Cancel button in action sheet. */ - showCancelButton?: boolean; - /** A Boolean value specifying whether or not the title of the action sheet is visible. */ - showTitle?: boolean; - /** Specifies the element the action sheet popover points at. */ - target?: any; - /** The title of the action sheet. */ - title?: string; - /** Specifies whether or not to show the action sheet within a dxPopover widget. */ - usePopover?: boolean; - /** A Boolean value specifying whether or not the dxActionSheet widget is visible. */ - visible?: boolean; - } - /** A widget consisting of a set of choices related to a certain task. */ - export class dxActionSheet extends CollectionWidget { - constructor(element: JQuery, options?: dxActionSheetOptions); - constructor(element: Element, options?: dxActionSheetOptions); - /** Hides the widget. */ - hide(): JQueryPromise; - /** Shows the widget. */ - show(): JQueryPromise; - /** Shows or hides the widget depending on the Boolean value passed as the parameter. */ - toggle(showing: boolean): JQueryPromise; - } -} -interface JQuery { - dxTileView(): JQuery; - dxTileView(options: "instance"): DevExpress.ui.dxTileView; - dxTileView(options: string): any; - dxTileView(options: string, ...params: any[]): any; - dxTileView(options: DevExpress.ui.dxTileViewOptions): JQuery; - dxSwitch(): JQuery; - dxSwitch(options: "instance"): DevExpress.ui.dxSwitch; - dxSwitch(options: string): any; - dxSwitch(options: string, ...params: any[]): any; - dxSwitch(options: DevExpress.ui.dxSwitchOptions): JQuery; - dxSlideOut(): JQuery; - dxSlideOut(options: "instance"): DevExpress.ui.dxSlideOut; - dxSlideOut(options: string): any; - dxSlideOut(options: string, ...params: any[]): any; - dxSlideOut(options: DevExpress.ui.dxSlideOutOptions): JQuery; - dxPivot(): JQuery; - dxPivot(options: "instance"): DevExpress.ui.dxPivot; - dxPivot(options: string): any; - dxPivot(options: string, ...params: any[]): any; - dxPivot(options: DevExpress.ui.dxPivotOptions): JQuery; - dxPanorama(): JQuery; - dxPanorama(options: "instance"): DevExpress.ui.dxPanorama; - dxPanorama(options: string): any; - dxPanorama(options: string, ...params: any[]): any; - dxPanorama(options: DevExpress.ui.dxPanoramaOptions): JQuery; - dxActionSheet(): JQuery; - dxActionSheet(options: "instance"): DevExpress.ui.dxActionSheet; - dxActionSheet(options: string): any; - dxActionSheet(options: string, ...params: any[]): any; - dxActionSheet(options: DevExpress.ui.dxActionSheetOptions): JQuery; - dxDropDownMenu(): JQuery; - dxDropDownMenu(options: "instance"): DevExpress.ui.dxDropDownMenu; - dxDropDownMenu(options: string): any; - dxDropDownMenu(options: string, ...params: any[]): any; - dxDropDownMenu(options: DevExpress.ui.dxDropDownMenuOptions): JQuery; -} -declare module DevExpress.data { - export interface XmlaStoreOptions { - /** The HTTP address to an XMLA OLAP server. */ - url?: string; - /** The name of the database associated with the Store. */ - catalog?: string; - /** The cube name. */ - cube?: string; - /** A function used to customize a web request before it is sent. */ - beforeSend?: (request: Object) => void; - } - /** A Store that provides access to an OLAP cube using the XMLA standard. */ - export class XmlaStore { - constructor(options: XmlaStoreOptions); - } - export interface PivotGridField { - index?: number; - /** A boolean value specifying whether or not the field is visible in the pivot grid and the Field Chooser. */ - visible?: boolean; - /** Name of the data source field containing data for the pivot grid field. */ - dataField?: string; - /** A caption that will be displayed in the pivot grid's field chooser and field panel to identify the field. */ - caption?: string; - /** Specifies a type of field values. */ - dataType?: string; - /** Specifies how the values of the current field are combined into groups. Cannot be used for the XmlaStore store type. */ - groupInterval?: any; - /** Specifies how to aggregate field data. Cannot be used for the XmlaStore store type. */ - summaryType?: string; - /** Allows you to use a custom aggregate function to calculate the summary values. Cannot be used for the XmlaStore store type. */ - calculateCustomSummary?: (options: { - summaryProcess?: string; - value?: any; - totalValue?: any; - }) => void; - /** Specifies the function that determines how to split data from the data source into ranges for header items. Cannot be used for the XmlaStore store type. */ - selector?: (data: Object) => any; - /** Type of the area where the field is located. */ - area?: string; - /** Index among the other fields displayed within the same area. */ - areaIndex?: number; - /** The name of the folder in which the field is located. */ - displayFolder?: string; - /** The name of the group to which the field belongs. */ - groupName?: string; - /** The index of the field within a group. */ - groupIndex?: number; - /** Specifies the sort order of field values. */ - sortOrder?: string; - /** Specifies how field data should be sorted. Can be used for the XmlaStore store type only. */ - sortBy?: string; - /** Sorts the header items of this field by the summary values of another field. */ - sortBySummaryField?: string; - /** The array of field names that specify a path to column/row whose summary field is used for sorting of this field's header items. */ - sortBySummaryPath?: Array; - /** The filter values for the current field. */ - filterValues?: Array; - /** The filter type for the current field. */ - filterType?: string; - /** Indicates whether all header items of the field's header level are expanded. */ - expanded?: boolean; - /** Specifies whether the field should be treated as a Data Field. */ - isMeasure?: boolean; - /** Specifies whether or not long text in header items should be wrapped. */ - wordWrapEnabled?: boolean; - /** Specifies a display format for field values. */ - format?: any; - /** Specifies a callback function that returns the text to be displayed in the cells of a field. */ - customizeText?: (cellInfo: { value: any; valueText: string }) => string; - /** - * Specifies a precision for formatted field values. - * @deprecated Use the format | precision option instead. - */ - precision?: number; - /** Specifies how to sort the header items. */ - sortingMethod?: (a: Object, b: Object) => number; - /** Allows an end-user to change sorting options. */ - allowSorting?: boolean; - /** Allows an end-user to sort columns by summary values. */ - allowSortingBySummary?: boolean; - /** Allows an end-user to change filtering options. */ - allowFiltering?: boolean; - /** Allows an end-user to expand/collapse all header items within a header level. */ - allowExpandAll?: boolean; - /** Specifies the absolute width of the field in the pivot grid. */ - width?: number; - /** Specifies the summary post-processing algorithm. */ - summaryDisplayMode?: string; - /** Specifies whether to summarize each next summary value with the previous one by rows or columns. */ - runningTotal?: string; - /** Specifies whether to allow the predefined summary post-processing functions ('absoluteVariation' and 'percentVariation') and runningTotal to take values of different groups into account. */ - allowCrossGroupCalculation?: boolean; - /** Specifies a callback function that allows you to modify summary values after they are calculated. */ - calculateSummaryValue?: (e: Object) => number; - /** Specifies whether or not to display Total values for the field. */ - showTotals?: boolean; - /** Specifies whether or not to display Grand Total values for the field. */ - showGrandTotals?: boolean; - } - export class SummaryCell { - /** Gets the parent cell in a specified direction. */ - parent(direction: string): SummaryCell; - /** Gets all children cells in a specified direction. */ - children(direction: string): Array; - /** Gets a partial Grand Total cell of a row or column. */ - grandTotal(direction: string): SummaryCell; - /** Gets the Grand Total of the entire pivot grid. */ - grandTotal(): SummaryCell; - /** Gets the cell next to the current one in a specified direction. */ - next(direction: string): SummaryCell; - /** Gets the cell next to current in a specified direction. */ - next(direction: string, allowCrossGroup: boolean): SummaryCell; - /** Gets the cell prior to the current one in a specified direction. */ - prev(direction: string): SummaryCell; - /** Gets the cell previous to current in a specified direction. */ - prev(direction: string, allowCrossGroup: boolean): SummaryCell; - /** Gets the child cell in a specified direction. */ - child(direction: string, fieldValue: any): SummaryCell; - /** Gets the cell located by the path of the source cell with one field value changed. */ - slice(field: PivotGridField, value: any): SummaryCell; - /** Gets the row or column field to which the current cell belongs. */ - field(area: string): PivotGridField; - /** Gets the value of the current cell. */ - value(): any; - /** Gets the value of the current cell. */ - value(isCalculatedValue: boolean): any; - /** Gets the value of any field linked with the current cell. */ - value(field: PivotGridField): any; - /** Gets the value of any field linked with the current cell. */ - value(field: PivotGridField, isCalculatedValue: boolean): any; - } - export interface PivotGridDataSourceOptions { - /** Specifies the underlying Store instance used to access data. */ - store?: any; - /** Indicates whether or not the automatic field generation from data in the Store is enabled. */ - retrieveFields?: boolean; - /** Specifies data filtering conditions. Cannot be used for the XmlaStore store type. */ - filter?: Object; - /** An array of pivot grid fields. */ - fields?: Array; - /** A handler for the changed event. */ - onChanged?: () => void; - /** A handler for the loadingChanged event. */ - onLoadingChanged?: (isLoading: boolean) => void; - /** A handler for the loadError event. */ - onLoadError?: (e?: Object) => void; - /** A handler for the fieldsPrepared event. */ - onFieldsPrepared?: (e?: Array) => void; - } - /** An object that provides access to data for the dxPivotGrid widget. */ - export class PivotGridDataSource implements EventsMixin { - constructor(options?: PivotGridDataSourceOptions); - /** Starts reloading data from any store and updating the data source. */ - reload(): JQueryPromise; - /** Starts updating the data source. Reloads data from the XMLA store only. */ - load(): JQueryPromise; - /** Indicates whether or not the PivotGridDataSource is currently being loaded. */ - isLoading(): boolean; - /** Gets data displayed in a PivotGrid. */ - getData(): Object; - /** Gets all fields within a specified area. */ - getAreaFields(area: string, collectGroups: boolean): Array; - /** Gets all fields from the data source. */ - fields(): Array; - /** Sets the fields option. */ - fields(fields: Array): void; - /** Gets current options of a specified field. */ - field(id: any): PivotGridField; - /** Sets one or more options of a specified field. */ - field(id: any, field: PivotGridField): void; - /** Collapses a specified header item. */ - collapseHeaderItem(area: string, path: Array): void; - /** Expands a specified header item. */ - expandHeaderItem(area: string, path: Array): void; - /** Expands all header items of a field. */ - expandAll(id: any): void; - /** Collapses all header items of a field. */ - collapseAll(id: any): void; - /** Disposes of all resources associated with this PivotGridDataSource. */ - dispose(): void; - /** Gets the current filter expression. Cannot be used for the XmlaStore store type. */ - filter(): Object; - /** Applies a new filter expression. Cannot be used for the XmlaStore store type. */ - filter(filterExpr: Object): void; - /** Provides access to a list of records (facts) that were used to calculate a specific summary. */ - createDrillDownDataSource(options: { - columnPath?: Array; - rowPath?: Array; - dataIndex?: number; - maxRowCount?: number; - customColumns?: Array; - }): DevExpress.data.DataSource; - /** Gets the current PivotGridDataSource state (fields configuration, sorting, filters, expanded headers, etc.) */ - state(): Object; - /** Sets the PivotGridDataSource state. */ - state(state: Object): void; - on(eventName: string, eventHandler: Function): PivotGridDataSource; - on(events: { [eventName: string]: Function; }): PivotGridDataSource; - off(eventName: string): PivotGridDataSource; - off(eventName: string, eventHandler: Function): PivotGridDataSource; - } -} -declare module DevExpress.ui { - export interface dxSchedulerOptions extends WidgetOptions { - /** Specifies a date displayed on the current scheduler view by default. */ - currentDate?: any; - /** The earliest date the widget allows you to select. */ - min?: Date; - /** The latest date the widget allows you to select. */ - max?: Date; - /** Specifies the view used in the scheduler by default. */ - currentView?: string; - /** A data source used to fetch data to be displayed by the widget. */ - dataSource?: any; - /** Specifies the first day of a week. */ - firstDayOfWeek?: number; - /** The template to be used for rendering appointments. */ - appointmentTemplate?: any; - /** The template to be used for rendering an appointment tooltip. */ - appointmentTooltipTemplate?: any; - /** Lists the views to be available within the scheduler's View Selector. */ - views?: Array; - /** Specifies the resource kinds by which the scheduler's appointments are grouped in a timetable. */ - groups?: Array; - /** Specifies a start hour in the scheduler view's time interval. */ - startDayHour?: number; - /** Specifies an end hour in the scheduler view's time interval. */ - endDayHour?: number; - /** Specifies whether or not the "All-day" panel is visible. */ - showAllDayPanel?: boolean; - /** Specifies cell duration in minutes. */ - cellDuration?: number; - /** Specifies the edit mode for recurring appointments. */ - recurrenceEditMode?: string; - /** Specifies which editing operations an end-user can perform on appointments. */ - editing?: { - /** Specifies whether or not an end-user can add appointments. */ - allowAdding?: boolean; - /** Specifies whether or not an end-user can change appointment options. */ - allowUpdating?: boolean; - /** Specifies whether or not an end-user can delete appointments. */ - allowDeleting?: boolean; - /** Specifies whether or not an end-user can change an appointment duration. */ - allowResizing?: boolean; - /** Specifies whether or not an end-user can drag appointments. */ - allowDragging?: boolean; - } - /** Specifies an array of resources available in the scheduler. */ - resources?: Array<{ - /** Indicates whether or not several resources of this kind can be assigned to an appointment. */ - allowMultiple?: boolean; - /** - * Indicates whether or not resources of this kind have priority in the color identification of the appointments that have resources of different kinds assigned. - * @deprecated Use the useColorAsDefault option instead. - */ - mainColor?: boolean; - /** Indicates whether or not resources of this kind have priority in the color identification of the appointments that have resources of different kinds assigned. */ - useColorAsDefault?: boolean; - /** A data source used to fetch resources to be available in the scheduler. */ - dataSource?: any; - /** Specifies the resource object field whose value is displayed by the Resource editor in the Appointment popup window. */ - displayExpr?: any; - /** Specifies the resource object field that is used as a value of the Resource editor in the Appointment popup window. */ - valueExpr?: any; - /** - * The name of the appointment object field that specifies a resource of this kind. - * @deprecated Use the fieldExpr option instead. - */ - field?: string; - /** The name of the appointment object field that specifies a resource of this kind. */ - fieldExpr?: string; - /** Specifies the label of the Appointment popup window field that allows end users to assign a resource of this kind. */ - label?: string; - }>; - /** A handler for the AppointmentAdding event. */ - onAppointmentAdding?: Function; - /** A handler for the appointmentAdded event. */ - onAppointmentAdded?: Function; - /** A handler for the AppointmentUpdating event. */ - onAppointmentUpdating?: Function; - /** A handler for the appointmentUpdated event. */ - onAppointmentUpdated?: Function; - /** A handler for the AppointmentDeleting event. */ - onAppointmentDeleting?: Function; - /** A handler for the appointmentDeleted event. */ - onAppointmentDeleted?: Function; - /** A handler for the appointmentRendered event. */ - onAppointmentRendered?: Function; - /** A handler for the appointmentClick event. */ - onAppointmentClick?: any; - /** A handler for the appointmentDblClick event. */ - onAppointmentDblClick?: any; - /** A handler for the cellClick event. */ - onCellClick?: any; - /** A handler for the appointmentFormCreated event. */ - onAppointmentFormCreated?: Function; - /** A handler for the contentReady event. */ - onContentReady?: Function; - horizontalScrollingEnabled?: boolean; - /** Specifies whether or not an end-user can scroll the view in both directions at the same time. */ - crossScrollingEnabled?: boolean; - /** Specifies whether a user can switch views using tabs or a drop-down menu. */ - useDropDownViewSwitcher?: boolean; - /** Specifies the name of the data source item field that defines the start of an appointment. */ - startDateExpr?: string; - /** Specifies the name of the data source item field that defines the ending of an appointment. */ - endDateExpr?: string; - /** Specifies the name of the data source item field that holds the subject of an appointment. */ - textExpr?: string; - /** Specifies the name of the data source item field whose value holds the description of the corresponding appointment. */ - descriptionExpr?: string; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding appointment is an all-day appointment. */ - allDayExpr?: string; - /** Specifies the name of the data source item field that defines a recurrence rule for generating recurring appointments. */ - recurrenceRuleExpr?: string; - /** Specifies the name of the data source item field that defines exceptions for the current recurring appointment. */ - recurrenceExceptionExpr?: string; - /** Specifies the name of the data source item field that defines the timezone of the appointment start date. */ - startDateTimeZoneExpr?: string; - /** Specifies the name of the data source item field that defines the timezone of the appointment end date. */ - endDateTimeZoneExpr?: string; - /** Specifies whether filtering is performed on the server or client side. */ - remoteFiltering?: boolean; - /** Specifies the timezone of the widget. */ - timeZone?: string; - /** The text or HTML markup displayed by the widget if the item collection is empty. Available for the Agenda view only. */ - noDataText?: string; - } - /** A widget that displays scheduled data using different views and provides the capability to load, add and edit appointments. */ - export class dxScheduler extends Widget { - constructor(element: JQuery, options?: dxSchedulerOptions); - constructor(element: Element, options?: dxSchedulerOptions); - /** Add the appointment defined by the object passed as a parameter to the data associated with the widget. */ - addAppointment(appointment: Object): void; - /** Updates the appointment specified by the first method parameter by the appointment object specified by the second method parameter in the the data associated with the widget. */ - updateAppointment(target: Object, appointment: Object): void; - /** Deletes the appointment defined by the parameter from the the data associated with the widget. */ - deleteAppointment(appointment: Object): void; - /** Scrolls the scheduler work space to the specified time of the specified day. */ - scrollToTime(hours: number, minutes: number, date: Date): void; - /** Displayes the Appointment Details popup. */ - showAppointmentPopup(appointmentData: Object, createNewAppointment?: boolean, currentAppointmentData?: Object): void; - /** Returns the start date of the current view. */ - getStartViewDate(): Date; - /** Returns the end date of the current view. */ - getEndViewDate(): Date; - } - export interface dxColorBoxOptions extends dxDropDownEditorOptions { - /** Specifies the text displayed on the button that applies changes and closes the drop-down editor. */ - applyButtonText?: string; - applyValueMode?: string; - /** Specifies the text displayed on the button that cancels changes and closes the drop-down editor. */ - cancelButtonText?: string; - /** Specifies whether or not the widget value includes the alpha channel component. */ - editAlphaChannel?: boolean; - /** Specifies the size of a step by which a handle is moved using a keyboard shortcut. */ - keyStep?: number; - } - /** A widget used to specify a color value. */ - export class dxColorBox extends dxDropDownEditor { - constructor(element: JQuery, options?: dxColorBoxOptions); - constructor(element: Element, options?: dxColorBoxOptions); - } - export interface HierarchicalCollectionWidgetOptions extends CollectionWidgetOptions { - /** Specifies the name of the data source item field whose value is displayed by the widget. */ - displayExpr?: any; - /** Specifies the name of the data source item field used as a key. */ - keyExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding widget items is selected. */ - selectedExpr?: any; - /** Specifies the name of the data source item field that contains an array of nested items. */ - itemsExpr?: any; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding widget item is disabled. */ - disabledExpr?: any; - hoverStateEnabled?: boolean; - focusStateEnabled?: boolean; - } - export class HierarchicalCollectionWidget extends CollectionWidget { - } - export interface dxTreeViewOptions extends HierarchicalCollectionWidgetOptions { - /** Specifies whether or not to animate item collapsing and expanding. */ - animationEnabled?: boolean; - /** Specifies whether a nested or plain array is used as a data source. */ - dataStructure?: string; - /** Specifies whether or not a user can expand all tree view items by the "*" hot key. */ - expandAllEnabled?: boolean; - /** - * Specifies whether or not a check box is displayed at each tree view item. - * @deprecated Use the showCheckBoxesMode options instead. - */ - showCheckBoxes?: boolean; - /** Specifies the current check boxes display mode. */ - showCheckBoxesMode?: string; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding widget item is displayed expanded. */ - expandedExpr?: any; - /** Specifies whether or not to select nodes recursively. */ - selectNodesRecursive?: boolean; - /** Specifies whether or not all parent nodes of an initially expanded node are displayed expanded. */ - expandNodesRecursive?: boolean; - /** - * Specifies whether the "Select All" check box is displayed over the tree view. - * @deprecated Use the showCheckBoxesMode options instead. - */ - selectAllEnabled?: boolean; - /** Specifies whether or not an item becomes selected if a user clicks it. */ - selectByClick?: boolean; - /** Specifies item selection mode. */ - selectionMode?: string; - /** Specifies the text displayed at the "Select All" check box. */ - selectAllText?: string; - /** Specifies the name of the data source item field whose value defines whether or not the corresponding node includes child nodes. */ - hasItemsExpr?: any; - /** Specifies the name of the data source item field for holding the parent key of the corresponding node. */ - parentIdExpr?: any; - /** Specifies if the virtual mode is enabled. */ - virtualModeEnabled?: boolean; - /** Specifies the parent ID value of the root item. */ - rootValue?: Object; - /** Specifies the current value used to filter tree view items. */ - searchValue?: string; - /** A string value specifying available scrolling directions. */ - scrollDirection?: string; - /** A handler for the itemSelectionChanged event. */ - onItemSelectionChanged?: Function; - /** A handler for the itemExpanded event. */ - onItemExpanded?: Function; - /** A handler for the itemCollapsed event. */ - onItemCollapsed?: Function; - onItemClick?: Function; - onItemContextMenu?: Function; - onItemRendered?: Function; - onItemHold?: Function; - } - /** A widget displaying specified data items as a tree. */ - export class dxTreeView extends HierarchicalCollectionWidget { - constructor(element: JQuery, options?: dxTreeViewOptions); - constructor(element: Element, options?: dxTreeViewOptions); - /** Updates the tree view scrollbars according to the current size of the widget content. */ - updateDimensions(): JQueryPromise; - /** Selects the specified item. */ - selectItem(itemElement: any): void; - /** Unselects the specified item. */ - unselectItem(itemElement: any): void; - /** Expands the specified item. */ - expandItem(itemElement: any): void; - /** Collapses the specified item. */ - collapseItem(itemElement: any): void; - /** Returns all nodes of the tree view. */ - getNodes(): Array; - /** Selects all widget items. */ - selectAll(): void; - /** Unselects all widget items. */ - unselectAll(): void; - } - export interface dxMenuBaseOptions extends HierarchicalCollectionWidgetOptions { - /** An object that defines the animation options of the widget. */ - animation?: { - /** An object that defines the animation options used when the widget is being shown. */ - show?: fx.AnimationOptions; - /** An object that defines the animation options used when the widget is being hidden. */ - hide?: fx.AnimationOptions; - }; - /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */ - activeStateEnabled?: boolean; - /** Specifies the name of the CSS class associated with the menu. */ - cssClass?: string; - /** Holds an array of menu items. */ - items?: Array; - /** - * Specifies whether or not an item becomes selected if an end-user clicks it. - * @deprecated Use the selectByClick option instead. - */ - selectionByClick?: boolean; - /** Specifies whether or not an item becomes selected if a user clicks it. */ - selectByClick?: boolean; - /** Specifies the selection mode supported by the menu. */ - selectionMode?: string; - /** Specifies options of submenu showing and hiding. */ - showSubmenuMode?: { - /** Specifies the mode name. */ - name?: string; - /** Specifies the delay of submenu show and hiding. */ - delay?: { - /** The time span after which the submenu is shown. */ - show?: number; - /** The time span after which the submenu is hidden. */ - hide?: number; - }; - }; - } - export class dxMenuBase extends HierarchicalCollectionWidget { - constructor(element: JQuery, options?: dxMenuBaseOptions); - constructor(element: Element, options?: dxMenuBaseOptions); - /** Selects the specified item. */ - selectItem(itemElement: any): void; - /** Unselects the specified item. */ - unselectItem(itemElement: any): void; - } - export interface dxMenuOptions extends dxMenuBaseOptions { - /** Specifies whether or not the submenu is hidden when the mouse pointer leaves it. */ - hideSubmenuOnMouseLeave?: boolean; - /** Specifies whether the menu has horizontal or vertical orientation. */ - orientation?: string; - /** Specifies options for showing and hiding the first level submenu. */ - showFirstSubmenuMode?: { - /** Specifies the mode name. */ - name?: string; - /** Specifies the delay in submenu showing and hiding. */ - delay?: { - /** The time span after which the submenu is shown. */ - show?: number; - /** The time span after which the submenu is hidden. */ - hide?: number; - }; - }; - /** Specifies the direction at which the submenus are displayed. */ - submenuDirection?: string; - /** A handler for the submenuHidden event. */ - onSubmenuHidden?: Function; - /** Specifies whether or not adaptive widget rendering is enabled on a small screen. */ - adaptivityEnabled?: boolean; - /** A handler for the submenuHiding event. */ - onSubmenuHiding?: Function; - /** A handler for the submenuShowing event. */ - onSubmenuShowing?: Function; - /** A handler for the submenuShown event. */ - onSubmenuShown?: Function; - } - /** A menu widget. */ - export class dxMenu extends dxMenuBase { - constructor(element: JQuery, options?: dxMenuOptions); - constructor(element: Element, options?: dxMenuOptions); - } - export interface dxContextMenuOptions extends dxMenuBaseOptions { - /** Holds an object that specifies options of alternative menu invocation. */ - alternativeInvocationMode?: { - /** Specifies whether or not an alternative invocation mode is enabled. */ - enabled?: Boolean; - /** Specifies the element used to invoke the context menu. */ - invokingElement?: any; - }; - /** A handler for the hidden event. */ - onHidden?: Function; - /** A handler for the hiding event. */ - onHiding?: Function; - /** A handler for the positioning event. */ - onPositioning?: Function; - /** A handler for the showing event. */ - onShowing?: Function; - /** A handler for the shown event. */ - onShown?: Function; - /** An object defining widget positioning options. */ - position?: PositionOptions; - /** Specifies the direction at which submenus are displayed. */ - submenuDirection?: string; - /** The target element associated with a popover. */ - target?: any; - /** A Boolean value specifying whether or not the widget is visible. */ - visible?: boolean; - } - /** A context menu widget. */ - export class dxContextMenu extends dxMenuBase { - constructor(element: JQuery, options?: dxContextMenuOptions); - constructor(element: Element, options?: dxContextMenuOptions); - /** Toggles the visibility of the widget. */ - toggle(showing: boolean): JQueryPromise; - /** Shows the widget. */ - show(): JQueryPromise; - /** Hides the widget. */ - hide(): JQueryPromise; - } - export interface dxRemoteOperations { - /** Specifies whether or not filtering must be performed on the server side. */ - filtering?: boolean; - /** Specifies whether or not paging must be performed on the server side. */ - paging?: boolean; - /** Specifies whether or not sorting must be performed on the server side. */ - sorting?: boolean; - /** Specifies whether or not grouping must be performed on the server side. */ - grouping?: boolean; - /** Specifies whether or not summaries calculation must be performed on the server side. */ - summary?: boolean; - } - export interface dxDataGridRow { - data: Object; - key: any; - rowIndex: number; - rowType: string; - groupIndex: number; - isExpanded: boolean; - isSelected: boolean; - values: Array; - } - export interface dxDataGridColumn { - /** Specifies the content alignment within column cells. */ - alignment?: string; - /** Specifies whether the values in a column can be edited at runtime. Setting this option makes sense only when editing is enabled for a grid. */ - allowEditing?: boolean; - /** Specifies whether or not a column can be used for filtering grid records. Setting this option makes sense only when the filter row and column header filtering are visible. */ - allowFiltering?: boolean; - /** Specifies whether or not to allow filtering by this column using its header. */ - allowHeaderFiltering?: boolean; - /** Specifies whether or not the column can be anchored to a grid edge by end users. Setting this option makes sense only when the columnFixing | enabled option is set to true. */ - allowFixing?: boolean; - /** Specifies if a column can be used for searching grid records. Setting this option makes sense only when the search panel is visible. */ - allowSearch?: boolean; - /** Specifies whether the user can group data by values of this column. Applies only when grouping is enabled. */ - allowGrouping?: boolean; - /** Specifies whether or not a column can be hidden by a user. Setting this option makes sense only when the column chooser is visible. */ - allowHiding?: boolean; - /** Specifies whether or not a particular column can be used in column reordering. Setting this option makes sense only when the allowColumnReordering option is set to true. */ - allowReordering?: boolean; - /** Specifies whether or not a particular column can be resized by a user. Setting this option makes sense only when the allowColumnResizing option is true. */ - allowResizing?: boolean; - /** Specifies whether grid records can be sorted by a specific column at runtime. Setting this option makes sense only when the sorting mode differs from none. */ - allowSorting?: boolean; - /** Specifies whether groups appear expanded or not when records are grouped by a specific column. Setting this option makes sense only when grouping is allowed for this column. */ - autoExpandGroup?: boolean; - /** Specifies a callback function that returns a value to be displayed in a column cell. */ - calculateCellValue?: (rowData: Object) => string; - /** Specifies a callback function to be invoked after the cell value is edited by an end-user and before the new value is saved to the data source. */ - setCellValue?: (rowData: Object, value: any) => void; - /** Specifies a callback function that defines filters for customary calculated grid cells. */ - calculateFilterExpression?: (filterValue: any, selectedFilterOperation: string, target: string) => Array; - /** Specifies a caption for a column. */ - caption?: string; - /** Specifies a custom template for grid column cells. */ - cellTemplate?: any; - /** Specifies a CSS class to be applied to a column. */ - cssClass?: string; - /** Specifies how to get a value to be displayed in a cell when it is not in an editing state. */ - calculateDisplayValue?: any; - /** Specifies a field name or a function that returns a field name or a value to be used for grouping column cells. */ - calculateGroupValue?: any; - /** Specifies a field name or a function that returns a field name or a value to be used for sorting column cells. */ - calculateSortValue?: any; - /** Specifies a callback function that returns the text to be displayed in the cells of a column. */ - customizeText?: (cellInfo: { value: any; valueText: string; target: string; groupInterval: any }) => string; - /** Specifies the field of a data source that provides data for a column. */ - dataField?: string; - /** Specifies the required type of column values. */ - dataType?: string; - /** Specifies a custom template for the cell of a grid column when it is in an editing state. */ - editCellTemplate?: any; - /** Specifies configuration options for the editor widget of the current column. */ - editorOptions?: Object; - /** Specifies whether HTML tags are displayed as plain text or applied to the values of the column. */ - encodeHtml?: boolean; - /** In a boolean column, replaces all false items with a specified text. */ - falseText?: string; - /** Specifies the set of available filter operations. */ - filterOperations?: Array; - /** Specifies a filter value for a column. */ - filterValue?: any; - /** Specifies initial filter values for the column's header filter. */ - filterValues?: Array; - /** Specifies whether to include or exclude the records with the values selected in the column's header filter. */ - filterType?: string; - /** Indicates whether the column takes part in horizontal grid scrolling or is anchored to a grid edge. */ - fixed?: boolean; - /** Specifies the order according to which grid columns must be concealed when the widget adapts to the screen or container size. */ - hidingPriority?: number; - /** Specifies the grid edge to which the column is anchored. */ - fixedPosition?: string; - /** Specifies a format for the values displayed in a column. */ - format?: any; - /** Specifies a custom template for the group cell of a grid column. */ - groupCellTemplate?: any; - /** Specifies the index of a column when grid records are grouped by the values of this column. */ - groupIndex?: number; - /** Specifies a custom template for the header of a grid column. */ - headerCellTemplate?: any; - /** Specifies options of a lookup column. */ - lookup?: { - /** Specifies whether or not a user can nullify values of a lookup column. */ - allowClearing?: boolean; - /** Specifies the data source providing data for a lookup column. */ - dataSource?: any; - /** Specifies the expression defining the data source field whose values must be displayed. */ - displayExpr?: any; - /** Specifies the expression defining the data source field whose values must be replaced. */ - valueExpr?: string; - }; - /** Specifies column-level options for filtering using a column header filter. */ - headerFilter?: { - /** Specifies the data source to be used for the header filter. */ - dataSource?: any; - /** Specifies how header filter values should be combined into groups. */ - groupInterval?: any; - }; - /** - * Specifies a precision for formatted values displayed in a column. - * @deprecated Use the format | precision option instead. - */ - precision?: number; - /** Specifies the default filter operation of a column. */ - selectedFilterOperation?: string; - /** Specifies whether or not the column displays its values by using editors. */ - showEditorAlways?: boolean; - /** Specifies whether or not to display the column when grid records are grouped by it. */ - showWhenGrouped?: boolean; - /** Specifies the index of a column when grid records are sorted by the values of this column. */ - sortIndex?: number; - /** Specifies the initial sort order of column values. */ - sortOrder?: string; - /** In a boolean column, replaces all true items with a specified text. */ - trueText?: string; - /** Specifies whether a column is visible or not. */ - visible?: boolean; - /** Specifies the sequence number of the column in the grid. */ - visibleIndex?: number; - /** Specifies a column width in pixels or percentages. */ - width?: any; - /** Specifies an array of validation rules to be checked when updating column cell values. */ - validationRules?: Array; - /** Specifies whether or not to display the header of a hidden column in the column chooser. */ - showInColumnChooser?: boolean; - /** Specifies the identifier of the column. */ - name?: string; - /** The form item configuration object. Used only when the editing mode is "form". */ - formItem?: DevExpress.ui.dxFormItem; - /** An array of grid columns. */ - columns?: Array; - /** Specifies the band column that owns the current column. Accepts the index of the band column in the columns array. */ - ownerBand?: number; - /** Specifies whether the column bands other columns or not. */ - isBand?: boolean; - } - export interface dxDataGridOptions extends WidgetOptions { - /** Specifies whether the outer borders of the grid are visible or not. */ - showBorders?: boolean; - /** Indicates whether to show the error row for the grid. */ - errorRowEnabled?: boolean; - /** A handler for the rowValidating event. */ - onRowValidating?: (e: Object) => void; - /** A handler for the contextMenuPreparing event. */ - onContextMenuPreparing?: (e: Object) => void; - /** A handler for the initNewRow event. */ - onInitNewRow?: (e: { data: Object }) => void; - /** A handler for the rowInserted event. */ - onRowInserted?: (e: { data: Object; key: any }) => void; - /** A handler for the rowInserting event. */ - onRowInserting?: (e: { data: Object; cancel: any }) => void; - /** A handler for the rowRemoved event. */ - onRowRemoved?: (e: { data: Object; key: any }) => void; - /** A handler for the rowRemoving event. */ - onRowRemoving?: (e: { data: Object; key: any; cancel: any }) => void; - /** A handler for the rowUpdated event. */ - onRowUpdated?: (e: { data: Object; key: any }) => void; - /** A handler for the rowUpdating event. */ - onRowUpdating?: (e: { oldData: Object; newData: Object; key: any; cancel: any }) => void; - /** Enables a hint that appears when a user hovers the mouse pointer over a cell with truncated content. */ - cellHintEnabled?: boolean; - /** Specifies whether or not the widget should hide columns in order to adapt to the screen or container size. */ - columnHidingEnabled?: boolean; - /** Specifies whether or not grid columns can be reordered by a user. */ - allowColumnReordering?: boolean; - /** Specifies whether or not grid columns can be resized by a user. */ - allowColumnResizing?: boolean; - /** A handler for the cellClick event. */ - onCellClick?: any; - /** A handler for the cellHoverChanged event. */ - onCellHoverChanged?: (e: Object) => void; - /** A handler for the cellPrepared event. */ - onCellPrepared?: (e: Object) => void; - /** A handler for the adaptiveDetailRowPreparing event. */ - onAdaptiveDetailRowPreparing?: (e: Object) => void; - /** Specifies whether or not the width of grid columns depends on column content. */ - columnAutoWidth?: boolean; - /** Specifies the options of a column chooser. */ - columnChooser?: { - /** Specifies text displayed by the column chooser panel when it does not contain any columns. */ - emptyPanelText?: string; - /** Specifies whether a user can invoke the column chooser or not. */ - enabled?: boolean; - /** Specifies how the end-user chooses columns. */ - mode?: string; - /** Specifies the height of the column chooser panel. */ - height?: number; - /** Specifies text displayed in the title of the column chooser panel. */ - title?: string; - /** Specifies the width of the column chooser panel. */ - width?: number; - }; - /** Specifies options for column fixing. */ - columnFixing?: { - /** Indicates if column fixing is enabled. */ - enabled?: boolean; - /** Contains options that specify texts for column-fixing related commands in the column header's context menu. */ - texts?: { - /** Specifies text for a context menu item that fixes the column for which the context menu is invoked. */ - fix?: string; - /** Specifies text for a context menu item that unfixes the column for which the context menu is invoked. */ - unfix?: string; - /** Specifies text for a context menu subitem that fixes a column, for which the context menu is invoked, to the left grid edge. */ - leftPosition?: string; - /** Specifies text for a context menu subitem that fixes a column, for which the context menu is invoked, to the right grid edge. */ - rightPosition?: string; - }; - }; - /** Specifies options for filtering using a column header filter. */ - headerFilter?: { - /** Indicates whether or not the column header filter button is visible. */ - visible?: boolean; - /** Specifies the height of the dropdown menu invoked when using a column header filter. */ - height?: number; - /** Specifies the width of the dropdown menu invoked when using a column header filter. */ - width?: number; - /** Contains options that specify texts for the dropdown menu invoked when you use a column header filter. */ - texts?: { - /** Specifies text for the item specifying an empty value in the column header filter's dropdown menu. */ - emptyValue?: string; - /** Specifies text for a button that closes the column header filter's dropdown menu and applies specified filtering. */ - ok?: string; - /** Specifies text for a button that closes the column header filter's dropdown menu without applying performed selection. */ - cancel?: string; - } - }; - /** An array of grid columns. */ - columns?: Array; - onContentReady?: Function; - /** Specifies a function that customizes grid columns after they are created. */ - customizeColumns?: (columns: Array) => void; - /** Customizes grid columns and data before exporting. */ - customizeExportData?: (columns: Array, rows: Array) => void; - /** Specifies a data source for the grid. */ - dataSource?: any; - /** Specifies whether or not to enable data caching. */ - cacheEnabled?: boolean; - /** A handler for the editingStart event. */ - onEditingStart?: (e: { - data: Object; - key: any; - cancel: boolean; - column: dxDataGridColumn - }) => void; - /** A handler for the editorPrepared event. */ - onEditorPrepared?: (e: Object) => void; - /** A handler for the editorPreparing event. */ - onEditorPreparing?: (e: Object) => void; - /** Contains options that specify how grid content can be changed. */ - editing?: { - editMode?: string; - editEnabled?: boolean; - insertEnabled?: boolean; - removeEnabled?: boolean; - /** Specifies how grid values can be edited manually. */ - mode?: string; - /** Specifies whether or not grid records can be edited at runtime. */ - allowUpdating?: boolean; - /** Specifies whether or not new grid records can be added at runtime. */ - allowAdding?: boolean; - /** Specifies whether or not grid records can be deleted at runtime. */ - allowDeleting?: boolean; - /** The form configuration object. Used only when the editing mode is "form". */ - form?: DevExpress.ui.dxFormOptions; - /** Contains options that specify texts for editing-related grid controls. */ - texts?: { - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Save" button. Setting this option makes sense only when the mode option is set to batch. */ - saveAllChanges?: string; - /** Specifies text for a cancel button displayed when a row is in the editing state. Setting this option makes sense only when the allowUpdating option is set to true. */ - cancelRowChanges?: string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Revert" button. Setting this option makes sense only when the mode option is set to batch. */ - cancelAllChanges?: string; - /** Specifies a message to be displayed by a confirmation window. Setting this option makes sense only when the edit mode is "row". */ - confirmDeleteMessage?: string; - /** Specifies text to be displayed in the title of a confirmation window. Setting this option makes sense only when the edit mode is "row". */ - confirmDeleteTitle?: string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Cancel changes" button. Setting this option makes sense only when the mode option is set to cell and the validation capabilities are enabled. -#####See Also##### -- Validation Engine -- Validation Engine - MVVM Approach */ - validationCancelChanges?: string; - /** Specifies text for a button that deletes a row from a grid. Setting this option makes sense only when the allowDeleting option is set to true. */ - deleteRow?: string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Add" button. Setting this option makes sense only when the allowAdding option is true. */ - addRow?: string; - /** Specifies text for a button that turns a row into the editing state. Setting this option makes sense only when the allowUpdating option is set to true. */ - editRow?: string; - /** Specifies text for a save button displayed when a row is in the editing state. Setting this option makes sense only when the allowUpdating option is set to true. */ - saveRowChanges?: string; - /** Specifies text for a button that recovers a deleted row. Setting this option makes sense only if the grid uses the batch edit mode and the allowDeleting option is set to true. */ - undeleteRow?: string; - }; - }; - /** Specifies filter row options. */ - filterRow?: { - /** Specifies when to apply a filter. */ - applyFilter?: string; - /** Specifies text for the hint that pops up when a user hovers the mouse pointer over the "Apply Filter" button. */ - applyFilterText?: string; - /** Specifies descriptions for filter operations. */ - operationDescriptions?: { - "=": string; - "<>": string; - "<": string; - "<=": string; - ">": string; - ">=": string; - "startswith": string; - "contains": string; - "notcontains": string; - "endswith": string; - }; - /** Specifies text for the reset operation in a filter list. */ - resetOperationText?: string; - /** Specifies text for the operation of clearing the applied filter when a select box is used. */ - showAllText?: string; - /** Specifies text for the range start in the 'between' filter type. */ - betweenStartText?: string; - /** Specifies text for the range end in the 'between' filter type. */ - betweenEndText?: string; - /** Specifies whether or not an icon that allows the user to choose a filter operation is visible. */ - showOperationChooser?: boolean; - /** Specifies whether the filter row is visible or not. */ - visible?: boolean; - }; - /** Specifies grouping settings and the behavior of grouped grid records. */ - grouping?: { - /** Specifies whether the user can collapse grouped records in a grid or not. */ - allowCollapsing?: boolean; - /** Specifies whether groups appear expanded or not. */ - autoExpandAll?: boolean; - /** Enables the user to group data using the context menu. */ - contextMenuEnabled?: boolean; - /** Specifies the event on which a group will be expanded/collapsed. */ - expandMode?: string; - groupContinuedMessage?: string; - groupContinuesMessage?: string; - /** Defines the texts of grouping-related visual elements. */ - texts?: { - /** Specifies the message displayed in a group row when the corresponding group is continued from the previous page. */ - groupContinuedMessage?: string; - /** Specifies the message displayed in a group row when the corresponding group continues on the next page. */ - groupContinuesMessage?: string; - /** Specifies the text of the context menu item that groups data by a specific column. */ - groupByThisColumn?: string; - /** Specifies the text of the context menu item that clears grouping settings of a specific column. */ - ungroup?: string; - /** Specifies the text of the context menu item that clears grouping settings of all columns. */ - ungroupAll?: string; - } - }; - /** Configures the group panel. */ - groupPanel?: { - /** Specifies whether columns can be dragged onto or from the group panel. */ - allowColumnDragging?: boolean; - /** Specifies text displayed by the group panel when it does not contain any columns. */ - emptyPanelText?: string; - /** Specifies whether the group panel is visible or not. */ - visible?: any; - }; - /** Specifies options configuring the load panel. */ - loadPanel?: { - /** Specifies whether to show the load panel or not. */ - enabled?: any; - /** Specifies the height of the load panel in pixels. */ - height?: number; - /** Specifies a URL pointing to an image to be used as a loading indicator. */ - indicatorSrc?: string; - /** Specifies whether or not a loading indicator must be displayed on the load panel. */ - showIndicator?: boolean; - /** Specifies whether or not the pane of the load panel must be displayed. */ - showPane?: boolean; - /** Specifies text displayed by the load panel. */ - text?: string; - /** Specifies the width of the load panel in pixels. */ - width?: number; - }; - /** Specifies text displayed when a grid does not contain any records. */ - noDataText?: string; - /** Specifies the options of a grid pager. */ - pager?: { - /** Specifies the page sizes that can be selected at runtime. */ - allowedPageSizes?: any; - /** Specifies whether to show the page size selector or not. */ - showPageSizeSelector?: boolean; - /** Specifies whether to show the pager or not. */ - visible?: any; - /** Specifies the text accompanying the page navigator. */ - infoText?: string; - /** Specifies whether or not to display the text accompanying the page navigator. This text is specified by the infoText option. */ - showInfo?: boolean; - /** Specifies whether or not to display buttons that switch the grid to the previous or next page. */ - showNavigationButtons?: boolean; - }; - /** Specifies paging options. */ - paging?: { - /** Specifies whether dxDataGrid loads data page by page or all at once. */ - enabled?: boolean; - /** Specifies the grid page that should be displayed by default. */ - pageIndex?: number; - /** Specifies the size of grid pages. */ - pageSize?: number; - }; - /** Specifies whether or not grid rows must be shaded in a different way. */ - rowAlternationEnabled?: boolean; - /** Specifies whether to enable two-way data binding. */ - twoWayBindingEnabled?: boolean; - /** A handler for the rowClick event. */ - onRowClick?: any; - /** A handler for the rowPrepared event. */ - onRowPrepared?: (e: Object) => void; - /** Specifies a custom template for grid rows. */ - rowTemplate?: any; - /** A configuration object specifying scrolling options. */ - scrolling?: { - /** Specifies the scrolling mode. */ - mode?: string; - /** Specifies whether or not a grid must preload pages adjacent to the current page when using virtual scrolling. */ - preloadEnabled?: boolean; - /** Specifies whether or not the widget uses native scrolling. */ - useNative?: any; - /** Specifies the scrollbar display policy. */ - showScrollbar?: string; - /** Specifies whether or not the scrolling by content is enabled. */ - scrollByContent?: boolean; - /** Specifies whether or not the scrollbar thumb scrolling enabled. */ - scrollByThumb?: boolean; - }; - /** Specifies options of the search panel. */ - searchPanel?: { - /** Specifies whether or not search strings in the located grid records should be highlighted. */ - highlightSearchText?: boolean; - /** Specifies text displayed by the search panel when no search string was typed. */ - placeholder?: string; - /** Specifies whether the search panel is visible or not. */ - visible?: boolean; - /** Specifies whether to search all columns or only visible ones. */ - searchVisibleColumnsOnly?: boolean; - /** Specifies the width of the search panel in pixels. */ - width?: number; - /** Sets a search string for the search panel. */ - text?: string; - }; - /** Specifies the operations that must be performed on the server side. */ - remoteOperations?: any; - /** Allows you to sort groups according to the values of group summary items. */ - sortByGroupSummaryInfo?: Array<{ - /** Specifies the group summary item whose values must be used to sort groups. */ - summaryItem?: string; - /** Specifies the identifier of the column that must be used in grouping so that sorting by group summary item values be applied. */ - groupColumn?: string; - /** Specifies the sort order of group summary item values. */ - sortOrder?: string; - }>; - /** Allows you to build a master-detail interface in the grid. */ - masterDetail?: { - /** Enables an end-user to expand/collapse detail sections. */ - enabled?: boolean; - /** Specifies whether detail sections appear expanded or collapsed. */ - autoExpandAll?: boolean; - /** Specifies the template for detail sections. */ - template?: any; - }; - /** Configures client-side export. */ - export?: { - /** Enables the client-side export feature. */ - enabled?: boolean; - /** Specifies a default name for the file to which grid data is exported. */ - fileName?: string; - /** Specifies whether to enable Excel filtering for the exported data in the resulting XLSX file. */ - excelFilterEnabled?: boolean; - /** Specifies whether to enable word wrapping for the exported data in the resulting XLSX file. */ - excelWrapTextEnabled?: boolean; - /** Specifies the URL of the server-side proxy that streams the resulting file to the end user to enable export in IE9 and Safari browsers. */ - proxyUrl?: string; - /** Allows an end user to export selected rows only. */ - allowExportSelectedData?: boolean; - /** Contains options that specify texts for the export-related commands and hints. */ - texts?: { - /** Specifies the hint of the Export button when the allowExportSelectedData option is true. */ - exportTo?: string; - exportToExcel?: string; - excelFormat?: string; - selectedRows?: string; - /** Specifies the text of the command that exports all data. */ - exportAll?: string; - /** Specifies the text of the drop-down menu command that exports selected rows. */ - exportSelectedRows?: string; - } - }; - /** Specifies the keys of the records that must appear selected initially. */ - selectedRowKeys?: Array; - /** Specifies options of runtime selection. */ - selection?: { - /** Specifies the checkbox row display policy in the multiple mode. */ - showCheckBoxesMode?: string; - /** Specifies whether the user can select all grid records at once. */ - allowSelectAll?: boolean; - /** Specifies the selection mode. */ - mode?: string; - }; - /** A handler for the dataErrorOccured event. */ - onDataErrorOccurred?: (e: { error: Error }) => void; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: (e: { - currentSelectedRowKeys: Array; - currentDeselectedRowKeys: Array; - selectedRowKeys: Array; - selectedRowsData: Array; - }) => void; - /** A handler for the exporting event. */ - onExporting?: (e: { - fileName: string; - cancel: boolean; - }) => void; - /** A handler for the fileSaving event. */ - onFileSaving?: (e: { - fileName: string; - format: string; - data: any; - cancel: boolean; - }) => void; - /** A handler for the exported event. */ - onExported?: (e: Object) => void; - /** A handler for the keyDown event. */ - onKeyDown?: (e: Object) => void; - /** A handler for the rowExpanding event. */ - onRowExpanding?: (e: Object) => void; - /** A handler for the rowExpanded event. */ - onRowExpanded?: (e: Object) => void; - /** A handler for the rowCollapsing event. */ - onRowCollapsing?: (e: Object) => void; - /** A handler for the rowCollapsed event. */ - onRowCollapsed?: (e: Object) => void; - /** Specifies whether column headers are visible or not. */ - showColumnHeaders?: boolean; - /** Specifies whether or not vertical lines separating one grid column from another are visible. */ - showColumnLines?: boolean; - /** Specifies whether or not horizontal lines separating one grid row from another are visible. */ - showRowLines?: boolean; - /** Specifies options of runtime sorting. */ - sorting?: { - /** Specifies text for the context menu item that sets an ascending sort order in a column. */ - ascendingText?: string; - /** Specifies text for the context menu item that resets sorting settings for a column. */ - clearText?: string; - /** Specifies text for the context menu item that sets a descending sort order in a column. */ - descendingText?: string; - /** Specifies the runtime sorting mode. */ - mode?: string; - }; - /** Specifies options of state storing. */ - stateStoring?: { - /** Specifies a callback function that performs specific actions on state loading. */ - customLoad?: () => JQueryPromise; - /** Specifies a callback function that performs specific actions on state saving. */ - customSave?: (state: Object) => void; - /** Specifies whether or not a grid saves its state. */ - enabled?: boolean; - /** Specifies the delay between the last change of a grid state and the operation of saving this state in milliseconds. */ - savingTimeout?: number; - /** Specifies a unique key to be used for storing the grid state. */ - storageKey?: string; - /** Specifies the type of storage to be used for state storing. */ - type?: string; - }; - /** Specifies the options of the grid summary. */ - summary?: { - /** Contains options that specify text patterns for summary items. */ - texts?: { - /** Specifies a pattern for the 'sum' summary items when they are displayed in the parent column. */ - sum?: string; - /** Specifies a pattern for the 'sum' summary items displayed in a group row or in any other column rather than the parent one. */ - sumOtherColumn?: string; - /** Specifies a pattern for the 'min' summary items when they are displayed in the parent column. */ - min?: string; - /** Specifies a pattern for the 'min' summary items displayed in a group row or in any other column rather than the parent one. */ - minOtherColumn?: string; - /** Specifies a pattern for the 'max' summary items when they are displayed in the parent column. */ - max?: string; - /** Specifies a pattern for the 'max' summary items displayed in a group row or in any other column rather than the parent one. */ - maxOtherColumn?: string; - /** Specifies a pattern for the 'avg' summary items when they are displayed in the parent column. */ - avg?: string; - /** Specifies a pattern for the 'avg' summary items displayed in a group row or in any other column rather than the parent one. */ - avgOtherColumn?: string; - /** Specifies a pattern for the 'count' summary items. */ - count?: string; - }; - /** Specifies items of the group summary. */ - groupItems?: Array<{ - /** Specifies the identifier of a summary item. */ - name?: string; - /** Specifies the column that provides data for a group summary item. */ - column?: string; - /** Customizes the text to be displayed in the summary item. */ - customizeText?: (itemInfo: { - value: any; - valueText: string; - }) => string; - /** Specifies a pattern for the summary item text. */ - displayFormat?: string; - /** - * Specifies a precision for the summary item value of a numeric format. - * @deprecated Use the valueFormat | precision option instead. - */ - precision?: number; - /** Specifies whether or not a summary item must be displayed in the group footer. */ - showInGroupFooter?: boolean; - /** Indicates whether to display group summary items in parentheses after the group row header or to align them by the corresponding columns within the group row. */ - alignByColumn?: boolean; - /** Specifies the column that must hold the summary item when this item is displayed in the group footer or aligned by a column in the group row. */ - showInColumn?: string; - /** Specifies how to aggregate data for a summary item. */ - summaryType?: string; - /** Specifies a format for the summary item value. */ - valueFormat?: any; - /** Specifies whether or not to skip empty strings, null and undefined values when calculating a summary. */ - skipEmptyValues?: boolean; - }>; - /** Specifies items of the total summary. */ - totalItems?: Array<{ - /** Specifies the identifier of a summary item. */ - name?: string; - /** Specifies the alignment of a summary item. */ - alignment?: string; - /** Specifies the column that provides data for a summary item. */ - column?: string; - /** Specifies a CSS class to be applied to a summary item. */ - cssClass?: string; - /** Customizes the text to be displayed in the summary item. */ - customizeText?: (itemInfo: { - value: any; - valueText: string; - }) => string; - /** Specifies a pattern for the summary item text. */ - displayFormat?: string; - /** - * Specifies a precision for the summary item value of a numeric format. - * @deprecated Use the valueFormat | precision option instead. - */ - precision?: number; - /** Specifies the column that must hold the summary item. */ - showInColumn?: string; - /** Specifies how to aggregate data for a summary item. */ - summaryType?: string; - /** Specifies a format for the summary item value. */ - valueFormat?: any; - /** Specifies whether or not to skip empty strings, null and undefined values when calculating a summary. */ - skipEmptyValues?: boolean; - }>; - /** Specifies whether or not to skip empty strings, null and undefined values when calculating a summary. */ - skipEmptyValues?: boolean; - /** Allows you to use a custom aggregate function to calculate the value of a summary item. */ - calculateCustomSummary?: (options: { - component: dxDataGrid; - name?: string; - value: any; - totalValue: any; - summaryProcess: string - }) => void; - }; - /** Specifies whether text that does not fit into a column should be wrapped. */ - wordWrapEnabled?: boolean; - } - /** A data grid widget. */ - export class dxDataGrid extends Widget { - constructor(element: JQuery, options?: dxDataGridOptions); - constructor(element: Element, options?: dxDataGridOptions); - /** Ungroups grid records. */ - clearGrouping(): void; - /** Clears sorting settings of all grid columns at once. */ - clearSorting(): void; - /** Allows you to obtain a cell by its row index and the data field of its column. */ - getCellElement(rowIndex: number, dataField: string): any; - /** Allows you to obtain a cell by its row index and the visible index of its column. */ - getCellElement(rowIndex: number, visibleColumnIndex: number): any; - /** Returns the current state of the grid. */ - state(): Object; - /** Sets the grid state. */ - state(state: Object): void; - /** Allows you to obtain the row index by a data key. */ - getRowIndexByKey(key: any): number; - /** Allows you to obtain the data key by a row index. */ - getKeyByRowIndex(rowIndex: number): any; - /** Adds a new column to a grid. */ - addColumn(columnOptions: dxDataGridColumn): void; - /** Removes the column from the grid. */ - deleteColumn(id: any): void; - /** Displays the load panel. */ - beginCustomLoading(messageText: string): void; - /** Discards changes made in a grid. */ - cancelEditData(): void; - /** Checks whether or not the grid contains unsaved changes. */ - hasEditData(): boolean; - /** Clears all the filters of a specific type applied to grid records. */ - clearFilter(): void; - /** Deselects all grid records. */ - clearSelection(): void; - /** Draws the cell being edited from the editing state. Use this method when the edit mode is batch. */ - closeEditCell(): void; - /** Collapses groups or master rows in a grid. */ - collapseAll(groupIndex?: number): void; - /** Returns the number of data columns in a grid. */ - columnCount(): number; - /** Returns the value of a specific column option. */ - columnOption(id: any, optionName: string): any; - /** Sets an option of a specific column. */ - columnOption(id: any, optionName: string, optionValue: any): void; - /** Returns the options of a column by an identifier. */ - columnOption(id: any): Object; - /** Sets several options of a column at once. */ - columnOption(id: any, options: Object): void; - /** Sets a specific cell into the editing state. */ - editCell(rowIndex: number, visibleColumnIndex: number): void; - /** Sets a specific cell into the editing state. */ - editCell(rowIndex: number, dataField: string): void; - /** Sets a specific row into the editing state. */ - editRow(rowIndex: number): void; - /** Gets the cell value. */ - cellValue(rowIndex: number, dataField: string): any; - /** Gets the cell value. */ - cellValue(rowIndex: number, visibleColumnIndex: number): any; - /** Sets the cell value. */ - cellValue(rowIndex: number, dataField: string, value: any): void; - /** Sets the cell value. */ - cellValue(rowIndex: number, visibleColumnIndex: number, value: any): void; - /** Hides the load panel. */ - endCustomLoading(): void; - /** Expands groups or master rows in a grid. */ - expandAll(groupIndex: number): void; - /** Allows you to find out whether a specific group or master row is expanded or collapsed. */ - isRowExpanded(key: any): boolean; - /** Allows you to expand a specific group or master row by its key. */ - expandRow(key: any): void; - /** Allows you to collapse a specific group or master row by its key. */ - collapseRow(key: any): void; - /** Checks whether a specific adaptive detail row is expanded or collapsed. */ - isAdaptiveDetailRowExpanded(key: any): void; - /** Expands an adaptive detail row by the key of its parent data row. */ - expandAdaptiveDetailRow(key: any): void; - /** Collapses the currently expanded adaptive detail row (if there is one). */ - collapseAdaptiveDetailRow(): void; - /** Applies a filter to the grid's data source. */ - filter(filterExpr?: any): void; - /** Returns a filter expression applied to the grid's data source using the filter(filterExpr) method. */ - filter(): any; - /** Returns a filter expression applied to the grid using all possible scenarious. */ - getCombinedFilter(): any; - /** Gets the keys of currently selected grid records. */ - getSelectedRowKeys(): Array; - /** Gets the data objects of currently selected grid records. */ - getSelectedRowsData(): Array; - /** Hides the column chooser panel. */ - hideColumnChooser(): void; - /** Adds a new data row to a grid. */ - addRow(): void; - /** - * Adds a new data row to a grid. - * @deprecated Use the addRow() method instead. - */ - insertRow(): void; - /** Returns the key corresponding to the passed data object. */ - keyOf(obj: Object): any; - /** Switches a grid to a specified page. */ - pageIndex(newIndex: number): void; - /** Gets the index of the current page. */ - pageIndex(): number; - /** Sets the page size. */ - pageSize(value: number): void; - /** Gets the current page size. */ - pageSize(): number; - /** Refreshes grid data. */ - refresh(): JQueryPromise; - /** Removes a specific row from a grid. */ - deleteRow(rowIndex: number): void; - /** - * Removes a specific row from a grid. - * @deprecated Use the deleteRow(rowIndex) method instead. - */ - removeRow(rowIndex: number): void; - /** Saves changes made in a grid. */ - saveEditData(): JQueryPromise; - /** Searches grid records by a search string. */ - searchByText(text: string): void; - /** Selects all grid records. */ - selectAll(): void; - /** Deselects the rows that are currently selected within the applied filter. */ - deselectAll(): void; - /** Selects specific grid records. */ - selectRows(keys: Array, preserve: boolean): void; - /** Deselects specific grid records. */ - deselectRows(keys: Array): void; - /** Selects grid rows by indexes. */ - selectRowsByIndexes(indexes: Array): void; - /** Allows you to find out whether a row is selected or not. */ - isRowSelected(key: any): boolean; - /** Invokes the column chooser panel. */ - showColumnChooser(): void; - startSelectionWithCheckboxes(): boolean; - /** Returns how many pages the grid contains. */ - pageCount(): number; - /** Returns the number of records currently held by a grid. */ - totalCount(): number; - /** Recovers a row deleted in the batch edit mode. */ - undeleteRow(rowIndex: number): void; - /** Allows you to obtain a data object by its key. */ - byKey(key: any): JQueryPromise; - /** Gets the value of a total summary item. */ - getTotalSummaryValue(summaryItemName: string): any; - /** Exports grid data to Excel. */ - exportToExcel(selectionOnly: boolean): void; - /** Updates the grid to the size of its content. */ - updateDimensions(): void; - /** Focuses the specified cell element in the grid. */ - focus(element?: JQuery): void; - } - export interface dxPivotGridOptions extends WidgetOptions { - onContentReady?: Function; - /** Specifies a data source for the pivot grid. */ - dataSource?: any; - useNativeScrolling?: any; - /** A configuration object specifying scrolling options. */ - scrolling?: { - /** Specifies the scrolling mode. */ - mode?: string; - /** Specifies whether or not the widget uses native scrolling. */ - useNative?: any; - }; - /** Allows an end-user to change sorting options. */ - allowSorting?: boolean; - /** Allows an end-user to sort columns by summary values. */ - allowSortingBySummary?: boolean; - /** Allows an end-user to change filtering options. */ - allowFiltering?: boolean; - /** Specifies the area to which data field headers must belong. */ - dataFieldArea?: string; - /** Configures the field panel. */ - fieldPanel?: { - /** Makes fields on the field panel draggable. */ - allowFieldDragging?: boolean; - /** Shows/hides filter fields on the field panel. */ - showFilterFields?: boolean; - /** Shows/hides data fields on the field panel. */ - showDataFields?: boolean; - /** Shows/hides column fields on the field panel. */ - showColumnFields?: boolean; - /** Shows/hides row fields on the field panel. */ - showRowFields?: boolean; - /** Shows/hides the field panel. */ - visible?: boolean; - /** Specifies the placeholders of the field areas. */ - texts?: { - /** Specifies the placeholder of the column field area. */ - columnFieldArea?: string; - /** Specifies the placeholder of the row field area. */ - rowFieldArea?: string; - /** Specifies the placeholder of the filter field area. */ - filterFieldArea?: string; - /** Specifies the placeholder of the data field area. */ - dataFieldArea?: string; - } - } - /** Allows an end-user to expand/collapse all header items within a header level. */ - allowExpandAll?: boolean; - /** Specifies whether long text in header items should be wrapped. */ - wordWrapEnabled?: boolean; - /** Specifies whether to display the Total rows. */ - showRowTotals?: boolean; - /** Specifies whether to display the Grand Total row. */ - showRowGrandTotals?: boolean; - /** Specifies whether to display the Total columns. */ - showColumnTotals?: boolean; - /** Specifies whether to display the Grand Total column. */ - showColumnGrandTotals?: boolean; - /** Specifies whether or not to hide rows and columns with no data. */ - hideEmptySummaryCells?: boolean; - /** Specifies where to show the total rows or columns. */ - showTotalsPrior?: string; - /** Specifies the layout of items in the row header. */ - rowHeaderLayout?: string; - /** Specifies whether the outer borders of the grid are visible or not. */ - showBorders?: boolean; - /** The Field Chooser configuration options. */ - fieldChooser?: { - /** Enables or disables the field chooser. */ - enabled?: boolean; - /** Specifies the field chooser layout. */ - layout?: number; - /** Specifies the text to display as a title of the field chooser popup window. */ - title?: string; - /** Specifies the field chooser width. */ - width?: number; - /** Specifies the field chooser height. */ - height?: number; - /** Strings that can be changed or localized in the pivot grid's integrated Field Chooser. */ - texts?: { - /** The string to display instead of Row Fields. */ - rowFields?: string; - /** The string to display instead of Column Fields. */ - columnFields?: string; - /** The string to display instead of Data Fields. */ - dataFields?: string; - /** The string to display instead of Filter Fields. */ - filterFields?: string; - /** The string to display instead of All Fields. */ - allFields?: string; - }; - } - /** Strings that can be changed or localized in the dxPivotGrid widget. */ - texts?: { - /** The string to display as a header of the Grand Total row and column. */ - grandTotal?: string; - /** The string to display as a header of the Total row and column. */ - total?: string; - /** Specifies the text displayed when a pivot grid does not contain any fields. */ - noData?: string; - /** The string to display as a Show Field Chooser context menu item. */ - showFieldChooser?: string; - /** The string to display as an Expand All context menu item. */ - expandAll?: string; - /** The string to display as a Collapse All context menu item. */ - collapseAll?: string; - /** The string to display as a Sort Column by Summary Value context menu item. */ - sortColumnBySummary?: string; - /** The string to display as a Sort Row by Summary Value context menu item. */ - sortRowBySummary?: string; - /** The string to display as a Remove All Sorting context menu item. */ - removeAllSorting?: string; - /** The string to display as an Export to Excel file context menu item. */ - exportToExcel?: string; - }; - /** Specifies options configuring the load panel. */ - loadPanel?: { - /** Enables or disables the load panel. */ - enabled?: boolean; - /** Specifies the height of the load panel. */ - height?: number; - /** Specifies the URL pointing to an image that will be used as a load indicator. */ - indicatorSrc?: string; - /** Specifies whether or not to show a load indicator. */ - showIndicator?: boolean; - /** Specifies whether or not to show load panel background. */ - showPane?: boolean; - /** Specifies the text to display inside a load panel. */ - text?: string; - /** Specifies the width of the load panel. */ - width?: number; - }; - /** A handler for the cellClick event. */ - onCellClick?: (e: any) => void; - /** A handler for the cellPrepared event. */ - onCellPrepared?: (e: any) => void; - /** A handler for the contextMenuPreparing event. */ - onContextMenuPreparing?: (e: Object) => void; - /** Configures client-side export. */ - export?: { - /** Enables client-side export. */ - enabled?: boolean; - /** Specifies a default name for the file to which grid data is exported. */ - fileName?: string; - /** Specifies the URL of the server-side proxy that streams the resulting file to the end user to enable export in IE9 and Safari browsers. */ - proxyUrl?: string; - }; - /** A handler for the exporting event. */ - onExporting?: (e: { - fileName: string; - cancel: boolean; - }) => void; - /** A handler for the fileSaving event. */ - onFileSaving?: (e: { - fileName: string; - format: string; - data: any; - cancel: boolean; - }) => void; - /** A handler for the exported event. */ - onExported?: (e: Object) => void; - /** A configuration object specifying options related to state storing. */ - stateStoring?: { - /** Specifies a callback function that performs specific actions on state loading. */ - customLoad?: () => JQueryPromise; - /** Specifies a callback function that performs specific actions on state saving. */ - customSave?: (gridState: Object) => void; - /** Specifies whether or not a grid saves its state. */ - enabled?: boolean; - /** Specifies the delay between the last change of a grid state and the operation of saving this state in milliseconds. */ - savingTimeout?: number; - /** Specifies a unique key to be used for storing the grid state. */ - storageKey?: string; - /** Specifies the type of storage to be used for state storing. */ - type?: string; - }; - } - /** A data summarization widget for multi-dimensional data analysis and data mining. */ - export class dxPivotGrid extends Widget { - constructor(element: JQuery, options?: dxPivotGridOptions); - constructor(element: Element, options?: dxPivotGridOptions); - /** Gets the PivotGridDataSource instance. */ - getDataSource(): DevExpress.data.PivotGridDataSource; - /** Gets the dxPopup instance of the field chooser window. */ - getFieldChooserPopup(): DevExpress.ui.dxPopup; - /** Updates the widget to the size of its content. */ - updateDimensions(): void; - /** Exports pivot grid data to the Excel file. */ - exportToExcel(): void; - /** Binds a dxChart to the dxPivotGrid. */ - bindChart(chart: any, integrationOptions?: { - inverted?: boolean; - dataFieldsDisplayMode?: string; - putDataFieldsInto?: string; - alternateDataFields?: boolean; - processCell?: Function; - customizeChart?: Function; - customizeSeries?: Function; - }): any; - } - export interface dxPivotGridFieldChooserOptions extends WidgetOptions { - /** Specifies the height of the widget. */ - height?: any; - /** Specifies the field chooser layout. */ - layout?: number; - /** The data source of a dxPivotGrid widget. */ - dataSource?: DevExpress.data.PivotGridDataSource; - onContentReady?: Function; - /** A handler for the contextMenuPreparing event. */ - onContextMenuPreparing?: (e: Object) => void; - /** Strings that can be changed or localized in the dxPivotGridFieldChooser widget. */ - texts?: { - /** The string to display instead of Row Fields. */ - rowFields?: string; - /** The string to display instead of Column Fields. */ - columnFields?: string; - /** The string to display instead of Data Fields. */ - dataFields?: string; - /** The string to display instead of Filter Fields. */ - filterFields?: string; - /** The string to display instead of All Fields. */ - allFields?: string; - }; - } - /** A complementary widget for dxPivotGrid that allows you to manage data displayed in the dxPivotGrid. */ - export class dxPivotGridFieldChooser extends Widget { - constructor(element: JQuery, options?: dxPivotGridFieldChooserOptions); - constructor(element: Element, options?: dxPivotGridFieldChooserOptions); - /** Updates the widget to the size of its content. */ - updateDimensions(): void; - /** Gets the PivotGridDataSource instance. */ - getDataSource(): DevExpress.data.PivotGridDataSource; - } -} -interface JQuery { - dxTreeView(): JQuery; - dxTreeView(options: "instance"): DevExpress.ui.dxTreeView; - dxTreeView(options: string): any; - dxTreeView(options: string, ...params: any[]): any; - dxTreeView(options: DevExpress.ui.dxTreeViewOptions): JQuery; - dxMenuBase(): JQuery; - dxMenuBase(options: "instance"): DevExpress.ui.dxMenuBase; - dxMenuBase(options: string): any; - dxMenuBase(options: string, ...params: any[]): any; - dxMenuBase(options: DevExpress.ui.dxMenuBaseOptions): JQuery; - dxMenu(): JQuery; - dxMenu(options: "instance"): DevExpress.ui.dxMenu; - dxMenu(options: string): any; - dxMenu(options: string, ...params: any[]): any; - dxMenu(options: DevExpress.ui.dxMenuOptions): JQuery; - dxContextMenu(): JQuery; - dxContextMenu(options: "instance"): DevExpress.ui.dxContextMenu; - dxContextMenu(options: string): any; - dxContextMenu(options: string, ...params: any[]): any; - dxContextMenu(options: DevExpress.ui.dxContextMenuOptions): JQuery; - dxColorBox(): JQuery; - dxColorBox(options: "instance"): DevExpress.ui.dxColorBox; - dxColorBox(options: string): any; - dxColorBox(options: string, ...params: any[]): any; - dxColorBox(options: DevExpress.ui.dxColorBoxOptions): JQuery; - dxDataGrid(): JQuery; - dxDataGrid(options: "instance"): DevExpress.ui.dxDataGrid; - dxDataGrid(options: string): any; - dxDataGrid(options: string, ...params: any[]): any; - dxDataGrid(options: DevExpress.ui.dxDataGridOptions): JQuery; - dxPivotGrid(): JQuery; - dxPivotGrid(options: "instance"): DevExpress.ui.dxPivotGrid; - dxPivotGrid(options: string): any; - dxPivotGrid(options: string, ...params: any[]): any; - dxPivotGrid(options: DevExpress.ui.dxPivotGridOptions): JQuery; - dxPivotGridFieldChooser(): JQuery; - dxPivotGridFieldChooser(options: "instance"): DevExpress.ui.dxPivotGridFieldChooser; - dxPivotGridFieldChooser(options: string): any; - dxPivotGridFieldChooser(options: string, ...params: any[]): any; - dxPivotGridFieldChooser(options: DevExpress.ui.dxPivotGridFieldChooserOptions): JQuery; - dxScheduler(): JQuery; - dxScheduler(options: "instance"): DevExpress.ui.dxScheduler; - dxScheduler(options: string): any; - dxScheduler(options: string, ...params: any[]): any; - dxScheduler(options: DevExpress.ui.dxSchedulerOptions): JQuery; -} -declare module DevExpress.framework { - /** An object used to store information on the views displayed in an application. */ - export class ViewCache { - viewRemoved: JQueryCallback; - /** Removes all the viewInfo objects from the cache. */ - clear(): void; - /** Obtains a viewInfo object from the cache by the specified key. */ - getView(key: string): Object; - /** Checks whether or not a viewInfo object is contained in the view cache under the specified key. */ - hasView(key: string): boolean; - /** Removes a viewInfo object from the cache by the specified key. */ - removeView(key: string): Object; - /** Adds the specified viewInfo object to the cache under the specified key. */ - setView(key: string, viewInfo: Object): void; - } - export interface dxCommandOptions extends DOMComponentOptions { - /** Specifies an action performed when the execute() method of the command is called. */ - onExecute?: any; - /** Indicates whether or not the widget that displays this command is disabled. */ - disabled?: boolean; - /** Specifies whether the current command is rendered when a view is being rendered or after a view is shown. */ - renderStage?: string; - /** Specifies the name of the icon shown inside the widget associated with this command. */ - icon?: string; - iconSrc?: string; - /** The identifier of the command. */ - id?: string; - /** Specifies the title of the widget associated with this command. */ - title?: string; - /** Specifies the type of the button, if the command is rendered as a dxButton widget. */ - type?: string; - /** A Boolean value specifying whether or not the widget associated with this command is visible. */ - visible?: boolean; - } - /** A markup component used to define markup options for a command. */ - export class dxCommand extends DOMComponent { - constructor(element: JQuery, options: dxCommandOptions); - constructor(options: dxCommandOptions); - /** Executes the action associated with this command. */ - execute(): void; - } - /** An object responsible for routing. */ - export class Router { - /** Adds a routing rule to the list of registered rules. */ - register(pattern: string, defaults?: Object, constraints?: Object): void; - /** Decodes the specified URI to an object using the registered routing rules. */ - parse(uri: string): Object; - /** Formats an object to a URI. */ - format(obj: Object): string; - } - export interface StateManagerOptions { - /** A storage to which the state manager saves the application state. */ - storage?: Object; - } - /** An object used to store the current application state. */ - export class StateManager { - constructor(options?: StateManagerOptions); - /** Adds an object that implements an interface of a state source to the state manager's collection of state sources. */ - addStateSource(stateSource: Object): void; - /** Removes a specified state source from the state manager's collection of state sources. */ - removeStateSource(stateSource: Object): void; - /** Saves the current application state. */ - saveState(): void; - /** Restores the application state that has been saved by the saveState() method to the state storage. */ - restoreState(): void; - /** Removes the application state that has been saved by the saveState() method to the state storage. */ - clearState(): void; - } - export module html { - export var layoutSets: Array; - export var animationSets: { [animationSetName: string]: AnimationSet }; - export interface AnimationSet { - [animationName: string]: any - } - export interface HtmlApplicationOptions { - /** Specifies where the commands that are defined in the application's views must be displayed. */ - commandMapping?: Object; - /** Specifies whether or not view caching is disabled. */ - disableViewCache?: boolean; - /** An array of layout controllers that should be used to show application views in the current navigation context. */ - layoutSet?: any; - /** Specifies the animation presets that are used to animate different UI elements in the current application. */ - animationSet?: AnimationSet; - /** Specifies whether the current application must behave as a mobile or web application. */ - mode?: string; - /** Specifies the object that represents a root namespace of the application. */ - namespace?: Object; - /** Specifies application behavior when the user navigates to a root view. */ - navigateToRootViewMode?: string; - /** An array of dxCommand configuration objects used to define commands available from the application's global navigation. */ - navigation?: Array; - /** A state manager to be used in the application. */ - stateManager?: StateManager; - /** Specifies the storage to be used by the application's state manager to store the application state. */ - stateStorage?: Object; - /** Indicates whether on not to use the title of the previously displayed view as text on the Back button. */ - useViewTitleAsBackText?: boolean; - /** A custom view cache to be used in the application. */ - viewCache?: Object; - /** Specifies a limit for the views that can be cached. */ - viewCacheSize?: number; - /** Specifies the current version of application templates. */ - templatesVersion?: string; - /** Specifies options for the viewport meta tag of a mobile browser. */ - viewPort?: JQuery; - /** A custom router to be used in the application. */ - router?: Router; - } - /** An object used to manage views, as well as control the application life cycle. */ - export class HtmlApplication implements EventsMixin { - constructor(options: HtmlApplicationOptions); - afterViewSetup: JQueryCallback; - beforeViewSetup: JQueryCallback; - initialized: JQueryCallback; - navigating: JQueryCallback; - navigatingBack: JQueryCallback; - resolveLayoutController: JQueryCallback; - resolveViewCacheKey: JQueryCallback; - viewDisposed: JQueryCallback; - viewDisposing: JQueryCallback; - viewHidden: JQueryCallback; - viewRendered: JQueryCallback; - viewShowing: JQueryCallback; - viewShown: JQueryCallback; - /** Provides access to the ViewCache object. */ - viewCache: ViewCache; - /** An array of dxCommand components that are created based on the application's navigation option value. */ - navigation: Array; - /** Provides access to the StateManager object. */ - stateManager: StateManager; - /** Provides access to the Router object. */ - router: Router; - /** Navigates to the URI preceding the current one in the navigation history. */ - back(): void; - /** Returns a Boolean value indicating whether or not backwards navigation is currently possible. */ - canBack(): boolean; - /** Calls the clearState() method of the application's StateManager object. */ - clearState(): void; - /** Creates global navigation commands. */ - createNavigation(navigationConfig: Array): void; - /** Returns an HTML template of the specified view. */ - getViewTemplate(viewName: string): JQuery; - /** Returns a configuration object used to create a dxView component for a specified view. */ - getViewTemplateInfo(viewName: string): Object; - /** Adds a specified HTML template to a collection of view or layout templates. */ - loadTemplates(source: any): JQueryPromise; - /** Navigates to the specified URI. */ - navigate(uri?: any, options?: Object): void; - /** Renders navigation commands to the navigation command containers that are located in the layouts used in the application. */ - renderNavigation(): void; - /** Calls the restoreState() method of the application's StateManager object. */ - restoreState(): void; - /** Calls the saveState method of the application's StateManager object. */ - saveState(): void; - /** Provides access to the object that defines the current context to be considered when choosing an appropriate template for a view. */ - templateContext(): Object; - on(eventName: "initialized", eventHandler: () => void): HtmlApplication; - on(eventName: "afterViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "beforeViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "navigating", eventHandler: (e: { - currentUri: string; - uri: string; - cancel: boolean; - options: { - root: boolean; - target: string; - direction: string; - rootInDetailPane: boolean; - modal: boolean; - }; - }) => void): HtmlApplication; - on(eventName: "navigatingBack", eventHandler: (e: { - cancel: boolean; - isHardwareButton: boolean; - }) => void): HtmlApplication; - on(eventName: "resolveLayoutController", eventHandler: (e: { - viewInfo: Object; - layoutController: Object; - availableLayoutControllers: Array; - }) => void): HtmlApplication; - on(eventName: "resolveViewCacheKey", eventHandler: (e: { - key: string; - navigationItem: Object; - routeData: Object; - }) => void): HtmlApplication; - on(eventName: "viewDisposed", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewDisposing", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewHidden", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewRendered", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - on(eventName: "viewShowing", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - on(eventName: "viewShown", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - on(eventName: string, eventHandler: Function): HtmlApplication; - on(events: { [eventName: string]: Function; }): HtmlApplication; - off(eventName: "initialized"): HtmlApplication; - off(eventName: "afterViewSetup"): HtmlApplication; - off(eventName: "beforeViewSetup"): HtmlApplication; - off(eventName: "navigating"): HtmlApplication; - off(eventName: "navigatingBack"): HtmlApplication; - off(eventName: "resolveLayoutController"): HtmlApplication; - off(eventName: "resolveViewCacheKey"): HtmlApplication; - off(eventName: "viewDisposed"): HtmlApplication; - off(eventName: "viewDisposing"): HtmlApplication; - off(eventName: "viewHidden"): HtmlApplication; - off(eventName: "viewRendered"): HtmlApplication; - off(eventName: "viewShowing"): HtmlApplication; - off(eventName: "viewShown"): HtmlApplication; - off(eventName: string): HtmlApplication; - off(eventName: "initialized", eventHandler: () => void): HtmlApplication; - off(eventName: "afterViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "beforeViewSetup", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "navigating", eventHandler: (e: { - currentUri: string; - uri: string; - cancel: boolean; - options: { - root: boolean; - target: string; - direction: string; - rootInDetailPane: boolean; - modal: boolean; - }; - }) => void): HtmlApplication; - off(eventName: "navigatingBack", eventHandler: (e: { - cancel: boolean; - isHardwareButton: boolean; - }) => void): HtmlApplication; - off(eventName: "resolveLayoutController", eventHandler: (e: { - viewInfo: Object; - layoutController: Object; - availableLayoutControllers: Array; - }) => void): HtmlApplication; - off(eventName: "resolveViewCacheKey", eventHandler: (e: { - key: string; - navigationItem: Object; - routeData: Object; - }) => void): HtmlApplication; - off(eventName: "viewDisposed", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewDisposing", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewHidden", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewRendered", eventHandler: (e: { - viewInfo: Object; - }) => void): HtmlApplication; - off(eventName: "viewShowing", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - off(eventName: "viewShown", eventHandler: (e: { - viewInfo: Object; - direction: string; - }) => void): HtmlApplication; - off(eventName: string, eventHandler: Function): HtmlApplication; - } - } -} -declare module DevExpress.viz.core { - export interface Border { - /** Sets a border color for a selected series. */ - color?: string; - /** Sets border visibility for a selected series. */ - visible?: boolean; - /** Sets a border width for a selected series. */ - width?: number; - } - export interface DashedBorder extends Border { - /** Specifies a dash style for the border of a selected series point. */ - dashStyle?: string; - } - export interface DashedBorderWithOpacity extends DashedBorder { - /** Specifies how transparent the vertical crosshair line should be. */ - opacity?: number; - } - export interface Font { - /** Colors the text displayed by the group labels. */ - color?: string; - /** Specifies the font family of the text displayed by the group labels. */ - family?: string; - /** Specifies how transparent the text displayed by the group labels should be. */ - opacity?: number; - /** Specifies the size of the text displayed by the group labels. */ - size?: any; - /** Specifies the font weight of the text displayed by the group labels. */ - weight?: number; - } - export interface Hatching { - direction?: string; - /** Specifies the opacity of hatching lines. */ - opacity?: number; - /** Specifies the distance between hatching lines in pixels. */ - step?: number; - /** Specifies the width of hatching lines in pixels. */ - width?: number; - } - export interface Margins { - /** Specifies the legend's bottom margin in pixels. */ - bottom?: number; - /** Specifies the legend's left margin in pixels. */ - left?: number; - /** Specifies the legend's right margin in pixels. */ - right?: number; - /** Specifies the legend's bottom margin in pixels. */ - top?: number; - } - export interface MarginOptions { - /** Generates space around the widget. */ - margin?: Margins; - } - export interface RedrawOnResizeOptions { - /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */ - redrawOnResize?: boolean; - } - export interface TitleOptions { - /** Specifies the widget title. */ - title?: Title; - } - export interface ExportOptions { - /** Configures the exporting and printing features. */ - export?: Export; - } - export interface LoadingIndicatorOptions { - /** Configures the loading indicator. */ - loadingIndicator?: LoadingIndicator; - } - export interface LoadingIndicatorMethods { - /** Displays the loading indicator. */ - showLoadingIndicator(): void; - /** Conceals the loading indicator. */ - hideLoadingIndicator(): void; - } - export interface Size { - /** Specifies the width of the widget in pixels. */ - width?: number; - /** Specifies the height of the widget in pixels. */ - height?: number; - } - export interface Title { - /** Specifies font options for the title. */ - font?: viz.core.Font; - /** Specifies the title's alignment in a horizontal direction. */ - horizontalAlignment?: string; - /** Specifies the title's alignment in a vertical direction. */ - verticalAlignment?: string; - /** Generates space around the title. */ - margin?: Margins; - /** Specifies the minimum height that the title occupies. */ - placeholderSize?: number; - /** Specifies the title text. */ - text?: string; - /** Specifies the widget subtitle. */ - subtitle?: { - /** Specifies font options for the subtitle. */ - font?: viz.core.Font; - /** Specifies text for the subtitle. */ - text?: string; - } - } - export interface Export { - /** Enables the client-side exporting in the widget. */ - enabled?: boolean; - /** Enables the printing feature in the widget. Applies only if the export | enabled option is true. */ - printingEnabled?: boolean; - /** Specifies a set of formats available for exporting into. */ - formats?: Array; - /** Specifies a default name for the file to which the widget will be exported. */ - fileName?: string; - /** Specifies the URL of the server-side proxy that streams the resulting file to the end user to enable exporting in IE9 and Safari browsers. */ - proxyUrl?: string; - /** Specifies the color that will fill transparent regions in the resulting file or document. */ - backgroundColor?: string; - } - export interface Tooltip { - /** Specifies the length of the tooltip's arrow in pixels. */ - arrowLength?: number; - /** Specifies the appearance of the tooltip's border. */ - border?: DashedBorderWithOpacity; - /** Specifies the color of tooltips. */ - color?: string; - /** Specifies the z-index of tooltips. */ - zIndex?: number; - /** Specifies the container to draw tooltips inside of it. */ - container?: any; - /** Allows you to change tooltip appearance. */ - customizeTooltip?: (arg: Object) => { color?: string; text?: string }; - enabled?: boolean; - /** Specifies the font of the text displayed by a tooltip. */ - font?: Font; - /** Specifies the format of the value displayed by a tooltip. */ - format?: any; - /** Specifies the opacity of tooltips. */ - opacity?: number; - /** Generates space on the left and the right of the text displayed by a tooltip. */ - paddingLeftRight?: number; - /** Generates space above and below the text displayed by a tooltip. */ - paddingTopBottom?: number; - /** - * Specifies the precision of formatted values in a tooltip. - * @deprecated Use the tooltip | format | precision option instead. - */ - precision?: number; - /** Specifies the appearance of the tooltip's shadow. */ - shadow?: { - /** Specifies the blur distance of the tooltip's shadow. */ - blur?: number; - /** Specifies the color of the tooltip's shadow. */ - color?: string; - /** Specifies the horizontal offset of the tooltip's shadow relative to the tooltip itself measured in pixels. */ - offsetX?: number; - /** Specifies the vertical offset of the tooltip's shadow relative to the tooltip itself measured in pixels. */ - offsetY?: number; - /** Specifies the opacity of the tooltip's shadow. */ - opacity?: number; - }; - } - export interface Animation { - /** Determines how long animation runs. */ - duration?: number; - /** Specifies the animation easing mode. */ - easing?: string; - /** Indicates whether or not animation is enabled. */ - enabled?: boolean; - } - export interface LoadingIndicator { - /** Colors the background of the loading indicator. */ - backgroundColor?: string; - /** Specifies font options for the loading indicator. */ - font?: viz.core.Font; - /** Specifies whether to show the loading indicator or not. */ - show?: boolean; - /** Specifies the text to be displayed by the loading indicator. */ - text?: string; - } - export interface LegendBorder extends viz.core.DashedBorderWithOpacity { - /** Specifies a radius for the corners of the legend border. */ - cornerRadius?: number; - } - export interface BaseLegend { - /** Specifies the color of the legend's background. */ - backgroundColor?: string; - /** Specifies legend border settings. */ - border?: viz.core.LegendBorder; - /** Specifies how many columns must be taken to arrange legend items. */ - columnCount?: number; - /** Specifies the spacing between a pair of neighboring legend columns in pixels. */ - columnItemSpacing?: number; - /** Specifies font options for legend items. */ - font?: viz.core.Font; - /** Specifies the legend's position on the map. */ - horizontalAlignment?: string; - /** Specifies the alignment of legend items. */ - itemsAlignment?: string; - /** Specifies the position of text relative to the item marker. */ - itemTextPosition?: string; - /** Specifies the distance between the legend and the container borders in pixels. */ - margin?: viz.core.Margins; - /** Specifies the size of item markers in the legend in pixels. */ - markerSize?: number; - /** Specifies whether to arrange legend items horizontally or vertically. */ - orientation?: string; - /** Specifies the spacing between the legend left/right border and legend items in pixels. */ - paddingLeftRight?: number; - /** Specifies the spacing between the legend top/bottom border and legend items in pixels. */ - paddingTopBottom?: number; - /** Specifies how many rows must be taken to arrange legend items. */ - rowCount?: number; - /** Specifies the spacing between a pair of neighboring legend rows in pixels. */ - rowItemSpacing?: number; - /** Specifies the legend's position on the map. */ - verticalAlignment?: string; - /** Specifies whether or not the legend is visible on the map. */ - visible?: boolean; - } - export interface BaseWidgetOptions extends DOMComponentOptions { - /** Specifies the size of the widget in pixels. */ - size?: Size; - /** A handler for the drawn event. */ - onDrawn?: (e: { - component: BaseWidget; - element: Element; - }) => void; - /** A handler for the incidentOccurred event. */ - onIncidentOccurred?: ( - component: BaseWidget, - element: Element, - target: { - id: string; - type: string; - args: any; - text: string; - widget: string; - version: string; - } - ) => void; - /** A handler for the exporting event. */ - onExporting?: (e: { - fileName: string; - cancel: boolean; - }) => void; - /** A handler for the fileSaving event. */ - onFileSaving?: (e: { - fileName: string; - format: string; - data: any; - cancel: boolean; - }) => void; - /** A handler for the exported event. */ - onExported?: (e: Object) => void; - /** Notifies a widget that it is embedded into an HTML page that uses a path modifier. */ - pathModified?: boolean; - /** Specifies whether or not the widget supports right-to-left representation. */ - rtlEnabled?: boolean; - /** Sets the name of the theme to be used in the widget. */ - theme?: string; - } - /** This section describes options and methods that are common to all widgets. */ - export class BaseWidget extends DOMComponent { - /** Returns the widget's SVG markup. */ - svg(): string; - /** Exports the widget into a document with a specified name and format. */ - exportTo(): void; - /** Opens the browser's print window. */ - print(): void; - /** Redraws the widget. */ - render(): void; - } -} -declare module DevExpress.viz { - /** - * Applies a theme for the entire page with several DevExtreme visualization widgets. - * @deprecated Use the DevExpress.viz.currentTheme(theme) method instead. - */ - export function currentTheme(theme: string): void; - /** - * Applies a new theme (with the color scheme defined separately) for the entire page with several DevExtreme visualization widgets. - * @deprecated Use the DevExpress.viz.currentTheme(platform, colorScheme) method instead. - */ - export function currentTheme(platform: string, colorScheme: string): void; - /** - * Registers a new theme based on the existing one. - * @deprecated Use the DevExpress.viz.registerTheme(customTheme, baseTheme) method instead. - */ - export function registerTheme(customTheme: Object, baseTheme: string): void; - /** - * Applies a predefined or registered custom palette to all visualization widgets at once. - * @deprecated Use the DevExpress.viz.currentPalette(paletteName) method instead. - */ - export function currentPalette(paletteName: string): void; - /** - * Obtains the color sets of a predefined or registered palette. - * @deprecated Use the DevExpress.viz.getPalette(paletteName) method instead. - */ - export function getPalette(paletteName: string): Object; - /** - * Registers a new palette. - * @deprecated Use the DevExpress.viz.registerPalette(paletteName, palette) method instead. - */ - export function registerPalette(paletteName: string, palette: Object): void; -} -declare module DevExpress.viz.charts { - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface BaseSeries { - /** Provides information about the state of the series object. */ - fullState: number; - /** Returns the type of the series. */ - type: string; - /** Unselects all the selected points of the series. The points are displayed in an initial style. */ - clearSelection(): void; - /** Gets the color of a particular series. */ - getColor(): string; - /** Gets points from the series point collection based on the specified argument. */ - getPointsByArg(pointArg: any): Array; - /** Gets a point from the series point collection based on the specified point position. */ - getPointByPos(positionIndex: number): Object; - /** Selects the series. The series is displayed in a 'selected' style until another series is selected or the current series is deselected programmatically. */ - select(): void; - /** Selects the specified point. The point is displayed in a 'selected' style. */ - selectPoint(point: BasePoint): void; - /** Deselects the specified point. The point is displayed in an initial style. */ - deselectPoint(point: BasePoint): void; - /** Returns an array of all points in the series. */ - getAllPoints(): Array; - /** Returns visible series points. */ - getVisiblePoints(): Array; - /** Returns the name of the series. */ - name: string; - /** Returns the tag of the series. */ - tag: string; - /** Hides a series. */ - hide(): void; - /** Provides information about the hover state of a series. */ - isHovered(): boolean; - /** Provides information about the selection state of a series. */ - isSelected(): boolean; - /** Provides information about the visibility state of a series. */ - isVisible(): boolean; - /** Makes a particular series visible. */ - show(): void; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface BasePoint { - /** Provides information about the state of the point object. */ - fullState: number; - /** Returns the point's argument value that was set in the data source. */ - originalArgument: any; - /** Returns the point's value that was set in the data source. */ - originalValue: any; - /** Returns the tag of the point. */ - tag: string; - /** Deselects the point. */ - clearSelection(): void; - /** Gets the color of a particular point. */ - getColor(): string; - /** Hides the tooltip of the point. */ - hideTooltip(): void; - /** Provides information about the hover state of a point. */ - isHovered(): boolean; - /** Provides information about the selection state of a point. */ - isSelected(): boolean; - /** Selects the point. The point is displayed in a 'selected' style until another point is selected or the current point is deselected programmatically. */ - select(): void; - /** Shows the tooltip of the point. */ - showTooltip(): void; - /** Allows you to obtain the label(s) of the series point. */ - getLabel(): any; - /** Returns the series object to which the point belongs. */ - series: BaseSeries; - } - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface ChartSeries extends BaseSeries { - /** Returns the name of the series pane. */ - pane: string; - /** Returns the name of the value axis of the series. */ - axis: string; - selectPoint(point: ChartPoint): void; - deselectPoint(point: ChartPoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface ChartPoint extends BasePoint { - /** Contains the close value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalCloseValue: any; - /** Contains the high value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalHighValue: any; - /** Contains the low value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalLowValue: any; - /** Contains the first value of the point. This field is useful for points belonging to a series of the range area or range bar type only. */ - originalMinValue: any; - /** Contains the open value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ - originalOpenValue: any; - /** Contains the size of the bubble as it was set in the data source. This field is useful for points belonging to a series of the bubble type only. */ - size: any; - /** Gets the parameters of the point's minimum bounding rectangle (MBR). */ - getBoundingRect(): { x: number; y: number; width: number; height: number; }; - series: ChartSeries; - } - /** This section describes the methods that can be used in code to manipulate the Label object. */ - export interface Label { - /** Gets the parameters of the label's minimum bounding rectangle (MBR). */ - getBoundingRect(): { x: number; y: number; width: number; height: number; }; - /** Hides the point label. */ - hide(): void; - /** Shows the point label. */ - show(): void; - } - export interface PieSeries extends BaseSeries { - selectPoint(point: PiePoint): void; - deselectPoint(point: PiePoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface PiePoint extends BasePoint { - /** Gets the percentage value of the specific point. */ - percent: any; - /** Provides information about the visibility state of a point. */ - isVisible(): boolean; - /** Makes a specific point visible. */ - show(): void; - /** Hides a specific point. */ - hide(): void; - series: PieSeries; - } - /** This section describes the fields and methods that can be used in code to manipulate the Series object. */ - export interface PolarSeries extends BaseSeries { - /** Returns the name of the value axis of the series. */ - axis: string; - selectPoint(point: PolarPoint): void; - deselectPoint(point: PolarPoint): void; - getAllPoints(): Array; - getVisiblePoints(): Array; - } - /** This section describes the methods that can be used in code to manipulate the Point object. */ - export interface PolarPoint extends BasePoint { - series: PolarSeries; - } - export interface Strip { - /** Specifies a color for a strip. */ - color?: string; - /** An object that defines the label configuration options of a strip. */ - label?: { - /** Specifies the text displayed in a strip. */ - text?: string; - }; - /** Specifies a start value for a strip. */ - startValue?: any; - /** Specifies an end value for a strip. */ - endValue?: any; - } - export interface BaseSeriesConfigLabel { - /** Specifies a format for arguments displayed by point labels. */ - argumentFormat?: any; - /** - * Specifies a precision for formatted point arguments displayed in point labels. - * @deprecated Use the series | label | argumentFormat | precision instead. - */ - argumentPrecision?: number; - /** Specifies a background color for point labels. */ - backgroundColor?: string; - /** Specifies border options for point labels. */ - border?: viz.core.DashedBorder; - /** Specifies connector options for series point labels. */ - connector?: { - /** Specifies the color of label connectors. */ - color?: string; - /** Indicates whether or not label connectors are visible. */ - visible?: boolean; - /** Specifies the width of label connectors. */ - width?: number; - }; - /** Specifies a callback function that returns the text to be displayed by point labels. */ - customizeText?: (pointInfo: Object) => string; - /** Specifies font options for the text displayed in point labels. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed by point labels. */ - format?: any; - position?: string; - /** - * Specifies a precision for formatted point values displayed in point labels. - * @deprecated Use the series | label | format | precision option instead. - */ - precision?: number; - /** Specifies the angle used to rotate point labels from their initial position. */ - rotationAngle?: number; - /** Specifies the visibility of point labels. */ - visible?: boolean; - } - export interface SeriesConfigLabel extends BaseSeriesConfigLabel { - /** Specifies whether or not to show labels for points with zero value. Applies only to bar-like series. */ - showForZeroValues?: boolean; - } - export interface ChartSeriesConfigLabel extends SeriesConfigLabel { - /** Aligns point labels in relation to their points. */ - alignment?: string; - /** Along with verticalOffset, shifts point labels from their initial positions. */ - horizontalOffset?: number; - /** Along with horizontalOffset, shifts point labels from their initial positions. */ - verticalOffset?: number; - /** - * Specifies a precision for the percentage values displayed in the labels of a full-stacked-like series. - * @deprecated Use the series | label | format | percentPrecision instead. - */ - percentPrecision?: number; - } - export interface BaseCommonSeriesConfig { - /** Specifies the data source field that provides arguments for series points. */ - argumentField?: string; - axis?: string; - label?: ChartSeriesConfigLabel; - border?: viz.core.DashedBorder; - /** Specifies a series color. */ - color?: string; - /** Specifies the dash style of the series' line. */ - dashStyle?: string; - hoverMode?: string; - hoverStyle?: { - border?: viz.core.DashedBorder; - /**

Sets a color for a series when it is hovered over.

*/ - color?: string; - /** Specifies the dash style for the line in a hovered series. */ - dashStyle?: string; - hatching?: viz.core.Hatching; - /** Specifies the width of a line in a hovered series. */ - width?: number; - }; - /** Specifies whether a chart ignores null data points or not. */ - ignoreEmptyPoints?: boolean; - /** Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed. */ - maxLabelCount?: number; - /** Specifies the minimal length of a displayed bar in pixels. */ - minBarSize?: number; - /** Specifies opacity for a series. */ - opacity?: number; - /** Specifies series elements to be highlighted when a user selects a point. */ - selectionMode?: string; - selectionStyle?: { - border?: viz.core.DashedBorder; - /** Sets a color for a series when it is selected. */ - color?: string; - /** Specifies the dash style for the line in a selected series. */ - dashStyle?: string; - hatching?: viz.core.Hatching; - /** Specifies the width of a line in a selected series. */ - width?: number; - }; - /** Specifies whether or not to show the series in the chart's legend. */ - showInLegend?: boolean; - /** Specifies the name of the stack where the values of the _stackedBar_ series must be located. */ - stack?: string; - /** Specifies the name of the data source field that provides data about a point. */ - tagField?: string; - /** Specifies the data source field that provides values for series points. */ - valueField?: string; - /** Specifies the visibility of a series. */ - visible?: boolean; - /** Specifies a line width. */ - width?: number; - /** Configures error bars. */ - valueErrorBar?: { - /** Specifies whether error bars must be displayed in full or partially. */ - displayMode?: string; - /** Specifies the data field that provides data for low error values. */ - lowValueField?: string; - /** Specifies the data field that provides data for high error values. */ - highValueField?: string; - /** Specifies how error bar values must be calculated. */ - type?: string; - /** Specifies the value to be used for generating error bars. */ - value?: number; - /** Specifies the color of error bars. */ - color?: string; - /** Specifies the opacity of error bars. */ - opacity?: number; - /** Specifies the length of the lines that indicate the error bar edges. */ - edgeLength?: number; - /** Specifies the width of the error bar line. */ - lineWidth?: number; - }; - } - export interface CommonPointOptions { - /** Specifies border options for points in the line and area series. */ - border?: viz.core.Border; - /** Specifies the points color. */ - color?: string; - /** Specifies what series points to highlight when a point is hovered over. */ - hoverMode?: string; - /** An object defining configuration options for a hovered point. */ - hoverStyle?: { - /** An object defining the border options for a hovered point. */ - border?: viz.core.Border; - /** Sets a color for a point when it is hovered over. */ - color?: string; - /** Specifies the diameter of a hovered point in the series that represents data points as symbols (not as bars for instance). */ - size?: number; - }; - /** Specifies what series points to highlight when a point is selected. */ - selectionMode?: string; - /** An object defining configuration options for a selected point. */ - selectionStyle?: { - /** An object defining the border options for a selected point. */ - border?: viz.core.Border; - /**

Sets a color for a point when it is selected.

*/ - color?: string; - /** Specifies the diameter of a selected point in the series that represents data points as symbols (not as bars for instance). */ - size?: number; - }; - /** Specifies the point diameter in pixels for those series that represent data points as symbols (not as bars for instance). */ - size?: number; - /** Specifies a symbol for presenting points of the line and area series. */ - symbol?: string; - visible?: boolean; - } - export interface ChartCommonPointOptions extends CommonPointOptions { - /** Substitutes the standard point symbols with an image. */ - image?: { - /** Specifies the height of the image used instead of a point marker. */ - height?: any; - /** Specifies the URL of the image to be used as a point marker. */ - url?: any; - /** Specifies the width of an image that is used as a point marker. */ - width?: any; - }; - } - export interface PolarCommonPointOptions extends CommonPointOptions { - /** An object specifying the parameters of an image that is used as a point marker. */ - image?: { - /** Specifies the height of an image that is used as a point marker. */ - height?: number; - /** Specifies a URL leading to the image to be used as a point marker. */ - url?: string; - /** Specifies the width of an image that is used as a point marker. */ - width?: number; - }; - } - /** An object that defines configuration options for chart series. */ - export interface CommonSeriesConfig extends BaseCommonSeriesConfig { - /** Specifies which data source field provides close values for points of a financial series. */ - closeValueField?: string; - /** Makes bars look rounded. Applies only to bar-like series. */ - cornerRadius?: number; - /** Specifies which data source field provides high values for points of a financial series. */ - highValueField?: string; - /** Specifies a filling color for the body of a series point that visualizes a non-reduced value. Applies only to candlestick series. */ - innerColor?: string; - /** Specifies which data source field provides low values for points of a financial series. */ - lowValueField?: string; - /** Specifies which data source field provides open values for points of a financial series. */ - openValueField?: string; - /** Specifies which pane the series should belong to. Accepts the name of the pane. */ - pane?: string; - point?: ChartCommonPointOptions; - /** Coupled with the rangeValue2Field option, specifies which data source field provides values for a range-like series. */ - rangeValue1Field?: string; - /** Coupled with the rangeValue1Field option, specifies which data source field provides values for a range-like series. */ - rangeValue2Field?: string; - /** Specifies reduction options for financial series. */ - reduction?: { - /** Specifies a color for the points whose price has decreased in comparison to the price of the previous point. */ - color?: string; - /** Specifies whether high, low, open or close prices of points should be compared. */ - level?: string; - }; - /** Specifies which data source field provides size values for bubbles. Required by and applies only to bubble series. */ - sizeField?: string; - } - export interface CommonSeriesSettings extends CommonSeriesConfig { - /** Defines common settings for all area series. */ - area?: CommonSeriesConfig; - /** Defines common settings for all bar series. */ - bar?: CommonSeriesConfig; - /** Defines common settings for all bubble series. */ - bubble?: CommonSeriesConfig; - /** Defines common settings for all candlestick series. */ - candlestick?: CommonSeriesConfig; - /** Defines common settings for all full-stacked area series. */ - fullstackedarea?: CommonSeriesConfig; - /** Defines common settings for all full-stacked spline area series. */ - fullstackedsplinearea?: CommonSeriesConfig; - /** Defines common settings for all full-stacked bar series. */ - fullstackedbar?: CommonSeriesConfig; - /** Defines common settings for all full-stacked line series. */ - fullstackedline?: CommonSeriesConfig; - /** Defines common settings for all full-stacked spline series. */ - fullstackedspline?: CommonSeriesConfig; - /** Defines common settings for all line series. */ - line?: CommonSeriesConfig; - /** Defines common settings for all range area series. */ - rangearea?: CommonSeriesConfig; - /** Defines common settings for all range bar series. */ - rangebar?: CommonSeriesConfig; - /** Defines common settings for all scatter series. */ - scatter?: CommonSeriesConfig; - /** Defines common settings for all spline series. */ - spline?: CommonSeriesConfig; - /** Defines common settings for all spline area series. */ - splinearea?: CommonSeriesConfig; - /** Defines common settings for all stacked area series. */ - stackedarea?: CommonSeriesConfig; - /** Defines common settings for all stacked spline area series. */ - stackedsplinearea?: CommonSeriesConfig; - /** Defines common settings for all stacked bar series. */ - stackedbar?: CommonSeriesConfig; - /** Defines common settings for all stacked line series. */ - stackedline?: CommonSeriesConfig; - /** Defines common settings for all stacked spline series. */ - stackedspline?: CommonSeriesConfig; - /** Defines common settings for all step area series. */ - steparea?: CommonSeriesConfig; - /** Defines common settings for all step line series. */ - stepline?: CommonSeriesConfig; - /** Defines common settings for all stock series. */ - stock?: CommonSeriesConfig; - /** Specifies the type of the series. */ - type?: string; - } - export interface SeriesConfig extends CommonSeriesConfig { - /** Specifies the name that identifies the series. */ - name?: string; - /** Specifies data about a series. */ - tag?: any; - /** Sets the series type. */ - type?: string; - } - /** An object that defines configuration options for polar chart series. */ - export interface CommonPolarSeriesConfig extends BaseCommonSeriesConfig { - /** Specifies whether or not to close the chart by joining the end point with the first point. */ - closed?: boolean; - label?: SeriesConfigLabel; - point?: PolarCommonPointOptions; - } - export interface CommonPolarSeriesSettings extends CommonPolarSeriesConfig { - /** An object that specifies configuration options for all series of the area type in the chart. */ - area?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _bar_ type in the chart. */ - bar?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _line_ type in the chart. */ - line?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _scatter_ type in the chart. */ - scatter?: CommonPolarSeriesConfig; - /** An object that specifies configuration options for all series of the _stackedBar_ type in the chart. */ - stackedbar?: CommonPolarSeriesConfig; - /** Sets a series type. */ - type?: string; - } - export interface PolarSeriesConfig extends CommonPolarSeriesConfig { - /** Specifies the name that identifies the series. */ - name?: string; - /** Specifies data about a series. */ - tag?: any; - /** Sets the series type. */ - type?: string; - } - export interface PieSeriesConfigLabel extends BaseSeriesConfigLabel { - /** Specifies how to shift labels from their initial position in a radial direction in pixels. */ - radialOffset?: number; - /** - * Specifies a precision for the percentage values displayed in labels. - * @deprecated Use the series | label | format | percentPrecision instead. - */ - percentPrecision?: number; - } - /** An object that defines configuration options for chart series. */ - export interface CommonPieSeriesConfig { - /** Specifies the data source field that provides arguments for series points. */ - argumentField?: string; - /** Specifies the required type for series arguments. */ - argumentType?: string; - /** An object defining the series border configuration options. */ - border?: viz.core.DashedBorder; - /** Specifies a series color. */ - color?: string; - /** Specifies the chart elements to highlight when a series is hovered over. */ - hoverMode?: string; - /** An object defining configuration options for a hovered series. */ - hoverStyle?: { - /** An object defining the border options for a hovered series. */ - border?: viz.core.DashedBorder; - /** Sets a color for the series when it is hovered over. */ - color?: string; - /** Specifies the hatching options to be applied when a point is hovered over. */ - hatching?: viz.core.Hatching; - }; - /** - * Specifies the fraction of the inner radius relative to the total radius in the series of the 'doughnut' type. - * @deprecated Use the innerRadius option instead. - */ - innerRadius?: number; - /** An object defining the label configuration options. */ - label?: PieSeriesConfigLabel; - /** Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed. */ - maxLabelCount?: number; - /** Specifies a minimal size of a displayed pie segment. */ - minSegmentSize?: number; - /** - * Specifies the direction in which the dxPieChart series points are located. - * @deprecated Use the segmentsDirection option instead. - */ - segmentsDirection?: string; - /**

Specifies the chart elements to highlight when the series is selected.

*/ - selectionMode?: string; - /** An object defining configuration options for the series when it is selected. */ - selectionStyle?: { - /** An object defining the border options for a selected series. */ - border?: viz.core.DashedBorder; - /** Sets a color for a series when it is selected. */ - color?: string; - /** Specifies the hatching options to be applied when a point is selected. */ - hatching?: viz.core.Hatching; - }; - /** Specifies chart segment grouping options. */ - smallValuesGrouping?: { - /** Specifies the name of the grouped chart segment. This name represents the segment in the chart legend. */ - groupName?: string; - /** Specifies the segment grouping mode. */ - mode?: string; - /** Specifies a threshold for segment values. */ - threshold?: number; - /** Specifies how many segments must not be grouped. */ - topCount?: number; - }; - /** - * Specifies a start angle for a pie chart in arc degrees. - * @deprecated Use the startAngle option instead. - */ - startAngle?: number; - /**

Specifies the name of the data source field that provides data about a point.

*/ - tagField?: string; - /** Specifies the data source field that provides values for series points. */ - valueField?: string; - } - export interface CommonPieSeriesSettings extends CommonPieSeriesConfig { - /** - * Specifies the type of the pie chart series. - * @deprecated Use the type option instead. - */ - type?: string; - } - export interface PieSeriesConfig extends CommonPieSeriesConfig { - /** - * Sets the series type. - * @deprecated Use the type option instead. - */ - type?: string; - /** Specifies the name that identifies the series. */ - name?: string; - /** Specifies data about a series. */ - tag?: any; - } - export interface SeriesTemplate { - /** Specifies a callback function that returns a series object with individual series settings. */ - customizeSeries?: (seriesName: string) => SeriesConfig; - /** Specifies a data source field that represents the series name. */ - nameField?: string; - } - export interface PolarSeriesTemplate { - /** Specifies a callback function that returns a series object with individual series settings. */ - customizeSeries?: (seriesName: string) => PolarSeriesConfig; - /** Specifies a data source field that represents the series name. */ - nameField?: string; - } - export interface ChartCommonConstantLineLabel { - /** Specifies font options for constant line labels. */ - font?: viz.core.Font; - /** Specifies the position of constant line labels on the chart plot. */ - position?: string; - /** Makes constant line labels visible. */ - visible?: boolean; - } - export interface PolarCommonConstantLineLabel { - /** Indicates whether or not to display labels for the axis constant lines. */ - visible?: boolean; - /** Specifies font options for a constant line label. */ - font?: viz.core.Font; - } - export interface ConstantLineStyle { - /** Specifies a color for a constant line. */ - color?: string; - /** Specifies a dash style for a constant line. */ - dashStyle?: string; - /** Specifies a constant line width in pixels. */ - width?: number; - } - export interface ChartCommonConstantLineStyle extends ConstantLineStyle { - /** Configures constant line labels. */ - label?: ChartCommonConstantLineLabel; - /** Generates a pixel-measured empty space between the left/right side of a constant line and the constant line label. */ - paddingLeftRight?: number; - /** Generates a pixel-measured empty space between the top/bottom side of a constant line and the constant line label. */ - paddingTopBottom?: number; - } - export interface PolarCommonConstantLineStyle extends ConstantLineStyle { - /** An object defining constant line label options. */ - label?: PolarCommonConstantLineLabel; - } - export interface CommonAxisLabel { - /** Specifies font options for axis labels. */ - font?: viz.core.Font; - /** Specifies the spacing between an axis and its labels in pixels. */ - indentFromAxis?: number; - /** Indicates whether or not axis labels are visible. */ - visible?: boolean; - } - export interface ChartCommonAxisLabel extends CommonAxisLabel { - /** Aligns axis labels in relation to ticks. */ - alignment?: string; - /** Decides how to arrange axis labels when there is not enough space to keep all of them. */ - overlappingBehavior?: { - /** Decides how to arrange axis labels when there is not enough space to keep all of them. */ - mode?: string; - /** Specifies the rotation angle of axis labels. Applies only if the mode option is "rotate". */ - rotationAngle?: number; - /** Adds a pixel-measured empty space between two staggered rows of axis labels. Applies only if the mode option is "stagger". */ - staggeringSpacing?: number; - }; - } - export interface PolarCommonAxisLabel extends CommonAxisLabel { - /** Specifies the overlap resolving algorithm to be applied to axis labels. */ - overlappingBehavior?: string; - } - export interface CommonAxisTitle { - /** Specifies font options for the axis title. */ - font?: viz.core.Font; - /** Adds a pixel-measured empty space between the axis title and axis labels. */ - margin?: number; - } - export interface BaseCommonAxisSettings { - /** Specifies the color of the line that represents an axis. */ - color?: string; - /** Specifies whether ticks/grid lines of a discrete axis are located between labels or cross the labels. */ - discreteAxisDivisionMode?: string; - /** An object defining the configuration options for the grid lines of an axis in the dxPolarChart widget. */ - grid?: { - /** Specifies a color for grid lines. */ - color?: string; - /** Specifies an opacity for grid lines. */ - opacity?: number; - /** Indicates whether or not the grid lines of an axis are visible. */ - visible?: boolean; - /** Specifies the width of grid lines. */ - width?: number; - }; - /** Specifies the options of the minor grid. */ - minorGrid?: { - /** Specifies a color for the lines of the minor grid. */ - color?: string; - /** Specifies an opacity for the lines of the minor grid. */ - opacity?: number; - /** Indicates whether the minor grid is visible or not. */ - visible?: boolean; - /** Specifies a width for the lines of the minor grid. */ - width?: number; - }; - /** Indicates whether or not an axis is inverted. */ - inverted?: boolean; - /** Specifies the opacity of the line that represents an axis. */ - opacity?: number; - /** Indicates whether or not to set ticks/grid lines of a continuous axis of the 'date-time' type at the beginning of each date-time interval. */ - setTicksAtUnitBeginning?: boolean; - /** An object defining the configuration options for axis ticks. */ - tick?: { - /** Specifies ticks color. */ - color?: string; - /** Specifies tick opacity. */ - opacity?: number; - /** Indicates whether or not ticks are visible on an axis. */ - visible?: boolean; - /** Specifies tick width. */ - width?: number; - /** Specifies tick length. */ - length?: number; - }; - /** Specifies the options of the minor ticks. */ - minorTick?: { - /** Specifies a color for the minor ticks. */ - color?: string; - /** Specifies an opacity for the minor ticks. */ - opacity?: number; - /** Indicates whether or not the minor ticks are displayed on an axis. */ - visible?: boolean; - /** Specifies minor tick width. */ - width?: number; - /** Specifies minor tick length. */ - length?: number; - }; - /** Indicates whether or not the line that represents an axis in a chart is visible. */ - visible?: boolean; - /** Specifies the width of the line that represents an axis in the chart. */ - width?: number; - } - export interface ChartCommonAxisSettings extends BaseCommonAxisSettings { - /** Configures the appearance of all constant lines in the widget. */ - constantLineStyle?: ChartCommonConstantLineStyle; - /** Configures axis labels. */ - label?: ChartCommonAxisLabel; - /** Controls the empty space between the maximum series points and the axis. Applies only to the axes of the "continuous" and "logarithmic" type. */ - maxValueMargin?: number; - /** Controls the empty space between the minimum series points and the axis. Applies only to the axes of the "continuous" and "logarithmic" type. */ - minValueMargin?: number; - /** Reserves a pixel-measured space for the axis. */ - placeholderSize?: number; - /** Configures the appearance of strips. */ - stripStyle?: { - /** Configures the appearance of strip labels. */ - label?: { - /** Specifies font options for strip labels. */ - font?: viz.core.Font; - /** Aligns strip labels in the horizontal direction. */ - horizontalAlignment?: string; - /** Aligns strip labels in the vertical direction. */ - verticalAlignment?: string; - }; - /** Generates a pixel-measured empty space between the left/right border of a strip and the strip label. */ - paddingLeftRight?: number; - /** Generates a pixel-measured empty space between the top/bottom border of a strip and the strip label. */ - paddingTopBottom?: number; - }; - /** Configures axis titles. */ - title?: CommonAxisTitle; - /** Adds an empty space between the axis and the minimum and maximum series points. */ - valueMarginsEnabled?: boolean; - } - export interface PolarCommonAxisSettings extends BaseCommonAxisSettings { - /** Specifies the appearance of all the widget's constant lines. */ - constantLineStyle?: PolarCommonConstantLineStyle; - /** An object defining the label configuration options that are common for all axes in the dxPolarChart widget. */ - label?: PolarCommonAxisLabel; - /** An object defining configuration options for strip style. */ - stripStyle?: { - /** An object defining the configuration options for a strip label style. */ - label?: { - /** Specifies font options for a strip label. */ - font?: viz.core.Font; - }; - }; - } - export interface ChartConstantLineLabel extends ChartCommonConstantLineLabel { - /** Aligns constant line labels in the horizontal direction. */ - horizontalAlignment?: string; - /** Aligns constant line labels in the vertical direction. */ - verticalAlignment?: string; - /** Specifies the text of a constant line label. By default, equals to the value of the constant line. */ - text?: string; - } - export interface PolarConstantLineLabel extends PolarCommonConstantLineLabel { - /** Specifies the text to be displayed in a constant line label. */ - text?: string; - } - export interface AxisLabel { - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a label on the value axis. */ - customizeHint?: (argument: { value: any; valueText: string }) => string; - /** Specifies a callback function that returns the text to be displayed in value axis labels. */ - customizeText?: (argument: { value: any; valueText: string }) => string; - /** Specifies a format for the text displayed by axis labels. */ - format?: any; - /** - * Specifies a precision for the formatted value displayed in the axis labels. - * @deprecated Use the valueAxis | label | format | precision option instead. - */ - precision?: number; - } - export interface ChartAxisLabel extends ChartCommonAxisLabel, AxisLabel { } - export interface PolarAxisLabel extends PolarCommonAxisLabel, AxisLabel { } - export interface AxisTitle extends CommonAxisTitle { - /** Specifies the text of the axis title. */ - text?: string; - } - export interface ChartConstantLineStyle extends ChartCommonConstantLineStyle { - /** Specifies the appearance of the labels of those constant lines that belong to the value axis. */ - label?: ChartConstantLineLabel; - } - export interface ChartConstantLine extends ChartConstantLineStyle { - /** Configures the constant line label. */ - label?: ChartConstantLineLabel; - /** Specifies the value indicated by a constant line. Setting this option is necessary. */ - value?: any; - } - export interface PolarConstantLine extends PolarCommonConstantLineStyle { - /** An object defining constant line label options. */ - label?: PolarConstantLineLabel; - /** Specifies a value to be displayed by a constant line. */ - value?: any; - } - export interface Axis { - /** Specifies a coefficient for dividing the value axis. */ - axisDivisionFactor?: number; - /** Specifies the order in which discrete values are arranged on the value axis. */ - categories?: Array; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic axis. */ - logarithmBase?: number; - /** Specifies an interval between axis ticks/grid lines. */ - tickInterval?: any; - /** Specifies the interval between minor ticks. */ - minorTickInterval?: any; - /** Specifies the number of minor ticks between two neighboring major ticks. */ - minorTickCount?: number; - /** Specifies the required type of the value axis. */ - type?: string; - /** Binds the value axis to a pane. */ - pane?: string; - /** Specifies options for value axis strips. */ - strips?: Array; - } - export interface ChartAxis extends ChartCommonAxisSettings, Axis { - /** Declares a collection of constant lines belonging to the value axis. */ - constantLines?: Array; - /** Specifies the appearance of those constant lines that belong to the value axis. */ - constantLineStyle?: ChartCommonConstantLineStyle; - /** Configures the labels of the value axis. */ - label?: ChartAxisLabel; - /** Coupled with the min option, focuses the widget on a specific chart segment. Applies only to the axes of the "continuous" and "logarithmic" type. */ - max?: any; - /** Coupled with the max option, focuses the widget on a specific chart segment. Applies only to the axes of the "continuous" and "logarithmic" type. */ - min?: any; - /** Relocates the value axis. */ - position?: string; - /** Configures the axis title. */ - title?: any; - } - export interface PolarAxis extends PolarCommonAxisSettings, Axis { - /** Defines an array of the value axis constant lines. */ - constantLines?: Array; - /** Specifies options for value axis labels. */ - label?: PolarAxisLabel; - } - export interface ArgumentAxis { - /** Specifies the desired type of axis values. */ - argumentType?: string; - /** Specifies the elements that will be highlighted when the argument axis is hovered over. */ - hoverMode?: string; - } - export interface ChartArgumentAxis extends ChartAxis, ArgumentAxis { } - export interface PolarArgumentAxis extends PolarAxis, ArgumentAxis { - /** Specifies the angle in arc degrees to which the argument axis should be rotated. The positive values rotate the axis clockwise. */ - startAngle?: number; - /** Specifies whether or not to display the first point at the angle specified by the startAngle option. */ - firstPointOnStartAngle?: boolean; - /** Specifies the value to be used as the origin for the argument axis. */ - originValue?: number; - /** Specifies the period of the argument values in the data source. */ - period?: number; - } - export interface ValueAxis { - /** Specifies the name of the value axis. */ - name?: string; - /** Specifies whether or not to indicate a zero value on the value axis. */ - showZero?: boolean; - /** Specifies the desired type of axis values. */ - valueType?: string; - } - export interface ChartValueAxis extends ChartAxis, ValueAxis { - /** Adds a pixel-measured empty space between two side-by-side value axes. Applies if several value axes are located on one side of the chart. */ - multipleAxesSpacing?: number; - /** Synchronizes two or more value axes with each other at a specific value. */ - synchronizedValue?: number; - } - export interface PolarValueAxis extends PolarAxis, ValueAxis { - /** Indicates whether to display series with indents from axis boundaries. */ - valueMarginsEnabled?: boolean; - /** Specifies a coefficient that determines the spacing between the maximum series point and the axis. */ - maxValueMargin?: number; - /** Specifies a coefficient that determines the spacing between the minimum series point and the axis. */ - minValueMargin?: number; - tick?: { - visible?: boolean; - } - } - export interface CommonPane { - /** Specifies the color of the pane's background. */ - backgroundColor?: string; - /** Configures the pane border. */ - border?: PaneBorder; - } - export interface Pane extends CommonPane { - /** Specifies the name of the pane. */ - name?: string; - } - export interface PaneBorder extends viz.core.DashedBorderWithOpacity { - /** Shows/hides the bottom border of the pane. Applies only when the border | visible option is true. */ - bottom?: boolean; - /** Shows/hides the left border of the pane. Applies only when the border | visible option is true. */ - left?: boolean; - /** Shows/hides the right border of the pane. Applies only when the border | visible option is true. */ - right?: boolean; - /** Shows/hides the top border of the pane. Applies only when the border | visible option is true. */ - top?: boolean; - } - export interface ChartAnimation extends viz.core.Animation { - /** Specifies how many series points the widget should have before the animation will be disabled. */ - maxPointCountSupported?: number; - } - export interface BaseChartTooltip extends viz.core.Tooltip { - /** Specifies a format for arguments of the chart's series points. */ - argumentFormat?: any; - /** - * Specifies a precision for formatted arguments displayed in tooltips. - * @deprecated Use the tooltip | argumentFormat | precision option instead. - */ - argumentPrecision?: number; - /** - * Specifies a precision for a percent value displayed in tooltips for stacked series and dxPieChart series. - * @deprecated Use the tooltip | format | percentPrecision option instead. - */ - percentPrecision?: number; - } - export interface BaseChartOptions extends viz.core.BaseWidgetOptions, viz.core.MarginOptions, viz.core.RedrawOnResizeOptions, viz.core.TitleOptions, viz.core.LoadingIndicatorOptions, viz.core.ExportOptions { - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - /** Specifies the widget's width small enough for the layout to begin adapting. */ - width?: number; - /** Specifies the widget's height small enough for the layout to begin adapting. */ - height?: number; - /** Specifies whether or not point labels should be kept when the layout is adapting. */ - keepLabels?: boolean; - }; - /** Specifies animation options. */ - animation?: ChartAnimation; - /** Customizes the appearance of an individual point label. */ - customizeLabel?: (pointInfo: Object) => Object; - /** Customizes the appearance of an individual series point. */ - customizePoint?: (pointInfo: Object) => Object; - /** Specifies the origin of data for the widget. */ - dataSource?: any; - /** Specifies options of a dxChart's (dxPieChart's) legend. */ - legend?: core.BaseLegend; - /** Sets the name of the palette to be used in the chart. Alternatively, an array of colors can be set as a custom palette to be used within this chart. */ - palette?: any; - /** A handler for the done event. */ - onDone?: (e: { - component: BaseChart; - element: Element; - }) => void; - /** A handler for the pointClick event. */ - onPointClick?: any; - /** A handler for the pointHoverChanged event. */ - onPointHoverChanged?: (e: { - component: BaseChart; - element: Element; - target: TPoint; - }) => void; - /** A handler for the pointSelectionChanged event. */ - onPointSelectionChanged?: (e: { - component: BaseChart; - element: Element; - target: TPoint; - }) => void; - /** Specifies whether a single point or multiple points can be selected in the chart. */ - pointSelectionMode?: string; - /** Specifies options for the dxChart and dxPieChart widget series. */ - series?: any; - /** Configures tooltips. */ - tooltip?: BaseChartTooltip; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: BaseChart; - element: Element; - target: BasePoint; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: BaseChart; - element: Element; - target: BasePoint; - }) => void; - } - /** A base class for all chart widgets included in the ChartJS library. */ - export class BaseChart extends viz.core.BaseWidget implements viz.core.LoadingIndicatorMethods { - /** Deselects the chart's selected series. The series is displayed in an initial style. */ - clearSelection(): void; - /** Gets the current size of the widget. */ - getSize(): { width: number; height: number }; - /** Returns an array of all series in the chart. */ - getAllSeries(): Array; - /** Gets a series within the chart's series collection by the specified name (see the name option). */ - getSeriesByName(seriesName: string): BaseSeries; - /** Gets a series within the chart's series collection by its position number. */ - getSeriesByPos(seriesIndex: number): BaseSeries; - /** Hides all widget tooltips. */ - hideTooltip(): void; - showLoadingIndicator(): void; - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(renderOptions?: { - force?: boolean; - animate?: boolean; - asyncSeriesRendering?: boolean; - }): void; - } - export interface AdvancedLegend extends core.BaseLegend { - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item. */ - customizeHint?: (seriesInfo: { seriesName: string; seriesIndex: number; seriesColor: string; }) => string; - /**

Specifies a callback function that returns the text to be displayed by legend items.

*/ - customizeText?: (seriesInfo: { seriesName: string; seriesIndex: number; seriesColor: string; }) => string; - /** Specifies what series elements to highlight when a corresponding item in the legend is hovered over. */ - hoverMode?: string; - } - export interface AdvancedOptions extends BaseChartOptions { - /** A handler for the argumentAxisClick event. */ - onArgumentAxisClick?: any; - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** An object providing options for managing data from a data source. */ - dataPrepareSettings?: { - /** Specifies whether or not to validate the values from a data source. */ - checkTypeForAllData?: boolean; - /** Specifies whether or not to convert the values from a data source into the data type of an axis. */ - convertToAxisDataType?: boolean; - /** Specifies how to sort the series points. */ - sortingMethod?: any; - }; - /** A handler for the legendClick event. */ - onLegendClick?: any; - /** A handler for the seriesClick event. */ - onSeriesClick?: any; - /** A handler for the seriesHoverChanged event. */ - onSeriesHoverChanged?: (e: { - component: BaseChart; - element: Element; - target: TSeries; - }) => void; - /** A handler for the seriesSelectionChanged event. */ - onSeriesSelectionChanged?: (e: { - component: BaseChart; - element: Element; - target: TSeries; - }) => void; - /** Specifies whether a single series or multiple series can be selected in the chart. */ - seriesSelectionMode?: string; - /** Specifies how the chart must behave when series point labels overlap. */ - resolveLabelOverlapping?: string; - /** Specifies whether or not all bars in a series must have the same angle, or may have different angles if any points in other series are missing. */ - equalBarWidth?: boolean; - /** Specifies a common bar width as a percentage from 0 to 1. */ - barWidth?: number; - /** Forces the widget to treat negative values as zeroes. Applies to stacked-like series only. */ - negativesAsZeroes?: boolean; - } - export interface Legend extends AdvancedLegend { - /** Specifies whether the legend is located outside or inside the chart's plot. */ - position?: string; - } - export interface ChartTooltip extends BaseChartTooltip { - /** Specifies whether the tooltip must be located in the center of a series point or on its edge. Applies to bar-like and bubble series only. */ - location?: string; - /** Specifies the kind of information to display in a tooltip. */ - shared?: boolean; - } - export interface dxChartOptions extends AdvancedOptions { - /** Indicates whether or not to synchronize value axes when they are displayed on a single pane. */ - synchronizeMultiAxes?: boolean; - /** Specifies whether or not to filter the series points depending on their quantity. */ - useAggregation?: boolean; - /** Specifies whether or not to adjust the value axis when zooming the widget. */ - adjustOnZoom?: boolean; - /** Configures the argument axis. */ - argumentAxis?: ChartArgumentAxis; - /** Defines common settings for both the argument and value axis in a chart. */ - commonAxisSettings?: ChartCommonAxisSettings; - /** Defines common settings for all panes in a chart. */ - commonPaneSettings?: CommonPane; - /** Specifies settings common for all series in the chart. */ - commonSeriesSettings?: CommonSeriesSettings; - /** Configures the crosshair feature. */ - crosshair?: { - /** Specifies the color of the crosshair lines. */ - color?: string; - /** Specifies the dash style of the crosshair lines. */ - dashStyle?: string; - /** Enables the crosshair. */ - enabled?: boolean; - /** Specifies how transparent the crosshair lines should be. */ - opacity?: number; - /** Specifies the width of the crosshair lines. */ - width?: number; - /** Configures the horizontal crosshair line individually. */ - horizontalLine?: CrosshaierWithLabel; - /** Configures the vertical crosshair line individually. */ - verticalLine?: CrosshaierWithLabel; - /** Configures the crosshair labels. */ - label?: { - /** Paints the background of the crosshair labels. */ - backgroundColor?: string; - /** Makes the crosshair labels visible. Applies only if the crosshair feature is enabled. */ - visible?: boolean; - /** Specifies font options for the crosshair labels. */ - font?: viz.core.Font; - /** Formats the point value/argument before it will be displayed in the crosshair label. */ - format?: any; - /** - * Specifies a precision for formatted values. - * @deprecated Use the crosshair | label | format | precision option instead. - */ - precision?: number; - /** Customizes the text displayed by the crosshair labels. */ - customizeText?: (info: { value: any; valueText: string; point: ChartPoint; }) => string; - } - }; - /** Specifies which pane should be used by default. */ - defaultPane?: string; - /** Specifies a coefficient determining the diameter of the largest bubble. */ - maxBubbleSize?: number; - /** Specifies the diameter of the smallest bubble measured in pixels. */ - minBubbleSize?: number; - /** Declares a collection of panes. */ - panes?: Array; - /** Swaps the axes around making the value axis horizontal and the argument axis vertical. */ - rotated?: boolean; - /** Specifies the options of a chart's legend. */ - legend?: Legend; - /** A handler for the zoomStart event. */ - onZoomStart?: (e: { - component: BaseChart; - element: Element; - }) => void; - /** A handler for the zoomEnd event. */ - onZoomEnd?: (e: { - component: BaseChart; - element: Element; - rangeStart: any; - rangeEnd: any; - }) => void; - /** Specifies options for dxChart widget series. */ - series?: Array; - /** Defines options for the series template. */ - seriesTemplate?: SeriesTemplate; - tooltip?: ChartTooltip; - /** Configures the value axis. */ - valueAxis?: Array; - /** Enables scrolling in your chart. */ - scrollingMode?: string; - /** Enables zooming in your chart. */ - zoomingMode?: string; - /** Specifies the settings of the scroll bar. */ - scrollBar?: { - /** Specifies whether the scroll bar is visible or not. */ - visible?: boolean; - /** Specifies the spacing between the scroll bar and the chart's plot in pixels. */ - offset?: number; - /** Specifies the color of the scroll bar. */ - color?: string; - /** Specifies the width of the scroll bar in pixels. */ - width?: number; - /** Specifies the opacity of the scroll bar. */ - opacity?: number; - /** Specifies the position of the scroll bar in the chart. */ - position?: string; - }; - } - interface CrosshaierWithLabel extends viz.core.DashedBorderWithOpacity { - /** Configures the label that belongs to the horizontal crosshair line. */ - label?: { - /** Paints the background of the label that belongs to the horizontal crosshair line. */ - backgroundColor?: string; - /** Makes the label of the horizontal crosshair line visible. Applies only if the crosshair feature is enabled and the horizontal line is visible. */ - visible?: boolean; - /** Specifies font options for the label of the horizontal crosshair line. */ - font?: viz.core.Font; - /** Formats the point value before it will be displayed in the crosshair label. */ - format?: any; - /** - * Specifies a precision for formatted values. - * @deprecated Use the crosshair | horizontalLine | label | format | precision option instead. - */ - precision?: number; - /** Customizes the text displayed by the label that belongs to the horizontal crosshair line. */ - customizeText?: (info: { value: any; valueText: string; point: ChartPoint; }) => string; - } - } - export interface PolarChartTooltip extends BaseChartTooltip { - /** Specifies the kind of information to display in a tooltip. */ - shared?: boolean; - } - export interface dxPolarChartOptions extends AdvancedOptions { - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - width?: number; - height?: number; - }; - /** Indicates whether or not to display a "spider web". */ - useSpiderWeb?: boolean; - /** Specifies argument axis options for the dxPolarChart widget. */ - argumentAxis?: PolarArgumentAxis; - /** An object defining the configuration options that are common for all axes of the dxPolarChart widget. */ - commonAxisSettings?: PolarCommonAxisSettings; - /** An object defining the configuration options that are common for all series of the dxPolarChart widget. */ - commonSeriesSettings?: CommonPolarSeriesSettings; - /** Specifies the options of a chart's legend. */ - legend?: AdvancedLegend; - /** Specifies options for dxPolarChart widget series. */ - series?: Array; - /** Defines options for the series template. */ - seriesTemplate?: PolarSeriesTemplate; - tooltip?: PolarChartTooltip; - /** Specifies value axis options for the dxPolarChart widget. */ - valueAxis?: PolarValueAxis; - } - export interface PieLegend extends core.BaseLegend { - /** Specifies what chart elements to highlight when a corresponding item in the legend is hovered over. */ - hoverMode?: string; - /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item. */ - customizeHint?: (pointInfo: { pointName: string; pointIndex: number; pointColor: string; }) => string; - /** Specifies a callback function that returns the text to be displayed by a legend item. */ - customizeText?: (pointInfo: { pointName: string; pointIndex: number; pointColor: string; }) => string; - } - export interface dxPieChartOptions extends BaseChartOptions { - /** Specifies adaptive layout options. */ - adaptiveLayout?: { - keepLabels?: boolean; - }; - /** Specifies dxPieChart legend options. */ - legend?: PieLegend; - /** Specifies options for the series of the dxPieChart widget. */ - series?: Array; - /** Specifies the diameter of the pie. */ - diameter?: number; - /** Specifies the direction that the pie chart segments will occupy. */ - segmentsDirection?: string; - /** Specifies the angle in arc degrees from which the first segment of a pie chart should start. */ - startAngle?: number; - /** Specifies the fraction of the inner radius relative to the total radius in the series of the 'doughnut' type. The value should be between 0 and 1. */ - innerRadius?: number; - /** A handler for the legendClick event. */ - onLegendClick?: any; - /** Specifies how a chart must behave when series point labels overlap. */ - resolveLabelOverlapping?: string; - /** An object defining the configuration options that are common for all series of the dxPieChart widget. */ - commonSeriesSettings?: CommonPieSeriesSettings; - /** Specifies the type of the pie chart series. */ - type?: string; - } -} -declare module DevExpress.viz { - /** A widget providing charts of various types for web applications. */ - export class dxChart extends DevExpress.viz.charts.BaseChart { - constructor(element: JQuery, options?: DevExpress.viz.charts.dxChartOptions); - constructor(element: Element, options?: DevExpress.viz.charts.dxChartOptions); - /** Sets the specified start and end values for the chart's argument axis. */ - zoomArgument(startValue: any, endValue: any): void; - } - /** A circular chart widget for web applications. */ - export class dxPieChart extends DevExpress.viz.charts.BaseChart { - constructor(element: JQuery, options?: DevExpress.viz.charts.dxPieChartOptions); - constructor(element: Element, options?: DevExpress.viz.charts.dxPieChartOptions); - /** - * Provides access to the dxPieChart series. - * @deprecated Use the getAllSeries() method instead. - */ - getSeries(): DevExpress.viz.charts.PieSeries; - } - /** A chart widget displaying data in a polar coordinate system. */ - export class dxPolarChart extends DevExpress.viz.charts.BaseChart { - constructor(element: JQuery, options?: DevExpress.viz.charts.dxPolarChartOptions); - constructor(element: Element, options?: DevExpress.viz.charts.dxPolarChartOptions); - } -} -interface JQuery { - dxChart(options?: DevExpress.viz.charts.dxChartOptions): JQuery; - dxChart(methodName: string, ...params: any[]): any; - dxChart(methodName: "instance"): DevExpress.viz.dxChart; - dxPieChart(options?: DevExpress.viz.charts.dxPieChartOptions): JQuery; - dxPieChart(methodName: string, ...params: any[]): any; - dxPieChart(methodName: "instance"): DevExpress.viz.dxPieChart; - dxPolarChart(options?: DevExpress.viz.charts.dxPolarChartOptions): JQuery; - dxPolarChart(methodName: string, ...params: any[]): any; - dxPolarChart(methodName: "instance"): DevExpress.viz.dxPolarChart; -} -declare module DevExpress.viz.gauges { - export interface BaseRangeContainer { - /** Specifies a range container's background color. */ - backgroundColor?: string; - /** Specifies the offset of the range container from an invisible scale line in pixels. */ - offset?: number; - /** Sets the name of the palette or an array of colors to be used for coloring the gauge range container. */ - palette?: any; - /** An array of objects representing ranges contained in the range container. */ - ranges?: Array<{ startValue: number; endValue: number; color: string }>; - /** Specifies a color of a range. */ - color?: string; - /** Specifies an end value of a range. */ - endValue?: number; - /** Specifies a start value of a range. */ - startValue?: number; - } - export interface ScaleTick { - /** Specifies the color of the scale's minor ticks. */ - color?: string; - /** - * Specifies an array of custom minor ticks. - * @deprecated Use the scale | customMinorTicks option instead. - */ - customTickValues?: Array; - /** Specifies the length of the scale's minor ticks. */ - length?: number; - /** - * Indicates whether automatically calculated minor ticks are visible or not. - * @deprecated This feature is no longer available. - */ - showCalculatedTicks?: boolean; - /** - * Specifies an interval between minor ticks. - * @deprecated Use the scale | minorTickInterval option instead. - */ - tickInterval?: number; - /** Indicates whether scale minor ticks are visible or not. */ - visible?: boolean; - /** Specifies the width of the scale's minor ticks. */ - width?: number; - } - export interface ScaleMajorTick extends ScaleTick { - /** - * Specifies whether or not to expand the current major tick interval if labels overlap each other. - * @deprecated Use the overlappingBehavior | useAutoArrangement option instead. - */ - useTicksAutoArrangement?: boolean; - } - export interface ScaleMinorTick extends ScaleTick { - /** Specifies the opacity of the scale's minor ticks. */ - opacity?: number; - } - export interface BaseScaleLabel { - /** Specifies whether or not scale labels should be colored similarly to their corresponding ranges in the range container. */ - useRangeColors?: boolean; - /** Specifies a callback function that returns the text to be displayed in scale labels. */ - customizeText?: (scaleValue: { value: number; valueText: string }) => string; - /** Specifies the overlap resolving options to be applied to scale labels. */ - overlappingBehavior?: { - /** Specifies whether or not to expand the current major tick interval if labels overlap each other. */ - useAutoArrangement?: boolean; - /** Specifies what label to hide in case of overlapping. */ - hideFirstOrLast?: string; - }; - /** Specifies font options for the text displayed in the scale labels of the gauge. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in scale labels. */ - format?: any; - /** - * Specifies a precision for the formatted value displayed in the scale labels. - * @deprecated Use the scale | label | format | precision option instead. - */ - precision?: number; - /** Specifies whether or not scale labels are visible on the gauge. */ - visible?: boolean; - } - export interface BaseScale { - /** Specifies the end value for the scale of the gauge. */ - endValue?: number; - /** - * Specifies whether or not to hide the first scale label. - * @deprecated This feature is no longer available. - */ - hideFirstLabel?: boolean; - /** - * Specifies whether or not to hide the first major tick on the scale. - * @deprecated This feature is no longer available. - */ - hideFirstTick?: boolean; - /** - * Specifies whether or not to hide the last scale label. - * @deprecated This feature is no longer available. - */ - hideLastLabel?: boolean; - /** - * Specifies whether or not to hide the last major tick on the scale. - * @deprecated This feature is no longer available. - */ - hideLastTick?: boolean; - /** Specifies an interval between major ticks. */ - tickInterval?: number; - /** Specifies an interval between minor ticks. */ - minorTickInterval?: number; - /** Specifies an array of custom major ticks. */ - customTicks?: Array; - /** Specifies an array of custom minor ticks. */ - customMinorTicks?: Array; - /** Specifies common options for scale labels. */ - label?: BaseScaleLabel; - /** - * Specifies options of the gauge's major ticks. - * @deprecated Use the tick option instead. - */ - majorTick?: ScaleMajorTick; - /** Specifies options of the gauge's major ticks. */ - tick?: { - /** Specifies the color of the scale's major ticks. */ - color?: string; - /** Specifies the length of the scale's major ticks. */ - length?: number; - /** Indicates whether scale major ticks are visible or not. */ - visible?: boolean; - /** Specifies the width of the scale's major ticks. */ - width?: number; - /** Specifies the opacity of the scale's major ticks. */ - opacity?: number; - }; - /** Specifies options of the gauge's minor ticks. */ - minorTick?: ScaleMinorTick; - /** Specifies the start value for the scale of the gauge. */ - startValue?: number; - } - export interface BaseValueIndicator { - /** Specifies the type of subvalue indicators. */ - type?: string; - /** Specifies the background color for the indicator of the rangeBar type. */ - backgroundColor?: string; - /** Specifies the base value for the indicator of the rangeBar type. */ - baseValue?: number; - /** Specifies a color of the indicator. */ - color?: string; - /** Specifies the range bar size for an indicator of the rangeBar type. */ - size?: number; - text?: { - /** Specifies a callback function that returns the text to be displayed in an indicator. */ - customizeText?: (indicatedValue: { value: number; valueText: string }) => string; - font?: viz.core.Font; - /** Specifies a format for the text displayed in an indicator. */ - format?: any; - /** Specifies the range bar's label indent in pixels. */ - indent?: number; - /** - * Specifies a precision for the formatted value displayed by an indicator. - * @deprecated Use the text | format | precision option instead. - */ - precision?: number; - }; - offset?: number; - length?: number; - width?: number; - /** Specifies the length of an arrow for the indicator of the textCloud type in pixels. */ - arrowLength?: number; - /** Sets the array of colors to be used for coloring subvalue indicators. */ - palette?: any; - /** Specifies the distance between the needle and the center of a gauge for the indicator of a needle-like type. */ - indentFromCenter?: number; - /** Specifies the second color for the indicator of the twoColorNeedle type. */ - secondColor?: string; - /** Specifies the length of a twoNeedleColor type indicator tip as a percentage. */ - secondFraction?: number; - /** Specifies the spindle's diameter in pixels for the indicator of a needle-like type. */ - spindleSize?: number; - /** Specifies the inner diameter in pixels, so that the spindle has the shape of a ring. */ - spindleGapSize?: number; - /** Specifies the orientation of the rangeBar indicator on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - /** Specifies the orientation of the rangeBar indicator on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - } - export interface SharedGaugeOptions extends viz.core.MarginOptions, viz.core.RedrawOnResizeOptions, viz.core.TitleOptions, viz.core.LoadingIndicatorOptions, viz.core.ExportOptions { - /** Specifies animation options. */ - animation?: viz.core.Animation; - /** - * Specifies a subtitle for the widget. - * @deprecated Use the title | subtitle option instead. - */ - subtitle?: { - /** - * Specifies font options for the subtitle. - * @deprecated Use the title | subtitle | font option instead. - */ - font?: viz.core.Font; - /** - * Specifies a text for the subtitle. - * @deprecated Use the title | subtitle | text option instead. - */ - text?: string; - }; - /** Configures tooltips. */ - tooltip?: viz.core.Tooltip; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: dxBaseGauge; - element: Element; - target: {}; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: dxBaseGauge; - element: Element; - target: {}; - }) => void; - } - export interface BaseGaugeOptions extends viz.core.BaseWidgetOptions, SharedGaugeOptions { - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** Specifies options of the gauge's range container. */ - rangeContainer?: BaseRangeContainer; - /** Specifies a gauge's scale options. */ - scale?: BaseScale; - /** Specifies the appearance options of subvalue indicators. */ - subvalueIndicator?: BaseValueIndicator; - /** Specifies a set of subvalues to be designated by the subvalue indicators. */ - subvalues?: Array; - /** Specifies the main value on a gauge. */ - value?: number; - /** Specifies the appearance options of the value indicator. */ - valueIndicator?: BaseValueIndicator; - } - /** A gauge widget. */ - export class dxBaseGauge extends viz.core.BaseWidget implements viz.core.LoadingIndicatorMethods { - showLoadingIndicator(): void; - hideLoadingIndicator(): void; - /** Returns the main gauge value. */ - value(): number; - /** Updates a gauge value. */ - value(value: number): void; - /** Returns an array of gauge subvalues. */ - subvalues(): Array; - /** Updates gauge subvalues. */ - subvalues(subvalues: Array): void; - } - export interface LinearRangeContainer extends BaseRangeContainer { - /** Specifies the orientation of the range container on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - /** Specifies the orientation of a range container on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - /** Specifies the width of the range container's start and end boundaries in the dxLinearGauge widget. */ - width?: any; - /** Specifies an end width of a range container. */ - end?: number; - /** Specifies a start width of a range container. */ - start?: number; - } - export interface LinearScaleLabel extends BaseScaleLabel { - /** Specifies the spacing between scale labels and ticks. */ - indentFromTick?: number; - } - export interface LinearScale extends BaseScale { - /** Specifies the orientation of scale ticks on a vertically oriented dxLinearGauge widget. */ - horizontalOrientation?: string; - label?: LinearScaleLabel; - /** Specifies the orientation of scale ticks on a horizontally oriented dxLinearGauge widget. */ - verticalOrientation?: string; - } - export interface dxLinearGaugeOptions extends BaseGaugeOptions { - /** Specifies the options required to set the geometry of the dxLinearGauge widget. */ - geometry?: { - /** Indicates whether to display the dxLinearGauge widget vertically or horizontally. */ - orientation?: string; - }; - /** Specifies gauge range container options. */ - rangeContainer?: LinearRangeContainer; - scale?: LinearScale; - } - export interface CircularRangeContainer extends BaseRangeContainer { - /** Specifies the orientation of the range container in the dxCircularGauge widget. */ - orientation?: string; - /** Specifies the range container's width in pixels. */ - width?: number; - } - export interface CircularScaleLabel extends BaseScaleLabel { - /** Specifies the spacing between scale labels and ticks. */ - indentFromTick?: number; - } - export interface CircularScale extends BaseScale { - label?: CircularScaleLabel; - /** Specifies the orientation of scale ticks. */ - orientation?: string; - } - export interface dxCircularGaugeOptions extends BaseGaugeOptions { - /** Specifies the options required to set the geometry of the dxCircularGauge widget. */ - geometry?: { - /** Specifies the end angle of the circular gauge's arc. */ - endAngle?: number; - /** Specifies the start angle of the circular gauge's arc. */ - startAngle?: number; - }; - /** Specifies gauge range container options. */ - rangeContainer?: CircularRangeContainer; - scale?: CircularScale; - } - export interface dxBarGaugeOptions extends viz.core.BaseWidgetOptions, SharedGaugeOptions { - /** Specifies a color for the remaining segment of the bar's track. */ - backgroundColor?: string; - /** Specifies a distance between bars in pixels. */ - barSpacing?: number; - /** Specifies a base value for bars. */ - baseValue?: number; - /** Specifies an end value for the gauge's invisible scale. */ - endValue?: number; - /** Defines the shape of the gauge's arc. */ - geometry?: { - /** Specifies the end angle of the bar gauge's arc. */ - endAngle?: number; - /** Specifies the start angle of the bar gauge's arc. */ - startAngle?: number; - }; - /** Specifies the options of the labels that accompany gauge bars. */ - label?: { - /** Specifies a color for the label connector text. */ - connectorColor?: string; - /** Specifies the width of the label connector in pixels. */ - connectorWidth?: number; - /** Specifies a callback function that returns a text for labels. */ - customizeText?: (barValue: { value: number; valueText: string }) => string; - /** Specifies font options for bar labels. */ - font?: viz.core.Font; - /** Specifies a format for bar labels. */ - format?: any; - /** Specifies the distance between the upper bar and bar labels in pixels. */ - indent?: number; - /** - * Specifies a precision for the formatted value displayed by labels. - * @deprecated Use the label | format | precision option instead. - */ - precision?: number; - /** Specifies whether bar labels appear on a gauge or not. */ - visible?: boolean; - }; - /** Sets the name of the palette or an array of colors to be used for coloring the gauge range container. */ - palette?: any; - /** Defines the radius of the bar that is closest to the center relatively to the radius of the topmost bar. */ - relativeInnerRadius?: number; - /** Specifies a start value for the gauge's invisible scale. */ - startValue?: number; - /** Specifies the array of values to be indicated on a bar gauge. */ - values?: Array; - } -} -declare module DevExpress.viz { - /** A widget that represents a gauge with a linear scale. */ - export class dxLinearGauge extends DevExpress.viz.gauges.dxBaseGauge { - constructor(element: JQuery, options?: DevExpress.viz.gauges.dxLinearGaugeOptions); - constructor(element: Element, options?: DevExpress.viz.gauges.dxLinearGaugeOptions); - } - /** A widget that represents a gauge with a circular scale. */ - export class dxCircularGauge extends DevExpress.viz.gauges.dxBaseGauge { - constructor(element: JQuery, options?: DevExpress.viz.gauges.dxCircularGaugeOptions); - constructor(element: Element, options?: DevExpress.viz.gauges.dxCircularGaugeOptions); - } - /** A circular bar widget. */ - export class dxBarGauge extends viz.core.BaseWidget implements viz.core.LoadingIndicatorMethods { - constructor(element: JQuery, options?: DevExpress.viz.gauges.dxBarGaugeOptions); - constructor(element: Element, options?: DevExpress.viz.gauges.dxBarGaugeOptions); - showLoadingIndicator(): void; - hideLoadingIndicator(): void; - /** Returns an array of gauge values. */ - values(): Array; - /** Updates the values displayed by a gauge. */ - values(values: Array): void; - } -} -interface JQuery { - dxLinearGauge(options?: DevExpress.viz.gauges.dxLinearGaugeOptions): JQuery; - dxLinearGauge(methodName: string, ...params: any[]): any; - dxLinearGauge(methodName: "instance"): DevExpress.viz.dxLinearGauge; - dxCircularGauge(options?: DevExpress.viz.gauges.dxCircularGaugeOptions): JQuery; - dxCircularGauge(methodName: string, ...params: any[]): any; - dxCircularGauge(methodName: "instance"): DevExpress.viz.dxCircularGauge; - dxBarGauge(options?: DevExpress.viz.gauges.dxBarGaugeOptions): JQuery; - dxBarGauge(methodName: string, ...params: any[]): any; - dxBarGauge(methodName: "instance"): DevExpress.viz.dxBarGauge; -} -declare module DevExpress.viz.rangeSelector { - export interface dxRangeSelectorOptions extends viz.core.BaseWidgetOptions, viz.core.MarginOptions, viz.core.RedrawOnResizeOptions, viz.core.TitleOptions, viz.core.LoadingIndicatorOptions, viz.core.ExportOptions { - /** Specifies the options for the range selector's background. */ - background?: { - /** Specifies the background color for the dxRangeSelector. */ - color?: string; - /** Specifies image options. */ - image?: { - /** Specifies a location for the image in the background of a range selector. */ - location?: string; - /** Specifies the image's URL. */ - url?: string; - }; - /** Indicates whether or not the background (background color and/or image) is visible. */ - visible?: boolean; - }; - /** Specifies the dxRangeSelector's behavior options. */ - behavior?: { - /** Indicates whether or not you can swap sliders. */ - allowSlidersSwap?: boolean; - /** Indicates whether or not animation is enabled. */ - animationEnabled?: boolean; - /** Specifies when to call the onSelectedRangeChanged function. */ - callSelectedRangeChanged?: string; - /** Indicates whether or not an end user can specify the range using a mouse, without the use of sliders. */ - manualRangeSelectionEnabled?: boolean; - /** Indicates whether or not an end user can shift the selected range to the required location on a scale by clicking. */ - moveSelectedRangeByClick?: boolean; - /** Indicates whether to snap a slider to ticks. */ - snapToTicks?: boolean; - }; - /** Specifies the options required to display a chart as the range selector's background. */ - chart?: { - /** Specifies a coefficient for determining an indent from the bottom background boundary to the lowest chart point. */ - bottomIndent?: number; - /** An object defining the common configuration options for the chart’s series. */ - commonSeriesSettings?: viz.charts.CommonSeriesSettings; - /** An object providing options for managing data from a data source. */ - dataPrepareSettings?: { - /** Specifies whether or not to validate values from a data source. */ - checkTypeForAllData?: boolean; - /** Specifies whether or not to convert the values from a data source into the data type of an axis. */ - convertToAxisDataType?: boolean; - /** Specifies how to sort series points. */ - sortingMethod?: any; - }; - /** Specifies whether all bars in a series must have the same width, or may have different widths if any points in other series are missing. */ - equalBarWidth?: boolean; - /** Specifies a common bar width as a percentage from 0 to 1. */ - barWidth?: number; - /** Forces the widget to treat negative values as zeroes. Applies to stacked-like series only. */ - negativesAsZeroes?: boolean; - /** Sets the name of the palette to be used in the range selector's chart. Alternatively, an array of colors can be set as a custom palette to be used within this chart. */ - palette?: any; - /** An object defining the chart’s series. */ - series?: Array; - /** Defines options for the series template. */ - seriesTemplate?: viz.charts.SeriesTemplate; - /** Specifies a coefficient for determining an indent from the background's top boundary to the topmost chart point. */ - topIndent?: number; - /** Specifies whether or not to filter the series points depending on their quantity. */ - useAggregation?: boolean; - /** Specifies options for the chart's value axis. */ - valueAxis?: { - /** Indicates whether or not the chart's value axis must be inverted. */ - inverted?: boolean; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic value axis. */ - logarithmBase?: number; - /** Specifies the maximum value of the chart's value axis. */ - max?: number; - /** Specifies the minimum value of the chart's value axis. */ - min?: number; - /** Specifies the type of the value axis. */ - type?: string; - /** Specifies the desired type of axis values. */ - valueType?: string; - }; - }; - /** Specifies the color of the parent page element. */ - containerBackgroundColor?: string; - /** Specifies a data source for the scale values and for the chart at the background. */ - dataSource?: any; - /** Specifies the data source field that provides data for the scale. */ - dataSourceField?: string; - /** Specifies options of the range selector's scale. */ - scale?: { - /** Specifies the scale's end value. */ - endValue?: any; - /** Specifies common options for scale labels. */ - label?: { - /** Specifies a callback function that returns the text to be displayed in scale labels. */ - customizeText?: (scaleValue: { value: any; valueText: string; }) => string; - /** Specifies font options for the text displayed in the range selector's scale labels. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in scale labels. */ - format?: any; - /** - * Specifies a precision for the formatted value displayed in the scale labels. - * @deprecated Use the scale | label | format | precision option instead. - */ - precision?: number; - /** Specifies a spacing between scale labels and the background bottom edge. */ - topIndent?: number; - /** Specifies whether or not the scale's labels are visible. */ - visible?: boolean; - }; - /** Specifies the value to be raised to a power when generating ticks for a logarithmic scale. */ - logarithmBase?: number; - /** - * Specifies an interval between major ticks. - * @deprecated Use the tickInterval option instead. - */ - majorTickInterval?: any; - /** Specifies an interval between axis ticks. */ - tickInterval?: any; - /** Specifies options for the date-time scale's markers. */ - marker?: { - /** Defines the options that can be set for the text that is displayed by the scale markers. */ - label?: { - /** Specifies a callback function that returns the text to be displayed in scale markers. */ - customizeText?: (markerValue: { value: any; valueText: string }) => string; - /** Specifies a format for the text displayed in scale markers. */ - format?: any; - }; - /** Specifies the height of the marker's separator. */ - separatorHeight?: number; - /** Specifies the space between the marker label and the marker separator. */ - textLeftIndent?: number; - /** Specifies the space between the marker's label and the top edge of the marker's separator. */ - textTopIndent?: number; - /** Specified the indent between the marker and the scale lables. */ - topIndent?: number; - /** Indicates whether scale markers are visible. */ - visible?: boolean; - }; - /** Specifies the maximum range that can be selected. */ - maxRange?: any; - /** Specifies the number of minor ticks between neighboring major ticks. */ - minorTickCount?: number; - /** Specifies an interval between minor ticks. */ - minorTickInterval?: any; - /** Specifies the minimum range that can be selected. */ - minRange?: any; - /** Specifies the height of the space reserved for the scale in pixels. */ - placeholderHeight?: number; - /** Indicates whether or not to set ticks of a date-time scale at the beginning of each date-time interval. */ - setTicksAtUnitBeginning?: boolean; - /** Specifies whether or not to show ticks for the boundary scale values, when neither major ticks nor minor ticks are created for these values. */ - showCustomBoundaryTicks?: boolean; - /** - * Indicates whether or not to show minor ticks on the scale. - * @deprecated Use the minorTick | visible option instead. - */ - showMinorTicks?: boolean; - /** Specifies the scale's start value. */ - startValue?: any; - /** Specifies options defining the appearance of scale ticks. */ - tick?: { - /** Specifies the color of scale ticks (both major and minor ticks). */ - color?: string; - /** Specifies the opacity of scale ticks (both major and minor ticks). */ - opacity?: number; - /** Specifies the width of the scale's ticks (both major and minor ticks). */ - width?: number; - }; - /** Specifies options of the range selector's minor ticks. */ - minorTick?: { - /** Specifies the color of the scale's minor ticks. */ - color?: string; - /** Specifies the opacity of the scale's minor ticks. */ - opacity?: number; - /** Specifies the width of the scale's minor ticks. */ - width?: number; - /** Indicates whether scale minor ticks are visible or not. */ - visible?: boolean; - }; - /** Specifies the type of the scale. */ - type?: string; - /** Specifies whether or not to expand the current tick interval if labels overlap each other. */ - useTicksAutoArrangement?: boolean; - /** Specifies the type of values on the scale. */ - valueType?: string; - /** Specifies the order of arguments on a discrete scale. */ - categories?: Array; - }; - /** Specifies the range to be selected when displaying the dxRangeSelector. */ - selectedRange?: { - /** Specifies the start value of the range to be selected when displaying the dxRangeSelector widget on a page. */ - startValue?: any; - /** Specifies the end value of the range to be selected when displaying the dxRangeSelector widget on a page. */ - endValue?: any; - }; - /** Specifies the color of the selected range. */ - selectedRangeColor?: string; - /** Range selector's indent options. */ - indent?: { - /** Specifies range selector's left indent. */ - left?: number; - /** Specifies range selector's right indent. */ - right?: number; - }; - /** A handler for the selectedRangeChanged event. */ - onSelectedRangeChanged?: (e: { - startValue: any; - endValue: any; - component: dxRangeSelector; - element: Element; - }) => void; - /** Specifies range selector shutter options. */ - shutter?: { - /** Specifies shutter color. */ - color?: string; - /** Specifies the opacity of the color of shutters. */ - opacity?: number; - }; - /** Specifies the appearance of the range selector's slider handles. */ - sliderHandle?: { - /** Specifies the color of the slider handles. */ - color?: string; - /** Specifies the opacity of the slider handles. */ - opacity?: number; - /** Specifies the width of the slider handles. */ - width?: number; - }; - /** Defines the options of the range selector slider markers. */ - sliderMarker?: { - /** Specifies the color of the slider markers. */ - color?: string; - /** Specifies a callback function that returns the text to be displayed by slider markers. */ - customizeText?: (scaleValue: { value: any; valueText: any; }) => string; - /** Specifies font options for the text displayed by the range selector slider markers. */ - font?: viz.core.Font; - /** Specifies a format for the text displayed in slider markers. */ - format?: any; - /** Specifies the color used for the slider marker text when the currently selected range does not match the minRange and maxRange values. */ - invalidRangeColor?: string; - /** - * Specifies the empty space between the marker's border and the marker’s text. - * @deprecated Use the paddingTopBottom and paddingLeftRight options instead. - */ - padding?: number; - /** Specifies the empty space between the marker's top and bottom borders and the marker's text. */ - paddingTopBottom?: number; - /** Specifies the empty space between the marker's left and right borders and the marker's text. */ - paddingLeftRight?: number; - /** Specifies the placeholder height of the slider marker. */ - placeholderHeight?: number; - /** - * Specifies in pixels the height and width of the space reserved for the range selector slider markers. - * @deprecated Use the placeholderHeight and indent options instead. - */ - placeholderSize?: { - /** Specifies the height of the placeholder for the left and right slider markers. */ - height?: number; - /** Specifies the width of the placeholder for the left and right slider markers. */ - width?: { - /** Specifies the width of the left slider marker's placeholder. */ - left?: number; - /** Specifies the width of the right slider marker's placeholder. */ - right?: number; - }; - }; - /** - * Specifies a precision for the formatted value displayed in slider markers. - * @deprecated Use the sliderMarker | format | precision option instead. - */ - precision?: number; - /** Indicates whether or not the slider markers are visible. */ - visible?: boolean; - }; - } -} -declare module DevExpress.viz { - /** A widget that allows end users to select a range of values on a scale. */ - export class dxRangeSelector extends viz.core.BaseWidget implements viz.core.LoadingIndicatorMethods { - constructor(element: JQuery, options?: DevExpress.viz.rangeSelector.dxRangeSelectorOptions); - constructor(element: Element, options?: DevExpress.viz.rangeSelector.dxRangeSelectorOptions); - showLoadingIndicator(): void; - hideLoadingIndicator(): void; - /** Redraws a widget. */ - render(skipChartAnimation?: boolean): void; - /** Returns the currently selected range. */ - getSelectedRange(): { startValue: any; endValue: any; }; - /** Sets a specified range. */ - setSelectedRange(selectedRange: { startValue: any; endValue: any; }): void; - } -} -interface JQuery { - dxRangeSelector(options?: DevExpress.viz.rangeSelector.dxRangeSelectorOptions): JQuery; - dxRangeSelector(methodName: string, ...params: any[]): any; - dxRangeSelector(methodName: "instance"): DevExpress.viz.dxRangeSelector; -} -declare module DevExpress.viz.map { - /** This section describes the fields and methods that can be used in code to manipulate the Layer object. */ - export interface MapLayer { - /** The name of the layer. */ - name: string; - /** The layer index in the layers array. */ - index: number; - /** The layer type. Can be "area", "line" or "marker". */ - type: string; - /** The type of the layer elements. */ - elementType: string; - /** Gets all layer elements. */ - getElements(): Array; - /** Deselects all layer elements. */ - clearSelection(): void; - } - /** This section describes the fields and methods that can be used in code to manipulate the Layer Element object. */ - export interface MapLayerElement { - /** The parent layer of the layer element. */ - layer: MapLayer; - /** Gets the layer element coordinates. */ - coordinates(): Object; - /** Sets the value of an attribute. */ - attribute(name: string, value: any): void; - /** Gets the value of an attribute. */ - attribute(name: string): any; - /** Gets the selection state of the layer element. */ - selected(): boolean; - /** Sets the selection state of the layer element. */ - selected(state: boolean): void; - /** Applies the layer element settings and updates element appearance. */ - applySettings(settings: any): void; - } - /** - * This section describes the fields and methods that can be used in code to manipulate the Area object. - * @deprecated Use the Layer Element instead. - */ - export interface Area { - /** - * Contains the element type. - * @deprecated Use the Layer | type instead. - */ - type: string; - /** - * Return the value of an attribute. - * @deprecated Use the Layer Element | attribute(name, value) method instead. - */ - attribute(name: string): any; - /** - * Provides information about the selection state of an area. - * @deprecated Use the Layer Element | selected() method instead. - */ - selected(): boolean; - /** - * Sets a new selection state for an area. - * @deprecated Use the Layer Element | selected(state) method instead. - */ - selected(state: boolean): void; - /** - * Applies the area settings specified as a parameter and updates the area appearance. - * @deprecated Use the Layer Element | applySettings(settings) method instead. - */ - applySettings(settings: any): void; - } - /** - * This section describes the fields and methods that can be used in code to manipulate the Markers object. - * @deprecated Use the Layer Element instead. - */ - export interface Marker { - /** - * Contains the descriptive text accompanying the map marker. - * @deprecated Get the text using the Layer Element | attribute(name) method. The name parameter value for text is set at the dataField option. - */ - text: string; - /** - * Contains the type of the element. - * @deprecated Use the Layer | type instead. - */ - type: string; - /** - * Contains the URL of an image map marker. - * @deprecated Get the image URL using the Layer Element | attribute(name) method. The name parameter value for the image URL is set at the dataField option. - */ - url: string; - /** - * Contains the value of a bubble map marker. - * @deprecated Get the bubble value using the Layer Element | attribute(name) method. The name parameter for the bubble value is set at the dataField option. - */ - value: number; - /** - * Contains the values of a pie map marker. - * @deprecated Get the pie values using the Layer Element | attribute(name) method. The name parameter for pie values is set at the dataField option. - */ - values: Array; - /** - * Returns the value of an attribute. - * @deprecated Use the Layer Element | attribute(name, value) method instead. - */ - attribute(name: string): any; - /** - * Returns the coordinates of a specific marker. - * @deprecated Use the Layer Element | coordinates() method instead. - */ - coordinates(): Array; - /** - * Provides information about the selection state of a marker. - * @deprecated Use the Layer Element | selected() method instead. - */ - selected(): boolean; - /** - * Sets a new selection state for a marker. - * @deprecated Use the Layer Element | selected(state) method instead. - */ - selected(state: boolean): void; - /** - * Applies the marker settings specified as a parameter and updates marker appearance. - * @deprecated Use the Layer Element | applySettings(settings) method instead. - */ - applySettings(settings: any): void; - } - export interface MapLayerSettings { - /** Specifies the layer name. */ - name?: string; - /** Specifies layer type. */ - type?: string; - /** Specifies the type of a marker element. Setting this option makes sense only if the layer type is "marker". */ - elementType?: string; - /** Specifies a data source for the layer. */ - dataSource?: any; - /** Specifies the line width (for layers of a line type) or width of the layer elements border in pixels. */ - borderWidth?: number; - /** Specifies a color for the border of the layer elements. */ - borderColor?: string; - /** Specifies a color for layer elements. */ - color?: string; - /** Specifies a color for the border of the layer element when it is hovered over. */ - hoveredBorderColor?: string; - /** Specifies the pixel-measured line width (for layers of a line type) or width for the border of the layer element when it is hovered over. */ - hoveredBorderWidth?: number; - /** Specifies a color for a layer element when it is hovered over. */ - hoveredColor?: string; - /** Specifies a pixel-measured line width (for layers of a line type) or width for the border of the layer element when it is selected. */ - selectedBorderWidth?: number; - /** Specifies a color for the border of the layer element when it is selected. */ - selectedBorderColor?: string; - /** Specifies a color for the layer element when it is selected. */ - selectedColor?: string; - /** Specifies the layer opacity (from 0 to 1). */ - opacity?: number; - /** Specifies the size of markers. Setting this option makes sense only if the layer type is "marker" and the elementType is "dot", "pie" or "image". */ - size?: number; - /** Specifies the pixel-measured diameter of the marker that represents the smallest value. Setting this option makes sense only if the layer type is "marker". */ - minSize?: number; - /** Specifies the pixel-measured diameter of the marker that represents the biggest value. Setting this option makes sense only if the layer type is "marker". */ - maxSize?: number; - /** Specifies whether or not to change the appearance of a layer element when it is hovered over. */ - hoverEnabled?: boolean; - /** Specifies whether single or multiple map elements can be selected on a vector map. */ - selectionMode?: string; - /** Specifies the name of the palette or a custom range of colors to be used for coloring a layer. */ - palette?: any; - /** Specifies the number of colors in a palette. */ - paletteSize?: number; - /** Allows you to paint layer elements with similar attributes in the same color. */ - colorGroups?: Array; - /** Specifies the field that provides data to be used for coloring of layer elements. */ - colorGroupingField?: string; - /** Allows you to display bubbles with similar attributes in the same size. Setting this option makes sense only if the layer type is "marker" and the elementType is "bubble". */ - sizeGroups?: Array; - /** Specifies the field that provides data to be used for sizing bubble markers. Setting this option makes sense only if the layer type is "marker" and the elementType is "bubble". */ - sizeGroupingField?: string; - /** Specifies the name of the attribute containing marker data. Setting this option makes sense only if the layer type is "marker" and the elementType is "bubble", "pie" or "image". */ - dataField?: string; - /** Specifies the function that customizes each layer element individually. */ - customize?: (eleemnts: Array) => void; - /** Specifies marker label options. */ - label?: { - /** The name of the data source attribute containing marker texts. */ - dataField?: string; - /** Enables marker labels. */ - enabled?: boolean; - /** Specifies font options for marker labels. */ - font?: viz.core.Font; - }; - } - export interface AreaSettings { - /** - * Specifies the width of the area border in pixels. - * @deprecated Use the layers | borderWidth option instead. - */ - borderWidth?: number; - /** - * Specifies a color for the area border. - * @deprecated Use the layers | borderColor option instead. - */ - borderColor?: string; - /** - * Specifies a color for an area. - * @deprecated Use the layers | color option instead. - */ - color?: string; - /** - * Specifies the function that customizes each area individually. - * @deprecated Use the layers | customize option instead. - */ - customize?: (areaInfo: Area) => AreaSettings; - /** - * Specifies a color for the area border when the area is hovered over. - * @deprecated Use the layers | hoveredBorderColor option instead. - */ - hoveredBorderColor?: string; - /** - * Specifies the pixel-measured width of the area border when the area is hovered over. - * @deprecated Use the layers | hoveredBorderWidth option instead. - */ - hoveredBorderWidth?: number; - /** - * Specifies a color for an area when this area is hovered over. - * @deprecated Use the layers | hoveredColor option instead. - */ - hoveredColor?: string; - /** - * Specifies whether or not to change the appearance of an area when it is hovered over. - * @deprecated Use the layers | hoverEnabled option instead. - */ - hoverEnabled?: boolean; - /** - * Configures area labels. - * @deprecated Use the layers | label option instead. - */ - label?: { - /** - * Specifies the data field that provides data for area labels. - * @deprecated Use the layers | label | dataField option instead. - */ - dataField?: string; - /** - * Enables area labels. - * @deprecated Use the layers | label | enabled option instead. - */ - enabled?: boolean; - /** - * Specifies font options for area labels. - * @deprecated Use the layers | label | font option instead. - */ - font?: viz.core.Font; - }; - /** - * Specifies the name of the palette or a custom range of colors to be used for coloring a map. - * @deprecated Use the layers | palette option instead. - */ - palette?: any; - /** - * Specifies the number of colors in a palette. - * @deprecated Use the layers | paletteSize option instead. - */ - paletteSize?: number; - /** - * Allows you to paint areas with similar attributes in the same color. - * @deprecated Use the layers | colorGroups option instead. - */ - colorGroups?: Array; - /** - * Specifies the field that provides data to be used for coloring areas. - * @deprecated Use the layers | colorGroupingField option instead. - */ - colorGroupingField?: string; - /** - * Specifies a color for the area border when the area is selected. - * @deprecated Use the layers | selectedBorderColor option instead. - */ - selectedBorderColor?: string; - /** - * Specifies a color for an area when this area is selected. - * @deprecated Use the layers | selectedColor option instead. - */ - selectedColor?: string; - /** - * Specifies the pixel-measured width of the area border when the area is selected. - * @deprecated Use the layers | selectedBorderWidth option instead. - */ - selectedBorderWidth?: number; - /** - * Specifies whether single or multiple areas can be selected on a vector map. - * @deprecated Use the layers | selectionMode option instead. - */ - selectionMode?: string; - } - export interface MarkerSettings { - /** - * Specifies a color for the marker border. - * @deprecated Use the layers | borderColor option instead. - */ - borderColor?: string; - /** - * Specifies the width of the marker border in pixels. - * @deprecated Use the layers | borderWidth option instead. - */ - borderWidth?: number; - /** - * Specifies a color for a marker of the dot or bubble type. - * @deprecated Use the layers | color option instead. - */ - color?: string; - /** - * Specifies the function that customizes each marker individually. - * @deprecated Use the layers | customize option instead. - */ - customize?: (markerInfo: Marker) => MarkerSettings; - /** - * Specifies the pixel-measured width of the marker border when the marker is hovered over. - * @deprecated Use the layers | hoveredBorderWidth option instead. - */ - hoveredBorderWidth?: number; - /** - * Specifies a color for the marker border when the marker is hovered over. - * @deprecated Use the layers | hoveredBorderColor option instead. - */ - hoveredBorderColor?: string; - /** - * Specifies a color for a marker of the dot or bubble type when this marker is hovered over. - * @deprecated Use the layers | hoveredColor option instead. - */ - hoveredColor?: string; - /** - * Specifies whether or not to change the appearance of a marker when it is hovered over. - * @deprecated Use the layers | hoverEnabled option instead. - */ - hoverEnabled?: boolean; - /** - * Specifies marker label options. - * @deprecated Use the layers | label option instead. - */ - label?: { - /** - * Enables marker labels. - * @deprecated Use the layers | label | enabled option instead. - */ - enabled?: boolean; - /** - * Specifies font options for marker labels. - * @deprecated Use the layers | label | font option instead. - */ - font?: viz.core.Font; - }; - /** - * Specifies the pixel-measured diameter of the marker that represents the biggest value. Setting this option makes sense only if you use markers of the bubble type. - * @deprecated Use the layers | maxSize option instead. - */ - maxSize?: number; - /** - * Specifies the pixel-measured diameter of the marker that represents the smallest value. Setting this option makes sense only if you use markers of the bubble type. - * @deprecated Use the layers | minSize option instead. - */ - minSize?: number; - /** - * Specifies the opacity of markers. Setting this option makes sense only if you use markers of the bubble type. - * @deprecated Use the layers | opacity option instead. - */ - opacity?: number; - /** - * Specifies the pixel-measured width of the marker border when the marker is selected. - * @deprecated Use the layers | selectedBorderWidth option instead. - */ - selectedBorderWidth?: number; - /** - * Specifies a color for the marker border when the marker is selected. - * @deprecated Use the layers | selectedBorderColor option instead. - */ - selectedBorderColor?: string; - /** - * Specifies a color for a marker of the dot or bubble type when this marker is selected. - * @deprecated Use the layers | selectedColor option instead. - */ - selectedColor?: string; - /** - * Specifies whether a single or multiple markers can be selected on a vector map. - * @deprecated Use the layers | selectionMode option instead. - */ - selectionMode?: string; - /** - * Specifies the size of markers. Setting this option makes sense for any type of marker except bubble. - * @deprecated Use the layers | size option instead. - */ - size?: number; - /** - * Specifies the type of markers to be used on the map. - * @deprecated Use the layers | elementType option instead. - */ - type?: string; - /** - * Specifies the name of a palette or a custom set of colors to be used for coloring markers of the pie type. - * @deprecated Use the layers | palette option instead. - */ - palette?: any; - /** - * Allows you to paint markers with similar attributes in the same color. - * @deprecated Use the layers | colorGroups option instead. - */ - colorGroups?: Array; - /** - * Specifies the field that provides data to be used for coloring markers. - * @deprecated Use the layers | colorGroupingField option instead. - */ - colorGroupingField?: string; - /** - * Allows you to display bubbles with similar attributes in the same size. - * @deprecated Use the layers | sizeGroups option instead. - */ - sizeGroups?: Array; - /** - * Specifies the field that provides data to be used for sizing bubble markers. - * @deprecated Use the layers | sizeGroupingField option instead. - */ - sizeGroupingField?: string; - } - export interface dxVectorMapOptions extends viz.core.BaseWidgetOptions, viz.core.RedrawOnResizeOptions, viz.core.TitleOptions, viz.core.LoadingIndicatorOptions, viz.core.ExportOptions { - /** - * An object specifying options for the map areas. - * @deprecated Use the "area" type element of the layers array. - */ - areaSettings?: AreaSettings; - /** Specifies the options for the map background. */ - background?: { - /** Specifies a color for the background border. */ - borderColor?: string; - /** Specifies a color for the background. */ - color?: string; - }; - /** Specifies options for dxVectorMap widget layers. */ - layers?: Array; - /** Specifies the map projection. */ - projection?: Object; - /** Specifies the positioning of a map in geographical coordinates. */ - bounds?: Array; - /** Specifies the options of the control bar. */ - controlBar?: { - /** Specifies a color for the outline of the control bar elements. */ - borderColor?: string; - /** Specifies a color for the inner area of the control bar elements. */ - color?: string; - /** Specifies whether or not to display the control bar. */ - enabled?: boolean; - /** Specifies the margin of the control bar in pixels. */ - margin?: number; - /** Specifies the position of the control bar. */ - horizontalAlignment?: string; - /** Specifies the position of the control bar. */ - verticalAlignment?: string; - /** Specifies the opacity of the control bar. */ - opacity?: number; - }; - /** - * Specifies a data source for the map area. - * @deprecated Use the layers | dataSource option instead. - */ - mapData?: any; - /** - * Specifies a data source for the map markers. - * @deprecated Use the layers | dataSource option instead. - */ - markers?: any; - /** - * An object specifying options for the map markers. - * @deprecated Use the "marker" type element of the layers array. - */ - markerSettings?: MarkerSettings; - /** Configures tooltips. */ - tooltip?: viz.core.Tooltip; - /** Configures map legends. */ - legends?: Array; - /** Specifies whether or not the map should respond when a user rolls the mouse wheel. */ - wheelEnabled?: boolean; - /** Specifies whether the map should respond to touch gestures. */ - touchEnabled?: boolean; - /** Disables the zooming capability. */ - zoomingEnabled?: boolean; - /** Specifies the geographical coordinates of the center for a map. */ - center?: Array; - /** A handler for the centerChanged event. */ - onCenterChanged?: (e: { - center: Array; - component: dxVectorMap; - element: Element; - }) => void; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: dxVectorMap; - element: Element; - target: {}; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: dxVectorMap; - element: Element; - target: {}; - }) => void; - /** Specifies a number that is used to zoom a map initially. */ - zoomFactor?: number; - /** Specifies a map's maximum zoom factor. */ - maxZoomFactor?: number; - /** A handler for the zoomFactorChanged event. */ - onZoomFactorChanged?: (e: { - component: dxVectorMap; - element: Element; - zoomFactor: number; - }) => void; - /** A handler for the click event. */ - onClick?: any; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: (e: { - component: dxVectorMap; - element: Element; - target: MapLayerElement; - }) => void; - /** - * A handler for the areaClick event. - * @deprecated Use the onClick option instead. - */ - onAreaClick?: any; - /** - * A handler for the areaSelectionChanged event. - * @deprecated Use the onSelectionChanged option instead. - */ - onAreaSelectionChanged?: (e: { - target: Area; - component: dxVectorMap; - element: Element; - }) => void; - /** - * A handler for the markerClick event. - * @deprecated Use the onClick option instead. - */ - onMarkerClick?: any; - /** - * A handler for the markerSelectionChanged event. - * @deprecated Use the onSelecitonChanged option instead. - */ - onMarkerSelectionChanged?: (e: { - target: Marker; - component: dxVectorMap; - element: Element; - }) => void; - /** Disables the panning capability. */ - panningEnabled?: boolean; - } - export interface Legend extends viz.core.BaseLegend { - /** Specifies the color of item markers in the legend. The specified color applied only when the legend uses 'size' source. */ - markerColor?: string; - /** Specifies the shape of item markers. */ - markerShape?: string; - /** Specifies text for legend items. */ - customizeText?: (itemInfo: { start: number; end: number; index: number; color: string; size: number; }) => string; - /** Specifies text for a hint that appears when a user hovers the mouse pointer over the text of a legend item. */ - customizeHint?: (itemInfo: { start: number; end: number; index: number; color: string; size: number }) => string; - /** Specifies the source of data for the legend. */ - source?: { - /** Specifies a layer to which the legend belongs. */ - layer?: string; - /** Specifies the type of the legend grouping. */ - grouping?: string; - } - } - export var projection: ProjectionCreator; - export interface ProjectionCreator { - /** Creates a new projection. */ - (data: { - to?: (coordinates: Array) => Array; - from?: (coordinates: Array) => Array; - aspectRatio?: number; - }): Object; - /** Gets the default or custom projection from the projection storage. */ - get(name: string): Object; - /** Adds a new projection to the internal projections storage. */ - add(name: string, projection: Object): void; - } -} -declare module DevExpress.viz{ - /** A vector map widget. */ - export class dxVectorMap extends viz.core.BaseWidget implements viz.core.LoadingIndicatorMethods { - constructor(element: JQuery, options?: DevExpress.viz.map.dxVectorMapOptions); - constructor(element: Element, options?: DevExpress.viz.map.dxVectorMapOptions); - showLoadingIndicator(): void; - hideLoadingIndicator(): void; - /** Gets the current coordinates of the map center. */ - center(): Array; - /** Sets the coordinates of the map center. */ - center(centerCoordinates: Array): void; - /** - * Deselects all the selected areas on a map. The areas are displayed in their initial style after. - * @deprecated Use the layer's clearSelection() method instead. - */ - clearAreaSelection(): void; - /** - * Deselects all the selected markers on a map. The markers are displayed in their initial style after. - * @deprecated Use the layer's clearSelection() method instead. - */ - clearMarkerSelection(): void; - /** Deselects all the selected area and markers on a map at once. The areas and markers are displayed in their initial style after. */ - clearSelection(): void; - /** Converts client area coordinates into map coordinates. */ - convertCoordinates(x: number, y: number): Array; - /** Gets all map layers. */ - getLayers(): Array; - /** Gets the layer by its index. */ - getLayerByIndex(index: number): DevExpress.viz.map.MapLayer; - /** Gets the layer by its name. */ - getLayerByName(name: string): DevExpress.viz.map.MapLayer; - /** - * Returns an array with all the map areas. - * @deprecated Use the layer's getElements() method instead. - */ - getAreas(): Array; - /** - * Returns an array with all the map markers. - * @deprecated Use the layer's getElements() method instead. - */ - getMarkers(): Array; - /** Gets the current coordinates of the map viewport. */ - viewport(): Array; - /** Sets the coordinates of the map viewport. */ - viewport(viewportCoordinates: Array): void; - /** Gets the current value of the map zoom factor. */ - zoomFactor(): number; - /** Sets the value of the map zoom factor. */ - zoomFactor(zoomFactor: number): void; - } -} -interface JQuery { - dxVectorMap(options?: DevExpress.viz.map.dxVectorMapOptions): JQuery; - dxVectorMap(methodName: string, ...params: any[]): any; - dxVectorMap(methodName: "instance"): DevExpress.viz.dxVectorMap; -} -declare module DevExpress.viz.sparklines { - export interface SparklineTooltip extends viz.core.Tooltip { - /** - * Specifies how a tooltip is horizontally aligned relative to the graph. - * @deprecated Tooltip alignment is no longer useful because the tooltips are aligned automatically. - */ - horizontalAlignment?: string; - /** - * Specifies how a tooltip is vertically aligned relative to the graph. - * @deprecated Tooltip alignment is no longer useful because the tooltips are aligned automatically. - */ - verticalAlignment?: string; - } - export interface BaseSparklineOptions extends viz.core.BaseWidgetOptions, viz.core.MarginOptions { - /** Configures the tooltip. */ - tooltip?: SparklineTooltip; - /** A handler for the tooltipShown event. */ - onTooltipShown?: (e: { - component: BaseSparkline; - element: Element; - }) => void; - /** A handler for the tooltipHidden event. */ - onTooltipHidden?: (e: { - component: BaseSparkline; - element: Element; - }) => void; - } - /** Overridden by descriptions for particular widgets. */ - export class BaseSparkline extends viz.core.BaseWidget { - } - export interface dxBulletOptions extends BaseSparklineOptions { - /** Specifies a color for the bullet bar. */ - color?: string; - /** Specifies an end value for the invisible scale. */ - endScaleValue?: number; - /** Specifies whether or not to show the target line. */ - showTarget?: boolean; - /** Specifies whether or not to show the line indicating zero on the invisible scale. */ - showZeroLevel?: boolean; - /** Specifies a start value for the invisible scale. */ - startScaleValue?: number; - /** Specifies the value indicated by the target line. */ - target?: number; - /** Specifies a color for both the target and zero level lines. */ - targetColor?: string; - /** Specifies the width of the target line. */ - targetWidth?: number; - /** Specifies the primary value indicated by the bullet bar. */ - value?: number; - } - export interface dxSparklineOptions extends BaseSparklineOptions { - /** Specifies the data source field that provides arguments for a sparkline. */ - argumentField?: string; - /** Sets a color for the bars indicating negative values. Available for a sparkline of the bar type only. */ - barNegativeColor?: string; - /** Sets a color for the bars indicating positive values. Available for a sparkline of the bar type only. */ - barPositiveColor?: string; - /** Specifies a data source for the sparkline. */ - dataSource?: any; - /** Sets a color for the boundary of both the first and last points on a sparkline. */ - firstLastColor?: string; - /** Specifies whether a sparkline ignores null data points or not. */ - ignoreEmptyPoints?: boolean; - /** Sets a color for a line on a sparkline. Available for the sparklines of the line- and area-like types. */ - lineColor?: string; - /** Specifies a width for a line on a sparkline. Available for the sparklines of the line- and area-like types. */ - lineWidth?: number; - /** Sets a color for the bars indicating the values that are less than the winloss threshold. Available for a sparkline of the winloss type only. */ - lossColor?: string; - /** Sets a color for the boundary of the maximum point on a sparkline. */ - maxColor?: string; - /** Sets a color for the boundary of the minimum point on a sparkline. */ - minColor?: string; - /** Sets a color for points on a sparkline. Available for the sparklines of the line- and area-like types. */ - pointColor?: string; - /** Specifies the diameter of sparkline points in pixels. Available for the sparklines of line- and area-like types. */ - pointSize?: number; - /** Specifies a symbol to use as a point marker on a sparkline. Available for the sparklines of the line- and area-like types. */ - pointSymbol?: string; - /** Specifies whether or not to indicate both the first and last values on a sparkline. */ - showFirstLast?: boolean; - /** Specifies whether or not to indicate both the minimum and maximum values on a sparkline. */ - showMinMax?: boolean; - /** Determines the type of a sparkline. */ - type?: string; - /** Specifies the data source field that provides values for a sparkline. */ - valueField?: string; - /** Sets a color for the bars indicating the values greater than a winloss threshold. Available for a sparkline of the winloss type only. */ - winColor?: string; - /** Specifies a value that serves as a threshold for the sparkline of the winloss type. */ - winlossThreshold?: number; - /** Specifies the minimum value of the sparkline value axis. */ - minValue?: number; - /** Specifies the maximum value of the sparkline's value axis. */ - maxValue?: number; - } -} -declare module DevExpress.viz { - /** A bullet graph widget. */ - export class dxBullet extends DevExpress.viz.sparklines.BaseSparkline { - constructor(element: JQuery, options?: DevExpress.viz.sparklines.dxBulletOptions); - constructor(element: Element, options?: DevExpress.viz.sparklines.dxBulletOptions); - } - /** A sparkline widget. */ - export class dxSparkline extends DevExpress.viz.sparklines.BaseSparkline { - constructor(element: JQuery, options?: DevExpress.viz.sparklines.dxSparklineOptions); - constructor(element: Element, options?: DevExpress.viz.sparklines.dxSparklineOptions); - } -} -interface JQuery { - dxBullet(options?: DevExpress.viz.sparklines.dxBulletOptions): JQuery; - dxBullet(methodName: string, ...params: any[]): any; - dxBullet(methodName: "instance"): DevExpress.viz.dxBullet; - dxSparkline(options?: DevExpress.viz.sparklines.dxSparklineOptions): JQuery; - dxSparkline(methodName: string, ...params: any[]): any; - dxSparkline(methodName: "instance"): DevExpress.viz.dxSparkline; -} -declare module DevExpress.viz.treeMap { - export interface dxTreeMapOptions extends viz.core.BaseWidgetOptions, viz.core.RedrawOnResizeOptions, viz.core.TitleOptions, viz.core.LoadingIndicatorOptions, viz.core.ExportOptions { - /** Specifies the origin of data for the widget. */ - dataSource?: any; - /** Specifies the name of the data source field that provides nested items for a group. Applies to hierarchical data sources only. */ - childrenField?: string; - /** Specifies the name of the data source field that provides values for tiles. */ - valueField?: string; - /** Specifies the name of the data source field that provides colors for tiles. */ - colorField?: string; - /** Specifies the name of the data source field that provides texts for tile and group labels. */ - labelField?: string; - /** Specifies the name of the data source field that provides IDs for items. Applies to flat data sources only. */ - idField?: string; - /** Specifies the name of the data source field that provides parent IDs for items. Applies to flat data sources only. */ - parentField?: string; - /** Specifies the layout algorithm. */ - layoutAlgorithm?: any; - /** Specifies the direction in which the items will be laid out. */ - layoutDirection?: string; - /** Configures tiles. */ - tile?: { - /** Configures the tile borders. */ - border?: { - /** Specifies the width of the tile borders in pixels. */ - width?: number; - /** Colors the tile borders. */ - color?: string; - }; - /** Specifies a single color for all tiles. */ - color?: string; - /** Specifies the appearance of tiles in the hover state. */ - hoverStyle?: { - /** Configures the appearance of the tile borders in the hover state. */ - border?: { - /** Specifies the width of the tile borders in pixels. Applies to a tile in the hover state. */ - width?: number; - /** Colors the tile borders in the hover state. */ - color?: string; - }; - /** Colors tiles in the hover state. */ - color?: string; - }; - /** Specifies the appearance of tiles in the selected state. */ - selectionStyle?: { - /** Configures the appearance of the tile borders in the selected state. */ - border?: { - /** Specifies the width of the tile borders in pixels. Applies to a tile in the selected state. */ - width?: number; - /** Colors the tile borders in the selected state. */ - color?: string; - }; - /** Colors tiles in the selected state. */ - color?: string; - }; - /** Configures the tile labels. */ - label?: { - /** Changes the visibility of the tile labels. */ - visible?: boolean; - /** Specifies the font settings of the tile labels. */ - font?: viz.core.Font; - }; - }; - /** Configures groups. */ - group?: { - /** Specifies the height of the group headers in pixels. */ - headerHeight?: number; - /** Configures the group borders. */ - border?: { - /** Specifies the width of the group borders in pixels. */ - width?: number; - /** Colors the group borders. */ - color?: string; - }; - /** Colors the group headers. */ - color?: string; - /** Specifies the appearance of groups in the hover state. */ - hoverStyle?: { - /** Configures the appearance of the group borders in the hover state. */ - border?: { - /** Specifies the width of the group borders in pixels. Applies to a group in the hover state. */ - width?: number; - /** Colors the group borders in the hover state. */ - color?: string; - }; - /** Colors the group headers in the hover state. */ - color?: string; - }; - /** Specifies the appearance of groups in the selected state. */ - selectionStyle?: { - /** Configures the appearance of the group borders in the selected state. */ - border?: { - /** Specifies the width of the group borders in pixels. Applies to a group in the selected state. */ - width?: number; - /** Colors the group borders in the selected state. */ - color?: string; - }; - /** Colors the group headers in the selected state. */ - color?: string; - }; - /** Configures the group labels. */ - label?: { - /** Changes the visibility of the group labels. */ - visible?: boolean; - /** Specifies the font settings of the group labels. */ - font?: viz.core.Font; - }; - }; - /** Manages the color settings. */ - colorizer?: { - /** Specifies the colorizing algorithm. */ - type?: string; - /** Sets the palette to be used for colorizing tiles. */ - palette?: any; - /** Specifies whether or not all tiles in a group must be colored uniformly. Applies only if the type option is "discrete". */ - colorizeGroups?: boolean; - /** Allows you to paint tiles with similar values uniformly. Applies only if the type option is "gradient" or "range". */ - range?: Array; - /** Specifies the name of the data source field whose values define the color of a tile. Applies only if the type option is "gradient" or "range". */ - colorCodeField?: string; - }; - /** Specifies whether tiles and groups change their style in the hover state. */ - hoverEnabled?: boolean; - /** Specifies whether a single or multiple nodes can be in the selected state simultaneously. */ - selectionMode?: string; - /** Specifies how many hierarchical levels must be visualized. */ - maxDepth?: number; - /** Specifies whether the user will interact with a single tile or its group. */ - interactWithGroup?: boolean; - tooltip?: viz.core.Tooltip; - /** A handler for the nodesInitialized event. */ - onNodesInitialized?: (e: { - component: dxTreeMap; - element: Element; - root: TreeMapNode - }) => void; - /** A handler for the nodesRendering event. */ - onNodesRendering?: (e: { - component: dxTreeMap; - element: Element; - node: TreeMapNode - }) => void; - /** A handler for the click event. */ - onClick?: any; - /** A handler for the hoverChanged event. */ - onHoverChanged?: (e: { - component: dxTreeMap; - element: Element; - node: TreeMapNode; - }) => void; - /** A handler for the selectionChanged event. */ - onSelectionChanged?: (e: { - component: dxTreeMap; - element: Element; - node: TreeMapNode; - }) => void; - /** A handler for the drill event. */ - onDrill?: (e: { - component: dxTreeMap; - element: Element; - node: TreeMapNode - }) => void; - } - /** This section describes fields and methods that can be used in code to manipulate a Node object. */ - export interface TreeMapNode { - /** The level that the current node occupies in the hierarchy of nodes. */ - level: number; - /** The index of the current node in the array of all nodes on the same level. */ - index: number; - /** The object from the data source visualized by the node. */ - data: Object; - /** Returns the parent node of the current node. */ - getParent(): TreeMapNode; - /** Indicates how many direct descendants the current node has. */ - getChildrenCount(): number; - /** Returns all nodes nested in the current node. */ - getAllChildren(): Array; - /** Returns all descendant nodes. */ - getAllNodes(): Array; - /** Gets a specific node from a collection of direct descendants. */ - getChild(index: number): TreeMapNode; - /** Gets the raw value of the node. */ - value(): number; - /** Returns the label of the node. */ - label(): string; - /** Sets the label to the node. */ - label(label: string): void; - /** Customizes the node. */ - customize(options: any): void; - /** Reverts the appearance of the node to the initial state. */ - resetCustomization(): void; - /** Indicates whether the node is in the hover state or not. */ - isHovered(): boolean; - /** Sets the selection state of a node. */ - select(state: boolean): void; - /** Indicates whether the node is selected or not. */ - isSelected(): boolean; - /** Indicates whether the node is visualized by a tile or a group of tiles. */ - isLeaf(): boolean; - /** Indicates whether the current node is active. */ - isActive(): boolean; - /** Shows the tooltip. */ - showTooltip(): void; - /** Drills down into the node. */ - drillDown(): void; - } -} -declare module DevExpress.viz { - /** A widget for displaying hierarchical data by using nested rectangles. */ - export class dxTreeMap extends viz.core.BaseWidget implements viz.core.LoadingIndicatorMethods { - constructor(element: JQuery, options?: DevExpress.viz.treeMap.dxTreeMapOptions); - constructor(element: Element, options?: DevExpress.viz.treeMap.dxTreeMapOptions); - /** Returns the root node. */ - getRootNode(): DevExpress.viz.treeMap.TreeMapNode; - /** Returns the current node. */ - getCurrentNode(): DevExpress.viz.treeMap.TreeMapNode; - /** Deselects all nodes in the widget. */ - clearSelection(): void; - /** Hides the tooltip. */ - hideTooltip(): void; - /** Drills one level up. */ - drillUp(): void; - /** Resets the drill down level. */ - resetDrillDown(): void; - showLoadingIndicator(): void; - hideLoadingIndicator(): void; - } -} -interface JQuery { - dxTreeMap(options?: DevExpress.viz.treeMap.dxTreeMapOptions): JQuery; - dxTreeMap(methodName: string, ...params: any[]): any; - dxTreeMap(methodName: "instance"): DevExpress.viz.dxTreeMap; -} diff --git a/devextreme/v15/devextreme-tests.ts b/devextreme/v15/devextreme-tests.ts new file mode 100644 index 0000000000..a38aae1f05 --- /dev/null +++ b/devextreme/v15/devextreme-tests.ts @@ -0,0 +1,320 @@ + + +namespace Tests.ui { + var dataGridOptions: DevExpress.ui.dxDataGridOptions = { + activeStateEnabled: true, + allowColumnReordering: true, + allowColumnResizing: true, + onCellClick: function() { }, + cellHintEnabled: true, + columnAutoWidth: true, + columnChooser: { + emptyPanelText: "Nothing is here", + enabled: true, + height: 400, + width: 200, + title: "Column chooser" + }, + columns: [ + { + alignment: "center", + allowFixing: true, + allowEditing: true, + allowFiltering: true, + allowGrouping: true, + allowHiding: true, + allowReordering: true, + allowResizing: true, + allowSearch: true, + allowSorting: true, + autoExpandGroup: true, + calculateCellValue: function(rowData: Object) { return "test-value"; }, + calculateFilterExpression: function(filterValue: any, selectedFilterOperation: string) { return []; }, + caption: "Test column", + cellTemplate: function(container: JQuery, options: Object) { $("Template").appendTo(container); }, + cssClass: "test-ccs-class-name", + customizeText: function(cellInfo: { value: any, valueText: string; }) { return "New text" }, + dataField: "Test", + dataType: "string", + encodeHtml: true, + falseText: "FALSE", + filterOperations: ["contains", "notcontains"], + filterType: "exclude", + filterValue: "Test-filter-value", + fixed: true, + fixedPosition: "right", + groupIndex: 0, + lookup: { + allowClearing: true, + dataSource: ["first", "second"], + displayExpr: "this", + valueExpr: "this" + }, + name: "test-column-name", + showEditorAlways: true, + showInColumnChooser: true, + showWhenGrouped: true, + sortIndex: 1, + sortOrder: "desc", + trueText: "TRUE", + visible: true, + visibleIndex: 0, + width: "100%" + } + ], + customizeColumns: function(columns) { + var i: number; + for (i = 0; i < columns.length; i++) { + if (columns[i].dataField.indexOf('Date') > 0) { + columns[i].dataType = 'date'; + } + + if (columns[i].dataField === 'Freight') { + columns[i].dataType = 'number'; + } + + if (columns[i].dataField === 'CustomerID') { + columns[i].lookup = { + dataSource: { store: [], sort: 'ContactName' }, + valueExpr: 'CustomerID', + displayExpr: 'ContactName' + } + } + if (columns[i].dataField === 'EmployeeID') { + columns[i].lookup = { + dataSource: { store: [], sort: 'LastName' }, + valueExpr: 'EmployeeID', + displayExpr: function(data: any) { + return data.LastName + ' ' + data.FirstName; + } + } + } + if (columns[i].dataField === 'ShipVia') { + columns[i].lookup = { + dataSource: [ + { ShipperID: 1, CompanyName: 'Speedy Express' }, + { ShipperID: 2, CompanyName: 'United Package' }, + { ShipperID: 3, CompanyName: 'Federal Shipping' } + ], + valueExpr: 'ShipperID', + displayExpr: 'CompanyName' + } + } + if (columns[i].dataField === 'ShipCity') { + columns[i].editCellTemplate = function(container: JQuery, options: { value: string; setValue: Function }) { + $('
').dxAutocomplete({ + dataSource: ["Bern", "Lyon", "Lander"], + value: options.value, + onValueChanged: function() { + options.setValue("test-value"); + } + }).appendTo(container); + } + } + } + }, + summary: { + totalItems: [{ + column: 'CustomerID', + summaryType: 'count' + }, { + column: 'Freight', + summaryType: 'min', + valueFormat: "percent", + showInColumn: "CustomerID" + }, + { + column: 'OrderDate', + summaryType: 'min', + valueFormat: "shortDate" + }, + { + column: 'Freight', + summaryType: 'avg', + valueFormat: "fixedPoint", + precision: 2 + }], + groupItems: [{ + column: 'CustomerID', + summaryType: 'count', + showInGroupFooter: true + }, { + column: 'Freight', + summaryType: 'min' + }, { + column: 'Freight', + summaryType: 'max' + }, + { + column: 'ShipName', + summaryType: 'count', + showInGroupFooter: true + }, + { + column: 'OrderDate', + summaryType: 'min', + valueFormat: "shortDate", + showInColumn: "CustomerID", + showInGroupFooter: true + }] + }, + sortByGroupSummaryInfo: [{ summaryItem: 'count' }], + groupPanel: { + visible: true + }, + filterRow: { + visible: true + }, + pager: { + visible: true, + showInfo: true, + showNavigationButtons: true, + showPageSizeSelector: true + }, + stateStoring: { + enabled: false + }, + rowAlternationEnabled: true, + editing: { + editMode: 'batch', + insertEnabled: true, + editEnabled: true, + removeEnabled: true + }, + searchPanel: { + visible: true + }, + sorting: { + mode: 'multiple' + } + }; + + new DevExpress.ui.dxDataGrid($("#data-grid"), dataGridOptions); + new DevExpress.ui.dxDataGrid($("#data-grid").get(0), dataGridOptions); + $("#data-grid").dxDataGrid(dataGridOptions); +} + +namespace Tests.viz { + var chartOptions: DevExpress.viz.charts.dxChartOptions = { + dataSource: [ + { arg: "Illinois", s1: 100, s2: 50, s3: 75, s4: 25, s5: 50, s6: 100, s7: 25, s8: 75 }, + { arg: "Indiana", s1: 100, s2: 50, s3: 75, s4: 25, s5: 50, s6: 100, s7: 25, s8: 75 }, + { arg: "Michigan", s1: 100, s2: 50, s3: 75, s4: 25, s5: 50, s6: 100, s7: 25, s8: 75 } + ], + valueAxis: [{ title: 'Value Axis Title' }], + argumentAxis: { title: 'Argument Axis Title', grid: { visible: true } }, + legend: { border: { visible: true } }, + tooltip: { enabled: true }, + commonPaneSettings: { border: { visible: true } }, + commonSeriesSettings: { + type: 'bar', + hoverMode: 'allArgumentPoints', + selectionMode: 'allArgumentPoints', + label: { + visible: true, + format: 'fixedPoint', + precision: 2 + } + }, + series: [ + { valueField: 's1' }, + { valueField: 's2' }, + { valueField: 's3' }, + { valueField: 's4' }, + { valueField: 's5' }, + { valueField: 's6' }, + { valueField: 's7' }, + { valueField: 's8' } + ], + title: 'Long Chart\'s Title', + onPointClick: function(arg: any) { + arg.target.isSelected() ? arg.target.clearSelection() : arg.target.select(); + }, + onSeriesClick: function(arg: any) { + arg.target.isVisible() ? arg.target.hide() : arg.target.show(); + } + }; + + var pieChartOptions: DevExpress.viz.charts.dxPieChartOptions = { + dataSource: [{ arg: "Index1", arg1: 1, val: 100 }, + { arg: "Index2", arg1: 2, val: 50 }, + { arg: "Index3", arg1: 3, val: 75 }, + { arg: "Index4", arg1: 4, val: 25 }, + { arg: "Index5", arg1: 5, val: 50 }, + { arg: "Index6", arg1: 6, val: 100 }, + { arg: "Index7", arg1: 7, val: 25 }, + { arg: "Index8", arg1: 8, val: 75 }], + tooltip: { + enabled: true + }, + series: [{ + type: 'doughnut', + label: { + visible: true, + format: 'fixedPoint', + precision: 2 + } + }], + title: 'Long PieChart\'s Title' + }; + + new DevExpress.viz.charts.dxChart($("chart"), chartOptions); + new DevExpress.viz.charts.dxChart($("#chart").get(0), chartOptions); + $("#chart").dxChart(chartOptions); + + new DevExpress.viz.charts.dxPieChart($("#pie-chart"), pieChartOptions); + new DevExpress.viz.charts.dxPieChart($("#pie-chart").get(0), pieChartOptions); + $("#pie-chart").dxPieChart(pieChartOptions); +} + +namespace Tests.framework { + var app = new DevExpress.framework.html.HtmlApplication({ + namespace: "Application", + navigation: [ + { + title: "Home", + action: "#home", + icon: "home" + }, + { + title: "About", + action: "#about", + icon: "info" + } + ] + }); + + app.router.register(":view/:id", { view: "home", id: undefined }); + app.navigate(); +} + +namespace Tests.data { + new DevExpress.data.DataSource({ + sort: ["value", true], + group: ["id", false], + select: ["value"], + filter: ["value", "startswith", "first"], + + pageSize: 25, + paginate: true, + + map: function(item) { return item; }, + postProcess: function(data) { return data; }, + searchExpr: "expr", + searchOperation: "contains", + searchValue: "somevalue", + store: [1, 2, 3] + }); + + new DevExpress.data.ArrayStore(); + new DevExpress.data.ArrayStore({ + data: [{ id: 1, value: "First one" }, { id: 2, value: "Second one" }], + key: "id" + }); + + new DevExpress.data.CustomStore({ + load: function() { + return $.Deferred().promise(); + } + }); +} diff --git a/devextreme/devextreme-15.2.13.d.ts b/devextreme/v15/index.d.ts similarity index 99% rename from devextreme/devextreme-15.2.13.d.ts rename to devextreme/v15/index.d.ts index cb1ca8697b..4c73e12d30 100644 --- a/devextreme/devextreme-15.2.13.d.ts +++ b/devextreme/v15/index.d.ts @@ -3,7 +3,7 @@ // Definitions by: DevExpress Inc. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -/// +/// declare module DevExpress { /** A mixin that provides a capability to fire and subscribe to events. */ diff --git a/devextreme/v15/tsconfig.json b/devextreme/v15/tsconfig.json new file mode 100644 index 0000000000..a94cf731c1 --- /dev/null +++ b/devextreme/v15/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "target": "es6", + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": false, + "baseUrl": "../../", + "typeRoots": [ + "../../" + ], + "types": [], + "paths": { + "devextreme": ["devextreme/v15"] + }, + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "devextreme-tests.ts" + ] +} \ No newline at end of file diff --git a/dojo/tsconfig.json b/dojo/tsconfig.json index 3ed256f27a..fbf76b15f5 100644 --- a/dojo/tsconfig.json +++ b/dojo/tsconfig.json @@ -15,6 +15,68 @@ }, "files": [ "index.d.ts", - "dijit.d.ts" + "dijit.d.ts", + "doh.d.ts", + "dojox.NodeList.d.ts", + "dojox.analytics.d.ts", + "dojox.app.d.ts", + "dojox.atom.d.ts", + "dojox.av.d.ts", + "dojox.calc.d.ts", + "dojox.calendar.d.ts", + "dojox.charting.d.ts", + "dojox.collections.d.ts", + "dojox.color.d.ts", + "dojox.css3.d.ts", + "dojox.data.d.ts", + "dojox.date.d.ts", + "dojox.dgauges.d.ts", + "dojox.dnd.d.ts", + "dojox.drawing.d.ts", + "dojox.dtl.d.ts", + "dojox.editor.d.ts", + "dojox.embed.d.ts", + "dojox.encoding.d.ts", + "dojox.flash.d.ts", + "dojox.form.d.ts", + "dojox.fx.d.ts", + "dojox.gantt.d.ts", + "dojox.gauges.d.ts", + "dojox.geo.d.ts", + "dojox.gesture.d.ts", + "dojox.gfx.d.ts", + "dojox.gfx3d.d.ts", + "dojox.grid.d.ts", + "dojox.help.d.ts", + "dojox.highlight.d.ts", + "dojox.html.d.ts", + "dojox.image.d.ts", + "dojox.io.d.ts", + "dojox.jq.d.ts", + "dojox.json.d.ts", + "dojox.jsonPath.d.ts", + "dojox.lang.d.ts", + "dojox.layout.d.ts", + "dojox.main.d.ts", + "dojox.math.d.ts", + "dojox.mdnd.d.ts", + "dojox.mobile.d.ts", + "dojox.mvc.d.ts", + "dojox.rails.d.ts", + "dojox.robot.d.ts", + "dojox.rpc.d.ts", + "dojox.secure.d.ts", + "dojox.sketch.d.ts", + "dojox.socket.d.ts", + "dojox.sql.d.ts", + "dojox.storage.d.ts", + "dojox.string.d.ts", + "dojox.testing.d.ts", + "dojox.timing.d.ts", + "dojox.treemap.d.ts", + "dojox.uuid.d.ts", + "dojox.validate.d.ts", + "dojox.widget.d.ts", + "dojox.xml.d.ts" ] } \ No newline at end of file diff --git a/draft-js/draft-js-0.2.2.d.ts b/draft-js/draft-js-0.2.2.d.ts deleted file mode 100644 index ac5eb21f33..0000000000 --- a/draft-js/draft-js-0.2.2.d.ts +++ /dev/null @@ -1,277 +0,0 @@ -// Type definitions for draft-js 0.2.2 -// Project: https://github.com/facebook/draft-js -// Definitions by: Pavel Evsegneev -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -declare module "draft-js" { - namespace Draft { - interface IEditor { - new(): Editor - } - - interface EditorState { - getCurrentContent(): ContentState, - getSelection(): SelectionState, - getCurrentInlineStyle(): any, - getBlockTree(): any, - - createEmpty(decorator?: any): EditorState, - createWithContent(contentState: ContentState, decorator?: any): EditorState, - create(config: any): EditorState, - push(editorState: EditorState, contentState: ContentState, actionType: string): EditorState, - undo(editorState: EditorState): EditorState, - redo(editorState: EditorState): EditorState, - acceptSelection(editorState: EditorState, selectionState: SelectionState): EditorState, - forceSelection(editorState: EditorState, selectionState: SelectionState): EditorState, - - moveFocusToEnd(editorState: EditorState): EditorState - } - - interface CompositeDecorator { - getDecorations(): Array, - getComponentForKey(): any, - getPropsForKey(): any - } - - interface Entity { - create(type: string, mutability: string, data?: Object): EntityInstance, - add(instance: EntityInstance): string, - get(key: string): EntityInstance, - mergeData(key: string, toMerge: any): EntityInstance, - replaceData(key: string, newData: any): EntityInstance - } - - interface EntityInstance { - getData(): any, - getKey(): string, - getMutability(): string - } - - interface BlockMapBuilder { - createFromArray(blocks: Array): BlockMap - } - - interface CharacterMetadata { - create(config?: any): CharacterMetadata, - - applyStyle(record: CharacterMetadata, - style: string): CharacterMetadata, - - removeStyle(record: CharacterMetadata, - style: string): CharacterMetadata, - - applyEntity(record: CharacterMetadata, - entityKey?: string): CharacterMetadata, - - getStyle(): any, - hasStyle(style: string): boolean, - - getEntity(): string - } - - interface IContentBlock { - new(draftContentBlock: any): ContentBlock; - } - interface ContentBlock { - key: string, - type: string, - text: string, - characterList: any, - depth: number, - - getKey(): string, - getType(): string, - getText(): string, - getCharacterList(): any, - getLength(): number, - getDepth(): number, - getInlineStyleAt(offset: number): any, - getEntityAt(offset: number): string, - findStyleRanges(filterFn: Function, callback: Function): void, - findEntityRanges(filterFn: Function, callback: Function): void - - } - - interface ContentState { - createFromText(text: string): ContentState, - createFromBlockArray(blocks: Array): ContentState, - - getBlockMap(): BlockMap, - getSelectionBefore(): SelectionState, - getSelectionAfter(): SelectionState, - - getBlockForKey(key: string): ContentBlock, - getKeyBefore(key: string): string, - getKeyAfter(key: string): string, - - getBlockBefore(key: string): ContentBlock, - getBlockAfter(key: string): ContentBlock, - - getBlocksAsArray(): Array, - - getPlainText(): string, - hasText(): boolean, - - set(key: string, value: any): ContentState, - toJS(): any - } - - interface ISelectionState { - new(draftSelectionState: any): SelectionState; - createEmpty(blockKey: string): SelectionState; - } - - interface SelectionState { - getStartKey(): string, - getStartOffset(): number, - getEndKey(): string, - getEndOffset(): number, - getAnchorKey(): string, - getAnchorOffset(): number, - getFocusKey(): string, - getFocusOffset(): number, - - getIsBackward(): boolean, - getHasFocus(): boolean, - isCollapsed(): boolean, - - hasEdgeWithin(blockKey: string, start: number, end: number): boolean, - serialize(): string, - - get(key: string): any, - set(key: string, value: any): SelectionState - } - - interface BlockMap { - get(key: string): ContentBlock, - set(key: string, value: any): BlockMap, - delete(key: string): BlockMap, - find(cb: any): ContentBlock - } - - interface Modifier { - replaceText(contentState: ContentState, - rangeToReplace: SelectionState, - text: string, - inlineStyle?: any, - entityKey?: string): ContentState, - - insertText(contentState: ContentState, - targetRange: SelectionState, - text: string, - inlineStyle?: any, - entityKey?: string): ContentState, - - moveText(contentState: ContentState, - removalRange: SelectionState, - targetRange: SelectionState): ContentState, - - replaceWithFragment(contentState: ContentState, - targetRange: SelectionState, - fragment: BlockMap): ContentState, - - removeRange(contentState: ContentState, - rangeToRemove: SelectionState, - removalDirection: string): ContentState, - - splitBlock(contentState: ContentState, - selectionState: SelectionState): ContentState, - - applyInlineStyle(contentState: ContentState, - selectionState: SelectionState, - inlineStyle: string): ContentState, - - removeInlineStyle(contentState: ContentState, - selectionState: SelectionState, - inlineStyle: string): ContentState, - - setBlockType(contentState: ContentState, - selectionState: SelectionState, - blockType: string): ContentState, - - applyEntity(contentState: ContentState, - selectionState: SelectionState, - entityKey: string): ContentState - } - - interface RichUtils { - currentBlockContainsLink(editorState: EditorState): boolean, - getCurrentBlockType(editor: EditorState): string, - handleKeyCommand(editorState: EditorState, command: string): any, - insertSoftNewline(editorState: EditorState): EditorState, - onBackspace(editorState: EditorState): EditorState, - onDelete(editorState: EditorState): EditorState, - onTab(event: Event, editorState: EditorState, maxDepth: number): EditorState, - toggleBlockType(editorState: EditorState, blockType: string): EditorState, - toggleCode(editorState: EditorState): EditorState, - toggleLink(editorState: EditorState, targetSelection: SelectionState, entityKey: string): EditorState, - tryToRemoveBlockStyle(editorState: EditorState): EditorState - } - - interface EditorProps { - editorState: EditorState, - onChange(editorState: EditorState): void, - - placeholder?: string, - textAlignment?: any, - blockRendererFn?: (ContentBlock: ContentBlock) => any, - blockStyleFn?: (ContentBlock: ContentBlock) => string, - customStyleMap?: any, - - readOnly?: boolean, - spellCheck?: boolean, - stripPastedStyles?: boolean, - - handleReturn?: (e: any) => boolean, - handleKeyCommand?: (command: string) => boolean, - handleBeforeInput?: (chars: string) => boolean, - handlePastedFiles?: (files: Array) => boolean, - handleDroppedFiles?: (selection: SelectionState, files: Array) => boolean, - handleDrop?: (selection: SelectionState, dataTransfer: any, isInternal: any) => boolean, - - onEscape?: (e: any) => void, - onTab?: (e: any) => void, - onUpArrow?: (e: any) => void, - onDownArrow?: (e: any) => void, - - suppressContentEditableWarning?: any, - - onBlur?: (e: any) => void, - onFocus?: (e: any) => void - } - - interface Editor { - props: EditorProps - state: any, - refs: any, - context: any, - setState(): any, - render(): any, - forceUpdate(): any - } - - var Editor: IEditor; - var EditorState: EditorState; - - var CompositeDecorator: CompositeDecorator; - var Entity: Entity; - var EntityInstance: EntityInstance; - - var BlockMapBuilder: BlockMapBuilder; - var CharacterMetadata: CharacterMetadata; - var ContentBlock: IContentBlock; - var ContentState: ContentState; - var SelectionState: ISelectionState; - - var Modifier: Modifier; - var RichUtils: RichUtils; - - function convertFromRaw(rawState: any): Array; - - function convertToRaw(contentState: ContentState): any; - - function genKey(): string - } - - export = Draft; - -} diff --git a/draft-js/draft-js-tests-0.2.2.tsx b/draft-js/draft-js-tests-0.2.2.tsx deleted file mode 100644 index 88271465f5..0000000000 --- a/draft-js/draft-js-tests-0.2.2.tsx +++ /dev/null @@ -1,183 +0,0 @@ -/// -/// -/// - -import * as React from "react"; - -import { - Editor, - EditorState, - Entity, - CharacterMetadata, - ContentBlock, - Modifier, - SelectionState, - genKey -} from "draft-js"; - -export class Tag extends React.Component { - constructor(props: any) { - super(props); - } - - remove = (): void => { - this.props.blockProps.removeBlock(this.props.block.getKey()); - } - - render () { - const {block} = this.props; - if (block.getEntityAt(0)) { - const data = Entity.get(block.getEntityAt(0)).getData(); - - return ( -
- {data.content.name} - - clear - -
- ); - } - } -} - -export class Hint extends React.Component { - constructor(props: any) { - super(props); - } - - render () { - const {block} = this.props; - if (block.getEntityAt(0)) { - const data = Entity.get(block.getEntityAt(0)).getData(); - - return ( -
- {this.props.blockProps.autocomplete} - {data.content.text} -
- ); - } - } -} - -export function removeBlock(editorState: EditorState, blockKey: string) { - const content = editorState.getCurrentContent(); - - const targetRange = new SelectionState({ - anchorKey: blockKey, - anchorOffset: 0, - focusKey: blockKey, - focusOffset: 1 - }); - - const withoutTag = Modifier.removeRange(content, targetRange, "backward"); - const resetBlock = Modifier.setBlockType( - withoutTag, - withoutTag.getSelectionAfter(), - "unstyled" - ); - - const newState = EditorState.push(editorState, resetBlock, "remove-range"); - return EditorState.forceSelection(newState, resetBlock.getSelectionAfter()); -} - -export function applyEntity(editorState: EditorState, blockKey: string, entityKey: string) { - const content = editorState.getCurrentContent(); - - const targetRange = new SelectionState({ - anchorKey: blockKey, - anchorOffset: 0, - focusKey: blockKey, - focusOffset: 1 - }); - - const withNewEntity = Modifier.applyEntity( - content, - targetRange, - entityKey - ) - - const newState = EditorState.push(editorState, withNewEntity, "change-entity"); - return EditorState.forceSelection(newState, withNewEntity.getSelectionAfter()); -} - -export function addTagBlock(content: any, editorState: EditorState): any { - const contentState = editorState.getCurrentContent(); - - const entityKey = Entity.create( - "TOKEN", - "IMMUTABLE", - {content} - ); - - const charData = CharacterMetadata.create({entity: entityKey}); - const tag = new ContentBlock({ - key: genKey(), - type: "tag", - text: "", - characterList: [], - }); - - const withTag = contentState.set("blockMap", contentState.getBlockMap().set(tag.key, tag)); - - const withRemovedPreviousBlock = withTag.set("blockMap", withTag.getBlockMap().delete(contentState.getSelectionBefore().getAnchorKey())) - - const withTagBlock = EditorState.push(editorState, withRemovedPreviousBlock, "insert-fragment"); - - return withTagBlock; -} - -export function addHintBlock(content: any, editorState: EditorState): any { - const contentState = editorState.getCurrentContent(); - const selectionState = editorState.getSelection(); - - const entityKey = Entity.create( - "TOKEN", - "IMMUTABLE", - {content} - ); - - const charData = CharacterMetadata.create({entity: entityKey}); - const hint = new ContentBlock({ - key: genKey(), - type: "hint", - text: "", - characterList: [], - }); - const empty = new ContentBlock({ - key: genKey(), - type: "unstyled", - text: "", - characterList: [], - }); - - const withEmpty = contentState.set("blockMap", contentState.getBlockMap().set(empty.key, empty)); - const withHint = withEmpty.set("blockMap", withEmpty.getBlockMap().set(hint.key, hint)); - return { - editorState: EditorState.forceSelection(EditorState.push(editorState, withHint, "insert-fragment"), selectionState), - blockKey: hint.key - } - -} - -export class SearchField extends React.Component { - public onChange: any; - - constructor(props: any) { - super(props); - this.onChange = (editorState: EditorState) => { - this.setState({editorState}) - }; - } - - render() { - const {editorState} = this.state; - return ( - - ) - } -} diff --git a/dragula/dragula-amd-tests.ts b/dragula/dragula-amd-tests.ts deleted file mode 100644 index f473f4ecc8..0000000000 --- a/dragula/dragula-amd-tests.ts +++ /dev/null @@ -1,39 +0,0 @@ - - -import dragula = require("dragula"); - -// containers -var d1 = dragula([document.querySelector('#left'), document.querySelector('#right')]); - -// all options -var d2 = dragula({ - isContainer: function (el) { - return false; - }, - moves: function (el, container, handle) { - return true; - }, - accepts: function (el, target, source, sibling) { - return true; - }, - invalid: function (el, target) { - return el.tagName === 'A' || el.tagName === 'BUTTON'; - }, - direction: 'vertical', - copy: false, - revertOnSpill: false, - removeOnSpill: false, - delay: false, - mirrorContainer: document.body -}); - -// empty call -var d3 = dragula(); - - -// drake API -var drake = dragula({ - copy: true -}); - -drake.containers.push(document.querySelector('#container')); diff --git a/dropzone/dropzone-commonjs-tests.ts b/dropzone/dropzone-commonjs-tests.ts deleted file mode 100755 index c77de6e583..0000000000 --- a/dropzone/dropzone-commonjs-tests.ts +++ /dev/null @@ -1,285 +0,0 @@ -/// - -import Dropzone = require("dropzone"); - -const dropzoneFromString = new Dropzone(".test"); -const dropzoneFromElement = new Dropzone(document.getElementById("test")); -const dropzoneRenameFunction = function(name: string){ - return name; -}; - -const dropzoneWithOptions = new Dropzone(".test", { - url: "/some/url", - method: "post", - withCredentials: false, - parallelUploads: 2, - uploadMultiple: true, - maxFilesize: 1024, - paramName: "file", - createImageThumbnails: true, - maxThumbnailFilesize: 1024, - thumbnailWidth: 50, - thumbnailHeight: 50, - filesizeBase: 1000, - maxFiles: 100, - params: { - additional: "param" - }, - clickable: true, - ignoreHiddenFiles: true, - acceptedFiles: "image/*", - renameFilename: dropzoneRenameFunction, - autoProcessQueue: true, - autoQueue: true, - addRemoveLinks: true, - previewsContainer: "
", - hiddenInputContainer: document.createElement("input"), - capture: "camera", - - dictDefaultMessage: "", - dictFallbackMessage: "", - dictFallbackText: "", - dictFileTooBig: "", - dictInvalidFileType: "", - dictResponseError: "", - dictCancelUpload: "", - dictCancelUploadConfirmation: "", - dictRemoveFile: "", - dictRemoveFileConfirmation: "", - dictMaxFilesExceeded: "", - - accept: (file:Dropzone.DropzoneFile, done:(error?:string|Error) => void) => { - if (file.accepted) { - file.previewElement.classList.add("accepted"); - file.previewTemplate.classList.add("accepted"); - file.previewsContainer.classList.add("accepted"); - done(); - } - else { - done(new Error(file.status)); - } - }, - init: () => console.log("Initialized"), - forceFallback: false, - fallback: () => console.log("Fallback"), - resize: (file:Dropzone.DropzoneFile) => ({ - srcX: 0, - srcY: 0, - trgX: 10, - trgY: 10, - srcWidth: 100, - srcHeight: 100, - trgWidth: 50, - trgHeight: 50, - optWidth: 50, - optHeight: 50 - }), - - drop: (e:DragEvent) => console.log("Drop"), - dragstart: (e:DragEvent) => console.log("Dragstart"), - dragend: (e:DragEvent) => console.log("Dragend"), - dragenter: (e:DragEvent) => console.log("Dragenter"), - dragover: (e:DragEvent) => console.log("Dragover"), - dragleave: (e:DragEvent) => console.log("Dragleave"), - paste: (e:DragEvent) => console.log("Paste"), - - reset: () => console.log("Reset"), - - addedfile: (file:Dropzone.DropzoneFile) => console.log("Addedfile"), - addedfiles: (files:Dropzone.DropzoneFile[]) => console.log("Addedfiles"), - removedfile: (file:Dropzone.DropzoneFile) => console.log("Removedfile"), - thumbnail: (file:Dropzone.DropzoneFile, dataUrl:string) => console.log("Thumbnail"), - - error: (file:Dropzone.DropzoneFile, message:string|Error) => console.log("Error"), - errormultiple: (files:Dropzone.DropzoneFile[], message:string|Error) => console.log("Errormultiple"), - - processing: (file:Dropzone.DropzoneFile) => console.log("Processing"), - processingmultiple: (files:Dropzone.DropzoneFile[]) => console.log("Processingmultiple"), - - uploadprogress: (file:Dropzone.DropzoneFile, progress:number, bytesSent:number) => console.log("Uploadprogress"), - totaluploadprogress: (totalProgress:number, totalBytes:number, totalBytesSent:number) => console.log("Totaluploadprogress"), - - sending: (file:Dropzone.DropzoneFile, xhr:XMLHttpRequest, formData:{}) => console.log("Sending"), - sendingmultiple: (files:Dropzone.DropzoneFile[], xhr:XMLHttpRequest, formData:{}) => console.log("Sendingmultiple"), - - success: (file:Dropzone.DropzoneFile) => console.log("Success"), - successmultiple: (files:Dropzone.DropzoneFile[]) => console.log("Successmultiple"), - - canceled: (file:Dropzone.DropzoneFile) => console.log("Canceled"), - canceledmultiple: (file:Dropzone.DropzoneFile[]) => console.log("Canceledmultiple"), - - complete: (file:Dropzone.DropzoneFile) => console.log("Complete"), - completemultiple: (file:Dropzone.DropzoneFile[]) => console.log("Completemultiple"), - - maxfilesexceeded: (file:Dropzone.DropzoneFile) => console.log("Maxfilesexceeded"), - maxfilesreached: (files:Dropzone.DropzoneFile[]) => console.log("Maxfilesreached"), - queuecomplete: () => console.log("Queuecomplete"), - - previewTemplate: "
", -}); - -var dropzoneWithOptionsVariations:Dropzone; -dropzoneWithOptionsVariations = new Dropzone(".test", { - clickable: ".test" -}); -dropzoneWithOptionsVariations = new Dropzone(".test", { - clickable: document.getElementById("test") -}); -dropzoneWithOptionsVariations = new Dropzone(".test", { - clickable: [".test", ".test"] -}); -dropzoneWithOptionsVariations = new Dropzone(".test", { - clickable: [document.getElementById("test"), document.getElementById("test")] -}); -dropzoneWithOptionsVariations = new Dropzone(".test", { - clickable: ["test", document.getElementById("test")] -}); - -const dropzone = new Dropzone(".test"); - -dropzone.enable(); -dropzone.disable(); - -dropzone.files.forEach(f => { - if (f.xhr) { - console.log(f.xhr.readyState) - } - if (f.accepted) { - f.previewElement.classList.add("accepted"); - f.previewTemplate.classList.add("accepted"); - f.previewsContainer.classList.add("accepted"); - } - else { - console.log(f.status.toUpperCase()); - } -}); - -const firstFile = dropzone.files[0]; -dropzone.removeFile(firstFile); -dropzone.addFile(firstFile); -dropzone.enqueueFile(firstFile); -dropzone.processFile(firstFile); -dropzone.uploadFile(firstFile); -dropzone.cancelUpload(firstFile); -dropzone.createThumbnail(firstFile, () => { - console.log("createThumbnail") -}); -dropzone.createThumbnailFromUrl(firstFile, "/some/url", () => { - console.log("createThumbnailFromUrl") -}); -dropzone.accept(firstFile, (e:string|Error) => { - console.log(e); -}); - -const acceptedFiles = dropzone.getAcceptedFiles(); -dropzone.processFiles(acceptedFiles); - -const rejectedFiles = dropzone.getRejectedFiles(); -dropzone.enqueueFiles(rejectedFiles); - -const queuedFiles = dropzone.getQueuedFiles(); -dropzone.processFiles(queuedFiles); - -const uploadingFiles = dropzone.getUploadingFiles(); -dropzone.processFiles(uploadingFiles); - -const activeFiles = dropzone.getActiveFiles(); -dropzone.processFiles(activeFiles); - -const addedFiles = dropzone.getFilesWithStatus(Dropzone.ADDED); -dropzone.processFiles(addedFiles); - -dropzone.processQueue(); -dropzone.removeAllFiles(true); - -dropzone - .on("drop", () => { - console.count('drop'); - }) - .on("dragstart", () => { - console.count('dragstart'); - }) - .on("dragend", () => { - console.count('dragend'); - }) - .on("dragenter", () => { - console.count('dragenter'); - }) - .on("dragover", () => { - console.count('dragover'); - }) - .on("dragleave", () => { - console.count('dragleave'); - }) - .on("paste", () => { - console.count('paste'); - }) - .on("reset", () => { - console.count('reset'); - }) - .on("addedfile", () => { - console.count('addedfile'); - }) - .on("addedfiles", () => { - console.count('addedfiles'); - }) - .on("removedfile", () => { - console.count('removedfile'); - }) - .on("thumbnail", () => { - console.count('thumbnail'); - }) - .on("error", () => { - console.count('error'); - }) - .on("errormultiple", () => { - console.count('errormultiple'); - }) - .on("processing", () => { - console.count('processing'); - }) - .on("processingmultiple", () => { - console.count('processingmultiple'); - }) - .on("uploadprogress", () => { - console.count('uploadprogress'); - }) - .on("totaluploadprogress", () => { - console.count('totaluploadprogress'); - }) - .on("sending", () => { - console.count('sending'); - }) - .on("sendingmultiple", () => { - console.count('sendingmultiple'); - }) - .on("success", () => { - console.count('success'); - }) - .on("successmultiple", () => { - console.count('successmultiple'); - }) - .on("canceled", () => { - console.count('canceled'); - }) - .on("canceledmultiple", () => { - console.count('canceledmultiple'); - }) - .on("complete", () => { - console.count('complete'); - }) - .on("completemultiple", () => { - console.count('completemultiple'); - }) - .on("maxfilesexceeded", () => { - console.count('maxfilesexceeded'); - }) - .on("maxfilesreached", () => { - console.count('maxfilesreached'); - }) - .on("queuecomplete", () => { - console.count('queuecomplete'); - }); - - -dropzone.destroy(); diff --git a/durandal/durandal-1.x.d.ts b/durandal/v1/index.d.ts similarity index 100% rename from durandal/durandal-1.x.d.ts rename to durandal/v1/index.d.ts diff --git a/durandal/v1/tsconfig.json b/durandal/v1/tsconfig.json new file mode 100644 index 0000000000..333827a63e --- /dev/null +++ b/durandal/v1/tsconfig.json @@ -0,0 +1,22 @@ +{ + "compilerOptions": { + "module": "commonjs", + "target": "es6", + "noImplicitAny": false, + "noImplicitThis": true, + "strictNullChecks": true, + "baseUrl": "../../", + "typeRoots": [ + "../../" + ], + "types": [], + "paths": { + "durandal": ["durandal/v1"] + }, + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts" + ] +} \ No newline at end of file diff --git a/easy-table/easy-table-0.2.0-tests.ts b/easy-table/easy-table-0.2.0-tests.ts deleted file mode 100644 index 3887d08f66..0000000000 --- a/easy-table/easy-table-0.2.0-tests.ts +++ /dev/null @@ -1,13 +0,0 @@ - -import EasyTable = require('easy-table'); - -var table = new EasyTable(); - -table.cell('aa', 1); -table.cell('bb',1); -table.newRow(); - -table.cell('aa', 1); -table.cell('bb',1); - -table.print(); diff --git a/easy-table/easy-table-0.2.0.d.ts b/easy-table/easy-table-0.2.0.d.ts deleted file mode 100644 index 1aaf7df01a..0000000000 --- a/easy-table/easy-table-0.2.0.d.ts +++ /dev/null @@ -1,40 +0,0 @@ -// Type definitions for easy-table 0.2.0 -// Project: https://github.com/eldargab/easy-table -// Definitions by: Bart van der Schoor -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - - -declare class EasyTable { - constructor(); - - cell(label: string, value: any, printer?: EasyTable.CellPrinter, width?: number): void; - newRow(): void; - toString(): string; - printTransposed(): string; - print(): string; - sort(fields: string): void; - sort(comparer: (a: any, b: any) => number): void; - total(label: string, accumulator: EasyTable.Accumulator, totalPrinter: EasyTable.CellPrinter): void; -} - -declare namespace EasyTable { - function printArray(array: any[], cellPrinter?: CellPrinter, tablePrinter?: Printer): string; - function printObject(object: any, cellPrinter?: CellPrinter, tablePrinter?: Printer): string; - - //printer helpers - function Number(length: number): CellPrinter; - function RightPadder(char: string): CellPrinter; - function LeftPadder(char: string): CellPrinter; - - interface CellPrinter extends Function { - (obj: any, cell: (label: string, value: any, width?: number) => void): string; - } - interface Printer extends Function { - (table: EasyTable): string; - } - interface Accumulator extends Function { - (sum: number, val: number, index: number, length: number): number; - } -} - -export = EasyTable; diff --git a/electron/electron-tests.ts b/electron/electron-tests.ts index 00b34d60b1..8ae462139a 100644 --- a/electron/electron-tests.ts +++ b/electron/electron-tests.ts @@ -1,7 +1,5 @@ -/// -/// - import electron = require('electron'); import child_process = require('child_process'); -child_process.spawn(electron); +// TODO +child_process.spawn(electron as any); diff --git a/electron/github-electron.d.ts b/electron/github-electron.d.ts deleted file mode 100644 index f87b50b362..0000000000 --- a/electron/github-electron.d.ts +++ /dev/null @@ -1,5765 +0,0 @@ -// Type definitions for Electron v1.4.4 -// Project: http://electron.atom.io/ -// Definitions by: jedmao , rhysd , Milan Burda -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -/// - -declare namespace Electron { - - interface Event { - preventDefault: Function; - sender: NodeJS.EventEmitter; - } - - type Point = { - x: number; - y: number; - } - - type Size = { - width: number; - height: number; - } - - type Rectangle = { - x: number; - y: number; - width: number; - height: number; - } - - interface Destroyable { - /** - * Destroys the object. - */ - destroy(): void; - /** - * @returns Whether the object is destroyed. - */ - isDestroyed(): boolean; - } - - // https://github.com/electron/electron/blob/master/docs/api/app.md - - /** - * The app module is responsible for controlling the application's lifecycle. - */ - interface App extends NodeJS.EventEmitter { - /** - * Emitted when the application has finished basic startup. - * On Windows and Linux, the will-finish-launching event - * is the same as the ready event; on macOS, this event represents - * the applicationWillFinishLaunching notification of NSApplication. - * You would usually set up listeners for the open-file and open-url events here, - * and start the crash reporter and auto updater. - * - * In most cases, you should just do everything in the ready event handler. - */ - on(event: 'will-finish-launching', listener: Function): this; - /** - * Emitted when Electron has finished initialization. - */ - on(event: 'ready', listener: (event: Event, launchInfo: Object) => void): this; - /** - * Emitted when all windows have been closed. - * - * If you do not subscribe to this event and all windows are closed, - * the default behavior is to quit the app; however, if you subscribe, - * you control whether the app quits or not. - * If the user pressed Cmd + Q, or the developer called app.quit(), - * Electron will first try to close all the windows and then emit the will-quit event, - * and in this case the window-all-closed event would not be emitted. - */ - on(event: 'window-all-closed', listener: Function): this; - /** - * Emitted before the application starts closing its windows. - * Calling event.preventDefault() will prevent the default behaviour, which is terminating the application. - */ - on(event: 'before-quit', listener: (event: Event) => void): this; - /** - * Emitted when all windows have been closed and the application will quit. - * Calling event.preventDefault() will prevent the default behaviour, which is terminating the application. - */ - on(event: 'will-quit', listener: (event: Event) => void): this; - /** - * Emitted when the application is quitting. - */ - on(event: 'quit', listener: (event: Event, exitCode: number) => void): this; - /** - * Emitted when the user wants to open a file with the application. - * The open-file event is usually emitted when the application is already open - * and the OS wants to reuse the application to open the file. - * open-file is also emitted when a file is dropped onto the dock and the application - * is not yet running. Make sure to listen for the open-file event very early - * in your application startup to handle this case (even before the ready event is emitted). - * - * You should call event.preventDefault() if you want to handle this event. - * - * Note: This is only implemented on macOS. - */ - on(event: 'open-file', listener: (event: Event, url: string) => void): this; - /** - * Emitted when the user wants to open a URL with the application. - * The URL scheme must be registered to be opened by your application. - * - * You should call event.preventDefault() if you want to handle this event. - * - * Note: This is only implemented on macOS. - */ - on(event: 'open-url', listener: (event: Event, url: string) => void): this; - /** - * Emitted when the application is activated, which usually happens when clicks on the applications’s dock icon. - * Note: This is only implemented on macOS. - */ - on(event: 'activate', listener: Function): this; - /** - * Emitted during Handoff when an activity from a different device wants to be resumed. - * You should call event.preventDefault() if you want to handle this event. - */ - on(event: 'continue-activity', listener: (event: Event, type: string, userInfo: Object) => void): this; - /** - * Emitted when a browserWindow gets blurred. - */ - on(event: 'browser-window-blur', listener: (event: Event, browserWindow: BrowserWindow) => void): this; - /** - * Emitted when a browserWindow gets focused. - */ - on(event: 'browser-window-focus', listener: (event: Event, browserWindow: BrowserWindow) => void): this; - /** - * Emitted when a new browserWindow is created. - */ - on(event: 'browser-window-created', listener: (event: Event, browserWindow: BrowserWindow) => void): this; - /** - * Emitted when a new webContents is created. - */ - on(event: 'web-contents-created', listener: (event: Event, webContents: WebContents) => void): this; - /** - * Emitted when failed to verify the certificate for url, to trust the certificate - * you should prevent the default behavior with event.preventDefault() and call callback(true). - */ - on(event: 'certificate-error', listener: (event: Event, - webContents: WebContents, - url: string, - error: string, - certificate: Certificate, - callback: (trust: boolean) => void - ) => void): this; - /** - * Emitted when a client certificate is requested. - * - * The url corresponds to the navigation entry requesting the client certificate - * and callback needs to be called with an entry filtered from the list. - * Using event.preventDefault() prevents the application from using the first certificate from the store. - */ - on(event: 'select-client-certificate', listener: (event: Event, - webContents: WebContents, - url: string, - certificateList: Certificate[], - callback: (certificate: Certificate) => void - ) => void): this; - /** - * Emitted when webContents wants to do basic auth. - * - * The default behavior is to cancel all authentications, to override this - * you should prevent the default behavior with event.preventDefault() - * and call callback(username, password) with the credentials. - */ - on(event: 'login', listener: (event: Event, - webContents: WebContents, - request: LoginRequest, - authInfo: LoginAuthInfo, - callback: (username: string, password: string) => void - ) => void): this; - /** - * Emitted when the gpu process crashes. - */ - on(event: 'gpu-process-crashed', listener: (event: Event, killed: boolean) => void): this; - /** - * Emitted when Chrome's accessibility support changes. - * - * Note: This API is only available on macOS and Windows. - */ - on(event: 'accessibility-support-changed', listener: (event: Event, accessibilitySupportEnabled: boolean) => void): this; - on(event: string, listener: Function): this; - /** - * Try to close all windows. The before-quit event will first be emitted. - * If all windows are successfully closed, the will-quit event will be emitted - * and by default the application would be terminated. - * - * This method guarantees all beforeunload and unload handlers are correctly - * executed. It is possible that a window cancels the quitting by returning - * false in beforeunload handler. - */ - quit(): void; - /** - * Exits immediately with exitCode. - * All windows will be closed immediately without asking user - * and the before-quit and will-quit events will not be emitted. - */ - exit(exitCode?: number): void; - /** - * Relaunches the app when current instance exits. - * - * By default the new instance will use the same working directory - * and command line arguments with current instance. - * When args is specified, the args will be passed as command line arguments instead. - * When execPath is specified, the execPath will be executed for relaunch instead of current app. - * - * Note that this method does not quit the app when executed, you have to call app.quit - * or app.exit after calling app.relaunch to make the app restart. - * - * When app.relaunch is called for multiple times, multiple instances - * will be started after current instance exited. - */ - relaunch(options?: { - args?: string[], - execPath?: string - }): void; - /** - * @returns Whether Electron has finished initializing. - */ - isReady(): boolean; - /** - * On Linux, focuses on the first visible window. - * On macOS, makes the application the active app. - * On Windows, focuses on the application’s first window. - */ - focus(): void; - /** - * Hides all application windows without minimizing them. - * Note: This is only implemented on macOS. - */ - hide(): void; - /** - * Shows application windows after they were hidden. Does not automatically focus them. - * Note: This is only implemented on macOS. - */ - show(): void; - /** - * Returns the current application directory. - */ - getAppPath(): string; - /** - * @returns The path to a special directory or file associated with name. - * On failure an Error would throw. - */ - getPath(name: AppPathName): string; - /** - * Overrides the path to a special directory or file associated with name. - * If the path specifies a directory that does not exist, the directory will - * be created by this method. On failure an Error would throw. - * - * You can only override paths of names defined in app.getPath. - * - * By default web pages' cookies and caches will be stored under userData - * directory, if you want to change this location, you have to override the - * userData path before the ready event of app module gets emitted. - */ - setPath(name: AppPathName, path: string): void; - /** - * @returns The version of loaded application, if no version is found in - * application's package.json, the version of current bundle or executable. - */ - getVersion(): string; - /** - * @returns The current application's name, the name in package.json would be used. - * Usually the name field of package.json is a short lowercased name, according to - * the spec of npm modules. So usually you should also specify a productName field, - * which is your application's full capitalized name, and it will be preferred over - * name by Electron. - */ - getName(): string; - /** - * Overrides the current application's name. - */ - setName(name: string): void; - /** - * @returns The current application locale. - */ - getLocale(): string; - /** - * Adds path to recent documents list. - * - * This list is managed by the system, on Windows you can visit the list from - * task bar, and on macOS you can visit it from dock menu. - * - * Note: This is only implemented on macOS and Windows. - */ - addRecentDocument(path: string): void; - /** - * Clears the recent documents list. - * - * Note: This is only implemented on macOS and Windows. - */ - clearRecentDocuments(): void; - /** - * Sets the current executable as the default handler for a protocol (aka URI scheme). - * Once registered, all links with your-protocol:// will be opened with the current executable. - * The whole link, including protocol, will be passed to your application as a parameter. - * - * On Windows you can provide optional parameters path, the path to your executable, - * and args, an array of arguments to be passed to your executable when it launches. - * - * @param protocol The name of your protocol, without ://. - * @param path Defaults to process.execPath. - * @param args Defaults to an empty array. - * - * Note: This is only implemented on macOS and Windows. - * On macOS, you can only register protocols that have been added to your app's info.plist. - */ - setAsDefaultProtocolClient(protocol: string, path?: string, args?: string[]): boolean; - /** - * Removes the current executable as the default handler for a protocol (aka URI scheme). - * - * @param protocol The name of your protocol, without ://. - * @param path Defaults to process.execPath. - * @param args Defaults to an empty array. - * - * Note: This is only implemented on macOS and Windows. - */ - removeAsDefaultProtocolClient(protocol: string, path?: string, args?: string[]): boolean; - /** - * @param protocol The name of your protocol, without ://. - * @param path Defaults to process.execPath. - * @param args Defaults to an empty array. - * - * @returns Whether the current executable is the default handler for a protocol (aka URI scheme). - * - * Note: This is only implemented on macOS and Windows. - */ - isDefaultProtocolClient(protocol: string, path?: string, args?: string[]): boolean; - /** - * Adds tasks to the Tasks category of JumpList on Windows. - * - * Note: This API is only available on Windows. - */ - setUserTasks(tasks: Task[]): boolean; - /** - * Note: This API is only available on Windows. - */ - getJumpListSettings(): JumpListSettings; - /** - * Sets or removes a custom Jump List for the application. - * - * If categories is null the previously set custom Jump List (if any) will be replaced - * by the standard Jump List for the app (managed by Windows). - * - * Note: This API is only available on Windows. - */ - setJumpList(categories: JumpListCategory[]): SetJumpListResult; - /** - * This method makes your application a Single Instance Application instead of allowing - * multiple instances of your app to run, this will ensure that only a single instance - * of your app is running, and other instances signal this instance and exit. - */ - makeSingleInstance(callback: (args: string[], workingDirectory: string) => void): boolean; - /** - * Releases all locks that were created by makeSingleInstance. This will allow - * multiple instances of the application to once again run side by side. - */ - releaseSingleInstance(): void; - /** - * Creates an NSUserActivity and sets it as the current activity. - * The activity is eligible for Handoff to another device afterward. - * - * @param type Uniquely identifies the activity. Maps to NSUserActivity.activityType. - * @param userInfo App-specific state to store for use by another device. - * @param webpageURL The webpage to load in a browser if no suitable app is - * installed on the resuming device. The scheme must be http or https. - * - * Note: This API is only available on macOS. - */ - setUserActivity(type: string, userInfo: Object, webpageURL?: string): void; - /** - * @returns The type of the currently running activity. - * - * Note: This API is only available on macOS. - */ - getCurrentActivityType(): string; - /** - * Changes the Application User Model ID to id. - * - * Note: This is only implemented on Windows. - */ - setAppUserModelId(id: string): void; - /** - * Imports the certificate in pkcs12 format into the platform certificate store. - * @param callback Called with the result of import operation, a value of 0 indicates success - * while any other value indicates failure according to chromium net_error_list. - * - * Note: This API is only available on Linux. - */ - importCertificate(options: ImportCertificateOptions, callback: (result: number) => void): void; - /** - * Disables hardware acceleration for current app. - * This method can only be called before app is ready. - */ - disableHardwareAcceleration(): void; - /** - * @returns whether current desktop environment is Unity launcher. (Linux) - * - * Note: This API is only available on Linux. - */ - isUnityRunning(): boolean; - /** - * Returns a Boolean, true if Chrome's accessibility support is enabled, false otherwise. - * This API will return true if the use of assistive technologies, such as screen readers, - * has been detected. - * See https://www.chromium.org/developers/design-documents/accessibility for more details. - * - * Note: This API is only available on macOS and Windows. - */ - isAccessibilitySupportEnabled(): boolean; - /** - * @returns an Object with the login item settings of the app. - * - * Note: This API is only available on macOS and Windows. - */ - getLoginItemSettings(): LoginItemSettings; - /** - * Set the app's login item settings. - * - * Note: This API is only available on macOS and Windows. - */ - setLoginItemSettings(settings: LoginItemSettings): void; - /** - * Set the about panel options. This will override the values defined in the app's .plist file. - * See the Apple docs for more details. - * - * Note: This API is only available on macOS. - */ - setAboutPanelOptions(options: AboutPanelOptions): void; - commandLine: CommandLine; - /** - * Note: This API is only available on macOS. - */ - dock: Dock; - } - - type AppPathName = 'home'|'appData'|'userData'|'temp'|'exe'|'module'|'desktop'|'documents'|'downloads'|'music'|'pictures'|'videos'|'pepperFlashSystemPlugin'; - - interface ImportCertificateOptions { - /** - * Path for the pkcs12 file. - */ - certificate: string; - /** - * Passphrase for the certificate. - */ - password: string; - } - - interface CommandLine { - /** - * Append a switch [with optional value] to Chromium's command line. - * - * Note: This will not affect process.argv, and is mainly used by developers - * to control some low-level Chromium behaviors. - */ - appendSwitch(_switch: string, value?: string): void; - /** - * Append an argument to Chromium's command line. The argument will quoted properly. - * - * Note: This will not affect process.argv. - */ - appendArgument(value: string): void; - } - - interface Dock { - /** - * When critical is passed, the dock icon will bounce until either the - * application becomes active or the request is canceled. - * - * When informational is passed, the dock icon will bounce for one second. - * However, the request remains active until either the application becomes - * active or the request is canceled. - * - * @param type The default is informational. - * @returns An ID representing the request. - */ - bounce(type?: 'critical' | 'informational'): number; - /** - * Cancel the bounce of id. - * - * Note: This API is only available on macOS. - */ - cancelBounce(id: number): void; - /** - * Bounces the Downloads stack if the filePath is inside the Downloads folder. - * - * Note: This API is only available on macOS. - */ - downloadFinished(filePath: string): void; - /** - * Sets the string to be displayed in the dock’s badging area. - * - * Note: This API is only available on macOS. - */ - setBadge(text: string): void; - /** - * Returns the badge string of the dock. - * - * Note: This API is only available on macOS. - */ - getBadge(): string; - /** - * Sets the counter badge for current app. Setting the count to 0 will hide the badge. - * - * @returns True when the call succeeded, otherwise returns false. - * - * Note: This API is only available on macOS and Linux. - */ - setBadgeCount(count: number): boolean; - /** - * @returns The current value displayed in the counter badge. - * - * Note: This API is only available on macOS and Linux. - */ - getBadgeCount(): number; - /** - * Hides the dock icon. - * - * Note: This API is only available on macOS. - */ - hide(): void; - /** - * Shows the dock icon. - * - * Note: This API is only available on macOS. - */ - show(): void; - /** - * @returns Whether the dock icon is visible. - * The app.dock.show() call is asynchronous so this method might not return true immediately after that call. - * - * Note: This API is only available on macOS. - */ - isVisible(): boolean; - /** - * Sets the application dock menu. - * - * Note: This API is only available on macOS. - */ - setMenu(menu: Menu): void; - /** - * Sets the image associated with this dock icon. - * - * Note: This API is only available on macOS. - */ - setIcon(icon: NativeImage | string): void; - } - - interface Task { - /** - * Path of the program to execute, usually you should specify process.execPath - * which opens current program. - */ - program: string; - /** - * The arguments of command line when program is executed. - */ - arguments: string; - /** - * The string to be displayed in a JumpList. - */ - title: string; - /** - * Description of this task. - */ - description?: string; - /** - * The absolute path to an icon to be displayed in a JumpList, it can be - * arbitrary resource file that contains an icon, usually you can specify - * process.execPath to show the icon of the program. - */ - iconPath: string; - /** - * The icon index in the icon file. If an icon file consists of two or more - * icons, set this value to identify the icon. If an icon file consists of - * one icon, this value is 0. - */ - iconIndex?: number; - } - - /** - * ok - Nothing went wrong. - * error - One or more errors occured, enable runtime logging to figure out the likely cause. - * invalidSeparatorError - An attempt was made to add a separator to a custom category in the Jump List. - * Separators are only allowed in the standard Tasks category. - * fileTypeRegistrationError - An attempt was made to add a file link to the Jump List - * for a file type the app isn't registered to handle. - * customCategoryAccessDeniedError - Custom categories can't be added to the Jump List - * due to user privacy or group policy settings. - */ - type SetJumpListResult = 'ok' | 'error' | 'invalidSeparatorError' | 'fileTypeRegistrationError' | 'customCategoryAccessDeniedError'; - - interface JumpListSettings { - /** - * The minimum number of items that will be shown in the Jump List. - */ - minItems: number; - /** - * Items that the user has explicitly removed from custom categories in the Jump List. - */ - removedItems: JumpListItem[]; - } - - interface JumpListCategory { - /** - * tasks - Items in this category will be placed into the standard Tasks category. - * frequent - Displays a list of files frequently opened by the app, the name of the category and its items are set by Windows. - * recent - Displays a list of files recently opened by the app, the name of the category and its items are set by Windows. - * custom - Displays tasks or file links, name must be set by the app. - */ - type?: 'tasks' | 'frequent' | 'recent' | 'custom'; - /** - * Must be set if type is custom, otherwise it should be omitted. - */ - name?: string; - /** - * Array of JumpListItem objects if type is tasks or custom, otherwise it should be omitted. - */ - items?: JumpListItem[]; - } - - interface JumpListItem { - /** - * task - A task will launch an app with specific arguments. - * separator - Can be used to separate items in the standard Tasks category. - * file - A file link will open a file using the app that created the Jump List. - */ - type: 'task' | 'separator' | 'file'; - /** - * Path of the file to open, should only be set if type is file. - */ - path?: string; - /** - * Path of the program to execute, usually you should specify process.execPath which opens the current program. - * Should only be set if type is task. - */ - program?: string; - /** - * The command line arguments when program is executed. Should only be set if type is task. - */ - args?: string; - /** - * The text to be displayed for the item in the Jump List. Should only be set if type is task. - */ - title?: string; - /** - * Description of the task (displayed in a tooltip). Should only be set if type is task. - */ - description?: string; - /** - * The absolute path to an icon to be displayed in a Jump List, which can be an arbitrary - * resource file that contains an icon (e.g. .ico, .exe, .dll). - * You can usually specify process.execPath to show the program icon. - */ - iconPath?: string; - /** - * The index of the icon in the resource file. If a resource file contains multiple icons - * this value can be used to specify the zero-based index of the icon that should be displayed - * for this task. If a resource file contains only one icon, this property should be set to zero. - */ - iconIndex?: number; - } - - interface LoginItemSettings { - /** - * True if the app is set to open at login. - */ - openAtLogin: boolean; - /** - * True if the app is set to open as hidden at login. This setting is only supported on macOS. - */ - openAsHidden: boolean; - /** - * True if the app was opened at login automatically. This setting is only supported on macOS. - */ - wasOpenedAtLogin?: boolean; - /** - * True if the app was opened as a hidden login item. This indicates that the app should not - * open any windows at startup. This setting is only supported on macOS. - */ - wasOpenedAsHidden?: boolean; - /** - * True if the app was opened as a login item that should restore the state from the previous session. - * This indicates that the app should restore the windows that were open the last time the app was closed. - * This setting is only supported on macOS. - */ - restoreState?: boolean; - } - - interface AboutPanelOptions { - /** - * The app's name. - */ - applicationName?: string; - /** - * The app's version. - */ - applicationVersion?: string; - /** - * Copyright information. - */ - copyright?: string; - /** - * Credit information. - */ - credits?: string; - /** - * The app's build version number. - */ - version?: string; - } - - // https://github.com/electron/electron/blob/master/docs/api/auto-updater.md - - /** - * This module provides an interface for the Squirrel auto-updater framework. - */ - interface AutoUpdater extends NodeJS.EventEmitter { - /** - * Emitted when there is an error while updating. - */ - on(event: 'error', listener: (error: Error) => void): this; - /** - * Emitted when checking if an update has started. - */ - on(event: 'checking-for-update', listener: Function): this; - /** - * Emitted when there is an available update. The update is downloaded automatically. - */ - on(event: 'update-available', listener: Function): this; - /** - * Emitted when there is no available update. - */ - on(event: 'update-not-available', listener: Function): this; - /** - * Emitted when an update has been downloaded. - * Note: On Windows only releaseName is available. - */ - on(event: 'update-downloaded', listener: (event: Event, releaseNotes: string, releaseName: string, releaseDate: Date, updateURL: string) => void): this; - on(event: string, listener: Function): this; - /** - * Set the url and initialize the auto updater. - */ - setFeedURL(url: string, requestHeaders?: Headers): void; - /** - * @returns The current update feed URL. - */ - getFeedURL(): string; - /** - * Ask the server whether there is an update, you have to call setFeedURL - * before using this API - */ - checkForUpdates(): void; - /** - * Restarts the app and installs the update after it has been downloaded. - * It should only be called after update-downloaded has been emitted. - */ - quitAndInstall(): void; - } - - // https://github.com/electron/electron/blob/master/docs/api/browser-window.md - - /** - * The BrowserWindow class gives you ability to create a browser window. - * You can also create a window without chrome by using Frameless Window API. - */ - class BrowserWindow extends NodeJS.EventEmitter implements Destroyable { - /** - * Emitted when the document changed its title, - * calling event.preventDefault() would prevent the native window’s title to change. - */ - on(event: 'page-title-updated', listener: (event: Event, title: string) => void): this; - /** - * Emitted when the window is going to be closed. It’s emitted before the beforeunload - * and unload event of the DOM. Calling event.preventDefault() will cancel the close. - */ - on(event: 'close', listener: (event: Event) => void): this; - /** - * Emitted when the window is closed. After you have received this event - * you should remove the reference to the window and avoid using it anymore. - */ - on(event: 'closed', listener: Function): this; - /** - * Emitted when the web page becomes unresponsive. - */ - on(event: 'unresponsive', listener: Function): this; - /** - * Emitted when the unresponsive web page becomes responsive again. - */ - on(event: 'responsive', listener: Function): this; - /** - * Emitted when the window loses focus. - */ - on(event: 'blur', listener: Function): this; - /** - * Emitted when the window gains focus. - */ - on(event: 'focus', listener: Function): this; - /** - * Emitted when the window is shown. - */ - on(event: 'show', listener: Function): this; - /** - * Emitted when the window is hidden. - */ - on(event: 'hide', listener: Function): this; - /** - * Emitted when the web page has been rendered and window can be displayed without visual flash. - */ - on(event: 'ready-to-show', listener: Function): this; - /** - * Emitted when window is maximized. - */ - on(event: 'maximize', listener: Function): this; - /** - * Emitted when the window exits from maximized state. - */ - on(event: 'unmaximize', listener: Function): this; - /** - * Emitted when the window is minimized. - */ - on(event: 'minimize', listener: Function): this; - /** - * Emitted when the window is restored from minimized state. - */ - on(event: 'restore', listener: Function): this; - /** - * Emitted when the window is getting resized. - */ - on(event: 'resize', listener: Function): this; - /** - * Emitted when the window is getting moved to a new position. - */ - on(event: 'move', listener: Function): this; - /** - * Emitted when the window enters full screen state. - */ - on(event: 'enter-full-screen', listener: Function): this; - /** - * Emitted when the window leaves full screen state. - */ - on(event: 'leave-full-screen', listener: Function): this; - /** - * Emitted when the window enters full screen state triggered by HTML API. - */ - on(event: 'enter-html-full-screen', listener: Function): this; - /** - * Emitted when the window leaves full screen state triggered by HTML API. - */ - on(event: 'leave-html-full-screen', listener: Function): this; - /** - * Emitted when an App Command is invoked. These are typically related - * to keyboard media keys or browser commands, as well as the "Back" / - * "Forward" buttons built into some mice on Windows. - * Note: This is only implemented on Windows. - */ - on(event: 'app-command', listener: (event: Event, command: string) => void): this; - /** - * Emitted when scroll wheel event phase has begun. - * Note: This is only implemented on macOS. - */ - on(event: 'scroll-touch-begin', listener: Function): this; - /** - * Emitted when scroll wheel event phase has ended. - * Note: This is only implemented on macOS. - */ - on(event: 'scroll-touch-end', listener: Function): this; - /** - * Emitted when scroll wheel event phase filed upon reaching the edge of element. - * Note: This is only implemented on macOS. - */ - on(event: 'scroll-touch-edge', listener: Function): this; - /** - * Emitted on 3-finger swipe. - * Note: This is only implemented on macOS. - */ - on(event: 'swipe', listener: (event: Event, direction: SwipeDirection) => void): this; - on(event: string, listener: Function): this; - /** - * Creates a new BrowserWindow with native properties as set by the options. - */ - constructor(options?: BrowserWindowOptions); - /** - * @returns All opened browser windows. - */ - static getAllWindows(): BrowserWindow[]; - /** - * @returns The window that is focused in this application. - */ - static getFocusedWindow(): BrowserWindow; - /** - * Find a window according to the webContents it owns. - */ - static fromWebContents(webContents: WebContents): BrowserWindow; - /** - * Find a window according to its ID. - */ - static fromId(id: number): BrowserWindow; - /** - * Adds devtools extension located at path. The extension will be remembered - * so you only need to call this API once, this API is not for programming use. - * @returns The extension's name. - * - * Note: This API cannot be called before the ready event of the app module is emitted. - */ - static addDevToolsExtension(path: string): string; - /** - * Remove a devtools extension. - * @param name The name of the devtools extension to remove. - * - * Note: This API cannot be called before the ready event of the app module is emitted. - */ - static removeDevToolsExtension(name: string): void; - /** - * @returns devtools extensions. - * - * Note: This API cannot be called before the ready event of the app module is emitted. - */ - static getDevToolsExtensions(): DevToolsExtensions; - /** - * The WebContents object this window owns, all web page related events and - * operations would be done via it. - * Note: Users should never store this object because it may become null when - * the renderer process (web page) has crashed. - */ - webContents: WebContents; - /** - * Get the unique ID of this window. - */ - id: number; - /** - * Force closing the window, the unload and beforeunload event won't be emitted - * for the web page, and close event would also not be emitted for this window, - * but it would guarantee the closed event to be emitted. - * You should only use this method when the renderer process (web page) has crashed. - */ - destroy(): void; - /** - * Try to close the window, this has the same effect with user manually clicking - * the close button of the window. The web page may cancel the close though, - * see the close event. - */ - close(): void; - /** - * Focus on the window. - */ - focus(): void; - /** - * Remove focus on the window. - */ - blur(): void; - /** - * @returns Whether the window is focused. - */ - isFocused(): boolean; - /** - * @returns Whether the window is destroyed. - */ - isDestroyed(): boolean; - /** - * Shows and gives focus to the window. - */ - show(): void; - /** - * Shows the window but doesn't focus on it. - */ - showInactive(): void; - /** - * Hides the window. - */ - hide(): void; - /** - * @returns Whether the window is visible to the user. - */ - isVisible(): boolean; - /** - * @returns Whether the window is a modal window. - */ - isModal(): boolean; - /** - * Maximizes the window. - */ - maximize(): void; - /** - * Unmaximizes the window. - */ - unmaximize(): void; - /** - * @returns Whether the window is maximized. - */ - isMaximized(): boolean; - /** - * Minimizes the window. On some platforms the minimized window will be - * shown in the Dock. - */ - minimize(): void; - /** - * Restores the window from minimized state to its previous state. - */ - restore(): void; - /** - * @returns Whether the window is minimized. - */ - isMinimized(): boolean; - /** - * Sets whether the window should be in fullscreen mode. - */ - setFullScreen(flag: boolean): void; - /** - * @returns Whether the window is in fullscreen mode. - */ - isFullScreen(): boolean; - /** - * This will have a window maintain an aspect ratio. - * The extra size allows a developer to have space, specified in pixels, - * not included within the aspect ratio calculations. - * This API already takes into account the difference between a window’s size and its content size. - * - * Note: This API is available only on macOS. - */ - setAspectRatio(aspectRatio: number, extraSize?: Size): void; - /** - * Resizes and moves the window to width, height, x, y. - */ - setBounds(options: Rectangle, animate?: boolean): void; - /** - * @returns The window's width, height, x and y values. - */ - getBounds(): Rectangle; - /** - * Resizes and moves the window's client area (e.g. the web page) to width, height, x, y. - */ - setContentBounds(options: Rectangle, animate?: boolean): void; - /** - * @returns The window's client area (e.g. the web page) width, height, x and y values. - */ - getContentBounds(): Rectangle; - /** - * Resizes the window to width and height. - */ - setSize(width: number, height: number, animate?: boolean): void; - /** - * @returns The window's width and height. - */ - getSize(): number[]; - /** - * Resizes the window's client area (e.g. the web page) to width and height. - */ - setContentSize(width: number, height: number, animate?: boolean): void; - /** - * @returns The window's client area's width and height. - */ - getContentSize(): number[]; - /** - * Sets the minimum size of window to width and height. - */ - setMinimumSize(width: number, height: number): void; - /** - * @returns The window's minimum width and height. - */ - getMinimumSize(): number[]; - /** - * Sets the maximum size of window to width and height. - */ - setMaximumSize(width: number, height: number): void; - /** - * @returns The window's maximum width and height. - */ - getMaximumSize(): number[]; - /** - * Sets whether the window can be manually resized by user. - */ - setResizable(resizable: boolean): void; - /** - * @returns Whether the window can be manually resized by user. - */ - isResizable(): boolean; - /** - * Sets whether the window can be moved by user. On Linux does nothing. - * Note: This API is available only on macOS and Windows. - */ - setMovable(movable: boolean): void; - /** - * Note: This API is available only on macOS and Windows. - * @returns Whether the window can be moved by user. On Linux always returns true. - */ - isMovable(): boolean; - /** - * Sets whether the window can be manually minimized by user. On Linux does nothing. - * Note: This API is available only on macOS and Windows. - */ - setMinimizable(minimizable: boolean): void; - /** - * Note: This API is available only on macOS and Windows. - * @returns Whether the window can be manually minimized by user. On Linux always returns true. - */ - isMinimizable(): boolean; - /** - * Sets whether the window can be manually maximized by user. On Linux does nothing. - * Note: This API is available only on macOS and Windows. - */ - setMaximizable(maximizable: boolean): void; - /** - * Note: This API is available only on macOS and Windows. - * @returns Whether the window can be manually maximized by user. On Linux always returns true. - */ - isMaximizable(): boolean; - /** - * Sets whether the maximize/zoom window button toggles fullscreen mode or maximizes the window. - */ - setFullScreenable(fullscreenable: boolean): void; - /** - * @returns Whether the maximize/zoom window button toggles fullscreen mode or maximizes the window. - */ - isFullScreenable(): boolean; - /** - * Sets whether the window can be manually closed by user. On Linux does nothing. - * Note: This API is available only on macOS and Windows. - */ - setClosable(closable: boolean): void; - /** - * Note: This API is available only on macOS and Windows. - * @returns Whether the window can be manually closed by user. On Linux always returns true. - */ - isClosable(): boolean; - /** - * Sets whether the window should show always on top of other windows. After - * setting this, the window is still a normal window, not a toolbox window - * which can not be focused on. - */ - setAlwaysOnTop(flag: boolean, level?: WindowLevel): void; - /** - * @returns Whether the window is always on top of other windows. - */ - isAlwaysOnTop(): boolean; - /** - * Moves window to the center of the screen. - */ - center(): void; - /** - * Moves window to x and y. - */ - setPosition(x: number, y: number, animate?: boolean): void; - /** - * @returns The window's current position. - */ - getPosition(): number[]; - /** - * Changes the title of native window to title. - */ - setTitle(title: string): void; - /** - * Note: The title of web page can be different from the title of the native window. - * @returns The title of the native window. - */ - getTitle(): string; - /** - * Changes the attachment point for sheets on macOS. - * Note: This API is available only on macOS. - */ - setSheetOffset(offsetY: number, offsetX?: number): void; - /** - * Starts or stops flashing the window to attract user's attention. - */ - flashFrame(flag: boolean): void; - /** - * Makes the window do not show in Taskbar. - */ - setSkipTaskbar(skip: boolean): void; - /** - * Enters or leaves the kiosk mode. - */ - setKiosk(flag: boolean): void; - /** - * @returns Whether the window is in kiosk mode. - */ - isKiosk(): boolean; - /** - * The native type of the handle is HWND on Windows, NSView* on macOS, - * and Window (unsigned long) on Linux. - * @returns The platform-specific handle of the window as Buffer. - */ - getNativeWindowHandle(): Buffer; - /** - * Hooks a windows message. The callback is called when the message is received in the WndProc. - * Note: This API is available only on Windows. - */ - hookWindowMessage(message: number, callback: Function): void; - /** - * @returns Whether the message is hooked. - */ - isWindowMessageHooked(message: number): boolean; - /** - * Unhook the window message. - */ - unhookWindowMessage(message: number): void; - /** - * Unhooks all of the window messages. - */ - unhookAllWindowMessages(): void; - /** - * Sets the pathname of the file the window represents, and the icon of the - * file will show in window's title bar. - * Note: This API is available only on macOS. - */ - setRepresentedFilename(filename: string): void; - /** - * Note: This API is available only on macOS. - * @returns The pathname of the file the window represents. - */ - getRepresentedFilename(): string; - /** - * Specifies whether the window’s document has been edited, and the icon in - * title bar will become grey when set to true. - * Note: This API is available only on macOS. - */ - setDocumentEdited(edited: boolean): void; - /** - * Note: This API is available only on macOS. - * @returns Whether the window's document has been edited. - */ - isDocumentEdited(): boolean; - focusOnWebView(): void; - blurWebView(): void; - /** - * Captures the snapshot of page within rect, upon completion the callback - * will be called. Omitting the rect would capture the whole visible page. - * Note: Be sure to read documents on remote buffer in remote if you are going - * to use this API in renderer process. - * @param callback Supplies the image that stores data of the snapshot. - */ - capturePage(rect: Rectangle, callback: (image: NativeImage) => void): void; - /** - * Captures the snapshot of page within rect, upon completion the callback - * will be called. Omitting the rect would capture the whole visible page. - * Note: Be sure to read documents on remote buffer in remote if you are going - * to use this API in renderer process. - * @param callback Supplies the image that stores data of the snapshot. - */ - capturePage(callback: (image: NativeImage) => void): void; - /** - * Same as webContents.loadURL(url). - */ - loadURL(url: string, options?: LoadURLOptions): void; - /** - * Same as webContents.reload. - */ - reload(): void; - /** - * Sets the menu as the window top menu. - * Note: This API is not available on macOS. - */ - setMenu(menu: Menu): void; - /** - * Sets the progress value in the progress bar. - * On Linux platform, only supports Unity desktop environment, you need to - * specify the *.desktop file name to desktopName field in package.json. - * By default, it will assume app.getName().desktop. - * @param progress Valid range is [0, 1.0]. If < 0, the progress bar is removed. - * If greater than 0, it becomes indeterminate. - */ - setProgressBar(progress: number, options?: { - /** - * Mode for the progress bar. - * Note: This is only implemented on Windows. - */ - mode: 'none' | 'normal' | 'indeterminate' | 'error' | 'paused' - }): void; - /** - * Sets a 16px overlay onto the current Taskbar icon, usually used to convey - * some sort of application status or to passively notify the user. - * Note: This API is only available on Windows 7 or above. - * @param overlay The icon to display on the bottom right corner of the Taskbar - * icon. If this parameter is null, the overlay is cleared - * @param description Provided to Accessibility screen readers. - */ - setOverlayIcon(overlay: NativeImage, description: string): void; - /** - * Sets whether the window should have a shadow. On Windows and Linux does nothing. - * Note: This API is available only on macOS. - */ - setHasShadow(hasShadow: boolean): void; - /** - * Note: This API is available only on macOS. - * @returns whether the window has a shadow. On Windows and Linux always returns true. - */ - hasShadow(): boolean; - /** - * Add a thumbnail toolbar with a specified set of buttons to the thumbnail image - * of a window in a taskbar button layout. - * @returns Whether the thumbnail has been added successfully. - * - * Note: This API is available only on Windows. - */ - setThumbarButtons(buttons: ThumbarButton[]): boolean; - /** - * Sets the region of the window to show as the thumbnail image displayed when hovering - * over the window in the taskbar. You can reset the thumbnail to be the entire window - * by specifying an empty region: {x: 0, y: 0, width: 0, height: 0}. - * - * Note: This API is available only on Windows. - */ - setThumbnailClip(region: Rectangle): boolean; - /** - * Sets the toolTip that is displayed when hovering over the window thumbnail in the taskbar. - * Note: This API is available only on Windows. - */ - setThumbnailToolTip(toolTip: string): boolean; - /** - * Same as webContents.showDefinitionForSelection(). - * Note: This API is available only on macOS. - */ - showDefinitionForSelection(): void; - /** - * Changes window icon. - * Note: This API is not available on macOS. - */ - setIcon(icon: NativeImage): void; - /** - * Sets whether the window menu bar should hide itself automatically. Once set - * the menu bar will only show when users press the single Alt key. - * If the menu bar is already visible, calling setAutoHideMenuBar(true) won't - * hide it immediately. - */ - setAutoHideMenuBar(hide: boolean): void; - /** - * @returns Whether menu bar automatically hides itself. - */ - isMenuBarAutoHide(): boolean; - /** - * Sets whether the menu bar should be visible. If the menu bar is auto-hide, - * users can still bring up the menu bar by pressing the single Alt key. - */ - setMenuBarVisibility(visibile: boolean): void; - /** - * @returns Whether the menu bar is visible. - */ - isMenuBarVisible(): boolean; - /** - * Sets whether the window should be visible on all workspaces. - * Note: This API does nothing on Windows. - */ - setVisibleOnAllWorkspaces(visible: boolean): void; - /** - * Note: This API always returns false on Windows. - * @returns Whether the window is visible on all workspaces. - */ - isVisibleOnAllWorkspaces(): boolean; - /** - * Makes the window ignore all mouse events. - * - * All mouse events happened in this window will be passed to the window below this window, - * but if this window has focus, it will still receive keyboard events. - */ - setIgnoreMouseEvents(ignore: boolean): void; - /** - * Prevents the window contents from being captured by other apps. - * - * On macOS it sets the NSWindow's sharingType to NSWindowSharingNone. - * On Windows it calls SetWindowDisplayAffinity with WDA_MONITOR. - */ - setContentProtection(enable: boolean): void; - /** - * Changes whether the window can be focused. - * Note: This API is available only on Windows. - */ - setFocusable(focusable: boolean): void; - /** - * Sets parent as current window's parent window, - * passing null will turn current window into a top-level window. - * Note: This API is not available on Windows. - */ - setParentWindow(parent: BrowserWindow): void; - /** - * @returns The parent window. - */ - getParentWindow(): BrowserWindow; - /** - * @returns All child windows. - */ - getChildWindows(): BrowserWindow[]; - } - - type WindowLevel = 'normal' | 'floating' | 'torn-off-menu' | 'modal-panel' | 'main-menu' | 'status' | 'pop-up-menu' | 'screen-saver' | 'dock'; - type SwipeDirection = 'up' | 'right' | 'down' | 'left'; - type ThumbarButtonFlags = 'enabled' | 'disabled' | 'dismissonclick' | 'nobackground' | 'hidden' | 'noninteractive'; - - interface ThumbarButton { - icon: NativeImage | string; - click: Function; - tooltip?: string; - flags?: ThumbarButtonFlags[]; - } - - interface DevToolsExtensions { - [name: string]: { - name: string; - value: string; - } - } - - interface WebPreferences { - /** - * Whether to enable DevTools. - * If it is set to false, can not use BrowserWindow.webContents.openDevTools() to open DevTools. - * Default: true. - */ - devTools?: boolean; - /** - * Whether node integration is enabled. - * Default: true. - */ - nodeIntegration?: boolean; - /** - * Specifies a script that will be loaded before other scripts run in the page. - * This script will always have access to node APIs no matter whether node integration is turned on or off. - * The value should be the absolute file path to the script. - * When node integration is turned off, the preload script can reintroduce - * Node global symbols back to the global scope. - */ - preload?: string; - /** - * Sets the session used by the page. Instead of passing the Session object directly, - * you can also choose to use the partition option instead, which accepts a partition string. - * When both session and partition are provided, session would be preferred. - * Default: the default session. - */ - session?: Session; - /** - * Sets the session used by the page according to the session’s partition string. - * If partition starts with persist:, the page will use a persistent session available - * to all pages in the app with the same partition. if there is no persist: prefix, - * the page will use an in-memory session. By assigning the same partition, - * multiple pages can share the same session. - * Default: the default session. - */ - partition?: string; - /** - * The default zoom factor of the page, 3.0 represents 300%. - * Default: 1.0. - */ - zoomFactor?: number; - /** - * Enables JavaScript support. - * Default: true. - */ - javascript?: boolean; - /** - * When setting false, it will disable the same-origin policy (Usually using testing - * websites by people), and set allowDisplayingInsecureContent and allowRunningInsecureContent - * to true if these two options are not set by user. - * Default: true. - */ - webSecurity?: boolean; - /** - * Allow an https page to display content like images from http URLs. - * Default: false. - */ - allowDisplayingInsecureContent?: boolean; - /** - * Allow a https page to run JavaScript, CSS or plugins from http URLs. - * Default: false. - */ - allowRunningInsecureContent?: boolean; - /** - * Enables image support. - * Default: true. - */ - images?: boolean; - /** - * Make TextArea elements resizable. - * Default: true. - */ - textAreasAreResizable?: boolean; - /** - * Enables WebGL support. - * Default: true. - */ - webgl?: boolean; - /** - * Enables WebAudio support. - * Default: true. - */ - webaudio?: boolean; - /** - * Whether plugins should be enabled. - * Default: false. - */ - plugins?: boolean; - /** - * Enables Chromium’s experimental features. - * Default: false. - */ - experimentalFeatures?: boolean; - /** - * Enables Chromium’s experimental canvas features. - * Default: false. - */ - experimentalCanvasFeatures?: boolean; - /** - * Enables DirectWrite font rendering system on Windows. - * Default: true. - */ - directWrite?: boolean; - /** - * Enables scroll bounce (rubber banding) effect on macOS. - * Default: false. - */ - scrollBounce?: boolean; - /** - * A list of feature strings separated by ",", like CSSVariables,KeyboardEventKey to enable. - */ - blinkFeatures?: string; - /** - * A list of feature strings separated by ",", like CSSVariables,KeyboardEventKey to disable. - */ - disableBlinkFeatures?: string; - /** - * Sets the default font for the font-family. - */ - defaultFontFamily?: { - /** - * Default: Times New Roman. - */ - standard?: string; - /** - * Default: Times New Roman. - */ - serif?: string; - /** - * Default: Arial. - */ - sansSerif?: string; - /** - * Default: Courier New. - */ - monospace?: string; - }; - /** - * Default: 16. - */ - defaultFontSize?: number; - /** - * Default: 13. - */ - defaultMonospaceFontSize?: number; - /** - * Default: 0. - */ - minimumFontSize?: number; - /** - * Default: ISO-8859-1. - */ - defaultEncoding?: string; - /** - * Whether to throttle animations and timers when the page becomes background. - * Default: true. - */ - backgroundThrottling?: boolean; - /** - * Whether to enable offscreen rendering for the browser window. - * Default: false. - */ - offscreen?: boolean; - /** - * Whether to enable Chromium OS-level sandbox. - * Default: false. - */ - sandbox?: boolean; - } - - interface BrowserWindowOptions { - /** - * Window’s width in pixels. - * Default: 800. - */ - width?: number; - /** - * Window’s height in pixels. - * Default: 600. - */ - height?: number; - /** - * Window’s left offset from screen. - * Default: center the window. - */ - x?: number; - /** - * Window’s top offset from screen. - * Default: center the window. - */ - y?: number; - /** - * The width and height would be used as web page’s size, which means - * the actual window’s size will include window frame’s size and be slightly larger. - * Default: false. - */ - useContentSize?: boolean; - /** - * Show window in the center of the screen. - * Default: true - */ - center?: boolean; - /** - * Window’s minimum width. - * Default: 0. - */ - minWidth?: number; - /** - * Window’s minimum height. - * Default: 0. - */ - minHeight?: number; - /** - * Window’s maximum width. - * Default: no limit. - */ - maxWidth?: number; - /** - * Window’s maximum height. - * Default: no limit. - */ - maxHeight?: number; - /** - * Whether window is resizable. - * Default: true. - */ - resizable?: boolean; - /** - * Whether window is movable. - * Note: This is not implemented on Linux. - * Default: true. - */ - movable?: boolean; - /** - * Whether window is minimizable. - * Note: This is not implemented on Linux. - * Default: true. - */ - minimizable?: boolean; - /** - * Whether window is maximizable. - * Note: This is not implemented on Linux. - * Default: true. - */ - maximizable?: boolean; - /** - * Whether window is closable. - * Note: This is not implemented on Linux. - * Default: true. - */ - closable?: boolean; - /** - * Whether the window can be focused. - * On Windows setting focusable: false also implies setting skipTaskbar: true. - * On Linux setting focusable: false makes the window stop interacting with wm, - * so the window will always stay on top in all workspaces. - * Default: true. - */ - focusable?: boolean; - /** - * Whether the window should always stay on top of other windows. - * Default: false. - */ - alwaysOnTop?: boolean; - /** - * Whether the window should show in fullscreen. - * When explicitly set to false the fullscreen button will be hidden or disabled on macOS. - * Default: false. - */ - fullscreen?: boolean; - /** - * Whether the window can be put into fullscreen mode. - * On macOS, also whether the maximize/zoom button should toggle full screen mode or maximize window. - * Default: true. - */ - fullscreenable?: boolean; - /** - * Whether to show the window in taskbar. - * Default: false. - */ - skipTaskbar?: boolean; - /** - * The kiosk mode. - * Default: false. - */ - kiosk?: boolean; - /** - * Default window title. - * Default: "Electron". - */ - title?: string; - /** - * The window icon, when omitted on Windows the executable’s icon would be used as window icon. - */ - icon?: NativeImage|string; - /** - * Whether window should be shown when created. - * Default: true. - */ - show?: boolean; - /** - * Specify false to create a Frameless Window. - * Default: true. - */ - frame?: boolean; - /** - * Specify parent window. - * Default: null. - */ - parent?: BrowserWindow; - /** - * Whether this is a modal window. This only works when the window is a child window. - * Default: false. - */ - modal?: boolean; - /** - * Whether the web view accepts a single mouse-down event that simultaneously activates the window. - * Default: false. - */ - acceptFirstMouse?: boolean; - /** - * Whether to hide cursor when typing. - * Default: false. - */ - disableAutoHideCursor?: boolean; - /** - * Auto hide the menu bar unless the Alt key is pressed. - * Default: true. - */ - autoHideMenuBar?: boolean; - /** - * Enable the window to be resized larger than screen. - * Default: false. - */ - enableLargerThanScreen?: boolean; - /** - * Window’s background color as Hexadecimal value, like #66CD00 or #FFF or #80FFFFFF (alpha is supported). - * Default: #FFF (white). - */ - backgroundColor?: string; - /** - * Whether window should have a shadow. - * Note: This is only implemented on macOS. - * Default: true. - */ - hasShadow?: boolean; - /** - * Forces using dark theme for the window. - * Note: Only works on some GTK+3 desktop environments. - * Default: false. - */ - darkTheme?: boolean; - /** - * Makes the window transparent. - * Default: false. - */ - transparent?: boolean; - /** - * The type of window, default is normal window. - */ - type?: BrowserWindowType; - /** - * The style of window title bar. - */ - titleBarStyle?: 'default' | 'hidden' | 'hidden-inset'; - /** - * Use WS_THICKFRAME style for frameless windows on Windows - */ - thickFrame?: boolean; - /** - * Settings of web page’s features. - */ - webPreferences?: WebPreferences; - } - - type BrowserWindowType = BrowserWindowTypeLinux | BrowserWindowTypeMac | BrowserWindowTypeWindows; - type BrowserWindowTypeLinux = 'desktop' | 'dock' | 'toolbar' | 'splash' | 'notification'; - type BrowserWindowTypeMac = 'desktop' | 'textured'; - type BrowserWindowTypeWindows = 'toolbar'; - - // https://github.com/electron/electron/blob/master/docs/api/clipboard.md - - /** - * The clipboard module provides methods to perform copy and paste operations. - */ - interface Clipboard { - /** - * @returns The contents of the clipboard as plain text. - */ - readText(type?: ClipboardType): string; - /** - * Writes the text into the clipboard as plain text. - */ - writeText(text: string, type?: ClipboardType): void; - /** - * @returns The contents of the clipboard as markup. - */ - readHTML(type?: ClipboardType): string; - /** - * Writes markup to the clipboard. - */ - writeHTML(markup: string, type?: ClipboardType): void; - /** - * @returns The contents of the clipboard as a NativeImage. - */ - readImage(type?: ClipboardType): NativeImage; - /** - * Writes the image into the clipboard. - */ - writeImage(image: NativeImage, type?: ClipboardType): void; - /** - * @returns The contents of the clipboard as RTF. - */ - readRTF(type?: ClipboardType): string; - /** - * Writes the text into the clipboard in RTF. - */ - writeRTF(text: string, type?: ClipboardType): void; - /** - * Clears everything in clipboard. - */ - clear(type?: ClipboardType): void; - /** - * @returns Array available formats for the clipboard type. - */ - availableFormats(type?: ClipboardType): string[]; - /** - * Returns whether the clipboard supports the format of specified data. - * Note: This API is experimental and could be removed in future. - * @returns Whether the clipboard has data in the specified format. - */ - has(format: string, type?: ClipboardType): boolean; - /** - * Reads the data in the clipboard of the specified format. - * Note: This API is experimental and could be removed in future. - */ - read(format: string, type?: ClipboardType): string | NativeImage; - /** - * Writes data to the clipboard. - */ - write(data: { - text?: string; - rtf?: string; - html?: string; - image?: NativeImage; - }, type?: ClipboardType): void; - /** - * @returns An Object containing title and url keys representing the bookmark in the clipboard. - * - * Note: This API is available on macOS and Windows. - */ - readBookmark(): Bookmark; - /** - * Writes the title and url into the clipboard as a bookmark. - * - * Note: This API is available on macOS and Windows. - */ - writeBookmark(title: string, url: string, type?: ClipboardType): void; - } - - type ClipboardType = '' | 'selection'; - - interface Bookmark { - title: string; - url: string; - } - - // https://github.com/electron/electron/blob/master/docs/api/content-tracing.md - - /** - * The content-tracing module is used to collect tracing data generated by the underlying Chromium content module. - * This module does not include a web interface so you need to open chrome://tracing/ - * in a Chrome browser and load the generated file to view the result. - */ - interface ContentTracing { - /** - * Get a set of category groups. The category groups can change as new code paths are reached. - * - * @param callback Called once all child processes have acknowledged the getCategories request. - */ - getCategories(callback: (categoryGroups: string[]) => void): void; - /** - * Start recording on all processes. Recording begins immediately locally and asynchronously - * on child processes as soon as they receive the EnableRecording request. - * - * @param callback Called once all child processes have acknowledged the startRecording request. - */ - startRecording(options: ContentTracingOptions, callback: Function): void; - /** - * Stop recording on all processes. Child processes typically are caching trace data and - * only rarely flush and send trace data back to the main process. That is because it may - * be an expensive operation to send the trace data over IPC, and we would like to avoid - * much runtime overhead of tracing. So, to end tracing, we must asynchronously ask all - * child processes to flush any pending trace data. - * - * @param resultFilePath Trace data will be written into this file if it is not empty, - * or into a temporary file. - * @param callback Called once all child processes have acknowledged the stopRecording request. - */ - stopRecording(resultFilePath: string, callback: (filePath: string) => void): void; - /** - * Start monitoring on all processes. Monitoring begins immediately locally and asynchronously - * on child processes as soon as they receive the startMonitoring request. - * - * @param callback Called once all child processes have acked to the startMonitoring request. - */ - startMonitoring(options: ContentTracingOptions, callback: Function): void; - /** - * Stop monitoring on all processes. - * - * @param callback Called once all child processes have acknowledged the stopMonitoring request. - */ - stopMonitoring(callback: Function): void; - /** - * Get the current monitoring traced data. Child processes typically are caching trace data - * and only rarely flush and send trace data back to the main process. That is because it may - * be an expensive operation to send the trace data over IPC, and we would like to avoid much - * runtime overhead of tracing. So, to end tracing, we must asynchronously ask all child - * processes to flush any pending trace data. - * - * @param callback Called once all child processes have acknowledged the captureMonitoringSnapshot request. - */ - captureMonitoringSnapshot(resultFilePath: string, callback: (filePath: string) => void): void; - /** - * Get the maximum usage across processes of trace buffer as a percentage of the full state. - * - * @param callback Called when the TraceBufferUsage value is determined. - */ - getTraceBufferUsage(callback: Function): void; - /** - * @param callback Called every time the given event occurs on any process. - */ - setWatchEvent(categoryName: string, eventName: string, callback: Function): void; - /** - * Cancel the watch event. This may lead to a race condition with the watch event callback if tracing is enabled. - */ - cancelWatchEvent(): void; - } - - interface ContentTracingOptions { - /** - * Filter to control what category groups should be traced. - * A filter can have an optional - prefix to exclude category groups - * that contain a matching category. Having both included and excluded - * category patterns in the same list is not supported. - * - * Examples: - * test_MyTest* - * test_MyTest*,test_OtherStuff - * -excluded_category1,-excluded_category2 - */ - categoryFilter: string; - /** - * Controls what kind of tracing is enabled, it is a comma-delimited list. - * - * Possible options are: - * record-until-full - * record-continuously - * trace-to-console - * enable-sampling - * enable-systrace - * - * The first 3 options are trace recoding modes and hence mutually exclusive. - * If more than one trace recording modes appear in the traceOptions string, - * the last one takes precedence. If none of the trace recording modes are specified, - * recording mode is record-until-full. - * - * The trace option will first be reset to the default option (record_mode set - * to record-until-full, enable_sampling and enable_systrace set to false) - * before options parsed from traceOptions are applied on it. - */ - traceOptions: string; - } - - // https://github.com/electron/electron/blob/master/docs/api/crash-reporter.md - - /** - * The crash-reporter module enables sending your app's crash reports. - */ - interface CrashReporter { - /** - * You are required to call this method before using other crashReporter APIs. - * - * Note: On macOS, Electron uses a new crashpad client, which is different from breakpad - * on Windows and Linux. To enable the crash collection feature, you are required to call - * the crashReporter.start API to initialize crashpad in the main process and in each - * renderer process from which you wish to collect crash reports. - */ - start(options: CrashReporterStartOptions): void; - /** - * @returns The crash report. When there was no crash report - * sent or the crash reporter is not started, null will be returned. - */ - getLastCrashReport(): CrashReport; - /** - * @returns All uploaded crash reports. - */ - getUploadedReports(): CrashReport[]; - } - - interface CrashReporterStartOptions { - /** - * Default: app.getName() - */ - productName?: string; - companyName: string; - /** - * URL that crash reports would be sent to as POST. - */ - submitURL: string; - /** - * Send the crash report without user interaction. - * Default: true. - */ - autoSubmit?: boolean; - /** - * Default: false. - */ - ignoreSystemCrashHandler?: boolean; - /** - * An object you can define that will be sent along with the report. - * Only string properties are sent correctly, nested objects are not supported. - */ - extra?: {[prop: string]: string}; - } - - interface CrashReport { - id: string; - date: Date; - } - - // https://github.com/electron/electron/blob/master/docs/api/desktop-capturer.md - - /** - * The desktopCapturer module can be used to get available sources - * that can be used to be captured with getUserMedia. - */ - interface DesktopCapturer { - /** - * Starts a request to get all desktop sources. - * - * Note: There is no guarantee that the size of source.thumbnail is always - * the same as the thumnbailSize in options. It also depends on the scale of the screen or window. - */ - getSources(options: DesktopCapturerOptions, callback: (error: Error, sources: DesktopCapturerSource[]) => any): void; - } - - interface DesktopCapturerOptions { - /** - * The types of desktop sources to be captured. - */ - types?: ('screen' | 'window')[]; - /** - * The suggested size that thumbnail should be scaled. - * Default: {width: 150, height: 150} - */ - thumbnailSize?: Size; - } - - interface DesktopCapturerSource { - /** - * The id of the captured window or screen used in navigator.webkitGetUserMedia. - * The format looks like window:XX or screen:XX where XX is a random generated number. - */ - id: string; - /** - * The described name of the capturing screen or window. - * If the source is a screen, the name will be Entire Screen or Screen ; - * if it is a window, the name will be the window’s title. - */ - name: string; - /** - * A thumbnail image. - */ - thumbnail: NativeImage; - } - - // https://github.com/electron/electron/blob/master/docs/api/dialog.md - - /** - * The dialog module provides APIs to show native system dialogs, such as opening files or alerting, - * so web applications can deliver the same user experience as native applications. - */ - interface Dialog { - /** - * Note: On Windows and Linux an open dialog can not be both a file selector and a directory selector, - * so if you set properties to ['openFile', 'openDirectory'] on these platforms, a directory selector will be shown. - * - * @param callback If supplied, the API call will be asynchronous. - * @returns On success, returns an array of file paths chosen by the user, - * otherwise returns undefined. - */ - showOpenDialog(browserWindow: BrowserWindow, options: OpenDialogOptions, callback?: (fileNames: string[]) => void): string[]; - /** - * Note: On Windows and Linux an open dialog can not be both a file selector and a directory selector, - * so if you set properties to ['openFile', 'openDirectory'] on these platforms, a directory selector will be shown. - * - * @param callback If supplied, the API call will be asynchronous. - * @returns On success, returns an array of file paths chosen by the user, - * otherwise returns undefined. - */ - showOpenDialog(options: OpenDialogOptions, callback?: (fileNames: string[]) => void): string[]; - /** - * @param callback If supplied, the API call will be asynchronous. - * @returns On success, returns the path of file chosen by the user, otherwise - * returns undefined. - */ - showSaveDialog(browserWindow: BrowserWindow, options: SaveDialogOptions, callback?: (fileName: string) => void): string; - /** - * @param callback If supplied, the API call will be asynchronous. - * @returns On success, returns the path of file chosen by the user, otherwise - * returns undefined. - */ - showSaveDialog(options: SaveDialogOptions, callback?: (fileName: string) => void): string; - /** - * Shows a message box. It will block until the message box is closed. - * @param callback If supplied, the API call will be asynchronous. - * @returns The index of the clicked button. - */ - showMessageBox(browserWindow: BrowserWindow, options: ShowMessageBoxOptions, callback?: (response: number) => void): number; - /** - * Shows a message box. It will block until the message box is closed. - * @param callback If supplied, the API call will be asynchronous. - * @returns The index of the clicked button. - */ - showMessageBox(options: ShowMessageBoxOptions, callback?: (response: number) => void): number; - /** - * Displays a modal dialog that shows an error message. - * - * This API can be called safely before the ready event the app module emits, - * it is usually used to report errors in early stage of startup. - * If called before the app readyevent on Linux, the message will be emitted to stderr, - * and no GUI dialog will appear. - */ - showErrorBox(title: string, content: string): void; - } - - interface OpenDialogOptions { - title?: string; - defaultPath?: string; - /** - * Custom label for the confirmation button, when left empty the default label will be used. - */ - buttonLabel?: string; - /** - * File types that can be displayed or selected. - */ - filters?: { - name: string; - /** - * Extensions without wildcards or dots (e.g. 'png' is good but '.png' and '*.png' are bad). - * To show all files, use the '*' wildcard (no other wildcard is supported). - */ - extensions: string[]; - }[]; - /** - * Contains which features the dialog should use. - */ - properties?: ('openFile' | 'openDirectory' | 'multiSelections' | 'createDirectory' | 'showHiddenFiles')[]; - } - - interface SaveDialogOptions { - title?: string; - defaultPath?: string; - /** - * Custom label for the confirmation button, when left empty the default label will be used. - */ - buttonLabel?: string; - /** - * File types that can be displayed, see dialog.showOpenDialog for an example. - */ - filters?: { - name: string; - extensions: string[]; - }[]; - } - - interface ShowMessageBoxOptions { - /** - * On Windows, "question" displays the same icon as "info", unless you set an icon using the "icon" option. - */ - type?: 'none' | 'info' | 'error' | 'question' | 'warning'; - /** - * Texts for buttons. On Windows, an empty array will result in one button labeled "OK". - */ - buttons?: string[]; - /** - * Index of the button in the buttons array which will be selected by default when the message box opens. - */ - defaultId?: number; - /** - * Title of the message box (some platforms will not show it). - */ - title?: string; - /** - * Contents of the message box. - */ - message?: string; - /** - * Extra information of the message. - */ - detail?: string; - icon?: NativeImage; - /** - * The value will be returned when user cancels the dialog instead of clicking the buttons of the dialog. - * By default it is the index of the buttons that have "cancel" or "no" as label, - * or 0 if there is no such buttons. On macOS and Windows the index of "Cancel" button - * will always be used as cancelId, not matter whether it is already specified. - */ - cancelId?: number; - /** - * On Windows Electron will try to figure out which one of the buttons are common buttons - * (like "Cancel" or "Yes"), and show the others as command links in the dialog. - * This can make the dialog appear in the style of modern Windows apps. - * If you don’t like this behavior, you can set noLink to true. - */ - noLink?: boolean; - } - - // https://github.com/electron/electron/blob/master/docs/api/download-item.md - - /** - * DownloadItem represents a download item in Electron. - */ - interface DownloadItem extends NodeJS.EventEmitter { - /** - * Emitted when the download has been updated and is not done. - */ - on(event: 'updated', listener: (event: Event, state: 'progressing' | 'interrupted') => void): this; - /** - * Emits when the download is in a terminal state. This includes a completed download, - * a cancelled download (via downloadItem.cancel()), and interrupted download that can’t be resumed. - */ - on(event: 'done', listener: (event: Event, state: 'completed' | 'cancelled' | 'interrupted') => void): this; - on(event: string, listener: Function): this; - /** - * Set the save file path of the download item. - * Note: The API is only available in session’s will-download callback function. - * If user doesn’t set the save path via the API, Electron will use the original - * routine to determine the save path (Usually prompts a save dialog). - */ - setSavePath(path: string): void; - /** - * @returns The save path of the download item. - * This will be either the path set via downloadItem.setSavePath(path) or the path selected from the shown save dialog. - */ - getSavePath(): string; - /** - * Pauses the download. - */ - pause(): void; - /** - * @returns Whether the download is paused. - */ - isPaused(): boolean; - /** - * Resumes the download that has been paused. - */ - resume(): void; - /** - * @returns Whether the download can resume. - */ - canResume(): boolean; - /** - * Cancels the download operation. - */ - cancel(): void; - /** - * @returns The origin url where the item is downloaded from. - */ - getURL(): string; - /** - * @returns The mime type. - */ - getMimeType(): string; - /** - * @returns Whether the download has user gesture. - */ - hasUserGesture(): boolean; - /** - * @returns The file name of the download item. - * Note: The file name is not always the same as the actual one saved in local disk. - * If user changes the file name in a prompted download saving dialog, - * the actual name of saved file will be different. - */ - getFilename(): string; - /** - * @returns The total size in bytes of the download item. If the size is unknown, it returns 0. - */ - getTotalBytes(): number; - /** - * @returns The received bytes of the download item. - */ - getReceivedBytes(): number; - /** - * @returns The Content-Disposition field from the response header. - */ - getContentDisposition(): string; - /** - * @returns The current state. - */ - getState(): 'progressing' | 'completed' | 'cancelled' | 'interrupted'; - } - - // https://github.com/electron/electron/blob/master/docs/api/global-shortcut.md - - /** - * The globalShortcut module can register/unregister a global keyboard shortcut - * with the operating system so that you can customize the operations for various shortcuts. - * Note: The shortcut is global; it will work even if the app does not have the keyboard focus. - * You should not use this module until the ready event of the app module is emitted. - */ - interface GlobalShortcut { - /** - * Registers a global shortcut of accelerator. - * @param accelerator Represents a keyboard shortcut. It can contain modifiers - * and key codes, combined by the "+" character. - * @param callback Called when the registered shortcut is pressed by the user. - */ - register(accelerator: string, callback: Function): void; - /** - * @param accelerator Represents a keyboard shortcut. It can contain modifiers - * and key codes, combined by the "+" character. - * @returns Whether the accelerator is registered. - */ - isRegistered(accelerator: string): boolean; - /** - * Unregisters the global shortcut of keycode. - * @param accelerator Represents a keyboard shortcut. It can contain modifiers - * and key codes, combined by the "+" character. - */ - unregister(accelerator: string): void; - /** - * Unregisters all the global shortcuts. - */ - unregisterAll(): void; - } - - // https://github.com/electron/electron/blob/master/docs/api/ipc-main.md - - /** - * The ipcMain module handles asynchronous and synchronous messages - * sent from a renderer process (web page). - * Messages sent from a renderer will be emitted to this module. - */ - interface IpcMain extends NodeJS.EventEmitter { - addListener(channel: string, listener: IpcMainEventListener): this; - on(channel: string, listener: IpcMainEventListener): this; - once(channel: string, listener: IpcMainEventListener): this; - removeListener(channel: string, listener: IpcMainEventListener): this; - removeAllListeners(channel?: string): this; - } - - type IpcMainEventListener = (event: IpcMainEvent, ...args: any[]) => void; - - interface IpcMainEvent { - /** - * Set this to the value to be returned in a synchronous message. - */ - returnValue?: any; - /** - * Returns the webContents that sent the message, you can call sender.send - * to reply to the asynchronous message. - */ - sender: WebContents; - } - - // https://github.com/electron/electron/blob/master/docs/api/ipc-renderer.md - - /** - * The ipcRenderer module provides a few methods so you can send synchronous - * and asynchronous messages from the render process (web page) to the main process. - * You can also receive replies from the main process. - */ - interface IpcRenderer extends NodeJS.EventEmitter { - addListener(channel: string, listener: IpcRendererEventListener): this; - on(channel: string, listener: IpcRendererEventListener): this; - once(channel: string, listener: IpcRendererEventListener): this; - removeListener(channel: string, listener: IpcRendererEventListener): this; - removeAllListeners(channel?: string): this; - /** - * Send ...args to the renderer via channel in asynchronous message, the main - * process can handle it by listening to the channel event of ipc module. - */ - send(channel: string, ...args: any[]): void; - /** - * Send ...args to the renderer via channel in synchronous message, and returns - * the result sent from main process. The main process can handle it by listening - * to the channel event of ipc module, and returns by setting event.returnValue. - * Note: Usually developers should never use this API, since sending synchronous - * message would block the whole renderer process. - * @returns The result sent from the main process. - */ - sendSync(channel: string, ...args: any[]): any; - /** - * Like ipc.send but the message will be sent to the host page instead of the main process. - * This is mainly used by the page in to communicate with host page. - */ - sendToHost(channel: string, ...args: any[]): void; - } - - type IpcRendererEventListener = (event: IpcRendererEvent, ...args: any[]) => void; - - interface IpcRendererEvent { - /** - * You can call sender.send to reply to the asynchronous message. - */ - sender: IpcRenderer; - } - - // https://github.com/electron/electron/blob/master/docs/api/menu-item.md - // https://github.com/electron/electron/blob/master/docs/api/accelerator.md - - /** - * The MenuItem allows you to add items to an application or context menu. - */ - class MenuItem { - /** - * Create a new menu item. - */ - constructor(options: MenuItemOptions); - - click: (menuItem: MenuItem, browserWindow: BrowserWindow, event: Event) => void; - /** - * Read-only property. - */ - type: MenuItemType; - /** - * Read-only property. - */ - role: MenuItemRole | MenuItemRoleMac; - /** - * Read-only property. - */ - accelerator: string; - /** - * Read-only property. - */ - icon: NativeImage | string; - /** - * Read-only property. - */ - submenu: Menu | MenuItemOptions[]; - - label: string; - sublabel: string; - enabled: boolean; - visible: boolean; - checked: boolean; - } - - type MenuItemType = 'normal' | 'separator' | 'submenu' | 'checkbox' | 'radio'; - type MenuItemRole = 'undo' | 'redo' | 'cut' | 'copy' | 'paste' | 'pasteandmatchstyle' | 'selectall' | 'delete' | 'minimize' | 'close' | 'quit' | 'togglefullscreen' | 'resetzoom' | 'zoomin' | 'zoomout'; - type MenuItemRoleMac = 'about' | 'hide' | 'hideothers' | 'unhide' | 'startspeaking' | 'stopspeaking' | 'front' | 'zoom' | 'window' | 'help' | 'services'; - - interface MenuItemOptions { - /** - * Callback when the menu item is clicked. - */ - click?: (menuItem: MenuItem, browserWindow: BrowserWindow) => void; - /** - * Can be normal, separator, submenu, checkbox or radio. - */ - type?: MenuItemType; - label?: string; - sublabel?: string; - /** - * An accelerator is string that represents a keyboard shortcut, it can contain - * multiple modifiers and key codes, combined by the + character. - * - * Examples: - * CommandOrControl+A - * CommandOrControl+Shift+Z - * - * Platform notice: - * On Linux and Windows, the Command key would not have any effect, - * you can use CommandOrControl which represents Command on macOS and Control on - * Linux and Windows to define some accelerators. - * - * Use Alt instead of Option. The Option key only exists on macOS, whereas - * the Alt key is available on all platforms. - * - * The Super key is mapped to the Windows key on Windows and Linux and Cmd on macOS. - * - * Available modifiers: - * Command (or Cmd for short) - * Control (or Ctrl for short) - * CommandOrControl (or CmdOrCtrl for short) - * Alt - * Option - * AltGr - * Shift - * Super - * - * Available key codes: - * 0 to 9 - * A to Z - * F1 to F24 - * Punctuations like ~, !, @, #, $, etc. - * Plus - * Space - * Tab - * Backspace - * Delete - * Insert - * Return (or Enter as alias) - * Up, Down, Left and Right - * Home and End - * PageUp and PageDown - * Escape (or Esc for short) - * VolumeUp, VolumeDown and VolumeMute - * MediaNextTrack, MediaPreviousTrack, MediaStop and MediaPlayPause - * PrintScreen - */ - accelerator?: string; - /** - * In Electron for the APIs that take images, you can pass either file paths - * or NativeImage instances. When passing null, an empty image will be used. - */ - icon?: NativeImage|string; - /** - * If false, the menu item will be greyed out and unclickable. - */ - enabled?: boolean; - /** - * If false, the menu item will be entirely hidden. - */ - visible?: boolean; - /** - * Should only be specified for 'checkbox' or 'radio' type menu items. - */ - checked?: boolean; - /** - * Should be specified for submenu type menu item, when it's specified the - * type: 'submenu' can be omitted for the menu item - */ - submenu?: Menu|MenuItemOptions[]; - /** - * Unique within a single menu. If defined then it can be used as a reference - * to this item by the position attribute. - */ - id?: string; - /** - * This field allows fine-grained definition of the specific location within - * a given menu. - */ - position?: string; - /** - * Define the action of the menu item, when specified the click property will be ignored - */ - role?: MenuItemRole | MenuItemRoleMac; - } - - // https://github.com/electron/electron/blob/master/docs/api/menu.md - - /** - * The Menu class is used to create native menus that can be used as application - * menus and context menus. This module is a main process module which can be used - * in a render process via the remote module. - * - * Each menu consists of multiple menu items, and each menu item can have a submenu. - */ - class Menu extends NodeJS.EventEmitter { - /** - * Creates a new menu. - */ - constructor(); - /** - * Sets menu as the application menu on macOS. On Windows and Linux, the menu - * will be set as each window's top menu. - */ - static setApplicationMenu(menu: Menu): void; - /** - * @returns The application menu if set, or null if not set. - */ - static getApplicationMenu(): Menu; - /** - * Sends the action to the first responder of application. - * This is used for emulating default Cocoa menu behaviors, - * usually you would just use the role property of MenuItem. - * - * Note: This method is macOS only. - */ - static sendActionToFirstResponder(action: string): void; - /** - * @param template Generally, just an array of options for constructing MenuItem. - * You can also attach other fields to element of the template, and they will - * become properties of the constructed menu items. - */ - static buildFromTemplate(template: MenuItemOptions[]): Menu; - /** - * Pops up this menu as a context menu in the browserWindow. You can optionally - * provide a (x,y) coordinate to place the menu at, otherwise it will be placed - * at the current mouse cursor position. - * @param x Horizontal coordinate where the menu will be placed. - * @param y Vertical coordinate where the menu will be placed. - */ - popup(browserWindow?: BrowserWindow, x?: number, y?: number): void; - /** - * Appends the menuItem to the menu. - */ - append(menuItem: MenuItem): void; - /** - * Inserts the menuItem to the pos position of the menu. - */ - insert(position: number, menuItem: MenuItem): void; - /** - * @returns an array containing the menu’s items. - */ - items: MenuItem[]; - } - - // https://github.com/electron/electron/blob/master/docs/api/native-image.md - - /** - * This class is used to represent an image. - */ - class NativeImage { - /** - * Creates an empty NativeImage instance. - */ - static createEmpty(): NativeImage; - /** - * Creates a new NativeImage instance from file located at path. - * This method returns an empty image if the path does not exist, cannot be read, or is not a valid image. - */ - static createFromPath(path: string): NativeImage; - /** - * Creates a new NativeImage instance from buffer. - * @param scaleFactor 1.0 by default. - */ - static createFromBuffer(buffer: Buffer, scaleFactor?: number): NativeImage; - /** - * Creates a new NativeImage instance from dataURL - */ - static createFromDataURL(dataURL: string): NativeImage; - /** - * @returns Buffer that contains the image's PNG encoded data. - */ - toPNG(): Buffer; - /** - * @returns Buffer that contains the image's JPEG encoded data. - */ - toJPEG(quality: number): Buffer; - /** - * @returns Buffer that contains a copy of the image's raw bitmap pixel data. - */ - toBitmap(): Buffer; - /** - * @returns Buffer that contains the image's raw bitmap pixel data. - * - * The difference between getBitmap() and toBitmap() is, getBitmap() does not copy the bitmap data, - * so you have to use the returned Buffer immediately in current event loop tick, - * otherwise the data might be changed or destroyed. - */ - getBitmap(): Buffer; - /** - * @returns The data URL of the image. - */ - toDataURL(): string; - /** - * The native type of the handle is NSImage* on macOS. - * Note: This is only implemented on macOS. - * @returns The platform-specific handle of the image as Buffer. - */ - getNativeHandle(): Buffer; - /** - * @returns Whether the image is empty. - */ - isEmpty(): boolean; - /** - * @returns The size of the image. - */ - getSize(): Size; - /** - * Marks the image as template image. - */ - setTemplateImage(option: boolean): void; - /** - * Returns a boolean whether the image is a template image. - */ - isTemplateImage(): boolean; - /** - * @param rect The area of the image to crop - * @returns The cropped image. - */ - crop(rect: Rectangle): NativeImage; - /** - * @returns The resized image. - * If only the height or the width are specified then the current aspect ratio will be preserved in the resized image. - */ - resize(options: { - width?: number; - height?: number; - /** - * The desired quality of the resized image. - * Default: best. - */ - quality?: 'good' | 'better' | 'best'; - }): NativeImage; - /** - * @returns The image's aspect ratio. - */ - getAspectRatio(): number; - } - - // https://github.com/electron/electron/blob/master/docs/api/power-monitor.md - - /** - * The power-monitor module is used to monitor power state changes. - * You should not use this module until the ready event of the app module is emitted. - */ - interface PowerMonitor extends NodeJS.EventEmitter { - /** - * Emitted when the system is suspending. - */ - on(event: 'suspend', listener: Function): this; - /** - * Emitted when system is resuming. - */ - on(event: 'resume', listener: Function): this; - /** - * Emitted when the system changes to AC power. - */ - on(event: 'on-ac', listener: Function): this; - /** - * Emitted when system changes to battery power. - */ - on(event: 'on-battery', listener: Function): this; - on(event: string, listener: Function): this; - } - - // https://github.com/electron/electron/blob/master/docs/api/power-save-blocker.md - - /** - * The powerSaveBlocker module is used to block the system from entering - * low-power (sleep) mode and thus allowing the app to keep the system and screen active. - */ - interface PowerSaveBlocker { - /** - * Starts preventing the system from entering lower-power mode. - * @returns The blocker ID that is assigned to this power blocker. - * Note: prevent-display-sleep has higher has precedence over prevent-app-suspension. - */ - start(type: 'prevent-app-suspension' | 'prevent-display-sleep'): number; - /** - * @param id The power save blocker id returned by powerSaveBlocker.start. - * Stops the specified power save blocker. - */ - stop(id: number): void; - /** - * @param id The power save blocker id returned by powerSaveBlocker.start. - * @returns Whether the corresponding powerSaveBlocker has started. - */ - isStarted(id: number): boolean; - } - - // https://github.com/electron/electron/blob/master/docs/api/protocol.md - - /** - * The protocol module can register a custom protocol or intercept an existing protocol. - */ - interface Protocol { - /** - * Registers custom schemes as standard schemes. - */ - registerStandardSchemes(schemes: string[]): void; - /** - * Registers custom schemes to handle service workers. - */ - registerServiceWorkerSchemes(schemes: string[]): void; - /** - * Registers a protocol of scheme that will send the file as a response. - */ - registerFileProtocol(scheme: string, handler: FileProtocolHandler, completion?: (error: Error) => void): void; - /** - * Registers a protocol of scheme that will send a Buffer as a response. - */ - registerBufferProtocol(scheme: string, handler: BufferProtocolHandler, completion?: (error: Error) => void): void; - /** - * Registers a protocol of scheme that will send a String as a response. - */ - registerStringProtocol(scheme: string, handler: StringProtocolHandler, completion?: (error: Error) => void): void; - /** - * Registers a protocol of scheme that will send an HTTP request as a response. - */ - registerHttpProtocol(scheme: string, handler: HttpProtocolHandler, completion?: (error: Error) => void): void; - /** - * Unregisters the custom protocol of scheme. - */ - unregisterProtocol(scheme: string, completion?: (error: Error) => void): void; - /** - * The callback will be called with a boolean that indicates whether there is already a handler for scheme. - */ - isProtocolHandled(scheme: string, callback: (handled: boolean) => void): void; - /** - * Intercepts scheme protocol and uses handler as the protocol’s new handler which sends a file as a response. - */ - interceptFileProtocol(scheme: string, handler: FileProtocolHandler, completion?: (error: Error) => void): void; - /** - * Intercepts scheme protocol and uses handler as the protocol’s new handler which sends a Buffer as a response. - */ - interceptBufferProtocol(scheme: string, handler: BufferProtocolHandler, completion?: (error: Error) => void): void; - /** - * Intercepts scheme protocol and uses handler as the protocol’s new handler which sends a String as a response. - */ - interceptStringProtocol(scheme: string, handler: StringProtocolHandler, completion?: (error: Error) => void): void; - /** - * Intercepts scheme protocol and uses handler as the protocol’s new handler which sends a new HTTP request as a response. - */ - interceptHttpProtocol(scheme: string, handler: HttpProtocolHandler, completion?: (error: Error) => void): void; - /** - * Remove the interceptor installed for scheme and restore its original handler. - */ - uninterceptProtocol(scheme: string, completion?: (error: Error) => void): void; - } - - type FileProtocolHandler = (request: ProtocolRequest, callback: FileProtocolCallback) => void; - type BufferProtocolHandler = (request: ProtocolRequest, callback: BufferProtocolCallback) => void; - type StringProtocolHandler = (request: ProtocolRequest, callback: StringProtocolCallback) => void; - type HttpProtocolHandler = (request: ProtocolRequest, callback: HttpProtocolCallback) => void; - - interface ProtocolRequest { - url: string; - referrer: string; - method: string; - uploadData?: { - /** - * Content being sent. - */ - bytes: Buffer, - /** - * Path of file being uploaded. - */ - file: string, - /** - * UUID of blob data. Use session.getBlobData method to retrieve the data. - */ - blobUUID: string; - }[]; - } - - interface ProtocolCallback { - (error: number): void; - (obj: { - error: number - }): void; - (): void; - } - - interface FileProtocolCallback extends ProtocolCallback { - (filePath: string): void; - (obj: { - path: string - }): void; - } - - interface BufferProtocolCallback extends ProtocolCallback { - (buffer: Buffer): void; - (obj: { - data: Buffer, - mimeType: string, - charset?: string - }): void; - } - - interface StringProtocolCallback extends ProtocolCallback { - (str: string): void; - (obj: { - data: Buffer, - mimeType: string, - charset?: string - }): void; - } - - interface HttpProtocolCallback extends ProtocolCallback { - (redirectRequest: { - url: string; - method: string; - session?: Object; - uploadData?: { - contentType: string; - data: string; - }; - }): void; - } - - // https://github.com/electron/electron/blob/master/docs/api/remote.md - - /** - * The remote module provides a simple way to do inter-process communication (IPC) - * between the renderer process (web page) and the main process. - */ - interface Remote extends CommonElectron { - /** - * @returns The object returned by require(module) in the main process. - */ - require(module: string): any; - /** - * @returns The BrowserWindow object which this web page belongs to. - */ - getCurrentWindow(): BrowserWindow; - /** - * @returns The WebContents object of this web page. - */ - getCurrentWebContents(): WebContents; - /** - * @returns The global variable of name (e.g. global[name]) in the main process. - */ - getGlobal(name: string): any; - /** - * Returns the process object in the main process. This is the same as - * remote.getGlobal('process'), but gets cached. - */ - process: NodeJS.Process; - } - - // https://github.com/electron/electron/blob/master/docs/api/screen.md - - /** - * The Display object represents a physical display connected to the system. - * A fake Display may exist on a headless system, or a Display may correspond to a remote, virtual display. - */ - interface Display { - /** - * Unique identifier associated with the display. - */ - id: number; - bounds: Rectangle; - workArea: Rectangle; - size: Size; - workAreaSize: Size; - /** - * Output device’s pixel scale factor. - */ - scaleFactor: number; - /** - * Can be 0, 90, 180, 270, represents screen rotation in clock-wise degrees. - */ - rotation: number; - touchSupport: 'available' | 'unavailable' | 'unknown'; - } - - type DisplayMetrics = 'bounds' | 'workArea' | 'scaleFactor' | 'rotation'; - - /** - * The screen module retrieves information about screen size, displays, cursor position, etc. - * You can not use this module until the ready event of the app module is emitted. - */ - interface Screen extends NodeJS.EventEmitter { - /** - * Emitted when newDisplay has been added. - */ - on(event: 'display-added', listener: (event: Event, newDisplay: Display) => void): this; - /** - * Emitted when oldDisplay has been removed. - */ - on(event: 'display-removed', listener: (event: Event, oldDisplay: Display) => void): this; - /** - * Emitted when one or more metrics change in a display. - */ - on(event: 'display-metrics-changed', listener: (event: Event, display: Display, changedMetrics: DisplayMetrics[]) => void): this; - on(event: string, listener: Function): this; - /** - * @returns The current absolute position of the mouse pointer. - */ - getCursorScreenPoint(): Point; - /** - * @returns The primary display. - */ - getPrimaryDisplay(): Display; - /** - * @returns An array of displays that are currently available. - */ - getAllDisplays(): Display[]; - /** - * @returns The display nearest the specified point. - */ - getDisplayNearestPoint(point: Point): Display; - /** - * @returns The display that most closely intersects the provided bounds. - */ - getDisplayMatching(rect: Rectangle): Display; - } - - // https://github.com/electron/electron/blob/master/docs/api/session.md - - /** - * The session module can be used to create new Session objects. - * You can also access the session of existing pages by using - * the session property of webContents which is a property of BrowserWindow. - */ - class Session extends NodeJS.EventEmitter { - /** - * @returns a new Session instance from partition string. - */ - static fromPartition(partition: string, options?: FromPartitionOptions): Session; - /** - * @returns the default session object of the app. - */ - static defaultSession: Session; - /** - * Emitted when Electron is about to download item in webContents. - * Calling event.preventDefault() will cancel the download - * and item will not be available from next tick of the process. - */ - on(event: 'will-download', listener: (event: Event, item: DownloadItem, webContents: WebContents) => void): this; - on(event: string, listener: Function): this; - /** - * The cookies gives you ability to query and modify cookies. - */ - cookies: SessionCookies; - /** - * @returns the session’s current cache size. - */ - getCacheSize(callback: (size: number) => void): void; - /** - * Clears the session’s HTTP cache. - */ - clearCache(callback: Function): void; - /** - * Clears the data of web storages. - */ - clearStorageData(callback: Function): void; - /** - * Clears the data of web storages. - */ - clearStorageData(options: ClearStorageDataOptions, callback: Function): void; - /** - * Writes any unwritten DOMStorage data to disk. - */ - flushStorageData(): void; - /** - * Sets the proxy settings. - */ - setProxy(config: ProxyConfig, callback: Function): void; - /** - * Resolves the proxy information for url. - */ - resolveProxy(url: URL, callback: (proxy: string) => void): void; - /** - * Sets download saving directory. - * By default, the download directory will be the Downloads under the respective app folder. - */ - setDownloadPath(path: string): void; - /** - * Emulates network with the given configuration for the session. - */ - enableNetworkEmulation(options: NetworkEmulationOptions): void; - /** - * Disables any network emulation already active for the session. - * Resets to the original network configuration. - */ - disableNetworkEmulation(): void; - /** - * Sets the certificate verify proc for session, the proc will be called - * whenever a server certificate verification is requested. - * - * Calling setCertificateVerifyProc(null) will revert back to default certificate verify proc. - */ - setCertificateVerifyProc(proc: (hostname: string, cert: Certificate, callback: (accepted: boolean) => void) => void): void; - /** - * Sets the handler which can be used to respond to permission requests for the session. - */ - setPermissionRequestHandler(handler: (webContents: WebContents, permission: Permission, callback: (allow: boolean) => void) => void): void; - /** - * Clears the host resolver cache. - */ - clearHostResolverCache(callback: Function): void; - /** - * Dynamically sets whether to always send credentials for HTTP NTLM or Negotiate authentication. - * @param domains Comma-seperated list of servers for which integrated authentication is enabled. - */ - allowNTLMCredentialsForDomains(domains: string): void; - /** - * Overrides the userAgent and acceptLanguages for this session. - * The acceptLanguages must a comma separated ordered list of language codes, for example "en-US,fr,de,ko,zh-CN,ja". - * This doesn't affect existing WebContents, and each WebContents can use webContents.setUserAgent to override the session-wide user agent. - */ - setUserAgent(userAgent: string, acceptLanguages?: string): void; - /** - * @returns The user agent for this session. - */ - getUserAgent(): string; - /** - * Returns the blob data associated with the identifier. - */ - getBlobData(identifier: string, callback: (result: Buffer) => void): void; - /** - * The webRequest API set allows to intercept and modify contents of a request at various stages of its lifetime. - */ - webRequest: WebRequest; - /** - * @returns An instance of protocol module for this session. - */ - protocol: Protocol; - } - - type Permission = 'media' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal'; - - interface FromPartitionOptions { - /** - * Whether to enable cache. - */ - cache?: boolean; - } - - interface ClearStorageDataOptions { - /** - * Should follow window.location.origin’s representation scheme://host:port. - */ - origin?: string; - /** - * The types of storages to clear. - */ - storages?: ('appcache' | 'cookies' | 'filesystem' | 'indexdb' | 'localstorage' | 'shadercache' | 'websql' | 'serviceworkers')[]; - /** - * The types of quotas to clear. - */ - quotas?: ('temporary' | 'persistent' | 'syncable')[]; - } - - interface ProxyConfig { - /** - * The URL associated with the PAC file. - */ - pacScript: string; - /** - * Rules indicating which proxies to use. - */ - proxyRules: string; - /** - * Rules indicating which URLs should bypass the proxy settings. - */ - proxyBypassRules: string; - } - - interface NetworkEmulationOptions { - /** - * Whether to emulate network outage. - * Default: false. - */ - offline?: boolean; - /** - * RTT in ms. - * Default: 0, which will disable latency throttling. - */ - latency?: number; - /** - * Download rate in Bps. - * Default: 0, which will disable download throttling. - */ - downloadThroughput?: number; - /** - * Upload rate in Bps. - * Default: 0, which will disable upload throttling. - */ - uploadThroughput?: number; - } - - interface CookieFilter { - /** - * Retrieves cookies which are associated with url. Empty implies retrieving cookies of all urls. - */ - url?: string; - /** - * Filters cookies by name. - */ - name?: string; - /** - * Retrieves cookies whose domains match or are subdomains of domains. - */ - domain?: string; - /** - * Retrieves cookies whose path matches path. - */ - path?: string; - /** - * Filters cookies by their Secure property. - */ - secure?: boolean; - /** - * Filters out session or persistent cookies. - */ - session?: boolean; - } - - interface Cookie { - /** - * Emitted when a cookie is changed because it was added, edited, removed, or expired. - */ - on(event: 'changed', listener: (event: Event, cookie: Cookie, cause: CookieChangedCause) => void): this; - on(event: string, listener: Function): this; - /** - * The name of the cookie. - */ - name: string; - /** - * The value of the cookie. - */ - value: string; - /** - * The domain of the cookie. - */ - domain: string; - /** - * Whether the cookie is a host-only cookie. - */ - hostOnly: string; - /** - * The path of the cookie. - */ - path: string; - /** - * Whether the cookie is marked as secure. - */ - secure: boolean; - /** - * Whether the cookie is marked as HTTP only. - */ - httpOnly: boolean; - /** - * Whether the cookie is a session cookie or a persistent cookie with an expiration date. - */ - session: boolean; - /** - * The expiration date of the cookie as the number of seconds since the UNIX epoch. - * Not provided for session cookies. - */ - expirationDate?: number; - } - - type CookieChangedCause = 'explicit' | 'overwrite' | 'expired' | 'evicted' | 'expired-overwrite'; - - interface CookieDetails { - /** - * The URL associated with the cookie. - */ - url: string; - /** - * The name of the cookie. - * Default: empty. - */ - name?: string; - /** - * The value of the cookie. - * Default: empty. - */ - value?: string; - /** - * The domain of the cookie. - * Default: empty. - */ - domain?: string; - /** - * The path of the cookie. - * Default: empty. - */ - path?: string; - /** - * Whether the cookie should be marked as secure. - * Default: false. - */ - secure?: boolean; - /** - * Whether the cookie should be marked as HTTP only. - * Default: false. - */ - httpOnly?: boolean; - /** - * The expiration date of the cookie as the number of seconds since the UNIX epoch. - * If omitted, the cookie becomes a session cookie. - */ - expirationDate?: number; - } - - interface SessionCookies { - /** - * Sends a request to get all cookies matching filter. - */ - get(filter: CookieFilter, callback: (error: Error, cookies: Cookie[]) => void): void; - /** - * Sets the cookie with details. - */ - set(details: CookieDetails, callback: (error: Error) => void): void; - /** - * Removes the cookies matching url and name. - */ - remove(url: string, name: string, callback: (error: Error) => void): void; - } - - /** - * Each API accepts an optional filter and a listener, the listener will be called when the API's event has happened. - * Passing null as listener will unsubscribe from the event. - * - * The filter will be used to filter out the requests that do not match the URL patterns. - * If the filter is omitted then all requests will be matched. - * - * For certain events the listener is passed with a callback, - * which should be called with an response object when listener has done its work. - */ - interface WebRequest { - /** - * The listener will be called when a request is about to occur. - */ - onBeforeRequest(listener: (details: WebRequest.BeforeRequestDetails, callback: WebRequest.BeforeRequestCallback) => void): void; - /** - * The listener will be called when a request is about to occur. - */ - onBeforeRequest(filter: WebRequest.Filter, listener: (details: WebRequest.BeforeRequestDetails, callback: WebRequest.BeforeRequestCallback) => void): void; - /** - * The listener will be called before sending an HTTP request, once the request headers are available. - * This may occur after a TCP connection is made to the server, but before any http data is sent. - */ - onBeforeSendHeaders(listener: (details: WebRequest.BeforeSendHeadersDetails, callback: WebRequest.BeforeSendHeadersCallback) => void): void; - /** - * The listener will be called before sending an HTTP request, once the request headers are available. - * This may occur after a TCP connection is made to the server, but before any http data is sent. - */ - onBeforeSendHeaders(filter: WebRequest.Filter, listener: (details: WebRequest.BeforeSendHeadersDetails, callback: WebRequest.BeforeSendHeadersCallback) => void): void; - /** - * The listener will be called just before a request is going to be sent to the server, - * modifications of previous onBeforeSendHeaders response are visible by the time this listener is fired. - */ - onSendHeaders(listener: (details: WebRequest.SendHeadersDetails) => void): void; - /** - * The listener will be called just before a request is going to be sent to the server, - * modifications of previous onBeforeSendHeaders response are visible by the time this listener is fired. - */ - onSendHeaders(filter: WebRequest.Filter, listener: (details: WebRequest.SendHeadersDetails) => void): void; - /** - * The listener will be called when HTTP response headers of a request have been received. - */ - onHeadersReceived(listener: (details: WebRequest.HeadersReceivedDetails, callback: WebRequest.HeadersReceivedCallback) => void): void; - /** - * The listener will be called when HTTP response headers of a request have been received. - */ - onHeadersReceived(filter: WebRequest.Filter, listener: (details: WebRequest.HeadersReceivedDetails, callback: WebRequest.HeadersReceivedCallback) => void): void; - /** - * The listener will be called when first byte of the response body is received. - * For HTTP requests, this means that the status line and response headers are available. - */ - onResponseStarted(listener: (details: WebRequest.ResponseStartedDetails) => void): void; - /** - * The listener will be called when first byte of the response body is received. - * For HTTP requests, this means that the status line and response headers are available. - */ - onResponseStarted(filter: WebRequest.Filter, listener: (details: WebRequest.ResponseStartedDetails) => void): void; - /** - * The listener will be called when a server initiated redirect is about to occur. - */ - onBeforeRedirect(listener: (details: WebRequest.BeforeRedirectDetails) => void): void; - /** - * The listener will be called when a server initiated redirect is about to occur. - */ - onBeforeRedirect(filter: WebRequest.Filter, listener: (details: WebRequest.BeforeRedirectDetails) => void): void; - /** - * The listener will be called when a request is completed. - */ - onCompleted(listener: (details: WebRequest.CompletedDetails) => void): void; - /** - * The listener will be called when a request is completed. - */ - onCompleted(filter: WebRequest.Filter, listener: (details: WebRequest.CompletedDetails) => void): void; - /** - * The listener will be called when an error occurs. - */ - onErrorOccurred(listener: (details: WebRequest.ErrorOccurredDetails) => void): void; - /** - * The listener will be called when an error occurs. - */ - onErrorOccurred(filter: WebRequest.Filter, listener: (details: WebRequest.ErrorOccurredDetails) => void): void; - } - - namespace WebRequest { - interface Filter { - urls: string[]; - } - - interface Details { - id: number; - url: string; - method: string; - resourceType: string; - timestamp: number; - } - - interface UploadData { - /** - * Content being sent. - */ - bytes: Buffer; - /** - * Path of file being uploaded. - */ - file: string; - /** - * UUID of blob data. Use session.getBlobData method to retrieve the data. - */ - blobUUID: string; - } - - interface BeforeRequestDetails extends Details { - uploadData?: UploadData[]; - } - - type BeforeRequestCallback = (response: { - cancel?: boolean; - /** - * The original request is prevented from being sent or completed, and is instead redirected to the given URL. - */ - redirectURL?: string; - }) => void; - - interface BeforeSendHeadersDetails extends Details { - requestHeaders: Headers; - } - - type BeforeSendHeadersCallback = (response: { - cancel?: boolean; - /** - * When provided, request will be made with these headers. - */ - requestHeaders?: Headers; - }) => void; - - interface SendHeadersDetails extends Details { - requestHeaders: Headers; - } - - interface HeadersReceivedDetails extends Details { - statusLine: string; - statusCode: number; - responseHeaders: Headers; - } - - type HeadersReceivedCallback = (response: { - cancel?: boolean; - /** - * When provided, the server is assumed to have responded with these headers. - */ - responseHeaders?: Headers; - /** - * Should be provided when overriding responseHeaders to change header status - * otherwise original response header's status will be used. - */ - statusLine?: string; - }) => void; - - interface ResponseStartedDetails extends Details { - responseHeaders: Headers; - fromCache: boolean; - statusCode: number; - statusLine: string; - } - - interface BeforeRedirectDetails extends Details { - redirectURL: string; - statusCode: number; - ip?: string; - fromCache: boolean; - responseHeaders: Headers; - } - - interface CompletedDetails extends Details { - responseHeaders: Headers; - fromCache: boolean; - statusCode: number; - statusLine: string; - } - - interface ErrorOccurredDetails extends Details { - fromCache: boolean; - error: string; - } - } - - // https://github.com/electron/electron/blob/master/docs/api/shell.md - - /** - * The shell module provides functions related to desktop integration. - */ - interface Shell { - /** - * Show the given file in a file manager. If possible, select the file. - * @returns Whether the item was successfully shown. - */ - showItemInFolder(fullPath: string): boolean; - /** - * Open the given file in the desktop's default manner. - * @returns Whether the item was successfully shown. - */ - openItem(fullPath: string): boolean; - /** - * Open the given external protocol URL in the desktop's default manner - * (e.g., mailto: URLs in the default mail user agent). - * @returns Whether an application was available to open the URL. - */ - openExternal(url: string, options?: { - /** - * Bring the opened application to the foreground. - * Default: true. - */ - activate: boolean; - }): boolean; - /** - * Move the given file to trash. - * @returns Whether the item was successfully moved to the trash. - */ - moveItemToTrash(fullPath: string): boolean; - /** - * Play the beep sound. - */ - beep(): void; - /** - * Creates or updates a shortcut link at shortcutPath. - * - * Note: This API is available only on Windows. - */ - writeShortcutLink(shortcutPath: string, options: ShortcutLinkOptions): boolean; - /** - * Creates or updates a shortcut link at shortcutPath. - * - * Note: This API is available only on Windows. - */ - writeShortcutLink(shortcutPath: string, operation: 'create' | 'update' | 'replace', options: ShortcutLinkOptions): boolean; - /** - * Resolves the shortcut link at shortcutPath. - * An exception will be thrown when any error happens. - * - * Note: This API is available only on Windows. - */ - readShortcutLink(shortcutPath: string): ShortcutLinkOptions; - } - - interface ShortcutLinkOptions { - /** - * The target to launch from this shortcut. - */ - target: string; - /** - * The working directory. - * Default: empty. - */ - cwd?: string; - /** - * The arguments to be applied to target when launching from this shortcut. - * Default: empty. - */ - args?: string; - /** - * The description of the shortcut. - * Default: empty. - */ - description?: string; - /** - * The path to the icon, can be a DLL or EXE. icon and iconIndex have to be set together. - * Default: empty, which uses the target's icon. - */ - icon?: string; - /** - * The resource ID of icon when icon is a DLL or EXE. - * Default: 0. - */ - iconIndex?: number; - /** - * The Application User Model ID. - * Default: empty. - */ - appUserModelId?: string; - } - - // https://github.com/electron/electron/blob/master/docs/api/system-preferences.md - - type SystemColor = - '3d-dark-shadow' | // Dark shadow for three-dimensional display elements. - '3d-face' | // Face color for three-dimensional display elements and for dialog box backgrounds. - '3d-highlight' | // Highlight color for three-dimensional display elements. - '3d-light' | // Light color for three-dimensional display elements. - '3d-shadow' | // Shadow color for three-dimensional display elements. - 'active-border' | // Active window border. - 'active-caption' | // Active window title bar. Specifies the left side color in the color gradient of an active window's title bar if the gradient effect is enabled. - 'active-caption-gradient' | // Right side color in the color gradient of an active window's title bar. - 'app-workspace' | // Background color of multiple document interface (MDI) applications. - 'button-text' | // Text on push buttons. - 'caption-text' | // Text in caption, size box, and scroll bar arrow box. - 'desktop' | // Desktop background color. - 'disabled-text' | // Grayed (disabled) text. - 'highlight' | // Item(s) selected in a control. - 'highlight-text' | // Text of item(s) selected in a control. - 'hotlight' | // Color for a hyperlink or hot-tracked item. - 'inactive-border' | // Inactive window border. - 'inactive-caption' | // Inactive window caption. Specifies the left side color in the color gradient of an inactive window's title bar if the gradient effect is enabled. - 'inactive-caption-gradient' | // Right side color in the color gradient of an inactive window's title bar. - 'inactive-caption-text' | // Color of text in an inactive caption. - 'info-background' | // Background color for tooltip controls. - 'info-text' | // Text color for tooltip controls. - 'menu' | // Menu background. - 'menu-highlight' | // The color used to highlight menu items when the menu appears as a flat menu. - 'menubar' | // The background color for the menu bar when menus appear as flat menus. - 'menu-text' | // Text in menus. - 'scrollbar' | // Scroll bar gray area. - 'window' | // Window background. - 'window-frame' | // Window frame. - 'window-text'; // Text in windows. - - /** - * Get system preferences. - */ - interface SystemPreferences { - /** - * Note: This is only implemented on Windows. - */ - on(event: 'accent-color-changed', listener: (event: Event, newColor: string) => void): this; - /** - * Note: This is only implemented on Windows. - */ - on(event: 'color-changed', listener: (event: Event) => void): this; - /** - * Note: This is only implemented on Windows. - */ - on(event: 'inverted-color-scheme-changed', listener: ( - event: Event, - /** - * @param invertedColorScheme true if an inverted color scheme, such as a high contrast theme, is being used, false otherwise. - */ - invertedColorScheme: boolean - ) => void): this; - on(event: string, listener: Function): this; - /** - * @returns Whether the system is in Dark Mode. - * - * Note: This is only implemented on macOS. - */ - isDarkMode(): boolean; - /** - * @returns Whether the Swipe between pages setting is on. - * - * Note: This is only implemented on macOS. - */ - isSwipeTrackingFromScrollEventsEnabled(): boolean; - /** - * Posts event as native notifications of macOS. - * The userInfo contains the user information dictionary sent along with the notification. - * - * Note: This is only implemented on macOS. - */ - postNotification(event: string, userInfo: Object): void; - /** - * Posts event as native notifications of macOS. - * The userInfo contains the user information dictionary sent along with the notification. - * - * Note: This is only implemented on macOS. - */ - postLocalNotification(event: string, userInfo: Object): void; - /** - * Subscribes to native notifications of macOS, callback will be called when the corresponding event happens. - * The id of the subscriber is returned, which can be used to unsubscribe the event. - * - * Note: This is only implemented on macOS. - */ - subscribeNotification(event: string, callback: (event: Event, userInfo: Object) => void): number; - /** - * Removes the subscriber with id. - * - * Note: This is only implemented on macOS. - */ - unsubscribeNotification(id: number): void; - /** - * Same as subscribeNotification, but uses NSNotificationCenter for local defaults. - */ - subscribeLocalNotification(event: string, callback: (event: Event, userInfo: Object) => void): number; - /** - * Same as unsubscribeNotification, but removes the subscriber from NSNotificationCenter. - */ - unsubscribeLocalNotification(id: number): void; - /** - * Get the value of key in system preferences. - * - * Note: This is only implemented on macOS. - */ - getUserDefault(key: string, type: 'string' | 'boolean' | 'integer' | 'float' | 'double' | 'url' | 'array' | 'dictionary'): any; - /** - * @returns Whether DWM composition (Aero Glass) is enabled. - * - * Note: This is only implemented on Windows. - */ - isAeroGlassEnabled(): boolean; - /** - * @returns The users current system wide color preference in the form of an RGBA hexadecimal string. - * - * Note: This is only implemented on Windows. - */ - getAccentColor(): string; - /** - * @returns true if an inverted color scheme, such as a high contrast theme, is active, false otherwise. - * - * Note: This is only implemented on Windows. - */ - isInvertedColorScheme(): boolean; - /** - * @returns The system color setting in RGB hexadecimal form (#ABCDEF). See the Windows docs for more details. - * - * Note: This is only implemented on Windows. - */ - getColor(color: SystemColor): string; - } - - // https://github.com/electron/electron/blob/master/docs/api/tray.md - - /** - * A Tray represents an icon in an operating system's notification area. - */ - class Tray extends NodeJS.EventEmitter implements Destroyable { - /** - * Emitted when the tray icon is clicked. - * Note: The bounds payload is only implemented on macOS and Windows. - */ - on(event: 'click', listener: (modifiers: Modifiers, bounds: Rectangle) => void): this; - /** - * Emitted when the tray icon is right clicked. - * Note: This is only implemented on macOS and Windows. - */ - on(event: 'right-click', listener: (modifiers: Modifiers, bounds: Rectangle) => void): this; - /** - * Emitted when the tray icon is double clicked. - * Note: This is only implemented on macOS and Windows. - */ - on(event: 'double-click', listener: (modifiers: Modifiers, bounds: Rectangle) => void): this; - /** - * Emitted when the tray balloon shows. - * Note: This is only implemented on Windows. - */ - on(event: 'balloon-show', listener: Function): this; - /** - * Emitted when the tray balloon is clicked. - * Note: This is only implemented on Windows. - */ - on(event: 'balloon-click', listener: Function): this; - /** - * Emitted when the tray balloon is closed because of timeout or user manually closes it. - * Note: This is only implemented on Windows. - */ - on(event: 'balloon-closed', listener: Function): this; - /** - * Emitted when any dragged items are dropped on the tray icon. - * Note: This is only implemented on macOS. - */ - on(event: 'drop', listener: Function): this; - /** - * Emitted when dragged files are dropped in the tray icon. - * Note: This is only implemented on macOS - */ - on(event: 'drop-files', listener: (event: Event, files: string[]) => void): this; - /** - * Emitted when dragged text is dropped in the tray icon. - * Note: This is only implemented on macOS - */ - on(event: 'drop-text', listener: (event: Event, text: string) => void): this; - /** - * Emitted when a drag operation enters the tray icon. - * Note: This is only implemented on macOS - */ - on(event: 'drag-enter', listener: Function): this; - /** - * Emitted when a drag operation exits the tray icon. - * Note: This is only implemented on macOS - */ - on(event: 'drag-leave', listener: Function): this; - /** - * Emitted when a drag operation ends on the tray or ends at another location. - * Note: This is only implemented on macOS - */ - on(event: 'drag-end', listener: Function): this; - on(event: string, listener: Function): this; - /** - * Creates a new tray icon associated with the image. - */ - constructor(image: NativeImage|string); - /** - * Destroys the tray icon immediately. - */ - destroy(): void; - /** - * Sets the image associated with this tray icon. - */ - setImage(image: NativeImage|string): void; - /** - * Sets the image associated with this tray icon when pressed. - */ - setPressedImage(image: NativeImage): void; - /** - * Sets the hover text for this tray icon. - */ - setToolTip(toolTip: string): void; - /** - * Sets the title displayed aside of the tray icon in the status bar. - * Note: This is only implemented on macOS. - */ - setTitle(title: string): void; - /** - * Sets when the tray's icon background becomes highlighted. - * Note: This is only implemented on macOS. - */ - setHighlightMode(mode: 'selection' | 'always' | 'never'): void; - /** - * Displays a tray balloon. - * Note: This is only implemented on Windows. - */ - displayBalloon(options?: { - icon?: NativeImage; - title?: string; - content?: string; - }): void; - /** - * Pops up the context menu of tray icon. When menu is passed, - * the menu will showed instead of the tray's context menu. - * The position is only available on Windows, and it is (0, 0) by default. - * Note: This is only implemented on macOS and Windows. - */ - popUpContextMenu(menu?: Menu, position?: Point): void; - /** - * Sets the context menu for this icon. - */ - setContextMenu(menu: Menu): void; - /** - * @returns The bounds of this tray icon. - */ - getBounds(): Rectangle; - /** - * @returns Whether the tray icon is destroyed. - */ - isDestroyed(): boolean; - } - - interface Modifiers { - altKey: boolean; - shiftKey: boolean; - ctrlKey: boolean; - metaKey: boolean; - } - - interface DragItem { - /** - * The absolute path of the file to be dragged - */ - file: string; - /** - * The image showing under the cursor when dragging. - */ - icon: NativeImage; - } - - // https://github.com/electron/electron/blob/master/docs/api/web-contents.md - - interface WebContentsStatic { - /** - * @returns An array of all WebContents instances. This will contain web contents for all windows, - * webviews, opened devtools, and devtools extension background pages. - */ - getAllWebContents(): WebContents[]; - /** - * @returns The web contents that is focused in this application, otherwise returns null. - */ - getFocusedWebContents(): WebContents; - /** - * Find a WebContents instance according to its ID. - */ - fromId(id: number): WebContents; - } - - /** - * A WebContents is responsible for rendering and controlling a web page. - */ - interface WebContents extends NodeJS.EventEmitter { - /** - * Emitted when the navigation is done, i.e. the spinner of the tab has stopped spinning, - * and the onload event was dispatched. - */ - on(event: 'did-finish-load', listener: Function): this; - /** - * This event is like did-finish-load but emitted when the load failed or was cancelled, - * e.g. window.stop() is invoked. - */ - on(event: 'did-fail-load', listener: (event: Event, errorCode: number, errorDescription: string, validatedURL: string, isMainFrame: boolean) => void): this; - /** - * Emitted when a frame has done navigation. - */ - on(event: 'did-frame-finish-load', listener: (event: Event, isMainFrame: boolean) => void): this; - /** - * Corresponds to the points in time when the spinner of the tab started spinning. - */ - on(event: 'did-start-loading', listener: Function): this; - /** - * Corresponds to the points in time when the spinner of the tab stopped spinning. - */ - on(event: 'did-stop-loading', listener: Function): this; - /** - * Emitted when details regarding a requested resource are available. - * status indicates the socket connection to download the resource. - */ - on(event: 'did-get-response-details', listener: (event: Event, - status: boolean, - newURL: string, - originalURL: string, - httpResponseCode: number, - requestMethod: string, - referrer: string, - headers: Headers, - resourceType: string - ) => void): this; - /** - * Emitted when a redirect is received while requesting a resource. - */ - on(event: 'did-get-redirect-request', listener: (event: Event, - oldURL: string, - newURL: string, - isMainFrame: boolean, - httpResponseCode: number, - requestMethod: string, - referrer: string, - headers: Headers - ) => void): this; - /** - * Emitted when the document in the given frame is loaded. - */ - on(event: 'dom-ready', listener: (event: Event) => void): this; - /** - * Emitted when page receives favicon URLs. - */ - on(event: 'page-favicon-updated', listener: (event: Event, favicons: string[]) => void): this; - /** - * Emitted when the page requests to open a new window for a url. - * It could be requested by window.open or an external link like . - * - * By default a new BrowserWindow will be created for the url. - * - * Calling event.preventDefault() will prevent creating new windows. - * In such case, the event.newGuest may be set with a reference - * to a BrowserWindow instance to make it used by the Electron's runtime. - */ - on(event: 'new-window', listener: (event: WebContents.NewWindowEvent, - url: string, - frameName: string, - disposition: NewWindowDisposition, - /** - * The options which will be used for creating the new BrowserWindow. - */ - options: BrowserWindowOptions, - /** - * The non-standard features (features not handled by Chromium or Electron) given to window.open(). - */ - additionalFeatures: string[] - ) => void): this; - /** - * Emitted when a user or the page wants to start navigation. - * It can happen when the window.location object is changed or a user clicks a link in the page. - * - * This event will not emit when the navigation is started programmatically with APIs like - * webContents.loadURL and webContents.back. - * - * It is also not emitted for in-page navigations, such as clicking anchor links - * or updating the window.location.hash. Use did-navigate-in-page event for this purpose. - * - * Calling event.preventDefault() will prevent the navigation. - */ - on(event: 'will-navigate', listener: (event: Event, url: string) => void): this; - /** - * Emitted when a navigation is done. - * - * This event is not emitted for in-page navigations, such as clicking anchor links - * or updating the window.location.hash. Use did-navigate-in-page event for this purpose. - */ - on(event: 'did-navigate', listener: (event: Event, url: string) => void): this; - /** - * Emitted when an in-page navigation happened. - * - * When in-page navigation happens, the page URL changes but does not cause - * navigation outside of the page. Examples of this occurring are when anchor links - * are clicked or when the DOM hashchange event is triggered. - */ - on(event: 'did-navigate-in-page', listener: (event: Event, url: string, isMainFrame: boolean) => void): this; - /** - * Emitted when the renderer process has crashed. - */ - on(event: 'crashed', listener: (event: Event, killed: boolean) => void): this; - /** - * Emitted when a plugin process has crashed. - */ - on(event: 'plugin-crashed', listener: (event: Event, name: string, version: string) => void): this; - /** - * Emitted when webContents is destroyed. - */ - on(event: 'destroyed', listener: Function): this; - /** - * Emitted when DevTools is opened. - */ - on(event: 'devtools-opened', listener: Function): this; - /** - * Emitted when DevTools is closed. - */ - on(event: 'devtools-closed', listener: Function): this; - /** - * Emitted when DevTools is focused / opened. - */ - on(event: 'devtools-focused', listener: Function): this; - /** - * Emitted when failed to verify the certificate for url. - * The usage is the same with the "certificate-error" event of app. - */ - on(event: 'certificate-error', listener: (event: Event, - url: string, - error: string, - certificate: Certificate, - callback: (trust: boolean) => void - ) => void): this; - /** - * Emitted when a client certificate is requested. - * The usage is the same with the "select-client-certificate" event of app. - */ - on(event: 'select-client-certificate', listener: (event: Event, - url: string, - certificateList: Certificate[], - callback: (certificate: Certificate) => void - ) => void): this; - /** - * Emitted when webContents wants to do basic auth. - * The usage is the same with the "login" event of app. - */ - on(event: 'login', listener: (event: Event, - request: LoginRequest, - authInfo: LoginAuthInfo, - callback: (username: string, password: string) => void - ) => void): this; - /** - * Emitted when a result is available for webContents.findInPage request. - */ - on(event: 'found-in-page', listener: (event: Event, result: FoundInPageResult) => void): this; - /** - * Emitted when media starts playing. - */ - on(event: 'media-started-playing', listener: Function): this; - /** - * Emitted when media is paused or done playing. - */ - on(event: 'media-paused', listener: Function): this; - /** - * Emitted when a page’s theme color changes. This is usually due to encountering a meta tag: - * - */ - on(event: 'did-change-theme-color', listener: Function): this; - /** - * Emitted when mouse moves over a link or the keyboard moves the focus to a link. - */ - on(event: 'update-target-url', listener: (event: Event, url: string) => void): this; - /** - * Emitted when the cursor’s type changes. - * If the type parameter is custom, the image parameter will hold the custom cursor image - * in a NativeImage, and scale, size and hotspot will hold additional information about the custom cursor. - */ - on(event: 'cursor-changed', listener: (event: Event, type: CursorType, image?: NativeImage, scale?: number, size?: Size, hotspot?: Point) => void): this; - /** - * Emitted when there is a new context menu that needs to be handled. - */ - on(event: 'context-menu', listener: (event: Event, params: ContextMenuParams) => void): this; - /** - * Emitted when bluetooth device needs to be selected on call to navigator.bluetooth.requestDevice. - * To use navigator.bluetooth api webBluetooth should be enabled. - * If event.preventDefault is not called, first available device will be selected. - * callback should be called with deviceId to be selected, - * passing empty string to callback will cancel the request. - */ - on(event: 'select-bluetooth-device', listener: (event: Event, deviceList: BluetoothDevice[], callback: (deviceId: string) => void) => void): this; - /** - * Emitted when a new frame is generated. Only the dirty area is passed in the buffer. - */ - on(event: 'paint', listener: (event: Event, dirtyRect: Rectangle, image: NativeImage) => void): this; - on(event: string, listener: Function): this; - /** - * Loads the url in the window. - * @param url Must contain the protocol prefix (e.g., the http:// or file://). - */ - loadURL(url: string, options?: LoadURLOptions): void; - /** - * Initiates a download of the resource at url without navigating. - * The will-download event of session will be triggered. - */ - downloadURL(url: string): void; - /** - * @returns The URL of current web page. - */ - getURL(): string; - /** - * @returns The title of web page. - */ - getTitle(): string; - /** - * @returns The favicon of the web page. - */ - getFavicon(): NativeImage; - /** - * @returns Whether web page is still loading resources. - */ - isLoading(): boolean; - /** - * @returns Whether the main frame (and not just iframes or frames within it) is still loading. - */ - isLoadingMainFrame(): boolean; - /** - * @returns Whether web page is waiting for a first-response for the main - * resource of the page. - */ - isWaitingForResponse(): boolean; - /** - * Stops any pending navigation. - */ - stop(): void; - /** - * Reloads current page. - */ - reload(): void; - /** - * Reloads current page and ignores cache. - */ - reloadIgnoringCache(): void; - /** - * @returns Whether the web page can go back. - */ - canGoBack(): boolean; - /** - * @returns Whether the web page can go forward. - */ - canGoForward(): boolean; - /** - * @returns Whether the web page can go to offset. - */ - canGoToOffset(offset: number): boolean; - /** - * Clears the navigation history. - */ - clearHistory(): void; - /** - * Makes the web page go back. - */ - goBack(): void; - /** - * Makes the web page go forward. - */ - goForward(): void; - /** - * Navigates to the specified absolute index. - */ - goToIndex(index: number): void; - /** - * Navigates to the specified offset from the "current entry". - */ - goToOffset(offset: number): void; - /** - * @returns Whether the renderer process has crashed. - */ - isCrashed(): boolean; - /** - * Overrides the user agent for this page. - */ - setUserAgent(userAgent: string): void; - /** - * @returns The user agent for this web page. - */ - getUserAgent(): string; - /** - * Injects CSS into this page. - */ - insertCSS(css: string): void; - /** - * Evaluates code in page. - * @param code Code to evaluate. - */ - executeJavaScript(code: string, userGesture?: boolean, callback?: (result: any) => void): void; - /** - * Mute the audio on the current web page. - */ - setAudioMuted(muted: boolean): void; - /** - * @returns Whether this page has been muted. - */ - isAudioMuted(): boolean; - /** - * Changes the zoom factor to the specified factor. - * Zoom factor is zoom percent divided by 100, so 300% = 3.0. - */ - setZoomFactor(factor: number): void; - /** - * Sends a request to get current zoom factor. - */ - getZoomFactor(callback: (zoomFactor: number) => void): void; - /** - * Changes the zoom level to the specified level. - * The original size is 0 and each increment above or below represents - * zooming 20% larger or smaller to default limits of 300% and 50% of original size, respectively. - */ - setZoomLevel(level: number): void; - /** - * Sends a request to get current zoom level. - */ - getZoomLevel(callback: (zoomLevel: number) => void): void; - /** - * Sets the maximum and minimum zoom level. - */ - setZoomLevelLimits(minimumLevel: number, maximumLevel: number): void; - /** - * Executes the editing command undo in web page. - */ - undo(): void; - /** - * Executes the editing command redo in web page. - */ - redo(): void; - /** - * Executes the editing command cut in web page. - */ - cut(): void; - /** - * Executes the editing command copy in web page. - */ - copy(): void; - /** - * Copy the image at the given position to the clipboard. - */ - copyImageAt(x: number, y: number): void; - /** - * Executes the editing command paste in web page. - */ - paste(): void; - /** - * Executes the editing command pasteAndMatchStyle in web page. - */ - pasteAndMatchStyle(): void; - /** - * Executes the editing command delete in web page. - */ - delete(): void; - /** - * Executes the editing command selectAll in web page. - */ - selectAll(): void; - /** - * Executes the editing command unselect in web page. - */ - unselect(): void; - /** - * Executes the editing command replace in web page. - */ - replace(text: string): void; - /** - * Executes the editing command replaceMisspelling in web page. - */ - replaceMisspelling(text: string): void; - /** - * Inserts text to the focused element. - */ - insertText(text: string): void; - /** - * Starts a request to find all matches for the text in the web page. - * The result of the request can be obtained by subscribing to found-in-page event. - * @returns The request id used for the request. - */ - findInPage(text: string, options?: FindInPageOptions): number; - /** - * Stops any findInPage request for the webContents with the provided action. - */ - stopFindInPage(action: StopFindInPageAtion): void; - /** - * Checks if any serviceworker is registered. - */ - hasServiceWorker(callback: (hasServiceWorker: boolean) => void): void; - /** - * Unregisters any serviceworker if present. - */ - unregisterServiceWorker(callback: (isFulfilled: boolean) => void): void; - /** - * Prints window's web page. When silent is set to false, Electron will pick up system's default printer and default settings for printing. - * Calling window.print() in web page is equivalent to call WebContents.print({silent: false, printBackground: false}). - * Note: On Windows, the print API relies on pdf.dll. If your application doesn't need print feature, you can safely remove pdf.dll in saving binary size. - */ - print(options?: PrintOptions): void; - /** - * Prints windows' web page as PDF with Chromium's preview printing custom settings. - */ - printToPDF(options: PrintToPDFOptions, callback: (error: Error, data: Buffer) => void): void; - /** - * Adds the specified path to DevTools workspace. - */ - addWorkSpace(path: string): void; - /** - * Removes the specified path from DevTools workspace. - */ - removeWorkSpace(path: string): void; - /** - * Opens the developer tools. - */ - openDevTools(options?: { - /** - * Opens the devtools with specified dock state. Defaults to last used dock state. - */ - mode?: 'right' | 'bottom' | 'undocked' | 'detach' - }): void; - /** - * Closes the developer tools. - */ - closeDevTools(): void; - /** - * Returns whether the developer tools are opened. - */ - isDevToolsOpened(): boolean; - /** - * Returns whether the developer tools are focussed. - */ - isDevToolsFocused(): boolean; - /** - * Toggle the developer tools. - */ - toggleDevTools(): void; - /** - * Starts inspecting element at position (x, y). - */ - inspectElement(x: number, y: number): void; - /** - * Opens the developer tools for the service worker context. - */ - inspectServiceWorker(): void; - /** - * Send args.. to the web page via channel in asynchronous message, the web page - * can handle it by listening to the channel event of ipc module. - * Note: - * 1. The IPC message handler in web pages do not have a event parameter, - * which is different from the handlers on the main process. - * 2. There is no way to send synchronous messages from the main process - * to a renderer process, because it would be very easy to cause dead locks. - */ - send(channel: string, ...args: any[]): void; - /** - * Enable device emulation with the given parameters. - */ - enableDeviceEmulation(parameters: DeviceEmulationParameters): void; - /** - * Disable device emulation. - */ - disableDeviceEmulation(): void; - /** - * Sends an input event to the page. - */ - sendInputEvent(event: SendInputEvent): void; - /** - * Begin subscribing for presentation events and captured frames, - * The callback will be called when there is a presentation event. - */ - beginFrameSubscription(onlyDirty: boolean, callback: BeginFrameSubscriptionCallback): void; - /** - * Begin subscribing for presentation events and captured frames, - * The callback will be called when there is a presentation event. - */ - beginFrameSubscription(callback: BeginFrameSubscriptionCallback): void; - /** - * End subscribing for frame presentation events. - */ - endFrameSubscription(): void; - /** - * @returns If the process of saving page has been initiated successfully. - */ - savePage(fullPath: string, saveType: 'HTMLOnly' | 'HTMLComplete' | 'MHTML', callback?: (eror: Error) => void): boolean; - /** - * Shows pop-up dictionary that searches the selected word on the page. - * Note: This API is available only on macOS. - */ - showDefinitionForSelection(): void; - /** - * @returns Whether offscreen rendering is enabled. - */ - isOffscreen(): boolean; - /** - * If offscreen rendering is enabled and not painting, start painting. - */ - startPainting(): void; - /** - * If offscreen rendering is enabled and painting, stop painting. - */ - stopPainting(): void; - /** - * If offscreen rendering is enabled returns whether it is currently painting. - */ - isPainting(): boolean; - /** - * If offscreen rendering is enabled sets the frame rate to the specified number. - * Only values between 1 and 60 are accepted. - */ - setFrameRate(fps: number): void; - /** - * If offscreen rendering is enabled returns the current frame rate. - */ - getFrameRate(): number; - /** - * If offscreen rendering is enabled invalidates the frame and generates a new one through the 'paint' event. - */ - invalidate(): void; - /** - * Sets the item as dragging item for current drag-drop operation. - */ - startDrag(item: DragItem): void; - /** - * Captures a snapshot of the page within rect. - */ - capturePage(callback: (image: NativeImage) => void): void; - /** - * Captures a snapshot of the page within rect. - */ - capturePage(rect: Rectangle, callback: (image: NativeImage) => void): void; - /** - * @returns The unique ID of this WebContents. - */ - id: number; - /** - * @returns The session object used by this webContents. - */ - session: Session; - /** - * @returns The WebContents that might own this WebContents. - */ - hostWebContents: WebContents; - /** - * @returns The WebContents of DevTools for this WebContents. - * Note: Users should never store this object because it may become null - * when the DevTools has been closed. - */ - devToolsWebContents: WebContents; - /** - * @returns Debugger API - */ - debugger: Debugger; - } - - namespace WebContents { - interface NewWindowEvent extends Event { - newGuest?: BrowserWindow; - } - } - - interface BeginFrameSubscriptionCallback { - ( - /** - * The frameBuffer is a Buffer that contains raw pixel data. - * On most machines, the pixel data is effectively stored in 32bit BGRA format, - * but the actual representation depends on the endianness of the processor - * (most modern processors are little-endian, on machines with big-endian - * processors the data is in 32bit ARGB format). - */ - frameBuffer: Buffer, - /** - * The dirtyRect is an object with x, y, width, height properties that describes which part of the page was repainted. - * If onlyDirty is set to true, frameBuffer will only contain the repainted area. onlyDirty defaults to false. - */ - dirtyRect?: Rectangle - ): void - } - - interface ContextMenuParams { - /** - * x coordinate - */ - x: number; - /** - * y coordinate - */ - y: number; - /** - * URL of the link that encloses the node the context menu was invoked on. - */ - linkURL: string; - /** - * Text associated with the link. May be an empty string if the contents of the link are an image. - */ - linkText: string; - /** - * URL of the top level page that the context menu was invoked on. - */ - pageURL: string; - /** - * URL of the subframe that the context menu was invoked on. - */ - frameURL: string; - /** - * Source URL for the element that the context menu was invoked on. - * Elements with source URLs are images, audio and video. - */ - srcURL: string; - /** - * Type of the node the context menu was invoked on. - */ - mediaType: 'none' | 'image' | 'audio' | 'video' | 'canvas' | 'file' | 'plugin'; - /** - * Parameters for the media element the context menu was invoked on. - */ - mediaFlags: { - /** - * Whether the media element has crashed. - */ - inError: boolean; - /** - * Whether the media element is paused. - */ - isPaused: boolean; - /** - * Whether the media element is muted. - */ - isMuted: boolean; - /** - * Whether the media element has audio. - */ - hasAudio: boolean; - /** - * Whether the media element is looping. - */ - isLooping: boolean; - /** - * Whether the media element's controls are visible. - */ - isControlsVisible: boolean; - /** - * Whether the media element's controls are toggleable. - */ - canToggleControls: boolean; - /** - * Whether the media element can be rotated. - */ - canRotate: boolean; - } - /** - * Whether the context menu was invoked on an image which has non-empty contents. - */ - hasImageContents: boolean; - /** - * Whether the context is editable. - */ - isEditable: boolean; - /** - * These flags indicate whether the renderer believes it is able to perform the corresponding action. - */ - editFlags: { - /** - * Whether the renderer believes it can undo. - */ - canUndo: boolean; - /** - * Whether the renderer believes it can redo. - */ - canRedo: boolean; - /** - * Whether the renderer believes it can cut. - */ - canCut: boolean; - /** - * Whether the renderer believes it can copy - */ - canCopy: boolean; - /** - * Whether the renderer believes it can paste. - */ - canPaste: boolean; - /** - * Whether the renderer believes it can delete. - */ - canDelete: boolean; - /** - * Whether the renderer believes it can select all. - */ - canSelectAll: boolean; - } - /** - * Text of the selection that the context menu was invoked on. - */ - selectionText: string; - /** - * Title or alt text of the selection that the context was invoked on. - */ - titleText: string; - /** - * The misspelled word under the cursor, if any. - */ - misspelledWord: string; - /** - * The character encoding of the frame on which the menu was invoked. - */ - frameCharset: string; - /** - * If the context menu was invoked on an input field, the type of that field. - */ - inputFieldType: 'none' | 'plainText' | 'password' | 'other'; - /** - * Input source that invoked the context menu. - */ - menuSourceType: 'none' | 'mouse' | 'keyboard' | 'touch' | 'touchMenu'; - } - - interface BluetoothDevice { - deviceName: string; - deviceId: string; - } - - interface Headers { - [key: string]: string; - } - - type NewWindowDisposition = 'default' | 'foreground-tab' | 'background-tab' | 'new-window' | 'save-to-disk' | 'other'; - - /** - * Specifies the action to take place when ending webContents.findInPage request. - * 'clearSelection' - Clear the selection. - * 'keepSelection' - Translate the selection into a normal selection. - * 'activateSelection' - Focus and click the selection node. - */ - type StopFindInPageAtion = 'clearSelection' | 'keepSelection' | 'activateSelection'; - - type CursorType = 'default' | 'crosshair' | 'pointer' | 'text' | 'wait' | 'help' | 'e-resize' | 'n-resize' | 'ne-resize' | 'nw-resize' | 's-resize' | 'se-resize' | 'sw-resize' | 'w-resize' | 'ns-resize' | 'ew-resize' | 'nesw-resize' | 'nwse-resize' | 'col-resize' | 'row-resize' | 'm-panning' | 'e-panning' | 'n-panning' | 'ne-panning' | 'nw-panning' | 's-panning' | 'se-panning' |'sw-panning' | 'w-panning' | 'move' | 'vertical-text' | 'cell' | 'context-menu' | 'alias' | 'progress' | 'nodrop' | 'copy' | 'none' | 'not-allowed' | 'zoom-in' | 'zoom-out' | 'grab' | 'grabbing' | 'custom'; - - interface LoadURLOptions { - /** - * HTTP Referrer URL. - */ - httpReferrer?: string; - /** - * User agent originating the request. - */ - userAgent?: string; - /** - * Extra headers separated by "\n" - */ - extraHeaders?: string; - } - - interface PrintOptions { - /** - * Don't ask user for print settings. - * Defaults: false. - */ - silent?: boolean; - /** - * Also prints the background color and image of the web page. - * Defaults: false. - */ - printBackground?: boolean; - } - - interface PrintToPDFOptions { - /** - * Specify the type of margins to use. - * 0 - default - * 1 - none - * 2 - minimum - * Default: 0 - */ - marginsType?: number; - /** - * Specify page size of the generated PDF. - * Default: A4. - */ - pageSize?: 'A3' | 'A4' | 'A5' | 'Legal' | 'Letter' | 'Tabloid' | Size; - /** - * Whether to print CSS backgrounds. - * Default: false. - */ - printBackground?: boolean; - /** - * Whether to print selection only. - * Default: false. - */ - printSelectionOnly?: boolean; - /** - * true for landscape, false for portrait. - * Default: false. - */ - landscape?: boolean; - } - - interface Certificate { - /** - * PEM encoded data. - */ - data: string; - /** - * Issuer's Common Name. - */ - issuerName: string; - /** - * Subject's Common Name. - */ - subjectName: string; - /** - * Hex value represented string. - */ - serialNumber: string; - /** - * Start date of the certificate being valid in seconds. - */ - validStart: number; - /** - * End date of the certificate being valid in seconds. - */ - validExpiry: number; - /** - * Fingerprint of the certificate. - */ - fingerprint: string; - } - - interface LoginRequest { - method: string; - url: string; - referrer: string; - } - - interface LoginAuthInfo { - isProxy: boolean; - scheme: string; - host: string; - port: number; - realm: string; - } - - interface FindInPageOptions { - /** - * Whether to search forward or backward, defaults to true - */ - forward?: boolean; - /** - * Whether the operation is first request or a follow up, defaults to false. - */ - findNext?: boolean; - /** - * Whether search should be case-sensitive, defaults to false. - */ - matchCase?: boolean; - /** - * Whether to look only at the start of words. defaults to false. - */ - wordStart?: boolean; - /** - * When combined with wordStart, accepts a match in the middle of a word - * if the match begins with an uppercase letter followed by a lowercase - * or non-letter. Accepts several other intra-word matches, defaults to false. - */ - medialCapitalAsWordStart?: boolean; - } - - interface FoundInPageResult { - requestId: number; - /** - * Indicates if more responses are to follow. - */ - finalUpdate: boolean; - /** - * Position of the active match. - */ - activeMatchOrdinal?: number; - /** - * Number of Matches. - */ - matches?: number; - /** - * Coordinates of first match region. - */ - selectionArea?: Rectangle; - } - - interface DeviceEmulationParameters { - /** - * Specify the screen type to emulated - * Default: desktop - */ - screenPosition?: 'desktop' | 'mobile'; - /** - * Set the emulated screen size (screenPosition == mobile) - */ - screenSize?: Size; - /** - * Position the view on the screen (screenPosition == mobile) - * Default: {x: 0, y: 0} - */ - viewPosition?: Point; - /** - * Set the device scale factor (if zero defaults to original device scale factor) - * Default: 0 - */ - deviceScaleFactor: number; - /** - * Set the emulated view size (empty means no override). - */ - viewSize?: Size; - /** - * Whether emulated view should be scaled down if necessary to fit into available space - * Default: false - */ - fitToView?: boolean; - /** - * Offset of the emulated view inside available space (not in fit to view mode) - * Default: {x: 0, y: 0} - */ - offset?: Point; - /** - * Scale of emulated view inside available space (not in fit to view mode) - * Default: 1 - */ - scale: number; - } - - interface SendInputEvent { - type: 'mouseDown' | 'mouseUp' | 'mouseEnter' | 'mouseLeave' | 'contextMenu' | 'mouseWheel' | 'mouseMove' | 'keyDown' | 'keyUp' | 'char'; - modifiers: ('shift' | 'control' | 'alt' | 'meta' | 'isKeypad' | 'isAutoRepeat' | 'leftButtonDown' | 'middleButtonDown' | 'rightButtonDown' | 'capsLock' | 'numLock' | 'left' | 'right')[]; - } - - interface SendInputKeyboardEvent extends SendInputEvent { - keyCode: string; - } - - interface SendInputMouseEvent extends SendInputEvent { - x: number; - y: number; - button?: 'left' | 'middle' | 'right'; - globalX?: number; - globalY?: number; - movementX?: number; - movementY?: number; - clickCount?: number; - } - - interface SendInputMouseWheelEvent extends SendInputEvent { - deltaX?: number; - deltaY?: number; - wheelTicksX?: number; - wheelTicksY?: number; - accelerationRatioX?: number; - accelerationRatioY?: number; - hasPreciseScrollingDeltas?: boolean; - canScroll?: boolean; - } - - /** - * Debugger API serves as an alternate transport for remote debugging protocol. - */ - interface Debugger extends NodeJS.EventEmitter { - /** - * Attaches the debugger to the webContents. - * @param protocolVersion Requested debugging protocol version. - */ - attach(protocolVersion?: string): void; - /** - * @returns Whether a debugger is attached to the webContents. - */ - isAttached(): boolean; - /** - * Detaches the debugger from the webContents. - */ - detach(): void; - /** - * Send given command to the debugging target. - * @param method Method name, should be one of the methods defined by the remote debugging protocol. - * @param commandParams JSON object with request parameters. - * @param callback Response defined by the ‘returns’ attribute of the command description in the remote debugging protocol. - */ - sendCommand(method: string, commandParams?: any, callback?: (error: Error, result: any) => void): void; - /** - * Emitted when debugging session is terminated. This happens either when - * webContents is closed or devtools is invoked for the attached webContents. - */ - on(event: 'detach', listener: (event: Event, reason: string) => void): this; - /** - * Emitted whenever debugging target issues instrumentation event. - * Event parameters defined by the ‘parameters’ attribute in the remote debugging protocol. - */ - on(event: 'message', listener: (event: Event, method: string, params: any) => void): this; - on(event: string, listener: Function): this; - } - - // https://github.com/electron/electron/blob/master/docs/api/web-frame.md - - /** - * The web-frame module allows you to customize the rendering of the current web page. - */ - interface WebFrame { - /** - * Changes the zoom factor to the specified factor, zoom factor is - * zoom percent / 100, so 300% = 3.0. - */ - setZoomFactor(factor: number): void; - /** - * @returns The current zoom factor. - */ - getZoomFactor(): number; - /** - * Changes the zoom level to the specified level, 0 is "original size", and each - * increment above or below represents zooming 20% larger or smaller to default - * limits of 300% and 50% of original size, respectively. - */ - setZoomLevel(level: number): void; - /** - * @returns The current zoom level. - */ - getZoomLevel(): number; - /** - * Sets the maximum and minimum zoom level. - */ - setZoomLevelLimits(minimumLevel: number, maximumLevel: number): void; - /** - * Sets a provider for spell checking in input fields and text areas. - */ - setSpellCheckProvider(language: string, autoCorrectWord: boolean, provider: { - /** - * @returns Whether the word passed is correctly spelled. - */ - spellCheck: (text: string) => boolean; - }): void; - /** - * Sets the scheme as secure scheme. Secure schemes do not trigger mixed content - * warnings. For example, https and data are secure schemes because they cannot be - * corrupted by active network attackers. - */ - registerURLSchemeAsSecure(scheme: string): void; - /** - * Resources will be loaded from this scheme regardless of the current page’s Content Security Policy. - */ - registerURLSchemeAsBypassingCSP(scheme: string): void; - /** - * Registers the scheme as secure, bypasses content security policy for resources, - * allows registering ServiceWorker and supports fetch API. - */ - registerURLSchemeAsPrivileged(scheme: string): void; - /** - * Inserts text to the focused element. - */ - insertText(text: string): void; - /** - * Evaluates `code` in page. - * In the browser window some HTML APIs like `requestFullScreen` can only be - * invoked by a gesture from the user. Setting `userGesture` to `true` will remove - * this limitation. - */ - executeJavaScript(code: string, userGesture?: boolean, callback?: (result: any) => void): void; - /** - * @returns Object describing usage information of Blink’s internal memory caches. - */ - getResourceUsage(): ResourceUsages; - /** - * Attempts to free memory that is no longer being used (like images from a previous navigation). - */ - clearCache(): void; - } - - interface ResourceUsages { - fonts: ResourceUsage; - images: ResourceUsage; - cssStyleSheets: ResourceUsage; - xslStyleSheets: ResourceUsage; - scripts: ResourceUsage; - other: ResourceUsage; - } - - interface ResourceUsage { - count: number; - decodedSize: number; - liveSize: number; - purgeableSize: number; - purgedSize: number; - size: number; - } - - // https://github.com/electron/electron/blob/master/docs/api/web-view-tag.md - - /** - * Use the webview tag to embed 'guest' content (such as web pages) in your Electron app. - * The guest content is contained within the webview container. - * An embedded page within your app controls how the guest content is laid out and rendered. - * - * Unlike an iframe, the webview runs in a separate process than your app. - * It doesn't have the same permissions as your web page and all interactions between your app - * and embedded content will be asynchronous. This keeps your app safe from the embedded content. - */ - interface WebViewElement extends HTMLElement { - /** - * Returns the visible URL. Writing to this attribute initiates top-level navigation. - * Assigning src its own value will reload the current page. - * The src attribute can also accept data URLs, such as data:text/plain,Hello, world!. - */ - src: string; - /** - * If "on", the webview container will automatically resize within the bounds specified - * by the attributes minwidth, minheight, maxwidth, and maxheight. - * These constraints do not impact the webview unless autosize is enabled. - * When autosize is enabled, the webview container size cannot be less than - * the minimum values or greater than the maximum. - */ - autosize: string; - /** - * If "on", the guest page in webview will have node integration and can use node APIs - * like require and process to access low level system resources. - */ - nodeintegration: string; - /** - * If "on", the guest page in webview will be able to use browser plugins. - */ - plugins: string; - /** - * Specifies a script that will be loaded before other scripts run in the guest page. - * The protocol of script's URL must be either file: or asar:, - * because it will be loaded by require in guest page under the hood. - * - * When the guest page doesn't have node integration this script will still have access to all Node APIs, - * but global objects injected by Node will be deleted after this script has finished executing. - */ - preload: string; - /** - * Sets the referrer URL for the guest page. - */ - httpreferrer: string; - /** - * Sets the user agent for the guest page before the page is navigated to. - * Once the page is loaded, use the setUserAgent method to change the user agent. - */ - useragent: string; - /** - * If "on", the guest page will have web security disabled. - */ - disablewebsecurity: string; - /** - * Sets the session used by the page. If partition starts with persist:, - * the page will use a persistent session available to all pages in the app with the same partition. - * If there is no persist: prefix, the page will use an in-memory session. - * By assigning the same partition, multiple pages can share the same session. - * If the partition is unset then default session of the app will be used. - * - * This value can only be modified before the first navigation, - * since the session of an active renderer process cannot change. - * Subsequent attempts to modify the value will fail with a DOM exception. - */ - partition: string; - /** - * If "on", the guest page will be allowed to open new windows. - */ - allowpopups: string; - /** - * A list of strings which specifies the blink features to be enabled separated by ,. - */ - blinkfeatures: string; - /** - * A list of strings which specifies the blink features to be disabled separated by ,. - */ - disableblinkfeatures: string; - /** - * A value that links the webview to a specific webContents. - * When a webview first loads a new webContents is created and this attribute is set - * to its instance identifier. Setting this attribute on a new or existing webview connects - * it to the existing webContents that currently renders in a different webview. - * - * The existing webview will see the destroy event and will then create a new webContents when a new url is loaded. - */ - guestinstance: string; - /** - * Loads the url in the webview, the url must contain the protocol prefix, e.g. the http:// or file://. - */ - loadURL(url: string, options?: LoadURLOptions): void; - /** - * @returns URL of guest page. - */ - getURL(): string; - /** - * @returns The title of guest page. - */ - getTitle(): string; - /** - * @returns Whether the web page is destroyed. - */ - isDestroyed(): boolean; - /** - * @returns Whether the web page is focused. - */ - isFocused(): boolean; - /** - * @returns Whether guest page is still loading resources. - */ - isLoading(): boolean; - /** - * Returns a boolean whether the guest page is waiting for a first-response for the main resource of the page. - */ - isWaitingForResponse(): boolean; - /** - * Stops any pending navigation. - */ - stop(): void; - /** - * Reloads the guest page. - */ - reload(): void; - /** - * Reloads the guest page and ignores cache. - */ - reloadIgnoringCache(): void; - /** - * @returns Whether the guest page can go back. - */ - canGoBack(): boolean; - /** - * @returns Whether the guest page can go forward. - */ - canGoForward(): boolean; - /** - * @returns Whether the guest page can go to offset. - */ - canGoToOffset(offset: number): boolean; - /** - * Clears the navigation history. - */ - clearHistory(): void; - /** - * Makes the guest page go back. - */ - goBack(): void; - /** - * Makes the guest page go forward. - */ - goForward(): void; - /** - * Navigates to the specified absolute index. - */ - goToIndex(index: number): void; - /** - * Navigates to the specified offset from the "current entry". - */ - goToOffset(offset: number): void; - /** - * @returns Whether the renderer process has crashed. - */ - isCrashed(): boolean; - /** - * Overrides the user agent for the guest page. - */ - setUserAgent(userAgent: string): void; - /** - * @returns The user agent for guest page. - */ - getUserAgent(): string; - /** - * Injects CSS into the guest page. - */ - insertCSS(css: string): void; - /** - * Evaluates code in page. If userGesture is set, it will create the user gesture context in the page. - * HTML APIs like requestFullScreen, which require user action, can take advantage of this option for automation. - */ - executeJavaScript(code: string, userGesture?: boolean, callback?: (result: any) => void): void; - /** - * Opens a DevTools window for guest page. - */ - openDevTools(): void; - /** - * Closes the DevTools window of guest page. - */ - closeDevTools(): void; - /** - * @returns Whether guest page has a DevTools window attached. - */ - isDevToolsOpened(): boolean; - /** - * @returns Whether DevTools window of guest page is focused. - */ - isDevToolsFocused(): boolean; - /** - * Starts inspecting element at position (x, y) of guest page. - */ - inspectElement(x: number, y: number): void; - /** - * Opens the DevTools for the service worker context present in the guest page. - */ - inspectServiceWorker(): void; - /** - * Set guest page muted. - */ - setAudioMuted(muted: boolean): void; - /** - * @returns Whether guest page has been muted. - */ - isAudioMuted(): boolean; - /** - * Executes editing command undo in page. - */ - undo(): void; - /** - * Executes editing command redo in page. - */ - redo(): void; - /** - * Executes editing command cut in page. - */ - cut(): void; - /** - * Executes editing command copy in page. - */ - copy(): void; - /** - * Executes editing command paste in page. - */ - paste(): void; - /** - * Executes editing command pasteAndMatchStyle in page. - */ - pasteAndMatchStyle(): void; - /** - * Executes editing command delete in page. - */ - delete(): void; - /** - * Executes editing command selectAll in page. - */ - selectAll(): void; - /** - * Executes editing command unselect in page. - */ - unselect(): void; - /** - * Executes editing command replace in page. - */ - replace(text: string): void; - /** - * Executes editing command replaceMisspelling in page. - */ - replaceMisspelling(text: string): void; - /** - * Inserts text to the focused element. - */ - insertText(text: string): void; - /** - * Starts a request to find all matches for the text in the web page. - * The result of the request can be obtained by subscribing to found-in-page event. - * @returns The request id used for the request. - */ - findInPage(text: string, options?: FindInPageOptions): number; - /** - * Stops any findInPage request for the webview with the provided action. - */ - stopFindInPage(action: StopFindInPageAtion): void; - /** - * Prints webview's web page. Same with webContents.print([options]). - */ - print(options?: PrintOptions): void; - /** - * Prints webview's web page as PDF, Same with webContents.printToPDF(options, callback) - */ - printToPDF(options: PrintToPDFOptions, callback: (error: Error, data: Buffer) => void): void; - /** - * Send an asynchronous message to renderer process via channel, you can also send arbitrary arguments. - * The renderer process can handle the message by listening to the channel event with the ipcRenderer module. - * See webContents.send for examples. - */ - send(channel: string, ...args: any[]): void; - /** - * Sends an input event to the page. - * See webContents.sendInputEvent for detailed description of event object. - */ - sendInputEvent(event: SendInputEvent): void - /** - * Changes the zoom factor to the specified factor. - * Zoom factor is zoom percent divided by 100, so 300% = 3.0. - */ - setZoomFactor(factor: number): void; - /** - * Changes the zoom level to the specified level. - * The original size is 0 and each increment above or below represents - * zooming 20% larger or smaller to default limits of 300% and 50% of original size, respectively. - */ - setZoomLevel(level: number): void; - /** - * Shows pop-up dictionary that searches the selected word on the page. - * Note: This API is available only on macOS. - */ - showDefinitionForSelection(): void; - /** - * @returns The WebContents associated with this webview. - */ - getWebContents(): WebContents; - /** - * Captures a snapshot of the webview's page. Same as webContents.capturePage([rect, ]callback). - */ - capturePage(callback: (image: NativeImage) => void): void; - /** - * Captures a snapshot of the webview's page. Same as webContents.capturePage([rect, ]callback). - */ - capturePage(rect: Rectangle, callback: (image: NativeImage) => void): void; - /** - * Fired when a load has committed. This includes navigation within the current document - * as well as subframe document-level loads, but does not include asynchronous resource loads. - */ - addEventListener(type: 'load-commit', listener: (event: WebViewElement.LoadCommitEvent) => void, useCapture?: boolean): void; - /** - * Fired when the navigation is done, i.e. the spinner of the tab will stop spinning, and the onload event is dispatched. - */ - addEventListener(type: 'did-finish-load', listener: (event: WebViewElement.Event) => void, useCapture?: boolean): void; - /** - * This event is like did-finish-load, but fired when the load failed or was cancelled, e.g. window.stop() is invoked. - */ - addEventListener(type: 'did-fail-load', listener: (event: WebViewElement.DidFailLoadEvent) => void, useCapture?: boolean): void; - /** - * Fired when a frame has done navigation. - */ - addEventListener(type: 'did-frame-finish-load', listener: (event: WebViewElement.DidFrameFinishLoadEvent) => void, useCapture?: boolean): void; - /** - * Corresponds to the points in time when the spinner of the tab starts spinning. - */ - addEventListener(type: 'did-start-loading', listener: (event: WebViewElement.Event) => void, useCapture?: boolean): void; - /** - * Corresponds to the points in time when the spinner of the tab stops spinning. - */ - addEventListener(type: 'did-stop-loading', listener: (event: WebViewElement.Event) => void, useCapture?: boolean): void; - /** - * Fired when details regarding a requested resource is available. - * status indicates socket connection to download the resource. - */ - addEventListener(type: 'did-get-response-details', listener: (event: WebViewElement.DidGetResponseDetails) => void, useCapture?: boolean): void; - /** - * Fired when a redirect was received while requesting a resource. - */ - addEventListener(type: 'did-get-redirect-request', listener: (event: WebViewElement.DidGetRedirectRequestEvent) => void, useCapture?: boolean): void; - /** - * Fired when document in the given frame is loaded. - */ - addEventListener(type: 'dom-ready', listener: (event: WebViewElement.Event) => void, useCapture?: boolean): void; - /** - * Fired when page title is set during navigation. explicitSet is false when title is synthesized from file URL. - */ - addEventListener(type: 'page-title-updated', listener: (event: WebViewElement.PageTitleUpdatedEvent) => void, useCapture?: boolean): void; - /** - * Fired when page receives favicon URLs. - */ - addEventListener(type: 'page-favicon-updated', listener: (event: WebViewElement.PageFaviconUpdatedEvent) => void, useCapture?: boolean): void; - /** - * Fired when page enters fullscreen triggered by HTML API. - */ - addEventListener(type: 'enter-html-full-screen', listener: (event: WebViewElement.Event) => void, useCapture?: boolean): void; - /** - * Fired when page leaves fullscreen triggered by HTML API. - */ - addEventListener(type: 'leave-html-full-screen', listener: (event: WebViewElement.Event) => void, useCapture?: boolean): void; - /** - * Fired when the guest window logs a console message. - */ - addEventListener(type: 'console-message', listener: (event: WebViewElement.ConsoleMessageEvent) => void, useCapture?: boolean): void; - /** - * Fired when a result is available for webview.findInPage request. - */ - addEventListener(type: 'found-in-page', listener: (event: WebViewElement.FoundInPageEvent) => void, useCapture?: boolean): void; - /** - * Fired when the guest page attempts to open a new browser window. - */ - addEventListener(type: 'new-window', listener: (event: WebViewElement.NewWindowEvent) => void, useCapture?: boolean): void; - /** - * Emitted when a user or the page wants to start navigation. - * It can happen when the window.location object is changed or a user clicks a link in the page. - * - * This event will not emit when the navigation is started programmatically with APIs - * like .loadURL and .back. - * - * It is also not emitted during in-page navigation, such as clicking anchor links - * or updating the window.location.hash. Use did-navigate-in-page event for this purpose. - * - * Calling event.preventDefault() does NOT have any effect. - */ - addEventListener(type: 'will-navigate', listener: (event: WebViewElement.WillNavigateEvent) => void, useCapture?: boolean): void; - /** - * Emitted when a navigation is done. - * - * This event is not emitted for in-page navigations, such as clicking anchor links - * or updating the window.location.hash. Use did-navigate-in-page event for this purpose. - */ - addEventListener(type: 'did-navigate', listener: (event: WebViewElement.DidNavigateEvent) => void, useCapture?: boolean): void; - /** - * Emitted when an in-page navigation happened. - * - * When in-page navigation happens, the page URL changes but does not cause - * navigation outside of the page. Examples of this occurring are when anchor links - * are clicked or when the DOM hashchange event is triggered. - */ - addEventListener(type: 'did-navigate-in-page', listener: (event: WebViewElement.DidNavigateInPageEvent) => void, useCapture?: boolean): void; - /** - * Fired when the guest page attempts to close itself. - */ - addEventListener(type: 'close', listener: (event: WebViewElement.Event) => void, useCapture?: boolean): void; - /** - * Fired when the guest page has sent an asynchronous message to embedder page. - */ - addEventListener(type: 'ipc-message', listener: (event: WebViewElement.IpcMessageEvent) => void, useCapture?: boolean): void; - /** - * Fired when the renderer process is crashed. - */ - addEventListener(type: 'crashed', listener: (event: WebViewElement.Event) => void, useCapture?: boolean): void; - /** - * Fired when the gpu process is crashed. - */ - addEventListener(type: 'gpu-crashed', listener: (event: WebViewElement.Event) => void, useCapture?: boolean): void; - /** - * Fired when a plugin process is crashed. - */ - addEventListener(type: 'plugin-crashed', listener: (event: WebViewElement.PluginCrashedEvent) => void, useCapture?: boolean): void; - /** - * Fired when the WebContents is destroyed. - */ - addEventListener(type: 'destroyed', listener: (event: WebViewElement.Event) => void, useCapture?: boolean): void; - /** - * Emitted when media starts playing. - */ - addEventListener(type: 'media-started-playing', listener: (event: WebViewElement.Event) => void, useCapture?: boolean): void; - /** - * Emitted when media is paused or done playing. - */ - addEventListener(type: 'media-paused', listener: (event: WebViewElement.Event) => void, useCapture?: boolean): void; - /** - * Emitted when a page's theme color changes. This is usually due to encountering a meta tag: - * - */ - addEventListener(type: 'did-change-theme-color', listener: (event: WebViewElement.DidChangeThemeColorEvent) => void, useCapture?: boolean): void; - /** - * Emitted when mouse moves over a link or the keyboard moves the focus to a link. - */ - addEventListener(type: 'update-target-url', listener: (event: WebViewElement.UpdateTargetUrlEvent) => void, useCapture?: boolean): void; - /** - * Emitted when DevTools is opened. - */ - addEventListener(type: 'devtools-opened', listener: (event: WebViewElement.Event) => void, useCapture?: boolean): void; - /** - * Emitted when DevTools is closed. - */ - addEventListener(type: 'devtools-closed', listener: (event: WebViewElement.Event) => void, useCapture?: boolean): void; - /** - * Emitted when DevTools is focused / opened. - */ - addEventListener(type: 'devtools-focused', listener: (event: WebViewElement.Event) => void, useCapture?: boolean): void; - addEventListener(type: string, listener: (event: WebViewElement.Event) => void, useCapture?: boolean): void; - } - - namespace WebViewElement { - type Event = ElectronPrivate.GlobalEvent; - - interface LoadCommitEvent extends Event { - url: string; - isMainFrame: boolean; - } - - interface DidFailLoadEvent extends Event { - errorCode: number; - errorDescription: string; - validatedURL: string; - isMainFrame: boolean; - } - - interface DidFrameFinishLoadEvent extends Event { - isMainFrame: boolean; - } - - interface DidGetResponseDetails extends Event { - status: boolean; - newURL: string; - originalURL: string; - httpResponseCode: number; - requestMethod: string; - referrer: string; - headers: Headers; - resourceType: string; - } - - interface DidGetRedirectRequestEvent extends Event { - oldURL: string; - newURL: string; - isMainFrame: boolean; - httpResponseCode: number; - requestMethod: string; - referrer: string; - headers: Headers; - } - - interface PageTitleUpdatedEvent extends Event { - title: string; - explicitSet: string; - } - - interface PageFaviconUpdatedEvent extends Event { - favicons: string[]; - } - - interface ConsoleMessageEvent extends Event { - level: number; - message: string; - line: number; - sourceId: string; - } - - interface FoundInPageEvent extends Event { - result: FoundInPageResult; - } - - interface NewWindowEvent extends Event { - url: string; - frameName: string; - disposition: NewWindowDisposition; - options: BrowserWindowOptions; - } - - interface WillNavigateEvent extends Event { - url: string; - } - - interface DidNavigateEvent extends Event { - url: string; - } - - interface DidNavigateInPageEvent extends Event { - url: string; - isMainFrame: boolean; - } - - interface IpcMessageEvent extends Event { - channel: string; - args: any[]; - } - - interface PluginCrashedEvent extends Event { - name: string; - version: string; - } - - interface DidChangeThemeColorEvent extends Event { - themeColor: string; - } - - interface UpdateTargetUrlEvent extends Event { - url: string; - } - } - - /** - * The BrowserWindowProxy object is returned from window.open and provides limited functionality with the child window. - */ - interface BrowserWindowProxy { - /** - * Removes focus from the child window. - */ - blur(): void; - /** - * Forcefully closes the child window without calling its unload event. - */ - close(): void; - /** - * Set to true after the child window gets closed. - */ - closed: boolean; - /** - * Evaluates the code in the child window. - */ - eval(code: string): void; - /** - * Focuses the child window (brings the window to front). - */ - focus(): void; - /** - * Sends a message to the child window with the specified origin or * for no origin preference. - * In addition to these methods, the child window implements window.opener object with no - * properties and a single method. - */ - postMessage(message: string, targetOrigin: string): void; - /** - * Invokes the print dialog on the child window. - */ - print(): void; - } - - // https://github.com/electron/electron/blob/master/docs/api/synopsis.md - - interface CommonElectron { - clipboard: Electron.Clipboard; - crashReporter: Electron.CrashReporter; - nativeImage: typeof Electron.NativeImage; - shell: Electron.Shell; - - app: Electron.App; - autoUpdater: Electron.AutoUpdater; - BrowserWindow: typeof Electron.BrowserWindow; - contentTracing: Electron.ContentTracing; - dialog: Electron.Dialog; - ipcMain: Electron.IpcMain; - globalShortcut: Electron.GlobalShortcut; - Menu: typeof Electron.Menu; - MenuItem: typeof Electron.MenuItem; - powerMonitor: Electron.PowerMonitor; - powerSaveBlocker: Electron.PowerSaveBlocker; - protocol: Electron.Protocol; - screen: Electron.Screen; - session: typeof Electron.Session; - systemPreferences: Electron.SystemPreferences; - Tray: typeof Electron.Tray; - webContents: Electron.WebContentsStatic; - } - - interface ElectronMainAndRenderer extends CommonElectron { - desktopCapturer: Electron.DesktopCapturer; - ipcRenderer: Electron.IpcRenderer; - remote: Electron.Remote; - webFrame: Electron.WebFrame; - } -} - -declare namespace ElectronPrivate { - type GlobalEvent = Event; -} - -interface Document { - createElement(tagName: 'webview'): Electron.WebViewElement; -} - -// https://github.com/electron/electron/blob/master/docs/api/window-open.md - -interface Window { - /** - * Creates a new window. - */ - open(url: string, frameName?: string, features?: string): Electron.BrowserWindowProxy; -} - -// https://github.com/electron/electron/blob/master/docs/api/file-object.md - -interface File { - /** - * Exposes the real path of the filesystem. - */ - path: string; -} - -// https://github.com/electron/electron/blob/master/docs/api/process.md - -declare namespace NodeJS { - - interface ProcessVersions { - /** - * Electron's version string. - */ - electron: string; - /** - * Chrome's version string. - */ - chrome: string; - } - - interface Process { - /** - * Setting this to true can disable the support for asar archives in Node's built-in modules. - */ - noAsar?: boolean; - /** - * Process's type - */ - type: 'browser' | 'renderer'; - /** - * Path to JavaScript source code. - */ - resourcesPath: string; - /** - * For Mac App Store build, this value is true, for other builds it is undefined. - */ - mas?: boolean; - /** - * If the app is running as a Windows Store app (appx), this value is true, for other builds it is undefined. - */ - windowsStore?: boolean; - /** - * When app is started by being passed as parameter to the default app, - * this value is true in the main process, otherwise it is undefined. - */ - defaultApp?: boolean; - /** - * Emitted when Electron has loaded its internal initialization script - * and is beginning to load the web page or the main script. - */ - on(event: 'loaded', listener: Function): this; - on(event: string, listener: Function): this; - /** - * Causes the main thread of the current process crash; - */ - crash(): void; - /** - * Causes the main thread of the current process hang. - */ - hang(): void; - /** - * Sets the file descriptor soft limit to maxDescriptors or the OS hard limit, - * whichever is lower for the current process. - * - * Note: This API is only available on macOS and Linux. - */ - setFdLimit(maxDescriptors: number): void; - /** - * @returns Object giving memory usage statistics about the current process. - * Note: All statistics are reported in Kilobytes. - */ - getProcessMemoryInfo(): ProcessMemoryInfo; - /** - * @returns Object giving memory usage statistics about the entire system. - * Note: All statistics are reported in Kilobytes. - */ - getSystemMemoryInfo(): SystemMemoryInfo; - } - - interface ProcessMemoryInfo { - /** - * The amount of memory currently pinned to actual physical RAM. - */ - workingSetSize: number; - /** - * The maximum amount of memory that has ever been pinned to actual physical RAM. - */ - peakWorkingSetSize: number; - /** - * The amount of memory not shared by other processes, such as JS heap or HTML content. - */ - privateBytes: number; - /** - * The amount of memory shared between processes, typically memory consumed by the Electron code itself. - */ - sharedBytes: number; - } - - interface SystemMemoryInfo { - /** - * The total amount of physical memory available to the system. - */ - total: number; - /** - * The total amount of memory not being used by applications or disk cache. - */ - free: number; - /** - * The total amount of swap memory available to the system. - */ - swapTotal: number; - /** - * The free amount of swap memory available to the system. - */ - swapFree: number; - } -} - -declare module 'electron' { - var electron: Electron.ElectronMainAndRenderer; - export = electron; -} - -interface NodeRequireFunction { - (moduleName: 'electron'): Electron.ElectronMainAndRenderer; -} diff --git a/electron/tsconfig.json b/electron/tsconfig.json index 89c5379095..79c504aade 100644 --- a/electron/tsconfig.json +++ b/electron/tsconfig.json @@ -15,6 +15,7 @@ }, "files": [ "index.d.ts", + "electron-tests.ts", "github-electron-renderer-tests.ts", "github-electron-main-tests.ts" ] diff --git a/ember/index.d.ts b/ember/index.d.ts index df63a1312a..dca7004163 100644 --- a/ember/index.d.ts +++ b/ember/index.d.ts @@ -1514,7 +1514,7 @@ declare namespace Ember { toArray(): any[]; } class Registry { - constructor (options: any); + constructor(options: any); static set: typeof Ember.set; } @@ -2242,10 +2242,10 @@ declare namespace Ember { } namespace Test { class Adapter extends Ember.Object { - constructor (); + constructor(); } class Promise extends Ember.RSVP.Promise { - constructor (); + constructor(); } function oninjectHelpers(callback: Function): void; function promise(resolver: (a: T) => any, label: string): Ember.Test.Promise; diff --git a/ember/ember-1.11.3-tests.ts b/ember/v1/ember-tests.ts similarity index 99% rename from ember/ember-1.11.3-tests.ts rename to ember/v1/ember-tests.ts index ca88b729b6..25ca3e3cc5 100644 --- a/ember/ember-1.11.3-tests.ts +++ b/ember/v1/ember-tests.ts @@ -1,4 +1,3 @@ -/// /// diff --git a/ember/ember-1.11.3.d.ts b/ember/v1/index.d.ts similarity index 99% rename from ember/ember-1.11.3.d.ts rename to ember/v1/index.d.ts index eef72fd87c..095c31a176 100644 --- a/ember/ember-1.11.3.d.ts +++ b/ember/v1/index.d.ts @@ -6,10 +6,6 @@ /// /// -/* this is an older file, do not lint */ -/* tslint:disable */ -declare var Handlebars: HandlebarsStatic; - declare namespace EmberStates { interface Transition { diff --git a/ember/v1/tsconfig.json b/ember/v1/tsconfig.json new file mode 100644 index 0000000000..04fdc535c5 --- /dev/null +++ b/ember/v1/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "target": "es6", + "noImplicitAny": true, + "noImplicitThis": false, + "strictNullChecks": false, + "baseUrl": "../../", + "typeRoots": [ + "../../" + ], + "types": [], + "paths": { + "ember": ["ember/v0"] + }, + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "ember-tests.ts" + ] +} \ No newline at end of file diff --git a/enhanced-resolve/lib/lib-tests.ts b/enhanced-resolve/lib/lib-tests.ts index b5b0d9a266..b655652ed4 100644 --- a/enhanced-resolve/lib/lib-tests.ts +++ b/enhanced-resolve/lib/lib-tests.ts @@ -60,7 +60,7 @@ import UnsafeCachePlugin = require('enhanced-resolve/lib/UnsafeCachePlugin'); import UseFilePlugin = require('enhanced-resolve/lib/UseFilePlugin'); -import resolve = require('../'); +import resolve = require('enhanced-resolve'); const aplugin = new AliasFieldPlugin('a', 'b', 'c'); diff --git a/enhanced-resolve/tsconfig.json b/enhanced-resolve/tsconfig.json index 9f1d84c469..5bd29396ab 100644 --- a/enhanced-resolve/tsconfig.json +++ b/enhanced-resolve/tsconfig.json @@ -16,38 +16,39 @@ "files": [ "index.d.ts", "enhanced-resolve-tests.ts", - "./lib/AliasFieldPlugin.d.ts", - "./lib/AliasPlugin.d.ts", - "./lib/AppendPlugin.d.ts", - "./lib/CloneBasenamePlugin.d.ts", - "./lib/common-types.d.ts", - "./lib/concord.d.ts", - "./lib/ConcordExtensionsPlugin.d.ts", - "./lib/ConcordMainPlugin.d.ts", - "./lib/ConcordModulesPlugin.d.ts", - "./lib/DescriptionFilePlugin.d.ts", - "./lib/DescriptionFileUtils.d.ts", - "./lib/DirectoryExistsPlugin.d.ts", - "./lib/FileExistsPlugin.d.ts", - "./lib/FileKindPlugin.d.ts", - "./lib/getPaths.d.ts", - "./lib/globToRegExp.d.ts", - "./lib/JoinRequestPlugin.d.ts", - "./lib/lib-tests.ts", - "./lib/LogInfoPlugin.d.ts", - "./lib/MainFieldPlugin.d.ts", - "./lib/ModuleAppendPlugin.d.ts", - "./lib/ModuleKindPlugin.d.ts", - "./lib/ModulesInHierachicDirectoriesPlugin.d.ts", - "./lib/ModulesInRootPlugin.d.ts", - "./lib/NextPlugin.d.ts", - "./lib/ParsePlugin.d.ts", - "./lib/Resolver.d.ts", - "./lib/ResultPlugin.d.ts", - "./lib/Storage.d.ts", - "./lib/SymlinkPlugin.d.ts", - "./lib/TryNextPlugin.d.ts", - "./lib/UnsafeCachePlugin.d.ts", - "./lib/UseFilePlugin.d.ts" + "lib/AliasFieldPlugin.d.ts", + "lib/AliasPlugin.d.ts", + "lib/AppendPlugin.d.ts", + "lib/CloneBasenamePlugin.d.ts", + "lib/common-types.d.ts", + "lib/concord.d.ts", + "lib/ConcordExtensionsPlugin.d.ts", + "lib/ConcordMainPlugin.d.ts", + "lib/ConcordModulesPlugin.d.ts", + "lib/DescriptionFilePlugin.d.ts", + "lib/DescriptionFileUtils.d.ts", + "lib/DirectoryExistsPlugin.d.ts", + "lib/FileExistsPlugin.d.ts", + "lib/FileKindPlugin.d.ts", + "lib/getPaths.d.ts", + "lib/globToRegExp.d.ts", + "lib/JoinRequestPlugin.d.ts", + "lib/lib-tests.ts", + "lib/LogInfoPlugin.d.ts", + "lib/MainFieldPlugin.d.ts", + "lib/ModuleAppendPlugin.d.ts", + "lib/ModuleKindPlugin.d.ts", + "lib/ModulesInHierachicDirectoriesPlugin.d.ts", + "lib/ModulesInRootPlugin.d.ts", + "lib/NextPlugin.d.ts", + "lib/ParsePlugin.d.ts", + "lib/Resolver.d.ts", + "lib/ResultPlugin.d.ts", + "lib/Storage.d.ts", + "lib/SymlinkPlugin.d.ts", + "lib/SyncAsyncFileSystemDecorator.d.ts", + "lib/TryNextPlugin.d.ts", + "lib/UnsafeCachePlugin.d.ts", + "lib/UseFilePlugin.d.ts" ] } diff --git a/enzyme/enzyme-1.2.0-tests.tsx b/enzyme/enzyme-1.2.0-tests.tsx deleted file mode 100644 index 44db5705bc..0000000000 --- a/enzyme/enzyme-1.2.0-tests.tsx +++ /dev/null @@ -1,605 +0,0 @@ -/// -/// - -import { shallow, mount, render, describeWithDOM, spyLifecycle } from "enzyme"; -import * as React from "react"; -import {Component, ReactElement, HTMLAttributes} from "react"; -import {ShallowWrapper, ReactWrapper, CheerioWrapper} from "enzyme"; - - -// Help classes/interfaces -interface MyComponentProps { - propsProperty: any; - numberProp?: number; -} - -interface StatelessProps { - stateless: any; -} - -interface MyComponentState { - stateProperty: any; -} - -class MyComponent extends Component { - setState(...args: any[]) { - } -} - -const MyStatelessComponent = (props: StatelessProps) => ; - -// API -namespace SpyLifecycleTest { - spyLifecycle(MyComponent); -} - -// ShallowWrapper -namespace ShallowWrapperTest { - var shallowWrapper: ShallowWrapper = - shallow(); - - var reactElement: ReactElement, - objectVal: Object, - boolVal: Boolean, - stringVal: String, - elementWrapper: ShallowWrapper - - function test_find() { - elementWrapper = shallowWrapper.find('.selector'); - shallowWrapper = shallowWrapper.find(MyComponent); - shallowWrapper.find(MyStatelessComponent).props().stateless; - shallowWrapper.find(MyStatelessComponent).shallow(); - } - - function test_findWhere() { - shallowWrapper = - shallowWrapper.findWhere((aShallowWrapper: ShallowWrapper) => true); - } - - function test_filter() { - elementWrapper = shallowWrapper.filter('.selector'); - shallowWrapper = shallowWrapper.filter(MyComponent).shallow(); - } - - function test_filterWhere() { - shallowWrapper = - shallowWrapper.filterWhere(wrapper => { - wrapper.props().propsProperty; - return true; - }); - } - - function test_contains() { - boolVal = shallowWrapper.contains(
); - } - - function test_hasClass() { - boolVal = shallowWrapper.find('.my-button').hasClass('disabled'); - } - - function test_is() { - boolVal = shallowWrapper.is('.some-class'); - } - - function test_not() { - elementWrapper = shallowWrapper.find('.foo').not('.bar'); - } - - function test_children() { - shallowWrapper = shallowWrapper.children(); - shallowWrapper.children(MyStatelessComponent).props().stateless; - } - - function test_parents() { - shallowWrapper = shallowWrapper.parents(); - } - - function test_parent() { - shallowWrapper = shallowWrapper.parent(); - } - - function test_closest() { - elementWrapper = shallowWrapper.closest('.selector'); - shallowWrapper = shallowWrapper.closest(MyComponent); - } - - function test_shallow() { - shallowWrapper = shallowWrapper.shallow(); - } - - function test_unmount() { - shallowWrapper = shallowWrapper.unmount(); - } - - function test_render() { - var cheerioWrapper: CheerioWrapper = shallowWrapper.render(); - } - - function test_text() { - stringVal = shallowWrapper.text(); - } - - - function test_html() { - stringVal = shallowWrapper.html(); - } - - function test_get() { - reactElement = shallowWrapper.get(1); - } - - function test_at() { - shallowWrapper = shallowWrapper.at(1); - } - - function test_first() { - shallowWrapper = shallowWrapper.first(); - } - - function test_last() { - shallowWrapper = shallowWrapper.last(); - } - - function test_state() { - shallowWrapper.state(); - shallowWrapper.state('key'); - } - - function test_props() { - objectVal = shallowWrapper.props(); - } - - function test_prop() { - shallowWrapper.prop('key'); - } - - - function test_simulate(...args: any[]) { - shallowWrapper.simulate('click'); - shallowWrapper.simulate('click', args); - } - - function test_setState() { - shallowWrapper = shallowWrapper.setState({stateProperty: 'state'}); - } - - function test_setProps() { - shallowWrapper = shallowWrapper.setProps({propsProperty: 'foo'}); - } - - function test_setContext() { - shallowWrapper = shallowWrapper.setContext({name: 'baz'}); - } - - function test_instance() { - var myComponent: MyComponent = shallowWrapper.instance(); - } - - function test_update() { - shallowWrapper = shallowWrapper.update(); - } - - function test_debug() { - stringVal = shallowWrapper.debug(); - } - - function test_type() { - var stringOrFunction: String|Function = shallowWrapper.type(); - } - - function test_forEach() { - shallowWrapper = - shallowWrapper.forEach(wrapper => wrapper.shallow().props().propsProperty); - } - - function test_map() { - var arrayNumbers: Array = - shallowWrapper.map(wrapper => wrapper.props().numberProp); - } - - function test_reduce() { - const total: number[] = - shallowWrapper.reduce( - (amount: number, n: ShallowWrapper) => amount + n.props().numberProp - ); - } - - function test_reduceRight() { - const total: number[] = - shallowWrapper.reduceRight( - (amount: number, n: ShallowWrapper) => amount + n.prop('amount') - ); - } - - function test_some() { - boolVal = shallowWrapper.some('.selector'); - boolVal = shallowWrapper.some(MyComponent); - } - - function test_someWhere() { - boolVal = shallowWrapper.someWhere((aShallowWrapper: ShallowWrapper) => true); - } - - function test_every() { - boolVal = shallowWrapper.every('.selector'); - boolVal = shallowWrapper.every(MyComponent); - } - - function test_everyWhere() { - boolVal = shallowWrapper.everyWhere((aShallowWrapper: ShallowWrapper) => true); - } -} - - -// ReactWrapper -namespace ReactWrapperTest { - var reactWrapper: ReactWrapper = - mount(); - - var reactElement: ReactElement, - objectVal: Object, - boolVal: Boolean, - stringVal: String, - elementWrapper: ReactWrapper - - function test_unmount() { - reactWrapper = reactWrapper.unmount(); - } - - function test_mount() { - reactWrapper = reactWrapper.mount(); - } - - function test_find() { - elementWrapper = reactWrapper.find('.selector'); - reactWrapper = reactWrapper.find(MyComponent); - reactWrapper.find(MyStatelessComponent).props().stateless; - } - - function test_findWhere() { - reactWrapper = - reactWrapper.findWhere((aReactWrapper: ReactWrapper) => true); - } - - function test_filter() { - elementWrapper = reactWrapper.filter('.selector'); - reactWrapper = reactWrapper.filter(MyComponent); - } - - function test_filterWhere() { - reactWrapper = - reactWrapper.filterWhere(wrapper => { - wrapper.props().propsProperty; - return true; - }); - } - - function test_contains() { - boolVal = reactWrapper.contains(
); - } - - function test_hasClass() { - boolVal = reactWrapper.find('.my-button').hasClass('disabled'); - } - - function test_is() { - boolVal = reactWrapper.is('.some-class'); - } - - function test_not() { - elementWrapper = reactWrapper.find('.foo').not('.bar'); - } - - function test_children() { - reactWrapper = reactWrapper.children(); - } - - function test_parents() { - reactWrapper = reactWrapper.parents(); - } - - function test_parent() { - reactWrapper = reactWrapper.parent(); - } - - function test_closest() { - elementWrapper = reactWrapper.closest('.selector'); - reactWrapper = reactWrapper.closest(MyComponent); - } - - function test_text() { - stringVal = reactWrapper.text(); - } - - function test_html() { - stringVal = reactWrapper.html(); - } - - function test_get() { - reactElement = reactWrapper.get(1); - } - - function test_at() { - reactWrapper = reactWrapper.at(1); - } - - function test_first() { - reactWrapper = reactWrapper.first(); - } - - function test_last() { - reactWrapper = reactWrapper.last(); - } - - function test_state() { - reactWrapper.state(); - reactWrapper.state('key'); - } - - function test_props() { - objectVal = reactWrapper.props(); - } - - function test_prop() { - reactWrapper.prop('key'); - } - - - function test_simulate(...args: any[]) { - reactWrapper.simulate('click'); - reactWrapper.simulate('click', args); - } - - function test_setState() { - reactWrapper = reactWrapper.setState({stateProperty: 'state'}); - } - - function test_setProps() { - reactWrapper = reactWrapper.setProps({propsProperty: 'foo'}); - } - - function test_setContext() { - reactWrapper = reactWrapper.setContext({name: 'baz'}); - } - - function test_instance() { - var myComponent: MyComponent = reactWrapper.instance(); - } - - function test_update() { - reactWrapper = reactWrapper.update(); - } - - function test_debug() { - stringVal = reactWrapper.debug(); - } - - function test_type() { - var stringOrFunction: String|Function = reactWrapper.type(); - } - - function test_forEach() { - reactWrapper = - reactWrapper.forEach(wrapper => wrapper.props().propsProperty); - } - - function test_map() { - var arrayNumbers: Array = - reactWrapper.map(wrapper => wrapper.props().numberProp); - } - - function test_reduce() { - const total: number[] = - reactWrapper.reduce( - (amount: number, n: ReactWrapper) => amount + n.prop('amount') - ); - } - - function test_reduceRight() { - const total: number[] = - reactWrapper.reduceRight( - (amount: number, n: ReactWrapper) => amount + n.prop('amount') - ); - } - - function test_some() { - boolVal = reactWrapper.some('.selector'); - boolVal = reactWrapper.some(MyComponent); - } - - function test_someWhere() { - boolVal = reactWrapper.someWhere((aReactWrapper: ReactWrapper) => true); - } - - function test_every() { - boolVal = reactWrapper.every('.selector'); - boolVal = reactWrapper.every(MyComponent); - } - - function test_everyWhere() { - boolVal = reactWrapper.everyWhere((aReactWrapper: ReactWrapper) => true); - } -} - -// CheerioWrapper -namespace CheerioWrapperTest { - var cheerioWrapper: CheerioWrapper = - render(); - - var reactElement: ReactElement, - objectVal: Object, - boolVal: Boolean, - stringVal: String, - elementWrapper: CheerioWrapper - - function test_find() { - elementWrapper = cheerioWrapper.find('.selector'); - cheerioWrapper = cheerioWrapper.find(MyComponent); - cheerioWrapper.find(MyStatelessComponent).props().stateless; - } - - function test_findWhere() { - cheerioWrapper = - cheerioWrapper.findWhere((aCheerioWrapper: CheerioWrapper) => true); - } - - function test_filter() { - elementWrapper = cheerioWrapper.filter('.selector'); - cheerioWrapper = cheerioWrapper.filter(MyComponent); - } - - function test_filterWhere() { - cheerioWrapper = - cheerioWrapper.filterWhere(wrapper => { - wrapper.props().propsProperty; - return true; - }); - } - - function test_contains() { - boolVal = cheerioWrapper.contains(
); - } - - function test_hasClass() { - boolVal = cheerioWrapper.find('.my-button').hasClass('disabled'); - } - - function test_is() { - boolVal = cheerioWrapper.is('.some-class'); - } - - function test_not() { - elementWrapper = cheerioWrapper.find('.foo').not('.bar'); - } - - function test_children() { - cheerioWrapper = cheerioWrapper.children(); - } - - function test_parents() { - cheerioWrapper = cheerioWrapper.parents(); - } - - function test_parent() { - cheerioWrapper = cheerioWrapper.parent(); - } - - function test_closest() { - elementWrapper = cheerioWrapper.closest('.selector'); - cheerioWrapper = cheerioWrapper.closest(MyComponent); - } - - function test_text() { - stringVal = cheerioWrapper.text(); - } - - function test_html() { - stringVal = cheerioWrapper.html(); - } - - function test_get() { - reactElement = cheerioWrapper.get(1); - } - - function test_at() { - cheerioWrapper = cheerioWrapper.at(1); - } - - function test_first() { - cheerioWrapper = cheerioWrapper.first(); - } - - function test_last() { - cheerioWrapper = cheerioWrapper.last(); - } - - function test_state() { - cheerioWrapper.state(); - cheerioWrapper.state('key'); - } - - function test_props() { - objectVal = cheerioWrapper.props(); - } - - function test_prop() { - cheerioWrapper.prop('key'); - } - - - function test_simulate(...args: any[]) { - cheerioWrapper.simulate('click'); - cheerioWrapper.simulate('click', args); - } - - function test_setState() { - cheerioWrapper = cheerioWrapper.setState({stateProperty: 'state'}); - } - - function test_setProps() { - cheerioWrapper = cheerioWrapper.setProps({propsProperty: 'foo'}); - } - - function test_setContext() { - cheerioWrapper = cheerioWrapper.setContext({name: 'baz'}); - } - - function test_instance() { - var myComponent: MyComponent = cheerioWrapper.instance(); - } - - function test_update() { - cheerioWrapper = cheerioWrapper.update(); - } - - function test_debug() { - stringVal = cheerioWrapper.debug(); - } - - function test_type() { - var stringOrFunction: String|Function = cheerioWrapper.type(); - } - - function test_forEach() { - cheerioWrapper = - cheerioWrapper.forEach((aCheerioWrapper: CheerioWrapper)=> { - }); - } - - function test_map() { - var arrayNumbers: Array = - cheerioWrapper.map(wrapper => wrapper.props().numberProp); - } - - function test_reduce() { - const total: number[] = - cheerioWrapper.reduce( - (amount: number, n: CheerioWrapper) => amount + n.prop('amount') - ); - } - - function test_reduceRight() { - const total: number[] = - cheerioWrapper.reduceRight( - (amount: number, n: CheerioWrapper) => amount + n.prop('amount') - ); - } - - function test_some() { - boolVal = cheerioWrapper.some('.selector'); - boolVal = cheerioWrapper.some(MyComponent); - } - - function test_someWhere() { - boolVal = cheerioWrapper.someWhere((aCheerioWrapper: CheerioWrapper) => true); - } - - function test_every() { - boolVal = cheerioWrapper.every('.selector'); - boolVal = cheerioWrapper.every(MyComponent); - } - - function test_everyWhere() { - boolVal = cheerioWrapper.everyWhere((aCheerioWrapper: CheerioWrapper) => true); - } -} diff --git a/enzyme/enzyme-1.2.0.d.ts b/enzyme/enzyme-1.2.0.d.ts deleted file mode 100644 index 865331529b..0000000000 --- a/enzyme/enzyme-1.2.0.d.ts +++ /dev/null @@ -1,473 +0,0 @@ -// Type definitions for Enzyme v1.2.0 -// Project: https://github.com/airbnb/enzyme -// Definitions by: Marian Palkus , Cap3 -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -/// - -declare module "enzyme" { - - import {ReactElement, Component, StatelessComponent, ComponentClass, HTMLAttributes} from "react"; - - export class ElementClass extends Component { - } - - /** - * Many methods in Enzyme's API accept a selector as an argument. Selectors in Enzyme can fall into one of the - * following three categories: - * - * 1. A Valid CSS Selector - * 2. A React Component Constructor - * 3. A React Component's displayName - */ - export type EnzymeSelector = String | typeof ElementClass; - - interface CommonWrapper { - /** - * Find every node in the render tree that matches the provided selector. - * @param selector The selector to match. - */ - find(component: ComponentClass): CommonWrapper; - find(statelessComponent: StatelessComponent): CommonWrapper; - find(selector: string): CommonWrapper; - - /** - * Finds every node in the render tree that returns true for the provided predicate function. - * @param predicate - */ - findWhere(predicate: (wrapper: CommonWrapper) => Boolean): CommonWrapper; - - /** - * Removes nodes in the current wrapper that do not match the provided selector. - * @param selector The selector to match. - */ - filter(component: ComponentClass): CommonWrapper; - filter(statelessComponent: StatelessComponent): CommonWrapper; - filter(selector: string): CommonWrapper; - - /** - * Returns a new wrapper with only the nodes of the current wrapper that, when passed into the provided predicate function, return true. - * @param predicate - */ - filterWhere(predicate: (wrapper: this) => Boolean): this; - - /** - * Returns whether or not the current wrapper has a node anywhere in it's render tree that looks like the one passed in. - * @param node - */ - contains(node: ReactElement): Boolean; - - /** - * Returns whether or not the current node has a className prop including the passed in class name. - * @param className - */ - hasClass(className: String): Boolean; - - /** - * Returns whether or not the current node matches a provided selector. - * @param selector - */ - is(selector: EnzymeSelector): Boolean; - - /** - * Returns a new wrapper with only the nodes of the current wrapper that don't match the provided selector. - * This method is effectively the negation or inverse of filter. - * @param selector - */ - not(selector: EnzymeSelector): this; - - /** - * Returns a new wrapper with all of the children of the node(s) in the current wrapper. Optionally, a selector - * can be provided and it will filter the children by this selector. - * @param [selector] - */ - children(component: ComponentClass): CommonWrapper; - children(statelessComponent: StatelessComponent): CommonWrapper; - children(selector: string): CommonWrapper; - children(): CommonWrapper; - - /** - * Returns a wrapper around all of the parents/ancestors of the wrapper. Does not include the node in the - * current wrapper. Optionally, a selector can be provided and it will filter the parents by this selector. - * - * Note: can only be called on a wrapper of a single node. - * @param [selector] - */ - parents(component: ComponentClass): CommonWrapper; - parents(statelessComponent: StatelessComponent): CommonWrapper; - parents(selector: string): CommonWrapper; - parents(): CommonWrapper; - - /** - * Returns a wrapper with the direct parent of the node in the current wrapper. - */ - parent(): CommonWrapper; - - /** - * Returns a wrapper of the first element that matches the selector by traversing up through the current node's - * ancestors in the tree, starting with itself. - * - * Note: can only be called on a wrapper of a single node. - * @param selector - */ - closest(component: ComponentClass): CommonWrapper; - closest(statelessComponent: StatelessComponent): CommonWrapper; - closest(selector: string): CommonWrapper; - - /** - * Returns a string of the rendered text of the current render tree. This function should be looked at with - * skepticism if being used to test what the actual HTML output of the component will be. If that is what you - * would like to test, use enzyme's render function instead. - * - * Note: can only be called on a wrapper of a single node. - */ - text(): String; - - /** - * Returns a string of the rendered HTML markup of the current render tree. - * - * Note: can only be called on a wrapper of a single node. - */ - html(): String; - - /** - * Returns the node at a given index of the current wrapper. - * @param index - */ - get(index: number): ReactElement; - - /** - * Returns a wrapper around the node at a given index of the current wrapper. - * @param index - */ - at(index: number): this; - - /** - * Reduce the set of matched nodes to the first in the set. - */ - first(): this; - - /** - * Reduce the set of matched nodes to the last in the set. - */ - last(): this; - - /** - * Returns the state hash for the root node of the wrapper. Optionally pass in a prop name and it will return just that value. - * @param [key] - */ - state(key?: String): any; - - /** - * Returns the props hash for the current node of the wrapper. - * - * NOTE: can only be called on a wrapper of a single node. - */ - props(): P; - - /** - * Returns the prop value for the node of the current wrapper with the provided key. - * - * NOTE: can only be called on a wrapper of a single node. - * @param key - */ - prop(key: String): any; - - /** - * Simulate events. - * Returns itself. - * @param event - * @param args? - */ - simulate(event: string, ...args: any[]): this; - - /** - * A method to invoke setState() on the root component instance similar to how you might in the definition of - * the component, and re-renders. This method is useful for testing your component in hard to achieve states, - * however should be used sparingly. If possible, you should utilize your component's external API in order to - * get it into whatever state you want to test, in order to be as accurate of a test as possible. This is not - * always practical, however. - * Returns itself. - * - * NOTE: can only be called on a wrapper instance that is also the root instance. - * @param state - */ - setState(state: S): this; - - /** - * A method that sets the props of the root component, and re-renders. Useful for when you are wanting to test - * how the component behaves over time with changing props. Calling this, for instance, will call the - * componentWillReceiveProps lifecycle method. - * - * Similar to setState, this method accepts a props object and will merge it in with the already existing props. - * Returns itself. - * - * NOTE: can only be called on a wrapper instance that is also the root instance. - * @param state - */ - setProps(props: P): this; - - /** - * A method that sets the context of the root component, and re-renders. Useful for when you are wanting to - * test how the component behaves over time with changing contexts. - * Returns itself. - * - * NOTE: can only be called on a wrapper instance that is also the root instance. - * @param state - */ - setContext(context: Object): this; - - /** - * Gets the instance of the component being rendered as the root node passed into shallow(). - * - * NOTE: can only be called on a wrapper instance that is also the root instance. - */ - instance(): Component; - - /** - * Forces a re-render. Useful to run before checking the render output if something external may be updating - * the state of the component somewhere. - * Returns itself. - * - * NOTE: can only be called on a wrapper instance that is also the root instance. - */ - update(): this; - - /** - * Returns an html-like string of the wrapper for debugging purposes. Useful to print out to the console when - * tests are not passing when you expect them to. - */ - debug(): String; - - /** - * Returns the type of the current node of this wrapper. If it's a composite component, this will be the - * component constructor. If it's native DOM node, it will be a string of the tag name. - * - * Note: can only be called on a wrapper of a single node. - */ - type(): String | Function; - - /** - * Iterates through each node of the current wrapper and executes the provided function with a wrapper around - * the corresponding node passed in as the first argument. - * - * Returns itself. - * @param fn A callback to be run for every node in the collection. Should expect a ShallowWrapper as the first - * argument, index as a second, and will be run with a context of the original instance. - */ - forEach(fn: (wrapper: this, index?: number) => any): this; - - /** - * Maps the current array of nodes to another array. Each node is passed in as a ShallowWrapper to the map - * function. - * Returns an array of the returned values from the mapping function.. - * @param fn A mapping function to be run for every node in the collection, the results of which will be mapped - * to the returned array. Should expect a ShallowWrapper as the first argument, and will be run - * with a context of the original instance. - */ - map(fn: (wrapper: this) => V): V[]; - - /** - * Applies the provided reducing function to every node in the wrapper to reduce to a single value. Each node - * is passed in as a ShallowWrapper, and is processed from left to right. - * @param fn - * @param initialValue - */ - reduce(fn: (prevVal: R, wrapper: this, index: number) => R, initialValue?: R): R[]; - - /** - * Applies the provided reducing function to every node in the wrapper to reduce to a single value. - * Each node is passed in as a ShallowWrapper, and is processed from right to left. - * @param fn - * @param initialValue - */ - reduceRight(fn: (prevVal: R, wrapper: this, index: number) => R, initialValue?: R): R[]; - - /** - * Returns whether or not any of the nodes in the wrapper match the provided selector. - * @param selector - */ - some(selector: EnzymeSelector): Boolean; - - /** - * Returns whether or not any of the nodes in the wrapper pass the provided predicate function. - * @param fn - */ - someWhere(fn: (wrapper: this) => Boolean): Boolean; - - /** - * Returns whether or not all of the nodes in the wrapper match the provided selector. - * @param selector - */ - every(selector: EnzymeSelector): Boolean; - - /** - * Returns whether or not any of the nodes in the wrapper pass the provided predicate function. - * @param fn - */ - everyWhere(fn: (wrapper: this) => Boolean): Boolean; - - length: number; - } - - export interface ShallowWrapper extends CommonWrapper { - shallow(): ShallowWrapper; - render(): CheerioWrapper; - unmount(): ShallowWrapper; - - /** - * Find every node in the render tree that matches the provided selector. - * @param selector The selector to match. - */ - find(component: ComponentClass): ShallowWrapper; - find(statelessComponent: (props: P2) => JSX.Element): ShallowWrapper; - find(selector: string): ShallowWrapper; - - /** - * Removes nodes in the current wrapper that do not match the provided selector. - * @param selector The selector to match. - */ - filter(component: ComponentClass): ShallowWrapper; - filter(statelessComponent: StatelessComponent): ShallowWrapper; - filter(selector: string): ShallowWrapper; - - /** - * Finds every node in the render tree that returns true for the provided predicate function. - * @param predicate - */ - findWhere(predicate: (wrapper: CommonWrapper) => Boolean): ShallowWrapper; - - /** - * Returns a new wrapper with all of the children of the node(s) in the current wrapper. Optionally, a selector - * can be provided and it will filter the children by this selector. - * @param [selector] - */ - children(component: ComponentClass): ShallowWrapper; - children(statelessComponent: StatelessComponent): ShallowWrapper; - children(selector: string): ShallowWrapper; - children(): ShallowWrapper; - - /** - * Returns a wrapper around all of the parents/ancestors of the wrapper. Does not include the node in the - * current wrapper. Optionally, a selector can be provided and it will filter the parents by this selector. - * - * Note: can only be called on a wrapper of a single node. - * @param [selector] - */ - parents(component: ComponentClass): ShallowWrapper; - parents(statelessComponent: StatelessComponent): ShallowWrapper; - parents(selector: string): ShallowWrapper; - parents(): ShallowWrapper; - - /** - * Returns a wrapper of the first element that matches the selector by traversing up through the current node's - * ancestors in the tree, starting with itself. - * - * Note: can only be called on a wrapper of a single node. - * @param selector - */ - closest(component: ComponentClass): ShallowWrapper; - closest(statelessComponent: StatelessComponent): ShallowWrapper; - closest(selector: string): ShallowWrapper; - - /** - * Returns a wrapper with the direct parent of the node in the current wrapper. - */ - parent(): ShallowWrapper; - } - - export interface ReactWrapper extends CommonWrapper { - unmount(): ReactWrapper; - mount(): ReactWrapper; - - /** - * Find every node in the render tree that matches the provided selector. - * @param selector The selector to match. - */ - find(component: ComponentClass): ReactWrapper; - find(statelessComponent: (props: P2) => JSX.Element): ReactWrapper; - find(selector: string): ReactWrapper; - - /** - * Finds every node in the render tree that returns true for the provided predicate function. - * @param predicate - */ - findWhere(predicate: (wrapper: CommonWrapper) => Boolean): ReactWrapper; - - /** - * Removes nodes in the current wrapper that do not match the provided selector. - * @param selector The selector to match. - */ - filter(component: ComponentClass): ReactWrapper; - filter(statelessComponent: StatelessComponent): ReactWrapper; - filter(selector: string): ReactWrapper; - - /** - * Returns a new wrapper with all of the children of the node(s) in the current wrapper. Optionally, a selector - * can be provided and it will filter the children by this selector. - * @param [selector] - */ - children(component: ComponentClass): ReactWrapper; - children(statelessComponent: StatelessComponent): ReactWrapper; - children(selector: string): ReactWrapper; - children(): ReactWrapper; - - /** - * Returns a wrapper around all of the parents/ancestors of the wrapper. Does not include the node in the - * current wrapper. Optionally, a selector can be provided and it will filter the parents by this selector. - * - * Note: can only be called on a wrapper of a single node. - * @param [selector] - */ - parents(component: ComponentClass): ReactWrapper; - parents(statelessComponent: StatelessComponent): ReactWrapper; - parents(selector: string): ReactWrapper; - parents(): ReactWrapper; - - /** - * Returns a wrapper of the first element that matches the selector by traversing up through the current node's - * ancestors in the tree, starting with itself. - * - * Note: can only be called on a wrapper of a single node. - * @param selector - */ - closest(component: ComponentClass): ReactWrapper; - closest(statelessComponent: StatelessComponent): ReactWrapper; - closest(selector: string): ReactWrapper; - - /** - * Returns a wrapper with the direct parent of the node in the current wrapper. - */ - parent(): ReactWrapper; - } - - export interface CheerioWrapper extends CommonWrapper { - - } - - /** - * Shallow rendering is useful to constrain yourself to testing a component as a unit, and to ensure that - * your tests aren't indirectly asserting on behavior of child components. - * @param node - * @param [options] - */ - export function shallow(node: ReactElement

, options?: any): ShallowWrapper; - - /** - * Mounts and renders a react component into the document and provides a testing wrapper around it. - * @param node - * @param [options] - */ - export function mount(node: ReactElement

, options?: any): ReactWrapper; - - /** - * Render react components to static HTML and analyze the resulting HTML structure. - * @param node - * @param [options] - */ - export function render(node: ReactElement

, options?: any): CheerioWrapper; - - export function describeWithDOM(description: String, fn: Function): void; - - export function spyLifecycle(component: typeof Component): void; -} diff --git a/eq.js/eq.js.tests.ts b/eq.js/eq.js-tests.ts similarity index 100% rename from eq.js/eq.js.tests.ts rename to eq.js/eq.js-tests.ts diff --git a/eq.js/tsconfig.json b/eq.js/tsconfig.json index 5d9487eb7c..a142a97c54 100644 --- a/eq.js/tsconfig.json +++ b/eq.js/tsconfig.json @@ -15,6 +15,6 @@ }, "files": [ "index.d.ts", - "eq.js.tests.ts" + "eq.js-tests.ts" ] } \ No newline at end of file diff --git a/es6-promise/es6-promise-commonjs-tests.ts b/es6-promise/es6-promise-commonjs-tests.ts deleted file mode 100644 index 4d78715245..0000000000 --- a/es6-promise/es6-promise-commonjs-tests.ts +++ /dev/null @@ -1,160 +0,0 @@ - - -import rsvp = require('es6-promise'); -rsvp.polyfill(); // Test for polyfill method existence -var Promise = rsvp.Promise; - -var promiseString: Promise, - promiseStringArr: Promise, - arrayOfPromise: Promise[], - promiseNumber: Promise, - promiseAny: Promise, - thenable: Thenable; - -// constructor test -var constructResult = new Promise((resolve, reject) => { - resolve('a string'); -}); -promiseString = constructResult; - - -var constructResult1 = new Promise((resolve: (promise: Thenable) => void) => { - resolve(Promise.resolve('a string')); -}); -promiseString = constructResult1; - -//resolve test -var resolveResult = Promise.resolve('a string'); -promiseString = resolveResult; - -var resolveResult1 = Promise.resolve(thenable); -promiseString = resolveResult1; - -//reject test -var rejectResult = Promise.reject('there is an error'); -promiseAny = rejectResult; - -//all test -var allResult = Promise.all(arrayOfPromise); -promiseStringArr = allResult; - -//race test -var raceResult = Promise.race(arrayOfPromise); -promiseString = raceResult; - - -//then test -var thenWithPromiseResult = promiseString.then(word => Promise.resolve(word.length)); -promiseNumber = thenWithPromiseResult; - -var thenWithPromiseResultAndPromiseReject = promiseString.then(word => Promise.resolve(word.length), error => Promise.resolve(10)); -promiseNumber = thenWithPromiseResultAndPromiseReject; - -var thenWithPromiseResultAndSimpleReject = promiseString.then(word => Promise.resolve(word.length), error => 10); -promiseNumber = thenWithPromiseResultAndSimpleReject; - -var thenWithSimpleResult = promiseString.then(word => word.length); -promiseNumber = thenWithSimpleResult; - -var thenWithSimpleResultAndPromiseReject = promiseString.then(word => word.length, error => Promise.resolve(10)); -promiseNumber = thenWithSimpleResultAndPromiseReject; - -var thenWithSimpleResultAndSimpleReject = promiseString.then(word => word.length, error => 10); -promiseNumber = thenWithSimpleResultAndSimpleReject; - -var thenWithUndefinedFullFillAndSimpleReject = promiseString.then(undefined, error => 10); -promiseNumber = thenWithUndefinedFullFillAndSimpleReject; - -var thenWithUndefinedFullFillAndPromiseReject = promiseString.then(undefined, error => Promise.resolve(10)); -promiseNumber = thenWithUndefinedFullFillAndPromiseReject; - -var thenWithNoResultAndNoReject = promiseString.then(); -promiseNumber = thenWithNoResultAndNoReject; - -//catch test -var catchWithSimpleResult = promiseString.catch(error => 10); -promiseNumber = catchWithSimpleResult; - -var catchWithPromiseResult = promiseString.catch(error => Promise.resolve(10)); -promiseNumber = catchWithPromiseResult; - - -//examples coming from http://www.html5rocks.com/en/tutorials/es6/promises/ - -function get(url: string) { - // Return a new promise. - return new Promise(function (resolve, reject) { - // Do the usual XHR stuff - var req = new XMLHttpRequest(); - req.open('GET', url); - - req.onload = function () { - // This is called even on 404 etc - // so check the status - if (req.status == 200) { - // Resolve the promise with the response text - resolve(req.response); - } - else { - // Otherwise reject with the status text - // which will hopefully be a meaningful error - reject(Error(req.statusText)); - } - }; - - // Handle network errors - req.onerror = function () { - reject(Error("Network Error")); - }; - - // Make the request - req.send(); - }); -} - - - -function getJSON(url: string) { - return get(url).then(JSON.parse); -} - -function addHtmlToPage(html: string) { - -} - -function addTextToPage(text: string) { - -} - -interface Story { - heading: string; - chapterUrls: string[] -} - -getJSON('story.json').then(function (story: Story) { - addHtmlToPage(story.heading); - - // Map our array of chapter urls to - // an array of chapter json promises. - // This makes sure they all download parallel. - return story.chapterUrls.map(getJSON) - .reduce(function (sequence, chapterPromise) { - // Use reduce to chain the promises together, - // adding content to the page for each chapter - return sequence.then(function () { - // Wait for everything in the sequence so far, - // then wait for this chapter to arrive. - return chapterPromise; - }).then(function (chapter) { - addHtmlToPage(chapter.html); - }); - }, Promise.resolve()); -}).then(function () { - addTextToPage("All done"); - }).catch(function (err) { - // catch any error that happened along the way - addTextToPage("Argh, broken: " + err.message); - }).then(function () { - (document.querySelector('.spinner')).style.display = 'none'; - }); - diff --git a/estree/UNUSED_FILES.txt b/estree/UNUSED_FILES.txt new file mode 100644 index 0000000000..4cee47e30f --- /dev/null +++ b/estree/UNUSED_FILES.txt @@ -0,0 +1 @@ +flow.d.ts \ No newline at end of file diff --git a/estree/estree-tests.ts b/estree/estree-tests.ts index ebfb4efe57..0d4b8f5bd9 100644 --- a/estree/estree-tests.ts +++ b/estree/estree-tests.ts @@ -1,4 +1,4 @@ -import * as ESTree from './index'; +import * as ESTree from 'estree'; declare var node: ESTree.Node; declare var program: ESTree.Program; diff --git a/eventemitter3/eventemitter3-tests.ts.tscparams b/eventemitter3/eventemitter3-tests.ts.tscparams deleted file mode 100644 index 30c9419a57..0000000000 --- a/eventemitter3/eventemitter3-tests.ts.tscparams +++ /dev/null @@ -1 +0,0 @@ --m commonjs diff --git a/expect.js/expect.js-commonjs-tests.ts b/expect.js/expect.js-commonjs-tests.ts deleted file mode 100644 index 52442be9a2..0000000000 --- a/expect.js/expect.js-commonjs-tests.ts +++ /dev/null @@ -1,129 +0,0 @@ - - -import expect = require("expect.js"); - -function test_expect() { - expect(); - expect(1); - expect(true); - expect({}); - expect(0); -} - -function test_expect_properties() { - expect(0).be.an; - expect(0).have.own; - expect(0).not.be.an; - expect(0).not.have.own; - expect(0).not.include; - expect(0).not.only.have.own; - expect(0).not.to.be; - expect(0).not.to.have.own; - expect(0).not.to.include; - expect(0).not.to.only.have.own; - expect(0).only.have.own; - expect(0).to.be.an; - expect(0).to.have.own; - expect(0).to.include; - expect(0).to.not.be.an; - expect(0).to.not.have.own; - expect(0).to.not.include; - expect(0).to.not.only.have.own; - expect(0).to.only.have.own; - expect(0).be; -} - -function test_ok() { - expect(true).to.be.ok(); -} - -function test_be() { - expect(1).to.be(1); -} - -function test_equal() { - expect(1).to.equal(1); -} - -function test_eql() { - expect({ a: 'b' }).to.eql({ a: 'b' }); -} - -function test_a() { - // string - expect(5).to.be.a('number'); - expect([]).to.be.an('array'); - - // constructors - expect(5).to.be.a(Number); - expect([]).to.be.an(Array); -} - -function test_match() { - expect('1.2.3').to.match(/[0-9]+\.[0-9]+\.[0-9]+/); -} - -function test_contain() { - // string - expect('hello world').to.contain('world'); - expect('hello world').to.string('world'); - // any - expect([1, 2]).to.contain(1); - expect([1, 2]).to.string(1); -} - -function test_length() { - expect([1,2,3]).to.have.length(3); -} - -function test_empty() { - expect([]).to.be.empty(); -} - -function test_property() { - expect(window).to.have.property('expect'); - expect(window).to.have.property('expect', expect); -} - -function test_key() { - expect({ a: 'b' }).to.have.key('a'); - expect({ a: 'b' }).to.include.key('a'); - expect({ a: 'b', c: 'd' }).to.only.have.keys('a', 'c'); - expect({ a: 'b', c: 'd' }).to.only.have.keys(['a', 'c']); - expect({ a: 'b', c: 'd' }).to.not.only.have.key('a'); -} - -function test_throwException() { - var fn = () => {}; - expect(fn).to.throwError(); - expect(fn).to.throwException(function (e) { - expect(e).to.be.a(SyntaxError); - }); - expect(fn).to.throwException(/matches the exception message/); - expect(fn).to.not.throwException(); -} - -function test_withArgs() { - var fn = () => {}; - expect(fn).withArgs().to.throwException(); - expect(fn).withArgs(true, 1, '').to.throwException(); -} - -function test_within() { - expect(1).to.be.within(0, Infinity); -} - -function test_greaterThan() { - expect(5).to.be.greaterThan(3); - expect(3).to.be.above(0); -} - -function test_lessThan() { - expect(1).to.be.lessThan(3); - expect(0).to.be.below(3); -} - -function test_fail() { - expect().fail(); - expect().fail('Custom failure message'); -} \ No newline at end of file diff --git a/express-brute-mongo/express-brute-mongo-tests.ts b/express-brute-mongo/express-brute-mongo-tests.ts index 23fdab05a8..f242da216e 100644 --- a/express-brute-mongo/express-brute-mongo-tests.ts +++ b/express-brute-mongo/express-brute-mongo-tests.ts @@ -1,4 +1,4 @@ -import express = require("../express"); +import express = require("express"); import ExpressBrute = require("express-brute"); import MongoStore = require("express-brute-mongo"); import mongodb = require("mongodb"); diff --git a/express-brute/express-brute-tests.ts b/express-brute/express-brute-tests.ts index ac6a11fe9f..f977ab0aee 100644 --- a/express-brute/express-brute-tests.ts +++ b/express-brute/express-brute-tests.ts @@ -1,4 +1,4 @@ -import express = require("../express"); +import express = require("express"); import ExpressBrute = require("express-brute"); var store = new ExpressBrute.MemoryStore(); diff --git a/express-useragent/express-useragent-tests.ts b/express-useragent/express-useragent-tests.ts index 93b0c20eb6..b959c4e0c2 100644 --- a/express-useragent/express-useragent-tests.ts +++ b/express-useragent/express-useragent-tests.ts @@ -1,8 +1,4 @@ - - - - -import express = require("../express"); +import express = require("express"); import useragent = require("express-useragent"); var app = express(); diff --git a/express/express-tests.ts b/express/express-tests.ts index e643ba208b..04165d5e09 100644 --- a/express/express-tests.ts +++ b/express/express-tests.ts @@ -1,5 +1,5 @@ /// -import * as express from './'; +import * as express from 'express'; namespace express_tests { diff --git a/ffi/tsconfig.json b/ffi/tsconfig.json index 5824401d8d..df00f708f8 100644 --- a/ffi/tsconfig.json +++ b/ffi/tsconfig.json @@ -15,6 +15,7 @@ }, "files": [ "index.d.ts", + "node-ffi-buffer.d.ts", "node-ffi-tests.ts" ] } \ No newline at end of file diff --git a/field/field-test.ts b/field/field-tests.ts similarity index 100% rename from field/field-test.ts rename to field/field-tests.ts diff --git a/field/tsconfig.json b/field/tsconfig.json index cdcaca971c..722570015b 100644 --- a/field/tsconfig.json +++ b/field/tsconfig.json @@ -14,6 +14,7 @@ "forceConsistentCasingInFileNames": true }, "files": [ - "index.d.ts" + "index.d.ts", + "field-tests.ts" ] } \ No newline at end of file diff --git a/firebase/tsconfig.json b/firebase/tsconfig.json index 4f16288a22..ead8399d7a 100644 --- a/firebase/tsconfig.json +++ b/firebase/tsconfig.json @@ -15,6 +15,8 @@ }, "files": [ "index.d.ts", - "firebase-tests.ts" + "firebase-simplelogin.d.ts", + "firebase-tests.ts", + "firebase-simplelogin-tests.ts" ] } \ No newline at end of file diff --git a/fixed-data-table/fixed-data-table-0.4.7-tests.tsx b/fixed-data-table/fixed-data-table-0.4.7-tests.tsx deleted file mode 100644 index 9e87f8ae5d..0000000000 --- a/fixed-data-table/fixed-data-table-0.4.7-tests.tsx +++ /dev/null @@ -1,39 +0,0 @@ - -/// -/// - -import * as React from "react"; -import * as ReactDOM from "react-dom"; -import * as FixedDataTable from "fixed-data-table"; - -var rows = [ - ['a1', 'b1', 'c1'], - ['a2', 'b2', 'c2'], - ['a3', 'b3', 'c3'], - // .... and more -]; - -function rowGetter(rowIndex: number) { - return rows[rowIndex]; -} - - var table = - - - - -ReactDOM.render(table, document.body); diff --git a/fixed-data-table/fixed-data-table-0.4.7.d.ts b/fixed-data-table/fixed-data-table-0.4.7.d.ts deleted file mode 100644 index 04fd6d32c1..0000000000 --- a/fixed-data-table/fixed-data-table-0.4.7.d.ts +++ /dev/null @@ -1,399 +0,0 @@ -// Type definitions for fixed-data-table 0.4.7 -// Project: https://github.com/facebook/fixed-data-table -// Definitions by: Petar Paar -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -/// - -declare namespace FixedDataTable { - export var version: string; - - export interface TableProps extends __React.Props { - /** - * Pixel width of table. If all columns do not fit, - * a horizontal scrollbar will appear. - */ - width: number; - - /** - * Pixel height of table. If all rows do not fit, - * a vertical scrollbar will appear. - * - * Either `height` or `maxHeight` must be specified. - */ - height?: number; - - /** - * Maximum pixel height of table. If all rows do not fit, - * a vertical scrollbar will appear. - * - * Either `height` or `maxHeight` must be specified. - */ - maxHeight?: number; - - /** - * Pixel height of table's owner, this is used in a managed scrolling - * situation when you want to slide the table up from below the fold - * without having to constantly update the height on every scroll tick. - * Instead, vary this property on scroll. By using `ownerHeight`, we - * over-render the table while making sure the footer and horizontal - * scrollbar of the table are visible when the current space for the table - * in view is smaller than the final, over-flowing height of table. It - * allows us to avoid resizing and reflowing table when it is moving in the - * view. - * - * This is used if `ownerHeight < height` (or `maxHeight`). - */ - ownerHeight?: number; - - /** - * hidden or auto - */ - overflowX?: string; - overflowY?: string; - - /** - * Number of rows in the table. - */ - rowsCount: number; - - /** - * Pixel height of rows unless `rowHeightGetter` is specified and returns - * different value. - */ - rowHeight: number; - - /** - * If specified, `rowHeightGetter(index)` is called for each row and the - * returned value overrides `rowHeight` for particular row. - */ - rowHeightGetter?: Function; - - /** - * To get rows to display in table, `rowGetter(index)` - * is called. `rowGetter` should be smart enough to handle async - * fetching of data and return temporary objects - * while data is being fetched. - */ - rowGetter: Function; - - /** - * To get any additional CSS classes that should be added to a row, - * `rowClassNameGetter(index)` is called. - */ - rowClassNameGetter?: Function; - - /** - * Pixel height of the column group header. - */ - groupHeaderHeight?: number; - - /** - * Pixel height of header. - */ - headerHeight: number; - - /** - * Function that is called to get the data for the header row. - * If the function returns null, the header will be set to the - * Column's label property. - */ - headerDataGetter?: Function; - - /** - * Pixel height of footer. - */ - footerHeight?: number; - - /** - * DEPRECATED - use footerDataGetter instead. - * Data that will be passed to footer cell renderers. - */ - footerData?: any; - - /** - * Function that is called to get the data for the footer row. - */ - footerDataGetter?: Function; - - /** - * Value of horizontal scroll. - */ - scrollLeft?: number; - - /** - * Index of column to scroll to. - */ - scrollToColumn?: number; - - /** - * Value of vertical scroll. - */ - scrollTop?: number; - - /** - * Index of row to scroll to. - */ - scrollToRow?: number; - - /** - * Callback that is called when scrolling starts with current horizontal - * and vertical scroll values. - */ - onScrollStart?: Function; - - /** - * Callback that is called when scrolling ends or stops with new horizontal - * and vertical scroll values. - */ - onScrollEnd?: Function; - - /** - * Callback that is called when `rowHeightGetter` returns a different height - * for a row than the `rowHeight` prop. This is necessary because initially - * table estimates heights of some parts of the content. - */ - onContentHeightChange?: Function; - - /** - * Callback that is called when a row is clicked. - */ - onRowClick?: Function; - - /** - * Callback that is called when a row is double clicked. - */ - onRowDoubleClick?: Function; - - /** - * Callback that is called when a mouse-down event happens on a row. - */ - onRowMouseDown?: Function; - - /** - * Callback that is called when a mouse-enter event happens on a row. - */ - onRowMouseEnter?: Function; - - /** - * Callback that is called when a mouse-leave event happens on a row. - */ - onRowMouseLeave?: Function; - - /** - * Callback that is called when resizer has been released - * and column needs to be updated. - * - * Required if the isResizable property is true on any column. - * - * ``` - * function( - * newColumnWidth: number, - * dataKey: string, - * ) - * ``` - */ - onColumnResizeEndCallback?: Function; - - /** - * Whether a column is currently being resized. - */ - isColumnResizing?: boolean - } - - interface ColumnProps { - /** - * The horizontal alignment of the table cell content. - * 'left', 'center', 'right' - */ - align?: string; - - /** - * className for this column's header cell. - */ - headerClassName?: string; - - /** - * className for this column's footer cell. - */ - footerClassName?: string; - - /** - * className for each of this column's data cells. - */ - cellClassName?: string; - - /** - * The cell renderer that returns React-renderable content for table cell. - * ``` - * function( - * cellData: any, - * cellDataKey: string, - * rowData: object, - * rowIndex: number, - * columnData: any, - * width: number - * ): ?$jsx - * ``` - */ - cellRenderer?: Function; - - /** - * The getter `function(string_cellDataKey, object_rowData)` that returns - * the cell data for the `cellRenderer`. - * If not provided, the cell data will be collected from - * `rowData[cellDataKey]` instead. The value that `cellDataGetter` returns - * will be used to determine whether the cell should re-render. - */ - cellDataGetter?: Function; - - /** - * The key to retrieve the cell data from the data row. Provided key type - * must be either `string` or `number`. Since we use this - * for keys, it must be specified for each column. - */ - dataKey: string|number; - - /** - * Controls if the column is fixed when scrolling in the X axis. - */ - fixed?: boolean; - - /** - * The cell renderer that returns React-renderable content for table column - * header. - * ``` - * function( - * label: ?string, - * cellDataKey: string, - * columnData: any, - * rowData: array, - * width: number - * ): ?$jsx - * ``` - */ - headerRenderer?: Function; - - /** - * The cell renderer that returns React-renderable content for table column - * footer. - * ``` - * function( - * label: ?string, - * cellDataKey: string, - * columnData: any, - * rowData: array, - * width: number - * ): ?$jsx - * ``` - */ - footerRenderer?: Function; - - /** - * Bucket for any data to be passed into column renderer functions. - */ - columnData?: any; - - /** - * The column's header label. - */ - label: string; - - /** - * The pixel width of the column. - */ - width: number; - - /** - * If this is a resizable column this is its minimum pixel width. - */ - minWidth?: number; - - /** - * If this is a resizable column this is its maximum pixel width. - */ - maxWidth?: number; - - /** - * The grow factor relative to other columns. Same as the flex-grow API - * from http://www.w3.org/TR/css3-flexbox/. Basically, take any available - * extra width and distribute it proportionally according to all columns' - * flexGrow values. Defaults to zero (no-flexing). - */ - flexGrow?: number; - - /** - * Whether the column can be resized with the - * FixedDataTableColumnResizeHandle. Please note that if a column - * has a flex grow, once you resize the column this will be set to 0. - * - * This property only provides the UI for the column resizing. If this - * is set to true, you will need ot se the onColumnResizeEndCallback table - * property and render your columns appropriately. - */ - isResizable?: boolean; - - /** - * Experimental feature - * Whether cells in this column can be removed from document when outside - * of viewport as a result of horizontal scrolling. - * Setting this property to true allows the table to not render cells in - * particular column that are outside of viewport for visible rows. This - * allows to create table with many columns and not have vertical scrolling - * performance drop. - * Setting the property to false will keep previous behaviour and keep - * cell rendered if the row it belongs to is visible. - */ - allowCellsRecycling?: boolean; - } - - export interface ColumnGroupProps { - /** - * The horizontal alignment of the table cell content. - * 'left', 'center', 'right' - */ - align?: string; - - /** - * Controls if the column group is fixed when scrolling in the X axis. - */ - fixed?: boolean; - - /** - * Bucket for any data to be passed into column group renderer functions. - */ - columnGroupData?: any; - - /** - * The column group's header label. - */ - label?: string; - - /** - * The cell renderer that returns React-renderable content for a table - * column group header. If it's not specified, the label from props will - * be rendered as header content. - * ``` - * function( - * label: ?string, - * cellDataKey: string, - * columnGroupData: any, - * rowData: array, // array of labels of all columnGroups - * width: number - * ): ?$jsx - * ``` - */ - groupHeaderRenderer?: Function; - } - - export class Table extends __React.Component { - } - export class Column extends __React.Component { - } - export class ColumnGroup extends __React.Component { - } -} - -declare module "fixed-data-table" { - export = FixedDataTable; -} diff --git a/freedom/UNUSED_FILES.txt b/freedom/UNUSED_FILES.txt new file mode 100644 index 0000000000..0ec05e5266 --- /dev/null +++ b/freedom/UNUSED_FILES.txt @@ -0,0 +1,2 @@ +freedom-core-env.d.ts +freedom-module-env.d.ts \ No newline at end of file diff --git a/fullcalendar/v1/fullCalendar-tests.ts b/fullcalendar/v1/fullCalendar-tests.ts index 59b9753369..4cec7039de 100644 --- a/fullcalendar/v1/fullCalendar-tests.ts +++ b/fullcalendar/v1/fullCalendar-tests.ts @@ -1,6 +1,6 @@ -/// /// /// +/// // All examples from http://arshaw.com/fullcalendar/docs/ @@ -779,16 +779,16 @@ $(document).ready(function () { /* initialize the external events -----------------------------------------------------------------*/ $('#external-events div.external-event').each(function () { - + // create an Event Object (http://arshaw.com/fullcalendar/docs/event_data/Event_Object/) // it doesn't need to have a start or end var eventObject = { title: $.trim($(this).text()) // use the element's text as the event title }; - + // store the Event Object in the DOM element so we can get to it later $(this).data('eventObject', eventObject); - + // make the event draggable using jQuery UI $(this).draggable({ zIndex: 999, @@ -809,21 +809,21 @@ $(document).ready(function () { editable: true, droppable: true, // this allows things to be dropped onto the calendar !!! drop: function (date, allDay) { // this function is called when something is dropped - + // retrieve the dropped element's stored Event Object var originalEventObject = $(this).data('eventObject'); - + // we need to copy it, so that multiple events don't have a reference to the same object var copiedEventObject: any = $.extend({}, originalEventObject); - + // assign it the date that was reported copiedEventObject.start = date; copiedEventObject.allDay = allDay; - + // render the event on the calendar // the last `true` argument determines if the event "sticks" (http://arshaw.com/fullcalendar/docs/event_rendering/renderEvent/) $('#calendar').fullCalendar('renderEvent', copiedEventObject, true); - + // is the "remove after drop" checkbox checked? if ($('#drop-remove').is(':checked')) { // if so, remove the element from the "Draggable Events" list diff --git a/fullcalendar/v1/fullCalendar.d.ts b/fullcalendar/v1/fullCalendar.d.ts deleted file mode 100644 index 43959c0477..0000000000 --- a/fullcalendar/v1/fullCalendar.d.ts +++ /dev/null @@ -1,431 +0,0 @@ -// Type definitions for FullCalendar 1.6.1 -// Project: http://arshaw.com/fullcalendar/ -// Definitions by: Neil Stalker , Marcelo Camargo -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -/// -/// - -declare namespace FullCalendar { - export interface Calendar { - - /** - * Formats a Date object into a string. - */ - formatDate(date: Date, format: string, options?: Options): string; - - /** - * Formats a date range (two Date objects) into a string. - */ - formatDates(date1: Date, date2: Date, format: string, options?: Options): string; - - /** - * Parses a string into a Date object. - */ - parseDate(dateString: string, ignoreTimezone?: boolean): Date; - - /** - * Parses an ISO8601 string into a Date object. - */ - parseISO8601(dateString: string, ignoreTimezone?: boolean): Date; - - /** - * Gets the version of Fullcalendar - */ - version: string; - } - - export interface BusinessHours { - start: moment.Duration; - end: moment.Duration; - dow: Array; - } - - export interface Timespan { - start: moment.Moment; - end: moment.Moment; - } - - export interface Options extends AgendaOptions, EventDraggingResizingOptions, DroppingExternalElementsOptions, SelectionOptions { - - // General display - http://arshaw.com/fullcalendar/docs/display/ - - header?: { - left: string; - center: string; - right: string; - } - theme?: boolean - buttonIcons?: { - prev: string; - next: string; - } - firstDay?: number; - isRTL?: boolean; - weekends?: boolean; - hiddenDays?: number[]; - weekMode?: string; - weekNumbers?: boolean; - weekNumberCalculation?: any; // String/Function - businessHours?: boolean | BusinessHours; - height?: number; - 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; - - // Timezone - timezone?: string | boolean; - now?: moment.Moment | Date | string | (() => moment.Moment) - - // Views - http://arshaw.com/fullcalendar/docs/views/ - - defaultView?: string; - - // Current Date - http://arshaw.com/fullcalendar/docs/current_date/ - - defaultDate?: moment.Moment | Date | string; - year?: number; - month?: number; - date?: number; - - // Text/Time Customization - http://arshaw.com/fullcalendar/docs/text/ - - timeFormat?: any; // String/ViewOptionHash - columnFormat?: any; // String/ViewOptionHash - titleFormat?: any; // String/ViewOptionHash - - buttonText?: ButtonTextObject; - monthNames?: Array; - monthNamesShort?: Array; - dayNames?: Array; - dayNamesShort?: Array; - weekNumberTitle?: string; - - // 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; - - // Event Data - http://arshaw.com/fullcalendar/docs/event_data/ - - /** - * This has one of the following types: - * - * - EventObject[] - * - string (JSON feed) - * - (start: Date | string, end: Date | string, callback: {(events: EventObject[]) => void;}) => void; - */ - events?: any; - - /** - * An array, each element being one of the following types: - * - * - EventSource - * - EventObject[] - * - string (JSON feed) - * - (start: Date | string, end: Date | string, callback: {(events: EventObject[]) => void;}) => void; - */ - eventSources?: any[]; - - allDayDefault?: boolean; - ignoreTimezone?: boolean; - startParam?: string; - endParam?: string - lazyFetching?: boolean; - eventDataTransform?: (eventData: any) => EventObject; - loading?: (isLoading: boolean, view: ViewObject) => void; - - // Event Rendering - http://arshaw.com/fullcalendar/docs/event_rendering/ - - eventColor?: string; - 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; - - - } - - export interface ViewOptionHash { - month?: any; - week?: any; - day?: any; - agenda?: any; - agendaDay?: any; - agendaWeek?: any; - basic?: any; - basicDay?: any; - basicWeek?: any; - ''?: any; - } - - /** - * Agenda Options - http://arshaw.com/fullcalendar/docs/agenda/ - */ - export interface AgendaOptions { - allDaySlot?: boolean; - allDayText?: string; - slotDuration?: moment.Duration; - slotLabelFormat?: string; - slotLabelInterval?: moment.Duration; - snapDuration?: moment.Duration; - scrollTime?: moment.Duration; - minTime?: moment.Duration; // Integer/String - maxTime?: moment.Duration; // Integer/String - slotEventOverlap?: boolean; - } - - /* - * Event Dragging & Resizing - */ - export interface EventDraggingResizingOptions { - editable?: boolean; - eventStartEditable?: boolean; - eventDurationEditable?: boolean; - dragRevertDuration?: number; // integer, milliseconds - dragOpacity?: number; // float - 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; - } - /* - * Selection - http://arshaw.com/fullcalendar/docs/selection/ - */ - export interface SelectionOptions { - selectable?: boolean; - selectHelper?: boolean | ((start: moment.Moment, end: moment.Moment) => HTMLElement); - unselectAuto?: boolean; - 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; - } - - export interface DroppingExternalElementsOptions { - droppable?: boolean; - dropAccept?: string | ((draggable: any) => boolean); - drop?: (date: moment.Moment, jsEvent: MouseEvent, ui: any) => void; - eventReceive?: (event: EventObject) => void - } - - export interface ButtonTextObject { - prev?: string; - next?: string; - prevYear?: string; - nextYear?: string; - today?: string; - month?: string; - week?: string; - day?: string; - } - - export interface EventObject extends Timespan { - id?: any // String/number - title: string; - allDay?: boolean; - url?: string; - className?: any; // string/Array - editable?: boolean; - source?: EventSource; - color?: string; - backgroundColor?: string; - borderColor?: string; - textColor?: string; - rendering?: string; - } - - export interface ViewObject extends Timespan { - name: string; - title: string; - intervalStart: moment.Moment; - intervalEnd: moment.Moment; - } - - export interface EventSource extends JQueryAjaxSettings { - - /** - * This has one of the following types: - * - * - EventObject[] - * - string (JSON feed) - * - (start: Date | string, end: Date | string, callback: {(events: EventObject[]) => void;}) => void; - */ - events?: any; - - color?: string; - backgroundColor?: string; - borderColor?: string; - textColor?: string; - className?: any; // string/Array - editable?: boolean; - allDayDefault?: boolean; - ignoreTimezone?: boolean; - eventTransform?: any; - startParam?: string; - endParam?: string - } - -} - -interface JQuery { - - /** - * Get/Set option value - */ - fullCalendar(method: 'option', option: string, value?: any): void; - - /** - * Immediately forces the calendar to render and/or readjusts its size. - */ - fullCalendar(method: 'render'): void; - - /** - * Restores the element to the state before FullCalendar was initialized. - */ - fullCalendar(method: 'destroy'): void; - - /** - * Returns the View Object for the current view. - */ - fullCalendar(method: 'getView'): FullCalendar.ViewObject; - - /** - * Immediately switches to a different view. - */ - fullCalendar(method: 'changeView', viewName: string): void; - - /** - * Moves the calendar one step back (either by a month, week, or day). - */ - fullCalendar(method: 'prev'): void; - - /** - * Moves the calendar one step forward (either by a month, week, or day). - */ - fullCalendar(method: 'next'): void; - - /** - * Moves the calendar back one year. - */ - fullCalendar(method: 'prevYear'): void; - - /** - * Moves the calendar forward one year. - */ - fullCalendar(method: 'nextYear'): void; - - /** - * Moves the calendar to the current date. - */ - fullCalendar(method: 'today'): void; - - /** - * Moves the calendar to an arbitrary year/month/date. - */ - fullCalendar(method: 'gotoDate', year: number, month?: number, date?: number): void; - - /** - * Moves the calendar to an arbitrary date. - */ - fullCalendar(method: 'gotoDate', date: Date | string): void; - - /** - * Moves the calendar forward/backward an arbitrary amount of time. - */ - fullCalendar(method: 'incrementDate', year: number, month?: number, date?: number): void; - - /** - * Returns a Date object for the current date of the calendar. - */ - fullCalendar(method: 'getDate'): Date; - - /** - * A method for programmatically selecting a period of time. - */ - fullCalendar(method: 'select', startDate: Date, endDate: Date, allDay: boolean): void; - - /** - * A method for programmatically clearing the current selection. - */ - fullCalendar(method: 'unselect'): void; - - /** - * Reports changes to an event and renders them on the calendar. - */ - fullCalendar(method: 'updateEvent', event: FullCalendar.EventObject): void; - - /** - * Retrieves events that FullCalendar has in memory. - */ - fullCalendar(method: 'clientEvents', idOrfilter?: any): Array; - - /** - * Retrieves events that FullCalendar has in memory. - */ - fullCalendar(method: 'clientEvents', idOrfilter?: (e: FullCalendar.EventObject) => boolean): Array; - - /** - * Removes events from the calendar. - */ - fullCalendar(method: 'removeEvents', idOrfilter?: any): void; - - /** - * Removes events from the calendar. - */ - fullCalendar(method: 'removeEvents', idOrfilter?: (e: FullCalendar.EventObject) => boolean): void; - - /** - * Refetches events from all sources and rerenders them on the screen. - */ - fullCalendar(method: 'refetchEvents'): void; - - /** - * Dynamically adds an event source. - */ - fullCalendar(method: 'addEventSource', source: any): void; - - /** - * Dynamically removes an event source. - */ - fullCalendar(method: 'removeEventSource', source: any): void; - - /** - * Renders a new event on the calendar. - */ - fullCalendar(method: 'renderEvent', event: FullCalendar.EventObject, stick?: boolean): void; - - /** - * Rerenders all events on the calendar. - */ - fullCalendar(method: 'rerenderEvents'): void; - - /** - * Create calendar object - */ - fullCalendar(options: FullCalendar.Options): JQuery; - - /** - * Generic method function - */ - fullCalendar(method: string, arg1: any, arg2: any, arg3: any): void; -} - -interface JQueryStatic { - fullCalendar: FullCalendar.Calendar; -} diff --git a/fullcalendar/v1/index.d.ts b/fullcalendar/v1/index.d.ts new file mode 100644 index 0000000000..9f521ca8fc --- /dev/null +++ b/fullcalendar/v1/index.d.ts @@ -0,0 +1,433 @@ +// Type definitions for FullCalendar 1.6 +// Project: http://arshaw.com/fullcalendar/ +// Definitions by: Neil Stalker , Marcelo Camargo +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +/// +import * as moment from "moment"; + +declare global { + namespace FullCalendar { + export interface Calendar { + + /** + * Formats a Date object into a string. + */ + formatDate(date: Date, format: string, options?: Options): string; + + /** + * Formats a date range (two Date objects) into a string. + */ + formatDates(date1: Date, date2: Date, format: string, options?: Options): string; + + /** + * Parses a string into a Date object. + */ + parseDate(dateString: string, ignoreTimezone?: boolean): Date; + + /** + * Parses an ISO8601 string into a Date object. + */ + parseISO8601(dateString: string, ignoreTimezone?: boolean): Date; + + /** + * Gets the version of Fullcalendar + */ + version: string; + } + + export interface BusinessHours { + start: moment.Duration; + end: moment.Duration; + dow: number[]; + } + + export interface Timespan { + start: moment.Moment; + end: moment.Moment; + } + + export interface Options extends AgendaOptions, EventDraggingResizingOptions, DroppingExternalElementsOptions, SelectionOptions { + + // General display - http://arshaw.com/fullcalendar/docs/display/ + + header?: { + left: string; + center: string; + right: string; + }; + theme?: boolean; + buttonIcons?: { + prev: string; + next: string; + }; + firstDay?: number; + isRTL?: boolean; + weekends?: boolean; + hiddenDays?: number[]; + weekMode?: string; + weekNumbers?: boolean; + weekNumberCalculation?: any; // String/Function + businessHours?: boolean | BusinessHours; + height?: number; + 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; + + // Timezone + timezone?: string | boolean; + now?: moment.Moment | Date | string | (() => moment.Moment); + + // Views - http://arshaw.com/fullcalendar/docs/views/ + + defaultView?: string; + + // Current Date - http://arshaw.com/fullcalendar/docs/current_date/ + + defaultDate?: moment.Moment | Date | string; + year?: number; + month?: number; + date?: number; + + // Text/Time Customization - http://arshaw.com/fullcalendar/docs/text/ + + timeFormat?: any; // String/ViewOptionHash + columnFormat?: any; // String/ViewOptionHash + titleFormat?: any; // String/ViewOptionHash + + buttonText?: ButtonTextObject; + monthNames?: string[]; + monthNamesShort?: string[]; + dayNames?: string[]; + dayNamesShort?: string[]; + weekNumberTitle?: string; + + // 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; + + // Event Data - http://arshaw.com/fullcalendar/docs/event_data/ + + /** + * This has one of the following types: + * + * - EventObject[] + * - string (JSON feed) + * - (start: Date | string, end: Date | string, callback: {(events: EventObject[]) => void;}) => void; + */ + events?: any; + + /** + * An array, each element being one of the following types: + * + * - EventSource + * - EventObject[] + * - string (JSON feed) + * - (start: Date | string, end: Date | string, callback: {(events: EventObject[]) => void;}) => void; + */ + eventSources?: any[]; + + allDayDefault?: boolean; + ignoreTimezone?: boolean; + startParam?: string; + endParam?: string; + lazyFetching?: boolean; + eventDataTransform?: (eventData: any) => EventObject; + loading?: (isLoading: boolean, view: ViewObject) => void; + + // Event Rendering - http://arshaw.com/fullcalendar/docs/event_rendering/ + + eventColor?: string; + 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; + + + } + + export interface ViewOptionHash { + month?: any; + week?: any; + day?: any; + agenda?: any; + agendaDay?: any; + agendaWeek?: any; + basic?: any; + basicDay?: any; + basicWeek?: any; + ''?: any; + } + + /** + * Agenda Options - http://arshaw.com/fullcalendar/docs/agenda/ + */ + export interface AgendaOptions { + allDaySlot?: boolean; + allDayText?: string; + slotDuration?: moment.Duration; + slotLabelFormat?: string; + slotLabelInterval?: moment.Duration; + snapDuration?: moment.Duration; + scrollTime?: moment.Duration; + minTime?: moment.Duration; // Integer/String + maxTime?: moment.Duration; // Integer/String + slotEventOverlap?: boolean; + } + + /* + * Event Dragging & Resizing + */ + export interface EventDraggingResizingOptions { + editable?: boolean; + eventStartEditable?: boolean; + eventDurationEditable?: boolean; + dragRevertDuration?: number; // integer, milliseconds + dragOpacity?: number; // float + 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; + } + /* + * Selection - http://arshaw.com/fullcalendar/docs/selection/ + */ + export interface SelectionOptions { + selectable?: boolean; + selectHelper?: boolean | ((start: moment.Moment, end: moment.Moment) => HTMLElement); + unselectAuto?: boolean; + 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; + } + + export interface DroppingExternalElementsOptions { + droppable?: boolean; + dropAccept?: string | ((draggable: any) => boolean); + drop?: (date: moment.Moment, jsEvent: MouseEvent, ui: any) => void; + eventReceive?: (event: EventObject) => void; + } + + export interface ButtonTextObject { + prev?: string; + next?: string; + prevYear?: string; + nextYear?: string; + today?: string; + month?: string; + week?: string; + day?: string; + } + + export interface EventObject extends Timespan { + id?: any; // String/number + title: string; + allDay?: boolean; + url?: string; + className?: any; // string/Array + editable?: boolean; + source?: EventSource; + color?: string; + backgroundColor?: string; + borderColor?: string; + textColor?: string; + rendering?: string; + } + + export interface ViewObject extends Timespan { + name: string; + title: string; + intervalStart: moment.Moment; + intervalEnd: moment.Moment; + } + + export interface EventSource extends JQueryAjaxSettings { + + /** + * This has one of the following types: + * + * - EventObject[] + * - string (JSON feed) + * - (start: Date | string, end: Date | string, callback: {(events: EventObject[]) => void;}) => void; + */ + events?: any; + + color?: string; + backgroundColor?: string; + borderColor?: string; + textColor?: string; + className?: any; // string/Array + editable?: boolean; + allDayDefault?: boolean; + ignoreTimezone?: boolean; + eventTransform?: any; + startParam?: string; + endParam?: string; + } + + } + + interface JQuery { + + /** + * Get/Set option value + */ + fullCalendar(method: 'option', option: string, value?: any): void; + + /** + * Immediately forces the calendar to render and/or readjusts its size. + */ + fullCalendar(method: 'render'): void; + + /** + * Restores the element to the state before FullCalendar was initialized. + */ + fullCalendar(method: 'destroy'): void; + + /** + * Returns the View Object for the current view. + */ + fullCalendar(method: 'getView'): FullCalendar.ViewObject; + + /** + * Immediately switches to a different view. + */ + fullCalendar(method: 'changeView', viewName: string): void; + + /** + * Moves the calendar one step back (either by a month, week, or day). + */ + fullCalendar(method: 'prev'): void; + + /** + * Moves the calendar one step forward (either by a month, week, or day). + */ + fullCalendar(method: 'next'): void; + + /** + * Moves the calendar back one year. + */ + fullCalendar(method: 'prevYear'): void; + + /** + * Moves the calendar forward one year. + */ + fullCalendar(method: 'nextYear'): void; + + /** + * Moves the calendar to the current date. + */ + fullCalendar(method: 'today'): void; + + /** + * Moves the calendar to an arbitrary year/month/date. + */ + fullCalendar(method: 'gotoDate', year: number, month?: number, date?: number): void; + + /** + * Moves the calendar to an arbitrary date. + */ + fullCalendar(method: 'gotoDate', date: Date | string): void; + + /** + * Moves the calendar forward/backward an arbitrary amount of time. + */ + fullCalendar(method: 'incrementDate', year: number, month?: number, date?: number): void; + + /** + * Returns a Date object for the current date of the calendar. + */ + fullCalendar(method: 'getDate'): Date; + + /** + * A method for programmatically selecting a period of time. + */ + fullCalendar(method: 'select', startDate: Date, endDate: Date, allDay: boolean): void; + + /** + * A method for programmatically clearing the current selection. + */ + fullCalendar(method: 'unselect'): void; + + /** + * Reports changes to an event and renders them on the calendar. + */ + fullCalendar(method: 'updateEvent', event: FullCalendar.EventObject): void; + + /** + * Retrieves events that FullCalendar has in memory. + */ + fullCalendar(method: 'clientEvents', idOrfilter?: any): FullCalendar.EventObject[]; + + /** + * Retrieves events that FullCalendar has in memory. + */ + fullCalendar(method: 'clientEvents', idOrfilter?: (e: FullCalendar.EventObject) => boolean): FullCalendar.EventObject[]; + + /** + * Removes events from the calendar. + */ + fullCalendar(method: 'removeEvents', idOrfilter?: any): void; + + /** + * Removes events from the calendar. + */ + fullCalendar(method: 'removeEvents', idOrfilter?: (e: FullCalendar.EventObject) => boolean): void; + + /** + * Refetches events from all sources and rerenders them on the screen. + */ + fullCalendar(method: 'refetchEvents'): void; + + /** + * Dynamically adds an event source. + */ + fullCalendar(method: 'addEventSource', source: any): void; + + /** + * Dynamically removes an event source. + */ + fullCalendar(method: 'removeEventSource', source: any): void; + + /** + * Renders a new event on the calendar. + */ + fullCalendar(method: 'renderEvent', event: FullCalendar.EventObject, stick?: boolean): void; + + /** + * Rerenders all events on the calendar. + */ + fullCalendar(method: 'rerenderEvents'): void; + + /** + * Create calendar object + */ + fullCalendar(options: FullCalendar.Options): JQuery; + + /** + * Generic method function + */ + fullCalendar(method: string, arg1: any, arg2: any, arg3: any): void; + } + + interface JQueryStatic { + fullCalendar: FullCalendar.Calendar; + } +} diff --git a/fullcalendar/v1/package.json b/fullcalendar/v1/package.json new file mode 100644 index 0000000000..d33ff913ce --- /dev/null +++ b/fullcalendar/v1/package.json @@ -0,0 +1,5 @@ +{ + "dependencies": { + "moment": ">=2.14.0" + } +} diff --git a/fullcalendar/v1/tsconfig.json b/fullcalendar/v1/tsconfig.json new file mode 100644 index 0000000000..a589491226 --- /dev/null +++ b/fullcalendar/v1/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "target": "es6", + "noImplicitAny": true, + "noImplicitThis": false, + "strictNullChecks": true, + "baseUrl": "../../", + "typeRoots": [ + "../../" + ], + "types": [], + "paths": { + "fullcalendar": ["fullcalendar/v1"] + }, + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "fullCalendar-tests.ts" + ] +} \ No newline at end of file diff --git a/fullcalendar/v1/tslint.json b/fullcalendar/v1/tslint.json new file mode 100644 index 0000000000..7d876390fe --- /dev/null +++ b/fullcalendar/v1/tslint.json @@ -0,0 +1,7 @@ +{ + "extends": "../../tslint.json", + "rules": { + "forbidden-types": false, + "unified-signatures": false + } +} \ No newline at end of file diff --git a/gaussian/gaussian-tests.ts b/gaussian/gaussian-tests.ts index bd2a226e88..05b75854e7 100644 --- a/gaussian/gaussian-tests.ts +++ b/gaussian/gaussian-tests.ts @@ -1,4 +1,4 @@ -import * as gaussian from "."; +import * as gaussian from "gaussian"; const d = gaussian(0, 1); const a = d.mean !== d.variance; diff --git a/generic-functions/genetic-functions-tests.ts b/generic-functions/generic-functions-tests.ts similarity index 91% rename from generic-functions/genetic-functions-tests.ts rename to generic-functions/generic-functions-tests.ts index d3dc53665a..7178c6f6a4 100644 --- a/generic-functions/genetic-functions-tests.ts +++ b/generic-functions/generic-functions-tests.ts @@ -1,5 +1,3 @@ -/// - import g = require('generic-functions'); var tvShow: Object = { diff --git a/generic-functions/tsconfig.json b/generic-functions/tsconfig.json index cdcaca971c..7a46abfbd9 100644 --- a/generic-functions/tsconfig.json +++ b/generic-functions/tsconfig.json @@ -14,6 +14,7 @@ "forceConsistentCasingInFileNames": true }, "files": [ - "index.d.ts" + "index.d.ts", + "generic-functions-tests.ts" ] } \ No newline at end of file diff --git a/git-config/gitconfig b/git-config/gitconfig deleted file mode 100644 index 0ee61d5b18..0000000000 --- a/git-config/gitconfig +++ /dev/null @@ -1,5 +0,0 @@ -[user] - name = A Git User - email = git.user@domain.xyz -[push] - default = simple diff --git a/gl-matrix/gl-matrix-legacy-tests.ts b/gl-matrix/gl-matrix-legacy-tests.ts deleted file mode 100644 index 5cfa9a1c3a..0000000000 --- a/gl-matrix/gl-matrix-legacy-tests.ts +++ /dev/null @@ -1,362 +0,0 @@ -/// - -// common -var result: number = glMatrix.toRadian(180); - -var out: GLM.IArray; -var outVal: number; -var outStr: string; - -// vec2 -var vecA: GLM.IArray, vecB: GLM.IArray, matA: GLM.IArray; -var vecArray: GLM.IArray; - -vecA = [1, 2]; -vecB = new Float32Array([3, 4]); -out = [0, 0]; -matA = [1, 2, 3, 4, 5, 6]; -vecArray = [1, 2, 3, 4, 0, 0]; - -out = vec2.create(); -out = vec2.clone(vecA); -out = vec2.fromValues(1, 2); -out = vec2.copy(out, vecA); -out = vec2.set(out, 1, 2); -out = vec2.add(out, vecA, vecB); -out = vec2.subtract(out, vecA, vecB); -out = vec2.sub(out, vecA, vecB); -out = vec2.multiply(out, vecA, vecB); -out = vec2.mul(out, vecA, vecB); -out = vec2.divide(out, vecA, vecB); -out = vec2.div(out, vecA, vecB); -out = vec2.min(out, vecA, vecB); -out = vec2.max(out, vecA, vecB); -out = vec2.scale(out, vecA, 2); -out = vec2.scaleAndAdd(out, vecA, vecB, 0.5); -outVal = vec2.distance(vecA, vecB); -outVal = vec2.dist(vecA, vecB); -outVal = vec2.squaredDistance(vecA, vecB); -outVal = vec2.sqrDist(vecA, vecB); -outVal = vec2.length(vecA); -outVal = vec2.len(vecA); -outVal = vec2.squaredLength(vecA); -outVal = vec2.sqrLen(vecA); -out = vec2.negate(out, vecA); -out = vec2.inverse(out, vecA); -out = vec2.normalize(out, vecA); -outVal = vec2.dot(vecA, vecB); -out = vec2.cross(out, vecA, vecB); -out = vec2.lerp(out, vecA, vecB, 0.5); -out = vec2.random(out); -out = vec2.random(out, 5.0); -out = vec2.transformMat2(out, vecA, matA); -out = vec2.transformMat2d(out, vecA, matA); -out = vec2.transformMat3(out, vecA, matA); -out = vec2.transformMat4(out, vecA, matA); -out = vec2.forEach(vecArray, 0, 0, 0, vec2.normalize); -outStr = vec2.str(vecA); - -// vec3 -var matr: GLM.IArray; -var q: GLM.IArray; - -vecA = [1, 2, 3]; -vecB = new Float32Array([4, 5, 6]); -out = [0, 0, 0]; -vecArray = [1, 2, 3, 4, 5, 6, 0, 0, 0]; -matr = [1, 0, 0, 0, 1, 0, 0, 0, 1 ]; - -out = vec3.create(); -out = vec3.clone(vecA); -out = vec3.fromValues(1, 2, 3); -out = vec3.copy(out, vecA); -out = vec3.set(out, 1, 2, 3); -out = vec3.add(out, vecA, vecB); -out = vec3.subtract(out, vecA, vecB); -out = vec3.sub(out, vecA, vecB); -out = vec3.multiply(out, vecA, vecB); -out = vec3.mul(out, vecA, vecB); -out = vec3.divide(out, vecA, vecB); -out = vec3.div(out, vecA, vecB); -out = vec3.min(out, vecA, vecB); -out = vec3.max(out, vecA, vecB); -out = vec3.scale(out, vecA, 2); -out = vec3.scaleAndAdd(out, vecA, vecB, 0.5); -outVal = vec3.distance(vecA, vecB); -outVal = vec3.dist(vecA, vecB); -outVal = vec3.squaredDistance(vecA, vecB); -outVal = vec3.sqrDist(vecA, vecB); -outVal = vec3.length(vecA); -outVal = vec3.len(vecA); -outVal = vec3.squaredLength(vecA); -outVal = vec3.sqrLen(vecA); -out = vec3.negate(out, vecA); -out = vec3.inverse(out, vecA); -out = vec3.normalize(out, vecA); -outVal = vec3.dot(vecA, vecB); -out = vec3.cross(out, vecA, vecB); -out = vec3.lerp(out, vecA, vecB, 0.5); -out = vec3.random(out); -out = vec3.random(out, 5.0); -out = vec3.rotateX(out, vecA, vecB, Math.PI); -out = vec3.rotateY(out, vecA, vecB, Math.PI); -out = vec3.rotateZ(out, vecA, vecB, Math.PI); -out = vec3.transformMat3(out, vecA, matr); - -matr = [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1 ]; -out = vec3.transformMat4(out, vecA, matr); - -q = [1, 2, 3, 4]; -out = vec3.transformQuat(out, vecA, matr); - -out = vec3.forEach(vecArray, 0, 0, 0, vec3.normalize); -outVal = vec3.angle(vecA, vecB); -outStr = vec3.str(vecA); - -// vec4 -var q: GLM.IArray; - -vecA = [1, 2, 3, 4]; -vecB = new Float32Array([5, 6, 7, 8]); -out = [0, 0, 0, 0]; -q = [1, 2, 3, 4]; - -out = vec4.create(); -out = vec4.clone(vecA); -out = vec4.fromValues(1, 2, 3, 4); -out = vec4.copy(out, vecA); -out = vec4.set(out, 1, 2, 3, 4); -out = vec4.add(out, vecA, vecB); -out = vec4.subtract(out, vecA, vecB); -out = vec4.sub(out, vecA, vecB); -out = vec4.multiply(out, vecA, vecB); -out = vec4.mul(out, vecA, vecB); -out = vec4.divide(out, vecA, vecB); -out = vec4.div(out, vecA, vecB); -out = vec4.min(out, vecA, vecB); -out = vec4.max(out, vecA, vecB); -out = vec4.scale(out, vecA, 2); -out = vec4.scaleAndAdd(out, vecA, vecB, 0.5); -outVal = vec4.distance(vecA, vecB); -outVal = vec4.dist(vecA, vecB); -outVal = vec4.squaredDistance(vecA, vecB); -outVal = vec4.sqrDist(vecA, vecB); -outVal = vec4.length(vecA); -outVal = vec4.len(vecA); -outVal = vec4.squaredLength(vecA); -outVal = vec4.sqrLen(vecA); -out = vec4.negate(out, vecA); -out = vec4.inverse(out, vecA); -out = vec4.normalize(out, vecA); -outVal = vec4.dot(vecA, vecB); -out = vec4.lerp(out, vecA, vecB, 0.5); -out = vec4.random(out); -out = vec4.random(out, 5.0); - -matr = [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1 ] -out = vec4.transformMat4(out, vecA, matr); -out = vec4.transformQuat(out, vecA, q); - -vecArray = [1, 2, 3, 4, 5, 6, 7, 8, 0, 0, 0, 0]; -out = vec4.forEach(vecArray, 0, 0, 0, vec4.normalize); -outStr = vec4.str(vecA); - -// mat2 -var matB: GLM.IArray, identity: GLM.IArray; - -matA = [1, 2, 3, 4]; -matB = new Float32Array([5, 6, 7, 8]); -out = [0, 0, 0, 0]; -identity = [1, 0, 0, 1]; - -out = mat2.create(); -out = mat2.clone(matA); -out = mat2.copy(out, matA); -out = mat2.identity(out); -out = mat2.transpose(out, matA); -out = mat2.invert(out, matA); -out = mat2.adjoint(out, matA); -outVal = mat2.determinant(matA); -out = mat2.multiply(out, matA, matB); -out = mat2.mul(out, matA, matB); -out = mat2.rotate(out, matA, Math.PI * 0.5); - -vecA = [2, 3]; -out = mat2.scale(out, matA, vecA); -outStr = mat2.str(matA); -outVal = mat2.frob(matA); - -var L = mat2.create(); -var D = mat2.create(); -var U = mat2.create(); -out = mat2.LDU(L, D, U, [4,3,6,3]); - -// mat2d -matA = [1, 2, 3, 4, 5, 6]; -matB = [7, 8, 9, 10, 11, 12]; -out = [0, 0, 0, 0, 0, 0]; -identity = [1, 0, 0, 1, 0, 0]; - -out = mat2d.create(); -out = mat2d.clone(matA); -out = mat2d.copy(out, matA); -out = mat2d.identity(out); -out = mat2d.invert(out, matA); -outVal = mat2d.determinant(matA); -out = mat2d.multiply(out, matA, matB); -out = mat2d.mul(out, matA, matB); -out = mat2d.rotate(out, matA, Math.PI * 0.5); - -vecA = [2, 3]; -out = mat2d.scale(out, matA, vecA); -out = mat2d.translate(out, matA, vecA); -outStr = mat2d.str(matA); -outVal = mat2d.frob(matA); - -// mat3 -matA = [1, 0, 0, 0, 1, 0, 1, 2, 1]; -matB = [1, 0, 0, 0, 1, 0, 3, 4, 1]; -out = [0, 0, 0, 0, 0, 0, 0, 0, 0]; -identity = [1, 0, 0, 0, 1, 0, 0, 0, 1]; - -out = mat3.create(); -out = mat3.clone(matA); -out = mat3.copy(out, matA); -out = mat3.identity(out); -out = mat3.transpose(out, matA); -out = mat3.invert(out, matA); -out = mat3.adjoint(out, matA); -outVal = mat3.determinant(matA); -out = mat3.multiply(out, matA, matB); -out = mat3.mul(out, matA, matB); -outStr = mat3.str(matA); -outVal = mat3.frob(matA); - -matA = [1, 0, 0, 0, - 0, 1, 0, 0, - 0, 0, 1, 0, - 0, 0, 0, 1]; -out = mat3.normalFromMat4(out, matA); - -q = [ 0, -0.7071067811865475, 0, 0.7071067811865475 ]; -out = mat3.fromQuat(out, q); - -out = mat3.normalFromMat4(out, [ 1, 2, 3, 4, 5, 6, 7, 8, 9,10,11,12, 13,14,15,16]); -out = mat3.fromMat4(out, [ 1, 2, 3, 4, 5, 6, 7, 8, 9,10,11,12, 13,14,15,16]); -out = mat3.scale(out, matA, [2,2]); -out = mat3.fromMat2d(out, [1, 2, 3, 4, 5, 6]); - -out = mat3.translate(out, matA, [1, 2, 3]); -out = mat3.rotate(out, matA, Math.PI/2); - -// mat4 -matA = [1, 0, 0, 0, - 0, 1, 0, 0, - 0, 0, 1, 0, - 1, 2, 3, 1]; - -matB = [1, 0, 0, 0, - 0, 1, 0, 0, - 0, 0, 1, 0, - 4, 5, 6, 1]; - -out = [0, 0, 0, 0, - 0, 0, 0, 0, - 0, 0, 0, 0, - 0, 0, 0, 0]; - -identity = [1, 0, 0, 0, - 0, 1, 0, 0, - 0, 0, 1, 0, - 0, 0, 0, 1]; - -out = mat4.create(); -out = mat4.clone(matA); -out = mat4.copy(out, matA); -out = mat4.identity(out); -out = mat4.transpose(out, matA); -out = mat4.invert(out, matA); -out = mat4.adjoint(out, matA); -outVal = mat4.determinant(matA); -out = mat4.multiply(out, matA, matB); -out = mat4.mul(out, matA, matB); -out = mat4.translate(out, matA, [4, 5, 6]); -out = mat4.scale(out, matA, [4, 5, 6]); - -var rad = Math.PI * 0.5; -var axis = [1, 0, 0]; -out = mat4.rotate(out, matA, rad, axis); -out = mat4.rotateX(out, matA, rad); -out = mat4.rotateY(out, matA, rad); -out = mat4.rotateZ(out, matA, rad); - -out = mat4.frustum(out, -1, 1, -1, 1, -1, 1); - -var fovy = Math.PI * 0.5; -out = mat4.perspective(out, fovy, 1, 0, 1); -out = mat4.ortho(out, -1, 1, -1, 1, -1, 1); - -var eye = [0, 0, 1]; -var center = [0, 0, -1]; -var up = [0, 1, 0]; -out = mat4.lookAt(out, eye, center, up); - -outStr = mat4.str(matA); -outVal = mat4.frob(matA); - -q = [0, 0, 0, 1]; -out = mat4.fromRotationTranslation(out, q, [1, 2, 3]); -out = mat4.fromQuat(out, q); - -q = [0, 0, 0, 1]; -out = mat4.fromRotationTranslationScale(out, q, [1, 2, 3], [1, 2, 3]); -out = mat4.fromQuat(out, q); - - -// quat -var quatA = [1, 2, 3, 4]; -var quatB = [5, 6, 7, 8]; -out = [0, 0, 0, 0]; -var vec = [1, 1, -1]; -var id = [0, 0, 0, 1]; -var deg90 = Math.PI / 2; - -out = quat.create(); -out = quat.clone(quatA); -out = quat.fromValues(1, 2, 3, 4); -out = quat.copy(out, quatA); -out = quat.set(out, 1, 2, 3, 4); -out = quat.identity(out); -out = quat.setAxisAngle(out, [1, 0, 0], Math.PI * 0.5); -out = quat.add(out, quatA, quatB); -out = quat.multiply(out, quatA, quatB); -out = quat.mul(out, quatA, quatB); -out = quat.scale(out, quatA, 2); -outVal = quat.length(quatA); -outVal = quat.len(quatA); -outVal = quat.squaredLength(quatA); -outVal = quat.sqrLen(quatA); -out = quat.normalize(out, quatA); -outVal = quat.dot(out, quatA, quatB); -out = quat.lerp(out, quatA, quatB, 0.5); -out = quat.slerp(out, quatA, quatB, 0.5); -out = quat.invert(out, quatA); -out = quat.conjugate(out, quatA); -outStr = quat.str(quatA); -out = quat.rotateX(out, id, deg90); -out = quat.rotateY(out, id, deg90); -out = quat.rotateZ(out, id, deg90); - -matr = [ 1, 0, 0, - 0, 0, -1, - 0, 1, 0 ]; -out = quat.fromMat3(out, matr); - -var view = [-1, 0, 0]; -up = [ 0, 1, 0]; -var right= [ 0, 0,-1]; -out = quat.setAxes([], view, right, up); - -out = quat.rotationTo(out, [0, 1, 0], [1, 0, 0]); -out = quat.calculateW(out, quatA); - diff --git a/gl-matrix/gl-matrix-legacy.d.ts b/gl-matrix/gl-matrix-legacy.d.ts deleted file mode 100644 index 16366f263a..0000000000 --- a/gl-matrix/gl-matrix-legacy.d.ts +++ /dev/null @@ -1,2163 +0,0 @@ -// Type definitions for gl-matrix 2.2.2 -// Project: https://github.com/toji/gl-matrix -// Definitions by: Tat -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -declare namespace GLM { - interface IArray - { - /** - * Must be indexable like an array - */ - [index: number]: number; - } -} - -// Common -declare namespace glMatrix { - /** - * Convert Degree To Radian - * - * @param a Angle in Degrees - */ - export function toRadian(a: number): number; -} - -// vec2 -declare namespace vec2 { - /** - * Creates a new, empty vec2 - * - * @returns a new 2D vector - */ - export function create(): GLM.IArray; - - /** - * Creates a new vec2 initialized with values from an existing vector - * - * @param a a vector to clone - * @returns a new 2D vector - */ - export function clone(a: GLM.IArray): GLM.IArray; - - /** - * Creates a new vec2 initialized with the given values - * - * @param x X component - * @param y Y component - * @returns a new 2D vector - */ - export function fromValues(x: number, y: number): GLM.IArray; - - /** - * Copy the values from one vec2 to another - * - * @param out the receiving vector - * @param a the source vector - * @returns out - */ - export function copy(out: GLM.IArray, a: GLM.IArray): GLM.IArray; - - /** - * Set the components of a vec2 to the given values - * - * @param out the receiving vector - * @param x X component - * @param y Y component - * @returns out - */ - export function set(out: GLM.IArray, x: number, y: number): GLM.IArray; - - /** - * Adds two vec2's - * - * @param out the receiving vector - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function add(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Subtracts vector b from vector a - * - * @param out the receiving vector - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function subtract(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Subtracts vector b from vector a - * - * @param out the receiving vector - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function sub(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Multiplies two vec2's - * - * @param out the receiving vector - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function multiply(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Multiplies two vec2's - * - * @param out the receiving vector - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function mul(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Divides two vec2's - * - * @param out the receiving vector - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function divide(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Divides two vec2's - * - * @param out the receiving vector - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function div(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Returns the minimum of two vec2's - * - * @param out the receiving vector - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function min(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Returns the maximum of two vec2's - * - * @param out the receiving vector - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function max(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Scales a vec2 by a scalar number - * - * @param out the receiving vector - * @param a the vector to scale - * @param b amount to scale the vector by - * @returns out - */ - export function scale(out: GLM.IArray, a: GLM.IArray, b: number): GLM.IArray; - - /** - * Adds two vec2's after scaling the second operand by a scalar value - * - * @param out the receiving vector - * @param a the first operand - * @param b the second operand - * @param scale the amount to scale b by before adding - * @returns out - */ - export function scaleAndAdd(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray, scale: number): GLM.IArray; - - /** - * Calculates the euclidian distance between two vec2's - * - * @param a the first operand - * @param b the second operand - * @returns distance between a and b - */ - export function distance(a: GLM.IArray, b: GLM.IArray): number; - - /** - * Calculates the euclidian distance between two vec2's - * - * @param a the first operand - * @param b the second operand - * @returns distance between a and b - */ - export function dist(a: GLM.IArray, b: GLM.IArray): number; - - /** - * Calculates the squared euclidian distance between two vec2's - * - * @param a the first operand - * @param b the second operand - * @returns squared distance between a and b - */ - export function squaredDistance(a: GLM.IArray, b: GLM.IArray): number; - - /** - * Calculates the squared euclidian distance between two vec2's - * - * @param a the first operand - * @param b the second operand - * @returns squared distance between a and b - */ - export function sqrDist(a: GLM.IArray, b: GLM.IArray): number; - - /** - * Calculates the length of a vec2 - * - * @param a vector to calculate length of - * @returns length of a - */ - export function length(a: GLM.IArray): number; - - /** - * Calculates the length of a vec2 - * - * @param a vector to calculate length of - * @returns length of a - */ - export function len(a: GLM.IArray): number; - - /** - * Calculates the squared length of a vec2 - * - * @param a vector to calculate squared length of - * @returns squared length of a - */ - export function squaredLength(a: GLM.IArray): number; - - /** - * Calculates the squared length of a vec2 - * - * @param a vector to calculate squared length of - * @returns squared length of a - */ - export function sqrLen(a: GLM.IArray): number; - - /** - * Negates the components of a vec2 - * - * @param out the receiving vector - * @param a vector to negate - * @returns out - */ - export function negate(out: GLM.IArray, a: GLM.IArray): GLM.IArray; - - /** - * Returns the inverse of the components of a vec2 - * - * @param out the receiving vector - * @param a vector to invert - * @returns out - */ - export function inverse(out: GLM.IArray, a: GLM.IArray): GLM.IArray; - - /** - * Normalize a vec2 - * - * @param out the receiving vector - * @param a vector to normalize - * @returns out - */ - export function normalize(out: GLM.IArray, a: GLM.IArray): GLM.IArray; - - /** - * Calculates the dot product of two vec2's - * - * @param a the first operand - * @param b the second operand - * @returns dot product of a and b - */ - export function dot(a: GLM.IArray, b: GLM.IArray): number; - - /** - * Computes the cross product of two vec2's - * Note that the cross product must by definition produce a 3D vector - * - * @param out the receiving vector - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function cross(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Performs a linear interpolation between two vec2's - * - * @param out the receiving vector - * @param a the first operand - * @param b the second operand - * @param t interpolation amount between the two inputs - * @returns out - */ - export function lerp(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray, t: number): GLM.IArray; - - /** - * Generates a random unit vector - * - * @param out the receiving vector - * @returns out - */ - export function random(out: GLM.IArray): GLM.IArray; - - /** - * Generates a random vector with the given scale - * - * @param out the receiving vector - * @param scale Length of the resulting vector. If ommitted, a unit vector will be returned - * @returns out - */ - export function random(out: GLM.IArray, scale: number): GLM.IArray; - - /** - * Transforms the vec2 with a mat2 - * - * @param out the receiving vector - * @param a the vector to transform - * @param m matrix to transform with - * @returns out - */ - export function transformMat2(out: GLM.IArray, a: GLM.IArray, m: GLM.IArray): GLM.IArray; - - /** - * Transforms the vec2 with a mat2d - * - * @param out the receiving vector - * @param a the vector to transform - * @param m matrix to transform with - * @returns out - */ - export function transformMat2d(out: GLM.IArray, a: GLM.IArray, m: GLM.IArray): GLM.IArray; - - /** - * Transforms the vec2 with a mat3 - * 3rd vector component is implicitly '1' - * - * @param out the receiving vector - * @param a the vector to transform - * @param m matrix to transform with - * @returns out - */ - export function transformMat3(out: GLM.IArray, a: GLM.IArray, m: GLM.IArray): GLM.IArray; - - /** - * Transforms the vec2 with a mat4 - * 3rd vector component is implicitly '0' - * 4th vector component is implicitly '1' - * - * @param out the receiving vector - * @param a the vector to transform - * @param m matrix to transform with - * @returns out - */ - export function transformMat4(out: GLM.IArray, a: GLM.IArray, m: GLM.IArray): GLM.IArray; - - /** - * Perform some operation over an array of vec2s. - * - * @param a the array of vectors to iterate over - * @param stride Number of elements between the start of each vec2. If 0 assumes tightly packed - * @param offset Number of elements to skip at the beginning of the array - * @param count Number of vec2s to iterate over. If 0 iterates over entire array - * @param fn Function to call for each vector in the array - * @param arg additional argument to pass to fn - * @returns a - */ - export function forEach(a: GLM.IArray, stride: number, offset: number, count: number, - fn: (a: GLM.IArray, b: GLM.IArray, arg: any) => void, arg: any): GLM.IArray; - - /** - * Perform some operation over an array of vec2s. - * - * @param a the array of vectors to iterate over - * @param stride Number of elements between the start of each vec2. If 0 assumes tightly packed - * @param offset Number of elements to skip at the beginning of the array - * @param count Number of vec2s to iterate over. If 0 iterates over entire array - * @param fn Function to call for each vector in the array - * @returns a - */ - export function forEach(a: GLM.IArray, stride: number, offset: number, count: number, - fn: (a: GLM.IArray, b: GLM.IArray) => void): GLM.IArray; - - /** - * Returns a string representation of a vector - * - * @param vec vector to represent as a string - * @returns string representation of the vector - */ - export function str(a: GLM.IArray): string; -} - -// vec3 -declare namespace vec3 { - - /** - * Creates a new, empty vec3 - * - * @returns a new 3D vector - */ - export function create(): GLM.IArray; - - /** - * Creates a new vec3 initialized with values from an existing vector - * - * @param a vector to clone - * @returns a new 3D vector - */ - export function clone(a: GLM.IArray): GLM.IArray; - - /** - * Creates a new vec3 initialized with the given values - * - * @param x X component - * @param y Y component - * @param z Z component - * @returns a new 3D vector - */ - export function fromValues(x: number, y: number, z: number): GLM.IArray; - - /** - * Copy the values from one vec3 to another - * - * @param out the receiving vector - * @param a the source vector - * @returns out - */ - export function copy(out: GLM.IArray, a: GLM.IArray): GLM.IArray; - - /** - * Set the components of a vec3 to the given values - * - * @param out the receiving vector - * @param x X component - * @param y Y component - * @param z Z component - * @returns out - */ - export function set(out: GLM.IArray, x: number, y: number, z: number): GLM.IArray; - - /** - * Adds two vec3's - * - * @param out the receiving vector - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function add(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Subtracts vector b from vector a - * - * @param out the receiving vector - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function subtract(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Subtracts vector b from vector a - * - * @param out the receiving vector - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function sub(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray - - /** - * Multiplies two vec3's - * - * @param out the receiving vector - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function multiply(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Multiplies two vec3's - * - * @param out the receiving vector - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function mul(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Divides two vec3's - * - * @param out the receiving vector - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function divide(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Divides two vec3's - * - * @param out the receiving vector - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function div(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Returns the minimum of two vec3's - * - * @param out the receiving vector - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function min(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Returns the maximum of two vec3's - * - * @param out the receiving vector - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function max(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Scales a vec3 by a scalar number - * - * @param out the receiving vector - * @param a the vector to scale - * @param b amount to scale the vector by - * @returns out - */ - export function scale(out: GLM.IArray, a: GLM.IArray, b: number): GLM.IArray; - - /** - * Adds two vec3's after scaling the second operand by a scalar value - * - * @param out the receiving vector - * @param a the first operand - * @param b the second operand - * @param scale the amount to scale b by before adding - * @returns out - */ - export function scaleAndAdd(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray, scale: number): GLM.IArray; - - /** - * Calculates the euclidian distance between two vec3's - * - * @param a the first operand - * @param b the second operand - * @returns distance between a and b - */ - export function distance(a: GLM.IArray, b: GLM.IArray): number; - - /** - * Calculates the euclidian distance between two vec3's - * - * @param a the first operand - * @param b the second operand - * @returns distance between a and b - */ - export function dist(a: GLM.IArray, b: GLM.IArray): number; - - /** - * Calculates the squared euclidian distance between two vec3's - * - * @param a the first operand - * @param b the second operand - * @returns squared distance between a and b - */ - export function squaredDistance(a: GLM.IArray, b: GLM.IArray): number; - - /** - * Calculates the squared euclidian distance between two vec3's - * - * @param a the first operand - * @param b the second operand - * @returns squared distance between a and b - */ - export function sqrDist(a: GLM.IArray, b: GLM.IArray): number; - - /** - * Calculates the length of a vec3 - * - * @param a vector to calculate length of - * @returns length of a - */ - export function length(a: GLM.IArray): number; - - /** - * Calculates the length of a vec3 - * - * @param a vector to calculate length of - * @returns length of a - */ - export function len(a: GLM.IArray): number; - - /** - * Calculates the squared length of a vec3 - * - * @param a vector to calculate squared length of - * @returns squared length of a - */ - export function squaredLength(a: GLM.IArray): number; - - /** - * Calculates the squared length of a vec3 - * - * @param a vector to calculate squared length of - * @returns squared length of a - */ - export function sqrLen(a: GLM.IArray): number; - - /** - * Negates the components of a vec3 - * - * @param out the receiving vector - * @param a vector to negate - * @returns out - */ - export function negate(out: GLM.IArray, a: GLM.IArray): GLM.IArray; - - /** - * Returns the inverse of the components of a vec3 - * - * @param out the receiving vector - * @param a vector to invert - * @returns out - */ - export function inverse(out: GLM.IArray, a: GLM.IArray): GLM.IArray; - - /** - * Normalize a vec3 - * - * @param out the receiving vector - * @param a vector to normalize - * @returns out - */ - export function normalize(out: GLM.IArray, a: GLM.IArray): GLM.IArray; - - /** - * Calculates the dot product of two vec3's - * - * @param a the first operand - * @param b the second operand - * @returns dot product of a and b - */ - export function dot(a: GLM.IArray, b: GLM.IArray): number; - - /** - * Computes the cross product of two vec3's - * - * @param out the receiving vector - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function cross(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Performs a linear interpolation between two vec3's - * - * @param out the receiving vector - * @param a the first operand - * @param b the second operand - * @param t interpolation amount between the two inputs - * @returns out - */ - export function lerp(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray, t: number): GLM.IArray; - - /** - * Generates a random unit vector - * - * @param out the receiving vector - * @returns out - */ - export function random(out: GLM.IArray): GLM.IArray; - - /** - * Generates a random vector with the given scale - * - * @param out the receiving vector - * @param [scale] Length of the resulting vector. If ommitted, a unit vector will be returned - * @returns out - */ - export function random(out: GLM.IArray, scale: number): GLM.IArray; - - /** - * Rotate a 3D vector around the x-axis - * @param out The receiving vec3 - * @param a The vec3 point to rotate - * @param b The origin of the rotation - * @param c The angle of rotation - * @returns out - */ - export function rotateX(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray, c: number): GLM.IArray; - - /** - * Rotate a 3D vector around the y-axis - * @param out The receiving vec3 - * @param a The vec3 point to rotate - * @param b The origin of the rotation - * @param c The angle of rotation - * @returns out - */ - export function rotateY(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray, c: number): GLM.IArray; - - /** - * Rotate a 3D vector around the z-axis - * @param out The receiving vec3 - * @param a The vec3 point to rotate - * @param b The origin of the rotation - * @param c The angle of rotation - * @returns out - */ - export function rotateZ(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray, c: number): GLM.IArray; - - /** - * Transforms the vec3 with a mat3. - * - * @param out the receiving vector - * @param a the vector to transform - * @param m the 3x3 matrix to transform with - * @returns out - */ - export function transformMat3(out: GLM.IArray, a: GLM.IArray, m: GLM.IArray): GLM.IArray; - - /** - * Transforms the vec3 with a mat4. - * 4th vector component is implicitly '1' - * - * @param out the receiving vector - * @param a the vector to transform - * @param m matrix to transform with - * @returns out - */ - export function transformMat4(out: GLM.IArray, a: GLM.IArray, m: GLM.IArray): GLM.IArray; - - /** - * Transforms the vec3 with a quat - * - * @param out the receiving vector - * @param a the vector to transform - * @param q quaternion to transform with - * @returns out - */ - export function transformQuat(out: GLM.IArray, a: GLM.IArray, q: GLM.IArray): GLM.IArray; - - - /** - * Perform some operation over an array of vec3s. - * - * @param a the array of vectors to iterate over - * @param stride Number of elements between the start of each vec3. If 0 assumes tightly packed - * @param offset Number of elements to skip at the beginning of the array - * @param count Number of vec3s to iterate over. If 0 iterates over entire array - * @param fn Function to call for each vector in the array - * @param arg additional argument to pass to fn - * @returns a - * @function - */ - export function forEach(out: GLM.IArray, string: number, offset: number, count: number, - fn: (a: GLM.IArray, b: GLM.IArray, arg: any) => void, arg: any): GLM.IArray; - - /** - * Perform some operation over an array of vec3s. - * - * @param a the array of vectors to iterate over - * @param stride Number of elements between the start of each vec3. If 0 assumes tightly packed - * @param offset Number of elements to skip at the beginning of the array - * @param count Number of vec3s to iterate over. If 0 iterates over entire array - * @param fn Function to call for each vector in the array - * @returns a - * @function - */ - export function forEach(out: GLM.IArray, string: number, offset: number, count: number, - fn: (a: GLM.IArray, b: GLM.IArray) => void): GLM.IArray; - - /** - * Get the angle between two 3D vectors - * @param a The first operand - * @param b The second operand - * @returns The angle in radians - */ - export function angle(a: GLM.IArray, b: GLM.IArray): number; - - /** - * Returns a string representation of a vector - * - * @param vec vector to represent as a string - * @returns string representation of the vector - */ - export function str(a: GLM.IArray): string; -} - -// vec4 -declare namespace vec4 { - - /** - * Creates a new, empty vec4 - * - * @returns a new 4D vector - */ - export function create(): GLM.IArray; - - /** - * Creates a new vec4 initialized with values from an existing vector - * - * @param a vector to clone - * @returns a new 4D vector - */ - export function clone(a: GLM.IArray): GLM.IArray; - - /** - * Creates a new vec4 initialized with the given values - * - * @param x X component - * @param y Y component - * @param z Z component - * @param w W component - * @returns a new 4D vector - */ - export function fromValues(x: number, y: number, z: number, w: number): GLM.IArray; - - /** - * Copy the values from one vec4 to another - * - * @param out the receiving vector - * @param a the source vector - * @returns out - */ - export function copy(out: GLM.IArray, a: GLM.IArray): GLM.IArray; - - /** - * Set the components of a vec4 to the given values - * - * @param out the receiving vector - * @param x X component - * @param y Y component - * @param z Z component - * @param w W component - * @returns out - */ - export function set(out: GLM.IArray, x: number, y: number, z: number, w: number): GLM.IArray; - - /** - * Adds two vec4's - * - * @param out the receiving vector - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function add(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Subtracts vector b from vector a - * - * @param out the receiving vector - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function subtract(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Subtracts vector b from vector a - * - * @param out the receiving vector - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function sub(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Multiplies two vec4's - * - * @param out the receiving vector - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function multiply(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Multiplies two vec4's - * - * @param out the receiving vector - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function mul(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Divides two vec4's - * - * @param out the receiving vector - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function divide(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Divides two vec4's - * - * @param out the receiving vector - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function div(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Returns the minimum of two vec4's - * - * @param out the receiving vector - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function min(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Returns the maximum of two vec4's - * - * @param out the receiving vector - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function max(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Scales a vec4 by a scalar number - * - * @param out the receiving vector - * @param a the vector to scale - * @param b amount to scale the vector by - * @returns out - */ - export function scale(out: GLM.IArray, a: GLM.IArray, b: number): GLM.IArray; - - /** - * Adds two vec4's after scaling the second operand by a scalar value - * - * @param out the receiving vector - * @param a the first operand - * @param b the second operand - * @param scale the amount to scale b by before adding - * @returns out - */ - export function scaleAndAdd(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray, scale: number): GLM.IArray; - - /** - * Calculates the euclidian distance between two vec4's - * - * @param a the first operand - * @param b the second operand - * @returns distance between a and b - */ - export function distance(a: GLM.IArray, b: GLM.IArray): number; - - /** - * Calculates the euclidian distance between two vec4's - * - * @param a the first operand - * @param b the second operand - * @returns distance between a and b - */ - export function dist(a: GLM.IArray, b: GLM.IArray): number; - - /** - * Calculates the squared euclidian distance between two vec4's - * - * @param a the first operand - * @param b the second operand - * @returns squared distance between a and b - */ - export function squaredDistance(a: GLM.IArray, b: GLM.IArray): number; - - /** - * Calculates the squared euclidian distance between two vec4's - * - * @param a the first operand - * @param b the second operand - * @returns squared distance between a and b - */ - export function sqrDist(a: GLM.IArray, b: GLM.IArray): number; - - /** - * Calculates the length of a vec4 - * - * @param a vector to calculate length of - * @returns length of a - */ - export function length(a: GLM.IArray): number; - - /** - * Calculates the length of a vec4 - * - * @param a vector to calculate length of - * @returns length of a - */ - export function len(a: GLM.IArray): number; - - /** - * Calculates the squared length of a vec4 - * - * @param a vector to calculate squared length of - * @returns squared length of a - */ - export function squaredLength(a: GLM.IArray): number; - - /** - * Calculates the squared length of a vec4 - * - * @param a vector to calculate squared length of - * @returns squared length of a - */ - export function sqrLen(a: GLM.IArray): number; - - /** - * Negates the components of a vec4 - * - * @param out the receiving vector - * @param a vector to negate - * @returns out - */ - export function negate(out: GLM.IArray, a: GLM.IArray): GLM.IArray; - - /** - * Returns the inverse of the components of a vec4 - * - * @param out the receiving vector - * @param a vector to invert - * @returns out - */ - export function inverse(out: GLM.IArray, a: GLM.IArray): GLM.IArray; - - /** - * Normalize a vec4 - * - * @param out the receiving vector - * @param a vector to normalize - * @returns out - */ - export function normalize(out: GLM.IArray, a: GLM.IArray): GLM.IArray; - - /** - * Calculates the dot product of two vec4's - * - * @param a the first operand - * @param b the second operand - * @returns dot product of a and b - */ - export function dot(a: GLM.IArray, b: GLM.IArray): number; - - /** - * Performs a linear interpolation between two vec4's - * - * @param out the receiving vector - * @param a the first operand - * @param b the second operand - * @param t interpolation amount between the two inputs - * @returns out - */ - export function lerp(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray, t: number): GLM.IArray; - - /** - * Generates a random unit vector - * - * @param out the receiving vector - * @returns out - */ - export function random(out: GLM.IArray): GLM.IArray; - - /** - * Generates a random vector with the given scale - * - * @param out the receiving vector - * @param Length of the resulting vector. If ommitted, a unit vector will be returned - * @returns out - */ - export function random(out: GLM.IArray, scale: number): GLM.IArray; - - /** - * Transforms the vec4 with a mat4. - * - * @param out the receiving vector - * @param a the vector to transform - * @param m matrix to transform with - * @returns out - */ - export function transformMat4(out: GLM.IArray, a: GLM.IArray, mat: GLM.IArray): GLM.IArray; - - /** - * Transforms the vec4 with a quat - * - * @param out the receiving vector - * @param a the vector to transform - * @param q quaternion to transform with - * @returns out - */ - export function transformQuat(out: GLM.IArray, a: GLM.IArray, quat: GLM.IArray): GLM.IArray; - - /** - * Perform some operation over an array of vec4s. - * - * @param a the array of vectors to iterate over - * @param stride Number of elements between the start of each vec4. If 0 assumes tightly packed - * @param offset Number of elements to skip at the beginning of the array - * @param count Number of vec4s to iterate over. If 0 iterates over entire array - * @param fn Function to call for each vector in the array - * @param additional argument to pass to fn - * @returns a - * @function - */ - export function forEach(out: GLM.IArray, string: number, offset: number, count: number, - callback: (a: GLM.IArray, b: GLM.IArray, arg: any) => void, arg: any): GLM.IArray; - - /** - * Perform some operation over an array of vec4s. - * - * @param a the array of vectors to iterate over - * @param stride Number of elements between the start of each vec4. If 0 assumes tightly packed - * @param offset Number of elements to skip at the beginning of the array - * @param count Number of vec4s to iterate over. If 0 iterates over entire array - * @param fn Function to call for each vector in the array - * @returns a - * @function - */ - export function forEach(out: GLM.IArray, string: number, offset: number, count: number, - callback: (a: GLM.IArray, b: GLM.IArray) => void): GLM.IArray; - - /** - * Returns a string representation of a vector - * - * @param vec vector to represent as a string - * @returns string representation of the vector - */ - export function str(a: GLM.IArray): string; -} - -// mat2 -declare namespace mat2 { - - /** - * Creates a new identity mat2 - * - * @returns a new 2x2 matrix - */ - export function create(): GLM.IArray; - - /** - * Creates a new mat2 initialized with values from an existing matrix - * - * @param a matrix to clone - * @returns a new 2x2 matrix - */ - export function clone(a: GLM.IArray): GLM.IArray; - - /** - * Copy the values from one mat2 to another - * - * @param out the receiving matrix - * @param a the source matrix - * @returns out - */ - export function copy(out: GLM.IArray, a: GLM.IArray): GLM.IArray; - - /** - * Set a mat2 to the identity matrix - * - * @param out the receiving matrix - * @returns out - */ - export function identity(out: GLM.IArray): GLM.IArray; - - /** - * Transpose the values of a mat2 - * - * @param out the receiving matrix - * @param a the source matrix - * @returns out - */ - export function transpose(out: GLM.IArray, a: GLM.IArray): GLM.IArray; - - /** - * Inverts a mat2 - * - * @param out the receiving matrix - * @param a the source matrix - * @returns out - */ - export function invert(out: GLM.IArray, a: GLM.IArray): GLM.IArray; - - /** - * Calculates the adjugate of a mat2 - * - * @param out the receiving matrix - * @param a the source matrix - * @returns out - */ - export function adjoint(out: GLM.IArray, a: GLM.IArray): GLM.IArray; - - /** - * Calculates the determinant of a mat2 - * - * @param a the source matrix - * @returns determinant of a - */ - export function determinant(a: GLM.IArray): number; - - /** - * Multiplies two mat2's - * - * @param out the receiving matrix - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function multiply(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Multiplies two mat2's - * - * @param out the receiving matrix - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function mul(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Rotates a mat2 by the given angle - * - * @param out the receiving matrix - * @param a the matrix to rotate - * @param rad the angle to rotate the matrix by - * @returns out - */ - export function rotate(out: GLM.IArray, a: GLM.IArray, rad: number): GLM.IArray; - - /** - * Scales the mat2 by the dimensions in the given vec2 - * - * @param out the receiving matrix - * @param a the matrix to rotate - * @param v the vec2 to scale the matrix by - * @returns out - **/ - export function scale(out: GLM.IArray, a: GLM.IArray, v: GLM.IArray): GLM.IArray; - - /** - * Returns a string representation of a mat2 - * - * @param a matrix to represent as a string - * @returns string representation of the matrix - */ - export function str(a: GLM.IArray): string; - - /** - * Returns Frobenius norm of a mat2 - * - * @param a the matrix to calculate Frobenius norm of - * @returns Frobenius norm - */ - export function frob(a: GLM.IArray): number; - - /** - * Returns L, D and U matrices (Lower triangular, Diagonal and Upper triangular) by factorizing the input matrix - * @param L the lower triangular matrix - * @param D the diagonal matrix - * @param U the upper triangular matrix - * @param a the input matrix to factorize - */ - export function LDU(L: GLM.IArray, D: GLM.IArray, U: GLM.IArray, a: GLM.IArray): GLM.IArray; -} - -// mat2d -declare namespace mat2d { - - /** - * Creates a new identity mat2d - * - * @returns a new 2x3 matrix - */ - export function create(): GLM.IArray; - - /** - * Creates a new mat2d initialized with values from an existing matrix - * - * @param a matrix to clone - * @returns a new 2x3 matrix - */ - export function clone(a: GLM.IArray): GLM.IArray; - - /** - * Copy the values from one mat2d to another - * - * @param out the receiving matrix - * @param a the source matrix - * @returns out - */ - export function copy(out: GLM.IArray, a: GLM.IArray): GLM.IArray; - - /** - * Set a mat2d to the identity matrix - * - * @param out the receiving matrix - * @returns out - */ - export function identity(out: GLM.IArray): GLM.IArray; - - /** - * Inverts a mat2d - * - * @param out the receiving matrix - * @param a the source matrix - * @returns out - */ - export function invert(out: GLM.IArray, a: GLM.IArray): GLM.IArray; - - /** - * Calculates the determinant of a mat2d - * - * @param a the source matrix - * @returns determinant of a - */ - export function determinant(a: GLM.IArray): number; - - /** - * Multiplies two mat2d's - * - * @param out the receiving matrix - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function multiply(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Multiplies two mat2d's - * - * @param out the receiving matrix - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function mul(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Rotates a mat2d by the given angle - * - * @param out the receiving matrix - * @param a the matrix to rotate - * @param rad the angle to rotate the matrix by - * @returns out - */ - export function rotate(out: GLM.IArray, a: GLM.IArray, rad: number): GLM.IArray; - - /** - * Scales the mat2d by the dimensions in the given vec2 - * - * @param out the receiving matrix - * @param a the matrix to translate - * @param v the vec2 to scale the matrix by - * @returns out - **/ - export function scale(out: GLM.IArray, a: GLM.IArray, v: GLM.IArray): GLM.IArray; - - /** - * Translates the mat2d by the dimensions in the given vec2 - * - * @param out the receiving matrix - * @param a the matrix to translate - * @param v the vec2 to translate the matrix by - * @returns out - **/ - export function translate(out: GLM.IArray, a: GLM.IArray, v: GLM.IArray): GLM.IArray; - - /** - * Returns a string representation of a mat2d - * - * @param a matrix to represent as a string - * @returns string representation of the matrix - */ - export function str(a: GLM.IArray): string; - - /** - * Returns Frobenius norm of a mat2d - * - * @param a the matrix to calculate Frobenius norm of - * @returns Frobenius norm - */ - export function frob(a: GLM.IArray): number; -} - -// mat3 -declare namespace mat3 { - - /** - * Creates a new identity mat3 - * - * @returns a new 3x3 matrix - */ - export function create(): GLM.IArray; - - /** - * Creates a new mat3 initialized with values from an existing matrix - * - * @param a matrix to clone - * @returns a new 3x3 matrix - */ - export function clone(a: GLM.IArray): GLM.IArray; - - /** - * Copy the values from one mat3 to another - * - * @param out the receiving matrix - * @param a the source matrix - * @returns out - */ - export function copy(out: GLM.IArray, a: GLM.IArray): GLM.IArray; - - /** - * Set a mat3 to the identity matrix - * - * @param out the receiving matrix - * @returns out - */ - export function identity(out: GLM.IArray): GLM.IArray; - - /** - * Transpose the values of a mat3 - * - * @param out the receiving matrix - * @param a the source matrix - * @returns out - */ - export function transpose(out: GLM.IArray, a: GLM.IArray): GLM.IArray; - - /** - * Inverts a mat3 - * - * @param out the receiving matrix - * @param a the source matrix - * @returns out - */ - export function invert(out: GLM.IArray, a: GLM.IArray): GLM.IArray; - - /** - * Calculates the adjugate of a mat3 - * - * @param out the receiving matrix - * @param a the source matrix - * @returns out - */ - export function adjoint(out: GLM.IArray, a: GLM.IArray): GLM.IArray; - - /** - * Calculates the determinant of a mat3 - * - * @param a the source matrix - * @returns determinant of a - */ - export function determinant(a: GLM.IArray): number; - - /** - * Multiplies two mat3's - * - * @param out the receiving matrix - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function multiply(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Multiplies two mat3's - * - * @param out the receiving matrix - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function mul(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Returns a string representation of a mat3 - * - * @param mat matrix to represent as a string - * @returns string representation of the matrix - */ - export function str(mat: GLM.IArray): string; - - /** - * Returns Frobenius norm of a mat3 - * - * @param a the matrix to calculate Frobenius norm of - * @returns Frobenius norm - */ - export function frob(a: GLM.IArray): number; - - /** - * Calculates a 3x3 normal matrix (transpose inverse) from the 4x4 matrix - * - * @param out mat3 receiving operation result - * @param a Mat4 to derive the normal matrix from - * - * @returns out - */ - export function normalFromMat4(out: GLM.IArray, a: GLM.IArray): GLM.IArray; - - /** - * Calculates a 3x3 matrix from the given quaternion - * - * @param out mat3 receiving operation result - * @param q Quaternion to create matrix from - * - * @returns out - */ - export function fromQuat(out: GLM.IArray, q: GLM.IArray): GLM.IArray; - - /** - * Copies the upper-left 3x3 values into the given mat3. - * - * @param out the receiving 3x3 matrix - * @param a the source 4x4 matrix - * @returns out - */ - export function fromMat4(out: GLM.IArray, a: GLM.IArray): GLM.IArray; - - /** - * Scales the mat3 by the dimensions in the given vec2 - * - * @param out the receiving matrix - * @param a the matrix to rotate - * @param v the vec2 to scale the matrix by - * @returns out - **/ - export function scale(out: GLM.IArray, a: GLM.IArray, v: GLM.IArray): GLM.IArray; - - /** - * Copies the values from a mat2d into a mat3 - * - * @param out the receiving matrix - * @param {mat2d} a the matrix to copy - * @returns out - **/ - export function fromMat2d(out: GLM.IArray, a: GLM.IArray): GLM.IArray; - - /** - * Translate a mat3 by the given vector - * - * @param out the receiving matrix - * @param a the matrix to translate - * @param v vector to translate by - * @returns out - */ - export function translate(out: GLM.IArray, a: GLM.IArray, v: GLM.IArray): GLM.IArray; - - /** - * Rotates a mat3 by the given angle - * - * @param out the receiving matrix - * @param a the matrix to rotate - * @param rad the angle to rotate the matrix by - * @returns out - */ - export function rotate(out: GLM.IArray, a: GLM.IArray, rad: number): GLM.IArray; -} - -// mat4 -declare namespace mat4 { - - /** - * Creates a new identity mat4 - * - * @returns a new 4x4 matrix - */ - export function create(): GLM.IArray; - - /** - * Creates a new mat4 initialized with values from an existing matrix - * - * @param a matrix to clone - * @returns a new 4x4 matrix - */ - export function clone(a: GLM.IArray): GLM.IArray; - - /** - * Copy the values from one mat4 to another - * - * @param out the receiving matrix - * @param a the source matrix - * @returns out - */ - export function copy(out: GLM.IArray, a: GLM.IArray): GLM.IArray; - - /** - * Set a mat4 to the identity matrix - * - * @param out the receiving matrix - * @returns out - */ - export function identity(a: GLM.IArray): GLM.IArray; - - /** - * Transpose the values of a mat4 - * - * @param out the receiving matrix - * @param a the source matrix - * @returns out - */ - export function transpose(out: GLM.IArray, a: GLM.IArray): GLM.IArray; - - /** - * Inverts a mat4 - * - * @param out the receiving matrix - * @param a the source matrix - * @returns out - */ - export function invert(out: GLM.IArray, a: GLM.IArray): GLM.IArray; - - /** - * Calculates the adjugate of a mat4 - * - * @param out the receiving matrix - * @param a the source matrix - * @returns out - */ - export function adjoint(out: GLM.IArray, a: GLM.IArray): GLM.IArray; - - /** - * Calculates the determinant of a mat4 - * - * @param a the source matrix - * @returns determinant of a - */ - export function determinant(a: GLM.IArray): number; - - /** - * Multiplies two mat4's - * - * @param out the receiving matrix - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function multiply(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Multiplies two mat4's - * - * @param out the receiving matrix - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function mul(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Translate a mat4 by the given vector - * - * @param out the receiving matrix - * @param a the matrix to translate - * @param v vector to translate by - * @returns out - */ - export function translate(out: GLM.IArray, a: GLM.IArray, v: GLM.IArray): GLM.IArray; - - /** - * Scales the mat4 by the dimensions in the given vec3 - * - * @param out the receiving matrix - * @param a the matrix to scale - * @param v the vec3 to scale the matrix by - * @returns out - **/ - export function scale(out: GLM.IArray, a: GLM.IArray, v: GLM.IArray): GLM.IArray; - - /** - * Rotates a mat4 by the given angle - * - * @param out the receiving matrix - * @param a the matrix to rotate - * @param rad the angle to rotate the matrix by - * @param axis the axis to rotate around - * @returns out - */ - export function rotate(out: GLM.IArray, a: GLM.IArray, rad: number, axis: GLM.IArray): GLM.IArray; - - /** - * Rotates a matrix by the given angle around the X axis - * - * @param out the receiving matrix - * @param a the matrix to rotate - * @param rad the angle to rotate the matrix by - * @returns out - */ - export function rotateX(out: GLM.IArray, a: GLM.IArray, rad: number): GLM.IArray; - - /** - * Rotates a matrix by the given angle around the Y axis - * - * @param out the receiving matrix - * @param a the matrix to rotate - * @param rad the angle to rotate the matrix by - * @returns out - */ - export function rotateY(out: GLM.IArray, a: GLM.IArray, rad: number): GLM.IArray; - - /** - * Rotates a matrix by the given angle around the Z axis - * - * @param out the receiving matrix - * @param a the matrix to rotate - * @param rad the angle to rotate the matrix by - * @returns out - */ - export function rotateZ(out: GLM.IArray, a: GLM.IArray, rad: number): GLM.IArray; - - /** - * Generates a frustum matrix with the given bounds - * - * @param out mat4 frustum matrix will be written into - * @param left Left bound of the frustum - * @param right Right bound of the frustum - * @param bottom Bottom bound of the frustum - * @param top Top bound of the frustum - * @param near Near bound of the frustum - * @param far Far bound of the frustum - * @returns out - */ - export function frustum(out: GLM.IArray, left: number, right: number, - bottom: number, top: number, near: number, far: number): GLM.IArray; - - /** - * Generates a perspective projection matrix with the given bounds - * - * @param out mat4 frustum matrix will be written into - * @param fovy Vertical field of view in radians - * @param aspect Aspect ratio. typically viewport width/height - * @param near Near bound of the frustum - * @param far Far bound of the frustum - * @returns out - */ - export function perspective(out: GLM.IArray, fovy: number, aspect: number, - near: number, far: number): GLM.IArray; - - /** - * Generates a orthogonal projection matrix with the given bounds - * - * @param out mat4 frustum matrix will be written into - * @param left Left bound of the frustum - * @param right Right bound of the frustum - * @param bottom Bottom bound of the frustum - * @param top Top bound of the frustum - * @param near Near bound of the frustum - * @param far Far bound of the frustum - * @returns out - */ - export function ortho(out: GLM.IArray, left: number, right: number, - bottom: number, top: number, near: number, far: number): GLM.IArray; - - /** - * Generates a look-at matrix with the given eye position, focal point, and up axis - * - * @param out mat4 frustum matrix will be written into - * @param eye Position of the viewer - * @param center Point the viewer is looking at - * @param up vec3 pointing up - * @returns out - */ - export function lookAt(out: GLM.IArray, eye: GLM.IArray, - center: GLM.IArray, up: GLM.IArray): GLM.IArray; - - /** - * Returns a string representation of a mat4 - * - * @param mat matrix to represent as a string - * @returns string representation of the matrix - */ - export function str(mat: GLM.IArray): string; - - /** - * Returns Frobenius norm of a mat4 - * - * @param a the matrix to calculate Frobenius norm of - * @returns Frobenius norm - */ - export function frob(a: GLM.IArray): number; - - /** - * Creates a matrix from a quaternion rotation and vector translation - * This is equivalent to (but much faster than): - * - * mat4.identity(dest); - * mat4.translate(dest, vec); - * var quatMat = mat4.create(); - * quat4.toMat4(quat, quatMat); - * mat4.multiply(dest, quatMat); - * - * @param out mat4 receiving operation result - * @param q Rotation quaternion - * @param v Translation vector - * @returns out - */ - export function fromRotationTranslation(out: GLM.IArray, q: GLM.IArray, v: GLM.IArray): GLM.IArray; - - /** - * Creates a matrix from a quaternion rotation, vector translation and vector scale. - * - * This is equivalent to (but much faster than): - * - * mat4.identity(dest); - * mat4.translate(dest, vec); - * var quatMat = mat4.create(); - * quat4.toMat4(quat, quatMat); - * mat4.multiply(dest, quatMat); - * mat4.scale(dest, scale) - * - * @param out mat4 receiving operation result - * @param q Rotation quaternion - * @param v Translation vector - * @param s Scale vector - * @returns out - */ - export function fromRotationTranslationScale(out: GLM.IArray, q: GLM.IArray, v: GLM.IArray, s: GLM.IArray): GLM.IArray - - /** - * Creates a matrix from a quaternion - * - * @param out mat4 receiving operation result - * @param q Rotation quaternion - * @returns out - */ - export function fromQuat(out: GLM.IArray, q: GLM.IArray): GLM.IArray; -} - -// quat -declare namespace quat { - - /** - * Creates a new identity quat - * - * @returns a new quaternion - */ - export function create(): GLM.IArray; - - /** - * Creates a new quat initialized with values from an existing quaternion - * - * @param a quaternion to clone - * @returns a new quaternion - * @function - */ - export function clone(a: GLM.IArray): GLM.IArray; - - /** - * Creates a new quat initialized with the given values - * - * @param x X component - * @param y Y component - * @param z Z component - * @param w W component - * @returns a new quaternion - * @function - */ - export function fromValues(x: number, y: number, z: number, w: number): GLM.IArray; - - /** - * Copy the values from one quat to another - * - * @param out the receiving quaternion - * @param a the source quaternion - * @returns out - * @function - */ - export function copy(out: GLM.IArray, a: GLM.IArray): GLM.IArray; - - /** - * Set the components of a quat to the given values - * - * @param out the receiving quaternion - * @param x X component - * @param y Y component - * @param z Z component - * @param w W component - * @returns out - * @function - */ - export function set(out: GLM.IArray, x: number, y: number, z: number, w: number): GLM.IArray; - - /** - * Set a quat to the identity quaternion - * - * @param out the receiving quaternion - * @returns out - */ - export function identity(out: GLM.IArray): GLM.IArray; - - /** - * Sets a quat from the given angle and rotation axis, - * then returns it. - * - * @param out the receiving quaternion - * @param axis the axis around which to rotate - * @param rad the angle in radians - * @returns out - **/ - export function setAxisAngle(out: GLM.IArray, axis: GLM.IArray, rad: number): GLM.IArray; - - /** - * Adds two quat's - * - * @param out the receiving quaternion - * @param a the first operand - * @param b the second operand - * @returns out - * @function - */ - export function add(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Multiplies two quat's - * - * @param out the receiving quaternion - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function multiply(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Multiplies two quat's - * - * @param out the receiving quaternion - * @param a the first operand - * @param b the second operand - * @returns out - */ - export function mul(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Scales a quat by a scalar number - * - * @param out the receiving vector - * @param a the vector to scale - * @param b amount to scale the vector by - * @returns out - * @function - */ - export function scale(out: GLM.IArray, a: GLM.IArray, b: number): GLM.IArray; - - /** - * Calculates the length of a quat - * - * @param a vector to calculate length of - * @returns length of a - * @function - */ - export function length(a: GLM.IArray): number; - - /** - * Calculates the length of a quat - * - * @param a vector to calculate length of - * @returns length of a - * @function - */ - export function len(a: GLM.IArray): number; - - /** - * Calculates the squared length of a quat - * - * @param a vector to calculate squared length of - * @returns squared length of a - * @function - */ - export function squaredLength(a: GLM.IArray): number; - - /** - * Calculates the squared length of a quat - * - * @param a vector to calculate squared length of - * @returns squared length of a - * @function - */ - export function sqrLen(a: GLM.IArray): number; - - /** - * Normalize a quat - * - * @param out the receiving quaternion - * @param a quaternion to normalize - * @returns out - * @function - */ - export function normalize(out: GLM.IArray, a: GLM.IArray): GLM.IArray; - - /** - * Calculates the dot product of two quat's - * - * @param a the first operand - * @param b the second operand - * @returns dot product of a and b - * @function - */ - export function dot(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): number; - - /** - * Performs a linear interpolation between two quat's - * - * @param out the receiving quaternion - * @param a the first operand - * @param b the second operand - * @param t interpolation amount between the two inputs - * @returns out - * @function - */ - export function lerp(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray, t: number): GLM.IArray; - - /** - * Performs a spherical linear interpolation between two quat - * - * @param out the receiving quaternion - * @param a the first operand - * @param b the second operand - * @param t interpolation amount between the two inputs - * @returns out - */ - export function slerp(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray, t: number): GLM.IArray; - - /** - * Calculates the inverse of a quat - * - * @param out the receiving quaternion - * @param a quat to calculate inverse of - * @returns out - */ - export function invert(out: GLM.IArray, a: GLM.IArray): GLM.IArray; - - /** - * Calculates the conjugate of a quat - * If the quaternion is normalized, this function is faster than quat.inverse and produces the same result. - * - * @param out the receiving quaternion - * @param a quat to calculate conjugate of - * @returns out - */ - export function conjugate(out: GLM.IArray, a: GLM.IArray): GLM.IArray; - - /** - * Returns a string representation of a quatenion - * - * @param vec vector to represent as a string - * @returns string representation of the vector - */ - export function str(a: GLM.IArray): string; - - /** - * Rotates a quaternion by the given angle about the X axis - * - * @param out quat receiving operation result - * @param a quat to rotate - * @param rad angle (in radians) to rotate - * @returns out - */ - export function rotateX(out: GLM.IArray, a: GLM.IArray, rad: number): GLM.IArray; - - /** - * Rotates a quaternion by the given angle about the Y axis - * - * @param out quat receiving operation result - * @param a quat to rotate - * @param rad angle (in radians) to rotate - * @returns out - */ - export function rotateY(out: GLM.IArray, a: GLM.IArray, rad: number): GLM.IArray; - - /** - * Rotates a quaternion by the given angle about the Z axis - * - * @param out quat receiving operation result - * @param a quat to rotate - * @param rad angle (in radians) to rotate - * @returns out - */ - export function rotateZ(out: GLM.IArray, a: GLM.IArray, rad: number): GLM.IArray; - - /** - * Creates a quaternion from the given 3x3 rotation matrix. - * - * NOTE: The resultant quaternion is not normalized, so you should be sure - * to renormalize the quaternion yourself where necessary. - * - * @param out the receiving quaternion - * @param m rotation matrix - * @returns out - * @function - */ - export function fromMat3(out: GLM.IArray, m: GLM.IArray): GLM.IArray; - - /** - * Sets the specified quaternion with values corresponding to the given - * axes. Each axis is a vec3 and is expected to be unit length and - * perpendicular to all other specified axes. - * - * @param view the vector representing the viewing direction - * @param right the vector representing the local "right" direction - * @param up the vector representing the local "up" direction - * @returns out - */ - export function setAxes(out: GLM.IArray, view: GLM.IArray, right: GLM.IArray, - up: GLM.IArray): GLM.IArray; - - /** - * Sets a quaternion to represent the shortest rotation from one - * vector to another. - * - * Both vectors are assumed to be unit length. - * - * @param out the receiving quaternion. - * @param a the initial vector - * @param b the destination vector - * @returns out - */ - export function rotationTo(out: GLM.IArray, a: GLM.IArray, b: GLM.IArray): GLM.IArray; - - /** - * Calculates the W component of a quat from the X, Y, and Z components. - * Assumes that quaternion is 1 unit in length. - * Any existing W component will be ignored. - * - * @param out the receiving quaternion - * @param a quat to calculate W component of - * @returns out - */ - export function calculateW(out: GLM.IArray, a: GLM.IArray): GLM.IArray; -} diff --git a/glob-stream/glob-stream-tests.ts b/glob-stream/glob-stream-tests.ts index 84e34dfe3e..617246799c 100644 --- a/glob-stream/glob-stream-tests.ts +++ b/glob-stream/glob-stream-tests.ts @@ -1,4 +1,4 @@ -import gs = require('./'); +import gs = require('glob-stream'); var read: NodeJS.ReadableStream; diff --git a/glob/glob-tests.ts b/glob/glob-tests.ts index c2c17bbbb5..dcc72341cc 100644 --- a/glob/glob-tests.ts +++ b/glob/glob-tests.ts @@ -1,4 +1,4 @@ -import glob = require("./"); +import glob = require("glob"); var Glob = glob.Glob; (()=> { diff --git a/globalize/globalize-0.1.3-tests.ts b/globalize/globalize-0.1.3-tests.ts deleted file mode 100644 index 4e3e9056ed..0000000000 --- a/globalize/globalize-0.1.3-tests.ts +++ /dev/null @@ -1,11 +0,0 @@ -/// -module Tests { - Globalize.culture('en-US'); - Globalize.addCultureInfo('nb-NO', 'no', { messages: {Test: "Test"} }); - var cult = Globalize.findClosestCulture('nb-NO'); - var numberString = Globalize.format(1.245, 'n2'); - var testString = Globalize.localize('Test'); - var dateParsed = Globalize.parseDate('2016-02-03'); - var intParsed = Globalize.parseInt('123'); - var floatParsed = Globalize.parseFloat('12.3'); -} \ No newline at end of file diff --git a/globalize/globalize-0.1.3.d.ts b/globalize/globalize-0.1.3.d.ts deleted file mode 100644 index b31a1cc092..0000000000 --- a/globalize/globalize-0.1.3.d.ts +++ /dev/null @@ -1,25 +0,0 @@ -// Type definitions for Globalize v0.1.3 (NuGet package version) -// Project: https://github.com/jquery/globalize -// Definitions by: Aram Taieb -// Definitions: https://github.com/afromogli/DefinitelyTyped - -interface GlobalizeStatic { - addCultureInfo(cultureName: string, baseCultureName: string, info: any): void; - findClosestCulture(name: string): any; - format(value: any, format: string): string; - format(value: any, format: string, cultureSelector: string): string; - localize(key: string): string; - localize(key: string, cultureSelector: string): string; - parseDate(value: any): Date; - parseDate(value: any, formats: any): Date; - parseDate(value: any, formats: any, culture: string): Date; - parseInt(value: any): number; - parseInt(value: any, radix: number): number; - parseInt(value: any, radix: number, cultureSelector: string): number; - parseFloat(value: any): number; - parseFloat(value: any, radix: number): number; - parseFloat(value: any, radix: number, cultureSelector: string): number; - culture(cultureSelector: string): any; -} - -declare var Globalize: GlobalizeStatic; diff --git a/google-apps-script/index.d.ts b/google-apps-script/index.d.ts index 76a3bbec61..f80598c391 100644 --- a/google-apps-script/index.d.ts +++ b/google-apps-script/index.d.ts @@ -20,7 +20,7 @@ /// /// /// -/// reference path="google-apps-script.maps.d.ts"/> +/// /// /// /// diff --git a/graphql-relay/graphql-relay-tests.ts b/graphql-relay/graphql-relay-tests.ts index 1ee0b5e111..f1b18a4521 100644 --- a/graphql-relay/graphql-relay-tests.ts +++ b/graphql-relay/graphql-relay-tests.ts @@ -29,7 +29,7 @@ import { pluralIdentifyingRootField, // Mutations mutationWithClientMutationId, -} from "."; +} from "graphql-relay"; // Connections // connectionArgs returns the arguments that fields should provide when they return a connection type that supports bidirectional pagination. connectionArgs.first = 10; diff --git a/gulp-cheerio/gulp-cheerio-tests.ts b/gulp-cheerio/gulp-cheerio-tests.ts index d31c0c51dc..464abccead 100644 --- a/gulp-cheerio/gulp-cheerio-tests.ts +++ b/gulp-cheerio/gulp-cheerio-tests.ts @@ -4,7 +4,7 @@ import cheerio = require('gulp-cheerio'); import gulp = require('gulp'); -import Vinyl = require('../vinyl'); +import Vinyl = require('vinyl'); // // There are two ways to use gulp-cheerio: synchronous and asynchronous. See the following usage examples: diff --git a/gulp-istanbul/gulp-istanbul-0.8.1.d.ts b/gulp-istanbul/gulp-istanbul-0.8.1.d.ts deleted file mode 100644 index de6d54635c..0000000000 --- a/gulp-istanbul/gulp-istanbul-0.8.1.d.ts +++ /dev/null @@ -1,50 +0,0 @@ -// Type definitions for gulp-istanbul v0.8.1 -// Project: https://github.com/SBoudrias/gulp-istanbul -// Definitions by: Asana -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -/// - - -declare function GulpIstanbul(opts?: GulpIstanbul.Options): NodeJS.ReadWriteStream; - -declare namespace GulpIstanbul { - export function hookRequire(): NodeJS.ReadWriteStream; - export function summarizeCoverage(opts?: { coverageVariable?: string }): Coverage; - export function writeReports(opts?: ReportOptions): NodeJS.ReadWriteStream; - - interface Options { - coverageVariable?: string; - includeUntested?: boolean; - embedSource?: boolean; - preserveComments?: boolean; - noCompact?: boolean; - noAutoWrap?: boolean; - codeGenerationOptions?: Object; - debug?: boolean; - walkDebug?: boolean; - } - - interface Coverage { - lines: CoverageStats; - statements: CoverageStats; - functions: CoverageStats; - branches: CoverageStats; - } - - interface CoverageStats { - total: number; - covered: number; - skipped: number; - pct: number; - } - - interface ReportOptions { - dir?: string; - reporters?: string[]; - reportOpts?: { dir?: string }; - coverageVariable?: string; - } -} - -export = GulpIstanbul; diff --git a/gulp-tslint/gulp-tslint-tests.ts b/gulp-tslint/gulp-tslint-tests.ts index 75c79954a9..efadfa9bb1 100644 --- a/gulp-tslint/gulp-tslint-tests.ts +++ b/gulp-tslint/gulp-tslint-tests.ts @@ -1,6 +1,6 @@ import * as gulp from 'gulp'; import * as tslint from 'gulp-tslint'; -import vinyl = require('../vinyl'); +import vinyl = require('vinyl'); // Taken from gulp-tslint README https://github.com/panuhorsmalahti/gulp-tslint/blob/master/README.md diff --git a/halogen/tsconfig.json b/halogen/tsconfig.json index 1b880dc4e8..5e6c8ab8f5 100644 --- a/halogen/tsconfig.json +++ b/halogen/tsconfig.json @@ -15,9 +15,10 @@ "jsx": "react" }, "files": [ - "index.d.ts" - ], - "include": [ - "halogen-*-loader-tests.tsx" + "index.d.ts", + "halogen-clip-loader-tests.tsx", + "halogen-fade-loader-tests.tsx", + "halogen-pacman-loader-tests.tsx", + "halogen-rotate-loader-tests.tsx" ] } \ No newline at end of file diff --git a/hammerjs/hammerjs-commonjs-tests.ts b/hammerjs/hammerjs-commonjs-tests.ts deleted file mode 100644 index 5788d67906..0000000000 --- a/hammerjs/hammerjs-commonjs-tests.ts +++ /dev/null @@ -1,117 +0,0 @@ -// Tests based on examples at http://hammerjs.github.io/examples/ - - - -import Hammer = require("hammerjs"); - -(() => -{ - var myElement = document.getElementById( 'myElement' ); - - // create a simple instance - // by default, it only adds horizontal recognizers - var mc = new Hammer( myElement ); - - // listen to events... - mc.on( "panleft panright tap press", function ( ev ) - { - myElement.textContent = ev.type + " gesture detected."; - } ); -})(); - - -(() => -{ - var myElement = document.getElementById( 'myElement' ); - - // create a simple instance - // by default, it only adds horizontal recognizers - var mc = new Hammer( myElement ); - - // let the pan gesture support all directions. - // this will block the vertical scrolling on a touch-device while on the element - mc.get( 'pan' ).set( {direction: Hammer.DIRECTION_ALL} ); - - // listen to events... - mc.on( "panleft panright panup pandown tap press", function ( ev:HammerInput ) - { - myElement.textContent = ev.type + " gesture detected."; - } ); -})(); - - -(() => -{ - var myElement = document.getElementById( 'myElement' ); - - var mc = new Hammer.Manager( myElement ); - - // create a pinch and rotate recognizer - // these require 2 pointers - var pinch = new Hammer.Pinch(); - var rotate = new Hammer.Rotate(); - - // we want to detect both the same time - pinch.recognizeWith( rotate ); - - // add to the Manager - mc.add( [pinch, rotate] ); - - - mc.on( "pinch rotate", function ( ev:HammerInput ) - { - myElement.textContent += ev.type + " "; - } ); -})(); - - -(() => -{ - var myElement = document.getElementById( 'myElement' ); - - // We create a manager object, which is the same as Hammer(), but without the presetted recognizers. - var mc = new Hammer.Manager( myElement ); - - // Default, tap recognizer - mc.add( new Hammer.Tap() ); - - // Tap recognizer with minimal 4 taps - mc.add( new Hammer.Tap( {event: 'quadrupletap', taps: 4} ) ); - - // we want to recognize this simulatenous, so a quadrupletap will be detected even while a tap has been recognized. - // the tap event will be emitted on every tap - mc.get( 'quadrupletap' ).recognizeWith( 'tap' ); - - - mc.on( "tap quadrupletap", function ( ev ) - { - myElement.textContent += ev.type + " "; - } ); -})(); - - -(() => -{ - var myElement = document.getElementById( 'myElement' ); - - // We create a manager object, which is the same as Hammer(), but without the presetted recognizers. - var mc = new Hammer.Manager( myElement ); - - - // Tap recognizer with minimal 2 taps - mc.add( new Hammer.Tap( {event: 'doubletap', taps: 2} ) ); - // Single tap recognizer - mc.add( new Hammer.Tap( {event: 'singletap'} ) ); - - - // we want to recognize this simulatenous, so a quadrupletap will be detected even while a tap has been recognized. - mc.get( 'doubletap' ).recognizeWith( 'singletap' ); - // we only want to trigger a tap, when we don't have detected a doubletap - mc.get( 'singletap' ).requireFailure( 'doubletap' ); - - - mc.on( "singletap doubletap", function ( ev ) - { - myElement.textContent += ev.type + " "; - } ); -})(); diff --git a/hammerjs/hammerjs-1.1.3-tests.ts b/hammerjs/v1/hammerjs-tests.ts similarity index 100% rename from hammerjs/hammerjs-1.1.3-tests.ts rename to hammerjs/v1/hammerjs-tests.ts diff --git a/hammerjs/hammerjs-1.1.3.d.ts b/hammerjs/v1/index.d.ts similarity index 100% rename from hammerjs/hammerjs-1.1.3.d.ts rename to hammerjs/v1/index.d.ts diff --git a/hammerjs/v1/tsconfig.json b/hammerjs/v1/tsconfig.json new file mode 100644 index 0000000000..deecbdb055 --- /dev/null +++ b/hammerjs/v1/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "target": "es6", + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "baseUrl": "../../", + "typeRoots": [ + "../../" + ], + "types": [], + "paths": { + "hammerjs": ["hammerjs/v0"] + }, + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "hammerjs-tests.ts" + ] +} \ No newline at end of file diff --git a/handlebars/handlebars-1.0.0.d.ts b/handlebars/v1/index.d.ts similarity index 100% rename from handlebars/handlebars-1.0.0.d.ts rename to handlebars/v1/index.d.ts diff --git a/handlebars/v1/tsconfig.json b/handlebars/v1/tsconfig.json new file mode 100644 index 0000000000..0813f4e359 --- /dev/null +++ b/handlebars/v1/tsconfig.json @@ -0,0 +1,22 @@ +{ + "compilerOptions": { + "module": "commonjs", + "target": "es6", + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "baseUrl": "../../", + "typeRoots": [ + "../../" + ], + "types": [], + "paths": { + "handlebars": ["handlebars/v1"] + }, + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts" + ] +} \ No newline at end of file diff --git a/hapi/hapi-tests-8.2.0.ts b/hapi/v8/hapi-tests.ts similarity index 100% rename from hapi/hapi-tests-8.2.0.ts rename to hapi/v8/hapi-tests.ts diff --git a/hapi/hapi-8.2.0.d.ts b/hapi/v8/index.d.ts similarity index 99% rename from hapi/hapi-8.2.0.d.ts rename to hapi/v8/index.d.ts index 9a9355412d..0a46c60757 100644 --- a/hapi/hapi-8.2.0.d.ts +++ b/hapi/v8/index.d.ts @@ -1242,7 +1242,7 @@ export declare class Request extends Events.EventEmitter { /** a string or an array of strings (e.g. ['error', 'database', 'read']) used to identify the event. Tags are used instead of log levels and provide a much more expressive mechanism for describing and filtering events.*/ tags: string | string[], /** an optional message string or object with the application data being logged.*/ - data?: string, + data?: any, /** an optional timestamp expressed in milliseconds. Defaults to Date.now() (now).*/ timestamp?: number): void; /** request.getLog([tags], [internal]) diff --git a/hapi/v8/tsconfig.json b/hapi/v8/tsconfig.json new file mode 100644 index 0000000000..bc6ce3ca68 --- /dev/null +++ b/hapi/v8/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "target": "es6", + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": false, + "baseUrl": "../../", + "typeRoots": [ + "../../" + ], + "types": [], + "paths": { + "hapi": ["hapi/v8"] + }, + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "hapi-tests.ts" + ] +} \ No newline at end of file diff --git a/hashmap/hashmap-commonjs-tests.ts b/hashmap/hashmap-commonjs-tests.ts deleted file mode 100644 index 966d62593d..0000000000 --- a/hashmap/hashmap-commonjs-tests.ts +++ /dev/null @@ -1,41 +0,0 @@ -/// - -import HashMap = require("hashmap"); - -var emptyMap:HashMap = new HashMap(); -var filledMap:HashMap = new HashMap("bar", 123, "bar2", 234); -var copiedMap:HashMap = new HashMap(filledMap); - -emptyMap.set("foo", 123); -emptyMap.set("foo", 123).set("foo2", 234); -emptyMap.multi("foo3", 345, "foo4", 456).multi("foo5", 567, "foo6", "678"); -emptyMap.copy(filledMap).copy(copiedMap); - -var value:number = emptyMap.get("foo"); - -var hasFoo:boolean = emptyMap.has("foo"); - -var key:string = emptyMap.search(567); - -emptyMap.remove("foo").remove("foo2"); - -var keys:string[] = emptyMap.keys(); - -var values:number[] = emptyMap.values(); - -var count:number = emptyMap.count(); - -var clonedMap:HashMap = emptyMap.clone(); - -emptyMap - .forEach(function (value:number, key:string):void { - console.log(key); - console.log(value); - }) - .forEach(function (value:number, key:string):void { - console.log("Chained"); - console.log(key); - console.log(value); - }); - -emptyMap.clear().set("foo", 123); diff --git a/hashmap/hashmap-1.1-tests.ts b/hashmap/v1/hashmap-tests.ts similarity index 90% rename from hashmap/hashmap-1.1-tests.ts rename to hashmap/v1/hashmap-tests.ts index a3e7fcced3..e4dc5df0c6 100644 --- a/hashmap/hashmap-1.1-tests.ts +++ b/hashmap/v1/hashmap-tests.ts @@ -1,5 +1,3 @@ -/// - var map : HashMap = new HashMap(); map.set("foo", 123); diff --git a/hashmap/hashmap-1.1.d.ts b/hashmap/v1/index.d.ts similarity index 100% rename from hashmap/hashmap-1.1.d.ts rename to hashmap/v1/index.d.ts diff --git a/hashmap/v1/tsconfig.json b/hashmap/v1/tsconfig.json new file mode 100644 index 0000000000..daf32660fb --- /dev/null +++ b/hashmap/v1/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "target": "es6", + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "baseUrl": "../../", + "typeRoots": [ + "../../" + ], + "types": [], + "paths": { + "hashmap": ["hashmap/v1"] + }, + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "hashmap-tests.ts" + ] +} \ No newline at end of file diff --git a/helmet/helmet-tests.ts b/helmet/helmet-tests.ts index 2a2c6e3126..1968c8f848 100644 --- a/helmet/helmet-tests.ts +++ b/helmet/helmet-tests.ts @@ -1,6 +1,6 @@ -import express = require("../express") +import express = require("express") import helmet = require("helmet"); var app = express(); diff --git a/highlight.js/highlightjs-7.5.0.d.ts b/highlight.js/v7/index.d.ts similarity index 100% rename from highlight.js/highlightjs-7.5.0.d.ts rename to highlight.js/v7/index.d.ts diff --git a/highlight.js/v7/tsconfig.json b/highlight.js/v7/tsconfig.json new file mode 100644 index 0000000000..8954865798 --- /dev/null +++ b/highlight.js/v7/tsconfig.json @@ -0,0 +1,22 @@ +{ + "compilerOptions": { + "module": "commonjs", + "target": "es6", + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "baseUrl": "../../", + "typeRoots": [ + "../../" + ], + "types": [], + "paths": { + "highlight.js": ["highlight.js/v7"] + }, + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts" + ] +} \ No newline at end of file diff --git a/html-to-text/h2t-test.html b/html-to-text/h2t-test.html deleted file mode 100644 index 1a3cafdf6a..0000000000 --- a/html-to-text/h2t-test.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - - -

- bold -

-

- italic -

- - - - diff --git a/i18n/i18n-node-tests.ts b/i18n/i18n-node-tests.ts index d649938858..dc87c60a28 100644 --- a/i18n/i18n-node-tests.ts +++ b/i18n/i18n-node-tests.ts @@ -1,6 +1,6 @@ -/** - * Test suite created by Maxime LUCE - * +/** + * Test suite created by Maxime LUCE + * * Created by using code samples from https://github.com/mashpie/i18n-node. */ @@ -8,7 +8,7 @@ -import express = require("../express"); +import express = require("express"); import i18n = require("i18n"); var app = express(); diff --git a/i18next/i18next-2.0.17.d.ts b/i18next/i18next-2.0.17.d.ts deleted file mode 100644 index a5a82f953b..0000000000 --- a/i18next/i18next-2.0.17.d.ts +++ /dev/null @@ -1,157 +0,0 @@ -// Type definitions for i18next v2.0.17 -// Project: http://i18next.com -// Definitions by: Maarten Docter -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -// Sources: https://github.com/jamuhl/i18next/ - -/// - -declare namespace I18next { - export interface I18nextStatic {} - export interface I18nextOptions {} -} - -interface IResourceStore { - [language: string]: IResourceStoreLanguage; -} -interface IResourceStoreLanguage { - [namespace: string]: IResourceStoreKey; -} -interface IResourceStoreKey { - [key: string]: any; -} - -interface I18nTranslateOptions extends I18nextOptions { - defaultValue?: any; // normally a string - // NOTE https://github.com/DefinitelyTyped/DefinitelyTyped/pull/5590 - toAdd?: any; - child?: any; - sprintf?: any; - count?: any; - context?: any; -} - -interface I18nextOptions extends I18next.I18nextOptions { - lng?: string; // Default value: undefined - load?: string; // Default value: 'all' - preload?: string[]; // Default value: [] - lowerCaseLng?: boolean; // Default value: false - returnObjectTrees?: boolean; // Default value: false - fallbackLng?: string|boolean; // Default value: 'dev' - detectLngQS?: string; // Default value: 'setLng' - ns?: any; // Default value: 'translation' (string), can also be an object - nsseparator?: string; // Default value: '::' - keyseparator?: string; // Default value: '.' - selectorAttr?: string; // Default value: 'data-i18n' - debug?: boolean; // Default value: false - - resGetPath?: string; // Default value: 'locales/__lng__/__ns__.json' - resPostPath?: string; // Default value: 'locales/add/__lng__/__ns__' - - getAsync?: boolean; // Default value: true - postAsync?: boolean; // Default value: true - - resStore?: IResourceStore; // Default value: undefined - useLocalStorage?: boolean; // Default value: false - localStorageExpirationTime?: number; // Default value: 7 * 24 * 60 * 60 * 1000 (in ms default one week) - - dynamicLoad?: boolean; // Default value: false - sendMissing?: boolean; // Default value: false - sendMissingTo?: string; // Default value: 'fallback'. Other options are: current | all - sendType?: string; // Default value: 'POST' - - interpolationPrefix?: string; // Default value: '__' - interpolationSuffix?: string; // Default value: '__' - reusePrefix?: string; // Default value: '$t(' - reuseSuffix?: string; // Default value: ')' - pluralSuffix?: string; // Default value: '_plural' - pluralNotFound?: string; // Default value: ['plural_not_found' Math.random()].join( '' ) - contextNotFound?: string; // Default value: ['context_not_found' Math.random()].join( '' ) - - setJqueryExt?: boolean; // Default value: true - defaultValueFromContent?: boolean; // Default value: true - useDataAttrOptions?: boolean; // Default value: false - cookieExpirationTime?: number; // Default value: undefined - useCookie?: boolean; // Default value: true - cookieName?: string; // Default value: 'i18next' - - postProcess?: string; // Default value: undefined - - // NOTE https://github.com/DefinitelyTyped/DefinitelyTyped/pull/5590 - replace?: any; -} - -interface I18nextStatic extends I18next.I18nextStatic { - - addPostProcessor(name: string, fn: (value: any, key: string, options: any) => string): void; - addResources(language: string, namespace: string, resources: IResourceStoreKey): void; - detectLanguage(): string; - functions: { - extend(target: any, ...objs: any[]): Object; - extend(deep: boolean, target: any, ...objs: any[]): Object; - each(collection: any, callback: (indexInArray: any, valueOfElement: any) => any): any; - ajax(settings: JQueryAjaxSettings): JQueryXHR; - ajax(url: string, settings?: JQueryAjaxSettings): JQueryXHR; - cookie: { - create: (name: string, value: string, minutes: number) => void; - read: (name: string) => string; - remove: (name: string) => void; - }; - detectLanguage(): string; - log(message: string): void; - toLanguages(language: string): string[]; - regexEscape(str: string): string; - }; - init(callback?: (err: any, t: (key: string, options?: any) => string) => void ): JQueryDeferred; - init(options?: I18nextOptions, callback?: (err: any, t: (key: string, options?: any) => string) => void ): JQueryDeferred; - lng(): string; - loadNamespace(namespace: string, callback?: () => void ): void; - loadNamespaces(namespaces: string[], callback?: () => void ): void; - pluralExtensions: { - addRule(language: string, obj: { - name: string; - numbers: number[]; - plurals: (n: number) => number; - }): void; - get (language: string, count: number): number; - rules: any; - setCurrentLng: (language: string) => void; - }; - preload(language: string, callback?: (err: any, t: (key: string, options?: any) => string) => void ): void; - preload(languages: string[], callback?: (err: any, t: (key: string, options?: any) => string) => void ): void; - setDefaultNamespace(namespace: string): void; - setLng(language: string, callback?: (err: any, t: (key: string, options?: any) => string) => void ): void; - sync: { - load: (languages: string[], options: I18nextOptions, callback: (err: Error, store: IResourceStore) => void ) => void; - postMissing: (language: string, namespace: string, key: string, defaultValue: any, languages: string[]) => void; - }; - t(key: string, options?: I18nTranslateOptions): string; - translate(key: string, options?: I18nTranslateOptions): string; - exists(key: string, options?: any): boolean; - use(module: any): I18nextStatic; -} - -// jQuery extensions -interface JQueryStatic { - i18n: I18nextStatic; - t: (key: string, options?: any) => string; -} - -interface JQuery { - /* Note: options are same options as used by the translate function. Alternatively by - setting init option or translation option 'useDataAttrOptions = true' the Options - for translation will be read and cached in the elements data-i18n-options attribute. - */ - i18n: (options?: I18nextOptions) => void; -} - -declare var i18n: I18nextStatic; - -declare module 'i18next' { - export = i18n; -} - -declare module 'i18next-client' { - export = i18n; -} diff --git a/i18next/i18next-tests-2.0.17.ts b/i18next/i18next-tests-2.0.17.ts deleted file mode 100644 index 1333bda1b5..0000000000 --- a/i18next/i18next-tests-2.0.17.ts +++ /dev/null @@ -1,1379 +0,0 @@ -/// -/// -/// -/// -/// - - -declare function done(): void; - -describe('i18next', function () { - - var i18n = $.i18n - , opts: I18nextOptions; - - beforeEach(function () { - opts = { - lng: 'en-US', - load: 'all', - fallbackLng: 'dev', - preload: [], - lowerCaseLng: false, - ns: 'translation', - resGetPath: 'locales/__lng__/__ns__.json', - dynamicLoad: false, - useLocalStorage: false, - sendMissing: false, - getAsync: true, - returnObjectTrees: false, - debug: true, - selectorAttr: 'data-i18n', - postProcess: '', - interpolationPrefix: '__', - interpolationSuffix: '__' - }; - }); - - - describe('Initialisation', function () { - - describe('with passed in resource set', function () { - - var resStore = { - dev: { translation: { 'simple_dev': 'ok_from_dev' } }, - en: { translation: { 'simple_en': 'ok_from_en' } }, - 'en-US': { translation: { 'simple_en-US': 'ok_from_en-US' } } - }; - - beforeEach(function (done) { - i18n.init($.extend(opts, { resStore: resStore }), - function (t) { done(); }); - }); - - it('it should provide passed in resources for translation', function () { - expect(i18n.t('simple_en-US')).to.be('ok_from_en-US'); - expect(i18n.t('simple_en')).to.be('ok_from_en'); - expect(i18n.t('simple_dev')).to.be('ok_from_dev'); - }); - - }); - - describe('loading from server', function () { - - describe('with static route', function () { - - beforeEach(function (done) { - i18n.init(opts, function (t) { done(); }); - }); - - it('it should provide loaded resources for translation', function () { - expect(i18n.t('simple_en-US')).to.be('ok_from_en-US'); - expect(i18n.t('simple_en')).to.be('ok_from_en'); - expect(i18n.t('simple_dev')).to.be('ok_from_dev'); - }); - - }); - - describe('with dynamic route', function () { - - beforeEach(function (done) { - - var res = { - dev: { translation: { 'simple_dev': 'ok_from_dev' } }, - en: { translation: { 'simple_en': 'ok_from_en' } }, - 'en-US': { translation: { 'simple_en-US': 'ok_from_en-US' } } - }; - - var server = sinon.fakeServer.create(); - server.autoRespond = true; - - server.respondWith([200, { "Content-Type": "application/json" }, JSON.stringify(res)]); - - i18n.init($.extend(opts, { - resGetPath: 'locales/resources.json?lng=__lng__&ns=__ns__', - dynamicLoad: true - }), - function (t) { server.restore(); done(); }); - }); - - it('it should provide loaded resources for translation', function () { - expect(i18n.t('simple_en-US')).to.be('ok_from_en-US'); - expect(i18n.t('simple_en')).to.be('ok_from_en'); - expect(i18n.t('simple_dev')).to.be('ok_from_dev'); - }); - - }); - - }); - - describe('advanced initialisation options', function () { - - describe('setting load', function () { - - describe('to current', function () { - - var spy: any; - - beforeEach(function (done) { - spy = sinon.spy(i18n.sync, '_fetchOne'); - i18n.init($.extend(opts, { - load: 'current' - }), - function (t) { done(); }); - }); - - afterEach(function () { - spy.restore(); - }); - - it('it should load only current and fallback language', function () { - expect(spy.callCount).to.be(2); // en-US, en - }); - - it('it should provide loaded resources for translation', function () { - expect(i18n.t('simple_en-US')).to.be('ok_from_en-US'); - expect(i18n.t('simple_en')).not.to.be('ok_from_en'); - expect(i18n.t('simple_dev')).to.be('ok_from_dev'); - }); - - }); - - describe('to unspecific', function () { - - var spy: any; - - beforeEach(function (done) { - spy = sinon.spy(i18n.sync, '_fetchOne'); - i18n.init($.extend(opts, { - load: 'unspecific' - }), - function (t) { done(); }); - }); - - afterEach(function () { - spy.restore(); - }); - - it('it should load only unspecific and fallback language', function () { - expect(spy.callCount).to.be(2); // en-US, en - }); - - it('it should provide loaded resources for translation', function () { - expect(i18n.t('simple_en-US')).not.to.be('ok_from_en-US'); - expect(i18n.t('simple_en')).to.be('ok_from_en'); - expect(i18n.t('simple_dev')).to.be('ok_from_dev'); - }); - - it('it should return unspecific language', function () { - expect(i18n.lng()).to.be('en'); - }); - - }); - - }); - - describe('with fallback language set to false', function () { - - var spy: any; - - beforeEach(function (done) { - spy = sinon.spy(i18n.sync, '_fetchOne'); - i18n.init($.extend(opts, { - fallbackLng: false - }), - function (t) { done(); }); - }); - - afterEach(function () { - spy.restore(); - }); - - it('it should load only specific and unspecific languages', function () { - expect(spy.callCount).to.be(2); // en-US, en - }); - - it('it should provide loaded resources for translation', function () { - expect(i18n.t('simple_en-US')).to.be('ok_from_en-US'); - expect(i18n.t('simple_en')).to.be('ok_from_en'); - expect(i18n.t('simple_dev')).not.to.be('ok_from_dev'); - }); - - }); - - describe('preloading multiple languages', function () { - - var spy: any; - - beforeEach(function (done) { - spy = sinon.spy(i18n.sync, '_fetchOne'); - i18n.init($.extend(opts, { - preload: ['fr', 'de-DE'] - }), - function (t) { done(); }); - }); - - afterEach(function () { - spy.restore(); - }); - - it('it should load additional languages', function () { - expect(spy.callCount).to.be(6); // en-US, en, de-DE, de, fr, dev - }); - - describe('changing the language', function () { - - beforeEach(function (done) { - spy.reset(); - i18n.setLng('de-DE', - function (t) { done(); }); - }); - - it('it should reload the preloaded languages', function () { - expect(spy.callCount).to.be(4); // de-DE, de, fr, dev - }); - - }); - - }); - - describe('with synchronous flag', function () { - - beforeEach(function () { - i18n.init($.extend(opts, { getAsync: false })); - }); - - it('it should provide loaded resources for translation', function () { - expect(i18n.t('simple_en-US')).to.be('ok_from_en-US'); - expect(i18n.t('simple_en')).to.be('ok_from_en'); - expect(i18n.t('simple_dev')).to.be('ok_from_dev'); - }); - - }); - - describe('with namespace', function () { - - describe('with one namespace set', function () { - - beforeEach(function (done) { - i18n.init($.extend(opts, { ns: 'ns.special' }), - function (t) { done(); }); - }); - - it('it should provide loaded resources for translation', function () { - expect(i18n.t('simple_en-US')).to.be('ok_from_special_en-US'); - expect(i18n.t('simple_en')).to.be('ok_from_special_en'); - expect(i18n.t('simple_dev')).to.be('ok_from_special_dev'); - }); - - }); - - describe('with more than one namespace set', function () { - - beforeEach(function (done) { - i18n.init($.extend(opts, { ns: { namespaces: ['ns.common', 'ns.special'], defaultNs: 'ns.special' } }), - function (t) { done(); }); - }); - - it('it should provide loaded resources for translation', function () { - // default ns - expect(i18n.t('simple_en-US')).to.be('ok_from_special_en-US'); - expect(i18n.t('simple_en')).to.be('ok_from_special_en'); - expect(i18n.t('simple_dev')).to.be('ok_from_special_dev'); - - // ns prefix - expect(i18n.t('ns.common:simple_en-US')).to.be('ok_from_common_en-US'); - expect(i18n.t('ns.common:simple_en')).to.be('ok_from_common_en'); - expect(i18n.t('ns.common:simple_dev')).to.be('ok_from_common_dev'); - - // ns in options - expect(i18n.t('simple_en-US', { ns: 'ns.common' })).to.be('ok_from_common_en-US'); - expect(i18n.t('simple_en', { ns: 'ns.common' })).to.be('ok_from_common_en'); - expect(i18n.t('simple_dev', { ns: 'ns.common' })).to.be('ok_from_common_dev'); - }); - - }); - - describe('with reloading additional namespace', function () { - - describe('without using localStorage', function () { - beforeEach(function (done) { - i18n.init(opts, - function (t) { - i18n.setDefaultNamespace('ns.special'); - i18n.loadNamespaces(['ns.common', 'ns.special'], done); - }); - }); - - it('it should provide loaded resources for translation', function () { - // default ns - expect(i18n.t('simple_en-US')).to.be('ok_from_special_en-US'); - expect(i18n.t('simple_en')).to.be('ok_from_special_en'); - expect(i18n.t('simple_dev')).to.be('ok_from_special_dev'); - - // ns prefix - expect(i18n.t('ns.common:simple_en-US')).to.be('ok_from_common_en-US'); - expect(i18n.t('ns.common:simple_en')).to.be('ok_from_common_en'); - expect(i18n.t('ns.common:simple_dev')).to.be('ok_from_common_dev'); - - // ns in options - expect(i18n.t('simple_en-US', { ns: 'ns.common' })).to.be('ok_from_common_en-US'); - expect(i18n.t('simple_en', { ns: 'ns.common' })).to.be('ok_from_common_en'); - expect(i18n.t('simple_dev', { ns: 'ns.common' })).to.be('ok_from_common_dev'); - }); - - }); - - describe('with using localStorage', function () { - - var spy: any; - - before(function () { - window.localStorage.removeItem('res_en-US'); - window.localStorage.removeItem('res_en'); - window.localStorage.removeItem('res_dev'); - }); - - beforeEach(function (done) { - spy = sinon.spy(i18n.sync, '_fetchOne'); - i18n.init($.extend(opts, { - useLocalStorage: true - }), function (t) { - i18n.setDefaultNamespace('ns.special'); - i18n.loadNamespaces(['ns.common', 'ns.special'], done); - }); - }); - - afterEach(function () { - spy.restore(); - }); - - it('it should load language', function () { - expect(spy.callCount).to.be(9); // en-US, en, de-DE, de, fr, dev * 3 namespaces (translate, common, special) - }); - - describe('on later reload of namespaces', function () { - - beforeEach(function (done) { - spy.reset(); - i18n.init($.extend(opts, { - useLocalStorage: true, - ns: 'translation' - }), function (t) { - i18n.setDefaultNamespace('ns.special'); - i18n.loadNamespaces(['ns.common', 'ns.special'], done); - }); - }); - - it('it should not reload language', function () { - expect(spy.callCount).to.be(0); - }); - - }); - - }); - - }); - - }); - - describe('using function provided in callback\'s argument', function () { - - var cbT: any; - - beforeEach(function (done) { - i18n.init(opts, function (t) { cbT = t; done(); }); - }); - - it('it should provide loaded resources for translation', function () { - expect(cbT('simple_en-US')).to.be('ok_from_en-US'); - expect(cbT('simple_en')).to.be('ok_from_en'); - expect(cbT('simple_dev')).to.be('ok_from_dev'); - }); - - }); - - describe('using localStorage', function () { - - var spy: any; - - before(function () { - window.localStorage.removeItem('res_en-US'); - window.localStorage.removeItem('res_en'); - window.localStorage.removeItem('res_dev'); - }); - - beforeEach(function (done) { - spy = sinon.spy(i18n.sync, '_fetchOne'); - i18n.init($.extend(opts, { - useLocalStorage: true - }), function (t) { done(); }); - }); - - afterEach(function () { - spy.restore(); - }); - - it('it should load language', function () { - expect(spy.callCount).to.be(3); // en-US, en, de-DE, de, fr, dev - }); - - describe('on later init', function () { - - beforeEach(function (done) { - spy.reset(); - i18n.init(function (t) { done(); }); - }); - - it('it should not reload language', function () { - expect(spy.callCount).to.be(0); // de-DE, de, fr, dev - }); - - describe('on later init - after caching duration', function () { - - beforeEach(function (done) { - spy.reset(); - - // exipred - var local = window.localStorage.getItem('res_en-US'); - local = JSON.parse(local); - local.i18nStamp = 0; - window.localStorage.setItem('res_en-US', JSON.stringify(local)); - - i18n.init(function (t) { done(); }); - }); - - it('it should reload language', function () { - expect(spy.callCount).to.be(1); // de-DE, de, fr, dev - }); - - }); - - }); - - }); - - describe('with lowercase flag', function () { - - describe('default behaviour will uppercase specifc country part.', function () { - - beforeEach(function () { - i18n.init($.extend(opts, { - lng: 'en-us', - resStore: { - 'en-US': { translation: { 'simple_en-US': 'ok_from_en-US' } } - } - }, function (t: any) { done(); })); - }); - - it('it should translate the uppercased lng value', function () { - expect(i18n.t('simple_en-US')).to.be('ok_from_en-US'); - }); - - it('it should get uppercased set language', function () { - expect(i18n.lng()).to.be('en-US'); - }); - - }); - - describe('overridden behaviour will accept lowercased country part.', function () { - - beforeEach(function () { - i18n.init($.extend(opts, { - lng: 'en-us', - lowerCaseLng: true, - resStore: { - 'en-us': { translation: { 'simple_en-us': 'ok_from_en-us' } } - } - }, function (t: any) { done(); })); - }); - - it('it should translate the lowercase lng value', function () { - expect(i18n.t('simple_en-us')).to.be('ok_from_en-us'); - }); - - it('it should get lowercased set language', function () { - expect(i18n.lng()).to.be('en-us'); - }); - - }); - - }); - - }); - - }); - describe('basic functionality', function () { - - describe('setting language', function () { - - beforeEach(function (done) { - i18n.init($.extend(opts, { - resStore: { - 'en-US': { translation: { 'simpleTest': 'ok_from_en-US' } }, - 'de-DE': { translation: { 'simpleTest': 'ok_from_de-DE' } } - } - }), function (t) { done(); }); - }); - - it('it should provide resources for set language', function (done) { - expect(i18n.t('simpleTest')).to.be('ok_from_en-US'); - - i18n.setLng('de-DE', function (t) { - expect(t('simpleTest')).to.be('ok_from_de-DE'); - done(); - }); - - }); - - }); - - describe('preloading multiple languages', function () { - - var spy: any; - - beforeEach(function (done) { - spy = sinon.spy(i18n.sync, '_fetchOne'); - i18n.init(opts, function (t) { done(); }); - }); - - afterEach(function () { - spy.restore(); - }); - - it('it should preload resources for languages', function (done) { - spy.reset(); - i18n.preload('de-DE', function (t) { - expect(spy.callCount).to.be(5); // en-US, en, de-DE, de, dev - done(); - }); - - }); - - }); - - describe('postprocessing tranlation', function () { - - describe('having a postprocessor', function () { - - before(function () { - i18n.addPostProcessor('myProcessor', function (val, key, opts) { - return 'ok_from_postprocessor'; - }); - }); - - beforeEach(function (done) { - i18n.init($.extend(opts, { - resStore: { - 'en-US': { translation: { 'simpleTest': 'ok_from_en-US' } }, - 'de-DE': { translation: { 'simpleTest': 'ok_from_de-DE' } } - } - }), function (t) { done(); }); - }); - - it('it should postprocess the translation by passing in postProcess name to t function', function () { - expect(i18n.t('simpleTest', { postProcess: 'myProcessor' })).to.be('ok_from_postprocessor'); - }); - - describe('or setting it as default on init', function () { - - beforeEach(function (done) { - i18n.init($.extend(opts, { - resStore: { - 'en-US': { translation: { 'simpleTest': 'ok_from_en-US' } }, - 'de-DE': { translation: { 'simpleTest': 'ok_from_de-DE' } } - }, - postProcess: 'myProcessor' - }), function (t) { done(); }); - }); - - it('it should postprocess the translation by default', function () { - expect(i18n.t('simpleTest')).to.be('ok_from_postprocessor'); - }); - - }); - - }); - - }); - - describe('post missing resources', function () { - - describe('to fallback', function () { - var server: any, stub: any; - - beforeEach(function (done) { - server = sinon.fakeServer.create(); - stub = sinon.stub(i18n.functions, "ajax"); - - server.respondWith([200, { "Content-Type": "text/html", "Content-Length": 2 }, "OK"]); - - i18n.init($.extend(opts, { - sendMissing: true, - resStore: { - 'en-US': { translation: {} }, - 'en': { translation: {} }, - 'dev': { translation: {} } - } - }), function (t) { done(); }); - }); - - afterEach(function () { - server.restore(); - stub.restore(); - }); - - it('it should post missing resource to server', function () { - i18n.t('missing'); - server.respond(); - expect(stub.calledOnce).to.be(true); - }); - - }); - - describe('to all', function () { - var server: any, stub: any; - - beforeEach(function (done) { - server = sinon.fakeServer.create(); - stub = sinon.stub(i18n.functions, "ajax"); - - server.respondWith([200, { "Content-Type": "text/html", "Content-Length": 2 }, "OK"]); - - i18n.init($.extend(opts, { - sendMissing: true, - sendMissingTo: 'all', - resStore: { - 'en-US': { translation: {} }, - 'en': { translation: {} }, - 'dev': { translation: {} } - } - }), function (t) { done(); }); - }); - - afterEach(function () { - server.restore(); - stub.restore(); - }); - - it('it should post missing resource for all lng to server', function () { - i18n.t('missing'); - server.respond(); - expect(stub.calledThrice).to.be(true); - }); - - }); - - }); - - describe('adding resources after initialisation', function () { - - var frResource = { 'simple_fr': 'ok_from_fr' }; - var enResource = { 'simple_en': 'ok_from_en' }; - - beforeEach(function (done) { - i18n.init({ resStore: {} }, - function (t) { done(); }); - }); - - it('it should use resources for translation added after initialisation', function () { - i18n.addResources('fr', 'translation', frResource); - i18n.addResources('en', 'translation', enResource); - expect(i18n.t('simple_fr', { lng: 'fr' })).to.be('ok_from_fr'); - expect(i18n.t('simple_en', { lng: 'en' })).to.be('ok_from_en'); - }); - - }); - }); - describe('translation functionality', function () { - - describe('key with empty string value as valid option', function () { - var resStore = { - dev: { translation: { empty: '' } }, - en: { translation: {} }, - 'en-US': { translation: {} } - }; - - beforeEach(function (done) { - i18n.init($.extend(opts, { resStore: resStore }), - function (t) { done(); }); - }); - - it('it should translate correctly', function () { - expect(i18n.t('empty')).to.be(''); - }); - }); - - describe('exists functionality', function () { - var resStore = { - dev: { translation: { empty: '' } }, - en: { translation: {} }, - 'en-US': { translation: {} } - }; - - beforeEach(function (done) { - i18n.init($.extend(opts, { resStore: resStore }), - function (t) { done(); }); - }); - - it('it should be able to test if a key exists', function () { - expect(i18n.exists('empty')).to.be(false); - }); - }); - - describe('resource string as array', function () { - var resStore = { - dev: { translation: { testarray: ["title", "text"] } }, - en: { translation: {} }, - 'en-US': { translation: {} } - }; - - beforeEach(function (done) { - i18n.init($.extend(opts, { resStore: resStore }), - function (t) { done(); }); - }); - - it('it should translate nested value', function () { - expect(i18n.t('testarray')).to.be('title\ntext'); - }); - }); - - describe('accessing nested values', function () { - - beforeEach(function (done) { - i18n.init(opts, function (t) { done(); }); - }); - - it('it should return nested string', function () { - expect(i18n.t('test.simple_en-US')).to.be('ok_from_en-US'); - }); - - it('it should not fail silently on accessing a objectTree', function () { - expect(i18n.t('test')).to.be('key \'translation:test (en-US)\' returned a object instead of string.'); - }); - - describe('optional return an objectTree for UI components,...', function () { - - describe('with init flag', function () { - - var resStore = { - dev: { translation: {} }, - en: { translation: {} }, - 'en-US': { - translation: { - test: { res: 'added __replace__' } - } - } - }; - - beforeEach(function (done) { - i18n.init($.extend(opts, { - returnObjectTrees: true, - resStore: resStore - } - ), function (t) { done(); }); - }); - - it('it should return objectTree applying options', function () { - expect(i18n.t('test', { replace: 'two' })).to.eql({ 'res': 'added two' }); - }); - - }); - - describe('with flag in options', function () { - - beforeEach(function (done) { - i18n.init($.extend(opts, { returnObjectTrees: false }), - function (t) { done(); }); - }); - - it('it should return objectTree', function () { - expect(i18n.t('test', { returnObjectTrees: true })).to.eql({ 'simple_en-US': 'ok_from_en-US' }); - }); - - }); - - }); - - }); - - describe('resource nesting', function () { - var resStore = { - dev: { translation: { nesting1: '1 $t(nesting2)' } }, - en: { translation: { nesting2: '2 $t(nesting3)' } }, - 'en-US': { translation: { nesting3: '3' } } - }; - - beforeEach(function (done) { - i18n.init($.extend(opts, { resStore: resStore }), - function (t) { done(); }); - }); - - it('it should translate nested value', function () { - expect(i18n.t('nesting1')).to.be('1 2 3'); - }); - - it('it should apply nested value on defaultValue', function () { - expect(i18n.t('nesting_default', { defaultValue: '0 $t(nesting1)' })).to.be('0 1 2 3'); - }); - }); - - describe('interpolation - replacing values inside a string', function () { - - describe('default i18next way', function () { - - var resStore = { - dev: { translation: {} }, - en: { translation: {} }, - 'en-US': { - translation: { - interpolationTest1: 'added __toAdd__', - interpolationTest2: 'added __toAdd__ __toAdd__ twice', - interpolationTest3: 'added __child.one__ __child.two__', - interpolationTest4: 'added __child.grandChild.three__' - } - } - }; - - beforeEach(function (done) { - i18n.init($.extend(opts, { resStore: resStore }), - function (t) { done(); }); - }); - - it('it should replace passed in key/values', function () { - expect(i18n.t('interpolationTest1', { toAdd: 'something' })).to.be('added something'); - expect(i18n.t('interpolationTest2', { toAdd: 'something' })).to.be('added something something twice'); - expect(i18n.t('interpolationTest3', { child: { one: '1', two: '2' } })).to.be('added 1 2'); - expect(i18n.t('interpolationTest4', { child: { grandChild: { three: '3' } } })).to.be('added 3'); - }); - - it('it should replace passed in key/values on defaultValue', function () { - expect(i18n.t('interpolationTest5', { defaultValue: 'added __toAdd__', toAdd: 'something' })).to.be('added something'); - }); - - }); - - describe('default i18next way - different prefix/suffix', function () { - - var resStore = { - dev: { translation: {} }, - en: { translation: {} }, - 'en-US': { - translation: { - interpolationTest1: 'added *toAdd*', - interpolationTest2: 'added *toAdd* *toAdd* twice', - interpolationTest3: 'added *child.one* *child.two*', - interpolationTest4: 'added *child.grandChild.three*' - } - } - }; - - beforeEach(function (done) { - i18n.init($.extend(opts, { - resStore: resStore, - interpolationPrefix: '*', - interpolationSuffix: '*' - }), function (t) { done(); }); - }); - - it('it should replace passed in key/values', function () { - expect(i18n.t('interpolationTest1', { toAdd: 'something' })).to.be('added something'); - expect(i18n.t('interpolationTest2', { toAdd: 'something' })).to.be('added something something twice'); - expect(i18n.t('interpolationTest3', { child: { one: '1', two: '2' } })).to.be('added 1 2'); - expect(i18n.t('interpolationTest4', { child: { grandChild: { three: '3' } } })).to.be('added 3'); - }); - - it('it should replace passed in key/values on defaultValue', function () { - expect(i18n.t('interpolationTest5', { defaultValue: 'added *toAdd*', toAdd: 'something' })).to.be('added something'); - }); - - }); - - describe('using sprintf', function () { - - var resStore = { - dev: { translation: {} }, - en: { translation: {} }, - 'en-US': { - translation: { - interpolationTest1: 'The first 4 letters of the english alphabet are: %s, %s, %s and %s', - interpolationTest2: 'Hello %(users[0].name)s, %(users[1].name)s and %(users[2].name)s' - } - } - }; - - beforeEach(function (done) { - i18n.init($.extend(opts, { resStore: resStore }), - function (t) { done(); }); - }); - - it('it should replace passed in key/values', function () { - expect(i18n.t('interpolationTest1', { postProcess: 'sprintf', sprintf: ['a', 'b', 'c', 'd'] })).to.be('The first 4 letters of the english alphabet are: a, b, c and d'); - expect(i18n.t('interpolationTest2', { postProcess: 'sprintf', sprintf: { users: [{ name: 'Dolly' }, { name: 'Molly' }, { name: 'Polly' }] } })).to.be('Hello Dolly, Molly and Polly'); - }); - - }); - - }); - - describe('plural usage', function () { - - describe('basic usage - singular and plural form', function () { - var resStore = { - dev: { - 'ns.2': { - pluralTest: 'singular from ns.2', - pluralTest_plural: 'plural from ns.2', - pluralTestWithCount: '__count__ item from ns.2', - pluralTestWithCount_plural: '__count__ items from ns.2' - } - }, - en: {}, - 'en-US': { - 'ns.1': { - pluralTest: 'singular', - pluralTest_plural: 'plural', - pluralTestWithCount: '__count__ item', - pluralTestWithCount_plural: '__count__ items' - } - } - }; - - beforeEach(function (done) { - i18n.init($.extend(opts, { - resStore: resStore, - ns: { namespaces: ['ns.1', 'ns.2'], defaultNs: 'ns.1' } - }), - function (t) { done(); }); - }); - - it('it should provide correct plural or singular form', function () { - expect(i18n.t('pluralTest', { count: 0 })).to.be('plural'); - expect(i18n.t('pluralTest', { count: 1 })).to.be('singular'); - expect(i18n.t('pluralTest', { count: 2 })).to.be('plural'); - expect(i18n.t('pluralTest', { count: 7 })).to.be('plural'); - - expect(i18n.t('pluralTestWithCount', { count: 0 })).to.be('0 items'); - expect(i18n.t('pluralTestWithCount', { count: 1 })).to.be('1 item'); - expect(i18n.t('pluralTestWithCount', { count: 7 })).to.be('7 items'); - }); - - it('it should provide correct plural or singular form for second namespace', function () { - expect(i18n.t('ns.2:pluralTest', { count: 0 })).to.be('plural from ns.2'); - expect(i18n.t('ns.2:pluralTest', { count: 1 })).to.be('singular from ns.2'); - expect(i18n.t('ns.2:pluralTest', { count: 2 })).to.be('plural from ns.2'); - expect(i18n.t('ns.2:pluralTest', { count: 7 })).to.be('plural from ns.2'); - - expect(i18n.t('ns.2:pluralTestWithCount', { count: 1 })).to.be('1 item from ns.2'); - expect(i18n.t('ns.2:pluralTestWithCount', { count: 7 })).to.be('7 items from ns.2'); - }); - }); - - describe('basic usage 2 - singular and plural form in french', function () { - var resStore = { - dev: { - 'ns.2': { - pluralTest: 'singular from ns.2', - pluralTest_plural: 'plural from ns.2', - pluralTestWithCount: '__count__ item from ns.2', - pluralTestWithCount_plural: '__count__ items from ns.2' - } - }, - en: {}, - 'fr': { - 'ns.1': { - pluralTest: 'singular', - pluralTest_plural: 'plural', - pluralTestWithCount: '__count__ item', - pluralTestWithCount_plural: '__count__ items' - } - } - }; - - beforeEach(function (done) { - i18n.init($.extend(opts, { - lng: 'fr', - resStore: resStore, - ns: { namespaces: ['ns.1', 'ns.2'], defaultNs: 'ns.1' } - }), - function (t) { done(); }); - }); - - it('it should provide correct plural or singular form', function () { - expect(i18n.t('pluralTest', { count: 0 })).to.be('singular'); - expect(i18n.t('pluralTest', { count: 1 })).to.be('singular'); - expect(i18n.t('pluralTest', { count: 2 })).to.be('plural'); - expect(i18n.t('pluralTest', { count: 7 })).to.be('plural'); - - expect(i18n.t('pluralTestWithCount', { count: 0 })).to.be('0 item'); - expect(i18n.t('pluralTestWithCount', { count: 1 })).to.be('1 item'); - expect(i18n.t('pluralTestWithCount', { count: 7 })).to.be('7 items'); - }); - }); - - describe('extended usage - multiple plural forms - ar', function () { - var resStore = { - dev: { translation: {} }, - ar: { - translation: { - key: 'singular', - key_plural_0: 'zero', - key_plural_2: 'two', - key_plural_3: 'few', - key_plural_11: 'many', - key_plural_100: 'plural' - } - }, - 'ar-??': { translation: {} } - }; - - beforeEach(function (done) { - i18n.init($.extend(opts, { lng: 'ar', resStore: resStore }), - function (t) { done(); }); - }); - - it('it should provide correct plural forms', function () { - expect(i18n.t('key', { count: 0 })).to.be('zero'); - expect(i18n.t('key', { count: 1 })).to.be('singular'); - expect(i18n.t('key', { count: 2 })).to.be('two'); - expect(i18n.t('key', { count: 3 })).to.be('few'); - expect(i18n.t('key', { count: 4 })).to.be('few'); - expect(i18n.t('key', { count: 104 })).to.be('few'); - expect(i18n.t('key', { count: 11 })).to.be('many'); - expect(i18n.t('key', { count: 99 })).to.be('many'); - expect(i18n.t('key', { count: 199 })).to.be('many'); - expect(i18n.t('key', { count: 100 })).to.be('plural'); - }); - }); - - describe('extended usage - multiple plural forms - ru', function () { - var resStore = { - dev: { translation: {} }, - ru: { - translation: { - key: '1,21,31', - key_plural_2: '2,3,4', - key_plural_5: '0,5,6' - } - }, - 'ru-??': { translation: {} } - }; - - beforeEach(function (done) { - i18n.init($.extend(opts, { lng: 'ru', resStore: resStore }), - function (t) { done(); }); - }); - - it('it should provide correct plural forms', function () { - expect(i18n.t('key', { count: 0 })).to.be('0,5,6'); - expect(i18n.t('key', { count: 1 })).to.be('1,21,31'); - expect(i18n.t('key', { count: 2 })).to.be('2,3,4'); - expect(i18n.t('key', { count: 3 })).to.be('2,3,4'); - expect(i18n.t('key', { count: 4 })).to.be('2,3,4'); - expect(i18n.t('key', { count: 104 })).to.be('2,3,4'); - expect(i18n.t('key', { count: 11 })).to.be('0,5,6'); - expect(i18n.t('key', { count: 24 })).to.be('2,3,4'); - expect(i18n.t('key', { count: 25 })).to.be('0,5,6'); - expect(i18n.t('key', { count: 99 })).to.be('0,5,6'); - expect(i18n.t('key', { count: 199 })).to.be('0,5,6'); - expect(i18n.t('key', { count: 100 })).to.be('0,5,6'); - }); - }); - - }); - - describe('context usage', function () { - - describe('basic usage', function () { - var resStore = { - dev: { - 'ns.2': { - friend_context: 'A friend from ns2', - friend_context_male: 'A boyfriend from ns2', - friend_context_female: 'A girlfriend from ns2' - } - }, - en: { - 'ns.1': { - friend_context: 'A friend', - friend_context_male: 'A boyfriend', - friend_context_female: 'A girlfriend' - } - }, - 'en-US': { translation: {} } - }; - - beforeEach(function (done) { - i18n.init($.extend(opts, { - resStore: resStore, - ns: { namespaces: ['ns.1', 'ns.2'], defaultNs: 'ns.1' } - }), - function (t) { done(); }); - }); - - it('it should provide correct context form', function () { - expect(i18n.t('friend_context')).to.be('A friend'); - expect(i18n.t('friend_context', { context: '' })).to.be('A friend'); - expect(i18n.t('friend_context', { context: 'male' })).to.be('A boyfriend'); - expect(i18n.t('friend_context', { context: 'female' })).to.be('A girlfriend'); - }); - - it('it should provide correct context form for second namespace', function () { - expect(i18n.t('ns.2:friend_context')).to.be('A friend from ns2'); - expect(i18n.t('ns.2:friend_context', { context: '' })).to.be('A friend from ns2'); - expect(i18n.t('ns.2:friend_context', { context: 'male' })).to.be('A boyfriend from ns2'); - expect(i18n.t('ns.2:friend_context', { context: 'female' })).to.be('A girlfriend from ns2'); - }); - }); - - describe('extended usage - in combination with plurals', function () { - var resStore = { - dev: { translation: {} }, - en: { - translation: { - friend_context: '__count__ friend', - friend_context_male: '__count__ boyfriend', - friend_context_female: '__count__ girlfriend', - friend_context_plural: '__count__ friends', - friend_context_male_plural: '__count__ boyfriends', - friend_context_female_plural: '__count__ girlfriends' - } - }, - 'en-US': { translation: {} } - }; - - beforeEach(function (done) { - i18n.init($.extend(opts, { resStore: resStore }), - function (t) { done(); }); - }); - - it('it should provide correct context with plural forms', function () { - expect(i18n.t('friend_context', { count: 1 })).to.be('1 friend'); - expect(i18n.t('friend_context', { context: '', count: 1 })).to.be('1 friend'); - expect(i18n.t('friend_context', { context: 'male', count: 1 })).to.be('1 boyfriend'); - expect(i18n.t('friend_context', { context: 'female', count: 1 })).to.be('1 girlfriend'); - - expect(i18n.t('friend_context', { count: 10 })).to.be('10 friends'); - expect(i18n.t('friend_context', { context: '', count: 10 })).to.be('10 friends'); - expect(i18n.t('friend_context', { context: 'male', count: 10 })).to.be('10 boyfriends'); - expect(i18n.t('friend_context', { context: 'female', count: 10 })).to.be('10 girlfriends'); - }); - - }); - - }); - - describe('with passed in languages different from set one', function () { - - beforeEach(function (done) { - i18n.init($.extend(opts, { - preload: ['de-DE'] - }), - function (t) { done(); }); - }); - - it('it should provide translation for passed in language', function () { - expect(i18n.t('simple_de', { lng: 'de-DE' })).to.be('ok_from_de'); - }); - - describe('with language not preloaded', function () { - - it('it should provide translation for passed in language after loading file sync', function () { - expect(i18n.t('simple_fr', { lng: 'fr' })).to.be('ok_from_fr'); - }); - - }); - - }); - - }); - - describe('jQuery integration / specials', function () { - - describe('initialise - use deferrer instead of callback', function () { - - describe('with passed in resource set', function () { - - var resStore = { - dev: { translation: { 'simple_dev': 'ok_from_dev' } }, - en: { translation: { 'simple_en': 'ok_from_en' } }, - 'en-US': { translation: { 'simple_en-US': 'ok_from_en-US' } } - }; - - beforeEach(function (done) { - i18n.init($.extend(opts, { resStore: resStore })).done(function (t: any) { done(); }); - }); - - it('it should provide passed in resources for translation', function () { - expect($.t('simple_en-US')).to.be('ok_from_en-US'); - expect($.t('simple_en')).to.be('ok_from_en'); - expect($.t('simple_dev')).to.be('ok_from_dev'); - }); - - }); - - describe('loading from server', function () { - - beforeEach(function (done) { - i18n.init(opts).done(function () { done(); }); - }); - - it('it should provide loaded resources for translation', function () { - expect($.t('simple_en-US')).to.be('ok_from_en-US'); - expect($.t('simple_en')).to.be('ok_from_en'); - expect($.t('simple_dev')).to.be('ok_from_dev'); - }); - - }); - - }); - - describe('use translation function shortcut $.t', function () { - - beforeEach(function (done) { - i18n.init(opts, function (t) { done(); }); - }); - - it('it should provide translation via $.t', function () { - expect($.t('simple_en-US')).to.be('ok_from_en-US'); - expect($.t('simple_en')).to.be('ok_from_en'); - expect($.t('simple_dev')).to.be('ok_from_dev'); - }); - - }); - - describe('using bindings $([selector].i18n())', function () { - - describe('basic - setting text', function () { - - var resStore = { - dev: { translation: {} }, - en: { translation: {} }, - 'en-US': { translation: { 'simpleTest': 'ok_from_en-US' } } - }; - - beforeEach(function (done) { - fixtures.set(''); - - i18n.init($.extend(opts, { resStore: resStore }), - function (t) { done(); }); - }); - - it('it should set text of elements inside selector having data-i18n attribute', function () { - $('#container').i18n(); - expect($('#testBtn').text()).to.be('ok_from_en-US'); - }); - - it('it should set text of element itself if having data-i18n attribute', function () { - $('#testBtn').i18n(); - expect($('#testBtn').text()).to.be('ok_from_en-US'); - }); - - }); - - describe('extended - setting other attributes', function () { - - var resStore = { - dev: { translation: {} }, - en: { translation: {} }, - 'en-US': { translation: { 'simpleTest': 'ok_from_en-US' } } - }; - - beforeEach(function (done) { - fixtures.set(''); - - i18n.init($.extend(opts, { resStore: resStore }), - function (t) { done(); }); - }); - - it('it should set text of elements inside selector having data-i18n attribute', function () { - $('#container').i18n(); - expect($('#testBtn').text()).to.be('ok_from_en-US'); - }); - - it('it should set attributes of elements inside selector having data-i18n attribute', function () { - $('#container').i18n(); - expect($('#testBtn').attr('title')).to.be('ok_from_en-US'); - }); - - }); - - describe('extended - pass in options', function () { - - var resStore = { - dev: { translation: {} }, - en: { translation: {} }, - 'en-US': { translation: { 'simpleTest': '__replace__ ok_from_en-US' } } - }; - - beforeEach(function (done) { - fixtures.set(''); - - i18n.init($.extend(opts, { resStore: resStore }), - function (t) { done(); }); - }); - - it('it should set text with passed in options', function () { - $('#container').i18n({ replace: 'replaced' }); - expect($('#testBtn').text()).to.be('replaced ok_from_en-US'); - }); - - }); - - describe('extended - render inner html', function () { - - var resStore = { - dev: { translation: {} }, - en: { translation: {} }, - 'en-US': { translation: { 'simpleTest': 'test' } } - }; - - beforeEach(function (done) { - fixtures.set(''); - - i18n.init($.extend(opts, { resStore: resStore }), - function (t) { done(); }); - }); - - it('it should set inner html', function () { - $('#container').i18n(); - expect($('#inner').html()).to.be('test'); - }); - - }); - - - describe('extended - read options from data attribute', function () { - - var resStore = { - dev: { translation: {} }, - en: { translation: {} }, - 'en-US': { translation: { 'simpleTest': '__replace__ ok_from_en-US' } } - }; - - beforeEach(function (done) { - fixtures.set(''); - - i18n.init($.extend(opts, { - resStore: resStore, - useDataAttrOptions: true - }), - function (t) { - $('#container').i18n({ replace: 'replaced' }); - $('#testBtn').text(''); - done(); - }); - }); - - it('it should set text with attributes options', function () { - $('#container').i18n(); // without option - expect($('#testBtn').text()).to.be('replaced ok_from_en-US'); - }); - - }); - - }); - - }); - - -}); diff --git a/iconv-lite/iconv-lite-tests.ts b/iconv-lite/iconv-lite-tests.ts index 30aca7968b..f89e84e195 100644 --- a/iconv-lite/iconv-lite-tests.ts +++ b/iconv-lite/iconv-lite-tests.ts @@ -1,6 +1,6 @@ // Code examples from iconv-lite README -import * as iconv from "./"; +import * as iconv from "iconv-lite"; import * as assert from "assert"; import * as fs from "fs"; diff --git a/inert/inert-tests-es6.ts b/inert/inert-tests-es6.ts deleted file mode 100644 index ac50196d00..0000000000 --- a/inert/inert-tests-es6.ts +++ /dev/null @@ -1,7 +0,0 @@ - -import * as HapiES6 from 'hapi'; -import * as InertES6 from 'inert'; - - -const server = new HapiES6.Server({}); -server.register(InertES6, () => {}); \ No newline at end of file diff --git a/inert/inert-tests.ts b/inert/inert-tests.ts index cd12de7780..e917fb9e41 100644 --- a/inert/inert-tests.ts +++ b/inert/inert-tests.ts @@ -1,9 +1,5 @@ +import * as HapiES6 from 'hapi'; +import * as InertES6 from 'inert'; -const Inert = require('inert'); -const Hapi = require('hapi'); - - -const server = new Hapi.Server({}); -server.register(Inert, () => {}); - -export var makeThisAModule: any; \ No newline at end of file +const server = new HapiES6.Server({}); +server.register(InertES6, () => {}); diff --git a/inert/tsconfig.json b/inert/tsconfig.json index f19b878114..2614a83e22 100644 --- a/inert/tsconfig.json +++ b/inert/tsconfig.json @@ -15,7 +15,6 @@ }, "files": [ "index.d.ts", - "inert-tests.ts", - "inert-tests-es6.ts" + "inert-tests.ts" ] } \ No newline at end of file diff --git a/inversify-devtools/inversify-devtools-test.ts b/inversify-devtools/inversify-devtools-tests.ts similarity index 100% rename from inversify-devtools/inversify-devtools-test.ts rename to inversify-devtools/inversify-devtools-tests.ts diff --git a/inversify-devtools/package.json b/inversify-devtools/package.json new file mode 100644 index 0000000000..2ec416e55c --- /dev/null +++ b/inversify-devtools/package.json @@ -0,0 +1,5 @@ +{ + "dependencies": { + "inversify": "^2.0.1" + } +} \ No newline at end of file diff --git a/inversify-devtools/tsconfig.json b/inversify-devtools/tsconfig.json index ab530b69c7..451d07224b 100644 --- a/inversify-devtools/tsconfig.json +++ b/inversify-devtools/tsconfig.json @@ -16,6 +16,6 @@ }, "files": [ "index.d.ts", - "inversify-devtools-test.ts" + "inversify-devtools-tests.ts" ] } \ No newline at end of file diff --git a/ion.rangeslider/ion.rangeSlider-1.9.1.d.ts b/ion.rangeslider/v1/index.d.ts similarity index 100% rename from ion.rangeslider/ion.rangeSlider-1.9.1.d.ts rename to ion.rangeslider/v1/index.d.ts diff --git a/ion.rangeslider/ion.rangeSlider-1.9.1-tests.ts b/ion.rangeslider/v1/ion.rangeSlider-tests.ts similarity index 93% rename from ion.rangeslider/ion.rangeSlider-1.9.1-tests.ts rename to ion.rangeslider/v1/ion.rangeSlider-tests.ts index 224deab397..ba10fa776f 100644 --- a/ion.rangeslider/ion.rangeSlider-1.9.1-tests.ts +++ b/ion.rangeslider/v1/ion.rangeSlider-tests.ts @@ -1,5 +1,4 @@ /// -/// var sliderInputElement = $(''); sliderInputElement.ionRangeSlider({ diff --git a/ion.rangeslider/v1/tsconfig.json b/ion.rangeslider/v1/tsconfig.json new file mode 100644 index 0000000000..fa756621f2 --- /dev/null +++ b/ion.rangeslider/v1/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "target": "es6", + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "baseUrl": "../../", + "typeRoots": [ + "../../" + ], + "types": [], + "paths": { + "ion.rangeslider": ["ion.rangeslider/v0"] + }, + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "ion.rangeSlider-tests.ts" + ] +} \ No newline at end of file diff --git a/is-promise/is-promise-tests.ts b/is-promise/is-promise-tests.ts index df9a1d316f..25071e21fd 100644 --- a/is-promise/is-promise-tests.ts +++ b/is-promise/is-promise-tests.ts @@ -1,4 +1,4 @@ -import isPromise = require("./"); +import isPromise = require("is-promise"); isPromise({ then() { }}); isPromise(null); diff --git a/iscroll/UNUSED_FILES.txt b/iscroll/UNUSED_FILES.txt new file mode 100644 index 0000000000..b3ebf4f3ea --- /dev/null +++ b/iscroll/UNUSED_FILES.txt @@ -0,0 +1 @@ +iscroll-lite.d.ts \ No newline at end of file diff --git a/iscroll/index.d.ts b/iscroll/index.d.ts index dbb3e851b6..b4a8d62763 100644 --- a/iscroll/index.d.ts +++ b/iscroll/index.d.ts @@ -1,76 +1,96 @@ -// Type definitions for iScroll 4.2 -// Project: http://cubiq.org/iscroll-4 -// Definitions by: Boris Yankov , Christiaan Rakowski +// Type definitions for iScroll 5 +// Project: http://cubiq.org/iscroll-5-ready-for-beta-test +// Definitions by: Christiaan Rakowski // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +interface IScrollOptions { + x?: number; + y?: number; + bounce?: boolean; + bounceLock?: boolean; + momentum?: boolean; + lockDirection?: boolean; + useTransform?: boolean; + useTransition?: boolean; + topOffset?: number; + checkDOMChanges?: boolean; + handleClick?: boolean; -interface iScrollEvent { - (e: Event): void; + // Scrollbar + hScrollbar?: boolean; + vScrollbar?: boolean; + fixedScrollbar?: boolean; + hideScrollbar?: boolean; + fadeScrollbar?: boolean; + scrollbarClass?: string; + + // Zoom + zoom?: boolean; + zoomMin?: number; + zoomMax?: number; + doubleTapZoom?: number; + mouseWheel?: boolean; + wheelAction?: string; + snap?: string | boolean; + snapThreshold?: number; + + // New in IScroll 5? + resizeIndicator?: boolean; + mouseWheelSpeed?: number; + startX?: number; + startY?: number; + scrollX?: boolean; + scrollY?: boolean; + scrollbars?: boolean | string; + shrinkScrollbars?: string; + interactiveScrollbars?: boolean; + releaseScroll?: boolean; + fadeScrollbars?: boolean; + directionLockThreshold?: number; + + bounceTime?: number; + + ///String or function + bounceEasing?: string|{ style: string, fn: (k: any) => any }; + + preventDefault?: boolean; + preventDefaultException?: Array|Object; + + HWCompositing?: boolean; + + freeScroll?: boolean; + + resizePolling?: number; + tap?: boolean; + click?: boolean; + invertWheelDirection?: boolean; + eventPassthrough?: string | boolean; + + // iScroll probe edition + probeType?: number; } -interface iScrollOptions { - hScroll?: boolean; - vScroll?: boolean; - x?: number; - y?: number; - bounce?: boolean; - bounceLock?: boolean; - momentum?: boolean; - lockDirection?: boolean; - useTransform?: boolean; - useTransition?: boolean; - topOffset?: number; - checkDOMChanges?: boolean; - handleClick?: boolean; +declare class IScroll { + constructor (element: string, options?: IScrollOptions); + constructor (element: HTMLElement, options?: IScrollOptions); - // Scrollbar - hScrollbar?: boolean; - vScrollbar?: boolean; - fixedScrollbar?: boolean; - hideScrollbar?: boolean; - fadeScrollbar?: boolean; - scrollbarClass?: string; + x: number; + y: number; - // Zoom - zoom?: boolean; - zoomMin?: number; - zoomMax?: number; - doubleTapZoom?: number; - wheelAction?: string; + destroy(): void; + refresh(): void; + scrollTo(x: number, y: number, time?: number, relative?: boolean): void; + scrollToElement(element: string, time?: number): void; + scrollToElement(element: HTMLElement, time?: number): void; + scrollToElement(element: HTMLElement, time?: number, offsetX?: number | boolean, offsetY?: number | boolean, easing?: Function): void; + goToPage(pageX: number, pageY: number, time?: number): void; + disable(): void; + enable(): void; + stop(): void; + zoom(x: number, y: number, scale: number, time?: number): void; + isReady(): boolean; - // Snap - snap?: any; - snapThreshold?: number; - - // Events - onRefresh?: iScrollEvent; - onBeforeScrollStart?: iScrollEvent; - onScrollStart?: iScrollEvent; - onBeforeScrollMove?: iScrollEvent; - onScrollMove?: iScrollEvent; - onBeforeScrollEnd?: iScrollEvent; - onScrollEnd?: iScrollEvent; - onTouchEnd?: iScrollEvent; - onDestroy?: iScrollEvent; - onZoomStart?: iScrollEvent; - onZoom?: iScrollEvent; - onZoomEnd?: iScrollEvent; -} - -declare class iScroll { - - constructor (element: string, options?: iScrollOptions); - constructor (element: HTMLElement, options?: iScrollOptions); - - destroy(): void; - refresh(): void; - scrollTo(x: number, y: number, time?: number, relative?: boolean): void; - scrollToElement(element: string, time?: number): void; - scrollToElement(element: HTMLElement, time?: number): void; - scrollToPage(pageX: number, pageY: number, time?: number): void; - disable(): void; - enable(): void; - stop(): void; - zoom(x: number, y: number, scale: number, time?: number): void; - isReady(): boolean; + // Events + on(type: string, fn: (evt?: any) => void): void; + off(type: string, fn?: (evt?: any) => void): void; } diff --git a/iscroll/iscroll-5-lite.d.ts b/iscroll/iscroll-5-lite.d.ts deleted file mode 100644 index c2c2559c87..0000000000 --- a/iscroll/iscroll-5-lite.d.ts +++ /dev/null @@ -1,39 +0,0 @@ -// Type definitions for iScroll Lite 5 -// Project: http://cubiq.org/iscroll-5-ready-for-beta-test -// Definitions by: Christiaan Rakowski -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -interface IScrollOptions { - //hScroll?: boolean; - //vScroll?: boolean; - - scrollX?: boolean; - scrollY?: boolean; - - x?: number; - y?: number; - bounce?: boolean; - bounceLock?: boolean; - momentum?: boolean; - lockDirection?: boolean; - useTransform?: boolean; - useTransition?: boolean; -} - -declare class IScroll { - - constructor (element: string, options?: IScrollOptions); - constructor (element: HTMLElement, options?: IScrollOptions); - - destroy(): void; - refresh(): void; - scrollTo(x: number, y: number, time?: number, relative?: boolean): void; - scrollToElement(element: string, time?: number): void; - scrollToElement(element: HTMLElement, time?: number): void; - disable(): void; - enable(): void; - stop(): void; - - // Events - on: (type: string, fn: () => void) => void; -} diff --git a/iscroll/iscroll-5-tests.ts b/iscroll/iscroll-5-tests.ts deleted file mode 100644 index 3e19397d0f..0000000000 --- a/iscroll/iscroll-5-tests.ts +++ /dev/null @@ -1,41 +0,0 @@ - - -var myScroll1 = new IScroll('#wrapper'); -var myScroll2 = new IScroll('#wrapper', { hScrollbar: false, vScrollbar: false }); -var myScroll3 = new IScroll('#wrapper', { - snap: true, - momentum: false, - hScrollbar: false, - vScrollbar: false -}); -var myScroll4 = new IScroll('#wrapper', { - snap: 'li', - momentum: false, - hScrollbar: false, - vScrollbar: false -}); -var myScroll6 = new IScroll('#wrapper', { scrollbarClass: 'myScrollbar' }); -var myScroll7 = new IScroll('#wrapper', { bounceEasing: 'elastic', bounceTime: 1200 }); - -var myScroll8 = new IScroll('#wrapper', { eventPassthrough: true, scrollX: true, scrollY: false, preventDefault: false }); - -myScroll1.refresh(); -myScroll1.scrollTo(0, 100); -myScroll1.scrollTo(0, 100, 200); -myScroll1.scrollTo(0, 100, 200, true); - -myScroll1.scrollToElement('selectedElement'); -myScroll1.scrollToElement('selectedElement', 250); - -myScroll1.scrollToElement(document.getElementById('selectedElement')); -myScroll1.scrollToElement(document.getElementById('selectedElement'), 250); - -myScroll2.on('scrollStart', function () { console.log('scroll started'); }); - -var myScroll9 = new IScroll(document.getElementById('wrapper')); -var myScroll10 = new IScroll(document.getElementById('wrapper'), { scrollbarClass: 'myScrollbar' }); -var myScroll11 = new IScroll(document.getElementById('wrapper'), { preventDefaultException: [ /^(INPUT|TEXTAREA|BUTTON|SELECT)$/ ] }); -var myScroll12 = new IScroll(document.getElementById('wrapper'), { preventDefaultException: { tagName: /^(INPUT|TEXTAREA|BUTTON|SELECT)$/ } }); - -var myScroll13 = new IScroll(document.getElementById('wrapper'), { bounceEasing: 'circular' }); -var myScroll14 = new IScroll(document.getElementById('wrapper'), { bounceEasing: { style: 'cubic-bezier(0,0,1,1)', fn: function (k) { return k; } } }); diff --git a/iscroll/iscroll-5.d.ts b/iscroll/iscroll-5.d.ts deleted file mode 100644 index b4a8d62763..0000000000 --- a/iscroll/iscroll-5.d.ts +++ /dev/null @@ -1,96 +0,0 @@ -// Type definitions for iScroll 5 -// Project: http://cubiq.org/iscroll-5-ready-for-beta-test -// Definitions by: Christiaan Rakowski -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -interface IScrollOptions { - x?: number; - y?: number; - bounce?: boolean; - bounceLock?: boolean; - momentum?: boolean; - lockDirection?: boolean; - useTransform?: boolean; - useTransition?: boolean; - topOffset?: number; - checkDOMChanges?: boolean; - handleClick?: boolean; - - // Scrollbar - hScrollbar?: boolean; - vScrollbar?: boolean; - fixedScrollbar?: boolean; - hideScrollbar?: boolean; - fadeScrollbar?: boolean; - scrollbarClass?: string; - - // Zoom - zoom?: boolean; - zoomMin?: number; - zoomMax?: number; - doubleTapZoom?: number; - mouseWheel?: boolean; - wheelAction?: string; - snap?: string | boolean; - snapThreshold?: number; - - // New in IScroll 5? - resizeIndicator?: boolean; - mouseWheelSpeed?: number; - startX?: number; - startY?: number; - scrollX?: boolean; - scrollY?: boolean; - scrollbars?: boolean | string; - shrinkScrollbars?: string; - interactiveScrollbars?: boolean; - releaseScroll?: boolean; - fadeScrollbars?: boolean; - directionLockThreshold?: number; - - bounceTime?: number; - - ///String or function - bounceEasing?: string|{ style: string, fn: (k: any) => any }; - - preventDefault?: boolean; - preventDefaultException?: Array|Object; - - HWCompositing?: boolean; - - freeScroll?: boolean; - - resizePolling?: number; - tap?: boolean; - click?: boolean; - invertWheelDirection?: boolean; - eventPassthrough?: string | boolean; - - // iScroll probe edition - probeType?: number; -} - -declare class IScroll { - constructor (element: string, options?: IScrollOptions); - constructor (element: HTMLElement, options?: IScrollOptions); - - x: number; - y: number; - - destroy(): void; - refresh(): void; - scrollTo(x: number, y: number, time?: number, relative?: boolean): void; - scrollToElement(element: string, time?: number): void; - scrollToElement(element: HTMLElement, time?: number): void; - scrollToElement(element: HTMLElement, time?: number, offsetX?: number | boolean, offsetY?: number | boolean, easing?: Function): void; - goToPage(pageX: number, pageY: number, time?: number): void; - disable(): void; - enable(): void; - stop(): void; - zoom(x: number, y: number, scale: number, time?: number): void; - isReady(): boolean; - - // Events - on(type: string, fn: (evt?: any) => void): void; - off(type: string, fn?: (evt?: any) => void): void; -} diff --git a/iscroll/iscroll-lite.d.ts b/iscroll/iscroll-lite.d.ts index 8b83664299..c2c2559c87 100644 --- a/iscroll/iscroll-lite.d.ts +++ b/iscroll/iscroll-lite.d.ts @@ -1,48 +1,39 @@ -// Type definitions for iScroll Lite 4.1 -// Project: http://cubiq.org/iscroll-4 -// Definitions by: Boris Yankov , Christiaan Rakowski +// Type definitions for iScroll Lite 5 +// Project: http://cubiq.org/iscroll-5-ready-for-beta-test +// Definitions by: Christiaan Rakowski // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +interface IScrollOptions { + //hScroll?: boolean; + //vScroll?: boolean; -interface iScrollEvent { - (e: Event): void; + scrollX?: boolean; + scrollY?: boolean; + + x?: number; + y?: number; + bounce?: boolean; + bounceLock?: boolean; + momentum?: boolean; + lockDirection?: boolean; + useTransform?: boolean; + useTransition?: boolean; } -interface iScrollOptions { - hScroll?: boolean; - vScroll?: boolean; - x?: number; - y?: number; - bounce?: boolean; - bounceLock?: boolean; - momentum?: boolean; - lockDirection?: boolean; - useTransform?: boolean; - useTransition?: boolean; +declare class IScroll { - // Events - onRefresh?: iScrollEvent; - onBeforeScrollStart?: iScrollEvent; - onScrollStart?: iScrollEvent; - onBeforeScrollMove?: iScrollEvent; - onScrollMove?: iScrollEvent; - onBeforeScrollEnd?: iScrollEvent; - onScrollEnd?: iScrollEvent; - onTouchEnd?: iScrollEvent; - onDestroy?: iScrollEvent; -} - -declare class iScroll { - - constructor (element: string, options?: iScrollOptions); - constructor (element: HTMLElement, options?: iScrollOptions); - - destroy(): void; - refresh(): void; - scrollTo(x: number, y: number, time?: number, relative?: boolean): void; - scrollToElement(element: string, time?: number): void; - scrollToElement(element: HTMLElement, time?: number): void; - disable(): void; - enable(): void; - stop(): void; + constructor (element: string, options?: IScrollOptions); + constructor (element: HTMLElement, options?: IScrollOptions); + + destroy(): void; + refresh(): void; + scrollTo(x: number, y: number, time?: number, relative?: boolean): void; + scrollToElement(element: string, time?: number): void; + scrollToElement(element: HTMLElement, time?: number): void; + disable(): void; + enable(): void; + stop(): void; + + // Events + on: (type: string, fn: () => void) => void; } diff --git a/iscroll/iscroll-tests.ts b/iscroll/iscroll-tests.ts index 09133f4175..3e19397d0f 100644 --- a/iscroll/iscroll-tests.ts +++ b/iscroll/iscroll-tests.ts @@ -1,20 +1,23 @@ -var myScroll1 = new iScroll('wrapper'); -var myScroll2 = new iScroll('wrapper', { hScrollbar: false, vScrollbar: false }); -var myScroll3= new iScroll('wrapper', { +var myScroll1 = new IScroll('#wrapper'); +var myScroll2 = new IScroll('#wrapper', { hScrollbar: false, vScrollbar: false }); +var myScroll3 = new IScroll('#wrapper', { snap: true, momentum: false, hScrollbar: false, vScrollbar: false }); -var myScroll4 = new iScroll('wrapper', { +var myScroll4 = new IScroll('#wrapper', { snap: 'li', momentum: false, hScrollbar: false, vScrollbar: false }); -var myScroll6 = new iScroll('wrapper', { scrollbarClass: 'myScrollbar' }); +var myScroll6 = new IScroll('#wrapper', { scrollbarClass: 'myScrollbar' }); +var myScroll7 = new IScroll('#wrapper', { bounceEasing: 'elastic', bounceTime: 1200 }); + +var myScroll8 = new IScroll('#wrapper', { eventPassthrough: true, scrollX: true, scrollY: false, preventDefault: false }); myScroll1.refresh(); myScroll1.scrollTo(0, 100); @@ -27,5 +30,12 @@ myScroll1.scrollToElement('selectedElement', 250); myScroll1.scrollToElement(document.getElementById('selectedElement')); myScroll1.scrollToElement(document.getElementById('selectedElement'), 250); -var myScroll7 = new iScroll(document.getElementById('wrapper')); -var myScroll8 = new iScroll(document.getElementById('wrapper'), { scrollbarClass: 'myScrollbar' }); \ No newline at end of file +myScroll2.on('scrollStart', function () { console.log('scroll started'); }); + +var myScroll9 = new IScroll(document.getElementById('wrapper')); +var myScroll10 = new IScroll(document.getElementById('wrapper'), { scrollbarClass: 'myScrollbar' }); +var myScroll11 = new IScroll(document.getElementById('wrapper'), { preventDefaultException: [ /^(INPUT|TEXTAREA|BUTTON|SELECT)$/ ] }); +var myScroll12 = new IScroll(document.getElementById('wrapper'), { preventDefaultException: { tagName: /^(INPUT|TEXTAREA|BUTTON|SELECT)$/ } }); + +var myScroll13 = new IScroll(document.getElementById('wrapper'), { bounceEasing: 'circular' }); +var myScroll14 = new IScroll(document.getElementById('wrapper'), { bounceEasing: { style: 'cubic-bezier(0,0,1,1)', fn: function (k) { return k; } } }); diff --git a/iscroll/tsconfig.json b/iscroll/tsconfig.json index ac5b1f94c2..4e847b3981 100644 --- a/iscroll/tsconfig.json +++ b/iscroll/tsconfig.json @@ -1,8 +1,4 @@ { - "files": [ - "index.d.ts", - "iscroll-tests.ts" - ], "compilerOptions": { "module": "commonjs", "target": "es6", @@ -16,5 +12,9 @@ "types": [], "noEmit": true, "forceConsistentCasingInFileNames": true - } + }, + "files": [ + "index.d.ts", + "iscroll-tests.ts" + ] } \ No newline at end of file diff --git a/iscroll/v4/UNUSED_FILES.txt b/iscroll/v4/UNUSED_FILES.txt new file mode 100644 index 0000000000..b3ebf4f3ea --- /dev/null +++ b/iscroll/v4/UNUSED_FILES.txt @@ -0,0 +1 @@ +iscroll-lite.d.ts \ No newline at end of file diff --git a/iscroll/v4/index.d.ts b/iscroll/v4/index.d.ts new file mode 100644 index 0000000000..dbb3e851b6 --- /dev/null +++ b/iscroll/v4/index.d.ts @@ -0,0 +1,76 @@ +// Type definitions for iScroll 4.2 +// Project: http://cubiq.org/iscroll-4 +// Definitions by: Boris Yankov , Christiaan Rakowski +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + + +interface iScrollEvent { + (e: Event): void; +} + +interface iScrollOptions { + hScroll?: boolean; + vScroll?: boolean; + x?: number; + y?: number; + bounce?: boolean; + bounceLock?: boolean; + momentum?: boolean; + lockDirection?: boolean; + useTransform?: boolean; + useTransition?: boolean; + topOffset?: number; + checkDOMChanges?: boolean; + handleClick?: boolean; + + // Scrollbar + hScrollbar?: boolean; + vScrollbar?: boolean; + fixedScrollbar?: boolean; + hideScrollbar?: boolean; + fadeScrollbar?: boolean; + scrollbarClass?: string; + + // Zoom + zoom?: boolean; + zoomMin?: number; + zoomMax?: number; + doubleTapZoom?: number; + wheelAction?: string; + + // Snap + snap?: any; + snapThreshold?: number; + + // Events + onRefresh?: iScrollEvent; + onBeforeScrollStart?: iScrollEvent; + onScrollStart?: iScrollEvent; + onBeforeScrollMove?: iScrollEvent; + onScrollMove?: iScrollEvent; + onBeforeScrollEnd?: iScrollEvent; + onScrollEnd?: iScrollEvent; + onTouchEnd?: iScrollEvent; + onDestroy?: iScrollEvent; + onZoomStart?: iScrollEvent; + onZoom?: iScrollEvent; + onZoomEnd?: iScrollEvent; +} + +declare class iScroll { + + constructor (element: string, options?: iScrollOptions); + constructor (element: HTMLElement, options?: iScrollOptions); + + destroy(): void; + refresh(): void; + scrollTo(x: number, y: number, time?: number, relative?: boolean): void; + scrollToElement(element: string, time?: number): void; + scrollToElement(element: HTMLElement, time?: number): void; + scrollToPage(pageX: number, pageY: number, time?: number): void; + disable(): void; + enable(): void; + stop(): void; + zoom(x: number, y: number, scale: number, time?: number): void; + isReady(): boolean; +} diff --git a/iscroll/v4/iscroll-lite.d.ts b/iscroll/v4/iscroll-lite.d.ts new file mode 100644 index 0000000000..8b83664299 --- /dev/null +++ b/iscroll/v4/iscroll-lite.d.ts @@ -0,0 +1,48 @@ +// Type definitions for iScroll Lite 4.1 +// Project: http://cubiq.org/iscroll-4 +// Definitions by: Boris Yankov , Christiaan Rakowski +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + + +interface iScrollEvent { + (e: Event): void; +} + +interface iScrollOptions { + hScroll?: boolean; + vScroll?: boolean; + x?: number; + y?: number; + bounce?: boolean; + bounceLock?: boolean; + momentum?: boolean; + lockDirection?: boolean; + useTransform?: boolean; + useTransition?: boolean; + + // Events + onRefresh?: iScrollEvent; + onBeforeScrollStart?: iScrollEvent; + onScrollStart?: iScrollEvent; + onBeforeScrollMove?: iScrollEvent; + onScrollMove?: iScrollEvent; + onBeforeScrollEnd?: iScrollEvent; + onScrollEnd?: iScrollEvent; + onTouchEnd?: iScrollEvent; + onDestroy?: iScrollEvent; +} + +declare class iScroll { + + constructor (element: string, options?: iScrollOptions); + constructor (element: HTMLElement, options?: iScrollOptions); + + destroy(): void; + refresh(): void; + scrollTo(x: number, y: number, time?: number, relative?: boolean): void; + scrollToElement(element: string, time?: number): void; + scrollToElement(element: HTMLElement, time?: number): void; + disable(): void; + enable(): void; + stop(): void; +} diff --git a/iscroll/v4/iscroll-tests.ts b/iscroll/v4/iscroll-tests.ts new file mode 100644 index 0000000000..09133f4175 --- /dev/null +++ b/iscroll/v4/iscroll-tests.ts @@ -0,0 +1,31 @@ + + +var myScroll1 = new iScroll('wrapper'); +var myScroll2 = new iScroll('wrapper', { hScrollbar: false, vScrollbar: false }); +var myScroll3= new iScroll('wrapper', { + snap: true, + momentum: false, + hScrollbar: false, + vScrollbar: false +}); +var myScroll4 = new iScroll('wrapper', { + snap: 'li', + momentum: false, + hScrollbar: false, + vScrollbar: false +}); +var myScroll6 = new iScroll('wrapper', { scrollbarClass: 'myScrollbar' }); + +myScroll1.refresh(); +myScroll1.scrollTo(0, 100); +myScroll1.scrollTo(0, 100, 200); +myScroll1.scrollTo(0, 100, 200, true); + +myScroll1.scrollToElement('selectedElement'); +myScroll1.scrollToElement('selectedElement', 250); + +myScroll1.scrollToElement(document.getElementById('selectedElement')); +myScroll1.scrollToElement(document.getElementById('selectedElement'), 250); + +var myScroll7 = new iScroll(document.getElementById('wrapper')); +var myScroll8 = new iScroll(document.getElementById('wrapper'), { scrollbarClass: 'myScrollbar' }); \ No newline at end of file diff --git a/iscroll/v4/tsconfig.json b/iscroll/v4/tsconfig.json new file mode 100644 index 0000000000..f393dcb124 --- /dev/null +++ b/iscroll/v4/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "target": "es6", + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": false, + "baseUrl": "../../", + "typeRoots": [ + "../../" + ], + "types": [], + "paths": { + "iscroll": ["iscroll/v4"] + }, + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "iscroll-tests.ts" + ] +} \ No newline at end of file diff --git a/ix.js/tsconfig.json b/ix.js/tsconfig.json index f0ce358bee..670dba223e 100644 --- a/ix.js/tsconfig.json +++ b/ix.js/tsconfig.json @@ -15,6 +15,7 @@ }, "files": [ "index.d.ts", - "ix-tests.ts" + "ix-tests.ts", + "l2o-tests.ts" ] } \ No newline at end of file diff --git a/jasmine/legacy/index.d.ts b/jasmine/v1/index.d.ts similarity index 100% rename from jasmine/legacy/index.d.ts rename to jasmine/v1/index.d.ts diff --git a/jasmine/legacy/jasmine-1.3-tests.ts b/jasmine/v1/jasmine-tests.ts similarity index 100% rename from jasmine/legacy/jasmine-1.3-tests.ts rename to jasmine/v1/jasmine-tests.ts diff --git a/jasmine/v1/tsconfig.json b/jasmine/v1/tsconfig.json new file mode 100644 index 0000000000..91e64eb5d2 --- /dev/null +++ b/jasmine/v1/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "target": "es6", + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": false, + "baseUrl": "../../", + "typeRoots": [ + "../../" + ], + "types": [], + "paths": { + "jasmine": ["jasmine/v1"] + }, + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "jasmine-tests.ts" + ] +} \ No newline at end of file diff --git a/joi/joi-6.5.0.d.ts b/joi/v6/index.d.ts similarity index 100% rename from joi/joi-6.5.0.d.ts rename to joi/v6/index.d.ts diff --git a/joi/joi-6.5.0-tests.ts b/joi/v6/joi-tests.ts similarity index 100% rename from joi/joi-6.5.0-tests.ts rename to joi/v6/joi-tests.ts diff --git a/js-data/legacy/tsconfig.json b/joi/v6/tsconfig.json similarity index 51% rename from js-data/legacy/tsconfig.json rename to joi/v6/tsconfig.json index 38975ea097..b7167c5d4f 100644 --- a/js-data/legacy/tsconfig.json +++ b/joi/v6/tsconfig.json @@ -3,14 +3,21 @@ "module": "commonjs", "target": "es6", "noImplicitAny": true, + "noImplicitThis": true, "strictNullChecks": false, "baseUrl": "../../", - "typesRoot": "../../", + "typeRoots": [ + "../../" + ], + "types": [], + "paths": { + "joi": ["joi/v6"] + }, "noEmit": true, - "forceConsistentCasingInFileNames": true + "forceConsistentCasingInFileNames": true }, "files": [ "index.d.ts", - "js-data-1.5.4-tests.ts" + "joi-tests.ts" ] } \ No newline at end of file diff --git a/jquery.bbq/jquery.bbq-tests.ts b/jquery.bbq/jquery.bbq-tests.ts index 8f3ab25aea..16216ea557 100644 --- a/jquery.bbq/jquery.bbq-tests.ts +++ b/jquery.bbq/jquery.bbq-tests.ts @@ -1,5 +1,4 @@ -/// - +/// // ************** Tests to jquery JQueryParam interface var myObject = { diff --git a/jquery.datatables/jquery.dataTables-1.9.4.d.ts b/jquery.datatables/jquery.dataTables-1.9.4.d.ts deleted file mode 100644 index a7ff0301aa..0000000000 --- a/jquery.datatables/jquery.dataTables-1.9.4.d.ts +++ /dev/null @@ -1,479 +0,0 @@ -// Type definitions for JQuery DataTables 1.9.4 -// Project: http://www.datatables.net -// Definitions by: Armin Sander -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -// missing: -// - Static methods that are defined in JQueryStatic.fn are not typed. -// - Plugin and extension definitions are not typed. - -interface JQuery -{ - dataTable(param? :DataTables.Options) : DataTables.DataTable; -} - -declare namespace DataTables -{ - export interface DataTable - { - /// Perform a jQuery selector action on the table's TR elements (from the tbody) and return the resulting jQuery object. - $(selector:string, opts?:RowParams): JQuery; - $(selector:Node[], opts?:RowParams): JQuery; - $(selector:JQuery, opts?:RowParams): JQuery; - - /// Almost identical to $ in operation, but in this case returns the data for the matched rows. - _(selector:string, opts?:RowParams): any[]; - _(selector:Node[], opts?:RowParams): any[]; - _(selector:JQuery, opts?:RowParams): any[]; - - /// Add a single new row or multiple rows of data to the table. - fnAddData(data:any, redraw?:boolean) : number[]; - - /// This function will make DataTables recalculate the column sizes. - fnAdjustColumnSizing(redraw? : boolean) : void; - - /// Quickly and simply clear a table - fnClearTable(redraw? : boolean) : void; - - /// The exact opposite of 'opening' a row, this function will close any rows which are currently 'open'. - fnClose(node: Node) : number; - - /// Remove a row for the table - fnDeleteRow(index: number, callback?: () => void, redraw?: boolean) : any[]; - fnDeleteRow(tr: Node, callback?: () => void, redraw?: boolean) : any[]; - - /// Restore the table to it's original state in the DOM by removing all of DataTables enhancements, - /// alterations to the DOM structure of the table and event listeners. - fnDestroy(remove?: boolean) : void; - - /// Redraw the table - fnDraw(complete? : boolean) : void; - - /// Filter the input based on data - fnFilter(input: string, column? : number, regex?: boolean, smart? : boolean, showGlobal?: boolean, caseInsensitive? : boolean) : void; - - /// Get the data for the whole table, an individual row or an individual cell based on the provided parameters. - fnGetData(row?: Node, col? : number) : any; - fnGetData(row?: number, col? : number) : any; - - /// Get an array of the TR nodes that are used in the table's body. - fnGetNodes(row? : number) : any; // Node[] | Node - - /// Get the array indexes of a particular cell from it's DOM element and column index including hidden columns - fnGetPosition(node: Node) : any; // number | number[] - - /// Check to see if a row is 'open' or not. - fnIsOpen(tr: Node) : boolean; - - /// This function will place a new row directly after a row which is currently on display on the page, - /// with the HTML contents that is passed into the function. - fnOpen(node: Node, html: string, clazz: string) : Node; - fnOpen(node: Node, html: Node, clazz: string) : Node; - fnOpen(node: Node, html: JQuery, clazz: string) : Node; - - /// Change the pagination - provides the internal logic for pagination in a simple API function. - fnPageChange(action: string, redraw?: boolean) : void; - fnPageChange(page: number, redraw?: boolean) : void; - - /// Show a particular column - fnSetColumnVis(column: number, show: boolean, redraw?: boolean) : void; - - /// Get the settings for a particular table for external manipulation - fnSettings() : Settings; - - /// Sort the table by a particular column - fnSort(col: number) : void; - fnSort(col: any[][]) : void; - - /// Attach a sort listener to an element for a given column - fnSortListener(node: Node, column: number, callback? : () => void): void; - - /// Update a table cell or row - this method will accept either a single value to update the cell with, - /// an array of values with one element for each column or an object in the same format as the original data source. - fnUpdate(data: any, row: Node, column?:number, redraw?: boolean, action? : boolean) : number; - fnUpdate(data: any, dataIndex: number, column?:number, redraw?: boolean, action? : boolean) : number; - - /// Provide a common method for plug-ins to check the version of DataTables being used, - /// in order to ensure compatibility. - fnVersionCheck(version: string) : boolean; - } - - export interface Static - { - /// Provide a common method for plug-ins to check the version of DataTables being used, - /// in order to ensure compatibility. - fnVersionCheck(version: string) : boolean; - - /// Check if a TABLE node is a DataTable table already or not. - fnIsDataTable(table: Node) : boolean; - - /// Get all DataTable tables that have been initialised. - fnTables(visible? : boolean) : Node[]; - } - - export interface RowParams - { - /// Select TR elements that meet the current filter criterion ("applied") or all TR elements (i.e. no filter). - filter?: string; - - /// Order of the TR elements in the processed array. - /// Can be either 'current', whereby the current sorting of the table is used, or - /// 'original' whereby the original order the data was read into the table is used. - order?: string; - - /// Limit the selection to the currently displayed page - /// ("current") or not ("all"). If 'current' is given, then order is assumed to be - /// 'current' and filter is 'applied', regardless of what they might be given as. - page?: string; - } - - export interface Options - { - aaData?: any[]; - aaSorting?: any[]; - aaSortingFixed?: any[]; - ajax?: any; - aLengthMenu?: any[]; - aoColumns?: ColumnOptions[]; - aoColumnDefs?: ColumnDef[]; - aoSearchCols?: any[]; - asStripClasses?: string[]; - bAutoWidth?: boolean; - bDeferRender?: boolean; - bDestroy?: boolean; - bFilter?: boolean; - bInfo?: boolean; - bJQueryUI?: boolean; - bLengthChange?: boolean; - bPaginate?: boolean; - bProcessing?: boolean; - bRetrieve?: boolean; - bScrollAutoCss?: boolean; - bScrollCollapse?: boolean; - bScrollInfinite?: boolean; - bServerSide?: boolean; - bSort?: boolean; - bSortCellsTop?: boolean; - bSortClasses?: boolean; - bStateSave?: boolean; - fnCookieCallback?: CookieCallback; - fnCreatedRow?: RowCreatedCallback; - fnDrawCallback?: DrawCallback; - fnFooterCallback?: FooterCallback; - fnFormatNumber?: FormatNumber; - fnHeaderCallback?: HeaderCallback; - fnInfoCallback?: InfoCallback; - fnInitComplete?: InitComplete; - fnPreDrawCallback?: PreDrawCallback; - fnRowCallback?: RowCallback; - - fnStateLoadCallback?: StateLoadCallback; - fnStateLoadParams?: StateLoadParams; - fnStateLoaded?: StateLoaded; - fnStateSaveCallback?: StateSaveCallback; - fnStateSaveParams?: StateSaveParams; - iCookieDuration?: number; - iDeferLoading?: any; - iDisplayLength?: number; - iDisplayStart?: number; - iScrollLoadGap?: number; - iTabIndex?: number; - oLanguage?: LanguageOptions; - oSearch?: any; - sAjaxDataProp?: string; - sAjaxSource?: string; - sCookiePrefix?: string; - sDom?: string; - sPaginationType?: string; - sScrollX?: string; - sScrollXInner?: string; - sScrollY?: string; - sServerMethod? : string; - } - - export interface LanguageOptions - { - oAria? : AriaOptions; - oPaginate? : PaginateOptions; - sEmptyTable?: string; - sInfo?: string; - sInfoEmpty?: string; - sInfoFiltered?: string; - sInfoPostFix?: string; - sInfoThousands?: string; - sLengthMenu?: string; - sLoadingRecords?: string; - sProcessing?: string; - sSearch?: string; - sUrl?: string; - sZeroRecords?: string; - } - - export interface AriaOptions - { - sSortAscending?: string; - sSortDescending?: string; - } - - export interface PaginateOptions - { - sFirst?: string; - sLast?: string; - sNext?: string; - sPrevious?: string; - } - - export interface ColumnOptions - { - aDataSort?: number[]; - asSorting?: string[]; - bSearchable? : boolean; - bSortable? : boolean; - bVisible? : boolean; - _bAutoType? : boolean; - fnCreatedCell?: CreatedCell; - iDataSort?: number; - mData?: any; - mRender?: any; - sCellType?: string; - sClass?: string; - sContentPadding?: string; - sDefaultContent?: string; - sName?: string; - sSortDataType?: string; - sSortingClass?: string; - sTitle?: string; - sType?: string; - sWidth?: string; - } - - export interface ColumnDef extends ColumnOptions - { - aTargets: any[]; - } - - export interface Settings - { - oFeatures : Features; - oScroll: ScrollingSettings; - oLanguage : { fnInfoCallback : InfoCallback; }; - oBrowser : { bScrollOversize : boolean; }; - aanFeatures: Node[][]; - aoData: Row[]; - aiDisplay: number[]; - aiDisplayMaster: number[]; - aoColumns: Column[]; - aoHeader: any[]; - aoFooter: any[]; - asDataSearch: string[]; - oPreviousSearch: any; - aoPreSearchCols: any[]; - aaSorting: any[][]; - aaSortingFixed: any[][]; - asStripeClasses: string[]; - asDestroyStripes: string[]; - sDestroyWidth: number; - aoRowCallback: RowCallback[]; - aoHeaderCallback: HeaderCallback[]; - aoFooterCallback: FooterCallback[]; - aoDrawCallback: DrawCallback[]; - aoRowCreatedCallback: RowCreatedCallback[]; - aoPreDrawCallback: PreDrawCallback[]; - aoInitComplete: InitComplete[]; - aoStateSaveParams: StateSaveParams[]; - aoStateLoadParams: StateLoadParams[]; - aoStateLoaded: StateLoaded[]; - sTableId: string; - nTable: Node; - nTHead: Node; - nTFoot: Node; - nTBody: Node; - nTableWrapper: Node; - bDeferLoading: boolean; - bInitialized: boolean; - aoOpenRows: any[]; - sDom: string; - sPaginationType: string; - iCookieDuration: number; - sCookiePrefix: string; - fnCookieCallback: CookieCallback; - aoStateSave: StateSaveCallback[]; - aoStateLoad: StateLoadCallback[]; - oLoadedState: any; - sAjaxSource: string; - sAjaxDataProp: string; - bAjaxDataGet: boolean; - jqXHR: any; - fnServerData: any; - aoServerParams: any[]; - sServerMethod: string; - fnFormatNumber: FormatNumber; - aLengthMenu: any[]; - iDraw: number; - bDrawing: boolean; - iDrawError: number; - _iDisplayLength: number; - _iDisplayStart: number; - _iDisplayEnd: number; - _iRecordsTotal: number; - _iRecordsDisplay: number; - bJUI: boolean; - oClasses: any; - bFiltered: boolean; - bSorted: boolean; - bSortCellsTop: boolean; - oInit: any; - aoDestroyCallback: any[]; - fnRecordsTotal: () => number; - fnRecordsDisplay: () => number; - fnDisplayEnd: () => number; - oInstance : any; - sInstance: string; - iTabIndex: number; - nScrollHead: Node; - nScrollFoot: Node; - } - - export interface Features - { - bAutoWidth: boolean; - bDeferRender: boolean; - bFilter: boolean; - bInfo: boolean; - bLengthChange: boolean; - bPaginate: boolean; - bProcessing: boolean; - bServerSide: boolean; - bSort: boolean; - bSortClasses: boolean; - bStateSave: boolean; - } - - export interface ScrollingSettings - { - bAutoCss : boolean; - bCollapse: boolean; - bInfinite: boolean; - iBarWidth: number; - iLoadGap: number; - sX: string; - sY: string; - } - - export interface Row - { - nTr: Node; - _aData: any; - _aSortData: any[]; - _anHidden: Node[]; - _sRowStripe: string; - } - - export interface Column - { - aDataSort: any; - asSorting: string[]; - bSearchable : boolean; - bSortable : boolean; - bVisible : boolean; - _bAutoType : boolean; - fnCreatedCell: CreatedCell; - fnGetData: (data: any, specific: string) => any; - fnSetData: (data: any, value: any) => void; - mData: any; - mRender: any; - nTh: Node; - nIf: Node; - sClass: string; - sContentPadding: string; - sDefaultContent: string; - sName: string; - sSortDataType: string; - sSortingClass: string; - sSortingClassJUI: string; - sTitle: string; - sType: string; - sWidth: string; - sWidthOrig: string; - } - - export interface CookieCallback - { - (name: string, data: any, expires: string, path: string, cookie: string) : void; - } - - export interface RowCreatedCallback - { - (row: Node, data: any[], dataIndex: number) : void; - } - - export interface DrawCallback - { - (settings: Settings) : void; - } - - export interface FooterCallback - { - (foot: Element, data: any[], start:number, end:number, display: number[]) : void; - } - - export interface FormatNumber - { - (toFormat: number) : string; - } - - export interface HeaderCallback - { - (head: Element, data: any[], start:number, end:number, display: number[]) : void; - } - - export interface InfoCallback - { - (settings: Settings, start: number, end: number, max:number, total: number, pre: string) : string; - } - - export interface InitComplete - { - (settings: Settings, json: any) : void; - } - - export interface PreDrawCallback - { - (settings: Settings) : boolean; - } - - export interface RowCallback - { - (row : Settings, data: any[], displayIndex: number, displayIndexFull: number) : void; - } - - export interface StateLoadCallback - { - (settings: Settings) : any; - } - - export interface StateLoadParams - { - (settings: Settings, data: any) : void; - } - - export interface StateLoaded - { - (settings: Settings, data: any) : void; - } - - export interface StateSaveCallback - { - (settings: any, data:any) : void; - } - - export interface StateSaveParams - { - (settings: any, data:any) : void; - } - - export interface CreatedCell - { - (nTd: Node, cellData: any, rowData: any, row: number, col: number) : void; - } -} diff --git a/jquery.payment/tsconfig.json b/jquery.payment/tsconfig.json index cdcaca971c..48dedd0dff 100644 --- a/jquery.payment/tsconfig.json +++ b/jquery.payment/tsconfig.json @@ -14,6 +14,7 @@ "forceConsistentCasingInFileNames": true }, "files": [ - "index.d.ts" + "index.d.ts", + "jquery.payment-tests.ts" ] } \ No newline at end of file diff --git a/js-base64/js-base64-test.ts b/js-base64/js-base64-tests.ts similarity index 90% rename from js-base64/js-base64-test.ts rename to js-base64/js-base64-tests.ts index c10943df2e..275547d296 100644 --- a/js-base64/js-base64-test.ts +++ b/js-base64/js-base64-tests.ts @@ -1,5 +1,3 @@ -/// - import { Base64 } from 'js-base64' Base64.encode('dankogai'); // ZGFua29nYWk= diff --git a/js-base64/tsconfig.json b/js-base64/tsconfig.json index cdcaca971c..89dca69d28 100644 --- a/js-base64/tsconfig.json +++ b/js-base64/tsconfig.json @@ -14,6 +14,7 @@ "forceConsistentCasingInFileNames": true }, "files": [ - "index.d.ts" + "index.d.ts", + "js-base64-tests.ts" ] } \ No newline at end of file diff --git a/js-combinatorics/js-combinatorics-global-tests.ts b/js-combinatorics/js-combinatorics-global-tests.ts deleted file mode 100644 index 2bdddc9897..0000000000 --- a/js-combinatorics/js-combinatorics-global-tests.ts +++ /dev/null @@ -1,99 +0,0 @@ - - -const p:number = Combinatorics.P(1, 2); -const c:number = Combinatorics.C(1, 2); -const factorial:number = Combinatorics.factorial(5); -const factoradic:number[] = Combinatorics.factoradic(5); - -const power = Combinatorics.power(["a", "b", "c"]); -const nextPower:string[] = power.next(); -power.forEach((i:string[]) => console.log(i)); -const powersLengths:number[] = power.map((i:string[]) => i.length); -const filteredPowers:string[][] = power.filter((i:string[]) => i.length > 0); -const allPowers:string[][] = power.toArray(); -const powersCount = power.length; -const nthPower:string[] = power.nth(3); - -const limitedCombination = Combinatorics.combination(["a", "b", "c"], 2); -const combination = Combinatorics.combination(["a", "b", "c"]); -const nextCombination:string[] = combination.next(); -combination.forEach((i:string[]) => console.log(i)); -const combinationsLengths:number[] = combination.map((i:string[]) => i.length); -const filteredCombinations:string[][] = combination.filter((i:string[]) => i.length > 0); -const allCombinations:string[][] = combination.toArray(); -const combinationsCount = combination.length; - -const limitedPermutation = Combinatorics.permutation(["a", "b", "c"], 2); -const permutation = Combinatorics.permutation(["a", "b", "c"]); -const nextPermutation:string[] = permutation.next(); -permutation.forEach((i:string[]) => console.log(i)); -const permutationsLengths:number[] = permutation.map((i:string[]) => i.length); -const filteredPermutations:string[][] = permutation.filter((i:string[]) => i.length > 0); -const allPermutations:string[][] = permutation.toArray(); -const permutationsCount = permutation.length; - -const permutationCombination = Combinatorics.permutationCombination(["a", "b", "c"]); -const nextPermutationCombinations:string[] = permutationCombination.next(); -permutationCombination.forEach((i:string[]) => console.log(i)); -const permutationCombinationsLengths:number[] = permutationCombination.map((i:string[]) => i.length); -const filteredPermutationCombinationss:string[][] = permutationCombination.filter((i:string[]) => i.length > 0); -const allPermutationCombinationss:string[][] = permutationCombination.toArray(); -const permutationCombinationsCount = permutationCombination.length; - -const limitedBaseN = Combinatorics.baseN(["a", "b", "c"], 2); -const baseN = Combinatorics.baseN(["a", "b", "c"]); -const nextbaseN:string[] = baseN.next(); -baseN.forEach((i:string[]) => console.log(i)); -const baseNsLengths:number[] = baseN.map((i:string[]) => i.length); -const filteredbaseNs:string[][] = baseN.filter((i:string[]) => i.length > 0); -const allbaseNs:string[][] = baseN.toArray(); -const baseNsCount = baseN.length; -const nthbaseN:string[] = baseN.nth(3); - -const cartesianProduct1 = Combinatorics.cartesianProduct(["a", "b", "c"]); -const nextCartesianProduct1:[string] = cartesianProduct1.next(); -const nextCartesianProduct1Char = nextCartesianProduct1[0].substr(0, 1); -cartesianProduct1.forEach((i:[string]) => console.log(i)); -const cartesianProduct1sLengths:number[] = cartesianProduct1.map((i:[string]) => i.length); -const filteredCartesianProduct1s:[string][] = cartesianProduct1.filter((i:[string]) => i.length > 0); -const allCartesianProduct1s:[string][] = cartesianProduct1.toArray(); -const cartesianProduct1sCount = cartesianProduct1.length; -const nthCartesianProduct1:[string] = cartesianProduct1.nth(3); -const cartesianProduct1ByCoords:[string] = cartesianProduct1.get(1); - -const cartesianProduct2 = Combinatorics.cartesianProduct(["a", "b", "c"], [1, 2, 3]); -const nextCartesianProduct2:[string, number] = cartesianProduct2.next(); -const nextCartesianProduct2Char = nextCartesianProduct2[0].substr(0, 1); -const nextCartesianProduct2Num = nextCartesianProduct2[1].toFixed(2); -cartesianProduct2.forEach((i:[string, number]) => console.log(i)); -const cartesianProduct2sLengths:number[] = cartesianProduct2.map((i:[string, number]) => i.length); -const filteredCartesianProduct2s:[string, number][] = cartesianProduct2.filter((i:[string, number]) => i.length > 0); -const allCartesianProduct2s:[string, number][] = cartesianProduct2.toArray(); -const cartesianProduct2sCount = cartesianProduct2.length; -const nthCartesianProduct2:[string, number] = cartesianProduct2.nth(3); -const cartesianProduct2ByCoords:[string, number] = cartesianProduct2.get(1, 1); - -const cartesianProduct3 = Combinatorics.cartesianProduct(["a", "b", "c"], [1, 2, 3], [true, false]); -const nextCartesianProduct3:[string, number, boolean] = cartesianProduct3.next(); -const nextCartesianProduct3Char = nextCartesianProduct3[0].substr(0, 1); -const nextCartesianProduct3Num = nextCartesianProduct3[1].toFixed(2); -const nextCartesianProduct4Cond = nextCartesianProduct3[2] === true; -cartesianProduct3.forEach((i:[string, number, boolean]) => console.log(i)); -const cartesianProduct3sLengths:number[] = cartesianProduct3.map((i:[string, number, boolean]) => i.length); -const filteredCartesianProduct3s:[string, number, boolean][] = cartesianProduct3.filter((i:[string, number, boolean]) => i.length > 0); -const allCartesianProduct3s:[string, number, boolean][] = cartesianProduct3.toArray(); -const cartesianProduct3sCount = cartesianProduct3.length; -const nthCartesianProduct3:[string, number, boolean] = cartesianProduct3.nth(3); -const cartesianProduct3ByCoords:[string, number, boolean] = cartesianProduct3.get(1, 1); - -const cartesianProductAny = Combinatorics.cartesianProduct(["a", 1, true], [false, 2, "b"]); -const nextCartesianProductAny:any[] = cartesianProductAny.next(); -cartesianProductAny.forEach((i:any[]) => console.log(i)); -const cartesianProductAnysLengths:number[] = cartesianProductAny.map((i:any[]) => i.length); -const filteredCartesianProductAnys:any[][] = cartesianProductAny.filter((i:any[]) => i.length > 0); -const allCartesianProductAnys:any[][] = cartesianProductAny.toArray(); -const cartesianProductAnysCount = cartesianProductAny.length; -const nthCartesianProductAny:any[] = cartesianProductAny.nth(3); -const cartesianProductAnyByCoords:any[] = cartesianProductAny.get(1, 1); - -const version:string = Combinatorics.VERSION; diff --git a/js-combinatorics/js-combinatorics-global.d.ts b/js-combinatorics/js-combinatorics-global.d.ts deleted file mode 100644 index b3a4b7b49a..0000000000 --- a/js-combinatorics/js-combinatorics-global.d.ts +++ /dev/null @@ -1,8 +0,0 @@ -// Type definitions for js-combinatorics v0.5.0 (global) -// Project: https://github.com/dankogai/js-combinatorics -// Definitions by: Vasya Aksyonov -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - - - -import Combinatorics = __Combinatorics; diff --git a/js-data/js-data-node-tests.ts b/js-data/js-data-node-tests.ts deleted file mode 100644 index 7317132605..0000000000 --- a/js-data/js-data-node-tests.ts +++ /dev/null @@ -1,15 +0,0 @@ -/// - -import JSData = require('js-data'); -import DSHttpAdapter = require('js-data-http') -var store = new JSData.DS(); - -// register and use http by default for async operations -store.registerAdapter('redis', new DSHttpAdapter(), {default: true}); - -// simplest model definition -var User = store.defineResource('user'); - -User.find(1).then(function (user: any) { - user; // { id: 1, name: 'John' } -}); diff --git a/js-data/legacy/js-data-node-1.5.4-tests.ts b/js-data/legacy/js-data-node-1.5.4-tests.ts deleted file mode 100644 index 547643fed0..0000000000 --- a/js-data/legacy/js-data-node-1.5.4-tests.ts +++ /dev/null @@ -1,11 +0,0 @@ - - -import JSData = require('js-data'); -var store = new JSData.DS(); - -// simplest model definition -var User = store.defineResource('user'); - -User.find(1).then(function (user: any) { - user; // { id: 1, name: 'John' } -}); diff --git a/js-data/legacy/index.d.ts b/js-data/v1/index.d.ts similarity index 100% rename from js-data/legacy/index.d.ts rename to js-data/v1/index.d.ts diff --git a/js-data/legacy/js-data-1.5.4-tests.ts b/js-data/v1/js-data-tests.ts similarity index 100% rename from js-data/legacy/js-data-1.5.4-tests.ts rename to js-data/v1/js-data-tests.ts diff --git a/js-data/v1/tsconfig.json b/js-data/v1/tsconfig.json new file mode 100644 index 0000000000..c0af79f5ce --- /dev/null +++ b/js-data/v1/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "target": "es6", + "noImplicitAny": true, + "noImplicitThis": false, + "strictNullChecks": false, + "baseUrl": "../../", + "typeRoots": [ + "../../" + ], + "types": [], + "paths": { + "js-data": ["js-data/v1"] + }, + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "js-data-tests.ts" + ] +} \ No newline at end of file diff --git a/js-quantities/js-quantities-tests.ts b/js-quantities/js-quantities-tests.ts index b1916bb626..f743d9a8e5 100644 --- a/js-quantities/js-quantities-tests.ts +++ b/js-quantities/js-quantities-tests.ts @@ -1,5 +1,5 @@ -import "../jasmine"; -import Qty from "."; +/// +import Qty from "js-quantities"; // From project readme diff --git a/jsfl/tsconfig.json b/jsfl/tsconfig.json index bf97b93a4d..9549c831eb 100644 --- a/jsfl/tsconfig.json +++ b/jsfl/tsconfig.json @@ -14,6 +14,7 @@ "forceConsistentCasingInFileNames": true }, "files": [ - "index.d.ts" + "index.d.ts", + "xJSFL.d.ts" ] } \ No newline at end of file diff --git a/jsfl/xJSFL.d.ts b/jsfl/xJSFL.d.ts index 868f9d1391..3e0be6e4e8 100644 --- a/jsfl/xJSFL.d.ts +++ b/jsfl/xJSFL.d.ts @@ -3,7 +3,7 @@ // Definitions by: soywiz // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -/// +/// interface _xjsfl { init(_this: any): void; diff --git a/jssha/jssha-1.6.0-tests.ts b/jssha/jssha-1.6.0-tests.ts deleted file mode 100644 index f0df88f7fe..0000000000 --- a/jssha/jssha-1.6.0-tests.ts +++ /dev/null @@ -1,15 +0,0 @@ - -/// - -var imported = require("jssha"); - -var shaObj1:jsSHA.jsSHA = new jsSHA("This is a Test", "TEXT", "UTF8"); -var shaObj2 = new imported("This is a Test", "TEXT"); - -var hash1:string = shaObj2.getHash("SHA-512", "HEX"); -var hash2:string = shaObj2.getHash("SHA-512", "HEX", 2); -var hash3:string = shaObj2.getHash("SHA-512", "HEX", 2, {outputUpper: false, b64Pad: "foobar"}); - -var format:jsSHA.OutputFormatOptions = {outputUpper: false, b64Pad: "foobar"}; -var hmac1 = shaObj2.getHMAC("SecretKey", "TEXT", "SHA-512", "HEX"); -var hmac2 = shaObj2.getHMAC("SecretKey", "TEXT", "SHA-512", "HEX", format); diff --git a/jssha/jssha-1.6.0.d.ts b/jssha/jssha-1.6.0.d.ts deleted file mode 100644 index dcde33c4a8..0000000000 --- a/jssha/jssha-1.6.0.d.ts +++ /dev/null @@ -1,65 +0,0 @@ -// Type definitions for jsSHA-1.6.0 -// Project: https://github.com/Caligatio/jsSHA -// Definitions by: David Li -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - - -declare namespace jsSHA { - export interface OutputFormatOptions { - outputUpper? : boolean; - b64Pad? : string; - } - - export interface jsSHA { - /** - * jsSHA is the workhorse of the library. Instantiate it with the string to - * be hashed as the parameter - * - * @constructor - * @this {jsSHA} - * @param {string} srcString The string to be hashed - * @param {string} inputFormat The format of srcString, HEX, TEXT, B64, or BYTES - * @param {string=} encoding The text encoding to use to encode the source - * string - */ - new (srcString:string, inputFormat:string, encoding?:string):jsSHA; - - /** - * Returns the desired SHA hash of the string specified at instantiation - * using the specified parameters - * - * @param {string} variant The desired SHA variant (SHA-1, SHA-224, - * SHA-256, SHA-384, or SHA-512) - * @param {string} format The desired output formatting (B64, HEX, or BYTES) - * @param {number=} numRounds The number of rounds of hashing to be - * executed - * @param {{outputUpper : boolean, b64Pad : string}=} outputFormatOpts - * Hash list of output formatting options - * @return {string} The string representation of the hash in the format - * specified - */ - getHash(variant:string, format:string, numRounds?:number, outputFormatOpts?:OutputFormatOptions):string; - - /** - * Returns the desired HMAC of the string specified at instantiation - * using the key and variant parameter - * - * @param {string} key The key used to calculate the HMAC - * @param {string} inputFormat The format of key, HEX, TEXT, B64, or BYTES - * @param {string} variant The desired SHA variant (SHA-1, SHA-224, - * SHA-256, SHA-384, or SHA-512) - * @param {string} outputFormat The desired output formatting - * (B64, HEX, or BYTES) - * @param {{outputUpper : boolean, b64Pad : string}=} outputFormatOpts - * associative array of output formatting options - * @return {string} The string representation of the hash in the format - * specified - */ - getHMAC(key:string, inputFormat:string, variant:string, outputFormat:string, outputFormatOpts?:OutputFormatOptions):string; - } -} - -declare var jsSHA: jsSHA.jsSHA; -declare module 'jssha' { - export = jsSHA; -} diff --git a/jwt-simple/jwt-simple-0.2.0-tests.ts b/jwt-simple/jwt-simple-0.2.0-tests.ts deleted file mode 100644 index 8a0cc59c52..0000000000 --- a/jwt-simple/jwt-simple-0.2.0-tests.ts +++ /dev/null @@ -1,12 +0,0 @@ -/// - -import jwt = require('jwt-simple'); -var payload = { foo: 'bar' }; -var secret:string = 'xxx'; - -// encode -var token = jwt.encode(payload, secret); - -// decode -var decoded = jwt.decode(token, secret); -console.log(decoded); //=> { foo: 'bar' } \ No newline at end of file diff --git a/jwt-simple/jwt-simple-0.2.0.d.ts b/jwt-simple/jwt-simple-0.2.0.d.ts deleted file mode 100644 index 0ee3cc6799..0000000000 --- a/jwt-simple/jwt-simple-0.2.0.d.ts +++ /dev/null @@ -1,22 +0,0 @@ -// Type definitions for jwt-simple v0.2.0 -// Project: https://github.com/hokaccha/node-jwt-simple -// Definitions by: Ken Fukuyama -// Definitions: https://github.com/borisyankov/DefinitelyTyped -declare module "jwt-simple" { - /** - * Decode jwt - * @param token - * @param key - * @param noVerify - * @api public - */ - export function decode(token:any, key:string, noVerify?:boolean):any; - /** - * Encode jwt - * @param payload - * @param key - * @param algorithm default is HS256 - * @api public - */ - export function encode(payload:any, key:string, algorithm?:string):string; -} diff --git a/karma/karma-0.12-tests.ts b/karma/karma-0.12-tests.ts deleted file mode 100644 index 7e2c7230db..0000000000 --- a/karma/karma-0.12-tests.ts +++ /dev/null @@ -1,25 +0,0 @@ - - -import gulp = require('gulp'); -import karma = require('karma'); - -function runKarma(singleRun: boolean): void { - karma.server.start({ - configFile: __dirname + '/karma.conf.js', - singleRun: singleRun - }); -} - -gulp.task('test:unit:karma', ['build:test:unit'], () => runKarma(true)); - - -karma.server.start({port: 9876}, (exitCode: number) => { - console.log('Karma has exited with ' + exitCode); - process.exit(exitCode); -}); - - -karma.runner.run({port: 9876}, (exitCode: number) => { - console.log('Karma has exited with ' + exitCode); - process.exit(exitCode); -}); diff --git a/karma/karma-0.12.d.ts b/karma/karma-0.12.d.ts deleted file mode 100644 index dc9939d205..0000000000 --- a/karma/karma-0.12.d.ts +++ /dev/null @@ -1,23 +0,0 @@ -// Type definitions for karma v0.12.37 -// Project: https://github.com/karma-runner/karma -// Definitions by: Tanguy Krotoff -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - - -// See Karma public API https://karma-runner.github.io/0.12/dev/public-api.html - -interface IKarmaServer { - start(options?: any, callback?: (exitCode: number) => void): void; -} - -interface IKarmaRunner { - run(options?: any, callback?: (exitCode: number) => void): void; -} - -interface IKarma { - server: IKarmaServer; - runner: IKarmaRunner; -} - -declare var karma: IKarma; -export = karma; diff --git a/knockout/all-tests.ts b/knockout/all-tests.ts deleted file mode 100644 index 1890561ac8..0000000000 --- a/knockout/all-tests.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -/// -/// diff --git a/knockout/knockoutamd-tests.ts b/knockout/knockoutamd-tests.ts deleted file mode 100644 index dbf407afd2..0000000000 --- a/knockout/knockoutamd-tests.ts +++ /dev/null @@ -1,11 +0,0 @@ - - -import ko = require("knockout"); - -var myArray = ko.observableArray([1, 2, 3]); - -class MyViewModel { - name = ko.observable("Jeff"); -} - -ko.applyBindings(new MyViewModel()); diff --git a/knockout/tests/index.d.ts b/knockout/tests/index.d.ts deleted file mode 100644 index 6188d49475..0000000000 --- a/knockout/tests/index.d.ts +++ /dev/null @@ -1,15 +0,0 @@ -// Type definitions for Knockout specs -// Project: http://knockoutjs.com -// Definitions by: Boris Yankov , Igor Oleinikov , Clément Bourgeois -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -// Knockout specs depend on custom Jasmine matchers -// See https://github.com/knockout/knockout/blob/v3.4.0/spec/lib/jasmine.extensions.js -// FYI jasmine-jquery.d.ts (https://github.com/velesin/jasmine-jquery) also defines toContainHtml() and toContainText() - -declare namespace jasmine { - interface Matchers { - toContainHtml(expected: string): boolean; - toContainText(expected: string): boolean; - } -} diff --git a/knockout/tests/knockout-templatingBehaviors-tests.ts b/knockout/tests/knockout-templatingBehaviors-tests.ts index 213ee06f15..7052b716f5 100644 --- a/knockout/tests/knockout-templatingBehaviors-tests.ts +++ b/knockout/tests/knockout-templatingBehaviors-tests.ts @@ -1,6 +1,13 @@ /// /// +declare namespace jasmine { + interface Matchers { + toContainHtml(expected: string): boolean; + toContainText(expected: string): boolean; + } +} + var dummyTemplateEngine = function (templates?) { var inMemoryTemplates = templates || {}; var inMemoryTemplateData = {}; diff --git a/knockout/tsconfig.json b/knockout/tsconfig.json index 18dd8dd7b5..04246314bb 100644 --- a/knockout/tsconfig.json +++ b/knockout/tsconfig.json @@ -15,6 +15,7 @@ }, "files": [ "index.d.ts", - "all-tests.ts" + "tests/knockout-templatingBehaviors-tests.ts", + "tests/knockout-tests.ts" ] } \ No newline at end of file diff --git a/koa/koa-1.1.2-tests.ts b/koa/koa-1.1.2-tests.ts deleted file mode 100644 index f9d908a47c..0000000000 --- a/koa/koa-1.1.2-tests.ts +++ /dev/null @@ -1,26 +0,0 @@ - - -import * as Koa from 'koa'; -var app = new Koa(); - -// logger - -app.use(function *(next: Function) { - // at present, we can not typing 'this' in function - // but there is a proposal: https://github.com/Microsoft/TypeScript/issues/3694 - var ctx: Koa.Context = this; - - var start = new Date; - yield next; - var ms = new Date - start; - console.log('%s %s - %s', ctx.method, ctx.url, ms); -}); - -// response - -app.use(function *(): Iterable { - var ctx: Koa.Context = this; - ctx.body = 'Hello World'; -}); - -app.listen(3000); diff --git a/koa/koa-1.1.2.d.ts b/koa/koa-1.1.2.d.ts deleted file mode 100644 index 25361cf4d7..0000000000 --- a/koa/koa-1.1.2.d.ts +++ /dev/null @@ -1,592 +0,0 @@ - - - -import * as net from 'net'; -import * as http from 'http'; -import * as events from 'events'; -import * as Cookies from 'cookies'; - -interface IRequest extends Koa.Request { - /** - * Return request header. - * - * @readonly - */ - header: any; - /** - * Return request header, alias as request.header - * - * @readonly - */ - headers: any; - /** - * Get/Set request URL. - */ - url: string; - /** - * Get origin of URL. - */ - origin: string; - /** - * Get full request URL. - * - * @readonly - */ - href: string; - /** - * Get/Set request method. - */ - method: string; - /** - * Get request pathname. - * Set pathname, retaining the query-string when present. - */ - path: string; - /** - * Get parsed query-string. - * Set query-string as an object. - */ - query: any; - /** - * Get/Set query string. - */ - querystring: string; - /** - * Get the search string. Same as the querystring except it includes the leading ?. - * Set the search string. Same as response.querystring= but included for ubiquity. - */ - search: string; - /** - * Parse the "Host" header field host and support X-Forwarded-Host when a proxy is enabled. - * - * @readonly - */ - host: string; - /** - * Parse the "Host" header field hostname and support X-Forwarded-Host when a proxy is enabled. - * - * @readonly - */ - hostname: string; - /** - * Check if the request is fresh, aka - * Last-Modified and/or the ETag - * still match. - * - * @readonly - */ - fresh: boolean; - /** - * Check if the request is stale, aka - * "Last-Modified" and / or the "ETag" for the - * resource has changed. - * - * @readonly - */ - stale: boolean; - /** - * Check if the request is idempotent. - * - * @readonly - */ - idempotent: boolean; - /** - * Return the request socket. - * - * @readonly - */ - socket: net.Socket; - /** - * Return the protocol string "http" or "https" - * when requested with TLS. When the proxy setting - * is enabled the "X-Forwarded-Proto" header - * field will be trusted. If you're running behind - * a reverse proxy that supplies https for you this - * may be enabled. - * - * @readonly - */ - protocol: string; - /** - * Short-hand for: - * - * this.protocol == 'https' - * - * @readonly - */ - secure: boolean; - /** - * Return the remote address, or when - * `app.proxy` is `true` return - * the upstream addr. - * - * @readonly - */ - ip: string; - /** - * When `app.proxy` is `true`, parse - * the "X-Forwarded-For" ip address list. - * - * For example if the value were "client, proxy1, proxy2" - * you would receive the array `["client", "proxy1", "proxy2"]` - * where "proxy2" is the furthest down-stream. - * - * @readonly - */ - ips: string[]; - /** - * Return subdomains as an array. - * - * Subdomains are the dot-separated parts of the host before the main domain of - * the app. By default, the domain of the app is assumed to be the last two - * parts of the host. This can be changed by setting `app.subdomainOffset`. - * - * For example, if the domain is "tobi.ferrets.example.com": - * If `app.subdomainOffset` is not set, this.subdomains is `["ferrets", "tobi"]`. - * If `app.subdomainOffset` is 3, this.subdomains is `["tobi"]`. - * - * @readonly - */ - subdomains: string[]; - /** - * Check if the given `type(s)` is acceptable, returning - * the best match when true, otherwise `undefined`, in which - * case you should respond with 406 "Not Acceptable". - * - * The `type` value may be a single mime type string - * such as "application/json", the extension name - * such as "json" or an array `["json", "html", "text/plain"]`. When a list - * or array is given the _best_ match, if any is returned. - * - * Examples: - * - * // Accept: text/html - * this.accepts('html'); - * // => "html" - * - * // Accept: text/*, application/json - * this.accepts('html'); - * // => "html" - * this.accepts('text/html'); - * // => "text/html" - * this.accepts('json', 'text'); - * // => "json" - * this.accepts('application/json'); - * // => "application/json" - * - * // Accept: text/*, application/json - * this.accepts('image/png'); - * this.accepts('png'); - * // => undefined - * - * // Accept: text/*;q=.5, application/json - * this.accepts(['html', 'json']); - * this.accepts('html', 'json'); - * // => "json" - */ - accepts(...types: string[]): string | boolean | string[]; - accepts(types: string[]): string | boolean | string[]; - /** - * Return accepted encodings or best fit based on `encodings`. - * - * Given `Accept-Encoding: gzip, deflate` - * an array sorted by quality is returned: - * - * ['gzip', 'deflate'] - */ - acceptsEncodings(...encodings: string[]): string | string[]; - acceptsEncodings(encodings: string[]): string | string[]; - /** - * Return accepted charsets or best fit based on `charsets`. - * - * Given `Accept-Charset: utf-8, iso-8859-1;q=0.2, utf-7;q=0.5` - * an array sorted by quality is returned: - * - * ['utf-8', 'utf-7', 'iso-8859-1'] - */ - acceptsCharsets(...charsets: string[]): string | string[]; - acceptsCharsets(charsets: string[]): string | string[]; - /** - * Return accepted languages or best fit based on `langs`. - * - * Given `Accept-Language: en;q=0.8, es, pt` - * an array sorted by quality is returned: - * - * ['es', 'pt', 'en'] - */ - acceptsLanguages(...langs: string[]): string | string[]; - acceptsLanguages(langs: string[]): string | string[]; - /** - * Check if the incoming request contains the "Content-Type" - * header field, and it contains any of the give mime `type`s. - * If there is no request body, `null` is returned. - * If there is no content type, `false` is returned. - * Otherwise, it returns the first `type` that matches. - * - * Examples: - * - * // With Content-Type: text/html; charset=utf-8 - * this.is('html'); // => 'html' - * this.is('text/html'); // => 'text/html' - * this.is('text/*', 'application/json'); // => 'text/html' - * - * // When Content-Type is application/json - * this.is('json', 'urlencoded'); // => 'json' - * this.is('application/json'); // => 'application/json' - * this.is('html', 'application/*'); // => 'application/json' - * - * this.is('html'); // => false - */ - is(type: string): string | boolean; - is(types: string[]): string | boolean; - /** - * Return request header. - * - * The `Referrer` header field is special-cased, - * both `Referrer` and `Referer` are interchangeable. - * - * Examples: - * - * this.get('Content-Type'); - * // => "text/plain" - * - * this.get('content-type'); - * // => "text/plain" - * - * this.get('Something'); - * // => undefined - */ - get(field: string): string; -} - -interface IResponse extends Koa.Response { - /** - * Get/Set response status code. - */ - status: number; - /** - * Get/Set response status message - */ - message: string; - /** - * Get/Set response body. - */ - body: any; - /** - * Return parsed response Content-Length when present. - * Set Content-Length field to `n`. - */ - length: number; - /** - * Check if a header has been written to the socket. - * - * @readonly - */ - headerSent: boolean; - /** - * Vary on `field`. - */ - vary(field: string): void; - /** - * Perform a 302 redirect to `url`. - * - * The string "back" is special-cased - * to provide Referrer support, when Referrer - * is not present `alt` or "/" is used. - * - * Examples: - * - * this.redirect('back'); - * this.redirect('back', '/index.html'); - * this.redirect('/login'); - * this.redirect('http://google.com'); - */ - redirect(url: string): void; - redirect(url: string, alt: string): void; - /** - * Set Content-Disposition header to "attachment" with optional `filename`. - */ - attachment(filename: string): void; - /** - * Return the response mime type void of - * parameters such as "charset". - * - * Set Content-Type response header with `type` through `mime.lookup()` - * when it does not contain a charset. - * - * Examples: - * - * this.type = '.html'; - * this.type = 'html'; - * this.type = 'json'; - * this.type = 'application/json'; - * this.type = 'png'; - */ - type: string; - /** - * Get the Last-Modified date in Date form, if it exists. - * Set the Last-Modified date using a string or a Date. - * - * this.response.lastModified = new Date(); - * this.response.lastModified = '2013-09-13'; - */ - lastModified: Date; - /** - * Get the ETag of a response. - * Set the ETag of a response. - * This will normalize the quotes if necessary. - * - * this.response.etag = 'md5hashsum'; - * this.response.etag = '"md5hashsum"'; - * this.response.etag = 'W/"123456789"'; - */ - etag: string; - /** - * Set header `field` to `val`, or pass - * an object of header fields. - * - * Examples: - * - * this.set('Foo', ['bar', 'baz']); - * this.set('Accept', 'application/json'); - * this.set({ Accept: 'text/plain', 'X-API-Key': 'tobi' }); - */ - set(field: any): void; - set(field: string, val: string): void; - set(field: string, val: any[]): void; - /** - * Append additional header `field` with value `val`. - * - * Examples: - * - * this.append('Link', ['', '']); - * this.append('Set-Cookie', 'foo=bar; Path=/; HttpOnly'); - * this.append('Warning', '199 Miscellaneous warning'); - */ - append(field: string, val: string): void; - append(field: string, val: any[]): void; - /** - * Remove header `field`. - */ - remove(field: string): void; - /** - * Checks if the request is writable. - * Tests for the existence of the socket - * as node sometimes does not set it. - * - * @readonly - * @private - */ - writable: boolean; -} - -declare namespace koa { - interface BaseRequest extends IRequest { - /** - * Get the charset when present or undefined. - * - * @readonly - */ - charset: string; - /** - * Return parsed Content-Length when present. - * - * @readonly - */ - length: number; - /** - * Return the request mime type void of - * parameters such as "charset". - * - * @readonly - */ - type: string; - /** - * Inspect implementation. - */ - inspect(): any; - /** - * Return JSON representation. - */ - toJSON(): any; - } - - interface BaseResponse extends IResponse { - /** - * Return the request socket. - * - * @readonly - */ - socket: net.Socket; - /** - * Return response header. - * - * @readonly - */ - header: any; - /** - * Return response header, alias as response.header - */ - headers: any; - /** - * Check whether the response is one of the listed types. - * Pretty much the same as `this.request.is()`. - */ - is(type: string): string | boolean; - is(types: string[]): string | boolean; - /** - * Return response header. - * - * Examples: - * - * this.get('Content-Type'); - * // => "text/plain" - * - * this.get('content-type'); - * // => "text/plain" - */ - get(field: string): string; - /** - * Inspect implementation. - */ - inspect(): any; - /** - * Return JSON representation. - */ - toJSON(): any; - } - - interface BaseContext extends IRequest, IResponse { - /** - * util.inspect() implementation, which - * just returns the JSON output. - */ - inspect(): any; - /** - * Return JSON representation. - * - * Here we explicitly invoke .toJSON() on each - * object, as iteration will otherwise fail due - * to the getters and cause utilities such as - * clone() to fail. - */ - toJSON(): any; - /** - * Similar to .throw(), adds assertion. - * - * this.assert(this.user, 401, 'Please login!'); - * - * See: https://github.com/jshttp/http-assert - */ - assert(test: any, status: number, message: string): void; - /** - * Throw an error with `msg` and optional `status` - * defaulting to 500. Note that these are user-level - * errors, and the message may be exposed to the client. - * - * this.throw(403) - * this.throw('name required', 400) - * this.throw(400, 'name required') - * this.throw('something exploded') - * this.throw(new Error('invalid'), 400); - * this.throw(400, new Error('invalid')); - * - * See: https://github.com/jshttp/http-errors - */ - throw(...args: any[]): void; - /** - * Default error handling. - * - * @private - */ - onerror(err: Error): void; - } - - interface Request extends BaseRequest { - app: Application; - ctx: Context; - response: Response; - req: http.IncomingMessage; - res: http.ServerResponse; - } - - interface Response extends BaseResponse { - app: Application; - ctx: Context; - request: Request; - req: http.IncomingMessage; - res: http.ServerResponse; - } - - interface Context extends BaseContext { - request: Request; - response: Response; - app: Application; - req: http.IncomingMessage; - res: http.ServerResponse; - originalUrl: string; - cookies: Cookies.ICookies; - accept: any; - state: any; - } - - interface Application extends events.EventEmitter, Koa.Application { - env: string; - subdomainOffset: number; - middleware: any[]; - proxy: boolean; - context: BaseContext; - request: BaseRequest; - response: BaseResponse; - /** - * Shorthand for: - * - * http.createServer(app.callback()).listen(...) - */ - listen(port: number, hostname?: string, backlog?: number, callback?: Function): http.Server; - listen(port: number, hostname?: string, callback?: Function): http.Server; - listen(path: string, callback?: Function): http.Server; - listen(handle: any, listeningListener?: Function): http.Server; - listen(): http.Server; - /** - * Return JSON representation. - * We only bother showing settings. - */ - inspect(): any; - /** - * Return JSON representation. - * We only bother showing settings. - */ - toJSON(): any; - /** - * Use the given middleware `fn`. - */ - use(fn: Function): Application; - /** - * Return a request handler callback - * for node's native http server. - */ - callback(): (req: http.IncomingMessage, res: http.ServerResponse) => void; - /** - * Initialize a new context. - * - * @private - */ - createContext(req: http.IncomingMessage, res: http.ServerResponse): Context; - /** - * Default error handler. - * - * @private - */ - onerror(err: Error): void; - } -} - -interface KoaStatic { - new (): koa.Application; - (): koa.Application; -} - -declare var koa: KoaStatic; - -export = koa; diff --git a/leaflet/leaflet-0.7.d.ts b/leaflet/v0/index.d.ts similarity index 100% rename from leaflet/leaflet-0.7.d.ts rename to leaflet/v0/index.d.ts diff --git a/leaflet/leaflet-0.7-tests.ts b/leaflet/v0/leaflet-tests.ts similarity index 99% rename from leaflet/leaflet-0.7-tests.ts rename to leaflet/v0/leaflet-tests.ts index 1a88096002..6ca2578f1f 100644 --- a/leaflet/leaflet-0.7-tests.ts +++ b/leaflet/v0/leaflet-tests.ts @@ -1,5 +1,3 @@ -/// - // initialize the map on the "map" div with a given center and zoom var div = document.getElementById('map'); diff --git a/leaflet/v0/tsconfig.json b/leaflet/v0/tsconfig.json new file mode 100644 index 0000000000..eee9d441fa --- /dev/null +++ b/leaflet/v0/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "target": "es6", + "noImplicitAny": true, + "noImplicitThis": false, + "strictNullChecks": false, + "baseUrl": "../../", + "typeRoots": [ + "../../" + ], + "types": [], + "paths": { + "leaflet": ["leaflet/v0"] + }, + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "leaflet-tests.ts" + ] +} \ No newline at end of file diff --git a/leapmotionts/leapmotionts-tests.ts b/leapmotionts/leapmotionts-tests.ts index 69512e4a37..fc3d62bb1c 100644 --- a/leapmotionts/leapmotionts-tests.ts +++ b/leapmotionts/leapmotionts-tests.ts @@ -1,4 +1,4 @@ -import Leap = require('./'); +import Leap = require('leapmotionts'); var controller: Leap.Controller = new Leap.Controller(); controller.addEventListener(Leap.LeapEvent.LEAPMOTION_FRAME, (event: Leap.LeapEvent) => { diff --git a/loader-runner/tsconfig.json b/loader-runner/tsconfig.json index 6701839e52..d87ded872d 100644 --- a/loader-runner/tsconfig.json +++ b/loader-runner/tsconfig.json @@ -15,6 +15,6 @@ }, "files": [ "index.d.ts", - "loader-runner-tests" + "loader-runner-tests.ts" ] } \ No newline at end of file diff --git a/locutus/locutus_print.ts b/locutus/scripts/locutus_print.ts similarity index 100% rename from locutus/locutus_print.ts rename to locutus/scripts/locutus_print.ts diff --git a/lodash-es/tsconfig.json b/lodash-es/tsconfig.json index 916fea3909..7d7453cd56 100644 --- a/lodash-es/tsconfig.json +++ b/lodash-es/tsconfig.json @@ -158,6 +158,7 @@ "max/index.d.ts", "maxBy/index.d.ts", "mean/index.d.ts", + "meanBy/index.d.ts", "memoize/index.d.ts", "merge/index.d.ts", "mergeWith/index.d.ts", diff --git a/lodash/generate-modules.ts b/lodash/scripts/generate-modules.ts similarity index 100% rename from lodash/generate-modules.ts rename to lodash/scripts/generate-modules.ts diff --git a/lodash/tsconfig.json b/lodash/tsconfig.json index 2d3c5c2b3a..3d17028275 100644 --- a/lodash/tsconfig.json +++ b/lodash/tsconfig.json @@ -158,6 +158,7 @@ "max/index.d.ts", "maxBy/index.d.ts", "mean/index.d.ts", + "meanBy/index.d.ts", "memoize/index.d.ts", "merge/index.d.ts", "mergeWith/index.d.ts", diff --git a/lodash/legacy/lodash-3.10.d.ts b/lodash/v3/index.d.ts similarity index 100% rename from lodash/legacy/lodash-3.10.d.ts rename to lodash/v3/index.d.ts diff --git a/lodash/legacy/lodash-3.10-tests.ts b/lodash/v3/lodash-tests.ts similarity index 99% rename from lodash/legacy/lodash-3.10-tests.ts rename to lodash/v3/lodash-tests.ts index a357d93f80..8ce09add75 100644 --- a/lodash/legacy/lodash-3.10-tests.ts +++ b/lodash/v3/lodash-tests.ts @@ -1,5 +1,3 @@ -/// - declare var $: any, jQuery: any; interface IFoodOrganic { @@ -2927,13 +2925,11 @@ namespace TestPlant { // _.prototype.reverse namespace TestReverse { { - let result: _.LoDashImplicitArrayWrapper; - result: _([42]).reverse(); + let result: _.LoDashImplicitArrayWrapper = _([42]).reverse(); } { - let result: _.LoDashExplicitArrayWrapper; - result: _([42]).chain().reverse(); + let result: _.LoDashExplicitArrayWrapper = _([42]).chain().reverse(); } } @@ -9970,78 +9966,63 @@ namespace TestCallback { // _.constant namespace TestConstant { { - let result: () => number; - result: _.constant(42); + let result: () => number = _.constant(42); } { - let result: () => string; - result: _.constant('a'); + let result: () => string = _.constant('a'); } { - let result: () => boolean; - result: _.constant(true); + let result: () => boolean = _.constant(true); } { - let result: () => string[]; - result: _.constant(['a']); + let result: () => string[] = _.constant(['a']); } { - let result: () => {a: string}; - result: _.constant<{a: string}>({a: 'a'}); + let result: () => {a: string} = _.constant<{a: string}>({a: 'a'}); } { - let result: _.LoDashImplicitObjectWrapper<() => number>; - result: _(42).constant(); + let result: _.LoDashImplicitObjectWrapper<() => number> = _(42).constant(); } { - let result: _.LoDashImplicitObjectWrapper<() => string>; - result: _('a').constant(); + let result: _.LoDashImplicitObjectWrapper<() => string> = _('a').constant(); } { - let result: _.LoDashImplicitObjectWrapper<() => boolean>; - result: _(true).constant(); + let result: _.LoDashImplicitObjectWrapper<() => boolean> = _(true).constant(); } { - let result: _.LoDashImplicitObjectWrapper<() => string[]>; - result: _(['a']).constant(); + let result: _.LoDashImplicitObjectWrapper<() => string[]> = _(['a']).constant(); } { - let result: _.LoDashImplicitObjectWrapper<() => {a: string}>; - result: _({a: 'a'}).constant<{a: string}>(); + let result: _.LoDashImplicitObjectWrapper<() => {a: string}> = _({a: 'a'}).constant<{a: string}>(); } { - let result: _.LoDashExplicitObjectWrapper<() => number>; - result: _(42).chain().constant(); + let result: _.LoDashExplicitObjectWrapper<() => number> = _(42).chain().constant(); } { - let result: _.LoDashExplicitObjectWrapper<() => string>; - result: _('a').chain().constant(); + let result: _.LoDashExplicitObjectWrapper<() => string> = _('a').chain().constant(); } { - let result: _.LoDashExplicitObjectWrapper<() => boolean>; - result: _(true).chain().constant(); + let result: _.LoDashExplicitObjectWrapper<() => boolean> = _(true).chain().constant(); } { - let result: _.LoDashExplicitObjectWrapper<() => string[]>; - result: _(['a']).chain().constant(); + let result: _.LoDashExplicitObjectWrapper<() => string[]> = _(['a']).chain().constant(); } { - let result: _.LoDashExplicitObjectWrapper<() => {a: string}>; - result: _({a: 'a'}).chain().constant<{a: string}>(); + let result: _.LoDashExplicitObjectWrapper<() => {a: string}> = _({a: 'a'}).chain().constant<{a: string}>(); } } diff --git a/lodash/v3/tsconfig.json b/lodash/v3/tsconfig.json new file mode 100644 index 0000000000..3cf7aba4f3 --- /dev/null +++ b/lodash/v3/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "target": "es6", + "noImplicitAny": true, + "noImplicitThis": false, + "strictNullChecks": false, + "baseUrl": "../../", + "typeRoots": [ + "../../" + ], + "types": [], + "paths": { + "lodash": ["lodash/v3"] + }, + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "lodash-tests.ts" + ] +} \ No newline at end of file diff --git a/mapbox-gl/mapbox-gl-0.25.1.d.ts b/mapbox-gl/mapbox-gl-0.25.1.d.ts deleted file mode 100644 index 2ee8d30949..0000000000 --- a/mapbox-gl/mapbox-gl-0.25.1.d.ts +++ /dev/null @@ -1,936 +0,0 @@ -// Type definitions for Mapbox GL JS v0.24.0 -// Project: https://github.com/mapbox/mapbox-gl-js -// Definitions by: Dominik Bruderer -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -/// - -declare namespace mapboxgl { - let accessToken: string; - let version: string; - export function supported(options?: {failIfMajorPerformanceCaveat?: boolean}): boolean; - - /** - * Map - */ - export class Map extends Evented { - constructor(options?: MapboxOptions); - - addControl(control: Control): this; - - addClass(klass: string, options?: mapboxgl.StyleOptions): this; - - removeClass(klass: string, options?: mapboxgl.StyleOptions): this; - - setClasses(klasses: string[], options?: mapboxgl.StyleOptions): this; - - hasClass(klass: string): boolean; - - getClasses(): string[]; - - resize(): this; - - getBounds(): mapboxgl.LngLatBounds; - - setMaxBounds(lnglatbounds?: mapboxgl.LngLatBounds | number[][]): this; - - setMinZoom(minZoom?: number): this; - - setMaxZoom(maxZoom?: number): this; - - project(lnglat: mapboxgl.LngLat | number[]): mapboxgl.Point; - - unproject(point: mapboxgl.Point | number[]): mapboxgl.LngLat; - - queryRenderedFeatures(pointOrBox?: mapboxgl.Point|number[]|mapboxgl.Point[]|number[][], parameters?: {layers?: string[], filter?: any[]}): GeoJSON.Feature[]; - - querySourceFeatures(sourceID: string, parameters: {sourceLayer?: string, filter?: any[]}): GeoJSON.Feature[]; - - setStyle(style: mapboxgl.Style | string): this; - - getStyle(): mapboxgl.Style; - - addSource(id: string, source: VectorSource | RasterSource | GeoJSONSource | ImageSource | VideoSource | GeoJSONSourceRaw): this; - - removeSource(id: string): this; - - getSource(id: string): VectorSource | RasterSource | GeoJSONSource | ImageSource | VideoSource; - - addLayer(layer: mapboxgl.Layer, before?: string): this; - - removeLayer(id: string): this; - - getLayer(id: string): mapboxgl.Layer; - - setFilter(layer: string, filter: any[]): this; - - setLayerZoomRange(layerId: string, minzoom: number, maxzoom: number): this; - - getFilter(layer: string): any[]; - - setPaintProperty(layer: string, name: string, value: any, klass?: string): this; - - getPaintProperty(layer: string, name: string, klass?: string): any; - - setLayoutProperty(layer: string, name: string, value: any): this; - - getLayoutProperty(layer: string, name: string, klass?: string): any; - - getContainer(): HTMLElement; - - getCanvasContainer(): HTMLElement; - - getCanvas(): HTMLCanvasElement; - - loaded(): boolean; - - remove(): void; - - onError(): void; - - showTileBoundaries: boolean; - - showCollisionBoxes: boolean; - - repaint: boolean; - - getCenter(): mapboxgl.LngLat; - - setCenter(center: LngLat|number[], eventData?: mapboxgl.EventData): this; - - panBy(offset: number[], options?: mapboxgl.AnimationOptions, eventData?: mapboxgl.EventData): this; - - panTo(lnglat: mapboxgl.LngLat, options?: mapboxgl.AnimationOptions, eventdata?: mapboxgl.EventData): this; - - getZoom(): number; - - setZoom(zoom: number, eventData?: mapboxgl.EventData): this; - - zoomTo(zoom: number, options?: mapboxgl.AnimationOptions, eventData?: mapboxgl.EventData): this; - - zoomIn(options?: mapboxgl.AnimationOptions, eventData?: mapboxgl.EventData): this; - - zoomOut(options?: mapboxgl.AnimationOptions, eventData?: mapboxgl.EventData): this; - - getBearing(): number; - - setBearing(bearing: number, eventData?: mapboxgl.EventData): this; - - rotateTo(bearing: number, options?: mapboxgl.AnimationOptions, eventData?: EventData): this; - - resetNorth(options?: mapboxgl.AnimationOptions, eventData?: mapboxgl.EventData): this; - - snapToNorth(options?: mapboxgl.AnimationOptions, eventData?: mapboxgl.EventData): this; - - getPitch(): number; - - setPitch(pitch: number, eventData?: EventData): this; - - fitBounds(bounds: mapboxgl.LngLatBounds | number[][], options?: { linear?: boolean, easing?: Function, padding?: number, offset?: Point|number[],maxZoom?: number }): this; - - jumpTo(options: mapboxgl.CameraOptions, eventData?: mapboxgl.EventData): this; - - easeTo(options: mapboxgl.CameraOptions | mapboxgl.AnimationOptions, eventData?: mapboxgl.EventData): this; - - flyTo(options: mapboxgl.FlyToOptions, eventData?: mapboxgl.EventData): this; - - stop(): this; - - scrollZoom: ScrollZoomHandler; - - boxZoom: BoxZoomHandler; - - dragRotate: DragRotateHandler; - - dragPan: DragPanHandler; - - keyboard: KeyboardHandler; - - doublClickZoom: DoubleClickZoomHandler; - - touchZoomRotate: TouchZoomRotateHandler; - } - - export interface MapboxOptions { - /** If true, an attribution control will be added to the map. */ - attributionControl?: boolean; - - bearing?: number; - - /** Snap to north threshold in degrees. */ - bearingSnap?: number; - - /** If true, enable the "box zoom" interaction (see BoxZoomHandler) */ - boxZoom?: boolean; - - /** initial map center */ - center?: mapboxgl.LngLat | number[]; - - /** Style class names with which to initialize the map */ - classes?: string[]; - - /** ID of the container element */ - container?: string | Element; - - /** If true, enable the "drag to pan" interaction (see DragPanHandler). */ - dragPan?: boolean; - - /** If true, enable the "drag to rotate" interaction (see DragRotateHandler). */ - dragRotate?: boolean; - - /** If true, enable the "double click to zoom" interaction (see DoubleClickZoomHandler). */ - doubleClickZoom?: boolean; - - /** If true, the map will track and update the page URL according to map position */ - hash?: boolean; - - /** If true, map creation will fail if the implementation determines that the performance of the created WebGL context would be dramatically lower than expected. */ - failIfMayorPerformanceCaveat?: boolean; - - /** If false, no mouse, touch, or keyboard listeners are attached to the map, so it will not respond to input */ - interactive?: boolean; - - /** If true, enable keyboard shortcuts (see KeyboardHandler). */ - keyboard?: boolean; - - /** If set, the map is constrained to the given bounds. */ - maxBounds?: mapboxgl.LngLatBounds | number[][]; - - /** Maximum zoom of the map */ - maxZoom?: number; - - /** Minimum zoom of the map */ - minZoom?: number; - - /** If true, The maps canvas can be exported to a PNG using map.getCanvas().toDataURL();. This is false by default as a performance optimization. */ - preserveDrawingBuffer?: boolean; - - pitch?: number; - - /** If true, enable the "scroll to zoom" interaction */ - scrollZoom?: boolean; - - /** stylesheet location */ - style?: mapboxgl.Style | string; - - /** If true, the map will automatically resize when the browser window resizes */ - trackResize?: boolean; - - /** If true, enable the "pinch to rotate and zoom" interaction (see TouchZoomRotateHandler). */ - touchZoomRotate?: boolean; - - /** Initial zoom level */ - zoom?: number; - } - - /** - * BoxZoomHandler - */ - export class BoxZoomHandler { - constructor(map: mapboxgl.Map); - - isEnabled(): boolean; - - isActive(): boolean; - - enable(): void; - - disable(): void; - } - - /** - * ScrollZoomHandler - */ - export class ScrollZoomHandler { - constructor(map: mapboxgl.Map); - - isEnabled(): boolean; - - enable(): void; - - disable(): void; - } - - /** - * DragPenHandler - */ - export class DragPanHandler { - constructor(map: mapboxgl.Map); - - isEnabled(): boolean; - - isActive(): boolean; - - enable(): void; - - disable(): void; - } - - /** - * DragRotateHandler - */ - export class DragRotateHandler { - constructor(map: mapboxgl.Map, options?: {bearingSnap?: number, pitchWithRotate?: boolean}); - - isEnabled(): boolean; - - isActive(): boolean; - - enable(): void; - - disable(): void; - } - - /** - * KeyboardHandler - */ - export class KeyboardHandler { - constructor(map: mapboxgl.Map); - - isEnabled(): boolean; - - enable(): void; - - disable(): void; - } - - /** - * DoubleClickZoomHandler - */ - export class DoubleClickZoomHandler { - constructor(map: mapboxgl.Map); - - isEnabled(): boolean; - - enable(): void; - - disable(): void; - } - - /** - * TouchZoomRotateHandler - */ - export class TouchZoomRotateHandler { - constructor(map: mapboxgl.Map); - - isEnabled(): boolean; - - enable(): void; - - disable(): void; - - disableRotation(): void; - - enableRotation(): void; - } - - /** - * Control - */ - export class Control extends Evented { - addTo(map: mapboxgl.Map): this; - - remove(): this; - } - - /** - * ControlOptions - */ - export interface ControlOptions { - position?: 'top-right' | 'top-left' | 'bottom-right' | 'bottom-left'; - } - - /** - * Navigation - */ - export class Navigation extends Control { - constructor(options?: mapboxgl.ControlOptions); - } - - /** - * Geolocate - */ - export class Geolocate extends Control { - constructor(options?: mapboxgl.ControlOptions); - } - - /** - * Attribution - */ - export class Attribution extends Control { - constructor(options?: mapboxgl.ControlOptions); - } - - /** - * Scale - */ - export class Scale extends Control { - constructor(options?: {position?: 'top-right' | 'top-left' | 'bottom-right' | 'bottom-left', maxWidth?: number, unit?: string}) - } - - /** - * Popup - */ - export class Popup extends Evented { - constructor(options?: mapboxgl.PopupOptions); - - addTo(map: mapboxgl.Map): this; - - isOpen(): boolean; - - remove(): this; - - getLngLat(): mapboxgl.LngLat; - - setLngLat(lnglat: mapboxgl.LngLat | number[]): this; - - setText(text: string): this; - - setHTML(html: string): this; - - setDOMContent(htmlNode: Node): this; - } - - export interface PopupOptions { - closeButton?: boolean; - - closeOnClick?: boolean; - - anchor?: 'top' | 'bottom' | 'left' | 'right' | 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'; - - offset?: number | Point | number[] | { [key:string]: Point | number[];}; - } - - export interface Style { - bearing?: number; - center?: number[]; - glyphs?: string; - layers?: Layer[]; - metadata?: any; - name?: string; - pitch?: number; - sources?: any; - sprite?: string; - transition?: Transition; - version: number; - zoom?: number; - } - - export interface Transition { - delay?: number; - duration?: number; - } - - export interface Source { - type: "vector" | "raster" | "geojson" | "image" | "video"; - } - - /** - * GeoJSONSource - */ - - export interface GeoJSONSourceRaw extends Source, GeoJSONSourceOptions { - type: "geojson"; - } - - export class GeoJSONSource implements GeoJSONSourceRaw { - type: "geojson"; - - constructor(options?: mapboxgl.GeoJSONSourceOptions); - - setData(data: GeoJSON.Feature | GeoJSON.FeatureCollection | String): this; - } - - export interface GeoJSONSourceOptions { - data?: GeoJSON.Feature | GeoJSON.FeatureCollection | string; - - maxzoom?: number; - - buffer?: number; - - tolerance?: number; - - cluster?: number | boolean; - - clusterRadius?: number; - - clusterMaxZoom?: number; - } - - /** - * VideoSource - */ - export class VideoSource implements Source, VideoSourceOptions { - type: "video"; - - constructor(options?: mapboxgl.VideoSourceOptions); - - getVideo(): HTMLVideoElement; - - setCoordinates(coordinates: number[][]): this; - } - - export interface VideoSourceOptions { - urls?: string[]; - - coordinates?: number[][]; - } - - /** - * ImageSource - */ - export class ImageSource implements Source, ImageSourceOptions { - type: "image"; - - constructor(options?: mapboxgl.ImageSourceOptions); - - setCoordinates(coordinates: number[][]): this; - } - - export interface ImageSourceOptions { - url?: string; - - coordinates?: number[][]; - } - - interface VectorSource extends Source { - type: "vector"; - url?: string; - tiles?: string[]; - minzoom?: number; - maxzoom?: number; - } - - interface RasterSource extends Source { - type: "raster"; - url: string; - tiles?: string[]; - minzoom?: number; - maxzoom?: number; - tileSize?: number; - } - - /** - * LngLat - */ - export class LngLat { - lng: number; - lat: number; - - constructor(lng: number, lat: number); - - /** Return a new LngLat object whose longitude is wrapped to the range (-180, 180). */ - wrap(): mapboxgl.LngLat; - - /** Return a LngLat as an array */ - toArray(): number[]; - - /** Return a LngLat as a string */ - toString(): string; - - static convert(input: number[]|mapboxgl.LngLat): mapboxgl.LngLat; - } - - /** - * LngLatBounds - */ - export class LngLatBounds { - sw: LngLat | number[]; - ne: LngLat | number[]; - constructor(sw?: LngLat, ne?: LngLat); - - /** Extend the bounds to include a given LngLat or LngLatBounds. */ - extend(obj: mapboxgl.LngLat | mapboxgl.LngLatBounds): this; - - /** Get the point equidistant from this box's corners */ - getCenter(): mapboxgl.LngLat; - - /** Get southwest corner */ - getSouthWest(): mapboxgl.LngLat; - - /** Get northeast corner */ - getNorthEast(): mapboxgl.LngLat; - - /** Get northwest corner */ - getNorthWest(): mapboxgl.LngLat; - - /** Get southeast corner */ - getSouthEast(): mapboxgl.LngLat; - - /** Get west edge longitude */ - getWest(): number; - - /** Get south edge latitude */ - getSouth(): number; - - /** Get east edge longitude */ - getEast(): number; - - /** Get north edge latitude */ - getNorth(): number; - - /** Returns a LngLatBounds as an array */ - toArray(): number[][]; - - /** Return a LngLatBounds as a string */ - toString(): string; - - /** Convert an array to a LngLatBounds object, or return an existing LngLatBounds object unchanged. */ - static convert(input: mapboxgl.LngLatBounds | number[] | number[][]): mapboxgl.LngLatBounds; - } - - /** - * Point - */ - // Todo: Pull out class to seperate definition for Module "point-geometry" - export class Point { - constructor(options?: Object); - - clone(): Point; - - add(p: number): Point; - - sub(p: number): Point; - - mult(k: number): Point; - - div(k: number): Point; - - rotate(a: number): Point; - - matMult(m: number): Point; - - unit(): Point; - - perp(): Point; - - round(): Point; - - mag(): number; - - equals(): boolean; - - dist(): number; - - distSqr(): number; - - angle(): number; - - angleTo(): number; - - angleWidth(): number; - - angleWidthSep(): number; - } - - export class Marker { - constructor(element?: HTMLElement, options?: { offset?: Point | number[] }); - - addTo(map: Map): this; - - remove(): this; - - getLngLat(): LngLat; - - setLngLat(lngLat: LngLat | number[]): this; - - setPopup(popup?: Popup): this; - - getPopup(): Popup; - - togglePopup(): this; - } - - /** - * Evented - */ - export class Evented { - on(type: string, listener: Function): this; - - off(type?: string | any, listener?: Function): this; - - once(type: string, listener: Function): this; - - fire(type: string, data?: mapboxgl.EventData | Object): this; - - listens(type: string): boolean; - } - - /** - * StyleOptions - */ - export interface StyleOptions { - transition?: boolean; - } - - /** - * EventData - */ - export class EventData { - type: string; - target: Map; - originalEvent: Event; - point: mapboxgl.Point; - lngLat: mapboxgl.LngLat; - } - - export class MapMouseEvent { - type: string; - target: Map; - originalEvent: MouseEvent; - point: mapboxgl.Point; - lngLat: mapboxgl.LngLat; - } - - export class MapTouchEvent { - type: string; - target: Map; - originalEvent: TouchEvent; - point: mapboxgl.Point; - lngLat: mapboxgl.LngLat; - points: Point[]; - lngLats: LngLat[]; - } - - export class MapBoxZoomEvent { - originalEvent: MouseEvent; - boxZoomBounds: LngLatBounds; - } - - /** - * AnimationOptions - */ - export interface AnimationOptions { - /** Number in milliseconds */ - duration?: number; - easing?: Function; - /** point, origin of movement relative to map center */ - offset?: Point | number[]; - /** When set to false, no animation happens */ - animate?: boolean; - } - - /** - * CameraOptions - */ - export interface CameraOptions { - /** Map center */ - center?: mapboxgl.LngLat | number[]; - /** Map zoom level */ - zoom?: number; - /** Map rotation bearing in degrees counter-clockwise from north */ - bearing?: number; - /** Map angle in degrees at which the camera is looking at the ground */ - pitch?: number; - /** If zooming, the zoom center (defaults to map center) */ - around?: mapboxgl.LngLat | number[]; - } - - /** - * FlyToOptions - */ - export interface FlyToOptions extends AnimationOptions, CameraOptions { - curve?: number; - minZoom?: number; - speed?: number; - screenSpeed?: number; - easing?: Function; - } - - /** - * MapEvent - */ - export interface MapEvent { - webglcontextlost?: {originalEvent: WebGLContextEvent}; - webglcontextrestored?: {originalEvent: WebGLContextEvent}; - render?: void; - contextmenu?: {data: mapboxgl.MapMouseEvent}; - dblclick?: {data: mapboxgl.MapMouseEvent}; - click?: {data: mapboxgl.MapMouseEvent}; - touchcancel?: {data: mapboxgl.MapTouchEvent}; - touchmove?: {data: mapboxgl.MapTouchEvent}; - touchend?: {data: mapboxgl.MapTouchEvent}; - touchstart?: {data: mapboxgl.MapTouchEvent}; - mousemove?: {data: mapboxgl.MapMouseEvent}; - mouseup?: {data: mapboxgl.MapMouseEvent}; - mousedown?: {data: mapboxgl.MapMouseEvent}; - moveend?: {data: mapboxgl.MapMouseEvent | mapboxgl.MapTouchEvent}; - move?: {data: mapboxgl.MapMouseEvent | mapboxgl.MapTouchEvent}; - movestart?: {data: mapboxgl.MapMouseEvent | mapboxgl.MapTouchEvent}; - mouseout?:{data: mapboxgl.MapMouseEvent}; - load?: void; - zoomend?: {data: mapboxgl.MapMouseEvent | mapboxgl.MapTouchEvent}; - zoom?: {data: mapboxgl.MapMouseEvent | mapboxgl.MapTouchEvent}; - zoomstart?: {data: mapboxgl.MapMouseEvent | mapboxgl.MapTouchEvent}; - boxzoomcancel?: {data: mapboxgl.MapBoxZoomEvent}; - boxzoomstart?: {data: mapboxgl.MapBoxZoomEvent}; - boxzoomend?: {data: mapboxgl.MapBoxZoomEvent}; - rotate?: {data: mapboxgl.MapMouseEvent | mapboxgl.MapTouchEvent}; - rotatestart?: {data: mapboxgl.MapMouseEvent | mapboxgl.MapTouchEvent}; - rotateend?: {data: mapboxgl.MapMouseEvent | mapboxgl.MapTouchEvent}; - drag?: {data: mapboxgl.MapMouseEvent | mapboxgl.MapTouchEvent}; - dragend?: {data: mapboxgl.MapMouseEvent | mapboxgl.MapTouchEvent}; - pitch?: {data: mapboxgl.EventData}; - } - - export interface Layer { - id: string; - type?: "fill" | "line" | "symbol" | "circle" | "raster" | "background" | string; //TODO: Ideally we wouldn't accept string here, just these specific strings - - metadata?: any; - ref?: string; - - source?: string; - - "source-layer"?: string; - - minzoom?: number; - maxzoom?: number; - - interactive?: boolean; - - filter?: any[]; - layout?: BackgroundLayout | FillLayout | LineLayout | SymbolLayout | RasterLayout | CircleLayout; - paint?: BackgroundPaint | FillPaint | LinePaint | SymbolPaint | RasterPaint | CirclePaint; - } - - export interface StyleFunction { - stops: any[][]; - property?: string; - base?: number; - type?: "continuous" | "interval" | "categorical"; - } - - export interface BackgroundLayout { - visibility?: "visible" | "none"; - } - export interface BackgroundPaint { - "background-color"?: string; - "background-pattern"?: string; - "background-opacity"?: number; - } - - export interface FillLayout { - visibility?: "visible" | "none"; - } - export interface FillPaint { - "fill-antialias"?: boolean; - "fill-opacity"?: number | StyleFunction; - "fill-color"?: string | StyleFunction; - "fill-outline-color": string | StyleFunction; - "fill-translate"?: number[]; - "fill-translate-anchor"?: "map" | "viewport"; - "fill-pattern"?: "string"; - } - - export interface LineLayout { - visibility?: "visible" | "none"; - - "line-cap"?: "butt" | "round" | "square"; - "line-join"?: "bevel" | "round" | "miter"; - "line-miter-limit"?: number; - "line-round-limit"?: number; - } - export interface LinePaint { - "line-opacity"?: number; - "line-color"?: string| StyleFunction; - "line-translate"?: number[]; - "line-translate-anchor"?: "map" | "viewport"; - "line-width"?: number; - "line-gap-width"?: number; - "line-offset"?: number; - "line-blur"?: number; - "line-dasharray"?: number[]; - "line-dasharray-transition"?: Transition; - "line-pattern"?: string; - } - - export interface SymbolLayout { - visibility?: "visible" | "none"; - - "symbol-placement"?: "point" | "line"; - "symbol-spacing"?: number; - "symbol-avoid-edges"?: boolean; - "icon-allow-overlap"?: boolean; - "icon-ignore-placement"?: boolean; - "icon-optional"?: boolean; - "icon-rotation-alignment"?: "map" | "viewport" | "auto"; - "icon-size"?: number; - "icon-text-fit"?: "none" | "both" | "width" | "height"; - "icon-text-fit-padding"?: number[]; - "icon-image"?: string; - "icon-rotate"?: number | StyleFunction; - "icon-padding"?: number; - "icon-keep-upright"?: boolean; - "icon-offset"?: number[]; - "text-pitch-alignment"?: "map" | "viewport" | "auto"; - "text-rotation-alignment"?: "map" | "viewport" | "auto"; - "text-field"?: string; - "text-font"?: string | string[]; - "text-size"?: number; - "text-max-width"?: number; - "text-line-height"?: number; - "text-letter-spacing"?: number; - "text-justify"?: "left" | "center" | "right"; - "text-anchor"?: "center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right"; - "text-max-angle"?: number; - "text-rotate"?: number; - "text-padding"?: number; - "text-keep-upright"?: boolean; - "text-transform"?: "none" | "uppercase" | "lowercase"; - "text-offset"?: number[]; - "text-allow-overlap"?: boolean; - "text-ignore-placement"?: boolean; - "text-optional"?: boolean; - - } - export interface SymbolPaint { - "icon-opacity"?: number; - "icon-color"?: string; - "icon-halo-color"?: string; - "icon-halo-width"?: number; - "icon-halo-blur"?: number; - "icon-translate"?: number[]; - "icon-translate-anchor"?: "map" | "viewport"; - "text-opacity"?: number; - "text-color"?: "string"; - "text-halo-color"?: "string"; - "text-halo-width"?: number; - "text-halo-blur"?: number; - "text-translate"?: number[]; - "text-translate-anchor"?: "map" | "viewport"; - } - - export interface RasterLayout { - visibility?: "visible" | "none"; - } - - export interface RasterPaint { - "raster-opacity"?: number; - "raster-hue-rotate"?: number; - "raster-brightness-min"?: number; - "raster-brightness-max"?: number; - "raster-saturation"?: number; - "raster-contrast"?: number; - "raster-fade-duration"?: number; - } - - export interface CircleLayout { - visibility?: "visible" | "none"; - } - - export interface CirclePaint { - "circle-radius"?: number | StyleFunction; - "circle-radius-transition"?: Transition; - "circle-color"?: number | StyleFunction; - "circle-blur"?: number | StyleFunction; - "circle-opacity"?: number | StyleFunction; - "circle-translate"?: number[]; - "circle-translate-anchor"?: "map" | "viewport"; - "circle-pitch-scale"?: "map" | "viewport"; - } -} - -declare module 'mapbox-gl' { - export = mapboxgl; -} diff --git a/mapbox-gl/mapbox-gl-0.26.0.d.ts b/mapbox-gl/mapbox-gl-0.26.0.d.ts deleted file mode 100644 index ddb6344cbd..0000000000 --- a/mapbox-gl/mapbox-gl-0.26.0.d.ts +++ /dev/null @@ -1,948 +0,0 @@ -// Type definitions for Mapbox GL JS v0.26.0 -// Project: https://github.com/mapbox/mapbox-gl-js -// Definitions by: Dominik Bruderer -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -/// - -declare namespace mapboxgl { - let accessToken: string; - let version: string; - export function supported(options?: {failIfMajorPerformanceCaveat?: boolean}): boolean; - - /** - * Map - */ - export class Map extends Evented { - constructor(options?: MapboxOptions); - - addControl(control: Control): this; - - addClass(klass: string, options?: mapboxgl.StyleOptions): this; - - removeClass(klass: string, options?: mapboxgl.StyleOptions): this; - - setClasses(klasses: string[], options?: mapboxgl.StyleOptions): this; - - hasClass(klass: string): boolean; - - getClasses(): string[]; - - resize(): this; - - getBounds(): mapboxgl.LngLatBounds; - - setMaxBounds(lnglatbounds?: mapboxgl.LngLatBounds | number[][]): this; - - setMinZoom(minZoom?: number): this; - - setMaxZoom(maxZoom?: number): this; - - project(lnglat: mapboxgl.LngLat | number[]): mapboxgl.Point; - - unproject(point: mapboxgl.Point | number[]): mapboxgl.LngLat; - - queryRenderedFeatures(pointOrBox?: mapboxgl.Point|number[]|mapboxgl.Point[]|number[][], parameters?: {layers?: string[], filter?: any[]}): GeoJSON.Feature[]; - - querySourceFeatures(sourceID: string, parameters: {sourceLayer?: string, filter?: any[]}): GeoJSON.Feature[]; - - setStyle(style: mapboxgl.Style | string): this; - - getStyle(): mapboxgl.Style; - - addSource(id: string, source: VectorSource | RasterSource | GeoJSONSource | ImageSource | VideoSource | GeoJSONSourceRaw): this; - - removeSource(id: string): this; - - getSource(id: string): VectorSource | RasterSource | GeoJSONSource | ImageSource | VideoSource; - - addLayer(layer: mapboxgl.Layer, before?: string): this; - - removeLayer(id: string): this; - - getLayer(id: string): mapboxgl.Layer; - - setFilter(layer: string, filter: any[]): this; - - setLayerZoomRange(layerId: string, minzoom: number, maxzoom: number): this; - - getFilter(layer: string): any[]; - - setPaintProperty(layer: string, name: string, value: any, klass?: string): this; - - getPaintProperty(layer: string, name: string, klass?: string): any; - - setLayoutProperty(layer: string, name: string, value: any): this; - - getLayoutProperty(layer: string, name: string, klass?: string): any; - - getContainer(): HTMLElement; - - getCanvasContainer(): HTMLElement; - - getCanvas(): HTMLCanvasElement; - - loaded(): boolean; - - remove(): void; - - onError(): void; - - showTileBoundaries: boolean; - - showCollisionBoxes: boolean; - - repaint: boolean; - - getCenter(): mapboxgl.LngLat; - - setCenter(center: LngLat|number[], eventData?: mapboxgl.EventData): this; - - panBy(offset: number[], options?: mapboxgl.AnimationOptions, eventData?: mapboxgl.EventData): this; - - panTo(lnglat: mapboxgl.LngLat, options?: mapboxgl.AnimationOptions, eventdata?: mapboxgl.EventData): this; - - getZoom(): number; - - setZoom(zoom: number, eventData?: mapboxgl.EventData): this; - - zoomTo(zoom: number, options?: mapboxgl.AnimationOptions, eventData?: mapboxgl.EventData): this; - - zoomIn(options?: mapboxgl.AnimationOptions, eventData?: mapboxgl.EventData): this; - - zoomOut(options?: mapboxgl.AnimationOptions, eventData?: mapboxgl.EventData): this; - - getBearing(): number; - - setBearing(bearing: number, eventData?: mapboxgl.EventData): this; - - rotateTo(bearing: number, options?: mapboxgl.AnimationOptions, eventData?: EventData): this; - - resetNorth(options?: mapboxgl.AnimationOptions, eventData?: mapboxgl.EventData): this; - - snapToNorth(options?: mapboxgl.AnimationOptions, eventData?: mapboxgl.EventData): this; - - getPitch(): number; - - setPitch(pitch: number, eventData?: EventData): this; - - fitBounds(bounds: mapboxgl.LngLatBounds | number[][], options?: { linear?: boolean, easing?: Function, padding?: number, offset?: Point|number[],maxZoom?: number }): this; - - jumpTo(options: mapboxgl.CameraOptions, eventData?: mapboxgl.EventData): this; - - easeTo(options: mapboxgl.CameraOptions | mapboxgl.AnimationOptions, eventData?: mapboxgl.EventData): this; - - flyTo(options: mapboxgl.FlyToOptions, eventData?: mapboxgl.EventData): this; - - stop(): this; - - scrollZoom: ScrollZoomHandler; - - boxZoom: BoxZoomHandler; - - dragRotate: DragRotateHandler; - - dragPan: DragPanHandler; - - keyboard: KeyboardHandler; - - doublClickZoom: DoubleClickZoomHandler; - - touchZoomRotate: TouchZoomRotateHandler; - } - - export interface MapboxOptions { - /** If true, an attribution control will be added to the map. */ - attributionControl?: boolean; - - bearing?: number; - - /** Snap to north threshold in degrees. */ - bearingSnap?: number; - - /** If true, enable the "box zoom" interaction (see BoxZoomHandler) */ - boxZoom?: boolean; - - /** initial map center */ - center?: mapboxgl.LngLat | number[]; - - /** Style class names with which to initialize the map */ - classes?: string[]; - - /** ID of the container element */ - container?: string | Element; - - /** If true, enable the "drag to pan" interaction (see DragPanHandler). */ - dragPan?: boolean; - - /** If true, enable the "drag to rotate" interaction (see DragRotateHandler). */ - dragRotate?: boolean; - - /** If true, enable the "double click to zoom" interaction (see DoubleClickZoomHandler). */ - doubleClickZoom?: boolean; - - /** If true, the map will track and update the page URL according to map position */ - hash?: boolean; - - /** If true, map creation will fail if the implementation determines that the performance of the created WebGL context would be dramatically lower than expected. */ - failIfMayorPerformanceCaveat?: boolean; - - /** If false, no mouse, touch, or keyboard listeners are attached to the map, so it will not respond to input */ - interactive?: boolean; - - /** If true, enable keyboard shortcuts (see KeyboardHandler). */ - keyboard?: boolean; - - /** If set, the map is constrained to the given bounds. */ - maxBounds?: mapboxgl.LngLatBounds | number[][]; - - /** Maximum zoom of the map */ - maxZoom?: number; - - /** Minimum zoom of the map */ - minZoom?: number; - - /** If true, The maps canvas can be exported to a PNG using map.getCanvas().toDataURL();. This is false by default as a performance optimization. */ - preserveDrawingBuffer?: boolean; - - pitch?: number; - - /** If true, enable the "scroll to zoom" interaction */ - scrollZoom?: boolean; - - /** stylesheet location */ - style?: mapboxgl.Style | string; - - /** If true, the map will automatically resize when the browser window resizes */ - trackResize?: boolean; - - /** If true, enable the "pinch to rotate and zoom" interaction (see TouchZoomRotateHandler). */ - touchZoomRotate?: boolean; - - /** Initial zoom level */ - zoom?: number; - } - - /** - * BoxZoomHandler - */ - export class BoxZoomHandler { - constructor(map: mapboxgl.Map); - - isEnabled(): boolean; - - isActive(): boolean; - - enable(): void; - - disable(): void; - } - - /** - * ScrollZoomHandler - */ - export class ScrollZoomHandler { - constructor(map: mapboxgl.Map); - - isEnabled(): boolean; - - enable(): void; - - disable(): void; - } - - /** - * DragPenHandler - */ - export class DragPanHandler { - constructor(map: mapboxgl.Map); - - isEnabled(): boolean; - - isActive(): boolean; - - enable(): void; - - disable(): void; - } - - /** - * DragRotateHandler - */ - export class DragRotateHandler { - constructor(map: mapboxgl.Map, options?: {bearingSnap?: number, pitchWithRotate?: boolean}); - - isEnabled(): boolean; - - isActive(): boolean; - - enable(): void; - - disable(): void; - } - - /** - * KeyboardHandler - */ - export class KeyboardHandler { - constructor(map: mapboxgl.Map); - - isEnabled(): boolean; - - enable(): void; - - disable(): void; - } - - /** - * DoubleClickZoomHandler - */ - export class DoubleClickZoomHandler { - constructor(map: mapboxgl.Map); - - isEnabled(): boolean; - - enable(): void; - - disable(): void; - } - - /** - * TouchZoomRotateHandler - */ - export class TouchZoomRotateHandler { - constructor(map: mapboxgl.Map); - - isEnabled(): boolean; - - enable(): void; - - disable(): void; - - disableRotation(): void; - - enableRotation(): void; - } - - /** - * Control - */ - export class Control extends Evented { - addTo(map: mapboxgl.Map): this; - - remove(): this; - } - - /** - * ControlOptions - */ - export interface ControlOptions { - position?: 'top-right' | 'top-left' | 'bottom-right' | 'bottom-left'; - } - - /** - * Navigation - */ - export class NavigationControl extends Control { - constructor(options?: mapboxgl.ControlOptions); - } - - /** - * Geolocate - */ - export class GeolocateControl extends Control { - constructor(options?: mapboxgl.ControlOptions); - } - - /** - * Attribution - */ - export class AttributionControl extends Control { - constructor(options?: mapboxgl.ControlOptions); - } - - /** - * Scale - */ - export class ScaleControl extends Control { - constructor(options?: {position?: 'top-right' | 'top-left' | 'bottom-right' | 'bottom-left', maxWidth?: number, unit?: string}) - } - - /** - * Popup - */ - export class Popup extends Evented { - constructor(options?: mapboxgl.PopupOptions); - - addTo(map: mapboxgl.Map): this; - - isOpen(): boolean; - - remove(): this; - - getLngLat(): mapboxgl.LngLat; - - setLngLat(lnglat: mapboxgl.LngLat | number[]): this; - - setText(text: string): this; - - setHTML(html: string): this; - - setDOMContent(htmlNode: Node): this; - } - - export interface PopupOptions { - closeButton?: boolean; - - closeOnClick?: boolean; - - anchor?: 'top' | 'bottom' | 'left' | 'right' | 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'; - - offset?: number | Point | number[] | { [key:string]: Point | number[];}; - } - - export interface Style { - bearing?: number; - center?: number[]; - glyphs?: string; - layers?: Layer[]; - metadata?: any; - name?: string; - pitch?: number; - sources?: any; - sprite?: string; - transition?: Transition; - version: number; - zoom?: number; - } - - export interface Transition { - delay?: number; - duration?: number; - } - - export interface Source { - type: "vector" | "raster" | "geojson" | "image" | "video"; - } - - /** - * GeoJSONSource - */ - - export interface GeoJSONSourceRaw extends Source, GeoJSONSourceOptions { - type: "geojson"; - } - - export class GeoJSONSource implements GeoJSONSourceRaw { - type: "geojson"; - - constructor(options?: mapboxgl.GeoJSONSourceOptions); - - setData(data: GeoJSON.Feature | GeoJSON.FeatureCollection | String): this; - } - - export interface GeoJSONSourceOptions { - data?: GeoJSON.Feature | GeoJSON.FeatureCollection | string; - - maxzoom?: number; - - buffer?: number; - - tolerance?: number; - - cluster?: number | boolean; - - clusterRadius?: number; - - clusterMaxZoom?: number; - } - - /** - * VideoSource - */ - export class VideoSource implements Source, VideoSourceOptions { - type: "video"; - - constructor(options?: mapboxgl.VideoSourceOptions); - - getVideo(): HTMLVideoElement; - - setCoordinates(coordinates: number[][]): this; - } - - export interface VideoSourceOptions { - urls?: string[]; - - coordinates?: number[][]; - } - - /** - * ImageSource - */ - export class ImageSource implements Source, ImageSourceOptions { - type: "image"; - - constructor(options?: mapboxgl.ImageSourceOptions); - - setCoordinates(coordinates: number[][]): this; - } - - export interface ImageSourceOptions { - url?: string; - - coordinates?: number[][]; - } - - interface VectorSource extends Source { - type: "vector"; - url?: string; - tiles?: string[]; - minzoom?: number; - maxzoom?: number; - } - - interface RasterSource extends Source { - type: "raster"; - url: string; - tiles?: string[]; - minzoom?: number; - maxzoom?: number; - tileSize?: number; - } - - /** - * LngLat - */ - export class LngLat { - lng: number; - lat: number; - - constructor(lng: number, lat: number); - - /** Return a new LngLat object whose longitude is wrapped to the range (-180, 180). */ - wrap(): mapboxgl.LngLat; - - /** Return a LngLat as an array */ - toArray(): number[]; - - /** Return a LngLat as a string */ - toString(): string; - - static convert(input: number[]|mapboxgl.LngLat): mapboxgl.LngLat; - } - - /** - * LngLatBounds - */ - export class LngLatBounds { - sw: LngLat | number[]; - ne: LngLat | number[]; - constructor(sw?: LngLat, ne?: LngLat); - - /** Extend the bounds to include a given LngLat or LngLatBounds. */ - extend(obj: mapboxgl.LngLat | mapboxgl.LngLatBounds): this; - - /** Get the point equidistant from this box's corners */ - getCenter(): mapboxgl.LngLat; - - /** Get southwest corner */ - getSouthWest(): mapboxgl.LngLat; - - /** Get northeast corner */ - getNorthEast(): mapboxgl.LngLat; - - /** Get northwest corner */ - getNorthWest(): mapboxgl.LngLat; - - /** Get southeast corner */ - getSouthEast(): mapboxgl.LngLat; - - /** Get west edge longitude */ - getWest(): number; - - /** Get south edge latitude */ - getSouth(): number; - - /** Get east edge longitude */ - getEast(): number; - - /** Get north edge latitude */ - getNorth(): number; - - /** Returns a LngLatBounds as an array */ - toArray(): number[][]; - - /** Return a LngLatBounds as a string */ - toString(): string; - - /** Convert an array to a LngLatBounds object, or return an existing LngLatBounds object unchanged. */ - static convert(input: mapboxgl.LngLatBounds | number[] | number[][]): mapboxgl.LngLatBounds; - } - - /** - * Point - */ - // Todo: Pull out class to seperate definition for Module "point-geometry" - export class Point { - constructor(options?: Object); - - clone(): Point; - - add(p: number): Point; - - sub(p: number): Point; - - mult(k: number): Point; - - div(k: number): Point; - - rotate(a: number): Point; - - matMult(m: number): Point; - - unit(): Point; - - perp(): Point; - - round(): Point; - - mag(): number; - - equals(): boolean; - - dist(): number; - - distSqr(): number; - - angle(): number; - - angleTo(): number; - - angleWidth(): number; - - angleWidthSep(): number; - } - - export class Marker { - constructor(element?: HTMLElement, options?: { offset?: Point | number[] }); - - addTo(map: Map): this; - - remove(): this; - - getLngLat(): LngLat; - - setLngLat(lngLat: LngLat | number[]): this; - - setPopup(popup?: Popup): this; - - getPopup(): Popup; - - togglePopup(): this; - } - - /** - * Evented - */ - export class Evented { - on(type: string, listener: Function): this; - - off(type?: string | any, listener?: Function): this; - - once(type: string, listener: Function): this; - - fire(type: string, data?: mapboxgl.EventData | Object): this; - - listens(type: string): boolean; - } - - /** - * StyleOptions - */ - export interface StyleOptions { - transition?: boolean; - } - - /** - * EventData - */ - export class EventData { - type: string; - target: Map; - originalEvent: Event; - point: mapboxgl.Point; - lngLat: mapboxgl.LngLat; - } - - export class MapMouseEvent { - type: string; - target: Map; - originalEvent: MouseEvent; - point: mapboxgl.Point; - lngLat: mapboxgl.LngLat; - } - - export class MapTouchEvent { - type: string; - target: Map; - originalEvent: TouchEvent; - point: mapboxgl.Point; - lngLat: mapboxgl.LngLat; - points: Point[]; - lngLats: LngLat[]; - } - - export class MapBoxZoomEvent { - originalEvent: MouseEvent; - boxZoomBounds: LngLatBounds; - } - - export class MapDataEvent { - type: string; - dataType: "source" | "style" | "tile"; - } - - /** - * AnimationOptions - */ - export interface AnimationOptions { - /** Number in milliseconds */ - duration?: number; - easing?: Function; - /** point, origin of movement relative to map center */ - offset?: Point | number[]; - /** When set to false, no animation happens */ - animate?: boolean; - } - - /** - * CameraOptions - */ - export interface CameraOptions { - /** Map center */ - center?: mapboxgl.LngLat | number[]; - /** Map zoom level */ - zoom?: number; - /** Map rotation bearing in degrees counter-clockwise from north */ - bearing?: number; - /** Map angle in degrees at which the camera is looking at the ground */ - pitch?: number; - /** If zooming, the zoom center (defaults to map center) */ - around?: mapboxgl.LngLat | number[]; - } - - /** - * FlyToOptions - */ - export interface FlyToOptions extends AnimationOptions, CameraOptions { - curve?: number; - minZoom?: number; - speed?: number; - screenSpeed?: number; - easing?: Function; - } - - /** - * MapEvent - */ - export interface MapEvent { - resize?: void; - webglcontextlost?: {originalEvent: WebGLContextEvent}; - webglcontextrestored?: {originalEvent: WebGLContextEvent}; - remove?: void; - dataloading?: {data: mapboxgl.MapDataEvent}; - data?: {data: mapboxgl.MapDataEvent}; - render?: void; - contextmenu?: {data: mapboxgl.MapMouseEvent}; - dblclick?: {data: mapboxgl.MapMouseEvent}; - click?: {data: mapboxgl.MapMouseEvent}; - touchcancel?: {data: mapboxgl.MapTouchEvent}; - touchmove?: {data: mapboxgl.MapTouchEvent}; - touchend?: {data: mapboxgl.MapTouchEvent}; - touchstart?: {data: mapboxgl.MapTouchEvent}; - mousemove?: {data: mapboxgl.MapMouseEvent}; - mouseup?: {data: mapboxgl.MapMouseEvent}; - mousedown?: {data: mapboxgl.MapMouseEvent}; - moveend?: {data: mapboxgl.MapMouseEvent | mapboxgl.MapTouchEvent}; - move?: {data: mapboxgl.MapMouseEvent | mapboxgl.MapTouchEvent}; - movestart?: {data: mapboxgl.MapMouseEvent | mapboxgl.MapTouchEvent}; - mouseout?:{data: mapboxgl.MapMouseEvent}; - load?: void; - zoomend?: {data: mapboxgl.MapMouseEvent | mapboxgl.MapTouchEvent}; - zoom?: {data: mapboxgl.MapMouseEvent | mapboxgl.MapTouchEvent}; - zoomstart?: {data: mapboxgl.MapMouseEvent | mapboxgl.MapTouchEvent}; - boxzoomcancel?: {data: mapboxgl.MapBoxZoomEvent}; - boxzoomstart?: {data: mapboxgl.MapBoxZoomEvent}; - boxzoomend?: {data: mapboxgl.MapBoxZoomEvent}; - rotate?: {data: mapboxgl.MapMouseEvent | mapboxgl.MapTouchEvent}; - rotatestart?: {data: mapboxgl.MapMouseEvent | mapboxgl.MapTouchEvent}; - rotateend?: {data: mapboxgl.MapMouseEvent | mapboxgl.MapTouchEvent}; - drag?: {data: mapboxgl.MapMouseEvent | mapboxgl.MapTouchEvent}; - dragend?: {data: mapboxgl.MapMouseEvent | mapboxgl.MapTouchEvent}; - pitch?: {data: mapboxgl.EventData}; - } - - export interface Layer { - id: string; - type?: "fill" | "line" | "symbol" | "circle" | "raster" | "background" | string; //TODO: Ideally we wouldn't accept string here, just these specific strings - - metadata?: any; - ref?: string; - - source?: string; - - "source-layer"?: string; - - minzoom?: number; - maxzoom?: number; - - interactive?: boolean; - - filter?: any[]; - layout?: BackgroundLayout | FillLayout | LineLayout | SymbolLayout | RasterLayout | CircleLayout; - paint?: BackgroundPaint | FillPaint | LinePaint | SymbolPaint | RasterPaint | CirclePaint; - } - - export interface StyleFunction { - stops: any[][]; - property?: string; - base?: number; - type?: "identity" | "exponential" | "interval" | "categorical"; - "colorSpace"?: "rgb" | "lab" | "interval"; - } - - export interface BackgroundLayout { - visibility?: "visible" | "none"; - } - export interface BackgroundPaint { - "background-color"?: string; - "background-pattern"?: string; - "background-opacity"?: number; - } - - export interface FillLayout { - visibility?: "visible" | "none"; - } - export interface FillPaint { - "fill-antialias"?: boolean; - "fill-opacity"?: number | StyleFunction; - "fill-color"?: string | StyleFunction; - "fill-outline-color": string | StyleFunction; - "fill-translate"?: number[]; - "fill-translate-anchor"?: "map" | "viewport"; - "fill-pattern"?: "string"; - "fill-extrude-height"?: number; - "fill-extrude-base"?: number; - } - - export interface LineLayout { - visibility?: "visible" | "none"; - - "line-cap"?: "butt" | "round" | "square"; - "line-join"?: "bevel" | "round" | "miter"; - "line-miter-limit"?: number; - "line-round-limit"?: number; - } - export interface LinePaint { - "line-opacity"?: number; - "line-color"?: string| StyleFunction; - "line-translate"?: number[]; - "line-translate-anchor"?: "map" | "viewport"; - "line-width"?: number; - "line-gap-width"?: number; - "line-offset"?: number; - "line-blur"?: number; - "line-dasharray"?: number[]; - "line-dasharray-transition"?: Transition; - "line-pattern"?: string; - } - - export interface SymbolLayout { - visibility?: "visible" | "none"; - - "symbol-placement"?: "point" | "line"; - "symbol-spacing"?: number; - "symbol-avoid-edges"?: boolean; - "icon-allow-overlap"?: boolean; - "icon-ignore-placement"?: boolean; - "icon-optional"?: boolean; - "icon-rotation-alignment"?: "map" | "viewport" | "auto"; - "icon-size"?: number; - "icon-text-fit"?: "none" | "both" | "width" | "height"; - "icon-text-fit-padding"?: number[]; - "icon-image"?: string; - "icon-rotate"?: number | StyleFunction; - "icon-padding"?: number; - "icon-keep-upright"?: boolean; - "icon-offset"?: number[]; - "text-pitch-alignment"?: "map" | "viewport" | "auto"; - "text-rotation-alignment"?: "map" | "viewport" | "auto"; - "text-field"?: string; - "text-font"?: string | string[]; - "text-size"?: number; - "text-max-width"?: number; - "text-line-height"?: number; - "text-letter-spacing"?: number; - "text-justify"?: "left" | "center" | "right"; - "text-anchor"?: "center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right"; - "text-max-angle"?: number; - "text-rotate"?: number; - "text-padding"?: number; - "text-keep-upright"?: boolean; - "text-transform"?: "none" | "uppercase" | "lowercase"; - "text-offset"?: number[]; - "text-allow-overlap"?: boolean; - "text-ignore-placement"?: boolean; - "text-optional"?: boolean; - - } - export interface SymbolPaint { - "icon-opacity"?: number; - "icon-color"?: string; - "icon-halo-color"?: string; - "icon-halo-width"?: number; - "icon-halo-blur"?: number; - "icon-translate"?: number[]; - "icon-translate-anchor"?: "map" | "viewport"; - "text-opacity"?: number; - "text-color"?: "string"; - "text-halo-color"?: "string"; - "text-halo-width"?: number; - "text-halo-blur"?: number; - "text-translate"?: number[]; - "text-translate-anchor"?: "map" | "viewport"; - } - - export interface RasterLayout { - visibility?: "visible" | "none"; - } - - export interface RasterPaint { - "raster-opacity"?: number; - "raster-hue-rotate"?: number; - "raster-brightness-min"?: number; - "raster-brightness-max"?: number; - "raster-saturation"?: number; - "raster-contrast"?: number; - "raster-fade-duration"?: number; - } - - export interface CircleLayout { - visibility?: "visible" | "none"; - } - - export interface CirclePaint { - "circle-radius"?: number | StyleFunction; - "circle-radius-transition"?: Transition; - "circle-color"?: number | StyleFunction; - "circle-blur"?: number | StyleFunction; - "circle-opacity"?: number | StyleFunction; - "circle-translate"?: number[]; - "circle-translate-anchor"?: "map" | "viewport"; - "circle-pitch-scale"?: "map" | "viewport"; - } -} - -declare module 'mapbox-gl' { - export = mapboxgl; -} diff --git a/marker-animate-unobtrusive/marker-animate-unobtrusive-amd-tests.ts b/marker-animate-unobtrusive/marker-animate-unobtrusive-amd-tests.ts deleted file mode 100644 index f86619fc90..0000000000 --- a/marker-animate-unobtrusive/marker-animate-unobtrusive-amd-tests.ts +++ /dev/null @@ -1,5 +0,0 @@ -import SlidingMarker = require('SlidingMarker'); -import MarkerWithGhost = require('MarkerWithGhost'); - -SlidingMarker.initializeGlobally(); -MarkerWithGhost.initializeGlobally(); diff --git a/marker-animate-unobtrusive/tsconfig.json b/marker-animate-unobtrusive/tsconfig.json index dbd27c0653..bc77ff1fcd 100644 --- a/marker-animate-unobtrusive/tsconfig.json +++ b/marker-animate-unobtrusive/tsconfig.json @@ -15,7 +15,6 @@ }, "files": [ "index.d.ts", - "marker-animate-unobtrusive-tests.ts", - "marker-animate-unobtrusive-amd-tests.ts" + "marker-animate-unobtrusive-tests.ts" ] } \ No newline at end of file diff --git a/material-ui/legacy/material-ui-0.11.1-tests.tsx b/material-ui/legacy/material-ui-0.11.1-tests.tsx deleted file mode 100644 index 9d82211bc5..0000000000 --- a/material-ui/legacy/material-ui-0.11.1-tests.tsx +++ /dev/null @@ -1,477 +0,0 @@ -/// -/// - -import * as React from "react/addons"; - -import mui = require("material-ui"); -import Colors = require("material-ui/lib/styles/colors"); -import AppBar = require("material-ui/lib/app-bar"); -import IconButton = require("material-ui/lib/icon-button"); -import FlatButton = require("material-ui/lib/flat-button"); -import Avatar = require("material-ui/lib/avatar"); -import FontIcon = require("material-ui/lib/font-icon"); -import Typography = require("material-ui/lib/styles/typography"); -import RaisedButton = require("material-ui/lib/raised-button"); -import FloatingActionButton = require("material-ui/lib/floating-action-button"); -import Card = require("material-ui/lib/card/card"); -import CardHeader = require("material-ui/lib/card/card-header"); -import CardText = require("material-ui/lib/card/card-text"); -import CardActions = require("material-ui/lib/card/card-actions"); -import Dialog = require("material-ui/lib/dialog"); -import DropDownMenu = require("material-ui/lib/drop-down-menu"); -import RadioButtonGroup = require("material-ui/lib/radio-button-group"); -import RadioButton = require("material-ui/lib/radio-button"); -import Toggle = require("material-ui/lib/toggle"); -import TextField = require("material-ui/lib/text-field"); -import SelectField = require("material-ui/lib/select-field"); -import IconMenu = require("material-ui/lib/menus/icon-menu"); -import Menu = require('material-ui/lib/menus/menu'); -import MenuItem = require('material-ui/lib/menus/menu-item'); -import MenuDivider = require('material-ui/lib/menus/menu-divider'); - -import NavigationClose = require("material-ui/lib/svg-icon"); // TODO: Should actually import the actual "material-ui/lib/svg-icons/navigation/close", but they aren't defined yet. -import FileFolder = require("material-ui/lib/svg-icon"); // TODO: Should actually import the actual "material-ui/lib/svg-icons/file/folder", but they aren't defined yet. -import ToggleStar = require("material-ui/lib/svg-icon"); // TODO: Should actually import the actual "material-ui/lib/svg-icons/toggle/star", but they aren't defined yet. -import ActionGrade = require("material-ui/lib/svg-icon"); // TODO: Should actually import the actual "material-ui/lib/svg-icons/action/grade", but they aren't defined yet. -import ToggleStarBorder = require("material-ui/lib/svg-icon"); // TODO: Should actually import the actual "material-ui/lib/svg-icons/toggle/star-border", but they aren't defined yet. -import ArrowDropRight = require("material-ui/lib/svg-icon"); // TODO: Should actually import the actual "material-ui/lib/svg-icons/toggle/star-border", but they aren't defined yet. - -class MaterialUiTests extends React.Component<{}, {}> implements React.LinkedStateMixin { - - // injected with mixin - linkState: (key: string) => React.ReactLink; - dialog: mui.Dialog; - //dialog2: Dialog; // can't get type directly from require("material-ui/lib/dialog"); - - private touchTapEventHandler(e: __MaterialUI.TouchTapEvent) { - this.dialog.show(); - //this.dialog2.show(); - } - private formEventHandler(e: React.FormEvent) { - } - private selectFieldChangeHandler(e: __MaterialUI.TouchTapEvent, si: number, mi: any) { - } - - render() { - - // "http://material-ui.com/#/customization/themes" - let ThemeManager = new mui.Styles.ThemeManager(); - ThemeManager.setTheme(ThemeManager.types.LIGHT); - ThemeManager.setTheme(ThemeManager.types.DARK); - let muiTheme = ThemeManager.getCurrentTheme(); - ThemeManager.setComponentThemes({ - toggle: { - thumbOnColor: "#00bcd4", - trackOnColor: "LightCyan", - } - }); - - // "http://material-ui.com/#/customization/inline-styles" - let Checkbox = mui.Checkbox; - let element: React.ReactElement; - element = - element = React.createElement<__MaterialUI.CheckboxProps>(Checkbox, { - id: "checkboxId1", name: "checkboxName1", value: "checkboxValue1", label: "went for a run today", style: { - width: '50%', - margin: '0 auto' - }, iconStyle: { - fill: '#FF4081' - } - }); - - // "http://material-ui.com/#/customization/colors" - ThemeManager.setComponentThemes({ - toggle: { - thumbOnColor: Colors.cyan200, - thumbOffColor: Colors.grey400, - } - }); - - // "http://material-ui.com/#/components/appbar" - element = - element = } - iconElementRight={} />; - - // "http://material-ui.com/#/components/avatars" - //image avatar - element = ; - //SvgIcon avatar - element = } />; - //SvgIcon avatar with custom colors - element = } - color={Colors.orange200} - backgroundColor={Colors.pink400} />; - //FontIcon avatar - element = - } />; - //FontIcon avatar with custom colors - element = } - color={Colors.blue300} - backgroundColor={Colors.indigo900} />; - //Letter avatar - element = A; - //Letter avatar with custom colors - element = - - - - // "http://material-ui.com/#/components/buttons" - element = - - ; - element = - - ; - element = - - ; - - // "http://material-ui.com/#/components/cards" - element = - A} - showExpandableButton={true}> - - - Lorem ipsum dolor sit amet, consectetur adipiscing elit. - - - - - - - Lorem ipsum dolor sit amet, consectetur adipiscing elit. - - ; - - // "http://material-ui.com/#/components/date-picker" - - - // "http://material-ui.com/#/components/dialog" - let standardActions = [ - { text: 'Cancel' }, - { text: 'Submit', onTouchTap: this.touchTapEventHandler, ref: 'submit' } - ]; - - element = - The actions in this window are created from the json that's passed in. - ; - - //Custom Actions - let customActions = [ - , - - ]; - - element = - The actions in this window were passed in as an array of react objects. - ; - - - // "http://material-ui.com/#/components/dropdown-menu" - let menuItems = [ - { payload: '1', text: 'Never' }, - { payload: '2', text: 'Every Night' }, - { payload: '3', text: 'Weeknights' }, - { payload: '4', text: 'Weekends' }, - { payload: '5', text: 'Weekly' }, - ]; - element = ; - - // "http://material-ui.com/#/components/icons" - element = home; - - // "http://material-ui.com/#/components/icon-buttons" - //Method 1: muidocs-icon-github is defined in a style sheet. - element = ; - //Method 2: ActionGrade is a component created using mui.SvgIcon. - element = - - ; - //Method 3: Manually creating a mui.FontIcon component within IconButton - element = - - ; - //Method 4: Using Google material-icons - element = settings_system_daydream; - - // "http://material-ui.com/#/components/icon-menus" - element = }> - - - - - - ; - - // "http://material-ui.com/#/components/left-nav" - - - // "http://material-ui.com/#/components/lists" - - - // "http://material-ui.com/#/components/menus" - element = - - - - - ; - element = - - - - - - - - } /> - } /> - } /> - } /> - } /> - - - ; - - // "http://material-ui.com/#/components/paper" - - - // "http://material-ui.com/#/components/progress" - - - // "http://material-ui.com/#/components/refresh-indicator" - - - // "http://material-ui.com/#/components/sliders" - - - // "http://material-ui.com/#/components/switches" - element = ; - element = ; - element = } - unCheckedIcon={} - label="custom icon" />; - - element = - ; - ; - - ; - - element = ; - - element = ; - - element = ; - - // "http://material-ui.com/#/components/snackbar" - - - // "http://material-ui.com/#/components/table" - - - // "http://material-ui.com/#/components/tabs" - - - // "http://material-ui.com/#/components/text-fields" - element = ; - element = ; - element = ; - element = ; - element = ('valueLinkValue') } />; - element = ; - element = ; - element = ; - element = ; - element = ; - element = ; - element = ; - - //Select Fields - let arbitraryArrayMenuItems = [ - { - id: 0, - name: "zero", - }, - ]; - element = ; - element = ; - element = ; - element = ; - - //Floating Hint Text Labels - element = ; - element = ; - element = ; - element = ('floatingValueLinkValue') } />; - element = ; - element = ; - element = ; - element = ; - element = ; - element = ; - - - // "http://material-ui.com/#/components/time-picker" - - - // "http://material-ui.com/#/components/toolbars" - - return element; - } -} diff --git a/material-ui/legacy/material-ui-0.11.1.d.ts b/material-ui/legacy/material-ui-0.11.1.d.ts deleted file mode 100644 index 8d457b7cf5..0000000000 --- a/material-ui/legacy/material-ui-0.11.1.d.ts +++ /dev/null @@ -1,2096 +0,0 @@ -// Type definitions for material-ui v0.11.1 -// Project: https://github.com/callemall/material-ui -// Definitions by: Nathan Brown -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -/// - -declare module "material-ui" { - // The reason for exporting the namespace types (__MaterialUI.*) is to also export the type for casting variable. - - export import AppBar = __MaterialUI.AppBar; // require('material-ui/lib/app-bar'); - export import AppCanvas = __MaterialUI.AppCanvas; // require('material-ui/lib/app-canvas'); - export import Avatar = __MaterialUI.Avatar; // require('material-ui/lib/avatar'); - export import BeforeAfterWrapper = __MaterialUI.BeforeAfterWrapper; // require('material-ui/lib/before-after-wrapper'); - export import Card = __MaterialUI.Card.Card; // require('material-ui/lib/card/card'); - export import CardActions = __MaterialUI.Card.CardActions; // require('material-ui/lib/card/card-actions'); - export import CardExpandable = __MaterialUI.Card.CardExpandable; // require('material-ui/lib/card/card-expandable'); - export import CardHeader = __MaterialUI.Card.CardHeader; // require('material-ui/lib/card/card-header'); - export import CardMedia = __MaterialUI.Card.CardMedia; // require('material-ui/lib/card/card-media'); - export import CardText = __MaterialUI.Card.CardText; // require('material-ui/lib/card/card-text'); - export import CardTitle = __MaterialUI.Card.CardTitle; // require('material-ui/lib/card/card-title'); - export import Checkbox = __MaterialUI.Checkbox; // require('material-ui/lib/checkbox'); - export import CircularProgress = __MaterialUI.CircularProgress; // require('material-ui/lib/circular-progress'); - export import ClearFix = __MaterialUI.ClearFix; // require('material-ui/lib/clearfix'); - export import DatePicker = __MaterialUI.DatePicker.DatePicker; // require('material-ui/lib/date-picker/date-picker'); - export import DatePickerDialog = __MaterialUI.DatePicker.DatePickerDialog; // require('material-ui/lib/date-picker/date-picker-dialog'); - export import Dialog = __MaterialUI.Dialog // require('material-ui/lib/dialog'); - export import DropDownIcon = __MaterialUI.DropDownIcon; // require('material-ui/lib/drop-down-icon'); - export import DropDownMenu = __MaterialUI.DropDownMenu; // require('material-ui/lib/drop-down-menu'); - export import EnhancedButton = __MaterialUI.EnhancedButton; // require('material-ui/lib/enhanced-button'); - export import FlatButton = __MaterialUI.FlatButton; // require('material-ui/lib/flat-button'); - export import FloatingActionButton = __MaterialUI.FloatingActionButton; // require('material-ui/lib/floating-action-button'); - export import FontIcon = __MaterialUI.FontIcon; // require('material-ui/lib/font-icon'); - export import IconButton = __MaterialUI.IconButton; // require('material-ui/lib/icon-button'); - export import IconMenu = __MaterialUI.Menus.IconMenu; // require('material-ui/lib/menus/icon-menu'); - export import LeftNav = __MaterialUI.LeftNav; // require('material-ui/lib/left-nav'); - export import LinearProgress = __MaterialUI.LinearProgress; // require('material-ui/lib/linear-progress'); - export import List = __MaterialUI.Lists.List; // require('material-ui/lib/lists/list'); - export import ListDivider = __MaterialUI.Lists.ListDivider; // require('material-ui/lib/lists/list-divider'); - export import ListItem = __MaterialUI.Lists.ListItem; // require('material-ui/lib/lists/list-item'); - export import Menu = __MaterialUI.Menu.Menu; // require('material-ui/lib/menu/menu'); - export import MenuItem = __MaterialUI.Menu.MenuItem; // require('material-ui/lib/menu/menu-item'); - export import Mixins = __MaterialUI.Mixins; // require('material-ui/lib/mixins/'); - export import Overlay = __MaterialUI.Overlay; // require('material-ui/lib/overlay'); - export import Paper = __MaterialUI.Paper; // require('material-ui/lib/paper'); - export import RadioButton = __MaterialUI.RadioButton; // require('material-ui/lib/radio-button'); - export import RadioButtonGroup = __MaterialUI.RadioButtonGroup; // require('material-ui/lib/radio-button-group'); - export import RaisedButton = __MaterialUI.RaisedButton; // require('material-ui/lib/raised-button'); - export import RefreshIndicator = __MaterialUI.RefreshIndicator; // require('material-ui/lib/refresh-indicator'); - export import Ripples = __MaterialUI.Ripples; // require('material-ui/lib/ripples/'); - export import SelectField = __MaterialUI.SelectField; // require('material-ui/lib/select-field'); - export import Slider = __MaterialUI.Slider; // require('material-ui/lib/slider'); - export import SvgIcon = __MaterialUI.SvgIcon; // require('material-ui/lib/svg-icon'); - - import NavigationMenu = require('material-ui/lib/svg-icons/navigation/menu'); - import NavigationChevronLeft = require('material-ui/lib/svg-icons/navigation/chevron-left'); - import NavigationChevronRight = require('material-ui/lib/svg-icons/navigation/chevron-right'); - export var Icons: { - NavigationMenu: __MaterialUI.NavigationMenu; - NavigationChevronLeft: __MaterialUI.NavigationChevronLeft; - NavigationChevronRight: __MaterialUI.NavigationChevronRight; - }; - - export import Styles = __MaterialUI.Styles; // require('material-ui/lib/styles/'); - export import Snackbar = __MaterialUI.Snackbar; // require('material-ui/lib/snackbar'); - export import Tab = __MaterialUI.Tabs.Tab; // require('material-ui/lib/tabs/tab'); - export import Tabs = __MaterialUI.Tabs.Tabs; // require('material-ui/lib/tabs/tabs'); - export import Table = __MaterialUI.Table.Table; // require('material-ui/lib/table/table'); - export import TableBody = __MaterialUI.Table.TableBody; // require('material-ui/lib/table/table-body'); - export import TableFooter = __MaterialUI.Table.TableFooter; // require('material-ui/lib/table/table-footer'); - export import TableHeader = __MaterialUI.Table.TableHeader; // require('material-ui/lib/table/table-header'); - export import TableHeaderColumn = __MaterialUI.Table.TableHeaderColumn; // require('material-ui/lib/table/table-header-column'); - export import TableRow = __MaterialUI.Table.TableRow; // require('material-ui/lib/table/table-row'); - export import TableRowColumn = __MaterialUI.Table.TableRowColumn; // require('material-ui/lib/table/table-row-column'); - export import Theme = __MaterialUI.Theme; // require('material-ui/lib/theme'); - export import Toggle = __MaterialUI.Toggle; // require('material-ui/lib/toggle'); - export import TimePicker = __MaterialUI.TimePicker; // require('material-ui/lib/time-picker'); - export import TextField = __MaterialUI.TextField; // require('material-ui/lib/text-field'); - export import Toolbar = __MaterialUI.Toolbar.Toolbar; // require('material-ui/lib/toolbar/toolbar'); - export import ToolbarGroup = __MaterialUI.Toolbar.ToolbarGroup; // require('material-ui/lib/toolbar/toolbar-group'); - export import ToolbarSeparator = __MaterialUI.Toolbar.ToolbarSeparator; // require('material-ui/lib/toolbar/toolbar-separator'); - export import ToolbarTitle = __MaterialUI.Toolbar.ToolbarTitle; // require('material-ui/lib/toolbar/toolbar-title'); - export import Tooltip = __MaterialUI.Tooltip; // require('material-ui/lib/tooltip'); - export import Utils = __MaterialUI.Utils; // require('material-ui/lib/utils/'); - - // export type definitions - export import TouchTapEvent = __MaterialUI.TouchTapEvent; - export import TouchTapEventHandler = __MaterialUI.TouchTapEventHandler; - export import DialogAction = __MaterialUI.DialogAction; -} - -declare namespace __MaterialUI { - import React = __React; - - // ReactLink is from "react/addons" - interface ReactLink { - value: T; - requestChange(newValue: T): void; - } - - // What's common between React.TouchEvent and React.MouseEvent - interface TouchTapEvent extends React.SyntheticEvent { - altKey: boolean; - ctrlKey: boolean; - getModifierState(key: string): boolean; - metaKey: boolean; - shiftKey: boolean; - } - - // What's common between React.TouchEventHandler and React.MouseEventHandler - interface TouchTapEventHandler extends React.EventHandler { } - - // more specific than React.HTMLAttributes - - interface AppBarProps extends React.Props { - iconClassNameLeft?: string; - iconClassNameRight?: string; - iconElementLeft?: React.ReactElement; - iconElementRight?: React.ReactElement; - iconStyleRight?: string; - style?: React.CSSProperties; - showMenuIconButton?: boolean; - title?: React.ReactNode; - zDepth?: number; - - onLeftIconButtonTouchTap?: TouchTapEventHandler; - onRightIconButtonTouchTap?: TouchTapEventHandler; - } - export class AppBar extends React.Component{ - } - - interface AppCanvasProps extends React.Props { - } - export class AppCanvas extends React.Component { - } - - interface AvatarProps extends React.Props { - icon?: React.ReactElement; - backgroundColor?: string; - color?: string; - size?: number; - src?: string; - style?: React.CSSProperties; - } - export class Avatar extends React.Component { - } - - interface BeforeAfterWrapperProps extends React.Props { - beforeStyle?: React.CSSProperties; - afterStyle?: React.CSSProperties; - beforeElementType?: string; - afterElementType?: string; - elementType?: string; - } - export class BeforeAfterWrapper extends React.Component { - } - - namespace Card { - - interface CardProps extends React.Props { - expandable?: boolean; - initiallyExpanded?: boolean; - onExpandedChange?: (isExpanded: boolean) => void; - style?: React.CSSProperties; - } - export class Card extends React.Component { - } - - interface CardActionsProps extends React.Props { - expandable?: boolean; - showExpandableButton?: boolean; - } - export class CardActions extends React.Component { - } - - interface CardExpandableProps extends React.Props { - onExpanding?: (isExpanded: boolean) => void; - expanded?: boolean; - } - export class CardExpandable extends React.Component { - } - - interface CardHeaderProps extends React.Props { - expandable?: boolean; - showExpandableButton?: boolean; - title?: string | React.ReactElement; - titleColor?: string; - titleStyle?: React.CSSProperties; - subtitle?: string | React.ReactElement; - subtitleColor?: string; - subtitleStyle?: React.CSSProperties; - textStyle?: React.CSSProperties; - style?: React.CSSProperties; - avatar: React.ReactElement | string; - } - export class CardHeader extends React.Component { - } - - interface CardMediaProps extends React.Props { - expandable?: boolean; - overlay?: React.ReactNode; - overlayStyle?: React.CSSProperties; - overlayContainerStyle?: React.CSSProperties; - overlayContentStyle?: React.CSSProperties; - mediaStyle?: React.CSSProperties; - style?: React.CSSProperties; - } - export class CardMedia extends React.Component { - } - - interface CardTextProps extends React.Props { - expandable?: boolean; - color?: string; - style?: React.CSSProperties; - } - export class CardText extends React.Component { - } - - interface CardTitleProps extends React.Props { - expandable?: boolean; - showExpandableButton?: boolean; - title?: string | React.ReactElement; - titleColor?: string; - titleStyle?: React.CSSProperties; - subtitle?: string | React.ReactElement; - subtitleColor?: string; - subtitleStyle?: React.CSSProperties; - textStyle?: React.CSSProperties; - style?: React.CSSProperties; - } - export class CardTitle extends React.Component { - } - } - - // what's not commonly overridden by Checkbox, RadioButton, or Toggle - interface CommonEnhancedSwitchProps extends React.HTMLAttributesBase { - // is root element - id?: string; - iconStyle?: React.CSSProperties; - labelStyle?: React.CSSProperties; - rippleStyle?: React.CSSProperties; - thumbStyle?: React.CSSProperties; - trackStyle?: React.CSSProperties; - name?: string; - value?: string; - label?: string; - required?: boolean; - disabled?: boolean; - defaultSwitched?: boolean; - disableFocusRipple?: boolean; - disableTouchRipple?: boolean; - } - - interface EnhancedSwitchProps extends CommonEnhancedSwitchProps { - // is root element - inputType: string; - switchElement: React.ReactElement; - onParentShouldUpdate: (isInputChecked: boolean) => void; - switched: boolean; - rippleColor?: string; - onSwitch?: (e: React.MouseEvent, isInputChecked: boolean) => void; - labelPosition?: string; - } - export class EnhancedSwitch extends React.Component { - isSwitched(): boolean; - setSwitched(newSwitchedValue: boolean): void; - getValue(): any; - isKeyboardFocused(): boolean; - } - - interface CheckboxProps extends CommonEnhancedSwitchProps { - // is root element - checkedIcon?: React.ReactElement<{ style?: React.CSSProperties }>; // Normally an SvgIcon - defaultChecked?: boolean; - iconStyle?: React.CSSProperties; - label?: string; - labelStyle?: React.CSSProperties; - labelPosition?: string; - style?: React.CSSProperties; - checked?: boolean; - unCheckedIcon?: React.ReactElement<{ style?: React.CSSProperties }>; // Normally an SvgIcon - - disabled?: boolean; - valueLink?: ReactLink; - checkedLink?: ReactLink; - - onCheck?: (event: React.MouseEvent, checked: boolean) => void; - } - export class Checkbox extends React.Component { - isChecked(): void; - setChecked(newCheckedValue: boolean): void; - } - - interface CircularProgressProps extends React.Props { - mode?: string; - value?: number; - min?: number; - max?: number; - size?: number; - color?: string; - innerStyle?: React.CSSProperties; - - } - export class CircularProgress extends React.Component { - } - - interface ClearFixProps extends React.Props { - } - export class ClearFix extends React.Component { - } - - namespace DatePicker { - interface DatePickerProps extends React.Props { - autoOk?: boolean; - defaultDate?: Date; - formatDate?: string; - hideToolbarYearChange?: boolean; - maxDate?: Date; - minDate?: Date; - mode?: string; - onDismiss?: () => void; - - // e is always null - onChange?: (e: any, d: Date) => void; - - onFocus?: React.FocusEventHandler; - onShow?: () => void; - onTouchTap?: React.TouchEventHandler; - shouldDisableDate?: (day: Date) => boolean; - showYearSelector?: boolean; - textFieldStyle?: React.CSSProperties; - } - export class DatePicker extends React.Component { - } - - interface DatePickerDialogProps extends React.Props { - disableYearSelection?: boolean; - initialDate?: Date; - maxDate?: Date; - minDate?: Date; - onAccept?: (d: Date) => void; - onClickAway?: () => void; - onDismiss?: () => void; - onShow?: () => void; - shouldDisableDate?: (day: Date) => boolean; - showYearSelector?: boolean; - } - export class DatePickerDialog extends React.Component { - } - } - - export interface DialogAction { - text: string; - ref?: string; - - onTouchTap?: TouchTapEventHandler; - onClick?: React.MouseEventHandler; - } - interface DialogProps extends React.Props { - actions?: Array>; - actionFocus?: string; - autoDetectWindowHeight?: boolean; - autoScrollBodyContent?: boolean; - bodyStyle?: React.CSSProperties; - contentClassName?: string; - contentInnerStyle?: React.CSSProperties; - contentStyle?: React.CSSProperties; - modal?: boolean; - openImmediately?: boolean; - repositionOnUpdate?: boolean; - title?: React.ReactNode; - - onClickAway?: () => void; - onDismiss?: () => void; - onShow?: () => void; - } - export class Dialog extends React.Component { - dismiss(): void; - show(): void; - } - - interface DropDownIconProps extends React.Props { - menuItems: Menu.MenuItemRequest[]; - closeOnMenuItemTouchTap?: boolean; - iconStyle?: React.CSSProperties; - iconClassName?: string; - iconLigature?: string; - - onChange?: Menu.ItemTapEventHandler; - } - export class DropDownIcon extends React.Component { - } - - interface DropDownMenuProps extends React.Props { - displayMember?: string; - valueMember?: string; - autoWidth?: boolean; - menuItems: Menu.MenuItemRequest[]; - menuItemStyle?: React.CSSProperties; - selectedIndex?: number; - underlineStyle?: React.CSSProperties; - iconStyle?: React.CSSProperties; - labelStyle?: React.CSSProperties; - style?: React.CSSProperties; - disabled?: boolean; - valueLink?: ReactLink; - value?: number; - - onChange?: Menu.ItemTapEventHandler; - } - export class DropDownMenu extends React.Component { - } - - // non generally overridden elements of EnhancedButton - interface SharedEnhancedButtonProps extends React.HTMLAttributesBase { - centerRipple?: boolean; - containerElement?: string | React.ReactElement; - disabled?: boolean; - disableFocusRipple?: boolean; - disableKeyboardFocus?: boolean; - disableTouchRipple?: boolean; - keyboardFocused?: boolean; - linkButton?: boolean; - focusRippleColor?: string; - focusRippleOpacity?: number; - touchRippleOpacity?: number; - tabIndex?: number; - - onBlur?: React.FocusEventHandler; - onFocus?: React.FocusEventHandler; - onKeyboardFocus?: (e: React.FocusEvent, isKeyboardFocused: boolean) => void; - onKeyDown?: React.KeyboardEventHandler; - onKeyUp?: React.KeyboardEventHandler; - onMouseEnter?: React.MouseEventHandler; - onMouseLeave?: React.MouseEventHandler; - onTouchStart?: React.TouchEventHandler; - onTouchEnd?: React.TouchEventHandler; - onTouchTap?: TouchTapEventHandler; - } - - interface EnhancedButtonProps extends SharedEnhancedButtonProps { - touchRippleColor?: string; - focusRippleColor?: string; - style?: React.CSSProperties; - } - export class EnhancedButton extends React.Component { - } - - interface FlatButtonProps extends SharedEnhancedButtonProps { - hoverColor?: string; - label?: string; - labelPosition?: string; - labelStyle?: React.CSSProperties; - linkButton?: boolean; - primary?: boolean; - secondary?: boolean; - rippleColor?: string; - style?: React.CSSProperties; - } - export class FlatButton extends React.Component { - } - - interface FloatingActionButtonProps extends SharedEnhancedButtonProps { - backgroundColor?: string; - disabled?: boolean; - disabledColor?: string; - iconClassName?: string; - iconStyle?: React.CSSProperties; - mini?: boolean; - secondary?: boolean; - style?: React.CSSProperties; - } - export class FloatingActionButton extends React.Component { - } - - interface FontIconProps extends React.Props { - color?: string; - hoverColor?: string; - onMouseLeave?: React.MouseEventHandler; - onMouseEnter?: React.MouseEventHandler; - style?: React.CSSProperties; - className?: string; - } - export class FontIcon extends React.Component { - } - - interface IconButtonProps extends SharedEnhancedButtonProps { - iconClassName?: string; - iconStyle?: React.CSSProperties; - style?: React.CSSProperties; - tooltip?: string; - tooltipPosition?: string; - tooltipStyles?: React.CSSProperties; - touch?: boolean; - - onBlur?: React.FocusEventHandler; - onFocus?: React.FocusEventHandler; - } - export class IconButton extends React.Component { - } - - interface LeftNavProps extends React.Props { - disableSwipeToOpen?: boolean; - docked?: boolean; - header?: React.ReactElement; - menuItems: Menu.MenuItemRequest[]; - onChange?: Menu.ItemTapEventHandler; - onNavOpen?: () => void; - onNavClose?: () => void; - openRight?: Boolean; - selectedIndex?: number; - menuItemClassName?: string; - menuItemClassNameSubheader?: string; - menuItemClassNameLink?: string; - } - export class LeftNav extends React.Component { - } - - interface LinearProgressProps extends React.Props { - mode?: string; - value?: number; - min?: number; - max?: number; - } - export class LinearProgress extends React.Component { - } - - namespace Lists { - interface ListProps extends React.Props { - insetSubheader?: boolean; - subheader?: string; - subheaderStyle?: React.CSSProperties; - zDepth?: number; - } - export class List extends React.Component { - } - - interface ListDividerProps extends React.Props { - inset?: boolean; - } - export class ListDivider extends React.Component { - } - - interface ListItemProps extends React.Props { - autoGenerateNestedIndicator?: boolean; - disableKeyboardFocus?: boolean; - initiallyOpen?: boolean; - innerDivStyle?: React.CSSProperties; - insetChildren?: boolean; - innerStyle?: React.CSSProperties; - leftAvatar?: React.ReactElement; - leftCheckbox?: React.ReactElement; - leftIcon?: React.ReactElement; - nestedLevel?: number; - nestedItems?: React.ReactElement[]; - onKeyboardFocus?: React.FocusEventHandler; - onNestedListToggle?: (item: ListItem) => void; - rightAvatar?: React.ReactElement; - rightIcon?: React.ReactElement; - rightIconButton?: React.ReactElement; - rightToggle?: React.ReactElement; - primaryText?: React.ReactNode; - secondaryText?: React.ReactNode; - secondaryTextLines?: number; - } - export class ListItem extends React.Component { - } - } - - // Old menu implementation. Being replaced by new "menus". - namespace Menu { - interface ItemTapEventHandler { - (e: TouchTapEvent, index: number, menuItem: MenuItemRequest): void; - } - - // almost extends MenuItemProps, but certain required items are generated in Menu and not passed here. - interface MenuItemRequest extends React.Props { - // use value from MenuItem.Types.* - type?: string; - - text?: string; - data?: string; - payload?: string; - icon?: React.ReactElement; - attribute?: string; - number?: string; - toggle?: boolean; - onTouchTap?: TouchTapEventHandler; - isDisabled?: boolean; - - // for MenuItems.Types.NESTED - items?: MenuItemRequest[]; - - // for custom text or payloads - [propertyName: string]: any; - } - - interface MenuProps extends React.Props { - index: number; - text?: string; - menuItems: MenuItemRequest[]; - zDepth?: number; - active?: boolean; - onItemTap?: ItemTapEventHandler; - menuItemStyle?: React.CSSProperties; - } - export class Menu extends React.Component { - } - - interface MenuItemProps extends React.Props { - index: number; - icon?: React.ReactElement; - iconClassName?: string; - iconRightClassName?: string; - iconStyle?: React.CSSProperties; - iconRightStyle?: React.CSSProperties; - attribute?: string; - number?: string; - data?: string; - toggle?: boolean; - onTouchTap?: (e: React.MouseEvent, key: number) => void; - onToggle?: (e: React.MouseEvent, key: number, toggled: boolean) => void; - selected?: boolean; - active?: boolean; - } - export class MenuItem extends React.Component { - static Types: { LINK: string, SUBHEADER: string, NESTED: string, } - } - } - - export namespace Mixins { - interface ClickAwayable extends React.Mixin { - } - var ClickAwayable: ClickAwayable; - - interface WindowListenable extends React.Mixin { - } - var WindowListenable: WindowListenable; - - interface StylePropable extends React.Mixin { - } - var StylePropable: StylePropable - - interface StyleResizable extends React.Mixin { - } - var StyleResizable: StyleResizable - } - - interface OverlayProps extends React.Props { - autoLockScrolling?: boolean; - show?: boolean; - transitionEnabled?: boolean; - } - export class Overlay extends React.Component { - } - - interface PaperProps extends React.Props { - circle?: boolean; - rounded?: boolean; - transitionEnabled?: boolean; - zDepth?: number; - } - export class Paper extends React.Component { - } - - interface RadioButtonProps extends CommonEnhancedSwitchProps { - // is root element - defaultChecked?: boolean; - iconStyle?: React.CSSProperties; - label?: string; - labelStyle?: React.CSSProperties; - labelPosition?: string; - style?: React.CSSProperties; - value?: string; - - onCheck?: (e: React.FormEvent, selected: string) => void; - } - export class RadioButton extends React.Component { - } - - interface RadioButtonGroupProps extends React.Props { - defaultSelected?: string; - labelPosition?: string; - name: string; - style?: React.CSSProperties; - valueSelected?: string; - - onChange?: (e: React.FormEvent, selected: string) => void; - } - export class RadioButtonGroup extends React.Component { - getSelectedValue(): string; - setSelectedValue(newSelectionValue: string): void; - clearValue(): void; - } - - interface RaisedButtonProps extends SharedEnhancedButtonProps { - className?: string; - disabled?: boolean; - label?: string; - primary?: boolean; - secondary?: boolean; - labelStyle?: React.CSSProperties; - backgroundColor?: string; - labelColor?: string; - disabledBackgroundColor?: string; - disabledLabelColor?: string; - fullWidth?: boolean; - } - export class RaisedButton extends React.Component { - } - - interface RefreshIndicatorProps extends React.Props { - left: number; - percentage?: number; - size?: number; - status?: string; - top: number; - } - export class RefreshIndicator extends React.Component { - } - - namespace Ripples { - interface CircleRippleProps extends React.Props { - color?: string; - opacity?: number; - } - export class CircleRipple extends React.Component { - } - - interface FocusRippleProps extends React.Props { - color?: string; - innerStyle?: React.CSSProperties; - opacity?: number; - show?: boolean; - } - export class FocusRipple extends React.Component { - } - - interface TouchRippleProps extends React.Props { - centerRipple?: boolean; - color?: string; - opacity?: number; - } - export class TouchRipple extends React.Component { - } - } - - interface SelectFieldProps extends React.Props { - // passed to TextField - errorStyle?: React.CSSProperties; - errorText?: string; - floatingLabelText?: string; - floatingLabelStyle?: React.CSSProperties; - fullWidth?: boolean; - hintText?: string | React.ReactElement; - - // passed to DropDownMenu - displayMember?: string; - valueMember?: string; - autoWidth?: boolean; - menuItems: Menu.MenuItemRequest[]; - menuItemStyle?: React.CSSProperties; - selectedIndex?: number; - underlineStyle?: React.CSSProperties; - iconStyle?: React.CSSProperties; - labelStyle?: React.CSSProperties; - style?: React.CSSProperties; - disabled?: boolean; - valueLink?: ReactLink; - value?: number; - - onChange?: Menu.ItemTapEventHandler; - onEnterKeyDown?: React.KeyboardEventHandler; - - // own properties - selectFieldRoot?: string; - multiLine?: boolean; - type?: string; - rows?: number; - inputStyle?: React.CSSProperties; - } - export class SelectField extends React.Component { - } - - interface SliderProps extends React.Props { - name: string; - defaultValue?: number; - description?: string; - error?: string; - max?: number; - min?: number; - required?: boolean; - step?: number; - value?: number; - } - export class Slider extends React.Component { - } - - interface SvgIconProps extends React.Props { - color?: string; - hoverColor?: string; - viewBox?: string; - } - export class SvgIcon extends React.Component { - } - - interface NavigationMenuProps extends React.Props { - } - export class NavigationMenu extends React.Component { - } - - interface NavigationChevronLeftProps extends React.Props { - } - export class NavigationChevronLeft extends React.Component { - } - - interface NavigationChevronRightProps extends React.Props { - } - export class NavigationChevronRight extends React.Component { - } - - export namespace Styles { - interface AutoPrefix { - all(styles: React.CSSProperties): React.CSSProperties; - set(style: React.CSSProperties, key: string, value: string | number): void; - single(key: string): string; - singleHyphened(key: string): string; - } - export var AutoPrefix: AutoPrefix; - - interface Spacing { - iconSize?: number; - - desktopGutter?: number; - desktopGutterMore?: number; - desktopGutterLess?: number; - desktopGutterMini?: number; - desktopKeylineIncrement?: number; - desktopDropDownMenuItemHeight?: number; - desktopDropDownMenuFontSize?: number; - desktopLeftNavMenuItemHeight?: number; - desktopSubheaderHeight?: number; - desktopToolbarHeight?: number; - } - interface ThemePalette { - primary1Color?: string, - primary2Color?: string, - primary3Color?: string, - accent1Color?: string, - accent2Color?: string, - accent3Color?: string, - textColor?: string, - canvasColor?: string, - borderColor?: string, - disabledColor?: string - } - interface Theme { - appBar?: { - color?: string, - textColor?: string, - height?: number - }, - button?: { - height?: number, - minWidth?: number, - iconButtonSize?: number - }, - checkbox?: { - boxColor?: string, - checkedColor?: string, - requiredColor?: string, - disabledColor?: string, - labelColor?: string, - labelDisabledColor?: string - }, - datePicker?: { - color?: string, - textColor?: string, - calendarTextColor?: string, - selectColor?: string, - selectTextColor?: string, - }, - dropDownMenu?: { - accentColor?: string, - }, - flatButton?: { - color?: string, - textColor?: string, - primaryTextColor?: string, - secondaryTextColor?: string, - disabledColor?: string - }, - floatingActionButton?: { - buttonSize?: number, - miniSize?: number, - color?: string, - iconColor?: string, - secondaryColor?: string, - secondaryIconColor?: string, - disabledColor?: string, - disabledTextColor?: string - }, - leftNav?: { - width?: number, - color?: string, - }, - menu?: { - backgroundColor?: string, - containerBackgroundColor?: string, - }, - menuItem?: { - dataHeight?: number, - height?: number, - hoverColor?: string, - padding?: number, - selectedTextColor?: string, - }, - menuSubheader?: { - padding?: number, - borderColor?: string, - textColor?: string, - }, - paper?: { - backgroundColor?: string, - }, - radioButton?: { - borderColor?: string, - backgroundColor?: string, - checkedColor?: string, - requiredColor?: string, - disabledColor?: string, - size?: number, - labelColor?: string, - labelDisabledColor?: string - }, - raisedButton?: { - color?: string, - textColor?: string, - primaryColor?: string, - primaryTextColor?: string, - secondaryColor?: string, - secondaryTextColor?: string, - disabledColor?: string, - disabledTextColor?: string - }, - slider?: { - trackSize?: number, - trackColor?: string, - trackColorSelected?: string, - handleSize?: number, - handleSizeActive?: number, - handleSizeDisabled?: number, - handleColorZero?: string, - handleFillColor?: string, - selectionColor?: string, - rippleColor?: string, - }, - snackbar?: { - textColor?: string, - backgroundColor?: string, - actionColor?: string, - }, - toggle?: { - thumbOnColor?: string, - thumbOffColor?: string, - thumbDisabledColor?: string, - thumbRequiredColor?: string, - trackOnColor?: string, - trackOffColor?: string, - trackDisabledColor?: string, - trackRequiredColor?: string, - labelColor?: string, - labelDisabledColor?: string - }, - toolbar?: { - backgroundColor?: string, - height?: number, - titleFontSize?: number, - iconColor?: string, - separatorColor?: string, - menuHoverColor?: string, - } - } - interface CustomTheme { - spacing?: Spacing; - contentFontFamily?: string; - getPalette(): ThemePalette; - getComponentThemes(palette: ThemePalette, spacing: Spacing): Theme; - } - - export class ThemeManager { - static: boolean; - spacing: Spacing; - palette: ThemePalette; - component: Theme; - contentFontFamily: string; - template: CustomTheme; - types: { - LIGHT: CustomTheme; - DARK: CustomTheme; - }; - - getCurrentTheme(): ThemeManager; - setContentFontFamily(newContentFontFamily: string): void; - setTheme(newTheme: CustomTheme): void; - setSpacing(newSpacing: Spacing): void; - setPalette(newPalette: ThemePalette): void; - setComponentThemes(overrides: Theme): void; - setIsRtl(isRtl: boolean): void; - } - - interface Transitions { - easeOut(duration?: string, property?: string | string[], delay?: string, easeFunction?: string): string; - create(duration?: string, property?: string, delay?: string, easeFunction?: string): string; - easeOutFunction: string; - easeInOutFunction: string; - } - export var Transitions: Transitions; - - interface Typography { - textFullBlack:string; - textDarkBlack: string; - textLightBlack: string; - textMinBlack: string; - textFullWhite: string; - textDarkWhite: string; - textLightWhite: string; - - // font weight - fontWeightLight: number; - fontWeightNormal: number; - fontWeightMedium: number; - - fontStyleButtonFontSize: number; - } - export var Typography: Typography; - } - - interface SnackbarProps extends React.Props { - message: string; - action?: string; - autoHideDuration?: number; - onActionTouchTap?: React.TouchEventHandler; - onShow?: () => void; - onDismiss?: () => void; - openOnMount?: boolean; - } - export class Snackbar extends React.Component { - } - - namespace Tabs { - interface TabProps extends React.Props { - label?: string; - value?: string; - selected?: boolean; - width?: string; - - // Called by Tabs component - onActive?: (tab: Tab) => void; - - onTouchTap?: (value: string, e: TouchTapEvent, tab: Tab) => void; - } - export class Tab extends React.Component { - } - - interface TabsProps extends React.Props { - contentContainerStyle?: React.CSSProperties; - initialSelectedIndex?: number; - inkBarStyle?: React.CSSProperties; - style?: React.CSSProperties; - tabItemContainerStyle?: React.CSSProperties; - tabWidth?: number; - value?: string | number; - - onChange?: (value: string | number, e: React.FormEvent, tab: Tab) => void; - } - export class Tabs extends React.Component { - } - } - - namespace Table { - interface TableProps extends React.Props
{ - allRowsSelected?: boolean; - fixedFooter?: boolean; - fixedHeader?: boolean; - height?: string; - multiSelectable?: boolean; - onCellClick?: (row: number, column: number) => void; - onCellHover?: (row: number, column: number) => void; - onCellHoverExit?: (row: number, column: number) => void; - onRowHover?: (row: number) => void; - onRowHoverExit?: (row: number) => void; - onRowSelection?: (selectedRows: number[])=> void; - selectable?: boolean; - } - export class Table extends React.Component { - } - - interface TableBodyProps extends React.Props { - allRowsSelected?: boolean; - deselectOnClickaway?: boolean; - displayRowCheckbox?: boolean; - multiSelectable?: boolean; - onCellClick?: (row: number, column: number) => void; - onCellHover?: (row: number, column: number) => void; - onCellHoverExit?: (row: number, column: number) => void; - onRowHover?: (row: number) => void; - onRowHoverExit?: (row: number) => void; - onRowSelection?: (selectedRows: number[])=> void; - preScanRows?: boolean; - selectable?: boolean; - showRowHover?: boolean; - stripedRows?: boolean; - } - export class TableBody extends React.Component { - } - - interface TableFooterProps extends React.Props { - adjustForCheckbox?: boolean; - } - export class TableFooter extends React.Component { - } - - interface TableHeaderProps extends React.Props { - adjustForCheckbox?: boolean; - displaySelectAll?: boolean; - enableSelectAll?: boolean; - onSelectAll?: (event: React.MouseEvent) => void; - selectAllSelected?: boolean; - } - export class TableHeader extends React.Component { - } - - interface TableHeaderColumnProps extends React.Props { - columnNumber?: number; - onClick?: (e: React.MouseEvent, column: number) => void; - tooltip?: string; - tooltipStyle?: React.CSSProperties; - } - export class TableHeaderColumn extends React.Component { - } - - interface TableRowProps extends React.Props { - displayBorder?: boolean; - hoverable?: boolean; - onCellClick?: (e: React.MouseEvent, row: number, column: number) => void; - onCellHover?: (e: React.MouseEvent, row: number, column: number) => void; - onCellHoverExit?: (e: React.MouseEvent, row: number, column: number) => void; - onRowClick?: (e: React.MouseEvent, row: number) => void; - onRowHover?: (e: React.MouseEvent, row: number) => void; - onRowHoverExit?: (e: React.MouseEvent, row: number) => void; - rowNumber?: number; - selectable?: boolean; - selected?: boolean; - striped?: boolean; - } - export class TableRow extends React.Component { - } - - interface TableRowColumnProps extends React.Props { - columnNumber?: number; - hoverable?: boolean; - onHover?: (e: React.MouseEvent, column: number) => void; - onHoverExit?: (e: React.MouseEvent, column: number) => void; - } - export class TableRowColumn extends React.Component { - } - } - - interface ThemeProps extends React.Props { - theme: Styles.CustomTheme; - } - export class Theme extends React.Component { - static theme(customTheme: Styles.CustomTheme):

(Component: React.ComponentClass

) => React.ComponentClass

; - } - - interface ToggleProps extends CommonEnhancedSwitchProps { - // is root element - - elementStyle?: React.CSSProperties; - labelStyle?: React.CSSProperties; - onToggle?: (e: React.MouseEvent, isInputChecked: boolean) => void; - toggled?: boolean; - defaultToggled?: boolean; - } - export class Toggle extends React.Component { - isToggled(): boolean; - setToggled(newToggledValue: boolean): void; - } - - interface TimePickerProps extends React.Props { - defaultTime?: Date; - format?: string; - pedantic?: boolean; - onFocus?: React.FocusEventHandler; - onTouchTap?: TouchTapEventHandler; - onChange?: (e: any, time: Date) => void; - onShow?: () => void; - onDismiss?: () => void; - } - export class TimePicker extends React.Component { - } - - interface TextFieldProps extends React.Props { - errorStyle?: React.CSSProperties; - errorText?: string; - floatingLabelText?: string; - floatingLabelStyle?: React.CSSProperties; - fullWidth?: boolean; - hintText?: string | React.ReactElement; - id?: string; - inputStyle?: React.CSSProperties; - multiLine?: boolean; - onEnterKeyDown?: React.KeyboardEventHandler; - style?: React.CSSProperties; - rows?: number, - underlineStyle?: React.CSSProperties; - underlineFocusStyle?: React.CSSProperties; - underlineDisabledStyle?: React.CSSProperties; - type?: string; - - disabled?: boolean; - isRtl?: boolean; - value?: string; - defaultValue?: string; - valueLink?: ReactLink; - - onBlur?: React.FocusEventHandler; - onChange?: React.FormEventHandler; - onFocus?: React.FocusEventHandler; - onKeyDown?: React.KeyboardEventHandler; - } - export class TextField extends React.Component { - blur(): void; - clearValue(): void; - focus(): void; - getValue(): string; - setErrorText(newErrorText: string): void; - setValue(newValue: string): void; - } - - namespace Toolbar { - interface ToolbarProps extends React.Props { - } - export class Toolbar extends React.Component { - } - - interface ToolbarGroupProps extends React.Props { - float?: string; - } - export class ToolbarGroup extends React.Component { - } - - interface ToolbarSeparatorProps extends React.Props { - } - export class ToolbarSeparator extends React.Component { - } - - interface ToolbarTitleProps extends React.Props { - text?: string; - } - export class ToolbarTitle extends React.Component { - } - } - - interface TooltipProps extends React.Props { - label: string; - show?: boolean; - touch?: boolean; - verticalPosition?: string; - horizontalPosition?: string; - } - export class Tooltip extends React.Component { - } - - export namespace Utils { - interface ContrastLevel { - range: [number, number]; - color: string; - } - interface ColorManipulator { - fade(color: string, amount: string|number): string; - lighten(color: string, amount: string|number): string; - darken(color: string, amount: string|number): string; - contrastRatio(background: string, foreground: string): number; - contrastRatioLevel(background: string, foreground: string): ContrastLevel; - } - export var ColorManipulator: ColorManipulator; - - interface CssEvent { - transitionEndEventName(): string; - animationEndEventName(): string; - onTransitionEnd(el: Element, callback: () => void): void; - onAnimationEnd(el: Element, callback: () => void): void; - } - export var CssEvent: CssEvent; - - interface Dom { - isDescendant(parent: Node, child: Node): boolean; - offset(el: Element): { top: number, left: number }; - getStyleAttributeAsNumber(el: HTMLElement, attr: string): number; - addClass(el: Element, className: string): void; - removeClass(el: Element, className: string): void; - hasClass(el: Element, className: string): boolean; - toggleClass(el: Element, className: string): void; - forceRedraw(el: HTMLElement): void; - withoutTransition(el: HTMLElement, callback: () => void): void; - } - export var Dom: Dom; - - interface Events { - once(el: Element, type: string, callback: EventListener): void; - on(el: Element, type: string, callback: EventListener): void; - off(el: Element, type: string, callback: EventListener): void; - isKeyboard(e: Event): boolean; - } - export var Events: Events; - - function Extend(base: T, override: S1): (T & S1); - - interface ImmutabilityHelper { - merge(base: any, ...args: any[]): any; - mergeItem(obj: any, key: any, newValueObject: any): any; - push(array: any[], obj: any): any[]; - shift(array: any[]): any[]; - } - export var ImmutabilityHelper: ImmutabilityHelper; - - interface KeyCode { - DOWN: number; - ESC: number; - ENTER: number; - LEFT: number; - RIGHT: number; - SPACE: number; - TAB: number; - UP: number; - } - var KeyCode: KeyCode; - - interface KeyLine { - Desktop: { - GUTTER: number; - GUTTER_LESS: number; - INCREMENT: number; - MENU_ITEM_HEIGHT: number; - }; - - getIncrementalDim(dim: number): number; - } - export var KeyLine: KeyLine; - - interface UniqueId { - generate(): string; - } - export var UniqueId: UniqueId; - - interface Styles { - mergeAndPrefix(base: any, ...args: any[]): React.CSSProperties; - } - export var Styles: Styles; - } - - // New menus available only through requiring directly to the end file - namespace Menus { - interface IconMenuProps extends React.Props { - closeOnItemTouchTap?: boolean; - desktop?: boolean; - iconButtonElement: React.ReactElement; - openDirection?: string; - menuStyle?: React.CSSProperties; - multiple?: boolean; - value?: string | Array; - width?: string | number; - touchTapCloseDelay?: number; - - onKeyboardFocus?: React.FocusEventHandler; - onItemTouchTap?: (e: TouchTapEvent, item: React.ReactElement) => void; - onChange?: (e: React.FormEvent, value: string | Array) => void; - } - export class IconMenu extends React.Component { - } - - interface MenuProps extends React.Props

{ - animated?: boolean; - autoWidth?: boolean; - desktop?: boolean; - listStyle?: React.CSSProperties; - maxHeight?: number; - multiple?: boolean; - openDirection?: string; - value?: string | Array; - width?: string | number; - zDepth?: number; - } - export class Menu extends React.Component{ - } - - interface MenuItemProps extends React.Props { - checked?: boolean; - desktop?: boolean; - disabled?: boolean; - innerDivStyle?: React.CSSProperties; - insetChildren?: boolean; - leftIcon?: React.ReactElement; - primaryText?: string | React.ReactElement; - rightIcon?: React.ReactElement; - secondaryText?: React.ReactNode; - value?: string; - - onEscKeyDown?: React.KeyboardEventHandler; - onItemTouchTap?: (e: TouchTapEvent, item: React.ReactElement) => void; - onChange?: (e: React.FormEvent, value: string) => void; - } - export class MenuItem extends React.Component{ - } - - interface MenuDividerProps extends React.Props { - inset?: boolean; - style?: React.CSSProperties; - } - export class MenuDivider extends React.Component{ - } - } -} // __MaterialUI - -declare module 'material-ui/lib/app-bar' { - export = __MaterialUI.AppBar; -} - -declare module 'material-ui/lib/app-canvas' { - export = __MaterialUI.AppCanvas; -} - -declare module 'material-ui/lib/avatar' { - export = __MaterialUI.Avatar; -} - -declare module 'material-ui/lib/before-after-wrapper' { - export = __MaterialUI.BeforeAfterWrapper; -} - -declare module 'material-ui/lib/card/card' { - export = __MaterialUI.Card.Card; -} - -declare module 'material-ui/lib/card/card-actions' { - export = __MaterialUI.Card.CardActions; -} - -declare module 'material-ui/lib/card/card-expandable' { - export = __MaterialUI.Card.CardExpandable; -} - -declare module 'material-ui/lib/card/card-header' { - export = __MaterialUI.Card.CardHeader; -} - -declare module 'material-ui/lib/card/card-media' { - export = __MaterialUI.Card.CardMedia; -} - -declare module 'material-ui/lib/card/card-text' { - export = __MaterialUI.Card.CardText; -} - -declare module 'material-ui/lib/card/card-title' { - export = __MaterialUI.Card.CardTitle; -} - -declare module 'material-ui/lib/checkbox' { - export = __MaterialUI.Checkbox; -} - -declare module 'material-ui/lib/circular-progress' { - export = __MaterialUI.CircularProgress; -} - -declare module 'material-ui/lib/clearfix' { - export = __MaterialUI.ClearFix; -} - -declare module 'material-ui/lib/date-picker/date-picker' { - export = __MaterialUI.DatePicker.DatePicker; -} - -declare module 'material-ui/lib/date-picker/date-picker-dialog' { - export = __MaterialUI.DatePicker.DatePickerDialog; -} - -declare module 'material-ui/lib/dialog' { - export = __MaterialUI.Dialog; -} - -declare module 'material-ui/lib/drop-down-icon' { - export = __MaterialUI.DropDownIcon; -} - -declare module 'material-ui/lib/drop-down-menu' { - export = __MaterialUI.DropDownMenu; -} - -declare module 'material-ui/lib/enhanced-button' { - export = __MaterialUI.EnhancedButton; -} - -declare module 'material-ui/lib/flat-button' { - export = __MaterialUI.FlatButton; -} - -declare module 'material-ui/lib/floating-action-button' { - export = __MaterialUI.FloatingActionButton; -} - -declare module 'material-ui/lib/font-icon' { - export = __MaterialUI.FontIcon; -} - -declare module 'material-ui/lib/icon-button' { - export = __MaterialUI.IconButton; -} - -declare module 'material-ui/lib/left-nav' { - export = __MaterialUI.LeftNav; -} - -declare module 'material-ui/lib/linear-progress' { - export = __MaterialUI.LinearProgress; -} - -declare module 'material-ui/lib/lists/list' { - export = __MaterialUI.Lists.List; -} - -declare module 'material-ui/lib/lists/list-divider' { - export = __MaterialUI.Lists.ListDivider; -} - -declare module 'material-ui/lib/lists/list-item' { - export = __MaterialUI.Lists.ListItem; -} - -declare module 'material-ui/lib/menu/menu' { - export = __MaterialUI.Menu.Menu; -} - -declare module 'material-ui/lib/menu/menu-item' { - export = __MaterialUI.Menu.MenuItem; -} - -declare module 'material-ui/lib/mixins/' { - export import ClickAwayable = __MaterialUI.Mixins.ClickAwayable; // require('material-ui/lib/mixins/click-awayable'); - export import WindowListenable = __MaterialUI.Mixins.WindowListenable; // require('material-ui/lib/mixins/window-listenable'); - export import StylePropable = __MaterialUI.Mixins.StylePropable; // require('material-ui/lib/mixins/style-propable'); - export import StyleResizable = __MaterialUI.Mixins.StyleResizable; // require('material-ui/lib/mixins/style-resizable'); -} - -declare module 'material-ui/lib/mixins/click-awayable' { - export = __MaterialUI.Mixins.ClickAwayable; -} - -declare module 'material-ui/lib/mixins/window-listenable' { - export = __MaterialUI.Mixins.WindowListenable; -} - -declare module 'material-ui/lib/mixins/style-propable' { - export = __MaterialUI.Mixins.StylePropable; -} - -declare module 'material-ui/lib/mixins/style-resizable' { - export = __MaterialUI.Mixins.StyleResizable; -} - -declare module 'material-ui/lib/overlay' { - export = __MaterialUI.Overlay; -} - -declare module 'material-ui/lib/paper' { - export = __MaterialUI.Paper; -} - -declare module 'material-ui/lib/radio-button' { - export = __MaterialUI.RadioButton; -} - -declare module 'material-ui/lib/radio-button-group' { - export = __MaterialUI.RadioButtonGroup; -} - -declare module 'material-ui/lib/raised-button' { - export = __MaterialUI.RaisedButton; -} - -declare module 'material-ui/lib/refresh-indicator' { - export = __MaterialUI.RefreshIndicator; -} - -declare module 'material-ui/lib/ripples/' { - export import CircleRipple = __MaterialUI.Ripples.CircleRipple; - export import FocusRipple = __MaterialUI.Ripples.FocusRipple; - export import TouchRipple = __MaterialUI.Ripples.TouchRipple; -} - -declare module 'material-ui/lib/select-field' { - export = __MaterialUI.SelectField; -} - -declare module 'material-ui/lib/slider' { - export = __MaterialUI.Slider; -} - -declare module 'material-ui/lib/svg-icon' { - export = __MaterialUI.SvgIcon; -} - -declare module 'material-ui/lib/svg-icons/navigation/menu' { - export = __MaterialUI.NavigationMenu; -} - -declare module 'material-ui/lib/svg-icons/navigation/chevron-left' { - export = __MaterialUI.NavigationChevronLeft; -} - -declare module 'material-ui/lib/svg-icons/navigation/chevron-right' { - export = __MaterialUI.NavigationChevronRight; -} - -declare module 'material-ui/lib/styles/' { - export import AutoPrefix = __MaterialUI.Styles.AutoPrefix; // require('material-ui/lib/styles/auto-prefix'); - export import Colors = __MaterialUI.Styles.Colors; // require('material-ui/lib/styles/colors'); - export import Spacing = require('material-ui/lib/styles/spacing'); - export import ThemeManager = __MaterialUI.Styles.ThemeManager; // require('material-ui/lib/styles/theme-manager'); - export import Transitions = __MaterialUI.Styles.Transitions; // require('material-ui/lib/styles/transitions'); - export import Typography = __MaterialUI.Styles.Typography; // require('material-ui/lib/styles/typography'); -} - -declare module 'material-ui/lib/styles/auto-prefix' { - export = __MaterialUI.Styles.AutoPrefix; -} - -declare module 'material-ui/lib/styles/spacing' { - var Spacing: __MaterialUI.Styles.Spacing; - export = Spacing; -} - -declare module 'material-ui/lib/styles/theme-manager' { - export = __MaterialUI.Styles.ThemeManager; -} - -declare module 'material-ui/lib/styles/transitions' { - export = __MaterialUI.Styles.Transitions; -} - -declare module 'material-ui/lib/styles/typography' { - export = __MaterialUI.Styles.Typography; -} - -declare module 'material-ui/lib/snackbar' { - export = __MaterialUI.Snackbar; -} - -declare module 'material-ui/lib/tabs/tab' { - export = __MaterialUI.Tabs.Tab; -} - -declare module 'material-ui/lib/tabs/tabs' { - export = __MaterialUI.Tabs.Tabs; -} - -declare module 'material-ui/lib/table/table' { - export = __MaterialUI.Table.Table; -} - -declare module 'material-ui/lib/table/table-body' { - export = __MaterialUI.Table.TableBody; -} - -declare module 'material-ui/lib/table/table-footer' { - export = __MaterialUI.Table.TableFooter; -} - -declare module 'material-ui/lib/table/table-header' { - export = __MaterialUI.Table.TableHeader; -} - -declare module 'material-ui/lib/table/table-header-column' { - export = __MaterialUI.Table.TableHeaderColumn; -} - -declare module 'material-ui/lib/table/table-row' { - export = __MaterialUI.Table.TableRow; -} - -declare module 'material-ui/lib/table/table-row-column' { - export = __MaterialUI.Table.TableRowColumn; -} - -declare module 'material-ui/lib/theme' { - export = __MaterialUI.Theme; -} - -declare module 'material-ui/lib/toggle' { - export = __MaterialUI.Toggle; -} - -declare module 'material-ui/lib/time-picker' { - export = __MaterialUI.TimePicker; -} - -declare module 'material-ui/lib/text-field' { - export = __MaterialUI.TextField; -} - -declare module 'material-ui/lib/toolbar/toolbar' { - export = __MaterialUI.Toolbar.Toolbar; -} - -declare module 'material-ui/lib/toolbar/toolbar-group' { - export = __MaterialUI.Toolbar.ToolbarGroup; -} - -declare module 'material-ui/lib/toolbar/toolbar-separator' { - export = __MaterialUI.Toolbar.ToolbarSeparator; -} - -declare module 'material-ui/lib/toolbar/toolbar-title' { - export = __MaterialUI.Toolbar.ToolbarTitle; -} - -declare module 'material-ui/lib/tooltip' { - export = __MaterialUI.Tooltip; -} - -declare module 'material-ui/lib/utils/' { - export import ColorManipulator = __MaterialUI.Utils.ColorManipulator; // require('material-ui/lib/utils/color-manipulator'); - export import CssEvent = __MaterialUI.Utils.CssEvent; // require('material-ui/lib/utils/css-event'); - export import Dom = __MaterialUI.Utils.Dom; // require('material-ui/lib/utils/dom'); - export import Events = __MaterialUI.Utils.Events; // require('material-ui/lib/utils/events'); - export import Extend = __MaterialUI.Utils.Extend; // require('material-ui/lib/utils/extend'); - export import ImmutabilityHelper = __MaterialUI.Utils.ImmutabilityHelper; // require('material-ui/lib/utils/immutability-helper'); - export import KeyCode = __MaterialUI.Utils.KeyCode; // require('material-ui/lib/utils/key-code'); - export import KeyLine = __MaterialUI.Utils.KeyLine; // require('material-ui/lib/utils/key-line'); - export import UniqueId = __MaterialUI.Utils.UniqueId; // require('material-ui/lib/utils/unique-id'); - export import Styles = __MaterialUI.Utils.Styles; // require('material-ui/lib/utils/styles'); -} - -declare module 'material-ui/lib/utils/color-manipulator' { - export = __MaterialUI.Utils.ColorManipulator; -} - -declare module 'material-ui/lib/utils/css-event' { - export = __MaterialUI.Utils.CssEvent; -} - -declare module 'material-ui/lib/utils/dom' { - export = __MaterialUI.Utils.Dom; -} - -declare module 'material-ui/lib/utils/events' { - export = __MaterialUI.Utils.Events; -} - -declare module 'material-ui/lib/utils/extend' { - export = __MaterialUI.Utils.Extend; -} - -declare module 'material-ui/lib/utils/immutability-helper' { - export = __MaterialUI.Utils.ImmutabilityHelper; -} - -declare module 'material-ui/lib/utils/key-code' { - export = __MaterialUI.Utils.KeyCode; -} - -declare module 'material-ui/lib/utils/key-line' { - export = __MaterialUI.Utils.KeyLine; -} - -declare module 'material-ui/lib/utils/unique-id' { - export = __MaterialUI.Utils.UniqueId; -} - -declare module 'material-ui/lib/utils/styles' { - export = __MaterialUI.Utils.Styles; -} - -declare module "material-ui/lib/menus/icon-menu" { - export = __MaterialUI.Menus.IconMenu; -} - -declare module "material-ui/lib/menus/menu" { - export = __MaterialUI.Menus.Menu; -} - -declare module "material-ui/lib/menus/menu-item" { - export = __MaterialUI.Menus.MenuItem; -} - -declare module "material-ui/lib/menus/menu-divider" { - export = __MaterialUI.Menus.MenuDivider; -} - -declare module "material-ui/lib/styles/colors" { - export = __MaterialUI.Styles.Colors; -} - -declare namespace __MaterialUI.Styles { - interface Colors { - red50: string; - red100: string; - red200: string; - red300: string; - red400: string; - red500: string; - red600: string; - red700: string; - red800: string; - red900: string; - redA100: string; - redA200: string; - redA400: string; - redA700: string; - - pink50: string; - pink100: string; - pink200: string; - pink300: string; - pink400: string; - pink500: string; - pink600: string; - pink700: string; - pink800: string; - pink900: string; - pinkA100: string; - pinkA200: string; - pinkA400: string; - pinkA700: string; - - purple50: string; - purple100: string; - purple200: string; - purple300: string; - purple400: string; - purple500: string; - purple600: string; - purple700: string; - purple800: string; - purple900: string; - purpleA100: string; - purpleA200: string; - purpleA400: string; - purpleA700: string; - - deepPurple50: string; - deepPurple100: string; - deepPurple200: string; - deepPurple300: string; - deepPurple400: string; - deepPurple500: string; - deepPurple600: string; - deepPurple700: string; - deepPurple800: string; - deepPurple900: string; - deepPurpleA100: string; - deepPurpleA200: string; - deepPurpleA400: string; - deepPurpleA700: string; - - indigo50: string; - indigo100: string; - indigo200: string; - indigo300: string; - indigo400: string; - indigo500: string; - indigo600: string; - indigo700: string; - indigo800: string; - indigo900: string; - indigoA100: string; - indigoA200: string; - indigoA400: string; - indigoA700: string; - - blue50: string; - blue100: string; - blue200: string; - blue300: string; - blue400: string; - blue500: string; - blue600: string; - blue700: string; - blue800: string; - blue900: string; - blueA100: string; - blueA200: string; - blueA400: string; - blueA700: string; - - lightBlue50: string; - lightBlue100: string; - lightBlue200: string; - lightBlue300: string; - lightBlue400: string; - lightBlue500: string; - lightBlue600: string; - lightBlue700: string; - lightBlue800: string; - lightBlue900: string; - lightBlueA100: string; - lightBlueA200: string; - lightBlueA400: string; - lightBlueA700: string; - - cyan50: string; - cyan100: string; - cyan200: string; - cyan300: string; - cyan400: string; - cyan500: string; - cyan600: string; - cyan700: string; - cyan800: string; - cyan900: string; - cyanA100: string; - cyanA200: string; - cyanA400: string; - cyanA700: string; - - teal50: string; - teal100: string; - teal200: string; - teal300: string; - teal400: string; - teal500: string; - teal600: string; - teal700: string; - teal800: string; - teal900: string; - tealA100: string; - tealA200: string; - tealA400: string; - tealA700: string; - - green50: string; - green100: string; - green200: string; - green300: string; - green400: string; - green500: string; - green600: string; - green700: string; - green800: string; - green900: string; - greenA100: string; - greenA200: string; - greenA400: string; - greenA700: string; - - lightGreen50: string; - lightGreen100: string; - lightGreen200: string; - lightGreen300: string; - lightGreen400: string; - lightGreen500: string; - lightGreen600: string; - lightGreen700: string; - lightGreen800: string; - lightGreen900: string; - lightGreenA100: string; - lightGreenA200: string; - lightGreenA400: string; - lightGreenA700: string; - - lime50: string; - lime100: string; - lime200: string; - lime300: string; - lime400: string; - lime500: string; - lime600: string; - lime700: string; - lime800: string; - lime900: string; - limeA100: string; - limeA200: string; - limeA400: string; - limeA700: string; - - yellow50: string; - yellow100: string; - yellow200: string; - yellow300: string; - yellow400: string; - yellow500: string; - yellow600: string; - yellow700: string; - yellow800: string; - yellow900: string; - yellowA100: string; - yellowA200: string; - yellowA400: string; - yellowA700: string; - - amber50: string; - amber100: string; - amber200: string; - amber300: string; - amber400: string; - amber500: string; - amber600: string; - amber700: string; - amber800: string; - amber900: string; - amberA100: string; - amberA200: string; - amberA400: string; - amberA700: string; - - orange50: string; - orange100: string; - orange200: string; - orange300: string; - orange400: string; - orange500: string; - orange600: string; - orange700: string; - orange800: string; - orange900: string; - orangeA100: string; - orangeA200: string; - orangeA400: string; - orangeA700: string; - - deepOrange50: string; - deepOrange100: string; - deepOrange200: string; - deepOrange300: string; - deepOrange400: string; - deepOrange500: string; - deepOrange600: string; - deepOrange700: string; - deepOrange800: string; - deepOrange900: string; - deepOrangeA100: string; - deepOrangeA200: string; - deepOrangeA400: string; - deepOrangeA700: string; - - brown50: string; - brown100: string; - brown200: string; - brown300: string; - brown400: string; - brown500: string; - brown600: string; - brown700: string; - brown800: string; - brown900: string; - - blueGrey50: string; - blueGrey100: string; - blueGrey200: string; - blueGrey300: string; - blueGrey400: string; - blueGrey500: string; - blueGrey600: string; - blueGrey700: string; - blueGrey800: string; - blueGrey900: string; - - grey50: string; - grey100: string; - grey200: string; - grey300: string; - grey400: string; - grey500: string; - grey600: string; - grey700: string; - grey800: string; - grey900: string; - - black: string; - white: string; - - transparent: string; - fullBlack: string; - darkBlack: string; - lightBlack: string; - minBlack: string; - faintBlack: string; - fullWhite: string; - darkWhite: string; - lightWhite: string; - } - export var Colors: Colors; -} diff --git a/material-ui/legacy/material-ui-0.12.1-tests.tsx b/material-ui/legacy/material-ui-0.12.1-tests.tsx deleted file mode 100644 index ad6bc81c37..0000000000 --- a/material-ui/legacy/material-ui-0.12.1-tests.tsx +++ /dev/null @@ -1,468 +0,0 @@ -/// -/// - -import * as React from "react/addons"; -import Checkbox = require("material-ui/lib/checkbox"); -import Colors = require("material-ui/lib/styles/colors"); -import AppBar = require("material-ui/lib/app-bar"); -import IconButton = require("material-ui/lib/icon-button"); -import FlatButton = require("material-ui/lib/flat-button"); -import Avatar = require("material-ui/lib/avatar"); -import FontIcon = require("material-ui/lib/font-icon"); -import Typography = require("material-ui/lib/styles/typography"); -import RaisedButton = require("material-ui/lib/raised-button"); -import FloatingActionButton = require("material-ui/lib/floating-action-button"); -import Card = require("material-ui/lib/card/card"); -import CardHeader = require("material-ui/lib/card/card-header"); -import CardText = require("material-ui/lib/card/card-text"); -import CardActions = require("material-ui/lib/card/card-actions"); -import Dialog = require("material-ui/lib/dialog"); -import DropDownMenu = require("material-ui/lib/drop-down-menu"); -import RadioButtonGroup = require("material-ui/lib/radio-button-group"); -import RadioButton = require("material-ui/lib/radio-button"); -import Toggle = require("material-ui/lib/toggle"); -import TextField = require("material-ui/lib/text-field"); -import SelectField = require("material-ui/lib/select-field"); -import IconMenu = require("material-ui/lib/menus/icon-menu"); -import Menu = require('material-ui/lib/menus/menu'); -import MenuItem = require('material-ui/lib/menus/menu-item'); -import MenuDivider = require('material-ui/lib/menus/menu-divider'); -import ThemeManager = require('material-ui/lib/styles/theme-manager'); - -import NavigationClose = require("material-ui/lib/svg-icon"); // TODO: Should actually import the actual "material-ui/lib/svg-icons/navigation/close", but they aren't defined yet. -import FileFolder = require("material-ui/lib/svg-icon"); // TODO: Should actually import the actual "material-ui/lib/svg-icons/file/folder", but they aren't defined yet. -import ToggleStar = require("material-ui/lib/svg-icon"); // TODO: Should actually import the actual "material-ui/lib/svg-icons/toggle/star", but they aren't defined yet. -import ActionGrade = require("material-ui/lib/svg-icon"); // TODO: Should actually import the actual "material-ui/lib/svg-icons/action/grade", but they aren't defined yet. -import ToggleStarBorder = require("material-ui/lib/svg-icon"); // TODO: Should actually import the actual "material-ui/lib/svg-icons/toggle/star-border", but they aren't defined yet. -import ArrowDropRight = require("material-ui/lib/svg-icon"); // TODO: Should actually import the actual "material-ui/lib/svg-icons/toggle/star-border", but they aren't defined yet. - -type CheckboxProps = __MaterialUI.CheckboxProps; -type MuiTheme = __MaterialUI.Styles.MuiTheme; -type TouchTapEvent = __MaterialUI.TouchTapEvent; - -class MaterialUiTests extends React.Component<{}, {}> implements React.LinkedStateMixin { - - // injected with mixin - linkState: (key: string) => React.ReactLink; - dialog: Dialog; - - private touchTapEventHandler(e: TouchTapEvent) { - this.dialog.show(); - } - private formEventHandler(e: React.FormEvent) { - } - private selectFieldChangeHandler(e: TouchTapEvent, si: number, mi: any) { - } - - render() { - - // "http://material-ui.com/#/customization/themes" - let muiTheme: MuiTheme = ThemeManager.getMuiTheme({ - palette: { - accent1Color: Colors.cyan100 - }, - spacing: { - - } - }); - - // "http://material-ui.com/#/customization/inline-styles" - let element: React.ReactElement; - element = - element = React.createElement(Checkbox, { - id: "checkboxId1", name: "checkboxName1", value: "checkboxValue1", label: "went for a run today", style: { - width: '50%', - margin: '0 auto' - }, iconStyle: { - fill: '#FF4081' - } - }); - - // "http://material-ui.com/#/components/appbar" - element = - element = } - iconElementRight={} />; - - // "http://material-ui.com/#/components/avatars" - //image avatar - element = ; - //SvgIcon avatar - element = } />; - //SvgIcon avatar with custom colors - element = } - color={Colors.orange200} - backgroundColor={Colors.pink400} />; - //FontIcon avatar - element = - } />; - //FontIcon avatar with custom colors - element = } - color={Colors.blue300} - backgroundColor={Colors.indigo900} />; - //Letter avatar - element = A; - //Letter avatar with custom colors - element = - - - - // "http://material-ui.com/#/components/buttons" - element = - - ; - element = - - ; - element = - - ; - - // "http://material-ui.com/#/components/cards" - element = - A} - showExpandableButton={true}> - - - Lorem ipsum dolor sit amet, consectetur adipiscing elit. - - - - - - - Lorem ipsum dolor sit amet, consectetur adipiscing elit. - - ; - - // "http://material-ui.com/#/components/date-picker" - - - // "http://material-ui.com/#/components/dialog" - let standardActions = [ - { text: 'Cancel' }, - { text: 'Submit', onTouchTap: this.touchTapEventHandler, ref: 'submit' } - ]; - - element = - The actions in this window are created from the json that's passed in. - ; - - //Custom Actions - let customActions = [ - , - - ]; - - element = - The actions in this window were passed in as an array of react objects. - ; - - - // "http://material-ui.com/#/components/dropdown-menu" - let menuItems = [ - { payload: '1', text: 'Never' }, - { payload: '2', text: 'Every Night' }, - { payload: '3', text: 'Weeknights' }, - { payload: '4', text: 'Weekends' }, - { payload: '5', text: 'Weekly' }, - ]; - element = ; - - // "http://material-ui.com/#/components/icons" - element = home; - - // "http://material-ui.com/#/components/icon-buttons" - //Method 1: muidocs-icon-github is defined in a style sheet. - element = ; - //Method 2: ActionGrade is a component created using mui.SvgIcon. - element = - - ; - //Method 3: Manually creating a mui.FontIcon component within IconButton - element = - - ; - //Method 4: Using Google material-icons - element = settings_system_daydream; - - // "http://material-ui.com/#/components/icon-menus" - element = }> - - - - - - ; - - // "http://material-ui.com/#/components/left-nav" - - - // "http://material-ui.com/#/components/lists" - - - // "http://material-ui.com/#/components/menus" - element = - - - - - ; - element = - - - - - - - - } /> - } /> - } /> - } /> - } /> - - - ; - - // "http://material-ui.com/#/components/paper" - - - // "http://material-ui.com/#/components/progress" - - - // "http://material-ui.com/#/components/refresh-indicator" - - - // "http://material-ui.com/#/components/sliders" - - - // "http://material-ui.com/#/components/switches" - element = ; - element = ; - element = } - unCheckedIcon={} - label="custom icon" />; - - element = - ; - ; - - ; - - element = ; - - element = ; - - element = ; - - // "http://material-ui.com/#/components/snackbar" - - - // "http://material-ui.com/#/components/table" - - - // "http://material-ui.com/#/components/tabs" - - - // "http://material-ui.com/#/components/text-fields" - element = ; - element = ; - element = ; - element = ; - element = ('valueLinkValue') } />; - element = ; - element = ; - element = ; - element = ; - element = ; - element = ; - element = ; - - //Select Fields - let arbitraryArrayMenuItems = [ - { - id: 0, - name: "zero", - }, - ]; - element = ; - element = ; - element = ; - element = ; - - //Floating Hint Text Labels - element = ; - element = ; - element = ; - element = ('floatingValueLinkValue') } />; - element = ; - element = ; - element = ; - element = ; - element = ; - element = ; - - - // "http://material-ui.com/#/components/time-picker" - - - // "http://material-ui.com/#/components/toolbars" - - return element; - } -} diff --git a/material-ui/legacy/material-ui-0.12.1.d.ts b/material-ui/legacy/material-ui-0.12.1.d.ts deleted file mode 100644 index ee1a306995..0000000000 --- a/material-ui/legacy/material-ui-0.12.1.d.ts +++ /dev/null @@ -1,2249 +0,0 @@ -// Type definitions for material-ui v0.12.1 -// Project: https://github.com/callemall/material-ui -// Definitions by: Nathan Brown -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -/// - -declare module "material-ui" { - export import AppBar = __MaterialUI.AppBar; // require('material-ui/lib/app-bar'); - export import AppCanvas = __MaterialUI.AppCanvas; // require('material-ui/lib/app-canvas'); - export import Avatar = __MaterialUI.Avatar; // require('material-ui/lib/avatar'); - export import BeforeAfterWrapper = __MaterialUI.BeforeAfterWrapper; // require('material-ui/lib/before-after-wrapper'); - export import Card = __MaterialUI.Card.Card; // require('material-ui/lib/card/card'); - export import CardActions = __MaterialUI.Card.CardActions; // require('material-ui/lib/card/card-actions'); - export import CardExpandable = __MaterialUI.Card.CardExpandable; // require('material-ui/lib/card/card-expandable'); - export import CardHeader = __MaterialUI.Card.CardHeader; // require('material-ui/lib/card/card-header'); - export import CardMedia = __MaterialUI.Card.CardMedia; // require('material-ui/lib/card/card-media'); - export import CardText = __MaterialUI.Card.CardText; // require('material-ui/lib/card/card-text'); - export import CardTitle = __MaterialUI.Card.CardTitle; // require('material-ui/lib/card/card-title'); - export import Checkbox = __MaterialUI.Checkbox; // require('material-ui/lib/checkbox'); - export import CircularProgress = __MaterialUI.CircularProgress; // require('material-ui/lib/circular-progress'); - export import ClearFix = __MaterialUI.ClearFix; // require('material-ui/lib/clearfix'); - export import DatePicker = __MaterialUI.DatePicker.DatePicker; // require('material-ui/lib/date-picker/date-picker'); - export import DatePickerDialog = __MaterialUI.DatePicker.DatePickerDialog; // require('material-ui/lib/date-picker/date-picker-dialog'); - export import Dialog = __MaterialUI.Dialog // require('material-ui/lib/dialog'); - export import DropDownIcon = __MaterialUI.DropDownIcon; // require('material-ui/lib/drop-down-icon'); - export import DropDownMenu = __MaterialUI.DropDownMenu; // require('material-ui/lib/drop-down-menu'); - export import EnhancedButton = __MaterialUI.EnhancedButton; // require('material-ui/lib/enhanced-button'); - export import FlatButton = __MaterialUI.FlatButton; // require('material-ui/lib/flat-button'); - export import FloatingActionButton = __MaterialUI.FloatingActionButton; // require('material-ui/lib/floating-action-button'); - export import FontIcon = __MaterialUI.FontIcon; // require('material-ui/lib/font-icon'); - export import IconButton = __MaterialUI.IconButton; // require('material-ui/lib/icon-button'); - export import IconMenu = __MaterialUI.Menus.IconMenu; // require('material-ui/lib/menus/icon-menu'); - export import LeftNav = __MaterialUI.LeftNav; // require('material-ui/lib/left-nav'); - export import LinearProgress = __MaterialUI.LinearProgress; // require('material-ui/lib/linear-progress'); - export import List = __MaterialUI.Lists.List; // require('material-ui/lib/lists/list'); - export import ListDivider = __MaterialUI.Lists.ListDivider; // require('material-ui/lib/lists/list-divider'); - export import ListItem = __MaterialUI.Lists.ListItem; // require('material-ui/lib/lists/list-item'); - export import Menu = __MaterialUI.Menu.Menu; // require('material-ui/lib/menu/menu'); - export import MenuItem = __MaterialUI.Menu.MenuItem; // require('material-ui/lib/menu/menu-item'); - export import Mixins = __MaterialUI.Mixins; // require('material-ui/lib/mixins/'); - export import Overlay = __MaterialUI.Overlay; // require('material-ui/lib/overlay'); - export import Paper = __MaterialUI.Paper; // require('material-ui/lib/paper'); - export import RadioButton = __MaterialUI.RadioButton; // require('material-ui/lib/radio-button'); - export import RadioButtonGroup = __MaterialUI.RadioButtonGroup; // require('material-ui/lib/radio-button-group'); - export import RaisedButton = __MaterialUI.RaisedButton; // require('material-ui/lib/raised-button'); - export import RefreshIndicator = __MaterialUI.RefreshIndicator; // require('material-ui/lib/refresh-indicator'); - export import Ripples = __MaterialUI.Ripples; // require('material-ui/lib/ripples/'); - export import SelectField = __MaterialUI.SelectField; // require('material-ui/lib/select-field'); - export import Slider = __MaterialUI.Slider; // require('material-ui/lib/slider'); - export import SvgIcon = __MaterialUI.SvgIcon; // require('material-ui/lib/svg-icon'); - export import Icons = __MaterialUI.Icons; - export import Styles = __MaterialUI.Styles; // require('material-ui/lib/styles/'); - export import Snackbar = __MaterialUI.Snackbar; // require('material-ui/lib/snackbar'); - export import Tab = __MaterialUI.Tabs.Tab; // require('material-ui/lib/tabs/tab'); - export import Tabs = __MaterialUI.Tabs.Tabs; // require('material-ui/lib/tabs/tabs'); - export import Table = __MaterialUI.Table.Table; // require('material-ui/lib/table/table'); - export import TableBody = __MaterialUI.Table.TableBody; // require('material-ui/lib/table/table-body'); - export import TableFooter = __MaterialUI.Table.TableFooter; // require('material-ui/lib/table/table-footer'); - export import TableHeader = __MaterialUI.Table.TableHeader; // require('material-ui/lib/table/table-header'); - export import TableHeaderColumn = __MaterialUI.Table.TableHeaderColumn; // require('material-ui/lib/table/table-header-column'); - export import TableRow = __MaterialUI.Table.TableRow; // require('material-ui/lib/table/table-row'); - export import TableRowColumn = __MaterialUI.Table.TableRowColumn; // require('material-ui/lib/table/table-row-column'); - export import ThemeWrapper = __MaterialUI.ThemeWrapper; // require('material-ui/lib/theme-wrapper'); - export import Toggle = __MaterialUI.Toggle; // require('material-ui/lib/toggle'); - export import TimePicker = __MaterialUI.TimePicker; // require('material-ui/lib/time-picker'); - export import TextField = __MaterialUI.TextField; // require('material-ui/lib/text-field'); - export import Toolbar = __MaterialUI.Toolbar.Toolbar; // require('material-ui/lib/toolbar/toolbar'); - export import ToolbarGroup = __MaterialUI.Toolbar.ToolbarGroup; // require('material-ui/lib/toolbar/toolbar-group'); - export import ToolbarSeparator = __MaterialUI.Toolbar.ToolbarSeparator; // require('material-ui/lib/toolbar/toolbar-separator'); - export import ToolbarTitle = __MaterialUI.Toolbar.ToolbarTitle; // require('material-ui/lib/toolbar/toolbar-title'); - export import Tooltip = __MaterialUI.Tooltip; // require('material-ui/lib/tooltip'); - export import Utils = __MaterialUI.Utils; // require('material-ui/lib/utils/'); - - // export type definitions - export type TouchTapEvent = __MaterialUI.TouchTapEvent; - export type TouchTapEventHandler = __MaterialUI.TouchTapEventHandler; - export type DialogAction = __MaterialUI.DialogAction; -} - -declare namespace __MaterialUI { - import React = __React; - - // ReactLink is from "react/addons" - interface ReactLink { - value: T; - requestChange(newValue: T): void; - } - - // What's common between React.TouchEvent and React.MouseEvent - interface TouchTapEvent extends React.SyntheticEvent { - altKey: boolean; - ctrlKey: boolean; - getModifierState(key: string): boolean; - metaKey: boolean; - shiftKey: boolean; - } - - // What's common between React.TouchEventHandler and React.MouseEventHandler - interface TouchTapEventHandler extends React.EventHandler { } - - // more specific than React.HTMLAttributes - - interface AppBarProps extends React.Props { - iconClassNameLeft?: string; - iconClassNameRight?: string; - iconElementLeft?: React.ReactElement; - iconElementRight?: React.ReactElement; - iconStyleRight?: string; - style?: React.CSSProperties; - showMenuIconButton?: boolean; - title?: React.ReactNode; - zDepth?: number; - - onLeftIconButtonTouchTap?: TouchTapEventHandler; - onRightIconButtonTouchTap?: TouchTapEventHandler; - } - export class AppBar extends React.Component{ - } - - interface AppCanvasProps extends React.Props { - } - export class AppCanvas extends React.Component { - } - - interface AvatarProps extends React.Props { - icon?: React.ReactElement; - backgroundColor?: string; - color?: string; - size?: number; - src?: string; - style?: React.CSSProperties; - } - export class Avatar extends React.Component { - } - - interface BeforeAfterWrapperProps extends React.Props { - beforeStyle?: React.CSSProperties; - afterStyle?: React.CSSProperties; - beforeElementType?: string; - afterElementType?: string; - elementType?: string; - } - export class BeforeAfterWrapper extends React.Component { - } - - namespace Card { - - interface CardProps extends React.Props { - expandable?: boolean; - initiallyExpanded?: boolean; - onExpandedChange?: (isExpanded: boolean) => void; - style?: React.CSSProperties; - } - export class Card extends React.Component { - } - - interface CardActionsProps extends React.Props { - expandable?: boolean; - showExpandableButton?: boolean; - } - export class CardActions extends React.Component { - } - - interface CardExpandableProps extends React.Props { - onExpanding?: (isExpanded: boolean) => void; - expanded?: boolean; - } - export class CardExpandable extends React.Component { - } - - interface CardHeaderProps extends React.Props { - expandable?: boolean; - showExpandableButton?: boolean; - title?: string | React.ReactElement; - titleColor?: string; - titleStyle?: React.CSSProperties; - subtitle?: string | React.ReactElement; - subtitleColor?: string; - subtitleStyle?: React.CSSProperties; - textStyle?: React.CSSProperties; - style?: React.CSSProperties; - avatar: React.ReactElement | string; - } - export class CardHeader extends React.Component { - } - - interface CardMediaProps extends React.Props { - expandable?: boolean; - overlay?: React.ReactNode; - overlayStyle?: React.CSSProperties; - overlayContainerStyle?: React.CSSProperties; - overlayContentStyle?: React.CSSProperties; - mediaStyle?: React.CSSProperties; - style?: React.CSSProperties; - } - export class CardMedia extends React.Component { - } - - interface CardTextProps extends React.Props { - expandable?: boolean; - color?: string; - style?: React.CSSProperties; - } - export class CardText extends React.Component { - } - - interface CardTitleProps extends React.Props { - expandable?: boolean; - showExpandableButton?: boolean; - title?: string | React.ReactElement; - titleColor?: string; - titleStyle?: React.CSSProperties; - subtitle?: string | React.ReactElement; - subtitleColor?: string; - subtitleStyle?: React.CSSProperties; - textStyle?: React.CSSProperties; - style?: React.CSSProperties; - } - export class CardTitle extends React.Component { - } - } - - // what's not commonly overridden by Checkbox, RadioButton, or Toggle - interface CommonEnhancedSwitchProps extends React.HTMLAttributesBase { - // is root element - id?: string; - iconStyle?: React.CSSProperties; - labelStyle?: React.CSSProperties; - rippleStyle?: React.CSSProperties; - thumbStyle?: React.CSSProperties; - trackStyle?: React.CSSProperties; - name?: string; - value?: string; - label?: string; - required?: boolean; - disabled?: boolean; - defaultSwitched?: boolean; - disableFocusRipple?: boolean; - disableTouchRipple?: boolean; - } - - interface EnhancedSwitchProps extends CommonEnhancedSwitchProps { - // is root element - inputType: string; - switchElement: React.ReactElement; - onParentShouldUpdate: (isInputChecked: boolean) => void; - switched: boolean; - rippleColor?: string; - onSwitch?: (e: React.MouseEvent, isInputChecked: boolean) => void; - labelPosition?: string; - } - export class EnhancedSwitch extends React.Component { - isSwitched(): boolean; - setSwitched(newSwitchedValue: boolean): void; - getValue(): any; - isKeyboardFocused(): boolean; - } - - interface CheckboxProps extends CommonEnhancedSwitchProps { - // is root element - checkedIcon?: React.ReactElement<{ style?: React.CSSProperties }>; // Normally an SvgIcon - defaultChecked?: boolean; - iconStyle?: React.CSSProperties; - label?: string; - labelStyle?: React.CSSProperties; - labelPosition?: string; - style?: React.CSSProperties; - checked?: boolean; - unCheckedIcon?: React.ReactElement<{ style?: React.CSSProperties }>; // Normally an SvgIcon - - disabled?: boolean; - valueLink?: ReactLink; - checkedLink?: ReactLink; - - onCheck?: (event: React.MouseEvent, checked: boolean) => void; - } - export class Checkbox extends React.Component { - isChecked(): void; - setChecked(newCheckedValue: boolean): void; - } - - interface CircularProgressProps extends React.Props { - mode?: string; - value?: number; - min?: number; - max?: number; - size?: number; - color?: string; - innerStyle?: React.CSSProperties; - - } - export class CircularProgress extends React.Component { - } - - interface ClearFixProps extends React.Props { - } - export class ClearFix extends React.Component { - } - - namespace DatePicker { - interface DatePickerProps extends React.Props { - autoOk?: boolean; - defaultDate?: Date; - formatDate?: string; - hideToolbarYearChange?: boolean; - maxDate?: Date; - minDate?: Date; - mode?: string; - onDismiss?: () => void; - - // e is always null - onChange?: (e: any, d: Date) => void; - - onFocus?: React.FocusEventHandler; - onShow?: () => void; - onTouchTap?: React.TouchEventHandler; - shouldDisableDate?: (day: Date) => boolean; - showYearSelector?: boolean; - textFieldStyle?: React.CSSProperties; - } - export class DatePicker extends React.Component { - } - - interface DatePickerDialogProps extends React.Props { - disableYearSelection?: boolean; - initialDate?: Date; - maxDate?: Date; - minDate?: Date; - onAccept?: (d: Date) => void; - onClickAway?: () => void; - onDismiss?: () => void; - onShow?: () => void; - shouldDisableDate?: (day: Date) => boolean; - showYearSelector?: boolean; - } - export class DatePickerDialog extends React.Component { - } - } - - export interface DialogAction { - id?: string; - text: string; - ref?: string; - - onTouchTap?: TouchTapEventHandler; - onClick?: React.MouseEventHandler; - } - interface DialogProps extends React.Props { - actions?: Array>; - actionFocus?: string; - autoDetectWindowHeight?: boolean; - autoScrollBodyContent?: boolean; - bodyStyle?: React.CSSProperties; - contentClassName?: string; - contentInnerStyle?: React.CSSProperties; - contentStyle?: React.CSSProperties; - modal?: boolean; - openImmediately?: boolean; - repositionOnUpdate?: boolean; - title?: React.ReactNode; - - onClickAway?: () => void; - onDismiss?: () => void; - onShow?: () => void; - } - export class Dialog extends React.Component { - dismiss(): void; - show(): void; - } - - interface DropDownIconProps extends React.Props { - menuItems: Menu.MenuItemRequest[]; - closeOnMenuItemTouchTap?: boolean; - iconStyle?: React.CSSProperties; - iconClassName?: string; - iconLigature?: string; - - onChange?: Menu.ItemTapEventHandler; - } - export class DropDownIcon extends React.Component { - } - - interface DropDownMenuProps extends React.Props { - displayMember?: string; - valueMember?: string; - autoWidth?: boolean; - menuItems: Menu.MenuItemRequest[]; - menuItemStyle?: React.CSSProperties; - selectedIndex?: number; - underlineStyle?: React.CSSProperties; - iconStyle?: React.CSSProperties; - labelStyle?: React.CSSProperties; - style?: React.CSSProperties; - disabled?: boolean; - valueLink?: ReactLink; - value?: number; - - onChange?: Menu.ItemTapEventHandler; - } - export class DropDownMenu extends React.Component { - } - - // non generally overridden elements of EnhancedButton - interface SharedEnhancedButtonProps extends React.HTMLAttributesBase { - centerRipple?: boolean; - containerElement?: string | React.ReactElement; - disabled?: boolean; - disableFocusRipple?: boolean; - disableKeyboardFocus?: boolean; - disableTouchRipple?: boolean; - keyboardFocused?: boolean; - linkButton?: boolean; - focusRippleColor?: string; - focusRippleOpacity?: number; - touchRippleOpacity?: number; - tabIndex?: number; - - onBlur?: React.FocusEventHandler; - onFocus?: React.FocusEventHandler; - onKeyboardFocus?: (e: React.FocusEvent, isKeyboardFocused: boolean) => void; - onKeyDown?: React.KeyboardEventHandler; - onKeyUp?: React.KeyboardEventHandler; - onMouseEnter?: React.MouseEventHandler; - onMouseLeave?: React.MouseEventHandler; - onTouchStart?: React.TouchEventHandler; - onTouchEnd?: React.TouchEventHandler; - onTouchTap?: TouchTapEventHandler; - } - - interface EnhancedButtonProps extends SharedEnhancedButtonProps { - touchRippleColor?: string; - focusRippleColor?: string; - style?: React.CSSProperties; - } - export class EnhancedButton extends React.Component { - } - - interface FlatButtonProps extends SharedEnhancedButtonProps { - hoverColor?: string; - label?: string; - labelPosition?: string; - labelStyle?: React.CSSProperties; - linkButton?: boolean; - primary?: boolean; - secondary?: boolean; - rippleColor?: string; - style?: React.CSSProperties; - } - export class FlatButton extends React.Component { - } - - interface FloatingActionButtonProps extends SharedEnhancedButtonProps { - backgroundColor?: string; - disabled?: boolean; - disabledColor?: string; - iconClassName?: string; - iconStyle?: React.CSSProperties; - mini?: boolean; - secondary?: boolean; - style?: React.CSSProperties; - } - export class FloatingActionButton extends React.Component { - } - - interface FontIconProps extends React.Props { - color?: string; - hoverColor?: string; - onMouseLeave?: React.MouseEventHandler; - onMouseEnter?: React.MouseEventHandler; - style?: React.CSSProperties; - className?: string; - } - export class FontIcon extends React.Component { - } - - interface IconButtonProps extends SharedEnhancedButtonProps { - iconClassName?: string; - iconStyle?: React.CSSProperties; - style?: React.CSSProperties; - tooltip?: string; - tooltipPosition?: string; - tooltipStyles?: React.CSSProperties; - touch?: boolean; - - onBlur?: React.FocusEventHandler; - onFocus?: React.FocusEventHandler; - } - export class IconButton extends React.Component { - } - - interface LeftNavProps extends React.Props { - disableSwipeToOpen?: boolean; - docked?: boolean; - header?: React.ReactElement; - menuItems: Menu.MenuItemRequest[]; - onChange?: Menu.ItemTapEventHandler; - onNavOpen?: () => void; - onNavClose?: () => void; - openRight?: Boolean; - selectedIndex?: number; - menuItemClassName?: string; - menuItemClassNameSubheader?: string; - menuItemClassNameLink?: string; - } - export class LeftNav extends React.Component { - } - - interface LinearProgressProps extends React.Props { - mode?: string; - value?: number; - min?: number; - max?: number; - } - export class LinearProgress extends React.Component { - } - - namespace Lists { - interface ListProps extends React.Props { - insetSubheader?: boolean; - subheader?: string; - subheaderStyle?: React.CSSProperties; - zDepth?: number; - } - export class List extends React.Component { - } - - interface ListDividerProps extends React.Props { - inset?: boolean; - } - export class ListDivider extends React.Component { - } - - interface ListItemProps extends React.Props { - autoGenerateNestedIndicator?: boolean; - disableKeyboardFocus?: boolean; - initiallyOpen?: boolean; - innerDivStyle?: React.CSSProperties; - insetChildren?: boolean; - innerStyle?: React.CSSProperties; - leftAvatar?: React.ReactElement; - leftCheckbox?: React.ReactElement; - leftIcon?: React.ReactElement; - nestedLevel?: number; - nestedItems?: React.ReactElement[]; - onKeyboardFocus?: React.FocusEventHandler; - onNestedListToggle?: (item: ListItem) => void; - rightAvatar?: React.ReactElement; - rightIcon?: React.ReactElement; - rightIconButton?: React.ReactElement; - rightToggle?: React.ReactElement; - primaryText?: React.ReactNode; - secondaryText?: React.ReactNode; - secondaryTextLines?: number; - } - export class ListItem extends React.Component { - } - } - - // Old menu implementation. Being replaced by new "menus". - namespace Menu { - interface ItemTapEventHandler { - (e: TouchTapEvent, index: number, menuItem: MenuItemRequest): void; - } - - // almost extends MenuItemProps, but certain required items are generated in Menu and not passed here. - interface MenuItemRequest extends React.Props { - // use value from MenuItem.Types.* - type?: string; - - text?: string; - data?: string; - payload?: string; - icon?: React.ReactElement; - attribute?: string; - number?: string; - toggle?: boolean; - onTouchTap?: TouchTapEventHandler; - isDisabled?: boolean; - - // for MenuItems.Types.NESTED - items?: MenuItemRequest[]; - - // for custom text or payloads - [propertyName: string]: any; - } - - interface MenuProps extends React.Props { - index: number; - text?: string; - menuItems: MenuItemRequest[]; - zDepth?: number; - active?: boolean; - onItemTap?: ItemTapEventHandler; - menuItemStyle?: React.CSSProperties; - } - export class Menu extends React.Component { - } - - interface MenuItemProps extends React.Props { - index: number; - icon?: React.ReactElement; - iconClassName?: string; - iconRightClassName?: string; - iconStyle?: React.CSSProperties; - iconRightStyle?: React.CSSProperties; - attribute?: string; - number?: string; - data?: string; - toggle?: boolean; - onTouchTap?: (e: React.MouseEvent, key: number) => void; - onToggle?: (e: React.MouseEvent, key: number, toggled: boolean) => void; - selected?: boolean; - active?: boolean; - } - export class MenuItem extends React.Component { - static Types: { LINK: string, SUBHEADER: string, NESTED: string, } - } - } - - export namespace Mixins { - interface ClickAwayable extends React.Mixin { - } - var ClickAwayable: ClickAwayable; - - interface WindowListenable extends React.Mixin { - } - var WindowListenable: WindowListenable; - - interface StylePropable extends React.Mixin { - } - var StylePropable: StylePropable - - interface StyleResizable extends React.Mixin { - } - var StyleResizable: StyleResizable - } - - interface OverlayProps extends React.Props { - autoLockScrolling?: boolean; - show?: boolean; - transitionEnabled?: boolean; - } - export class Overlay extends React.Component { - } - - interface PaperProps extends React.HTMLAttributesBase { - circle?: boolean; - rounded?: boolean; - transitionEnabled?: boolean; - zDepth?: number; - } - export class Paper extends React.Component { - } - - interface RadioButtonProps extends CommonEnhancedSwitchProps { - // is root element - defaultChecked?: boolean; - iconStyle?: React.CSSProperties; - label?: string; - labelStyle?: React.CSSProperties; - labelPosition?: string; - style?: React.CSSProperties; - value?: string; - - onCheck?: (e: React.FormEvent, selected: string) => void; - } - export class RadioButton extends React.Component { - } - - interface RadioButtonGroupProps extends React.Props { - defaultSelected?: string; - labelPosition?: string; - name: string; - style?: React.CSSProperties; - valueSelected?: string; - - onChange?: (e: React.FormEvent, selected: string) => void; - } - export class RadioButtonGroup extends React.Component { - getSelectedValue(): string; - setSelectedValue(newSelectionValue: string): void; - clearValue(): void; - } - - interface RaisedButtonProps extends SharedEnhancedButtonProps { - className?: string; - disabled?: boolean; - label?: string; - primary?: boolean; - secondary?: boolean; - labelStyle?: React.CSSProperties; - backgroundColor?: string; - labelColor?: string; - disabledBackgroundColor?: string; - disabledLabelColor?: string; - fullWidth?: boolean; - } - export class RaisedButton extends React.Component { - } - - interface RefreshIndicatorProps extends React.Props { - left: number; - percentage?: number; - size?: number; - status?: string; - top: number; - } - export class RefreshIndicator extends React.Component { - } - - namespace Ripples { - interface CircleRippleProps extends React.Props { - color?: string; - opacity?: number; - } - export class CircleRipple extends React.Component { - } - - interface FocusRippleProps extends React.Props { - color?: string; - innerStyle?: React.CSSProperties; - opacity?: number; - show?: boolean; - } - export class FocusRipple extends React.Component { - } - - interface TouchRippleProps extends React.Props { - centerRipple?: boolean; - color?: string; - opacity?: number; - } - export class TouchRipple extends React.Component { - } - } - - interface SelectFieldProps extends React.Props { - // passed to TextField - errorStyle?: React.CSSProperties; - errorText?: string; - floatingLabelText?: string; - floatingLabelStyle?: React.CSSProperties; - fullWidth?: boolean; - hintText?: string | React.ReactElement; - - // passed to DropDownMenu - displayMember?: string; - valueMember?: string; - autoWidth?: boolean; - menuItems: Menu.MenuItemRequest[]; - menuItemStyle?: React.CSSProperties; - selectedIndex?: number; - underlineStyle?: React.CSSProperties; - iconStyle?: React.CSSProperties; - labelStyle?: React.CSSProperties; - style?: React.CSSProperties; - disabled?: boolean; - valueLink?: ReactLink; - value?: number; - - onChange?: Menu.ItemTapEventHandler; - onEnterKeyDown?: React.KeyboardEventHandler; - - // own properties - selectFieldRoot?: string; - multiLine?: boolean; - type?: string; - rows?: number; - inputStyle?: React.CSSProperties; - } - export class SelectField extends React.Component { - } - - interface SliderProps extends React.Props { - name: string; - defaultValue?: number; - description?: string; - error?: string; - max?: number; - min?: number; - required?: boolean; - step?: number; - value?: number; - } - export class Slider extends React.Component { - } - - interface SvgIconProps extends React.Props { - color?: string; - hoverColor?: string; - viewBox?: string; - } - export class SvgIcon extends React.Component { - } - - export namespace Icons { - export import NavigationMenu = __MaterialUI.NavigationMenu; - export import NavigationChevronLeft = __MaterialUI.NavigationChevronLeft; - export import NavigationChevronRight = __MaterialUI.NavigationChevronRight; - } - - interface NavigationMenuProps extends React.Props { - } - export class NavigationMenu extends React.Component { - } - - interface NavigationChevronLeftProps extends React.Props { - } - export class NavigationChevronLeft extends React.Component { - } - - interface NavigationChevronRightProps extends React.Props { - } - export class NavigationChevronRight extends React.Component { - } - - export namespace Styles { - interface AutoPrefix { - all(styles: React.CSSProperties): React.CSSProperties; - set(style: React.CSSProperties, key: string, value: string | number): void; - single(key: string): string; - singleHyphened(key: string): string; - } - export var AutoPrefix: AutoPrefix; - - interface Spacing { - iconSize?: number; - - desktopGutter?: number; - desktopGutterMore?: number; - desktopGutterLess?: number; - desktopGutterMini?: number; - desktopKeylineIncrement?: number; - desktopDropDownMenuItemHeight?: number; - desktopDropDownMenuFontSize?: number; - desktopLeftNavMenuItemHeight?: number; - desktopSubheaderHeight?: number; - desktopToolbarHeight?: number; - } - interface ThemePalette { - primary1Color?: string; - primary2Color?: string; - primary3Color?: string; - accent1Color?: string; - accent2Color?: string; - accent3Color?: string; - textColor?: string; - canvasColor?: string; - borderColor?: string; - disabledColor?: string; - alternateTextColor?: string; - } - interface MuiTheme { - rawTheme: RawTheme; - static: boolean; - appBar?: { - color?: string, - textColor?: string, - height?: number - }, - avatar?: { - borderColor?: string; - } - button?: { - height?: number, - minWidth?: number, - iconButtonSize?: number - }, - checkbox?: { - boxColor?: string, - checkedColor?: string, - requiredColor?: string, - disabledColor?: string, - labelColor?: string, - labelDisabledColor?: string - }, - datePicker?: { - color?: string, - textColor?: string, - calendarTextColor?: string, - selectColor?: string, - selectTextColor?: string, - }, - dropDownMenu?: { - accentColor?: string, - }, - flatButton?: { - color?: string, - textColor?: string, - primaryTextColor?: string, - secondaryTextColor?: string, - disabledColor?: string - }, - floatingActionButton?: { - buttonSize?: number, - miniSize?: number, - color?: string, - iconColor?: string, - secondaryColor?: string, - secondaryIconColor?: string, - disabledColor?: string, - disabledTextColor?: string - }, - inkBar?: { - backgroundColor?: string; - }, - leftNav?: { - width?: number, - color?: string, - }, - listItem?: { - nestedLevelDepth?: number; - }, - menu?: { - backgroundColor?: string, - containerBackgroundColor?: string, - }, - menuItem?: { - dataHeight?: number, - height?: number, - hoverColor?: string, - padding?: number, - selectedTextColor?: string, - }, - menuSubheader?: { - padding?: number, - borderColor?: string, - textColor?: string, - }, - paper?: { - backgroundColor?: string, - }, - radioButton?: { - borderColor?: string, - backgroundColor?: string, - checkedColor?: string, - requiredColor?: string, - disabledColor?: string, - size?: number, - labelColor?: string, - labelDisabledColor?: string - }, - raisedButton?: { - color?: string, - textColor?: string, - primaryColor?: string, - primaryTextColor?: string, - secondaryColor?: string, - secondaryTextColor?: string, - disabledColor?: string, - disabledTextColor?: string - }, - refreshIndicator?: { - strokeColor?: string; - loadingStrokeColor?: string; - }; - slider?: { - trackSize?: number, - trackColor?: string, - trackColorSelected?: string, - handleSize?: number, - handleSizeActive?: number, - handleSizeDisabled?: number, - handleColorZero?: string, - handleFillColor?: string, - selectionColor?: string, - rippleColor?: string, - }, - snackbar?: { - textColor?: string, - backgroundColor?: string, - actionColor?: string, - }, - table?: { - backgroundColor?: string; - }; - tableHeader?: { - borderColor?: string; - }; - tableHeaderColumn?: { - textColor?: string; - }; - tableFooter?: { - borderColor?: string; - textColor?: string; - }; - tableRow?: { - hoverColor?: string; - stripeColor?: string; - selectedColor?: string; - textColor?: string; - borderColor?: string; - }; - tableRowColumn?: { - height?: number; - spacing?: number; - }; - timePicker?: { - color?: string; - textColor?: string; - accentColor?: string; - clockColor?: string; - selectColor?: string; - selectTextColor?: string; - }; - toggle?: { - thumbOnColor?: string, - thumbOffColor?: string, - thumbDisabledColor?: string, - thumbRequiredColor?: string, - trackOnColor?: string, - trackOffColor?: string, - trackDisabledColor?: string, - trackRequiredColor?: string, - labelColor?: string, - labelDisabledColor?: string - }, - toolbar?: { - backgroundColor?: string, - height?: number, - titleFontSize?: number, - iconColor?: string, - separatorColor?: string, - menuHoverColor?: string, - }; - tabs?: { - backgroundColor?: string; - }; - textField?: { - textColor?: string; - hintColor?: string; - floatingLabelColor?: string; - disabledTextColor?: string; - errorColor?: string; - focusColor?: string; - backgroundColor?: string; - borderColor?: string; - }; - } - - interface RawTheme { - spacing: Spacing; - fontFamily?: string; - palette: ThemePalette; - } - - export function ThemeDecorator(muiTheme: Styles.MuiTheme):

(Component: React.ComponentClass

) => React.ComponentClass

; - - interface ThemeManager { - getMuiTheme(rawTheme: RawTheme): MuiTheme; - modifyRawThemeSpacing(muiTheme: MuiTheme, newSpacing: Spacing): MuiTheme; - modifyRawThemePalette(muiTheme: MuiTheme, newPaletteKeys: ThemePalette): MuiTheme; - modifyRawThemeFontFamily(muiTheme: MuiTheme, newFontFamily: string): MuiTheme; - } - export var ThemeManager: ThemeManager; - - interface Transitions { - easeOut(duration?: string, property?: string | string[], delay?: string, easeFunction?: string): string; - create(duration?: string, property?: string, delay?: string, easeFunction?: string): string; - easeOutFunction: string; - easeInOutFunction: string; - } - export var Transitions: Transitions; - - interface Typography { - textFullBlack:string; - textDarkBlack: string; - textLightBlack: string; - textMinBlack: string; - textFullWhite: string; - textDarkWhite: string; - textLightWhite: string; - - // font weight - fontWeightLight: number; - fontWeightNormal: number; - fontWeightMedium: number; - - fontStyleButtonFontSize: number; - } - export var Typography: Typography; - - export var DarkRawTheme: RawTheme; - export var LightRawTheme: RawTheme; - } - - interface SnackbarProps extends React.Props { - message: string; - action?: string; - autoHideDuration?: number; - onActionTouchTap?: React.TouchEventHandler; - onShow?: () => void; - onDismiss?: () => void; - openOnMount?: boolean; - } - export class Snackbar extends React.Component { - } - - namespace Tabs { - interface TabProps extends React.Props { - label?: string; - value?: string; - selected?: boolean; - width?: string; - - // Called by Tabs component - onActive?: (tab: Tab) => void; - - onTouchTap?: (value: string, e: TouchTapEvent, tab: Tab) => void; - } - export class Tab extends React.Component { - } - - interface TabsProps extends React.Props { - contentContainerStyle?: React.CSSProperties; - initialSelectedIndex?: number; - inkBarStyle?: React.CSSProperties; - style?: React.CSSProperties; - tabItemContainerStyle?: React.CSSProperties; - tabWidth?: number; - value?: string | number; - - onChange?: (value: string | number, e: React.FormEvent, tab: Tab) => void; - } - export class Tabs extends React.Component { - } - } - - namespace Table { - interface TableProps extends React.Props

{ - allRowsSelected?: boolean; - fixedFooter?: boolean; - fixedHeader?: boolean; - height?: string; - multiSelectable?: boolean; - onCellClick?: (row: number, column: number) => void; - onCellHover?: (row: number, column: number) => void; - onCellHoverExit?: (row: number, column: number) => void; - onRowHover?: (row: number) => void; - onRowHoverExit?: (row: number) => void; - onRowSelection?: (selectedRows: number[])=> void; - selectable?: boolean; - } - export class Table extends React.Component { - } - - interface TableBodyProps extends React.Props { - allRowsSelected?: boolean; - deselectOnClickaway?: boolean; - displayRowCheckbox?: boolean; - multiSelectable?: boolean; - onCellClick?: (row: number, column: number) => void; - onCellHover?: (row: number, column: number) => void; - onCellHoverExit?: (row: number, column: number) => void; - onRowHover?: (row: number) => void; - onRowHoverExit?: (row: number) => void; - onRowSelection?: (selectedRows: number[])=> void; - preScanRows?: boolean; - selectable?: boolean; - showRowHover?: boolean; - stripedRows?: boolean; - } - export class TableBody extends React.Component { - } - - interface TableFooterProps extends React.Props { - adjustForCheckbox?: boolean; - } - export class TableFooter extends React.Component { - } - - interface TableHeaderProps extends React.Props { - adjustForCheckbox?: boolean; - displaySelectAll?: boolean; - enableSelectAll?: boolean; - onSelectAll?: (event: React.MouseEvent) => void; - selectAllSelected?: boolean; - } - export class TableHeader extends React.Component { - } - - interface TableHeaderColumnProps extends React.Props { - columnNumber?: number; - onClick?: (e: React.MouseEvent, column: number) => void; - tooltip?: string; - tooltipStyle?: React.CSSProperties; - } - export class TableHeaderColumn extends React.Component { - } - - interface TableRowProps extends React.Props { - displayBorder?: boolean; - hoverable?: boolean; - onCellClick?: (e: React.MouseEvent, row: number, column: number) => void; - onCellHover?: (e: React.MouseEvent, row: number, column: number) => void; - onCellHoverExit?: (e: React.MouseEvent, row: number, column: number) => void; - onRowClick?: (e: React.MouseEvent, row: number) => void; - onRowHover?: (e: React.MouseEvent, row: number) => void; - onRowHoverExit?: (e: React.MouseEvent, row: number) => void; - rowNumber?: number; - selectable?: boolean; - selected?: boolean; - striped?: boolean; - } - export class TableRow extends React.Component { - } - - interface TableRowColumnProps extends React.Props { - columnNumber?: number; - hoverable?: boolean; - onHover?: (e: React.MouseEvent, column: number) => void; - onHoverExit?: (e: React.MouseEvent, column: number) => void; - } - export class TableRowColumn extends React.Component { - } - } - - interface ThemeWrapperProps extends React.Props { - theme: Styles.MuiTheme; - } - export class ThemeWrapper extends React.Component { - } - - interface ToggleProps extends CommonEnhancedSwitchProps { - // is root element - - elementStyle?: React.CSSProperties; - labelStyle?: React.CSSProperties; - onToggle?: (e: React.MouseEvent, isInputChecked: boolean) => void; - toggled?: boolean; - defaultToggled?: boolean; - } - export class Toggle extends React.Component { - isToggled(): boolean; - setToggled(newToggledValue: boolean): void; - } - - interface TimePickerProps extends React.Props { - defaultTime?: Date; - format?: string; - pedantic?: boolean; - onFocus?: React.FocusEventHandler; - onTouchTap?: TouchTapEventHandler; - onChange?: (e: any, time: Date) => void; - onShow?: () => void; - onDismiss?: () => void; - } - export class TimePicker extends React.Component { - } - - interface TextFieldProps extends React.Props { - errorStyle?: React.CSSProperties; - errorText?: string; - floatingLabelText?: string; - floatingLabelStyle?: React.CSSProperties; - fullWidth?: boolean; - hintText?: string | React.ReactElement; - id?: string; - inputStyle?: React.CSSProperties; - multiLine?: boolean; - onEnterKeyDown?: React.KeyboardEventHandler; - style?: React.CSSProperties; - rows?: number, - underlineStyle?: React.CSSProperties; - underlineFocusStyle?: React.CSSProperties; - underlineDisabledStyle?: React.CSSProperties; - type?: string; - - disabled?: boolean; - isRtl?: boolean; - value?: string; - defaultValue?: string; - valueLink?: ReactLink; - - onBlur?: React.FocusEventHandler; - onChange?: React.FormEventHandler; - onFocus?: React.FocusEventHandler; - onKeyDown?: React.KeyboardEventHandler; - } - export class TextField extends React.Component { - blur(): void; - clearValue(): void; - focus(): void; - getValue(): string; - setErrorText(newErrorText: string): void; - setValue(newValue: string): void; - } - - namespace Toolbar { - interface ToolbarProps extends React.Props { - } - export class Toolbar extends React.Component { - } - - interface ToolbarGroupProps extends React.Props { - float?: string; - } - export class ToolbarGroup extends React.Component { - } - - interface ToolbarSeparatorProps extends React.Props { - } - export class ToolbarSeparator extends React.Component { - } - - interface ToolbarTitleProps extends React.HTMLAttributesBase { - text?: string; - } - export class ToolbarTitle extends React.Component { - } - } - - interface TooltipProps extends React.Props { - label: string; - show?: boolean; - touch?: boolean; - verticalPosition?: string; - horizontalPosition?: string; - } - export class Tooltip extends React.Component { - } - - export namespace Utils { - interface ContrastLevel { - range: [number, number]; - color: string; - } - interface ColorManipulator { - fade(color: string, amount: string|number): string; - lighten(color: string, amount: string|number): string; - darken(color: string, amount: string|number): string; - contrastRatio(background: string, foreground: string): number; - contrastRatioLevel(background: string, foreground: string): ContrastLevel; - } - export var ColorManipulator: ColorManipulator; - - interface CssEvent { - transitionEndEventName(): string; - animationEndEventName(): string; - onTransitionEnd(el: Element, callback: () => void): void; - onAnimationEnd(el: Element, callback: () => void): void; - } - export var CssEvent: CssEvent; - - interface Dom { - isDescendant(parent: Node, child: Node): boolean; - offset(el: Element): { top: number, left: number }; - getStyleAttributeAsNumber(el: HTMLElement, attr: string): number; - addClass(el: Element, className: string): void; - removeClass(el: Element, className: string): void; - hasClass(el: Element, className: string): boolean; - toggleClass(el: Element, className: string): void; - forceRedraw(el: HTMLElement): void; - withoutTransition(el: HTMLElement, callback: () => void): void; - } - export var Dom: Dom; - - interface Events { - once(el: Element, type: string, callback: EventListener): void; - on(el: Element, type: string, callback: EventListener): void; - off(el: Element, type: string, callback: EventListener): void; - isKeyboard(e: Event): boolean; - } - export var Events: Events; - - function Extend(base: T, override: S1): (T & S1); - - interface ImmutabilityHelper { - merge(base: any, ...args: any[]): any; - mergeItem(obj: any, key: any, newValueObject: any): any; - push(array: any[], obj: any): any[]; - shift(array: any[]): any[]; - } - export var ImmutabilityHelper: ImmutabilityHelper; - - interface KeyCode { - DOWN: number; - ESC: number; - ENTER: number; - LEFT: number; - RIGHT: number; - SPACE: number; - TAB: number; - UP: number; - } - var KeyCode: KeyCode; - - interface KeyLine { - Desktop: { - GUTTER: number; - GUTTER_LESS: number; - INCREMENT: number; - MENU_ITEM_HEIGHT: number; - }; - - getIncrementalDim(dim: number): number; - } - export var KeyLine: KeyLine; - - interface UniqueId { - generate(): string; - } - export var UniqueId: UniqueId; - - interface Styles { - mergeAndPrefix(base: any, ...args: any[]): React.CSSProperties; - } - export var Styles: Styles; - } - - // New menus available only through requiring directly to the end file - namespace Menus { - interface IconMenuProps extends React.Props { - closeOnItemTouchTap?: boolean; - desktop?: boolean; - iconButtonElement: React.ReactElement; - openDirection?: string; - menuStyle?: React.CSSProperties; - multiple?: boolean; - value?: string | Array; - width?: string | number; - touchTapCloseDelay?: number; - - onKeyboardFocus?: React.FocusEventHandler; - onItemTouchTap?: (e: TouchTapEvent, item: React.ReactElement) => void; - onChange?: (e: React.FormEvent, value: string | Array) => void; - } - export class IconMenu extends React.Component { - } - - interface MenuProps extends React.Props { - animated?: boolean; - autoWidth?: boolean; - desktop?: boolean; - listStyle?: React.CSSProperties; - maxHeight?: number; - multiple?: boolean; - openDirection?: string; - value?: string | Array; - width?: string | number; - zDepth?: number; - } - export class Menu extends React.Component{ - } - - interface MenuItemProps extends React.Props { - checked?: boolean; - desktop?: boolean; - disabled?: boolean; - innerDivStyle?: React.CSSProperties; - insetChildren?: boolean; - leftIcon?: React.ReactElement; - primaryText?: string | React.ReactElement; - rightIcon?: React.ReactElement; - secondaryText?: React.ReactNode; - value?: string; - - onEscKeyDown?: React.KeyboardEventHandler; - onItemTouchTap?: (e: TouchTapEvent, item: React.ReactElement) => void; - onChange?: (e: React.FormEvent, value: string) => void; - } - export class MenuItem extends React.Component{ - } - - interface MenuDividerProps extends React.Props { - inset?: boolean; - style?: React.CSSProperties; - } - export class MenuDivider extends React.Component{ - } - } -} // __MaterialUI - -declare module 'material-ui/lib/app-bar' { - import AppBar = __MaterialUI.AppBar; - export = AppBar; -} - -declare module 'material-ui/lib/app-canvas' { - import AppCanvas = __MaterialUI.AppCanvas; - export = AppCanvas; -} - -declare module 'material-ui/lib/avatar' { - import Avatar = __MaterialUI.Avatar; - export = Avatar; -} - -declare module 'material-ui/lib/before-after-wrapper' { - import BeforeAfterWrapper = __MaterialUI.BeforeAfterWrapper; - export = BeforeAfterWrapper; -} - -declare module 'material-ui/lib/card/card' { - import Card = __MaterialUI.Card.Card; - export = Card; -} - -declare module 'material-ui/lib/card/card-actions' { - import CardActions = __MaterialUI.Card.CardActions; - export = CardActions; -} - -declare module 'material-ui/lib/card/card-expandable' { - import CardExpandable = __MaterialUI.Card.CardExpandable; - export = CardExpandable; -} - -declare module 'material-ui/lib/card/card-header' { - import CardHeader = __MaterialUI.Card.CardHeader; - export = CardHeader; -} - -declare module 'material-ui/lib/card/card-media' { - import CardMedia = __MaterialUI.Card.CardMedia; - export = CardMedia; -} - -declare module 'material-ui/lib/card/card-text' { - import CardText = __MaterialUI.Card.CardText; - export = CardText; -} - -declare module 'material-ui/lib/card/card-title' { - import CardTitle = __MaterialUI.Card.CardTitle; - export = CardTitle; -} - -declare module 'material-ui/lib/checkbox' { - import Checkbox = __MaterialUI.Checkbox; - export = Checkbox; -} - -declare module 'material-ui/lib/circular-progress' { - import CircularProgress = __MaterialUI.CircularProgress; - export = CircularProgress; -} - -declare module 'material-ui/lib/clearfix' { - import ClearFix = __MaterialUI.ClearFix; - export = ClearFix; -} - -declare module 'material-ui/lib/date-picker/date-picker' { - import DatePicker = __MaterialUI.DatePicker.DatePicker; - export = DatePicker; -} - -declare module 'material-ui/lib/date-picker/date-picker-dialog' { - import DatePickerDialog = __MaterialUI.DatePicker.DatePickerDialog; - export = DatePickerDialog; -} - -declare module 'material-ui/lib/dialog' { - import Dialog = __MaterialUI.Dialog; - export = Dialog; -} - -declare module 'material-ui/lib/drop-down-icon' { - import DropDownIcon = __MaterialUI.DropDownIcon; - export = DropDownIcon; -} - -declare module 'material-ui/lib/drop-down-menu' { - import DropDownMenu = __MaterialUI.DropDownMenu; - export = DropDownMenu; -} - -declare module 'material-ui/lib/enhanced-button' { - import EnhancedButton = __MaterialUI.EnhancedButton; - export = EnhancedButton; -} - -declare module 'material-ui/lib/flat-button' { - import FlatButton = __MaterialUI.FlatButton; - export = FlatButton; -} - -declare module 'material-ui/lib/floating-action-button' { - import FloatingActionButton = __MaterialUI.FloatingActionButton; - export = FloatingActionButton; -} - -declare module 'material-ui/lib/font-icon' { - import FontIcon = __MaterialUI.FontIcon; - export = FontIcon; -} - -declare module 'material-ui/lib/icon-button' { - import IconButton = __MaterialUI.IconButton; - export = IconButton; -} - -declare module 'material-ui/lib/left-nav' { - import LeftNav = __MaterialUI.LeftNav; - export = LeftNav; -} - -declare module 'material-ui/lib/linear-progress' { - import LinearProgress = __MaterialUI.LinearProgress; - export = LinearProgress; -} - -declare module 'material-ui/lib/lists/list' { - import List = __MaterialUI.Lists.List; - export = List; -} - -declare module 'material-ui/lib/lists/list-divider' { - import ListDivider = __MaterialUI.Lists.ListDivider; - export = ListDivider; -} - -declare module 'material-ui/lib/lists/list-item' { - import ListItem = __MaterialUI.Lists.ListItem; - export = ListItem; -} - -declare module 'material-ui/lib/menu/menu' { - import Menu = __MaterialUI.Menu.Menu; - export = Menu; -} - -declare module 'material-ui/lib/menu/menu-item' { - import MenuItem = __MaterialUI.Menu.MenuItem; - export = MenuItem; -} - -declare module 'material-ui/lib/mixins/' { - export import ClickAwayable = __MaterialUI.Mixins.ClickAwayable; // require('material-ui/lib/mixins/click-awayable'); - export import WindowListenable = __MaterialUI.Mixins.WindowListenable; // require('material-ui/lib/mixins/window-listenable'); - export import StylePropable = __MaterialUI.Mixins.StylePropable; // require('material-ui/lib/mixins/style-propable'); - export import StyleResizable = __MaterialUI.Mixins.StyleResizable; // require('material-ui/lib/mixins/style-resizable'); -} - -declare module 'material-ui/lib/mixins/click-awayable' { - import ClickAwayable = __MaterialUI.Mixins.ClickAwayable; - export = ClickAwayable; -} - -declare module 'material-ui/lib/mixins/window-listenable' { - import WindowListenable = __MaterialUI.Mixins.WindowListenable; - export = WindowListenable; -} - -declare module 'material-ui/lib/mixins/style-propable' { - import StylePropable = __MaterialUI.Mixins.StylePropable; - export = StylePropable; -} - -declare module 'material-ui/lib/mixins/style-resizable' { - import StyleResizable = __MaterialUI.Mixins.StyleResizable; - export = StyleResizable; -} - -declare module 'material-ui/lib/overlay' { - import Overlay = __MaterialUI.Overlay; - export = Overlay; -} - -declare module 'material-ui/lib/paper' { - import Paper = __MaterialUI.Paper; - export = Paper; -} - -declare module 'material-ui/lib/radio-button' { - import RadioButton = __MaterialUI.RadioButton; - export = RadioButton; -} - -declare module 'material-ui/lib/radio-button-group' { - import RadioButtonGroup = __MaterialUI.RadioButtonGroup; - export = RadioButtonGroup; -} - -declare module 'material-ui/lib/raised-button' { - import RaisedButton = __MaterialUI.RaisedButton; - export = RaisedButton; -} - -declare module 'material-ui/lib/refresh-indicator' { - import RefreshIndicator = __MaterialUI.RefreshIndicator; - export = RefreshIndicator; -} - -declare module 'material-ui/lib/ripples/' { - export import CircleRipple = __MaterialUI.Ripples.CircleRipple; - export import FocusRipple = __MaterialUI.Ripples.FocusRipple; - export import TouchRipple = __MaterialUI.Ripples.TouchRipple; -} - -declare module 'material-ui/lib/select-field' { - import SelectField = __MaterialUI.SelectField; - export = SelectField; -} - -declare module 'material-ui/lib/slider' { - import Slider = __MaterialUI.Slider; - export = Slider; -} - -declare module 'material-ui/lib/svg-icon' { - import SvgIcon = __MaterialUI.SvgIcon; - export = SvgIcon; -} - -declare module 'material-ui/lib/svg-icons/navigation/menu' { - import NavigationMenu = __MaterialUI.NavigationMenu; - export = NavigationMenu; -} - -declare module 'material-ui/lib/svg-icons/navigation/chevron-left' { - import NavigationChevronLeft = __MaterialUI.NavigationChevronLeft; - export = NavigationChevronLeft; -} - -declare module 'material-ui/lib/svg-icons/navigation/chevron-right' { - import NavigationChevronRight = __MaterialUI.NavigationChevronRight; - export = NavigationChevronRight; -} - -declare module 'material-ui/lib/styles/' { - export import AutoPrefix = __MaterialUI.Styles.AutoPrefix; // require('material-ui/lib/styles/auto-prefix'); - export import Colors = __MaterialUI.Styles.Colors; // require('material-ui/lib/styles/colors'); - export import Spacing = require('material-ui/lib/styles/spacing'); - export import ThemeManager = __MaterialUI.Styles.ThemeManager; // require('material-ui/lib/styles/theme-manager'); - export import Transitions = __MaterialUI.Styles.Transitions; // require('material-ui/lib/styles/transitions'); - export import Typography = __MaterialUI.Styles.Typography; // require('material-ui/lib/styles/typography'); - export import LightRawTheme = __MaterialUI.Styles.LightRawTheme; // require('material-ui/lib/styles/raw-themes/light-raw-theme'), - export import DarkRawTheme = __MaterialUI.Styles.DarkRawTheme; // require('material-ui/lib/styles/raw-themes/dark-raw-theme'), - export import ThemeDecorator = __MaterialUI.Styles.ThemeDecorator; //require('material-ui/lib/styles/theme-decorator'); -} - -declare module 'material-ui/lib/styles/auto-prefix' { - import AutoPrefix = __MaterialUI.Styles.AutoPrefix; - export = AutoPrefix; -} - -declare module 'material-ui/lib/styles/spacing' { - type Spacing = __MaterialUI.Styles.Spacing; - var Spacing: Spacing; - export = Spacing; -} - -declare module 'material-ui/lib/styles/theme-manager' { - import ThemeManager = __MaterialUI.Styles.ThemeManager; - export = ThemeManager; -} - -declare module 'material-ui/lib/styles/transitions' { - import Transitions = __MaterialUI.Styles.Transitions; - export = Transitions; -} - -declare module 'material-ui/lib/styles/typography' { - import Typography = __MaterialUI.Styles.Typography; - export = Typography; -} - -declare module 'material-ui/lib/styles/raw-themes/light-raw-theme' { - import LightRawTheme = __MaterialUI.Styles.LightRawTheme; - export = LightRawTheme; -} - -declare module 'material-ui/lib/styles/raw-themes/dark-raw-theme' { - import DarkRawTheme = __MaterialUI.Styles.DarkRawTheme; - export = DarkRawTheme; -} - -declare module 'material-ui/lib/styles/theme-decorator' { - import ThemeDecorator = __MaterialUI.Styles.ThemeDecorator; - export = ThemeDecorator; -} - - -declare module 'material-ui/lib/snackbar' { - import Snackbar = __MaterialUI.Snackbar; - export = Snackbar; -} - -declare module 'material-ui/lib/tabs/tab' { - import Tab = __MaterialUI.Tabs.Tab; - export = Tab; -} - -declare module 'material-ui/lib/tabs/tabs' { - import Tabs = __MaterialUI.Tabs.Tabs; - export = Tabs; -} - -declare module 'material-ui/lib/table/table' { - import Table = __MaterialUI.Table.Table; - export = Table; -} - -declare module 'material-ui/lib/table/table-body' { - import TableBody = __MaterialUI.Table.TableBody; - export = TableBody; -} - -declare module 'material-ui/lib/table/table-footer' { - import TableFooter = __MaterialUI.Table.TableFooter; - export = TableFooter; -} - -declare module 'material-ui/lib/table/table-header' { - import TableHeader = __MaterialUI.Table.TableHeader; - export = TableHeader; -} - -declare module 'material-ui/lib/table/table-header-column' { - import TableHeaderColumn = __MaterialUI.Table.TableHeaderColumn; - export = TableHeaderColumn; -} - -declare module 'material-ui/lib/table/table-row' { - import TableRow = __MaterialUI.Table.TableRow; - export = TableRow; -} - -declare module 'material-ui/lib/table/table-row-column' { - import TableRowColumn = __MaterialUI.Table.TableRowColumn; - export = TableRowColumn; -} - -declare module 'material-ui/lib/theme-wrapper' { - import ThemeWrapper = __MaterialUI.ThemeWrapper; - export = ThemeWrapper; -} - -declare module 'material-ui/lib/toggle' { - import Toggle = __MaterialUI.Toggle; - export = Toggle; -} - -declare module 'material-ui/lib/time-picker' { - import TimePicker = __MaterialUI.TimePicker; - export = TimePicker; -} - -declare module 'material-ui/lib/text-field' { - import TextField = __MaterialUI.TextField; - export = TextField; -} - -declare module 'material-ui/lib/toolbar/toolbar' { - import Toolbar = __MaterialUI.Toolbar.Toolbar; - export = Toolbar; -} - -declare module 'material-ui/lib/toolbar/toolbar-group' { - import ToolbarGroup = __MaterialUI.Toolbar.ToolbarGroup; - export = ToolbarGroup; -} - -declare module 'material-ui/lib/toolbar/toolbar-separator' { - import ToolbarSeparator = __MaterialUI.Toolbar.ToolbarSeparator; - export = ToolbarSeparator; -} - -declare module 'material-ui/lib/toolbar/toolbar-title' { - import ToolbarTitle = __MaterialUI.Toolbar.ToolbarTitle; - export = ToolbarTitle; -} - -declare module 'material-ui/lib/tooltip' { - import Tooltip = __MaterialUI.Tooltip; - export = Tooltip; -} - -declare module 'material-ui/lib/utils/' { - export import ColorManipulator = __MaterialUI.Utils.ColorManipulator; // require('material-ui/lib/utils/color-manipulator'); - export import CssEvent = __MaterialUI.Utils.CssEvent; // require('material-ui/lib/utils/css-event'); - export import Dom = __MaterialUI.Utils.Dom; // require('material-ui/lib/utils/dom'); - export import Events = __MaterialUI.Utils.Events; // require('material-ui/lib/utils/events'); - export import Extend = __MaterialUI.Utils.Extend; // require('material-ui/lib/utils/extend'); - export import ImmutabilityHelper = __MaterialUI.Utils.ImmutabilityHelper; // require('material-ui/lib/utils/immutability-helper'); - export import KeyCode = __MaterialUI.Utils.KeyCode; // require('material-ui/lib/utils/key-code'); - export import KeyLine = __MaterialUI.Utils.KeyLine; // require('material-ui/lib/utils/key-line'); - export import UniqueId = __MaterialUI.Utils.UniqueId; // require('material-ui/lib/utils/unique-id'); - export import Styles = __MaterialUI.Utils.Styles; // require('material-ui/lib/utils/styles'); -} - -declare module 'material-ui/lib/utils/color-manipulator' { - import ColorManipulator = __MaterialUI.Utils.ColorManipulator; - export = ColorManipulator; -} - -declare module 'material-ui/lib/utils/css-event' { - import CssEvent = __MaterialUI.Utils.CssEvent; - export = CssEvent; -} - -declare module 'material-ui/lib/utils/dom' { - import Dom = __MaterialUI.Utils.Dom; - export = Dom; -} - -declare module 'material-ui/lib/utils/events' { - import Events = __MaterialUI.Utils.Events; - export = Events; -} - -declare module 'material-ui/lib/utils/extend' { - import Extend = __MaterialUI.Utils.Extend; - export = Extend; -} - -declare module 'material-ui/lib/utils/immutability-helper' { - import ImmutabilityHelper = __MaterialUI.Utils.ImmutabilityHelper; - export = ImmutabilityHelper; -} - -declare module 'material-ui/lib/utils/key-code' { - import KeyCode = __MaterialUI.Utils.KeyCode; - export = KeyCode; -} - -declare module 'material-ui/lib/utils/key-line' { - import KeyLine = __MaterialUI.Utils.KeyLine; - export = KeyLine; -} - -declare module 'material-ui/lib/utils/unique-id' { - import UniqueId = __MaterialUI.Utils.UniqueId; - export = UniqueId; -} - -declare module 'material-ui/lib/utils/styles' { - import Styles = __MaterialUI.Utils.Styles; - export = Styles; -} - -declare module "material-ui/lib/menus/icon-menu" { - import IconMenu = __MaterialUI.Menus.IconMenu; - export = IconMenu; -} - -declare module "material-ui/lib/menus/menu" { - import Menu = __MaterialUI.Menus.Menu; - export = Menu; -} - -declare module "material-ui/lib/menus/menu-item" { - import MenuItem = __MaterialUI.Menus.MenuItem; - export = MenuItem; -} - -declare module "material-ui/lib/menus/menu-divider" { - import MenuDivider = __MaterialUI.Menus.MenuDivider; - export = MenuDivider; -} - -declare module "material-ui/lib/styles/colors" { - import Colors = __MaterialUI.Styles.Colors; - export = Colors; -} - -declare namespace __MaterialUI.Styles { - interface Colors { - red50: string; - red100: string; - red200: string; - red300: string; - red400: string; - red500: string; - red600: string; - red700: string; - red800: string; - red900: string; - redA100: string; - redA200: string; - redA400: string; - redA700: string; - - pink50: string; - pink100: string; - pink200: string; - pink300: string; - pink400: string; - pink500: string; - pink600: string; - pink700: string; - pink800: string; - pink900: string; - pinkA100: string; - pinkA200: string; - pinkA400: string; - pinkA700: string; - - purple50: string; - purple100: string; - purple200: string; - purple300: string; - purple400: string; - purple500: string; - purple600: string; - purple700: string; - purple800: string; - purple900: string; - purpleA100: string; - purpleA200: string; - purpleA400: string; - purpleA700: string; - - deepPurple50: string; - deepPurple100: string; - deepPurple200: string; - deepPurple300: string; - deepPurple400: string; - deepPurple500: string; - deepPurple600: string; - deepPurple700: string; - deepPurple800: string; - deepPurple900: string; - deepPurpleA100: string; - deepPurpleA200: string; - deepPurpleA400: string; - deepPurpleA700: string; - - indigo50: string; - indigo100: string; - indigo200: string; - indigo300: string; - indigo400: string; - indigo500: string; - indigo600: string; - indigo700: string; - indigo800: string; - indigo900: string; - indigoA100: string; - indigoA200: string; - indigoA400: string; - indigoA700: string; - - blue50: string; - blue100: string; - blue200: string; - blue300: string; - blue400: string; - blue500: string; - blue600: string; - blue700: string; - blue800: string; - blue900: string; - blueA100: string; - blueA200: string; - blueA400: string; - blueA700: string; - - lightBlue50: string; - lightBlue100: string; - lightBlue200: string; - lightBlue300: string; - lightBlue400: string; - lightBlue500: string; - lightBlue600: string; - lightBlue700: string; - lightBlue800: string; - lightBlue900: string; - lightBlueA100: string; - lightBlueA200: string; - lightBlueA400: string; - lightBlueA700: string; - - cyan50: string; - cyan100: string; - cyan200: string; - cyan300: string; - cyan400: string; - cyan500: string; - cyan600: string; - cyan700: string; - cyan800: string; - cyan900: string; - cyanA100: string; - cyanA200: string; - cyanA400: string; - cyanA700: string; - - teal50: string; - teal100: string; - teal200: string; - teal300: string; - teal400: string; - teal500: string; - teal600: string; - teal700: string; - teal800: string; - teal900: string; - tealA100: string; - tealA200: string; - tealA400: string; - tealA700: string; - - green50: string; - green100: string; - green200: string; - green300: string; - green400: string; - green500: string; - green600: string; - green700: string; - green800: string; - green900: string; - greenA100: string; - greenA200: string; - greenA400: string; - greenA700: string; - - lightGreen50: string; - lightGreen100: string; - lightGreen200: string; - lightGreen300: string; - lightGreen400: string; - lightGreen500: string; - lightGreen600: string; - lightGreen700: string; - lightGreen800: string; - lightGreen900: string; - lightGreenA100: string; - lightGreenA200: string; - lightGreenA400: string; - lightGreenA700: string; - - lime50: string; - lime100: string; - lime200: string; - lime300: string; - lime400: string; - lime500: string; - lime600: string; - lime700: string; - lime800: string; - lime900: string; - limeA100: string; - limeA200: string; - limeA400: string; - limeA700: string; - - yellow50: string; - yellow100: string; - yellow200: string; - yellow300: string; - yellow400: string; - yellow500: string; - yellow600: string; - yellow700: string; - yellow800: string; - yellow900: string; - yellowA100: string; - yellowA200: string; - yellowA400: string; - yellowA700: string; - - amber50: string; - amber100: string; - amber200: string; - amber300: string; - amber400: string; - amber500: string; - amber600: string; - amber700: string; - amber800: string; - amber900: string; - amberA100: string; - amberA200: string; - amberA400: string; - amberA700: string; - - orange50: string; - orange100: string; - orange200: string; - orange300: string; - orange400: string; - orange500: string; - orange600: string; - orange700: string; - orange800: string; - orange900: string; - orangeA100: string; - orangeA200: string; - orangeA400: string; - orangeA700: string; - - deepOrange50: string; - deepOrange100: string; - deepOrange200: string; - deepOrange300: string; - deepOrange400: string; - deepOrange500: string; - deepOrange600: string; - deepOrange700: string; - deepOrange800: string; - deepOrange900: string; - deepOrangeA100: string; - deepOrangeA200: string; - deepOrangeA400: string; - deepOrangeA700: string; - - brown50: string; - brown100: string; - brown200: string; - brown300: string; - brown400: string; - brown500: string; - brown600: string; - brown700: string; - brown800: string; - brown900: string; - - blueGrey50: string; - blueGrey100: string; - blueGrey200: string; - blueGrey300: string; - blueGrey400: string; - blueGrey500: string; - blueGrey600: string; - blueGrey700: string; - blueGrey800: string; - blueGrey900: string; - - grey50: string; - grey100: string; - grey200: string; - grey300: string; - grey400: string; - grey500: string; - grey600: string; - grey700: string; - grey800: string; - grey900: string; - - black: string; - white: string; - - transparent: string; - fullBlack: string; - darkBlack: string; - lightBlack: string; - minBlack: string; - faintBlack: string; - fullWhite: string; - darkWhite: string; - lightWhite: string; - } - export var Colors: Colors; -} diff --git a/material-ui/legacy/material-ui-0.13.4-tests.tsx b/material-ui/legacy/material-ui-0.13.4-tests.tsx deleted file mode 100644 index 6a4228e0b0..0000000000 --- a/material-ui/legacy/material-ui-0.13.4-tests.tsx +++ /dev/null @@ -1,534 +0,0 @@ -/// -/// -/// - -import * as React from "react"; -import * as LinkedStateMixin from "react-addons-linked-state-mixin"; -import Checkbox = require("material-ui/lib/checkbox"); -import Colors = require("material-ui/lib/styles/colors"); -import Spacing = require("material-ui/lib/styles/spacing"); -import AppBar = require("material-ui/lib/app-bar"); -import Badge = require("material-ui/lib/badge"); -import IconButton = require("material-ui/lib/icon-button"); -import FlatButton = require("material-ui/lib/flat-button"); -import Avatar = require("material-ui/lib/avatar"); -import FontIcon = require("material-ui/lib/font-icon"); -import Typography = require("material-ui/lib/styles/typography"); -import RaisedButton = require("material-ui/lib/raised-button"); -import FloatingActionButton = require("material-ui/lib/floating-action-button"); -import Card = require("material-ui/lib/card/card"); -import CardHeader = require("material-ui/lib/card/card-header"); -import CardText = require("material-ui/lib/card/card-text"); -import CardActions = require("material-ui/lib/card/card-actions"); -import Dialog = require("material-ui/lib/dialog"); -import DropDownMenu = require("material-ui/lib/drop-down-menu"); -import DatePicker = require("material-ui/lib/date-picker/date-picker"); -import TimePicker = require("material-ui/lib/time-picker"); -import RadioButtonGroup = require("material-ui/lib/radio-button-group"); -import RadioButton = require("material-ui/lib/radio-button"); -import Toggle = require("material-ui/lib/toggle"); -import TextField = require("material-ui/lib/text-field"); -import SelectField = require("material-ui/lib/select-field"); -import IconMenu = require("material-ui/lib/menus/icon-menu"); -import Menu = require('material-ui/lib/menus/menu'); -import MenuItem = require('material-ui/lib/menus/menu-item'); -import MenuDivider = require('material-ui/lib/menus/menu-divider'); -import ThemeManager = require('material-ui/lib/styles/theme-manager'); -import GridList = require('material-ui/lib/grid-list/grid-list'); -import GridTile = require('material-ui/lib/grid-list/grid-tile'); - - -import NavigationClose = require("material-ui/lib/svg-icon"); // TODO: Should actually import the actual "material-ui/lib/svg-icons/navigation/close", but they aren't defined yet. -import FileFolder = require("material-ui/lib/svg-icon"); // TODO: Should actually import the actual "material-ui/lib/svg-icons/file/folder", but they aren't defined yet. -import ToggleStar = require("material-ui/lib/svg-icon"); // TODO: Should actually import the actual "material-ui/lib/svg-icons/toggle/star", but they aren't defined yet. -import ActionGrade = require("material-ui/lib/svg-icon"); // TODO: Should actually import the actual "material-ui/lib/svg-icons/action/grade", but they aren't defined yet. -import ToggleStarBorder = require("material-ui/lib/svg-icon"); // TODO: Should actually import the actual "material-ui/lib/svg-icons/toggle/star-border", but they aren't defined yet. -import ArrowDropRight = require("material-ui/lib/svg-icon"); // TODO: Should actually import the actual "material-ui/lib/svg-icons/toggle/star-border", but they aren't defined yet. - -type CheckboxProps = __MaterialUI.CheckboxProps; -type MuiTheme = __MaterialUI.Styles.MuiTheme; -type TouchTapEvent = __MaterialUI.TouchTapEvent; - -interface MaterialUiTestsState { - showDialogStandardActions: boolean; - showDialogCustomActions: boolean; - showDialogScrollable: boolean; -} - -class MaterialUiTests extends React.Component<{}, MaterialUiTestsState> implements React.LinkedStateMixin { - - // injected with mixin - linkState: (key: string) => React.ReactLink; - dialog: Dialog; - - private touchTapEventHandler(e: TouchTapEvent) { - this.dialog.show(); - } - private formEventHandler(e: React.FormEvent) { - } - private selectFieldChangeHandler(e: TouchTapEvent, si: number, mi: any) { - } - private handleRequestClose(buttonClicked: boolean) { - } - - render() { - - // "http://material-ui.com/#/customization/themes" - let muiTheme: MuiTheme = ThemeManager.getMuiTheme({ - palette: { - accent1Color: Colors.cyan100 - }, - spacing: { - - } - }); - - // "http://material-ui.com/#/customization/inline-styles" - let element: React.ReactElement; - element = - element = React.createElement(Checkbox, { - id: "checkboxId1", name: "checkboxName1", value: "checkboxValue1", label: "went for a run today", style: { - width: '50%', - margin: '0 auto' - }, iconStyle: { - fill: '#FF4081' - } - }); - - // "http://material-ui.com/#/components/appbar" - element = - element = } - iconElementRight={} />; - - // "http://material-ui.com/#/components/avatars" - //image avatar - element = ; - //SvgIcon avatar - element = } />; - //SvgIcon avatar with custom colors - element = } - color={Colors.orange200} - backgroundColor={Colors.pink400} />; - //FontIcon avatar - element = - } />; - //FontIcon avatar with custom colors - element = } - color={Colors.blue300} - backgroundColor={Colors.indigo900} />; - //Letter avatar - element = A; - //Letter avatar with custom colors - element = - - - // "http://material-ui.com/#/components/badge" - element = Hello}> - - ; - element = Hello} - badgeStyle={{height: '24px', width: '24px'}} - > - This text has a badge! - ; - - // "http://material-ui.com/#/components/buttons" - element = - - ; - element = - - ; - element = - - ; - - // "http://material-ui.com/#/components/cards" - element = - A} - showExpandableButton={true}> - - - Lorem ipsum dolor sit amet, consectetur adipiscing elit. - - - - - - - Lorem ipsum dolor sit amet, consectetur adipiscing elit. - - ; - - // "http://material-ui.com/#/components/date-picker" - element = ; - element = ; - element = ; - - // "http://material-ui.com/#/components/time-picker" - element = - - // "http://material-ui.com/#/components/dialog" - let standardActions = [ - { text: 'Cancel' }, - { text: 'Submit', onTouchTap: this.touchTapEventHandler, ref: 'submit' } - ]; - - element = - The actions in this window are created from the json that's passed in. - ; - - //Custom Actions - let customActions = [ - , - - ]; - - element = - The actions in this window were passed in as an array of react objects. - ; - - element = -
- Really long content -
- ; - - - // "http://material-ui.com/#/components/dropdown-menu" - let menuItems = [ - { payload: '1', text: 'Never' }, - { payload: '2', text: 'Every Night' }, - { payload: '3', text: 'Weeknights' }, - { payload: '4', text: 'Weekends' }, - { payload: '5', text: 'Weekly' }, - ]; - element = ; - - // "http://material-ui.com/#/components/icons" - element = home; - - // "http://material-ui.com/#/components/icon-buttons" - //Method 1: muidocs-icon-github is defined in a style sheet. - element = ; - //Method 2: ActionGrade is a component created using mui.SvgIcon. - element = - - ; - //Method 3: Manually creating a mui.FontIcon component within IconButton - element = - - ; - //Method 4: Using Google material-icons - element = settings_system_daydream; - - // "http://material-ui.com/#/components/icon-menus" - element = }> - - - - - - ; - - // "http://material-ui.com/#/components/left-nav" - - - // "http://material-ui.com/#/components/lists" - - - // "http://material-ui.com/#/components/menus" - element = - - - - - ; - element = - - - - - - - - } /> - } /> - } /> - } /> - } /> - - - ; - - // "http://material-ui.com/#/components/paper" - - - // "http://material-ui.com/#/components/progress" - - - // "http://material-ui.com/#/components/refresh-indicator" - - - // "http://material-ui.com/#/components/sliders" - - - // "http://material-ui.com/#/components/switches" - element = ; - element = ; - element = } - unCheckedIcon={} - label="custom icon" />; - - element = - ; - ; - - ; - - element = ; - - element = ; - - element = ; - - // "http://material-ui.com/#/components/snackbar" - - - // "http://material-ui.com/#/components/table" - - - // "http://material-ui.com/#/components/tabs" - - - // "http://material-ui.com/#/components/text-fields" - element = ; - element = ; - element = ; - element = ; - element = ('valueLinkValue') } />; - element = ; - element = ; - element = ; - element = ; - element = ; - element = ; - element = ; - - //Select Fields - let arbitraryArrayMenuItems = [ - { - id: 0, - name: "zero", - }, - ]; - element = ; - element = ; - element = ; - element = ; - - //Floating Hint Text Labels - element = ; - element = ; - element = ; - element = ('floatingValueLinkValue') } />; - element = ; - element = ; - element = ; - element = ; - element = ; - element = ; - - - // "http://material-ui.com/#/components/time-picker" - - - // "http://material-ui.com/#/components/toolbars" - - // "http://material-ui.com/#/components/grid-list" - element = ; - - element = GridTile} - actionPosition="left" - titlePosition="top" - titleBackground="rgba(0, 0, 0, 0.4)" - cols={2} - rows={1} - style={{ color: 'red' }}> -

Children are Required!

- ; - - return element; - } -} diff --git a/material-ui/legacy/material-ui-0.13.4.d.ts b/material-ui/legacy/material-ui-0.13.4.d.ts deleted file mode 100644 index d2913c0fe4..0000000000 --- a/material-ui/legacy/material-ui-0.13.4.d.ts +++ /dev/null @@ -1,3283 +0,0 @@ -// Type definitions for material-ui v0.13.4 -// Project: https://github.com/callemall/material-ui -// Definitions by: Nathan Brown , Oliver Herrmann -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -/// - -declare module "material-ui" { - export import AppBar = __MaterialUI.AppBar; // require('material-ui/lib/app-bar'); - export import AppCanvas = __MaterialUI.AppCanvas; // require('material-ui/lib/app-canvas'); - export import Avatar = __MaterialUI.Avatar; // require('material-ui/lib/avatar'); - export import Badge = __MaterialUI.Badge; // require('material-ui/lib/badge'); - export import BeforeAfterWrapper = __MaterialUI.BeforeAfterWrapper; // require('material-ui/lib/before-after-wrapper'); - export import Card = __MaterialUI.Card.Card; // require('material-ui/lib/card/card'); - export import CardActions = __MaterialUI.Card.CardActions; // require('material-ui/lib/card/card-actions'); - export import CardExpandable = __MaterialUI.Card.CardExpandable; // require('material-ui/lib/card/card-expandable'); - export import CardHeader = __MaterialUI.Card.CardHeader; // require('material-ui/lib/card/card-header'); - export import CardMedia = __MaterialUI.Card.CardMedia; // require('material-ui/lib/card/card-media'); - export import CardText = __MaterialUI.Card.CardText; // require('material-ui/lib/card/card-text'); - export import CardTitle = __MaterialUI.Card.CardTitle; // require('material-ui/lib/card/card-title'); - export import Checkbox = __MaterialUI.Checkbox; // require('material-ui/lib/checkbox'); - export import CircularProgress = __MaterialUI.CircularProgress; // require('material-ui/lib/circular-progress'); - export import ClearFix = __MaterialUI.ClearFix; // require('material-ui/lib/clearfix'); - export import DatePicker = __MaterialUI.DatePicker.DatePicker; // require('material-ui/lib/date-picker/date-picker'); - export import DatePickerDialog = __MaterialUI.DatePicker.DatePickerDialog; // require('material-ui/lib/date-picker/date-picker-dialog'); - export import Dialog = __MaterialUI.Dialog // require('material-ui/lib/dialog'); - export import DropDownIcon = __MaterialUI.DropDownIcon; // require('material-ui/lib/drop-down-icon'); - export import DropDownMenu = __MaterialUI.DropDownMenu; // require('material-ui/lib/drop-down-menu'); - export import EnhancedButton = __MaterialUI.EnhancedButton; // require('material-ui/lib/enhanced-button'); - export import FlatButton = __MaterialUI.FlatButton; // require('material-ui/lib/flat-button'); - export import FloatingActionButton = __MaterialUI.FloatingActionButton; // require('material-ui/lib/floating-action-button'); - export import FontIcon = __MaterialUI.FontIcon; // require('material-ui/lib/font-icon'); - export import IconButton = __MaterialUI.IconButton; // require('material-ui/lib/icon-button'); - export import IconMenu = __MaterialUI.Menus.IconMenu; // require('material-ui/lib/menus/icon-menu'); - export import LeftNav = __MaterialUI.LeftNav; // require('material-ui/lib/left-nav'); - export import LinearProgress = __MaterialUI.LinearProgress; // require('material-ui/lib/linear-progress'); - export import List = __MaterialUI.Lists.List; // require('material-ui/lib/lists/list'); - export import ListDivider = __MaterialUI.Lists.ListDivider; // require('material-ui/lib/lists/list-divider'); - export import ListItem = __MaterialUI.Lists.ListItem; // require('material-ui/lib/lists/list-item'); - export import Menu = __MaterialUI.Menu.Menu; // require('material-ui/lib/menu/menu'); - export import MenuItem = __MaterialUI.Menu.MenuItem; // require('material-ui/lib/menu/menu-item'); - export import Mixins = __MaterialUI.Mixins; // require('material-ui/lib/mixins/'); - export import Overlay = __MaterialUI.Overlay; // require('material-ui/lib/overlay'); - export import Paper = __MaterialUI.Paper; // require('material-ui/lib/paper'); - export import RadioButton = __MaterialUI.RadioButton; // require('material-ui/lib/radio-button'); - export import RadioButtonGroup = __MaterialUI.RadioButtonGroup; // require('material-ui/lib/radio-button-group'); - export import RaisedButton = __MaterialUI.RaisedButton; // require('material-ui/lib/raised-button'); - export import RefreshIndicator = __MaterialUI.RefreshIndicator; // require('material-ui/lib/refresh-indicator'); - export import Ripples = __MaterialUI.Ripples; // require('material-ui/lib/ripples/'); - export import SelectField = __MaterialUI.SelectField; // require('material-ui/lib/select-field'); - export import Slider = __MaterialUI.Slider; // require('material-ui/lib/slider'); - export import SvgIcon = __MaterialUI.SvgIcon; // require('material-ui/lib/svg-icon'); - export import Icons = __MaterialUI.Icons; - export import Styles = __MaterialUI.Styles; // require('material-ui/lib/styles/'); - export import Snackbar = __MaterialUI.Snackbar; // require('material-ui/lib/snackbar'); - export import Tab = __MaterialUI.Tabs.Tab; // require('material-ui/lib/tabs/tab'); - export import Tabs = __MaterialUI.Tabs.Tabs; // require('material-ui/lib/tabs/tabs'); - export import Table = __MaterialUI.Table.Table; // require('material-ui/lib/table/table'); - export import TableBody = __MaterialUI.Table.TableBody; // require('material-ui/lib/table/table-body'); - export import TableFooter = __MaterialUI.Table.TableFooter; // require('material-ui/lib/table/table-footer'); - export import TableHeader = __MaterialUI.Table.TableHeader; // require('material-ui/lib/table/table-header'); - export import TableHeaderColumn = __MaterialUI.Table.TableHeaderColumn; // require('material-ui/lib/table/table-header-column'); - export import TableRow = __MaterialUI.Table.TableRow; // require('material-ui/lib/table/table-row'); - export import TableRowColumn = __MaterialUI.Table.TableRowColumn; // require('material-ui/lib/table/table-row-column'); - export import ThemeWrapper = __MaterialUI.ThemeWrapper; // require('material-ui/lib/theme-wrapper'); - export import Toggle = __MaterialUI.Toggle; // require('material-ui/lib/toggle'); - export import TimePicker = __MaterialUI.TimePicker; // require('material-ui/lib/time-picker'); - export import TextField = __MaterialUI.TextField; // require('material-ui/lib/text-field'); - export import Toolbar = __MaterialUI.Toolbar.Toolbar; // require('material-ui/lib/toolbar/toolbar'); - export import ToolbarGroup = __MaterialUI.Toolbar.ToolbarGroup; // require('material-ui/lib/toolbar/toolbar-group'); - export import ToolbarSeparator = __MaterialUI.Toolbar.ToolbarSeparator; // require('material-ui/lib/toolbar/toolbar-separator'); - export import ToolbarTitle = __MaterialUI.Toolbar.ToolbarTitle; // require('material-ui/lib/toolbar/toolbar-title'); - export import Tooltip = __MaterialUI.Tooltip; // require('material-ui/lib/tooltip'); - export import Utils = __MaterialUI.Utils; // require('material-ui/lib/utils/'); - - export import GridList = __MaterialUI.GridList.GridList; // require('material-ui/lib/gridlist/grid-list'); - export import GridTile = __MaterialUI.GridList.GridTile; // require('material-ui/lib/gridlist/grid-tile'); - - // export type definitions - export type TouchTapEvent = __MaterialUI.TouchTapEvent; - export type TouchTapEventHandler = __MaterialUI.TouchTapEventHandler; - export type DialogAction = __MaterialUI.DialogAction; -} - -declare namespace __MaterialUI { - import React = __React; - - // ReactLink is from "react/addons" - interface ReactLink { - value: T; - requestChange(newValue: T): void; - } - - // What's common between React.TouchEvent and React.MouseEvent - interface TouchTapEvent extends React.SyntheticEvent { - altKey: boolean; - ctrlKey: boolean; - getModifierState(key: string): boolean; - metaKey: boolean; - shiftKey: boolean; - } - - // What's common between React.TouchEventHandler and React.MouseEventHandler - interface TouchTapEventHandler extends React.EventHandler { } - - // more specific than React.HTMLAttributes - - interface AppBarProps extends React.Props { - iconClassNameLeft?: string; - iconClassNameRight?: string; - iconElementLeft?: React.ReactElement; - iconElementRight?: React.ReactElement; - iconStyleRight?: string; - style?: React.CSSProperties; - showMenuIconButton?: boolean; - title?: React.ReactNode; - zDepth?: number; - - onLeftIconButtonTouchTap?: TouchTapEventHandler; - onRightIconButtonTouchTap?: TouchTapEventHandler; - } - export class AppBar extends React.Component{ - } - - interface AppCanvasProps extends React.Props { - style?: React.CSSProperties; - } - export class AppCanvas extends React.Component { - } - - interface AvatarProps extends React.Props { - icon?: React.ReactElement; - backgroundColor?: string; - color?: string; - size?: number; - src?: string; - style?: React.CSSProperties; - } - export class Avatar extends React.Component { - } - - interface BadgeProps extends React.Props { - badgeContent: React.ReactElement | string | number; - primary?: boolean; - secondary?: boolean; - style?: React.CSSProperties; - badgeStyle?: React.CSSProperties; - } - export class Badge extends React.Component { - } - - interface BeforeAfterWrapperProps extends React.Props { - beforeStyle?: React.CSSProperties; - afterStyle?: React.CSSProperties; - beforeElementType?: string; - afterElementType?: string; - elementType?: string; - } - export class BeforeAfterWrapper extends React.Component { - } - - namespace Card { - - interface CardProps extends React.Props { - expandable?: boolean; - initiallyExpanded?: boolean; - onExpandedChange?: (isExpanded: boolean) => void; - style?: React.CSSProperties; - } - export class Card extends React.Component { - } - - interface CardActionsProps extends React.Props { - expandable?: boolean; - showExpandableButton?: boolean; - style?: React.CSSProperties; - } - export class CardActions extends React.Component { - } - - interface CardExpandableProps extends React.Props { - onExpanding?: (isExpanded: boolean) => void; - expanded?: boolean; - style?: React.CSSProperties; - } - export class CardExpandable extends React.Component { - } - - interface CardHeaderProps extends React.Props { - expandable?: boolean; - showExpandableButton?: boolean; - title?: string | React.ReactElement; - titleColor?: string; - titleStyle?: React.CSSProperties; - subtitle?: string | React.ReactElement; - subtitleColor?: string; - subtitleStyle?: React.CSSProperties; - textStyle?: React.CSSProperties; - style?: React.CSSProperties; - avatar: React.ReactElement | string; - } - export class CardHeader extends React.Component { - } - - interface CardMediaProps extends React.Props { - expandable?: boolean; - overlay?: React.ReactNode; - overlayStyle?: React.CSSProperties; - overlayContainerStyle?: React.CSSProperties; - overlayContentStyle?: React.CSSProperties; - mediaStyle?: React.CSSProperties; - style?: React.CSSProperties; - } - export class CardMedia extends React.Component { - } - - interface CardTextProps extends React.Props { - expandable?: boolean; - color?: string; - style?: React.CSSProperties; - } - export class CardText extends React.Component { - } - - interface CardTitleProps extends React.Props { - expandable?: boolean; - showExpandableButton?: boolean; - title?: string | React.ReactElement; - titleColor?: string; - titleStyle?: React.CSSProperties; - subtitle?: string | React.ReactElement; - subtitleColor?: string; - subtitleStyle?: React.CSSProperties; - textStyle?: React.CSSProperties; - style?: React.CSSProperties; - } - export class CardTitle extends React.Component { - } - } - - // what's not commonly overridden by Checkbox, RadioButton, or Toggle - interface CommonEnhancedSwitchProps extends React.HTMLAttributes, React.Props { - // is root element - id?: string; - iconStyle?: React.CSSProperties; - labelStyle?: React.CSSProperties; - rippleStyle?: React.CSSProperties; - thumbStyle?: React.CSSProperties; - trackStyle?: React.CSSProperties; - name?: string; - value?: string; - label?: string; - required?: boolean; - disabled?: boolean; - defaultSwitched?: boolean; - disableFocusRipple?: boolean; - disableTouchRipple?: boolean; - } - - interface EnhancedSwitchProps extends CommonEnhancedSwitchProps { - // is root element - inputType: string; - switchElement: React.ReactElement; - onParentShouldUpdate: (isInputChecked: boolean) => void; - switched: boolean; - rippleColor?: string; - onSwitch?: (e: React.MouseEvent, isInputChecked: boolean) => void; - labelPosition?: string; - } - export class EnhancedSwitch extends React.Component { - isSwitched(): boolean; - setSwitched(newSwitchedValue: boolean): void; - getValue(): any; - isKeyboardFocused(): boolean; - } - - interface CheckboxProps extends CommonEnhancedSwitchProps { - // is root element - checkedIcon?: React.ReactElement<{ style?: React.CSSProperties }>; // Normally an SvgIcon - defaultChecked?: boolean; - iconStyle?: React.CSSProperties; - label?: string; - labelStyle?: React.CSSProperties; - labelPosition?: string; - style?: React.CSSProperties; - checked?: boolean; - unCheckedIcon?: React.ReactElement<{ style?: React.CSSProperties }>; // Normally an SvgIcon - - disabled?: boolean; - valueLink?: ReactLink; - checkedLink?: ReactLink; - - onCheck?: (event: React.MouseEvent, checked: boolean) => void; - } - export class Checkbox extends React.Component { - isChecked(): void; - setChecked(newCheckedValue: boolean): void; - } - - interface CircularProgressProps extends React.Props { - mode?: string; - value?: number; - min?: number; - max?: number; - size?: number; - color?: string; - innerStyle?: React.CSSProperties; - style?: React.CSSProperties; - - } - export class CircularProgress extends React.Component { - } - - interface ClearFixProps extends React.Props { - } - export class ClearFix extends React.Component { - } - - namespace DatePicker { - interface DatePickerProps extends React.Props { - autoOk?: boolean; - defaultDate?: Date; - formatDate?: (date:Date) => string; - hintText?: string; - floatingLabelText?: string; - hideToolbarYearChange?: boolean; - maxDate?: Date; - minDate?: Date; - mode?: string; - onDismiss?: () => void; - - // e is always null - onChange?: (e: any, d: Date) => void; - - onFocus?: React.FocusEventHandler; - onShow?: () => void; - onTouchTap?: React.TouchEventHandler; - shouldDisableDate?: (day: Date) => boolean; - showYearSelector?: boolean; - style?: React.CSSProperties; - textFieldStyle?: React.CSSProperties; - } - export class DatePicker extends React.Component { - } - - interface DatePickerDialogProps extends React.Props { - disableYearSelection?: boolean; - initialDate?: Date; - maxDate?: Date; - minDate?: Date; - onAccept?: (d: Date) => void; - onClickAway?: () => void; - onDismiss?: () => void; - onShow?: () => void; - shouldDisableDate?: (day: Date) => boolean; - showYearSelector?: boolean; - } - export class DatePickerDialog extends React.Component { - } - } - - export interface DialogAction { - id?: string; - text: string; - ref?: string; - - onTouchTap?: TouchTapEventHandler; - onClick?: React.MouseEventHandler; - } - interface DialogProps extends React.Props { - actions?: Array>; - actionFocus?: string; - autoDetectWindowHeight?: boolean; - autoScrollBodyContent?: boolean; - style?: React.CSSProperties; - bodyStyle?: React.CSSProperties; - contentClassName?: string; - contentInnerStyle?: React.CSSProperties; - contentStyle?: React.CSSProperties; - modal?: boolean; - openImmediately?: boolean; - repositionOnUpdate?: boolean; - title?: React.ReactNode; - defaultOpen?: boolean; - open?: boolean; - - onClickAway?: () => void; - onDismiss?: () => void; - onShow?: () => void; - onRequestClose?: (buttonClicked: boolean) => void; - } - export class Dialog extends React.Component { - dismiss(): void; - show(): void; - isOpen(): boolean; - } - - interface DropDownIconProps extends React.Props { - menuItems: Menu.MenuItemRequest[]; - closeOnMenuItemTouchTap?: boolean; - iconStyle?: React.CSSProperties; - iconClassName?: string; - iconLigature?: string; - - onChange?: Menu.ItemTapEventHandler; - } - export class DropDownIcon extends React.Component { - } - - interface DropDownMenuProps extends React.Props { - displayMember?: string; - valueMember?: string; - autoWidth?: boolean; - menuItems: Menu.MenuItemRequest[]; - menuItemStyle?: React.CSSProperties; - selectedIndex?: number; - underlineStyle?: React.CSSProperties; - iconStyle?: React.CSSProperties; - labelStyle?: React.CSSProperties; - style?: React.CSSProperties; - disabled?: boolean; - valueLink?: ReactLink; - value?: number; - - onChange?: Menu.ItemTapEventHandler; - } - export class DropDownMenu extends React.Component { - } - - // non generally overridden elements of EnhancedButton - interface SharedEnhancedButtonProps extends React.HTMLAttributes, React.Props { - centerRipple?: boolean; - containerElement?: string | React.ReactElement; - disabled?: boolean; - disableFocusRipple?: boolean; - disableKeyboardFocus?: boolean; - disableTouchRipple?: boolean; - keyboardFocused?: boolean; - linkButton?: boolean; - focusRippleColor?: string; - focusRippleOpacity?: number; - touchRippleOpacity?: number; - tabIndex?: number; - - onBlur?: React.FocusEventHandler; - onFocus?: React.FocusEventHandler; - onKeyboardFocus?: (e: React.FocusEvent, isKeyboardFocused: boolean) => void; - onKeyDown?: React.KeyboardEventHandler; - onKeyUp?: React.KeyboardEventHandler; - onMouseEnter?: React.MouseEventHandler; - onMouseLeave?: React.MouseEventHandler; - onTouchStart?: React.TouchEventHandler; - onTouchEnd?: React.TouchEventHandler; - onTouchTap?: TouchTapEventHandler; - } - - interface EnhancedButtonProps extends SharedEnhancedButtonProps { - touchRippleColor?: string; - focusRippleColor?: string; - style?: React.CSSProperties; - } - export class EnhancedButton extends React.Component { - } - - interface FlatButtonProps extends SharedEnhancedButtonProps { - hoverColor?: string; - label?: string; - labelPosition?: string; - labelStyle?: React.CSSProperties; - linkButton?: boolean; - primary?: boolean; - secondary?: boolean; - rippleColor?: string; - style?: React.CSSProperties; - } - export class FlatButton extends React.Component { - } - - interface FloatingActionButtonProps extends SharedEnhancedButtonProps { - backgroundColor?: string; - disabled?: boolean; - disabledColor?: string; - iconClassName?: string; - iconStyle?: React.CSSProperties; - mini?: boolean; - secondary?: boolean; - style?: React.CSSProperties; - } - export class FloatingActionButton extends React.Component { - } - - interface FontIconProps extends React.Props { - color?: string; - hoverColor?: string; - onMouseLeave?: React.MouseEventHandler; - onMouseEnter?: React.MouseEventHandler; - style?: React.CSSProperties; - className?: string; - } - export class FontIcon extends React.Component { - } - - interface IconButtonProps extends SharedEnhancedButtonProps { - iconClassName?: string; - iconStyle?: React.CSSProperties; - style?: React.CSSProperties; - tooltip?: string; - tooltipPosition?: string; - tooltipStyles?: React.CSSProperties; - touch?: boolean; - - onBlur?: React.FocusEventHandler; - onFocus?: React.FocusEventHandler; - } - export class IconButton extends React.Component { - } - - interface LeftNavProps extends React.Props { - disableSwipeToOpen?: boolean; - docked?: boolean; - header?: React.ReactElement; - menuItems: Menu.MenuItemRequest[]; - onChange?: Menu.ItemTapEventHandler; - onNavOpen?: () => void; - onNavClose?: () => void; - openRight?: Boolean; - selectedIndex?: number; - menuItemClassName?: string; - menuItemClassNameSubheader?: string; - menuItemClassNameLink?: string; - style?: React.CSSProperties; - } - export class LeftNav extends React.Component { - } - - interface LinearProgressProps extends React.Props { - mode?: string; - value?: number; - min?: number; - max?: number; - } - export class LinearProgress extends React.Component { - } - - namespace Lists { - interface ListProps extends React.Props { - insetSubheader?: boolean; - subheader?: string; - subheaderStyle?: React.CSSProperties; - zDepth?: number; - style?: React.CSSProperties; - } - export class List extends React.Component { - } - - interface ListDividerProps extends React.Props { - inset?: boolean; - } - export class ListDivider extends React.Component { - } - - interface ListItemProps extends React.Props { - autoGenerateNestedIndicator?: boolean; - disableKeyboardFocus?: boolean; - initiallyOpen?: boolean; - innerDivStyle?: React.CSSProperties; - insetChildren?: boolean; - innerStyle?: React.CSSProperties; - leftAvatar?: React.ReactElement; - leftCheckbox?: React.ReactElement; - leftIcon?: React.ReactElement; - nestedLevel?: number; - nestedItems?: React.ReactElement[]; - onKeyboardFocus?: React.FocusEventHandler; - onNestedListToggle?: (item: ListItem) => void; - onClick?: React.MouseEventHandler; - rightAvatar?: React.ReactElement; - rightIcon?: React.ReactElement; - rightIconButton?: React.ReactElement; - rightToggle?: React.ReactElement; - primaryText?: React.ReactNode; - secondaryText?: React.ReactNode; - secondaryTextLines?: number; - style?: React.CSSProperties; - } - export class ListItem extends React.Component { - } - } - - // Old menu implementation. Being replaced by new "menus". - namespace Menu { - interface ItemTapEventHandler { - (e: TouchTapEvent, index: number, menuItem: MenuItemRequest): void; - } - - // almost extends MenuItemProps, but certain required items are generated in Menu and not passed here. - interface MenuItemRequest extends React.Props { - // use value from MenuItem.Types.* - type?: string; - - text?: string; - data?: string; - payload?: string; - icon?: React.ReactElement; - attribute?: string; - number?: string; - toggle?: boolean; - onTouchTap?: TouchTapEventHandler; - isDisabled?: boolean; - style?: React.CSSProperties; - - // for MenuItems.Types.NESTED - items?: MenuItemRequest[]; - - // for custom text or payloads - [propertyName: string]: any; - } - - interface MenuProps extends React.Props { - index: number; - text?: string; - menuItems: MenuItemRequest[]; - zDepth?: number; - active?: boolean; - onItemTap?: ItemTapEventHandler; - menuItemStyle?: React.CSSProperties; - style?: React.CSSProperties; - } - export class Menu extends React.Component { - } - - interface MenuItemProps extends React.Props { - index: number; - icon?: React.ReactElement; - iconClassName?: string; - iconRightClassName?: string; - iconStyle?: React.CSSProperties; - iconRightStyle?: React.CSSProperties; - attribute?: string; - number?: string; - data?: string; - toggle?: boolean; - onTouchTap?: (e: React.MouseEvent, key: number) => void; - onToggle?: (e: React.MouseEvent, key: number, toggled: boolean) => void; - selected?: boolean; - active?: boolean; - style?: React.CSSProperties; - } - export class MenuItem extends React.Component { - static Types: { LINK: string, SUBHEADER: string, NESTED: string, } - } - } - - export namespace Mixins { - interface ClickAwayable extends React.Mixin { - } - var ClickAwayable: ClickAwayable; - - interface WindowListenable extends React.Mixin { - } - var WindowListenable: WindowListenable; - - interface StylePropable extends React.Mixin { - } - var StylePropable: StylePropable - - interface StyleResizable extends React.Mixin { - } - var StyleResizable: StyleResizable - } - - interface OverlayProps extends React.Props { - autoLockScrolling?: boolean; - show?: boolean; - transitionEnabled?: boolean; - } - export class Overlay extends React.Component { - } - - interface PaperProps extends React.HTMLAttributes, React.Props { - circle?: boolean; - rounded?: boolean; - transitionEnabled?: boolean; - zDepth?: number; - } - export class Paper extends React.Component { - } - - interface RadioButtonProps extends CommonEnhancedSwitchProps { - // is root element - defaultChecked?: boolean; - iconStyle?: React.CSSProperties; - label?: string; - labelStyle?: React.CSSProperties; - labelPosition?: string; - style?: React.CSSProperties; - value?: string; - - onCheck?: (e: React.FormEvent, selected: string) => void; - } - export class RadioButton extends React.Component { - } - - interface RadioButtonGroupProps extends React.Props { - defaultSelected?: string; - labelPosition?: string; - name: string; - style?: React.CSSProperties; - valueSelected?: string; - - onChange?: (e: React.FormEvent, selected: string) => void; - } - export class RadioButtonGroup extends React.Component { - getSelectedValue(): string; - setSelectedValue(newSelectionValue: string): void; - clearValue(): void; - } - - interface RaisedButtonProps extends SharedEnhancedButtonProps { - className?: string; - disabled?: boolean; - label?: string; - primary?: boolean; - secondary?: boolean; - labelStyle?: React.CSSProperties; - backgroundColor?: string; - labelColor?: string; - disabledBackgroundColor?: string; - disabledLabelColor?: string; - fullWidth?: boolean; - } - export class RaisedButton extends React.Component { - } - - interface RefreshIndicatorProps extends React.Props { - left: number; - percentage?: number; - size?: number; - status?: string; - top: number; - style?: React.CSSProperties; - } - export class RefreshIndicator extends React.Component { - } - - namespace Ripples { - interface CircleRippleProps extends React.Props { - color?: string; - opacity?: number; - style?: React.CSSProperties; - } - export class CircleRipple extends React.Component { - } - - interface FocusRippleProps extends React.Props { - color?: string; - style?: React.CSSProperties; - innerStyle?: React.CSSProperties; - opacity?: number; - show?: boolean; - } - export class FocusRipple extends React.Component { - } - - interface TouchRippleProps extends React.Props { - centerRipple?: boolean; - color?: string; - opacity?: number; - style?: React.CSSProperties; - } - export class TouchRipple extends React.Component { - } - } - - interface SelectFieldProps extends React.Props { - // passed to TextField - errorStyle?: React.CSSProperties; - errorText?: string; - floatingLabelText?: string; - floatingLabelStyle?: React.CSSProperties; - fullWidth?: boolean; - hintText?: string | React.ReactElement; - - // passed to DropDownMenu - displayMember?: string; - valueMember?: string; - autoWidth?: boolean; - menuItems: Menu.MenuItemRequest[]; - menuItemStyle?: React.CSSProperties; - selectedIndex?: number; - underlineStyle?: React.CSSProperties; - underlineFocusStyle?: React.CSSProperties; - iconStyle?: React.CSSProperties; - labelStyle?: React.CSSProperties; - style?: React.CSSProperties; - disabled?: boolean; - valueLink?: ReactLink; - value?: number; - - onChange?: Menu.ItemTapEventHandler; - onEnterKeyDown?: React.KeyboardEventHandler; - - // own properties - selectFieldRoot?: string; - multiLine?: boolean; - type?: string; - rows?: number; - inputStyle?: React.CSSProperties; - } - export class SelectField extends React.Component { - } - - interface SliderProps extends React.Props { - name: string; - defaultValue?: number; - description?: string; - error?: string; - max?: number; - min?: number; - required?: boolean; - step?: number; - value?: number; - style?: React.CSSProperties; - } - export class Slider extends React.Component { - } - - interface SvgIconProps extends React.Props { - color?: string; - hoverColor?: string; - viewBox?: string; - style?: React.CSSProperties; - } - export class SvgIcon extends React.Component { - } - - export namespace Icons { - export import NavigationMenu = __MaterialUI.NavigationMenu; - export import NavigationChevronLeft = __MaterialUI.NavigationChevronLeft; - export import NavigationChevronRight = __MaterialUI.NavigationChevronRight; - } - - interface NavigationMenuProps extends React.Props { - } - export class NavigationMenu extends React.Component { - } - - interface NavigationChevronLeftProps extends React.Props { - } - export class NavigationChevronLeft extends React.Component { - } - - interface NavigationChevronRightProps extends React.Props { - } - export class NavigationChevronRight extends React.Component { - } - - export namespace Styles { - interface AutoPrefix { - all(styles: React.CSSProperties): React.CSSProperties; - set(style: React.CSSProperties, key: string, value: string | number): void; - single(key: string): string; - singleHyphened(key: string): string; - } - export var AutoPrefix: AutoPrefix; - - interface Spacing { - iconSize?: number; - - desktopGutter?: number; - desktopGutterMore?: number; - desktopGutterLess?: number; - desktopGutterMini?: number; - desktopKeylineIncrement?: number; - desktopDropDownMenuItemHeight?: number; - desktopDropDownMenuFontSize?: number; - desktopLeftNavMenuItemHeight?: number; - desktopSubheaderHeight?: number; - desktopToolbarHeight?: number; - } - export var Spacing: Spacing; - - interface ThemePalette { - primary1Color?: string; - primary2Color?: string; - primary3Color?: string; - accent1Color?: string; - accent2Color?: string; - accent3Color?: string; - textColor?: string; - canvasColor?: string; - borderColor?: string; - disabledColor?: string; - alternateTextColor?: string; - } - interface MuiTheme { - rawTheme: RawTheme; - static: boolean; - appBar?: { - color?: string, - textColor?: string, - height?: number - }, - avatar?: { - borderColor?: string; - } - button?: { - height?: number, - minWidth?: number, - iconButtonSize?: number - }, - checkbox?: { - boxColor?: string, - checkedColor?: string, - requiredColor?: string, - disabledColor?: string, - labelColor?: string, - labelDisabledColor?: string - }, - datePicker?: { - color?: string, - textColor?: string, - calendarTextColor?: string, - selectColor?: string, - selectTextColor?: string, - }, - dropDownMenu?: { - accentColor?: string, - }, - flatButton?: { - color?: string, - textColor?: string, - primaryTextColor?: string, - secondaryTextColor?: string, - disabledColor?: string - }, - floatingActionButton?: { - buttonSize?: number, - miniSize?: number, - color?: string, - iconColor?: string, - secondaryColor?: string, - secondaryIconColor?: string, - disabledColor?: string, - disabledTextColor?: string - }, - inkBar?: { - backgroundColor?: string; - }, - leftNav?: { - width?: number, - color?: string, - }, - listItem?: { - nestedLevelDepth?: number; - }, - menu?: { - backgroundColor?: string, - containerBackgroundColor?: string, - }, - menuItem?: { - dataHeight?: number, - height?: number, - hoverColor?: string, - padding?: number, - selectedTextColor?: string, - }, - menuSubheader?: { - padding?: number, - borderColor?: string, - textColor?: string, - }, - paper?: { - backgroundColor?: string, - }, - radioButton?: { - borderColor?: string, - backgroundColor?: string, - checkedColor?: string, - requiredColor?: string, - disabledColor?: string, - size?: number, - labelColor?: string, - labelDisabledColor?: string - }, - raisedButton?: { - color?: string, - textColor?: string, - primaryColor?: string, - primaryTextColor?: string, - secondaryColor?: string, - secondaryTextColor?: string, - disabledColor?: string, - disabledTextColor?: string - }, - refreshIndicator?: { - strokeColor?: string; - loadingStrokeColor?: string; - }; - slider?: { - trackSize?: number, - trackColor?: string, - trackColorSelected?: string, - handleSize?: number, - handleSizeActive?: number, - handleSizeDisabled?: number, - handleColorZero?: string, - handleFillColor?: string, - selectionColor?: string, - rippleColor?: string, - }, - snackbar?: { - textColor?: string, - backgroundColor?: string, - actionColor?: string, - }, - table?: { - backgroundColor?: string; - }; - tableHeader?: { - borderColor?: string; - }; - tableHeaderColumn?: { - textColor?: string; - }; - tableFooter?: { - borderColor?: string; - textColor?: string; - }; - tableRow?: { - hoverColor?: string; - stripeColor?: string; - selectedColor?: string; - textColor?: string; - borderColor?: string; - }; - tableRowColumn?: { - height?: number; - spacing?: number; - }; - timePicker?: { - color?: string; - textColor?: string; - accentColor?: string; - clockColor?: string; - selectColor?: string; - selectTextColor?: string; - }; - toggle?: { - thumbOnColor?: string, - thumbOffColor?: string, - thumbDisabledColor?: string, - thumbRequiredColor?: string, - trackOnColor?: string, - trackOffColor?: string, - trackDisabledColor?: string, - trackRequiredColor?: string, - labelColor?: string, - labelDisabledColor?: string - }, - toolbar?: { - backgroundColor?: string, - height?: number, - titleFontSize?: number, - iconColor?: string, - separatorColor?: string, - menuHoverColor?: string, - }; - tabs?: { - backgroundColor?: string; - }; - textField?: { - textColor?: string; - hintColor?: string; - floatingLabelColor?: string; - disabledTextColor?: string; - errorColor?: string; - focusColor?: string; - backgroundColor?: string; - borderColor?: string; - }; - isRtl: boolean; - } - - interface RawTheme { - spacing: Spacing; - fontFamily?: string; - palette: ThemePalette; - } - - export function ThemeDecorator(muiTheme: Styles.MuiTheme):

(Component: React.ComponentClass

) => React.ComponentClass

; - - interface ThemeManager { - getMuiTheme(rawTheme: RawTheme): MuiTheme; - modifyRawThemeSpacing(muiTheme: MuiTheme, newSpacing: Spacing): MuiTheme; - modifyRawThemePalette(muiTheme: MuiTheme, newPaletteKeys: ThemePalette): MuiTheme; - modifyRawThemeFontFamily(muiTheme: MuiTheme, newFontFamily: string): MuiTheme; - } - export var ThemeManager: ThemeManager; - - interface Transitions { - easeOut(duration?: string, property?: string | string[], delay?: string, easeFunction?: string): string; - create(duration?: string, property?: string, delay?: string, easeFunction?: string): string; - easeOutFunction: string; - easeInOutFunction: string; - } - export var Transitions: Transitions; - - interface Typography { - textFullBlack: string; - textDarkBlack: string; - textLightBlack: string; - textMinBlack: string; - textFullWhite: string; - textDarkWhite: string; - textLightWhite: string; - - // font weight - fontWeightLight: number; - fontWeightNormal: number; - fontWeightMedium: number; - - fontStyleButtonFontSize: number; - } - export var Typography: Typography; - - export var DarkRawTheme: RawTheme; - export var LightRawTheme: RawTheme; - } - - interface SnackbarProps extends React.Props { - message: string; - action?: string; - autoHideDuration?: number; - onActionTouchTap?: React.TouchEventHandler; - onShow?: () => void; - onDismiss?: () => void; - openOnMount?: boolean; - style?: React.CSSProperties; - } - export class Snackbar extends React.Component { - } - - namespace Tabs { - interface TabProps extends React.Props { - label?: any; - value?: string; - selected?: boolean; - width?: string; - style?: React.CSSProperties; - - // Called by Tabs component - onActive?: (tab: Tab) => void; - - onTouchTap?: (value: string, e: TouchTapEvent, tab: Tab) => void; - } - export class Tab extends React.Component { - } - - interface TabsProps extends React.Props { - contentContainerStyle?: React.CSSProperties; - initialSelectedIndex?: number; - inkBarStyle?: React.CSSProperties; - style?: React.CSSProperties; - tabItemContainerStyle?: React.CSSProperties; - tabWidth?: number; - value?: string | number; - tabTemplate?: __React.ComponentClass; - - onChange?: (value: string | number, e: React.FormEvent, tab: Tab) => void; - } - export class Tabs extends React.Component { - } - } - - namespace Table { - interface TableProps extends React.Props

{ - allRowsSelected?: boolean; - fixedFooter?: boolean; - fixedHeader?: boolean; - height?: string; - multiSelectable?: boolean; - onCellClick?: (row: number, column: number) => void; - onCellHover?: (row: number, column: number) => void; - onCellHoverExit?: (row: number, column: number) => void; - onRowHover?: (row: number) => void; - onRowHoverExit?: (row: number) => void; - onRowSelection?: (selectedRows: number[]) => void; - selectable?: boolean; - style?: React.CSSProperties; - } - export class Table extends React.Component { - } - - interface TableBodyProps extends React.Props { - allRowsSelected?: boolean; - deselectOnClickaway?: boolean; - displayRowCheckbox?: boolean; - multiSelectable?: boolean; - onCellClick?: (row: number, column: number) => void; - onCellHover?: (row: number, column: number) => void; - onCellHoverExit?: (row: number, column: number) => void; - onRowHover?: (row: number) => void; - onRowHoverExit?: (row: number) => void; - onRowSelection?: (selectedRows: number[]) => void; - preScanRows?: boolean; - selectable?: boolean; - showRowHover?: boolean; - stripedRows?: boolean; - style?: React.CSSProperties; - } - export class TableBody extends React.Component { - } - - interface TableFooterProps extends React.Props { - adjustForCheckbox?: boolean; - style?: React.CSSProperties; - } - export class TableFooter extends React.Component { - } - - interface TableHeaderProps extends React.Props { - adjustForCheckbox?: boolean; - displaySelectAll?: boolean; - enableSelectAll?: boolean; - onSelectAll?: (event: React.MouseEvent) => void; - selectAllSelected?: boolean; - style?: React.CSSProperties; - } - export class TableHeader extends React.Component { - } - - interface TableHeaderColumnProps extends React.Props { - columnNumber?: number; - onClick?: (e: React.MouseEvent, column: number) => void; - tooltip?: string; - tooltipStyle?: React.CSSProperties; - style?: React.CSSProperties; - } - export class TableHeaderColumn extends React.Component { - } - - interface TableRowProps extends React.Props { - displayBorder?: boolean; - hoverable?: boolean; - onCellClick?: (e: React.MouseEvent, row: number, column: number) => void; - onCellHover?: (e: React.MouseEvent, row: number, column: number) => void; - onCellHoverExit?: (e: React.MouseEvent, row: number, column: number) => void; - onRowClick?: (e: React.MouseEvent, row: number) => void; - onRowHover?: (e: React.MouseEvent, row: number) => void; - onRowHoverExit?: (e: React.MouseEvent, row: number) => void; - rowNumber?: number; - selectable?: boolean; - selected?: boolean; - striped?: boolean; - style?: React.CSSProperties; - } - export class TableRow extends React.Component { - } - - interface TableRowColumnProps extends React.Props { - columnNumber?: number; - colSpan?: number; - hoverable?: boolean; - onClick?: React.MouseEventHandler; - onHover?: (e: React.MouseEvent, column: number) => void; - onHoverExit?: (e: React.MouseEvent, column: number) => void; - style?: React.CSSProperties; - } - export class TableRowColumn extends React.Component { - } - } - - interface ThemeWrapperProps extends React.Props { - theme: Styles.MuiTheme; - } - export class ThemeWrapper extends React.Component { - } - - interface ToggleProps extends CommonEnhancedSwitchProps { - // is root element - - elementStyle?: React.CSSProperties; - labelStyle?: React.CSSProperties; - onToggle?: (e: React.MouseEvent, isInputChecked: boolean) => void; - toggled?: boolean; - defaultToggled?: boolean; - } - export class Toggle extends React.Component { - isToggled(): boolean; - setToggled(newToggledValue: boolean): void; - } - - interface TimePickerProps extends React.Props { - defaultTime?: Date; - format?: string; - pedantic?: boolean; - style?: __React.CSSProperties; - textFieldStyle?: __React.CSSProperties; - autoOk?: boolean; - openDialog?: () => void; - onFocus?: React.FocusEventHandler; - onTouchTap?: TouchTapEventHandler; - onChange?: (e: any, time: Date) => void; - onShow?: () => void; - onDismiss?: () => void; - } - export class TimePicker extends React.Component { - } - - interface TextFieldProps extends React.Props { - errorStyle?: React.CSSProperties; - errorText?: string; - floatingLabelText?: string; - floatingLabelStyle?: React.CSSProperties; - fullWidth?: boolean; - hintText?: string | React.ReactElement; - id?: string; - inputStyle?: React.CSSProperties; - multiLine?: boolean; - onEnterKeyDown?: React.KeyboardEventHandler; - style?: React.CSSProperties; - rows?: number, - underlineStyle?: React.CSSProperties; - underlineFocusStyle?: React.CSSProperties; - underlineDisabledStyle?: React.CSSProperties; - type?: string; - hintStyle?: React.CSSProperties; - - disabled?: boolean; - isRtl?: boolean; - value?: string; - defaultValue?: string; - valueLink?: ReactLink; - - onBlur?: React.FocusEventHandler; - onChange?: React.FormEventHandler; - onFocus?: React.FocusEventHandler; - onKeyDown?: React.KeyboardEventHandler; - } - export class TextField extends React.Component { - blur(): void; - clearValue(): void; - focus(): void; - getValue(): string; - setErrorText(newErrorText: string): void; - setValue(newValue: string): void; - } - - namespace Toolbar { - interface ToolbarProps extends React.Props { - style?: React.CSSProperties; - } - export class Toolbar extends React.Component { - } - - interface ToolbarGroupProps extends React.Props { - float?: string; - style?: React.CSSProperties; - } - export class ToolbarGroup extends React.Component { - } - - interface ToolbarSeparatorProps extends React.Props { - style?: React.CSSProperties; - } - export class ToolbarSeparator extends React.Component { - } - - interface ToolbarTitleProps extends React.HTMLAttributes, React.Props { - text?: string; - style?: React.CSSProperties; - } - export class ToolbarTitle extends React.Component { - } - } - - interface TooltipProps extends React.Props { - label: string; - show?: boolean; - touch?: boolean; - verticalPosition?: string; - horizontalPosition?: string; - } - export class Tooltip extends React.Component { - } - - export namespace Utils { - interface ContrastLevel { - range: [number, number]; - color: string; - } - interface ColorManipulator { - fade(color: string, amount: string | number): string; - lighten(color: string, amount: string | number): string; - darken(color: string, amount: string | number): string; - contrastRatio(background: string, foreground: string): number; - contrastRatioLevel(background: string, foreground: string): ContrastLevel; - } - export var ColorManipulator: ColorManipulator; - - interface CssEvent { - transitionEndEventName(): string; - animationEndEventName(): string; - onTransitionEnd(el: Element, callback: () => void): void; - onAnimationEnd(el: Element, callback: () => void): void; - } - export var CssEvent: CssEvent; - - interface Dom { - isDescendant(parent: Node, child: Node): boolean; - offset(el: Element): { top: number, left: number }; - getStyleAttributeAsNumber(el: HTMLElement, attr: string): number; - addClass(el: Element, className: string): void; - removeClass(el: Element, className: string): void; - hasClass(el: Element, className: string): boolean; - toggleClass(el: Element, className: string): void; - forceRedraw(el: HTMLElement): void; - withoutTransition(el: HTMLElement, callback: () => void): void; - } - export var Dom: Dom; - - interface Events { - once(el: Element, type: string, callback: EventListener): void; - on(el: Element, type: string, callback: EventListener): void; - off(el: Element, type: string, callback: EventListener): void; - isKeyboard(e: Event): boolean; - } - export var Events: Events; - - function Extend(base: T, override: S1): (T & S1); - - interface ImmutabilityHelper { - merge(base: any, ...args: any[]): any; - mergeItem(obj: any, key: any, newValueObject: any): any; - push(array: any[], obj: any): any[]; - shift(array: any[]): any[]; - } - export var ImmutabilityHelper: ImmutabilityHelper; - - interface KeyCode { - DOWN: number; - ESC: number; - ENTER: number; - LEFT: number; - RIGHT: number; - SPACE: number; - TAB: number; - UP: number; - } - var KeyCode: KeyCode; - - interface KeyLine { - Desktop: { - GUTTER: number; - GUTTER_LESS: number; - INCREMENT: number; - MENU_ITEM_HEIGHT: number; - }; - - getIncrementalDim(dim: number): number; - } - export var KeyLine: KeyLine; - - interface UniqueId { - generate(): string; - } - export var UniqueId: UniqueId; - - interface Styles { - mergeAndPrefix(base: any, ...args: any[]): React.CSSProperties; - } - export var Styles: Styles; - } - - // New menus available only through requiring directly to the end file - namespace Menus { - interface IconMenuProps extends React.Props { - closeOnItemTouchTap?: boolean; - desktop?: boolean; - iconButtonElement: React.ReactElement; - openDirection?: string; - menuStyle?: React.CSSProperties; - multiple?: boolean; - value?: string | Array; - width?: string | number; - touchTapCloseDelay?: number; - style?: React.CSSProperties; - - onKeyboardFocus?: React.FocusEventHandler; - onItemTouchTap?: (e: TouchTapEvent, item: React.ReactElement) => void; - onChange?: (e: React.FormEvent, value: string | Array) => void; - } - export class IconMenu extends React.Component { - } - - interface MenuProps extends React.Props { - animated?: boolean; - autoWidth?: boolean; - desktop?: boolean; - listStyle?: React.CSSProperties; - maxHeight?: number; - multiple?: boolean; - openDirection?: string; - value?: string | Array; - width?: string | number; - zDepth?: number; - style?: React.CSSProperties; - } - export class Menu extends React.Component{ - } - - interface MenuItemProps extends React.Props { - checked?: boolean; - desktop?: boolean; - disabled?: boolean; - innerDivStyle?: React.CSSProperties; - insetChildren?: boolean; - leftIcon?: React.ReactElement; - primaryText?: string | React.ReactElement; - rightIcon?: React.ReactElement; - secondaryText?: React.ReactNode; - value?: string; - style?: React.CSSProperties; - - onEscKeyDown?: React.KeyboardEventHandler; - onItemTouchTap?: (e: TouchTapEvent, item: React.ReactElement) => void; - onChange?: (e: React.FormEvent, value: string) => void; - } - export class MenuItem extends React.Component{ - } - - interface MenuDividerProps extends React.Props { - inset?: boolean; - style?: React.CSSProperties; - } - export class MenuDivider extends React.Component{ - } - } - - namespace GridList { - - interface GridListProps extends React.Props { - cols?: number; - padding?: number; - cellHeight?: number; - style?: React.CSSProperties; - } - - export class GridList extends React.Component{ - } - - interface GridTileProps extends React.Props { - title?: string; - subtitle?: __React.ReactNode; - titlePosition?: string; //"top"|"bottom" - titleBackground?: string; - actionIcon?: __React.ReactElement; - actionPosition?: string; //"left"|"right" - cols?: number; - rows?: number; - rootClass?: string | __React.Component; - style?: React.CSSProperties; - } - - export class GridTile extends React.Component{ - } - - } -} // __MaterialUI - -declare module 'material-ui/lib/app-bar' { - import AppBar = __MaterialUI.AppBar; - export = AppBar; -} - -declare module 'material-ui/lib/app-canvas' { - import AppCanvas = __MaterialUI.AppCanvas; - export = AppCanvas; -} - -declare module 'material-ui/lib/avatar' { - import Avatar = __MaterialUI.Avatar; - export = Avatar; -} - -declare module "material-ui/lib/badge" { - import Badge = __MaterialUI.Badge; - export = Badge; -} - -declare module 'material-ui/lib/before-after-wrapper' { - import BeforeAfterWrapper = __MaterialUI.BeforeAfterWrapper; - export = BeforeAfterWrapper; -} - -declare module 'material-ui/lib/card/card' { - import Card = __MaterialUI.Card.Card; - export = Card; -} - -declare module 'material-ui/lib/card/card-actions' { - import CardActions = __MaterialUI.Card.CardActions; - export = CardActions; -} - -declare module 'material-ui/lib/card/card-expandable' { - import CardExpandable = __MaterialUI.Card.CardExpandable; - export = CardExpandable; -} - -declare module 'material-ui/lib/card/card-header' { - import CardHeader = __MaterialUI.Card.CardHeader; - export = CardHeader; -} - -declare module 'material-ui/lib/card/card-media' { - import CardMedia = __MaterialUI.Card.CardMedia; - export = CardMedia; -} - -declare module 'material-ui/lib/card/card-text' { - import CardText = __MaterialUI.Card.CardText; - export = CardText; -} - -declare module 'material-ui/lib/card/card-title' { - import CardTitle = __MaterialUI.Card.CardTitle; - export = CardTitle; -} - -declare module 'material-ui/lib/checkbox' { - import Checkbox = __MaterialUI.Checkbox; - export = Checkbox; -} - -declare module 'material-ui/lib/circular-progress' { - import CircularProgress = __MaterialUI.CircularProgress; - export = CircularProgress; -} - -declare module 'material-ui/lib/clearfix' { - import ClearFix = __MaterialUI.ClearFix; - export = ClearFix; -} - -declare module 'material-ui/lib/date-picker/date-picker' { - import DatePicker = __MaterialUI.DatePicker.DatePicker; - export = DatePicker; -} - -declare module 'material-ui/lib/date-picker/date-picker-dialog' { - import DatePickerDialog = __MaterialUI.DatePicker.DatePickerDialog; - export = DatePickerDialog; -} - -declare module 'material-ui/lib/dialog' { - import Dialog = __MaterialUI.Dialog; - export = Dialog; -} - -declare module 'material-ui/lib/drop-down-icon' { - import DropDownIcon = __MaterialUI.DropDownIcon; - export = DropDownIcon; -} - -declare module 'material-ui/lib/drop-down-menu' { - import DropDownMenu = __MaterialUI.DropDownMenu; - export = DropDownMenu; -} - -declare module 'material-ui/lib/enhanced-button' { - import EnhancedButton = __MaterialUI.EnhancedButton; - export = EnhancedButton; -} - -declare module 'material-ui/lib/flat-button' { - import FlatButton = __MaterialUI.FlatButton; - export = FlatButton; -} - -declare module 'material-ui/lib/floating-action-button' { - import FloatingActionButton = __MaterialUI.FloatingActionButton; - export = FloatingActionButton; -} - -declare module 'material-ui/lib/font-icon' { - import FontIcon = __MaterialUI.FontIcon; - export = FontIcon; -} - -declare module 'material-ui/lib/icon-button' { - import IconButton = __MaterialUI.IconButton; - export = IconButton; -} - -declare module 'material-ui/lib/left-nav' { - import LeftNav = __MaterialUI.LeftNav; - export = LeftNav; -} - -declare module 'material-ui/lib/linear-progress' { - import LinearProgress = __MaterialUI.LinearProgress; - export = LinearProgress; -} - -declare module 'material-ui/lib/lists/list' { - import List = __MaterialUI.Lists.List; - export = List; -} - -declare module 'material-ui/lib/lists/list-divider' { - import ListDivider = __MaterialUI.Lists.ListDivider; - export = ListDivider; -} - -declare module 'material-ui/lib/lists/list-item' { - import ListItem = __MaterialUI.Lists.ListItem; - export = ListItem; -} - -declare module 'material-ui/lib/menu/menu' { - import Menu = __MaterialUI.Menu.Menu; - export = Menu; -} - -declare module 'material-ui/lib/menu/menu-item' { - import MenuItem = __MaterialUI.Menu.MenuItem; - export = MenuItem; -} - -declare module 'material-ui/lib/mixins/' { - export import ClickAwayable = __MaterialUI.Mixins.ClickAwayable; // require('material-ui/lib/mixins/click-awayable'); - export import WindowListenable = __MaterialUI.Mixins.WindowListenable; // require('material-ui/lib/mixins/window-listenable'); - export import StylePropable = __MaterialUI.Mixins.StylePropable; // require('material-ui/lib/mixins/style-propable'); - export import StyleResizable = __MaterialUI.Mixins.StyleResizable; // require('material-ui/lib/mixins/style-resizable'); -} - -declare module 'material-ui/lib/mixins/click-awayable' { - import ClickAwayable = __MaterialUI.Mixins.ClickAwayable; - export = ClickAwayable; -} - -declare module 'material-ui/lib/mixins/window-listenable' { - import WindowListenable = __MaterialUI.Mixins.WindowListenable; - export = WindowListenable; -} - -declare module 'material-ui/lib/mixins/style-propable' { - import StylePropable = __MaterialUI.Mixins.StylePropable; - export = StylePropable; -} - -declare module 'material-ui/lib/mixins/style-resizable' { - import StyleResizable = __MaterialUI.Mixins.StyleResizable; - export = StyleResizable; -} - -declare module 'material-ui/lib/overlay' { - import Overlay = __MaterialUI.Overlay; - export = Overlay; -} - -declare module 'material-ui/lib/paper' { - import Paper = __MaterialUI.Paper; - export = Paper; -} - -declare module 'material-ui/lib/radio-button' { - import RadioButton = __MaterialUI.RadioButton; - export = RadioButton; -} - -declare module 'material-ui/lib/radio-button-group' { - import RadioButtonGroup = __MaterialUI.RadioButtonGroup; - export = RadioButtonGroup; -} - -declare module 'material-ui/lib/raised-button' { - import RaisedButton = __MaterialUI.RaisedButton; - export = RaisedButton; -} - -declare module 'material-ui/lib/refresh-indicator' { - import RefreshIndicator = __MaterialUI.RefreshIndicator; - export = RefreshIndicator; -} - -declare module 'material-ui/lib/ripples/' { - export import CircleRipple = __MaterialUI.Ripples.CircleRipple; - export import FocusRipple = __MaterialUI.Ripples.FocusRipple; - export import TouchRipple = __MaterialUI.Ripples.TouchRipple; -} - -declare module 'material-ui/lib/select-field' { - import SelectField = __MaterialUI.SelectField; - export = SelectField; -} - -declare module 'material-ui/lib/slider' { - import Slider = __MaterialUI.Slider; - export = Slider; -} - -declare module 'material-ui/lib/svg-icon' { - import SvgIcon = __MaterialUI.SvgIcon; - export = SvgIcon; -} - -declare module 'material-ui/lib/svg-icons/navigation/menu' { - import NavigationMenu = __MaterialUI.NavigationMenu; - export = NavigationMenu; -} - -declare module 'material-ui/lib/svg-icons/navigation/chevron-left' { - import NavigationChevronLeft = __MaterialUI.NavigationChevronLeft; - export = NavigationChevronLeft; -} - -declare module 'material-ui/lib/svg-icons/navigation/chevron-right' { - import NavigationChevronRight = __MaterialUI.NavigationChevronRight; - export = NavigationChevronRight; -} - -declare module 'material-ui/lib/styles/' { - export import AutoPrefix = __MaterialUI.Styles.AutoPrefix; // require('material-ui/lib/styles/auto-prefix'); - export import Colors = __MaterialUI.Styles.Colors; // require('material-ui/lib/styles/colors'); - export import Spacing = require('material-ui/lib/styles/spacing'); - export import ThemeManager = __MaterialUI.Styles.ThemeManager; // require('material-ui/lib/styles/theme-manager'); - export import Transitions = __MaterialUI.Styles.Transitions; // require('material-ui/lib/styles/transitions'); - export import Typography = __MaterialUI.Styles.Typography; // require('material-ui/lib/styles/typography'); - export import LightRawTheme = __MaterialUI.Styles.LightRawTheme; // require('material-ui/lib/styles/raw-themes/light-raw-theme'), - export import DarkRawTheme = __MaterialUI.Styles.DarkRawTheme; // require('material-ui/lib/styles/raw-themes/dark-raw-theme'), - export import ThemeDecorator = __MaterialUI.Styles.ThemeDecorator; //require('material-ui/lib/styles/theme-decorator'); -} - -declare module 'material-ui/lib/styles/auto-prefix' { - import AutoPrefix = __MaterialUI.Styles.AutoPrefix; - export = AutoPrefix; -} - -declare module 'material-ui/lib/styles/spacing' { - type Spacing = __MaterialUI.Styles.Spacing; - var Spacing: Spacing; - export = Spacing; -} - -declare module 'material-ui/lib/styles/theme-manager' { - import ThemeManager = __MaterialUI.Styles.ThemeManager; - export = ThemeManager; -} - -declare module 'material-ui/lib/styles/transitions' { - import Transitions = __MaterialUI.Styles.Transitions; - export = Transitions; -} - -declare module 'material-ui/lib/styles/typography' { - import Typography = __MaterialUI.Styles.Typography; - export = Typography; -} - -declare module 'material-ui/lib/styles/raw-themes/light-raw-theme' { - import LightRawTheme = __MaterialUI.Styles.LightRawTheme; - export = LightRawTheme; -} - -declare module 'material-ui/lib/styles/raw-themes/dark-raw-theme' { - import DarkRawTheme = __MaterialUI.Styles.DarkRawTheme; - export = DarkRawTheme; -} - -declare module 'material-ui/lib/styles/theme-decorator' { - import ThemeDecorator = __MaterialUI.Styles.ThemeDecorator; - export = ThemeDecorator; -} - - -declare module 'material-ui/lib/snackbar' { - import Snackbar = __MaterialUI.Snackbar; - export = Snackbar; -} - -declare module 'material-ui/lib/tabs/tab' { - import Tab = __MaterialUI.Tabs.Tab; - export = Tab; -} - -declare module 'material-ui/lib/tabs/tabs' { - import Tabs = __MaterialUI.Tabs.Tabs; - export = Tabs; -} - -declare module 'material-ui/lib/table/table' { - import Table = __MaterialUI.Table.Table; - export = Table; -} - -declare module 'material-ui/lib/table/table-body' { - import TableBody = __MaterialUI.Table.TableBody; - export = TableBody; -} - -declare module 'material-ui/lib/table/table-footer' { - import TableFooter = __MaterialUI.Table.TableFooter; - export = TableFooter; -} - -declare module 'material-ui/lib/table/table-header' { - import TableHeader = __MaterialUI.Table.TableHeader; - export = TableHeader; -} - -declare module 'material-ui/lib/table/table-header-column' { - import TableHeaderColumn = __MaterialUI.Table.TableHeaderColumn; - export = TableHeaderColumn; -} - -declare module 'material-ui/lib/table/table-row' { - import TableRow = __MaterialUI.Table.TableRow; - export = TableRow; -} - -declare module 'material-ui/lib/table/table-row-column' { - import TableRowColumn = __MaterialUI.Table.TableRowColumn; - export = TableRowColumn; -} - -declare module 'material-ui/lib/theme-wrapper' { - import ThemeWrapper = __MaterialUI.ThemeWrapper; - export = ThemeWrapper; -} - -declare module 'material-ui/lib/toggle' { - import Toggle = __MaterialUI.Toggle; - export = Toggle; -} - -declare module 'material-ui/lib/time-picker' { - import TimePicker = __MaterialUI.TimePicker; - export = TimePicker; -} - -declare module 'material-ui/lib/text-field' { - import TextField = __MaterialUI.TextField; - export = TextField; -} - -declare module 'material-ui/lib/toolbar/toolbar' { - import Toolbar = __MaterialUI.Toolbar.Toolbar; - export = Toolbar; -} - -declare module 'material-ui/lib/toolbar/toolbar-group' { - import ToolbarGroup = __MaterialUI.Toolbar.ToolbarGroup; - export = ToolbarGroup; -} - -declare module 'material-ui/lib/toolbar/toolbar-separator' { - import ToolbarSeparator = __MaterialUI.Toolbar.ToolbarSeparator; - export = ToolbarSeparator; -} - -declare module 'material-ui/lib/toolbar/toolbar-title' { - import ToolbarTitle = __MaterialUI.Toolbar.ToolbarTitle; - export = ToolbarTitle; -} - -declare module 'material-ui/lib/tooltip' { - import Tooltip = __MaterialUI.Tooltip; - export = Tooltip; -} - -declare module 'material-ui/lib/utils/' { - export import ColorManipulator = __MaterialUI.Utils.ColorManipulator; // require('material-ui/lib/utils/color-manipulator'); - export import CssEvent = __MaterialUI.Utils.CssEvent; // require('material-ui/lib/utils/css-event'); - export import Dom = __MaterialUI.Utils.Dom; // require('material-ui/lib/utils/dom'); - export import Events = __MaterialUI.Utils.Events; // require('material-ui/lib/utils/events'); - export import Extend = __MaterialUI.Utils.Extend; // require('material-ui/lib/utils/extend'); - export import ImmutabilityHelper = __MaterialUI.Utils.ImmutabilityHelper; // require('material-ui/lib/utils/immutability-helper'); - export import KeyCode = __MaterialUI.Utils.KeyCode; // require('material-ui/lib/utils/key-code'); - export import KeyLine = __MaterialUI.Utils.KeyLine; // require('material-ui/lib/utils/key-line'); - export import UniqueId = __MaterialUI.Utils.UniqueId; // require('material-ui/lib/utils/unique-id'); - export import Styles = __MaterialUI.Utils.Styles; // require('material-ui/lib/utils/styles'); -} - -declare module 'material-ui/lib/utils/color-manipulator' { - import ColorManipulator = __MaterialUI.Utils.ColorManipulator; - export = ColorManipulator; -} - -declare module 'material-ui/lib/utils/css-event' { - import CssEvent = __MaterialUI.Utils.CssEvent; - export = CssEvent; -} - -declare module 'material-ui/lib/utils/dom' { - import Dom = __MaterialUI.Utils.Dom; - export = Dom; -} - -declare module 'material-ui/lib/utils/events' { - import Events = __MaterialUI.Utils.Events; - export = Events; -} - -declare module 'material-ui/lib/utils/extend' { - import Extend = __MaterialUI.Utils.Extend; - export = Extend; -} - -declare module 'material-ui/lib/utils/immutability-helper' { - import ImmutabilityHelper = __MaterialUI.Utils.ImmutabilityHelper; - export = ImmutabilityHelper; -} - -declare module 'material-ui/lib/utils/key-code' { - import KeyCode = __MaterialUI.Utils.KeyCode; - export = KeyCode; -} - -declare module 'material-ui/lib/utils/key-line' { - import KeyLine = __MaterialUI.Utils.KeyLine; - export = KeyLine; -} - -declare module 'material-ui/lib/utils/unique-id' { - import UniqueId = __MaterialUI.Utils.UniqueId; - export = UniqueId; -} - -declare module 'material-ui/lib/utils/styles' { - import Styles = __MaterialUI.Utils.Styles; - export = Styles; -} - -declare module "material-ui/lib/menus/icon-menu" { - import IconMenu = __MaterialUI.Menus.IconMenu; - export = IconMenu; -} - -declare module "material-ui/lib/menus/menu" { - import Menu = __MaterialUI.Menus.Menu; - export = Menu; -} - -declare module "material-ui/lib/menus/menu-item" { - import MenuItem = __MaterialUI.Menus.MenuItem; - export = MenuItem; -} - -declare module "material-ui/lib/menus/menu-divider" { - import MenuDivider = __MaterialUI.Menus.MenuDivider; - export = MenuDivider; -} - -declare module "material-ui/lib/grid-list/grid-list" { - import GridList = __MaterialUI.GridList.GridList; - export = GridList; -} - -declare module "material-ui/lib/grid-list/grid-tile" { - import GridTile = __MaterialUI.GridList.GridTile; - export = GridTile; -} - -declare module "material-ui/lib/styles/colors" { - import Colors = __MaterialUI.Styles.Colors; - export = Colors; -} - -declare namespace __MaterialUI.Styles { - interface Colors { - red50: string; - red100: string; - red200: string; - red300: string; - red400: string; - red500: string; - red600: string; - red700: string; - red800: string; - red900: string; - redA100: string; - redA200: string; - redA400: string; - redA700: string; - - pink50: string; - pink100: string; - pink200: string; - pink300: string; - pink400: string; - pink500: string; - pink600: string; - pink700: string; - pink800: string; - pink900: string; - pinkA100: string; - pinkA200: string; - pinkA400: string; - pinkA700: string; - - purple50: string; - purple100: string; - purple200: string; - purple300: string; - purple400: string; - purple500: string; - purple600: string; - purple700: string; - purple800: string; - purple900: string; - purpleA100: string; - purpleA200: string; - purpleA400: string; - purpleA700: string; - - deepPurple50: string; - deepPurple100: string; - deepPurple200: string; - deepPurple300: string; - deepPurple400: string; - deepPurple500: string; - deepPurple600: string; - deepPurple700: string; - deepPurple800: string; - deepPurple900: string; - deepPurpleA100: string; - deepPurpleA200: string; - deepPurpleA400: string; - deepPurpleA700: string; - - indigo50: string; - indigo100: string; - indigo200: string; - indigo300: string; - indigo400: string; - indigo500: string; - indigo600: string; - indigo700: string; - indigo800: string; - indigo900: string; - indigoA100: string; - indigoA200: string; - indigoA400: string; - indigoA700: string; - - blue50: string; - blue100: string; - blue200: string; - blue300: string; - blue400: string; - blue500: string; - blue600: string; - blue700: string; - blue800: string; - blue900: string; - blueA100: string; - blueA200: string; - blueA400: string; - blueA700: string; - - lightBlue50: string; - lightBlue100: string; - lightBlue200: string; - lightBlue300: string; - lightBlue400: string; - lightBlue500: string; - lightBlue600: string; - lightBlue700: string; - lightBlue800: string; - lightBlue900: string; - lightBlueA100: string; - lightBlueA200: string; - lightBlueA400: string; - lightBlueA700: string; - - cyan50: string; - cyan100: string; - cyan200: string; - cyan300: string; - cyan400: string; - cyan500: string; - cyan600: string; - cyan700: string; - cyan800: string; - cyan900: string; - cyanA100: string; - cyanA200: string; - cyanA400: string; - cyanA700: string; - - teal50: string; - teal100: string; - teal200: string; - teal300: string; - teal400: string; - teal500: string; - teal600: string; - teal700: string; - teal800: string; - teal900: string; - tealA100: string; - tealA200: string; - tealA400: string; - tealA700: string; - - green50: string; - green100: string; - green200: string; - green300: string; - green400: string; - green500: string; - green600: string; - green700: string; - green800: string; - green900: string; - greenA100: string; - greenA200: string; - greenA400: string; - greenA700: string; - - lightGreen50: string; - lightGreen100: string; - lightGreen200: string; - lightGreen300: string; - lightGreen400: string; - lightGreen500: string; - lightGreen600: string; - lightGreen700: string; - lightGreen800: string; - lightGreen900: string; - lightGreenA100: string; - lightGreenA200: string; - lightGreenA400: string; - lightGreenA700: string; - - lime50: string; - lime100: string; - lime200: string; - lime300: string; - lime400: string; - lime500: string; - lime600: string; - lime700: string; - lime800: string; - lime900: string; - limeA100: string; - limeA200: string; - limeA400: string; - limeA700: string; - - yellow50: string; - yellow100: string; - yellow200: string; - yellow300: string; - yellow400: string; - yellow500: string; - yellow600: string; - yellow700: string; - yellow800: string; - yellow900: string; - yellowA100: string; - yellowA200: string; - yellowA400: string; - yellowA700: string; - - amber50: string; - amber100: string; - amber200: string; - amber300: string; - amber400: string; - amber500: string; - amber600: string; - amber700: string; - amber800: string; - amber900: string; - amberA100: string; - amberA200: string; - amberA400: string; - amberA700: string; - - orange50: string; - orange100: string; - orange200: string; - orange300: string; - orange400: string; - orange500: string; - orange600: string; - orange700: string; - orange800: string; - orange900: string; - orangeA100: string; - orangeA200: string; - orangeA400: string; - orangeA700: string; - - deepOrange50: string; - deepOrange100: string; - deepOrange200: string; - deepOrange300: string; - deepOrange400: string; - deepOrange500: string; - deepOrange600: string; - deepOrange700: string; - deepOrange800: string; - deepOrange900: string; - deepOrangeA100: string; - deepOrangeA200: string; - deepOrangeA400: string; - deepOrangeA700: string; - - brown50: string; - brown100: string; - brown200: string; - brown300: string; - brown400: string; - brown500: string; - brown600: string; - brown700: string; - brown800: string; - brown900: string; - - blueGrey50: string; - blueGrey100: string; - blueGrey200: string; - blueGrey300: string; - blueGrey400: string; - blueGrey500: string; - blueGrey600: string; - blueGrey700: string; - blueGrey800: string; - blueGrey900: string; - - grey50: string; - grey100: string; - grey200: string; - grey300: string; - grey400: string; - grey500: string; - grey600: string; - grey700: string; - grey800: string; - grey900: string; - - black: string; - white: string; - - transparent: string; - fullBlack: string; - darkBlack: string; - lightBlack: string; - minBlack: string; - faintBlack: string; - fullWhite: string; - darkWhite: string; - lightWhite: string; - } - export var Colors: Colors; -} - -declare module "material-ui/lib/svg-icons" { - export var ActionAccessibility: __MaterialUI.SvgIcon; - export var ActionAccessible: __MaterialUI.SvgIcon; - export var ActionAccountBalanceWallet: __MaterialUI.SvgIcon; - export var ActionAccountBalance: __MaterialUI.SvgIcon; - export var ActionAccountBox: __MaterialUI.SvgIcon; - export var ActionAccountCircle: __MaterialUI.SvgIcon; - export var ActionAddShoppingCart: __MaterialUI.SvgIcon; - export var ActionAlarmAdd: __MaterialUI.SvgIcon; - export var ActionAlarmOff: __MaterialUI.SvgIcon; - export var ActionAlarmOn: __MaterialUI.SvgIcon; - export var ActionAlarm: __MaterialUI.SvgIcon; - export var ActionAllOut: __MaterialUI.SvgIcon; - export var ActionAndroid: __MaterialUI.SvgIcon; - export var ActionAnnouncement: __MaterialUI.SvgIcon; - export var ActionAspectRatio: __MaterialUI.SvgIcon; - export var ActionAssessment: __MaterialUI.SvgIcon; - export var ActionAssignmentInd: __MaterialUI.SvgIcon; - export var ActionAssignmentLate: __MaterialUI.SvgIcon; - export var ActionAssignmentReturn: __MaterialUI.SvgIcon; - export var ActionAssignmentReturned: __MaterialUI.SvgIcon; - export var ActionAssignmentTurnedIn: __MaterialUI.SvgIcon; - export var ActionAssignment: __MaterialUI.SvgIcon; - export var ActionAutorenew: __MaterialUI.SvgIcon; - export var ActionBackup: __MaterialUI.SvgIcon; - export var ActionBook: __MaterialUI.SvgIcon; - export var ActionBookmarkBorder: __MaterialUI.SvgIcon; - export var ActionBookmark: __MaterialUI.SvgIcon; - export var ActionBugReport: __MaterialUI.SvgIcon; - export var ActionBuild: __MaterialUI.SvgIcon; - export var ActionCached: __MaterialUI.SvgIcon; - export var ActionCameraEnhance: __MaterialUI.SvgIcon; - export var ActionCardGiftcard: __MaterialUI.SvgIcon; - export var ActionCardMembership: __MaterialUI.SvgIcon; - export var ActionCardTravel: __MaterialUI.SvgIcon; - export var ActionChangeHistory: __MaterialUI.SvgIcon; - export var ActionCheckCircle: __MaterialUI.SvgIcon; - export var ActionChromeReaderMode: __MaterialUI.SvgIcon; - export var ActionClass: __MaterialUI.SvgIcon; - export var ActionCode: __MaterialUI.SvgIcon; - export var ActionCompareArrows: __MaterialUI.SvgIcon; - export var ActionCopyright: __MaterialUI.SvgIcon; - export var ActionCreditCard: __MaterialUI.SvgIcon; - export var ActionDashboard: __MaterialUI.SvgIcon; - export var ActionDateRange: __MaterialUI.SvgIcon; - export var ActionDelete: __MaterialUI.SvgIcon; - export var ActionDescription: __MaterialUI.SvgIcon; - export var ActionDns: __MaterialUI.SvgIcon; - export var ActionDoneAll: __MaterialUI.SvgIcon; - export var ActionDone: __MaterialUI.SvgIcon; - export var ActionDonutLarge: __MaterialUI.SvgIcon; - export var ActionDonutSmall: __MaterialUI.SvgIcon; - export var ActionEject: __MaterialUI.SvgIcon; - export var ActionEventSeat: __MaterialUI.SvgIcon; - export var ActionEvent: __MaterialUI.SvgIcon; - export var ActionExitToApp: __MaterialUI.SvgIcon; - export var ActionExplore: __MaterialUI.SvgIcon; - export var ActionExtension: __MaterialUI.SvgIcon; - export var ActionFace: __MaterialUI.SvgIcon; - export var ActionFavoriteBorder: __MaterialUI.SvgIcon; - export var ActionFavorite: __MaterialUI.SvgIcon; - export var ActionFeedback: __MaterialUI.SvgIcon; - export var ActionFindInPage: __MaterialUI.SvgIcon; - export var ActionFindReplace: __MaterialUI.SvgIcon; - export var ActionFingerprint: __MaterialUI.SvgIcon; - export var ActionFlightLand: __MaterialUI.SvgIcon; - export var ActionFlightTakeoff: __MaterialUI.SvgIcon; - export var ActionFlipToBack: __MaterialUI.SvgIcon; - export var ActionFlipToFront: __MaterialUI.SvgIcon; - export var ActionGavel: __MaterialUI.SvgIcon; - export var ActionGetApp: __MaterialUI.SvgIcon; - export var ActionGif: __MaterialUI.SvgIcon; - export var ActionGrade: __MaterialUI.SvgIcon; - export var ActionGroupWork: __MaterialUI.SvgIcon; - export var ActionHelpOutline: __MaterialUI.SvgIcon; - export var ActionHelp: __MaterialUI.SvgIcon; - export var ActionHighlightOff: __MaterialUI.SvgIcon; - export var ActionHistory: __MaterialUI.SvgIcon; - export var ActionHome: __MaterialUI.SvgIcon; - export var ActionHourglassEmpty: __MaterialUI.SvgIcon; - export var ActionHourglassFull: __MaterialUI.SvgIcon; - export var ActionHttp: __MaterialUI.SvgIcon; - export var ActionHttps: __MaterialUI.SvgIcon; - export var ActionImportantDevices: __MaterialUI.SvgIcon; - export var ActionInfoOutline: __MaterialUI.SvgIcon; - export var ActionInfo: __MaterialUI.SvgIcon; - export var ActionInput: __MaterialUI.SvgIcon; - export var ActionInvertColors: __MaterialUI.SvgIcon; - export var ActionLabelOutline: __MaterialUI.SvgIcon; - export var ActionLabel: __MaterialUI.SvgIcon; - export var ActionLanguage: __MaterialUI.SvgIcon; - export var ActionLaunch: __MaterialUI.SvgIcon; - export var ActionLightbulbOutline: __MaterialUI.SvgIcon; - export var ActionLineStyle: __MaterialUI.SvgIcon; - export var ActionLineWeight: __MaterialUI.SvgIcon; - export var ActionList: __MaterialUI.SvgIcon; - export var ActionLockOpen: __MaterialUI.SvgIcon; - export var ActionLockOutline: __MaterialUI.SvgIcon; - export var ActionLock: __MaterialUI.SvgIcon; - export var ActionLoyalty: __MaterialUI.SvgIcon; - export var ActionMarkunreadMailbox: __MaterialUI.SvgIcon; - export var ActionMotorcycle: __MaterialUI.SvgIcon; - export var ActionNoteAdd: __MaterialUI.SvgIcon; - export var ActionOfflinePin: __MaterialUI.SvgIcon; - export var ActionOpacity: __MaterialUI.SvgIcon; - export var ActionOpenInBrowser: __MaterialUI.SvgIcon; - export var ActionOpenInNew: __MaterialUI.SvgIcon; - export var ActionOpenWith: __MaterialUI.SvgIcon; - export var ActionPageview: __MaterialUI.SvgIcon; - export var ActionPanTool: __MaterialUI.SvgIcon; - export var ActionPayment: __MaterialUI.SvgIcon; - export var ActionPermCameraMic: __MaterialUI.SvgIcon; - export var ActionPermContactCalendar: __MaterialUI.SvgIcon; - export var ActionPermDataSetting: __MaterialUI.SvgIcon; - export var ActionPermDeviceInformation: __MaterialUI.SvgIcon; - export var ActionPermIdentity: __MaterialUI.SvgIcon; - export var ActionPermMedia: __MaterialUI.SvgIcon; - export var ActionPermPhoneMsg: __MaterialUI.SvgIcon; - export var ActionPermScanWifi: __MaterialUI.SvgIcon; - export var ActionPets: __MaterialUI.SvgIcon; - export var ActionPictureInPictureAlt: __MaterialUI.SvgIcon; - export var ActionPictureInPicture: __MaterialUI.SvgIcon; - export var ActionPlayForWork: __MaterialUI.SvgIcon; - export var ActionPolymer: __MaterialUI.SvgIcon; - export var ActionPowerSettingsNew: __MaterialUI.SvgIcon; - export var ActionPregnantWoman: __MaterialUI.SvgIcon; - export var ActionPrint: __MaterialUI.SvgIcon; - export var ActionQueryBuilder: __MaterialUI.SvgIcon; - export var ActionQuestionAnswer: __MaterialUI.SvgIcon; - export var ActionReceipt: __MaterialUI.SvgIcon; - export var ActionRecordVoiceOver: __MaterialUI.SvgIcon; - export var ActionRedeem: __MaterialUI.SvgIcon; - export var ActionReorder: __MaterialUI.SvgIcon; - export var ActionReportProblem: __MaterialUI.SvgIcon; - export var ActionRestore: __MaterialUI.SvgIcon; - export var ActionRoom: __MaterialUI.SvgIcon; - export var ActionRoundedCorner: __MaterialUI.SvgIcon; - export var ActionRowing: __MaterialUI.SvgIcon; - export var ActionSchedule: __MaterialUI.SvgIcon; - export var ActionSearch: __MaterialUI.SvgIcon; - export var ActionSettingsApplications: __MaterialUI.SvgIcon; - export var ActionSettingsBackupRestore: __MaterialUI.SvgIcon; - export var ActionSettingsBluetooth: __MaterialUI.SvgIcon; - export var ActionSettingsBrightness: __MaterialUI.SvgIcon; - export var ActionSettingsCell: __MaterialUI.SvgIcon; - export var ActionSettingsEthernet: __MaterialUI.SvgIcon; - export var ActionSettingsInputAntenna: __MaterialUI.SvgIcon; - export var ActionSettingsInputComponent: __MaterialUI.SvgIcon; - export var ActionSettingsInputComposite: __MaterialUI.SvgIcon; - export var ActionSettingsInputHdmi: __MaterialUI.SvgIcon; - export var ActionSettingsInputSvideo: __MaterialUI.SvgIcon; - export var ActionSettingsOverscan: __MaterialUI.SvgIcon; - export var ActionSettingsPhone: __MaterialUI.SvgIcon; - export var ActionSettingsPower: __MaterialUI.SvgIcon; - export var ActionSettingsRemote: __MaterialUI.SvgIcon; - export var ActionSettingsVoice: __MaterialUI.SvgIcon; - export var ActionSettings: __MaterialUI.SvgIcon; - export var ActionShopTwo: __MaterialUI.SvgIcon; - export var ActionShop: __MaterialUI.SvgIcon; - export var ActionShoppingBasket: __MaterialUI.SvgIcon; - export var ActionShoppingCart: __MaterialUI.SvgIcon; - export var ActionSpeakerNotes: __MaterialUI.SvgIcon; - export var ActionSpellcheck: __MaterialUI.SvgIcon; - export var ActionStars: __MaterialUI.SvgIcon; - export var ActionStore: __MaterialUI.SvgIcon; - export var ActionSubject: __MaterialUI.SvgIcon; - export var ActionSupervisorAccount: __MaterialUI.SvgIcon; - export var ActionSwapHoriz: __MaterialUI.SvgIcon; - export var ActionSwapVert: __MaterialUI.SvgIcon; - export var ActionSwapVerticalCircle: __MaterialUI.SvgIcon; - export var ActionSystemUpdateAlt: __MaterialUI.SvgIcon; - export var ActionTabUnselected: __MaterialUI.SvgIcon; - export var ActionTab: __MaterialUI.SvgIcon; - export var ActionTheaters: __MaterialUI.SvgIcon; - export var ActionThreeDRotation: __MaterialUI.SvgIcon; - export var ActionThumbDown: __MaterialUI.SvgIcon; - export var ActionThumbUp: __MaterialUI.SvgIcon; - export var ActionThumbsUpDown: __MaterialUI.SvgIcon; - export var ActionTimeline: __MaterialUI.SvgIcon; - export var ActionToc: __MaterialUI.SvgIcon; - export var ActionToday: __MaterialUI.SvgIcon; - export var ActionToll: __MaterialUI.SvgIcon; - export var ActionTouchApp: __MaterialUI.SvgIcon; - export var ActionTrackChanges: __MaterialUI.SvgIcon; - export var ActionTranslate: __MaterialUI.SvgIcon; - export var ActionTrendingDown: __MaterialUI.SvgIcon; - export var ActionTrendingFlat: __MaterialUI.SvgIcon; - export var ActionTrendingUp: __MaterialUI.SvgIcon; - export var ActionTurnedInNot: __MaterialUI.SvgIcon; - export var ActionTurnedIn: __MaterialUI.SvgIcon; - export var ActionUpdate: __MaterialUI.SvgIcon; - export var ActionVerifiedUser: __MaterialUI.SvgIcon; - export var ActionViewAgenda: __MaterialUI.SvgIcon; - export var ActionViewArray: __MaterialUI.SvgIcon; - export var ActionViewCarousel: __MaterialUI.SvgIcon; - export var ActionViewColumn: __MaterialUI.SvgIcon; - export var ActionViewDay: __MaterialUI.SvgIcon; - export var ActionViewHeadline: __MaterialUI.SvgIcon; - export var ActionViewList: __MaterialUI.SvgIcon; - export var ActionViewModule: __MaterialUI.SvgIcon; - export var ActionViewQuilt: __MaterialUI.SvgIcon; - export var ActionViewStream: __MaterialUI.SvgIcon; - export var ActionViewWeek: __MaterialUI.SvgIcon; - export var ActionVisibilityOff: __MaterialUI.SvgIcon; - export var ActionVisibility: __MaterialUI.SvgIcon; - export var ActionWatchLater: __MaterialUI.SvgIcon; - export var ActionWork: __MaterialUI.SvgIcon; - export var ActionYoutubeSearchedFor: __MaterialUI.SvgIcon; - export var ActionZoomIn: __MaterialUI.SvgIcon; - export var ActionZoomOut: __MaterialUI.SvgIcon; - export var AlertAddAlert: __MaterialUI.SvgIcon; - export var AlertErrorOutline: __MaterialUI.SvgIcon; - export var AlertError: __MaterialUI.SvgIcon; - export var AlertWarning: __MaterialUI.SvgIcon; - export var AvAddToQueue: __MaterialUI.SvgIcon; - export var AvAirplay: __MaterialUI.SvgIcon; - export var AvAlbum: __MaterialUI.SvgIcon; - export var AvArtTrack: __MaterialUI.SvgIcon; - export var AvAvTimer: __MaterialUI.SvgIcon; - export var AvClosedCaption: __MaterialUI.SvgIcon; - export var AvEqualizer: __MaterialUI.SvgIcon; - export var AvExplicit: __MaterialUI.SvgIcon; - export var AvFastForward: __MaterialUI.SvgIcon; - export var AvFastRewind: __MaterialUI.SvgIcon; - export var AvFiberDvr: __MaterialUI.SvgIcon; - export var AvFiberManualRecord: __MaterialUI.SvgIcon; - export var AvFiberNew: __MaterialUI.SvgIcon; - export var AvFiberPin: __MaterialUI.SvgIcon; - export var AvFiberSmartRecord: __MaterialUI.SvgIcon; - export var AvForward10: __MaterialUI.SvgIcon; - export var AvForward30: __MaterialUI.SvgIcon; - export var AvForward5: __MaterialUI.SvgIcon; - export var AvGames: __MaterialUI.SvgIcon; - export var AvHd: __MaterialUI.SvgIcon; - export var AvHearing: __MaterialUI.SvgIcon; - export var AvHighQuality: __MaterialUI.SvgIcon; - export var AvLibraryAdd: __MaterialUI.SvgIcon; - export var AvLibraryBooks: __MaterialUI.SvgIcon; - export var AvLibraryMusic: __MaterialUI.SvgIcon; - export var AvLoop: __MaterialUI.SvgIcon; - export var AvMicNone: __MaterialUI.SvgIcon; - export var AvMicOff: __MaterialUI.SvgIcon; - export var AvMic: __MaterialUI.SvgIcon; - export var AvMovie: __MaterialUI.SvgIcon; - export var AvMusicVideo: __MaterialUI.SvgIcon; - export var AvNewReleases: __MaterialUI.SvgIcon; - export var AvNotInterested: __MaterialUI.SvgIcon; - export var AvPauseCircleFilled: __MaterialUI.SvgIcon; - export var AvPauseCircleOutline: __MaterialUI.SvgIcon; - export var AvPause: __MaterialUI.SvgIcon; - export var AvPlayArrow: __MaterialUI.SvgIcon; - export var AvPlayCircleFilled: __MaterialUI.SvgIcon; - export var AvPlayCircleOutline: __MaterialUI.SvgIcon; - export var AvPlaylistAddCheck: __MaterialUI.SvgIcon; - export var AvPlaylistAdd: __MaterialUI.SvgIcon; - export var AvPlaylistPlay: __MaterialUI.SvgIcon; - export var AvQueueMusic: __MaterialUI.SvgIcon; - export var AvQueuePlayNext: __MaterialUI.SvgIcon; - export var AvQueue: __MaterialUI.SvgIcon; - export var AvRadio: __MaterialUI.SvgIcon; - export var AvRecentActors: __MaterialUI.SvgIcon; - export var AvRemoveFromQueue: __MaterialUI.SvgIcon; - export var AvRepeatOne: __MaterialUI.SvgIcon; - export var AvRepeat: __MaterialUI.SvgIcon; - export var AvReplay10: __MaterialUI.SvgIcon; - export var AvReplay30: __MaterialUI.SvgIcon; - export var AvReplay5: __MaterialUI.SvgIcon; - export var AvReplay: __MaterialUI.SvgIcon; - export var AvShuffle: __MaterialUI.SvgIcon; - export var AvSkipNext: __MaterialUI.SvgIcon; - export var AvSkipPrevious: __MaterialUI.SvgIcon; - export var AvSlowMotionVideo: __MaterialUI.SvgIcon; - export var AvSnooze: __MaterialUI.SvgIcon; - export var AvSortByAlpha: __MaterialUI.SvgIcon; - export var AvStop: __MaterialUI.SvgIcon; - export var AvSubscriptions: __MaterialUI.SvgIcon; - export var AvSubtitles: __MaterialUI.SvgIcon; - export var AvSurroundSound: __MaterialUI.SvgIcon; - export var AvVideoLibrary: __MaterialUI.SvgIcon; - export var AvVideocamOff: __MaterialUI.SvgIcon; - export var AvVideocam: __MaterialUI.SvgIcon; - export var AvVolumeDown: __MaterialUI.SvgIcon; - export var AvVolumeMute: __MaterialUI.SvgIcon; - export var AvVolumeOff: __MaterialUI.SvgIcon; - export var AvVolumeUp: __MaterialUI.SvgIcon; - export var AvWebAsset: __MaterialUI.SvgIcon; - export var AvWeb: __MaterialUI.SvgIcon; - export var CommunicationBusiness: __MaterialUI.SvgIcon; - export var CommunicationCallEnd: __MaterialUI.SvgIcon; - export var CommunicationCallMade: __MaterialUI.SvgIcon; - export var CommunicationCallMerge: __MaterialUI.SvgIcon; - export var CommunicationCallMissedOutgoing: __MaterialUI.SvgIcon; - export var CommunicationCallMissed: __MaterialUI.SvgIcon; - export var CommunicationCallReceived: __MaterialUI.SvgIcon; - export var CommunicationCallSplit: __MaterialUI.SvgIcon; - export var CommunicationCall: __MaterialUI.SvgIcon; - export var CommunicationChatBubbleOutline: __MaterialUI.SvgIcon; - export var CommunicationChatBubble: __MaterialUI.SvgIcon; - export var CommunicationChat: __MaterialUI.SvgIcon; - export var CommunicationClearAll: __MaterialUI.SvgIcon; - export var CommunicationComment: __MaterialUI.SvgIcon; - export var CommunicationContactMail: __MaterialUI.SvgIcon; - export var CommunicationContactPhone: __MaterialUI.SvgIcon; - export var CommunicationContacts: __MaterialUI.SvgIcon; - export var CommunicationDialerSip: __MaterialUI.SvgIcon; - export var CommunicationDialpad: __MaterialUI.SvgIcon; - export var CommunicationEmail: __MaterialUI.SvgIcon; - export var CommunicationForum: __MaterialUI.SvgIcon; - export var CommunicationImportContacts: __MaterialUI.SvgIcon; - export var CommunicationImportExport: __MaterialUI.SvgIcon; - export var CommunicationInvertColorsOff: __MaterialUI.SvgIcon; - export var CommunicationLiveHelp: __MaterialUI.SvgIcon; - export var CommunicationLocationOff: __MaterialUI.SvgIcon; - export var CommunicationLocationOn: __MaterialUI.SvgIcon; - export var CommunicationMailOutline: __MaterialUI.SvgIcon; - export var CommunicationMessage: __MaterialUI.SvgIcon; - export var CommunicationNoSim: __MaterialUI.SvgIcon; - export var CommunicationPhone: __MaterialUI.SvgIcon; - export var CommunicationPhonelinkErase: __MaterialUI.SvgIcon; - export var CommunicationPhonelinkLock: __MaterialUI.SvgIcon; - export var CommunicationPhonelinkRing: __MaterialUI.SvgIcon; - export var CommunicationPhonelinkSetup: __MaterialUI.SvgIcon; - export var CommunicationPortableWifiOff: __MaterialUI.SvgIcon; - export var CommunicationPresentToAll: __MaterialUI.SvgIcon; - export var CommunicationRingVolume: __MaterialUI.SvgIcon; - export var CommunicationScreenShare: __MaterialUI.SvgIcon; - export var CommunicationSpeakerPhone: __MaterialUI.SvgIcon; - export var CommunicationStayCurrentLandscape: __MaterialUI.SvgIcon; - export var CommunicationStayCurrentPortrait: __MaterialUI.SvgIcon; - export var CommunicationStayPrimaryLandscape: __MaterialUI.SvgIcon; - export var CommunicationStayPrimaryPortrait: __MaterialUI.SvgIcon; - export var CommunicationStopScreenShare: __MaterialUI.SvgIcon; - export var CommunicationSwapCalls: __MaterialUI.SvgIcon; - export var CommunicationTextsms: __MaterialUI.SvgIcon; - export var CommunicationVoicemail: __MaterialUI.SvgIcon; - export var CommunicationVpnKey: __MaterialUI.SvgIcon; - export var ContentAddBox: __MaterialUI.SvgIcon; - export var ContentAddCircleOutline: __MaterialUI.SvgIcon; - export var ContentAddCircle: __MaterialUI.SvgIcon; - export var ContentAdd: __MaterialUI.SvgIcon; - export var ContentArchive: __MaterialUI.SvgIcon; - export var ContentBackspace: __MaterialUI.SvgIcon; - export var ContentBlock: __MaterialUI.SvgIcon; - export var ContentClear: __MaterialUI.SvgIcon; - export var ContentContentCopy: __MaterialUI.SvgIcon; - export var ContentContentCut: __MaterialUI.SvgIcon; - export var ContentContentPaste: __MaterialUI.SvgIcon; - export var ContentCreate: __MaterialUI.SvgIcon; - export var ContentDrafts: __MaterialUI.SvgIcon; - export var ContentFilterList: __MaterialUI.SvgIcon; - export var ContentFlag: __MaterialUI.SvgIcon; - export var ContentFontDownload: __MaterialUI.SvgIcon; - export var ContentForward: __MaterialUI.SvgIcon; - export var ContentGesture: __MaterialUI.SvgIcon; - export var ContentInbox: __MaterialUI.SvgIcon; - export var ContentLink: __MaterialUI.SvgIcon; - export var ContentMail: __MaterialUI.SvgIcon; - export var ContentMarkunread: __MaterialUI.SvgIcon; - export var ContentMoveToInbox: __MaterialUI.SvgIcon; - export var ContentNextWeek: __MaterialUI.SvgIcon; - export var ContentRedo: __MaterialUI.SvgIcon; - export var ContentRemoveCircleOutline: __MaterialUI.SvgIcon; - export var ContentRemoveCircle: __MaterialUI.SvgIcon; - export var ContentRemove: __MaterialUI.SvgIcon; - export var ContentReplyAll: __MaterialUI.SvgIcon; - export var ContentReply: __MaterialUI.SvgIcon; - export var ContentReport: __MaterialUI.SvgIcon; - export var ContentSave: __MaterialUI.SvgIcon; - export var ContentSelectAll: __MaterialUI.SvgIcon; - export var ContentSend: __MaterialUI.SvgIcon; - export var ContentSort: __MaterialUI.SvgIcon; - export var ContentTextFormat: __MaterialUI.SvgIcon; - export var ContentUnarchive: __MaterialUI.SvgIcon; - export var ContentUndo: __MaterialUI.SvgIcon; - export var ContentWeekend: __MaterialUI.SvgIcon; - export var DeviceAccessAlarm: __MaterialUI.SvgIcon; - export var DeviceAccessAlarms: __MaterialUI.SvgIcon; - export var DeviceAccessTime: __MaterialUI.SvgIcon; - export var DeviceAddAlarm: __MaterialUI.SvgIcon; - export var DeviceAirplanemodeActive: __MaterialUI.SvgIcon; - export var DeviceAirplanemodeInactive: __MaterialUI.SvgIcon; - export var DeviceBattery20: __MaterialUI.SvgIcon; - export var DeviceBattery30: __MaterialUI.SvgIcon; - export var DeviceBattery50: __MaterialUI.SvgIcon; - export var DeviceBattery60: __MaterialUI.SvgIcon; - export var DeviceBattery80: __MaterialUI.SvgIcon; - export var DeviceBattery90: __MaterialUI.SvgIcon; - export var DeviceBatteryAlert: __MaterialUI.SvgIcon; - export var DeviceBatteryCharging20: __MaterialUI.SvgIcon; - export var DeviceBatteryCharging30: __MaterialUI.SvgIcon; - export var DeviceBatteryCharging50: __MaterialUI.SvgIcon; - export var DeviceBatteryCharging60: __MaterialUI.SvgIcon; - export var DeviceBatteryCharging80: __MaterialUI.SvgIcon; - export var DeviceBatteryCharging90: __MaterialUI.SvgIcon; - export var DeviceBatteryChargingFull: __MaterialUI.SvgIcon; - export var DeviceBatteryFull: __MaterialUI.SvgIcon; - export var DeviceBatteryStd: __MaterialUI.SvgIcon; - export var DeviceBatteryUnknown: __MaterialUI.SvgIcon; - export var DeviceBluetoothConnected: __MaterialUI.SvgIcon; - export var DeviceBluetoothDisabled: __MaterialUI.SvgIcon; - export var DeviceBluetoothSearching: __MaterialUI.SvgIcon; - export var DeviceBluetooth: __MaterialUI.SvgIcon; - export var DeviceBrightnessAuto: __MaterialUI.SvgIcon; - export var DeviceBrightnessHigh: __MaterialUI.SvgIcon; - export var DeviceBrightnessLow: __MaterialUI.SvgIcon; - export var DeviceBrightnessMedium: __MaterialUI.SvgIcon; - export var DeviceDataUsage: __MaterialUI.SvgIcon; - export var DeviceDeveloperMode: __MaterialUI.SvgIcon; - export var DeviceDevices: __MaterialUI.SvgIcon; - export var DeviceDvr: __MaterialUI.SvgIcon; - export var DeviceGpsFixed: __MaterialUI.SvgIcon; - export var DeviceGpsNotFixed: __MaterialUI.SvgIcon; - export var DeviceGpsOff: __MaterialUI.SvgIcon; - export var DeviceGraphicEq: __MaterialUI.SvgIcon; - export var DeviceLocationDisabled: __MaterialUI.SvgIcon; - export var DeviceLocationSearching: __MaterialUI.SvgIcon; - export var DeviceNetworkCell: __MaterialUI.SvgIcon; - export var DeviceNetworkWifi: __MaterialUI.SvgIcon; - export var DeviceNfc: __MaterialUI.SvgIcon; - export var DeviceScreenLockLandscape: __MaterialUI.SvgIcon; - export var DeviceScreenLockPortrait: __MaterialUI.SvgIcon; - export var DeviceScreenLockRotation: __MaterialUI.SvgIcon; - export var DeviceScreenRotation: __MaterialUI.SvgIcon; - export var DeviceSdStorage: __MaterialUI.SvgIcon; - export var DeviceSettingsSystemDaydream: __MaterialUI.SvgIcon; - export var DeviceSignalCellular0Bar: __MaterialUI.SvgIcon; - export var DeviceSignalCellular1Bar: __MaterialUI.SvgIcon; - export var DeviceSignalCellular2Bar: __MaterialUI.SvgIcon; - export var DeviceSignalCellular3Bar: __MaterialUI.SvgIcon; - export var DeviceSignalCellular4Bar: __MaterialUI.SvgIcon; - export var DeviceSignalCellularConnectedNoInternet0Bar: __MaterialUI.SvgIcon; - export var DeviceSignalCellularConnectedNoInternet1Bar: __MaterialUI.SvgIcon; - export var DeviceSignalCellularConnectedNoInternet2Bar: __MaterialUI.SvgIcon; - export var DeviceSignalCellularConnectedNoInternet3Bar: __MaterialUI.SvgIcon; - export var DeviceSignalCellularConnectedNoInternet4Bar: __MaterialUI.SvgIcon; - export var DeviceSignalCellularNoSim: __MaterialUI.SvgIcon; - export var DeviceSignalCellularNull: __MaterialUI.SvgIcon; - export var DeviceSignalCellularOff: __MaterialUI.SvgIcon; - export var DeviceSignalWifi0Bar: __MaterialUI.SvgIcon; - export var DeviceSignalWifi1BarLock: __MaterialUI.SvgIcon; - export var DeviceSignalWifi1Bar: __MaterialUI.SvgIcon; - export var DeviceSignalWifi2BarLock: __MaterialUI.SvgIcon; - export var DeviceSignalWifi2Bar: __MaterialUI.SvgIcon; - export var DeviceSignalWifi3BarLock: __MaterialUI.SvgIcon; - export var DeviceSignalWifi3Bar: __MaterialUI.SvgIcon; - export var DeviceSignalWifi4BarLock: __MaterialUI.SvgIcon; - export var DeviceSignalWifi4Bar: __MaterialUI.SvgIcon; - export var DeviceSignalWifiOff: __MaterialUI.SvgIcon; - export var DeviceStorage: __MaterialUI.SvgIcon; - export var DeviceUsb: __MaterialUI.SvgIcon; - export var DeviceWallpaper: __MaterialUI.SvgIcon; - export var DeviceWidgets: __MaterialUI.SvgIcon; - export var DeviceWifiLock: __MaterialUI.SvgIcon; - export var DeviceWifiTethering: __MaterialUI.SvgIcon; - export var EditorAttachFile: __MaterialUI.SvgIcon; - export var EditorAttachMoney: __MaterialUI.SvgIcon; - export var EditorBorderAll: __MaterialUI.SvgIcon; - export var EditorBorderBottom: __MaterialUI.SvgIcon; - export var EditorBorderClear: __MaterialUI.SvgIcon; - export var EditorBorderColor: __MaterialUI.SvgIcon; - export var EditorBorderHorizontal: __MaterialUI.SvgIcon; - export var EditorBorderInner: __MaterialUI.SvgIcon; - export var EditorBorderLeft: __MaterialUI.SvgIcon; - export var EditorBorderOuter: __MaterialUI.SvgIcon; - export var EditorBorderRight: __MaterialUI.SvgIcon; - export var EditorBorderStyle: __MaterialUI.SvgIcon; - export var EditorBorderTop: __MaterialUI.SvgIcon; - export var EditorBorderVertical: __MaterialUI.SvgIcon; - export var EditorDragHandle: __MaterialUI.SvgIcon; - export var EditorFormatAlignCenter: __MaterialUI.SvgIcon; - export var EditorFormatAlignJustify: __MaterialUI.SvgIcon; - export var EditorFormatAlignLeft: __MaterialUI.SvgIcon; - export var EditorFormatAlignRight: __MaterialUI.SvgIcon; - export var EditorFormatBold: __MaterialUI.SvgIcon; - export var EditorFormatClear: __MaterialUI.SvgIcon; - export var EditorFormatColorFill: __MaterialUI.SvgIcon; - export var EditorFormatColorReset: __MaterialUI.SvgIcon; - export var EditorFormatColorText: __MaterialUI.SvgIcon; - export var EditorFormatIndentDecrease: __MaterialUI.SvgIcon; - export var EditorFormatIndentIncrease: __MaterialUI.SvgIcon; - export var EditorFormatItalic: __MaterialUI.SvgIcon; - export var EditorFormatLineSpacing: __MaterialUI.SvgIcon; - export var EditorFormatListBulleted: __MaterialUI.SvgIcon; - export var EditorFormatListNumbered: __MaterialUI.SvgIcon; - export var EditorFormatPaint: __MaterialUI.SvgIcon; - export var EditorFormatQuote: __MaterialUI.SvgIcon; - export var EditorFormatShapes: __MaterialUI.SvgIcon; - export var EditorFormatSize: __MaterialUI.SvgIcon; - export var EditorFormatStrikethrough: __MaterialUI.SvgIcon; - export var EditorFormatTextdirectionLToR: __MaterialUI.SvgIcon; - export var EditorFormatTextdirectionRToL: __MaterialUI.SvgIcon; - export var EditorFormatUnderlined: __MaterialUI.SvgIcon; - export var EditorFunctions: __MaterialUI.SvgIcon; - export var EditorHighlight: __MaterialUI.SvgIcon; - export var EditorInsertChart: __MaterialUI.SvgIcon; - export var EditorInsertComment: __MaterialUI.SvgIcon; - export var EditorInsertDriveFile: __MaterialUI.SvgIcon; - export var EditorInsertEmoticon: __MaterialUI.SvgIcon; - export var EditorInsertInvitation: __MaterialUI.SvgIcon; - export var EditorInsertLink: __MaterialUI.SvgIcon; - export var EditorInsertPhoto: __MaterialUI.SvgIcon; - export var EditorLinearScale: __MaterialUI.SvgIcon; - export var EditorMergeType: __MaterialUI.SvgIcon; - export var EditorModeComment: __MaterialUI.SvgIcon; - export var EditorModeEdit: __MaterialUI.SvgIcon; - export var EditorMoneyOff: __MaterialUI.SvgIcon; - export var EditorPublish: __MaterialUI.SvgIcon; - export var EditorShortText: __MaterialUI.SvgIcon; - export var EditorSpaceBar: __MaterialUI.SvgIcon; - export var EditorStrikethroughS: __MaterialUI.SvgIcon; - export var EditorTextFields: __MaterialUI.SvgIcon; - export var EditorVerticalAlignBottom: __MaterialUI.SvgIcon; - export var EditorVerticalAlignCenter: __MaterialUI.SvgIcon; - export var EditorVerticalAlignTop: __MaterialUI.SvgIcon; - export var EditorWrapText: __MaterialUI.SvgIcon; - export var FileAttachment: __MaterialUI.SvgIcon; - export var FileCloudCircle: __MaterialUI.SvgIcon; - export var FileCloudDone: __MaterialUI.SvgIcon; - export var FileCloudDownload: __MaterialUI.SvgIcon; - export var FileCloudOff: __MaterialUI.SvgIcon; - export var FileCloudQueue: __MaterialUI.SvgIcon; - export var FileCloudUpload: __MaterialUI.SvgIcon; - export var FileCloud: __MaterialUI.SvgIcon; - export var FileCreateNewFolder: __MaterialUI.SvgIcon; - export var FileFileDownload: __MaterialUI.SvgIcon; - export var FileFileUpload: __MaterialUI.SvgIcon; - export var FileFolderOpen: __MaterialUI.SvgIcon; - export var FileFolderShared: __MaterialUI.SvgIcon; - export var FileFolder: __MaterialUI.SvgIcon; - export var HardwareCastConnected: __MaterialUI.SvgIcon; - export var HardwareCast: __MaterialUI.SvgIcon; - export var HardwareComputer: __MaterialUI.SvgIcon; - export var HardwareDesktopMac: __MaterialUI.SvgIcon; - export var HardwareDesktopWindows: __MaterialUI.SvgIcon; - export var HardwareDeveloperBoard: __MaterialUI.SvgIcon; - export var HardwareDeviceHub: __MaterialUI.SvgIcon; - export var HardwareDevicesOther: __MaterialUI.SvgIcon; - export var HardwareDock: __MaterialUI.SvgIcon; - export var HardwareGamepad: __MaterialUI.SvgIcon; - export var HardwareHeadsetMic: __MaterialUI.SvgIcon; - export var HardwareHeadset: __MaterialUI.SvgIcon; - export var HardwareKeyboardArrowDown: __MaterialUI.SvgIcon; - export var HardwareKeyboardArrowLeft: __MaterialUI.SvgIcon; - export var HardwareKeyboardArrowRight: __MaterialUI.SvgIcon; - export var HardwareKeyboardArrowUp: __MaterialUI.SvgIcon; - export var HardwareKeyboardBackspace: __MaterialUI.SvgIcon; - export var HardwareKeyboardCapslock: __MaterialUI.SvgIcon; - export var HardwareKeyboardHide: __MaterialUI.SvgIcon; - export var HardwareKeyboardReturn: __MaterialUI.SvgIcon; - export var HardwareKeyboardTab: __MaterialUI.SvgIcon; - export var HardwareKeyboardVoice: __MaterialUI.SvgIcon; - export var HardwareKeyboard: __MaterialUI.SvgIcon; - export var HardwareLaptopChromebook: __MaterialUI.SvgIcon; - export var HardwareLaptopMac: __MaterialUI.SvgIcon; - export var HardwareLaptopWindows: __MaterialUI.SvgIcon; - export var HardwareLaptop: __MaterialUI.SvgIcon; - export var HardwareMemory: __MaterialUI.SvgIcon; - export var HardwareMouse: __MaterialUI.SvgIcon; - export var HardwarePhoneAndroid: __MaterialUI.SvgIcon; - export var HardwarePhoneIphone: __MaterialUI.SvgIcon; - export var HardwarePhonelinkOff: __MaterialUI.SvgIcon; - export var HardwarePhonelink: __MaterialUI.SvgIcon; - export var HardwarePowerInput: __MaterialUI.SvgIcon; - export var HardwareRouter: __MaterialUI.SvgIcon; - export var HardwareScanner: __MaterialUI.SvgIcon; - export var HardwareSecurity: __MaterialUI.SvgIcon; - export var HardwareSimCard: __MaterialUI.SvgIcon; - export var HardwareSmartphone: __MaterialUI.SvgIcon; - export var HardwareSpeakerGroup: __MaterialUI.SvgIcon; - export var HardwareSpeaker: __MaterialUI.SvgIcon; - export var HardwareTabletAndroid: __MaterialUI.SvgIcon; - export var HardwareTabletMac: __MaterialUI.SvgIcon; - export var HardwareTablet: __MaterialUI.SvgIcon; - export var HardwareToys: __MaterialUI.SvgIcon; - export var HardwareTv: __MaterialUI.SvgIcon; - export var HardwareVideogameAsset: __MaterialUI.SvgIcon; - export var HardwareWatch: __MaterialUI.SvgIcon; - export var ImageAddAPhoto: __MaterialUI.SvgIcon; - export var ImageAddToPhotos: __MaterialUI.SvgIcon; - export var ImageAdjust: __MaterialUI.SvgIcon; - export var ImageAssistantPhoto: __MaterialUI.SvgIcon; - export var ImageAssistant: __MaterialUI.SvgIcon; - export var ImageAudiotrack: __MaterialUI.SvgIcon; - export var ImageBlurCircular: __MaterialUI.SvgIcon; - export var ImageBlurLinear: __MaterialUI.SvgIcon; - export var ImageBlurOff: __MaterialUI.SvgIcon; - export var ImageBlurOn: __MaterialUI.SvgIcon; - export var ImageBrightness1: __MaterialUI.SvgIcon; - export var ImageBrightness2: __MaterialUI.SvgIcon; - export var ImageBrightness3: __MaterialUI.SvgIcon; - export var ImageBrightness4: __MaterialUI.SvgIcon; - export var ImageBrightness5: __MaterialUI.SvgIcon; - export var ImageBrightness6: __MaterialUI.SvgIcon; - export var ImageBrightness7: __MaterialUI.SvgIcon; - export var ImageBrokenImage: __MaterialUI.SvgIcon; - export var ImageBrush: __MaterialUI.SvgIcon; - export var ImageCameraAlt: __MaterialUI.SvgIcon; - export var ImageCameraFront: __MaterialUI.SvgIcon; - export var ImageCameraRear: __MaterialUI.SvgIcon; - export var ImageCameraRoll: __MaterialUI.SvgIcon; - export var ImageCamera: __MaterialUI.SvgIcon; - export var ImageCenterFocusStrong: __MaterialUI.SvgIcon; - export var ImageCenterFocusWeak: __MaterialUI.SvgIcon; - export var ImageCollectionsBookmark: __MaterialUI.SvgIcon; - export var ImageCollections: __MaterialUI.SvgIcon; - export var ImageColorLens: __MaterialUI.SvgIcon; - export var ImageColorize: __MaterialUI.SvgIcon; - export var ImageCompare: __MaterialUI.SvgIcon; - export var ImageControlPointDuplicate: __MaterialUI.SvgIcon; - export var ImageControlPoint: __MaterialUI.SvgIcon; - export var ImageCrop169: __MaterialUI.SvgIcon; - export var ImageCrop32: __MaterialUI.SvgIcon; - export var ImageCrop54: __MaterialUI.SvgIcon; - export var ImageCrop75: __MaterialUI.SvgIcon; - export var ImageCropDin: __MaterialUI.SvgIcon; - export var ImageCropFree: __MaterialUI.SvgIcon; - export var ImageCropLandscape: __MaterialUI.SvgIcon; - export var ImageCropOriginal: __MaterialUI.SvgIcon; - export var ImageCropPortrait: __MaterialUI.SvgIcon; - export var ImageCropRotate: __MaterialUI.SvgIcon; - export var ImageCropSquare: __MaterialUI.SvgIcon; - export var ImageCrop: __MaterialUI.SvgIcon; - export var ImageDehaze: __MaterialUI.SvgIcon; - export var ImageDetails: __MaterialUI.SvgIcon; - export var ImageEdit: __MaterialUI.SvgIcon; - export var ImageExposureNeg1: __MaterialUI.SvgIcon; - export var ImageExposureNeg2: __MaterialUI.SvgIcon; - export var ImageExposurePlus1: __MaterialUI.SvgIcon; - export var ImageExposurePlus2: __MaterialUI.SvgIcon; - export var ImageExposureZero: __MaterialUI.SvgIcon; - export var ImageExposure: __MaterialUI.SvgIcon; - export var ImageFilter1: __MaterialUI.SvgIcon; - export var ImageFilter2: __MaterialUI.SvgIcon; - export var ImageFilter3: __MaterialUI.SvgIcon; - export var ImageFilter4: __MaterialUI.SvgIcon; - export var ImageFilter5: __MaterialUI.SvgIcon; - export var ImageFilter6: __MaterialUI.SvgIcon; - export var ImageFilter7: __MaterialUI.SvgIcon; - export var ImageFilter8: __MaterialUI.SvgIcon; - export var ImageFilter9Plus: __MaterialUI.SvgIcon; - export var ImageFilter9: __MaterialUI.SvgIcon; - export var ImageFilterBAndW: __MaterialUI.SvgIcon; - export var ImageFilterCenterFocus: __MaterialUI.SvgIcon; - export var ImageFilterDrama: __MaterialUI.SvgIcon; - export var ImageFilterFrames: __MaterialUI.SvgIcon; - export var ImageFilterHdr: __MaterialUI.SvgIcon; - export var ImageFilterNone: __MaterialUI.SvgIcon; - export var ImageFilterTiltShift: __MaterialUI.SvgIcon; - export var ImageFilterVintage: __MaterialUI.SvgIcon; - export var ImageFilter: __MaterialUI.SvgIcon; - export var ImageFlare: __MaterialUI.SvgIcon; - export var ImageFlashAuto: __MaterialUI.SvgIcon; - export var ImageFlashOff: __MaterialUI.SvgIcon; - export var ImageFlashOn: __MaterialUI.SvgIcon; - export var ImageFlip: __MaterialUI.SvgIcon; - export var ImageGradient: __MaterialUI.SvgIcon; - export var ImageGrain: __MaterialUI.SvgIcon; - export var ImageGridOff: __MaterialUI.SvgIcon; - export var ImageGridOn: __MaterialUI.SvgIcon; - export var ImageHdrOff: __MaterialUI.SvgIcon; - export var ImageHdrOn: __MaterialUI.SvgIcon; - export var ImageHdrStrong: __MaterialUI.SvgIcon; - export var ImageHdrWeak: __MaterialUI.SvgIcon; - export var ImageHealing: __MaterialUI.SvgIcon; - export var ImageImageAspectRatio: __MaterialUI.SvgIcon; - export var ImageImage: __MaterialUI.SvgIcon; - export var ImageIso: __MaterialUI.SvgIcon; - export var ImageLandscape: __MaterialUI.SvgIcon; - export var ImageLeakAdd: __MaterialUI.SvgIcon; - export var ImageLeakRemove: __MaterialUI.SvgIcon; - export var ImageLens: __MaterialUI.SvgIcon; - export var ImageLinkedCamera: __MaterialUI.SvgIcon; - export var ImageLooks3: __MaterialUI.SvgIcon; - export var ImageLooks4: __MaterialUI.SvgIcon; - export var ImageLooks5: __MaterialUI.SvgIcon; - export var ImageLooks6: __MaterialUI.SvgIcon; - export var ImageLooksOne: __MaterialUI.SvgIcon; - export var ImageLooksTwo: __MaterialUI.SvgIcon; - export var ImageLooks: __MaterialUI.SvgIcon; - export var ImageLoupe: __MaterialUI.SvgIcon; - export var ImageMonochromePhotos: __MaterialUI.SvgIcon; - export var ImageMovieCreation: __MaterialUI.SvgIcon; - export var ImageMovieFilter: __MaterialUI.SvgIcon; - export var ImageMusicNote: __MaterialUI.SvgIcon; - export var ImageNaturePeople: __MaterialUI.SvgIcon; - export var ImageNature: __MaterialUI.SvgIcon; - export var ImageNavigateBefore: __MaterialUI.SvgIcon; - export var ImageNavigateNext: __MaterialUI.SvgIcon; - export var ImagePalette: __MaterialUI.SvgIcon; - export var ImagePanoramaFishEye: __MaterialUI.SvgIcon; - export var ImagePanoramaHorizontal: __MaterialUI.SvgIcon; - export var ImagePanoramaVertical: __MaterialUI.SvgIcon; - export var ImagePanoramaWideAngle: __MaterialUI.SvgIcon; - export var ImagePanorama: __MaterialUI.SvgIcon; - export var ImagePhotoAlbum: __MaterialUI.SvgIcon; - export var ImagePhotoCamera: __MaterialUI.SvgIcon; - export var ImagePhotoFilter: __MaterialUI.SvgIcon; - export var ImagePhotoLibrary: __MaterialUI.SvgIcon; - export var ImagePhotoSizeSelectActual: __MaterialUI.SvgIcon; - export var ImagePhotoSizeSelectLarge: __MaterialUI.SvgIcon; - export var ImagePhotoSizeSelectSmall: __MaterialUI.SvgIcon; - export var ImagePhoto: __MaterialUI.SvgIcon; - export var ImagePictureAsPdf: __MaterialUI.SvgIcon; - export var ImagePortrait: __MaterialUI.SvgIcon; - export var ImageRemoveRedEye: __MaterialUI.SvgIcon; - export var ImageRotate90DegreesCcw: __MaterialUI.SvgIcon; - export var ImageRotateLeft: __MaterialUI.SvgIcon; - export var ImageRotateRight: __MaterialUI.SvgIcon; - export var ImageSlideshow: __MaterialUI.SvgIcon; - export var ImageStraighten: __MaterialUI.SvgIcon; - export var ImageStyle: __MaterialUI.SvgIcon; - export var ImageSwitchCamera: __MaterialUI.SvgIcon; - export var ImageSwitchVideo: __MaterialUI.SvgIcon; - export var ImageTagFaces: __MaterialUI.SvgIcon; - export var ImageTexture: __MaterialUI.SvgIcon; - export var ImageTimelapse: __MaterialUI.SvgIcon; - export var ImageTimer10: __MaterialUI.SvgIcon; - export var ImageTimer3: __MaterialUI.SvgIcon; - export var ImageTimerOff: __MaterialUI.SvgIcon; - export var ImageTimer: __MaterialUI.SvgIcon; - export var ImageTonality: __MaterialUI.SvgIcon; - export var ImageTransform: __MaterialUI.SvgIcon; - export var ImageTune: __MaterialUI.SvgIcon; - export var ImageViewComfy: __MaterialUI.SvgIcon; - export var ImageViewCompact: __MaterialUI.SvgIcon; - export var ImageVignette: __MaterialUI.SvgIcon; - export var ImageWbAuto: __MaterialUI.SvgIcon; - export var ImageWbCloudy: __MaterialUI.SvgIcon; - export var ImageWbIncandescent: __MaterialUI.SvgIcon; - export var ImageWbIridescent: __MaterialUI.SvgIcon; - export var ImageWbSunny: __MaterialUI.SvgIcon; - export var MapsAddLocation: __MaterialUI.SvgIcon; - export var MapsBeenhere: __MaterialUI.SvgIcon; - export var MapsDirectionsBike: __MaterialUI.SvgIcon; - export var MapsDirectionsBoat: __MaterialUI.SvgIcon; - export var MapsDirectionsBus: __MaterialUI.SvgIcon; - export var MapsDirectionsCar: __MaterialUI.SvgIcon; - export var MapsDirectionsRailway: __MaterialUI.SvgIcon; - export var MapsDirectionsRun: __MaterialUI.SvgIcon; - export var MapsDirectionsSubway: __MaterialUI.SvgIcon; - export var MapsDirectionsTransit: __MaterialUI.SvgIcon; - export var MapsDirectionsWalk: __MaterialUI.SvgIcon; - export var MapsDirections: __MaterialUI.SvgIcon; - export var MapsEditLocation: __MaterialUI.SvgIcon; - export var MapsFlight: __MaterialUI.SvgIcon; - export var MapsHotel: __MaterialUI.SvgIcon; - export var MapsLayersClear: __MaterialUI.SvgIcon; - export var MapsLayers: __MaterialUI.SvgIcon; - export var MapsLocalActivity: __MaterialUI.SvgIcon; - export var MapsLocalAirport: __MaterialUI.SvgIcon; - export var MapsLocalAtm: __MaterialUI.SvgIcon; - export var MapsLocalBar: __MaterialUI.SvgIcon; - export var MapsLocalCafe: __MaterialUI.SvgIcon; - export var MapsLocalCarWash: __MaterialUI.SvgIcon; - export var MapsLocalConvenienceStore: __MaterialUI.SvgIcon; - export var MapsLocalDining: __MaterialUI.SvgIcon; - export var MapsLocalDrink: __MaterialUI.SvgIcon; - export var MapsLocalFlorist: __MaterialUI.SvgIcon; - export var MapsLocalGasStation: __MaterialUI.SvgIcon; - export var MapsLocalGroceryStore: __MaterialUI.SvgIcon; - export var MapsLocalHospital: __MaterialUI.SvgIcon; - export var MapsLocalHotel: __MaterialUI.SvgIcon; - export var MapsLocalLaundryService: __MaterialUI.SvgIcon; - export var MapsLocalLibrary: __MaterialUI.SvgIcon; - export var MapsLocalMall: __MaterialUI.SvgIcon; - export var MapsLocalMovies: __MaterialUI.SvgIcon; - export var MapsLocalOffer: __MaterialUI.SvgIcon; - export var MapsLocalParking: __MaterialUI.SvgIcon; - export var MapsLocalPharmacy: __MaterialUI.SvgIcon; - export var MapsLocalPhone: __MaterialUI.SvgIcon; - export var MapsLocalPizza: __MaterialUI.SvgIcon; - export var MapsLocalPlay: __MaterialUI.SvgIcon; - export var MapsLocalPostOffice: __MaterialUI.SvgIcon; - export var MapsLocalPrintshop: __MaterialUI.SvgIcon; - export var MapsLocalSee: __MaterialUI.SvgIcon; - export var MapsLocalShipping: __MaterialUI.SvgIcon; - export var MapsLocalTaxi: __MaterialUI.SvgIcon; - export var MapsMap: __MaterialUI.SvgIcon; - export var MapsMyLocation: __MaterialUI.SvgIcon; - export var MapsNavigation: __MaterialUI.SvgIcon; - export var MapsNearMe: __MaterialUI.SvgIcon; - export var MapsPersonPinCircle: __MaterialUI.SvgIcon; - export var MapsPersonPin: __MaterialUI.SvgIcon; - export var MapsPinDrop: __MaterialUI.SvgIcon; - export var MapsPlace: __MaterialUI.SvgIcon; - export var MapsRateReview: __MaterialUI.SvgIcon; - export var MapsRestaurantMenu: __MaterialUI.SvgIcon; - export var MapsSatellite: __MaterialUI.SvgIcon; - export var MapsStoreMallDirectory: __MaterialUI.SvgIcon; - export var MapsTerrain: __MaterialUI.SvgIcon; - export var MapsTraffic: __MaterialUI.SvgIcon; - export var MapsZoomOutMap: __MaterialUI.SvgIcon; - export var NavigationApps: __MaterialUI.SvgIcon; - export var NavigationArrowBack: __MaterialUI.SvgIcon; - export var NavigationArrowDownward: __MaterialUI.SvgIcon; - export var NavigationArrowDropDownCircle: __MaterialUI.SvgIcon; - export var NavigationArrowDropDown: __MaterialUI.SvgIcon; - export var NavigationArrowDropUp: __MaterialUI.SvgIcon; - export var NavigationArrowForward: __MaterialUI.SvgIcon; - export var NavigationArrowUpward: __MaterialUI.SvgIcon; - export var NavigationCancel: __MaterialUI.SvgIcon; - export var NavigationCheck: __MaterialUI.SvgIcon; - export var NavigationChevronLeft: __MaterialUI.SvgIcon; - export var NavigationChevronRight: __MaterialUI.SvgIcon; - export var NavigationClose: __MaterialUI.SvgIcon; - export var NavigationExpandLess: __MaterialUI.SvgIcon; - export var NavigationExpandMore: __MaterialUI.SvgIcon; - export var NavigationFullscreenExit: __MaterialUI.SvgIcon; - export var NavigationFullscreen: __MaterialUI.SvgIcon; - export var NavigationMenu: __MaterialUI.SvgIcon; - export var NavigationMoreHoriz: __MaterialUI.SvgIcon; - export var NavigationMoreVert: __MaterialUI.SvgIcon; - export var NavigationRefresh: __MaterialUI.SvgIcon; - export var NavigationSubdirectoryArrowLeft: __MaterialUI.SvgIcon; - export var NavigationSubdirectoryArrowRight: __MaterialUI.SvgIcon; - export var NavigationUnfoldLess: __MaterialUI.SvgIcon; - export var NavigationUnfoldMore: __MaterialUI.SvgIcon; - export var NavigationArrowDropRight: __MaterialUI.SvgIcon; - export var NotificationAdb: __MaterialUI.SvgIcon; - export var NotificationAirlineSeatFlatAngled: __MaterialUI.SvgIcon; - export var NotificationAirlineSeatFlat: __MaterialUI.SvgIcon; - export var NotificationAirlineSeatIndividualSuite: __MaterialUI.SvgIcon; - export var NotificationAirlineSeatLegroomExtra: __MaterialUI.SvgIcon; - export var NotificationAirlineSeatLegroomNormal: __MaterialUI.SvgIcon; - export var NotificationAirlineSeatLegroomReduced: __MaterialUI.SvgIcon; - export var NotificationAirlineSeatReclineExtra: __MaterialUI.SvgIcon; - export var NotificationAirlineSeatReclineNormal: __MaterialUI.SvgIcon; - export var NotificationBluetoothAudio: __MaterialUI.SvgIcon; - export var NotificationConfirmationNumber: __MaterialUI.SvgIcon; - export var NotificationDiscFull: __MaterialUI.SvgIcon; - export var NotificationDoNotDisturbAlt: __MaterialUI.SvgIcon; - export var NotificationDoNotDisturb: __MaterialUI.SvgIcon; - export var NotificationDriveEta: __MaterialUI.SvgIcon; - export var NotificationEnhancedEncryption: __MaterialUI.SvgIcon; - export var NotificationEventAvailable: __MaterialUI.SvgIcon; - export var NotificationEventBusy: __MaterialUI.SvgIcon; - export var NotificationEventNote: __MaterialUI.SvgIcon; - export var NotificationFolderSpecial: __MaterialUI.SvgIcon; - export var NotificationLiveTv: __MaterialUI.SvgIcon; - export var NotificationMms: __MaterialUI.SvgIcon; - export var NotificationMore: __MaterialUI.SvgIcon; - export var NotificationNetworkCheck: __MaterialUI.SvgIcon; - export var NotificationNetworkLocked: __MaterialUI.SvgIcon; - export var NotificationNoEncryption: __MaterialUI.SvgIcon; - export var NotificationOndemandVideo: __MaterialUI.SvgIcon; - export var NotificationPersonalVideo: __MaterialUI.SvgIcon; - export var NotificationPhoneBluetoothSpeaker: __MaterialUI.SvgIcon; - export var NotificationPhoneForwarded: __MaterialUI.SvgIcon; - export var NotificationPhoneInTalk: __MaterialUI.SvgIcon; - export var NotificationPhoneLocked: __MaterialUI.SvgIcon; - export var NotificationPhoneMissed: __MaterialUI.SvgIcon; - export var NotificationPhonePaused: __MaterialUI.SvgIcon; - export var NotificationPower: __MaterialUI.SvgIcon; - export var NotificationRvHookup: __MaterialUI.SvgIcon; - export var NotificationSdCard: __MaterialUI.SvgIcon; - export var NotificationSimCardAlert: __MaterialUI.SvgIcon; - export var NotificationSmsFailed: __MaterialUI.SvgIcon; - export var NotificationSms: __MaterialUI.SvgIcon; - export var NotificationSyncDisabled: __MaterialUI.SvgIcon; - export var NotificationSyncProblem: __MaterialUI.SvgIcon; - export var NotificationSync: __MaterialUI.SvgIcon; - export var NotificationSystemUpdate: __MaterialUI.SvgIcon; - export var NotificationTapAndPlay: __MaterialUI.SvgIcon; - export var NotificationTimeToLeave: __MaterialUI.SvgIcon; - export var NotificationVibration: __MaterialUI.SvgIcon; - export var NotificationVoiceChat: __MaterialUI.SvgIcon; - export var NotificationVpnLock: __MaterialUI.SvgIcon; - export var NotificationWc: __MaterialUI.SvgIcon; - export var NotificationWifi: __MaterialUI.SvgIcon; - export var PlacesAcUnit: __MaterialUI.SvgIcon; - export var PlacesAirportShuttle: __MaterialUI.SvgIcon; - export var PlacesAllInclusive: __MaterialUI.SvgIcon; - export var PlacesBeachAccess: __MaterialUI.SvgIcon; - export var PlacesBusinessCenter: __MaterialUI.SvgIcon; - export var PlacesCasino: __MaterialUI.SvgIcon; - export var PlacesChildCare: __MaterialUI.SvgIcon; - export var PlacesChildFriendly: __MaterialUI.SvgIcon; - export var PlacesFitnessCenter: __MaterialUI.SvgIcon; - export var PlacesFreeBreakfast: __MaterialUI.SvgIcon; - export var PlacesGolfCourse: __MaterialUI.SvgIcon; - export var PlacesHotTub: __MaterialUI.SvgIcon; - export var PlacesKitchen: __MaterialUI.SvgIcon; - export var PlacesPool: __MaterialUI.SvgIcon; - export var PlacesRoomService: __MaterialUI.SvgIcon; - export var PlacesSmokeFree: __MaterialUI.SvgIcon; - export var PlacesSmokingRooms: __MaterialUI.SvgIcon; - export var PlacesSpa: __MaterialUI.SvgIcon; - export var SocialCake: __MaterialUI.SvgIcon; - export var SocialDomain: __MaterialUI.SvgIcon; - export var SocialGroupAdd: __MaterialUI.SvgIcon; - export var SocialGroup: __MaterialUI.SvgIcon; - export var SocialLocationCity: __MaterialUI.SvgIcon; - export var SocialMoodBad: __MaterialUI.SvgIcon; - export var SocialMood: __MaterialUI.SvgIcon; - export var SocialNotificationsActive: __MaterialUI.SvgIcon; - export var SocialNotificationsNone: __MaterialUI.SvgIcon; - export var SocialNotificationsOff: __MaterialUI.SvgIcon; - export var SocialNotificationsPaused: __MaterialUI.SvgIcon; - export var SocialNotifications: __MaterialUI.SvgIcon; - export var SocialPages: __MaterialUI.SvgIcon; - export var SocialPartyMode: __MaterialUI.SvgIcon; - export var SocialPeopleOutline: __MaterialUI.SvgIcon; - export var SocialPeople: __MaterialUI.SvgIcon; - export var SocialPersonAdd: __MaterialUI.SvgIcon; - export var SocialPersonOutline: __MaterialUI.SvgIcon; - export var SocialPerson: __MaterialUI.SvgIcon; - export var SocialPlusOne: __MaterialUI.SvgIcon; - export var SocialPoll: __MaterialUI.SvgIcon; - export var SocialPublic: __MaterialUI.SvgIcon; - export var SocialSchool: __MaterialUI.SvgIcon; - export var SocialShare: __MaterialUI.SvgIcon; - export var SocialWhatshot: __MaterialUI.SvgIcon; - export var ToggleCheckBoxOutlineBlank: __MaterialUI.SvgIcon; - export var ToggleCheckBox: __MaterialUI.SvgIcon; - export var ToggleIndeterminateCheckBox: __MaterialUI.SvgIcon; - export var ToggleRadioButtonChecked: __MaterialUI.SvgIcon; - export var ToggleRadioButtonUnchecked: __MaterialUI.SvgIcon; - export var ToggleStarBorder: __MaterialUI.SvgIcon; - export var ToggleStarHalf: __MaterialUI.SvgIcon; - export var ToggleStar: __MaterialUI.SvgIcon; -} \ No newline at end of file diff --git a/material-ui/legacy/material-ui-0.14.4-tests.tsx b/material-ui/legacy/material-ui-0.14.4-tests.tsx deleted file mode 100644 index 0d112fcaa8..0000000000 --- a/material-ui/legacy/material-ui-0.14.4-tests.tsx +++ /dev/null @@ -1,2302 +0,0 @@ -/// -/// -/// - -import * as React from "react"; -import * as LinkedStateMixin from "react-addons-linked-state-mixin"; -import * as MaterialUi from "material-ui"; -import ActionGrade from "material-ui/lib/svg-icons/action/grade"; -import AppBar from "material-ui/lib/app-bar"; -import ArrowDropRight from "material-ui/lib/svg-icons/navigation-arrow-drop-right"; -import AutoComplete from 'material-ui/lib/auto-complete'; -import Avatar from "material-ui/lib/avatar"; -import Badge from "material-ui/lib/badge"; -import Card from "material-ui/lib/card/card"; -import CardActions from "material-ui/lib/card/card-actions"; -import CardHeader from "material-ui/lib/card/card-header"; -import CardMedia from 'material-ui/lib/card/card-media'; -import CardText from "material-ui/lib/card/card-text"; -import CardTitle from 'material-ui/lib/card/card-title'; -import Checkbox from "material-ui/lib/checkbox"; -import CircularProgress from 'material-ui/lib/circular-progress'; -import ColorManipulator from 'material-ui/lib/utils/color-manipulator'; -import Colors from "material-ui/lib/styles/colors"; -import DatePicker from "material-ui/lib/date-picker/date-picker"; -import Dialog from "material-ui/lib/dialog"; -import Divider from 'material-ui/lib/divider'; -import DropDownMenu from "material-ui/lib/drop-down-menu"; -import FileFolder from "material-ui/lib/svg-icons/file/folder"; -import FlatButton from "material-ui/lib/flat-button"; -import FloatingActionButton from "material-ui/lib/floating-action-button"; -import FontIcon from "material-ui/lib/font-icon"; -import GridList from 'material-ui/lib/grid-list/grid-list'; -import GridTile from 'material-ui/lib/grid-list/grid-tile'; -import IconButton from "material-ui/lib/icon-button"; -import IconMenu from "material-ui/lib/menus/icon-menu"; -import LeftNav from 'material-ui/lib/left-nav'; -import LinearProgress from 'material-ui/lib/linear-progress'; -import List from 'material-ui/lib/lists/list'; -import ListItem from 'material-ui/lib/lists/list-item'; -import Menu from 'material-ui/lib/menus/menu'; -import MenuItem from 'material-ui/lib/menus/menu-item'; -import Paper from 'material-ui/lib/paper'; -import Popover from 'material-ui/lib/popover/popover'; -import PopoverAnimationFromTop from 'material-ui/lib/popover/popover-animation-from-top'; -import RadioButton from "material-ui/lib/radio-button"; -import RadioButtonGroup from "material-ui/lib/radio-button-group"; -import RaisedButton from "material-ui/lib/raised-button"; -import RefreshIndicator from 'material-ui/lib/refresh-indicator'; -import SelectField from "material-ui/lib/select-field"; -import Slider from 'material-ui/lib/slider'; -import Snackbar from 'material-ui/lib/snackbar'; -import Spacing from "material-ui/lib/styles/spacing"; -import Styles from 'material-ui/lib/styles'; -import SvgIcon from 'material-ui/lib/svg-icon'; -import Tab from 'material-ui/lib/tabs/tab'; -import Table from 'material-ui/lib/table/table'; -import TableBody from 'material-ui/lib/table/table-body'; -import TableFooter from 'material-ui/lib/table/table-footer'; -import TableHeader from 'material-ui/lib/table/table-header'; -import TableHeaderColumn from 'material-ui/lib/table/table-header-column'; -import TableRow from 'material-ui/lib/table/table-row'; -import TableRowColumn from 'material-ui/lib/table/table-row-column'; -import Tabs from 'material-ui/lib/tabs/tabs'; -import TextField from "material-ui/lib/text-field"; -import ThemeDecorator from 'material-ui/lib/styles/theme-decorator'; -import ThemeManager from 'material-ui/lib/styles/theme-manager'; -import TimePicker from "material-ui/lib/time-picker"; -import Toggle from "material-ui/lib/toggle"; -import ToggleStar from "material-ui/lib/svg-icons/toggle/star"; -import ToggleStarBorder from "material-ui/lib/svg-icons/toggle/star-border"; -import Toolbar from 'material-ui/lib/toolbar/toolbar'; -import ToolbarGroup from 'material-ui/lib/toolbar/toolbar-group'; -import ToolbarSeparator from 'material-ui/lib/toolbar/toolbar-separator'; -import ToolbarTitle from 'material-ui/lib/toolbar/toolbar-title'; -import Typography from "material-ui/lib/styles/typography"; -import zIndex from 'material-ui/lib/styles/zIndex'; - -import {SelectableContainerEnhance} from 'material-ui/lib/hoc/selectable-enhance'; - -import * as Icons from "material-ui/lib/svg-icons"; -import ActionAndroid from 'material-ui/lib/svg-icons/action/android'; -import ActionFavorite from 'material-ui/lib/svg-icons/action/favorite'; -import ActionFavoriteBorder from 'material-ui/lib/svg-icons/action/favorite-border'; -import ActionFlightTakeoff from 'material-ui/lib/svg-icons/action/flight-takeoff'; -import ActionHome from 'material-ui/lib/svg-icons/action/home'; -import ActionInfo from 'material-ui/lib/svg-icons/action/info'; -import CommunicationChatBubble from 'material-ui/lib/svg-icons/communication/chat-bubble'; -import ContentAdd from 'material-ui/lib/svg-icons/content/add'; -import ContentCopy from 'material-ui/lib/svg-icons/content/content-copy'; -import ContentDrafts from 'material-ui/lib/svg-icons/content/drafts'; -import ContentFilter from 'material-ui/lib/svg-icons/content/filter-list'; -import ContentInbox from 'material-ui/lib/svg-icons/content/inbox'; -import ContentLink from 'material-ui/lib/svg-icons/content/link'; -import ContentSend from 'material-ui/lib/svg-icons/content/send'; -import Delete from 'material-ui/lib/svg-icons/action/delete'; -import Download from 'material-ui/lib/svg-icons/file/file-download'; -import FileCloudDownload from 'material-ui/lib/svg-icons/file/cloud-download'; -import FolderIcon from 'material-ui/lib/svg-icons/file/folder-open'; -import HardwareVideogameAsset from 'material-ui/lib/svg-icons/hardware/videogame-asset'; -import MapsPlace from 'material-ui/lib/svg-icons/maps/place'; -import MoreVertIcon from 'material-ui/lib/svg-icons/navigation/more-vert'; -import NavigationClose from "material-ui/lib/svg-icons/navigation/close"; -import NavigationExpandMoreIcon from 'material-ui/lib/svg-icons/navigation/expand-more'; -import NotificationsIcon from 'material-ui/lib/svg-icons/social/notifications'; -import PersonAdd from 'material-ui/lib/svg-icons/social/person-add'; -import RemoveRedEye from 'material-ui/lib/svg-icons/image/remove-red-eye'; -import StarBorder from 'material-ui/lib/svg-icons/toggle/star-border'; -import UploadIcon from 'material-ui/lib/svg-icons/file/cloud-upload'; - - -type CheckboxProps = __MaterialUI.CheckboxProps; -type MuiTheme = __MaterialUI.Styles.MuiTheme; -type TouchTapEvent = __MaterialUI.TouchTapEvent; - -interface MaterialUiTestsState { - showDialogStandardActions: boolean; - showDialogCustomActions: boolean; - showDialogScrollable: boolean; - value: number; - dataSource: [string]; - minDate: Date; - maxDate: Date; - autoOk: boolean; - disableYearSelection: boolean; - open: boolean; - valueSingle: string; - valueMultiple: string[]; - anchorEl: Element; - completed: number; - message: string; - autoHideDuration: number; - fixedHeader: boolean; - fixedFooter: boolean; - stripedRows: boolean; - showRowHover: boolean; - selectable: boolean; - multiSelectable: boolean; - enableSelectAll: boolean; - deselectOnClickaway: boolean; - height: string; -} - -// "http://www.material-ui.com/#/customization/themes" -let muiTheme: MuiTheme = ThemeManager.getMuiTheme({ - spacing: Spacing, - zIndex: zIndex, - fontFamily: 'Roboto, sans-serif', - palette: { - primary1Color: Colors.cyan500, - primary2Color: Colors.cyan700, - primary3Color: Colors.lightBlack, - accent1Color: Colors.pinkA200, - accent2Color: Colors.grey100, - accent3Color: Colors.grey500, - textColor: Colors.darkBlack, - alternateTextColor: Colors.white, - canvasColor: Colors.white, - borderColor: Colors.grey300, - disabledColor: ColorManipulator.fade(Colors.darkBlack, 0.3), - pickerHeaderColor: Colors.cyan500, - } -}); - -let SelectableList = SelectableContainerEnhance(List); - -@ThemeDecorator(muiTheme) -class MaterialUiTests extends React.Component<{}, MaterialUiTestsState> implements React.LinkedStateMixin { - - // injected with mixin - linkState: (key: string) => React.ReactLink; - - private picker12hr: TimePicker; - private picker24hr: TimePicker; - - private touchTapEventHandler(e: TouchTapEvent) { - console.info("Received touch tap", e); - } - private formEventHandler(e: React.FormEvent) { - } - private selectFieldChangeHandler(e: TouchTapEvent, si: number, mi: any) { - } - private handleRequestClose(buttonClicked: boolean) { - } - private handleRequestCloseReason(reason: string) { - } - private handleToggle() { - this.setState(Object.assign({}, this.state, { open: !this.state.open })); - } - private handleClose() { - this.setState(Object.assign({}, this.state, { open: false })); - } - private handleChangeSingle(event: React.MouseEvent, value: string){ - } - private handleChangeMultiple(event: React.MouseEvent, value: string[]) { - } - - private handleChange = (e: TouchTapEvent, index: number, value: number) => this.setState(Object.assign({}, this.state, { value })); - - private handleUpdateInput(t: string) { - this.setState(Object.assign({}, this.state, { - dataSource: [t, t + t, t + t + t], - })); - } - private handleTouchTap(e: TouchTapEvent) { - alert('onTouchTap triggered on the title component'); - } - private handleActionTouchTap() { - this.setState(Object.assign({}, this.state, {open: false,})); - alert('Event removed from your calendar.'); - } - private handleChangeDuration = (event: React.FormEvent) => { - const value = event.target["value"]; - this.setState(Object.assign({}, this.state, { - autoHideDuration: value.length > 0 ? parseInt(value) : 0, - })); - } - private onRowSelection(selectedRows: number[] | string) { - } - private handleActive(tab: Tab) { - alert(`A tab with this route property ${tab.props.value} was activated.`); - } - private handleChangeTabs(value: any, e: React.FormEvent, tab: Tab) { - } - private handleChangeTimePicker12(err, time) { - this.picker12hr.setTime(time); - }; - - private handleChangeTimePicker24(err, time) { - this.picker24hr.setTime(time); - }; - - render() { - - const styles = { - title: { - cursor: 'pointer', - }, - exampleImageInput: { - cursor: 'pointer', - position: 'absolute', - top: 0, - bottom: 0, - right: 0, - left: 0, - width: '100%', - opacity: 0, - }, - button: { - margin: 12, - }, - floatingButton: { - marginRight: 20, - }, - textField: { - marginLeft: 20, - }, - floatLeft: { - float: 'left', - }, - root: { - display: 'flex', - flexWrap: 'wrap', - justifyContent: 'space-around', - }, - gridList: { - width: 500, - height: 400, - overflowY: 'auto', - marginBottom: 24, - }, - icons: { - marginRight: 24, - }, - menu: { - marginRight: 32, - marginBottom: 32, - float: 'left', - position: 'relative', - zIndex: 0, - }, - rightIcon: { - textAlign: 'center', - lineHeight: '24px', - }, - paper: { - height: 100, - width: 100, - margin: 20, - textAlign: 'center', - display: 'inline-block', - }, - popover: { - padding: 20, - }, - container: { - position: 'relative', - }, - refresh: { - display: 'inline-block', - position: 'relative', - }, - block: { - maxWidth: 250, - }, - checkbox: { - marginBottom: 16, - }, - radioButton: { - marginBottom: 16, - }, - toggle: { - marginBottom: 16, - }, - propContainerStyle: { - width: 200, - overflow: 'hidden', - margin: '20px auto 0', - }, - propToggleHeader: { - margin: '20px auto 10px', - }, - headline: { - fontSize: 24, - paddingTop: 16, - marginBottom: 12, - fontWeight: 400, - }, - errorStyle: { - color: Colors.orange500, - }, - underlineStyle: { - borderColor: Colors.orange500, - }, - }; - const colors = Styles.Colors; - - // "http://www.material-ui.com/#/customization/inline-styles" - let element: React.ReactElement; - element = - element = React.createElement(Checkbox, { - id: "checkboxId1", name: "checkboxName1", value: "checkboxValue1", label: "went for a run today", style: { - width: '50%', - margin: '0 auto' - }, iconStyle: { - fill: '#FF4081' - } - }); - - // "http://www.material-ui.com/#/components/app-bar" - const AppBarExampleIcon = () => ( - - ); - - const AppBarExampleIconButton = () => ( - Title} - onTitleTouchTap={this.handleTouchTap} - iconElementLeft={} - iconElementRight={} - /> - ); - const AppBarExampleIconMenu = () => ( - } - iconElementRight={ - - } - targetOrigin={{ horizontal: 'right', vertical: 'top' }} - anchorOrigin={{ horizontal: 'right', vertical: 'top' }} - > - - - - - } - /> - ); - - // "http://www.material-ui.com/#/components/auto-complete" - element = - - const dataSource1 = [ - { - text: 'text-value1', - value: ( - - ), - }, - { - text: 'text-value2', - value: ( - - ), - }, - ]; - - const dataSource2 = ['12345', '23456', '34567']; - - const AutoCompleteExampleNoFilter = () => ( -
-
- -
- ); - - const AutoCompleteExampleFilters = () => ( -
- -
- -
- ); - - // "http://www.material-ui.com/#/components/avatar" - const AvatarExampleSimple = () => ( - - - } - > - Image Avatar - - } /> - } - > - FontIcon Avatar - - } - color={colors.blue300} - backgroundColor={colors.indigo900} - /> - } - > - FontIcon Avatar with custom colors - - } /> - } - > - SvgIcon Avatar - - } - color={colors.orange200} - backgroundColor={colors.pink400} - /> - } - > - SvgIcon Avatar with custom colors - - A} - > - Letter Avatar - - - A - - } - > - Letter Avatar with custom colors - - - ); - - //image avatar - element = ; - //SvgIcon avatar - element = } />; - //SvgIcon avatar with custom colors - element = } - color={Colors.orange200} - backgroundColor={Colors.pink400} />; - //FontIcon avatar - element = - } />; - //FontIcon avatar with custom colors - element = } - color={Colors.blue300} - backgroundColor={Colors.indigo900} />; - //Letter avatar - element = A; - //Letter avatar with custom colors - element = - - - // "http://www.material-ui.com/#/components/badge" - const BadgeExampleSimple = () => ( -
- - - - - - - - -
- ); - const BadgeExampleContent = () => ( -
- } - > - - - - Company Name - -
- ); - - // "http://www.material-ui.com/#/components/flat-button" - const FlatButtonExampleSimple = () => ( -
- - - - -
- ); - const FlatButtonExampleComplex = () => ( -
- - - - - } - /> - - } - /> - -
- ); - - // "http://www.material-ui.com/#/components/raised-button" - const RaisedButtonExampleSimple = () => ( -
- - - - -
- ); - const RaisedButtonExampleComplex = () => ( -
- - - - } - style={styles.button} - /> - } - /> -
- ); - - // "http://www.material-ui.com/#/components/floating-action-button" - const FloatingActionButtonExampleSimple = () => ( -
- - - - - - - - - - - - - - - - - - - - - - - -
- ); - - // "http://www.material-ui.com/#/components/icon-button" - const IconButtonExampleSimple = () => ( -
- - -
- ); - const IconButtonExampleComplex = () => ( -
- - - - - - - - - - home - -
- ); - const IconButtonExampleTooltip = () => ( -
- - - - - - -
- ); - const IconButtonExampleTouch = () => ( -
- - - - - - - - - - - - - - - - - - -
- ); - //Method 1: muidocs-icon-github is defined in a style sheet. - element = ; - //Method 2: ActionGrade is a component created using mui.SvgIcon. - element = - - ; - //Method 3: Manually creating a mui.FontIcon component within IconButton - element = - - ; - //Method 4: Using Google material-icons - element = settings_system_daydream; - - - // "http://www.material-ui.com/#/components/card" - const CardExampleWithAvatar = () => ( - - - } - > - - - - - Lorem ipsum dolor sit amet, consectetur adipiscing elit. - Donec mattis pretium massa.Aliquam erat volutpat.Nulla facilisi. - Donec vulputate interdum sollicitudin.Nunc lacinia auctor quam sed pellentesque. - Aliquam dui mauris, mattis quis lacus id, pellentesque lobortis odio. - - - - - - - ); - const CardExampleWithoutAvatar = () => ( - - - - Lorem ipsum dolor sit amet, consectetur adipiscing elit. - Donec mattis pretium massa.Aliquam erat volutpat.Nulla facilisi. - Donec vulputate interdum sollicitudin.Nunc lacinia auctor quam sed pellentesque. - Aliquam dui mauris, mattis quis lacus id, pellentesque lobortis odio. - - - - - - - ); - - // "http://www.material-ui.com/#/components/date-picker" - const DatePickerExampleSimple = () => ( -
- - - -
- ); - const DatePickerExampleInline = () => ( -
- - -
- ); - element = ( -
- -
- ); - element = ; - element = ; - element = ; - - // "http://material-ui.com/#/components/dialog" - let standardActions = [ - { text: 'Cancel' }, - { text: 'Submit', onTouchTap: this.touchTapEventHandler, ref: 'submit' } - ]; - - element = - The actions in this window are created from the json that's passed in. - ; - - //Custom Actions - let customActions = [ - , - - ]; - - element = - The actions in this window were passed in as an array of react objects. - ; - - element = -
- Really long content -
- ; - - // "http://www.material-ui.com/#/components/divider" - const DividerExampleForm = () => ( - - - - - - - - - - - ); - const DividerExampleList = () => ( -
- - - - - - - - - -
- ); - const DividerExampleMenu = () => ( - - - - - - - ); - - - // "http://www.material-ui.com/#/components/grid-list" - const tilesData = [ - { - img: 'images/grid-list/00-52-29-429_640.jpg', - title: 'Breakfast', - author: 'jill111', - featured: false, - }]; - const GridListExampleSimple = () => ( -
- - {tilesData.map(tile => ( - by {tile.author}} - actionIcon={} - > - - - )) } - -
- ); - const GridListExampleComplex = () => ( -
- - {tilesData.map(tile => ( - } - actionPosition="left" - titlePosition="top" - titleBackground="linear-gradient(to bottom, rgba(0,0,0,0.7) 0%,rgba(0,0,0,0.3) 70%,rgba(0,0,0,0) 100%)" - cols={tile.featured ? 2 : 1} - rows={tile.featured ? 2 : 1} - > - - - )) } - -
- ); - - - element = ; - - element = GridTile} - actionPosition="left" - titlePosition="top" - titleBackground="rgba(0, 0, 0, 0.4)" - cols={2} - rows={1} - style={{ color: 'red' }}> -

Children are Required!

- ; - - - // "http://www.material-ui.com/#/components/font-icon" - const FontIconExampleSimple = () => ( -
- - - - - -
- ); - - const FontIconExampleIcons = () => ( -
- home - flight_takeoff - cloud_download - videogame_asset -
- ); - - - // "http://www.material-ui.com/#/components/svg-icon" - const HomeIcon = (props) => ( - - - - ); - - const SvgIconExampleSimple = () => ( -
- - - -
- ); - const SvgIconExampleIcons = () => ( -
- - - - -
- ); - element = ; - element = ; - element = home; - - - // "http://www.material-ui.com/#/components/left-nav" - element = ( -
- - - Menu Item - Menu Item 2 - -
- ); - element = ( -
- - this.setState(Object.assign({}, this.state, { open })) } - > - Menu Item - Menu Item 2 - -
- ); - element = ( -
- - - - -
- ); - - - // "http://material-ui.com/#/components/lists" - const ListExampleSimple = () => ( -
- - } /> - } /> - } /> - } /> - } /> - - - - } /> - } /> - } /> - } /> - -
- ); - const ListExampleChat = () => ( -
- - } - rightIcon={} - /> - } - rightIcon={} - /> - } - rightIcon={} - /> - } - rightIcon={} - /> - } - rightIcon={} - /> - - - - } - /> - } - /> - -
- ); - const ListExampleNested = () => ( -
- - } /> - } /> - } - initiallyOpen={true} - primaryTogglesNestedList={true} - nestedItems={[ - } - />, - } - disabled={true} - nestedItems={[ - } />, - ]} - />, - ]} - /> - -
- ); - const iconButtonElement = ( - - - - ); - const rightIconMenu = ( - - Reply - Forward - Delete - - ); - const ListExampleMessages = () => ( -
- - } - rightIconButton={rightIconMenu} - primaryText="Brendan Lim" - secondaryText={ -

- Brunch this weekend?
- I' ll be in your neighborhood doing errands this weekend.Do you want to grab brunch? -

- } - secondaryTextLines={2} - /> - -
- ); - const ListExampleSelectable = () => ( -
- - } - nestedItems={[ - } - />, - ]} - /> - } - /> - } - /> - } - /> - -
- ); - - - // "http://www.material-ui.com/#/components/menu" - const MenuExampleSimple = () => ( -
- - - - - - - - - - - - -
- ); - const MenuExampleDisable = () => ( -
- - - - - - - - - - - - - - - - -
- ); - const MenuExampleIcons = () => ( -
- - } /> - } /> - } /> - - } /> - } /> - - } /> - - - - } /> - settings}/> - settings - } - /> - ¶} /> - §} /> - -
- ); - const MenuExampleSecondary = () => ( -
- - - - - - - - - } /> - } /> - } /> - } /> - } /> - - - - - - - - - - - - - -
- ); - const MenuExampleNested = () => ( -
- - - - - } - menuItems={[ - } - menuItems={[ - , - , - , - , - ]} - />, - , - , - , - ]} - /> - - - - - - -
- ); - - - // "http://www.material-ui.com/#/components/icon-menu" - const IconMenuExampleSimple = () => ( -
- } - anchorOrigin={{ horizontal: 'left', vertical: 'top' }} - targetOrigin={{ horizontal: 'left', vertical: 'top' }} - > - - - - - - - } - anchorOrigin={{ horizontal: 'left', vertical: 'bottom' }} - targetOrigin={{ horizontal: 'left', vertical: 'bottom' }} - > - - - - - - - } - anchorOrigin={{ horizontal: 'right', vertical: 'bottom' }} - targetOrigin={{ horizontal: 'right', vertical: 'bottom' }} - > - - - - - - - } - anchorOrigin={{ horizontal: 'right', vertical: 'top' }} - targetOrigin={{ horizontal: 'right', vertical: 'top' }} - > - - - - - - -
- ); - element = ( -
- } - onChange={this.handleChangeSingle} - value={this.state.valueSingle} - > - - - - - - - } - onChange={this.handleChangeMultiple} - value={this.state.valueMultiple} - multiple={true} - > - - - - - - - -
- ); - const IconMenuExampleScrollable = () => ( - } - anchorOrigin={{ horizontal: 'left', vertical: 'top' }} - targetOrigin={{ horizontal: 'left', vertical: 'top' }} - maxHeight={272} - > - - - - ); - - - // "http://www.material-ui.com/#/components/dropdown-menu" - element = - - - - - - ; - const menuItems = []; - element = ( - - {menuItems} - - ); - element = ( - - - - - - - ); - - // "http://material-ui.com/#/components/paper" - const PaperExampleSimple = () => ( -
- - - - - -
- ); - const PaperExampleRounded = () => ( -
- - - - - -
- ); - const PaperExampleCircle = () => ( -
- - - - - -
- ); - - - // "http://www.material-ui.com/#/components/popover" - element = ( -
- - -
- -
- -
- ); - element = ( -
- - -
- -
- -
- ); - - - // "http://www.material-ui.com/#/components/circular-progress" - const CircularProgressExampleSimple = () => ( -
- - - -
- ); - element = ( -
- - - -
- ); - - - // "http://www.material-ui.com/#/components/linear-progress" - const LinearProgressExampleSimple = () => ( - - ); - element = ( - - ); - - - // "http://www.material-ui.com/#/components/refresh-indicator" - const RefreshIndicatorExampleSimple = () => ( -
- - - - -
- ); - const RefreshIndicatorExampleLoading = () => ( -
- - -
- ); - - - // "http://www.material-ui.com/#/components/select-field" - element = ( -
- - - - - - - -
- - - - -
- ); - element = ( - - {menuItems} - - ); - element = ( - - - - - - - ); - element = ( -
- - {menuItems} - -
- - {menuItems} - -
- ); - const {value} = this.state; - const night = value === 2 || value === 3; - element = ( -
- - {menuItems} - -
- - {menuItems} - -
- ); - - - // "http://www.material-ui.com/#/components/slider" - const SliderExampleSimple = () => ( -
- - - -
- ); - const SliderExampleDisabled = () => ( -
- - - -
- ); - const SliderExampleStep = () => ( - - ); - - - // "http://www.material-ui.com/#/components/checkbox" - const CheckboxExampleSimple = () => ( -
- - - - } - unCheckedIcon={} - label="Custom icon" - style={styles.checkbox} - /> - -
- ); - - - // "http://www.material-ui.com/#/components/radio-button" - const RadioButtonExampleSimple = () => ( -
- - - - - - - - - -
- ); - - - // "http://www.material-ui.com/#/components/toggle" - const ToggleExampleSimple = () => ( -
- - - - -
- ); - - - // "http://material-ui.com/#/components/snackbar" - element = ( -
- - -
- ); - element = ( -
- -
- - -
- ); - - // "http://www.material-ui.com/#/components/table" - element = ( -
- - - ID - Name - Status - - - - - 1 - John Smith - Employed - - - 2 - Randal White - Unemployed - - - 3 - Stephanie Sanders - Employed - - - 4 - Steve Brown - Employed - - -
- ); - const tableData = [ - { - name: 'John Smith', - status: 'Employed', - selected: true, - }, - ]; - element = ( -

- - - - - Super Header - - - - ID - Name - Status - - - - {tableData.map( (row, index) => ( - - {index} - {row.name} - {row.status} - - ))} - - - - ID - Name - Status - - - - Super Footer - - - -
- -
-

Table Properties

- - - - - - -

TableBody Properties

- - - -
-
- ); - - // "http://www.material-ui.com/#/components/tabs" - const TabsExampleSimple = () => ( - - -
-

Tab One

-

- This is an example tab. -

-

- You can put any sort of HTML or react component in here. It even keeps the component state! -

- -
- - -
-

Tab Two

-

- This is another example tab. -

-
- - -
-

Tab Three

-

- This is a third example tab. -

-
- - - ); - element = ( - - -
-

Controllable Tab A

-

- Tabs are also controllable if you want to programmatically pass them their values. - This allows for more functionality in Tabs such as not - having any Tab selected or assigning them different values. -

-
- - -
-

Controllable Tab B

-

- This is another example of a controllable tab. Remember, if you - use controllable Tabs, you need to give all of your tabs values or else - you wont be able to select them. -

-
- - - ); - const TabsExampleIcon = () => ( - - } /> - } /> - favorite} /> - - ); - - // "http://www.material-ui.com/#/components/text-field" - const TextFieldExampleSimple = () => ( -
-
-
-
-
-
-
-
- -
- ); - const TextFieldExampleError = () => ( -
-
-
-
-
-
- ); - const TextFieldExampleCustomize = () => ( -
-
-
-
- -
- ); - const TextFieldExampleDisabled = () => ( -
-
-
-
- -
- ); - element = ; - - - // "http://www.material-ui.com/#/components/time-picker" - const TimePickerExampleSimple = () => ( -
- - -
- ); - element = ( -
- this.picker12hr = t} - format="ampm" - hintText="12hr Format" - onChange={this.handleChangeTimePicker12} - /> - this.picker24hr = t} - format="24hr" - hintText="24hr Format" - onChange={this.handleChangeTimePicker24} - /> -
- ); - - // "http://www.material-ui.com/#/components/toolbar" - const ToolbarExamplesSimple = () => ( - - - - - - - - - - - - - - - - - - - } - > - - - - - - - - ); - - return element; - } -} diff --git a/material-ui/legacy/material-ui-0.14.4.d.ts b/material-ui/legacy/material-ui-0.14.4.d.ts deleted file mode 100644 index 1d28878b08..0000000000 --- a/material-ui/legacy/material-ui-0.14.4.d.ts +++ /dev/null @@ -1,8246 +0,0 @@ -// Type definitions for material-ui v0.14.4 -// Project: https://github.com/callemall/material-ui -// Definitions by: Nathan Brown , Oliver Herrmann -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -/// - -declare module "material-ui" { - export import AppBar = __MaterialUI.AppBar; // require('material-ui/lib/app-bar'); - export import AppCanvas = __MaterialUI.AppCanvas; // require('material-ui/lib/app-canvas'); - export import AutoComplete = __MaterialUI.AutoComplete; // require('material-ui/lib/auto-complete'); - export import Avatar = __MaterialUI.Avatar; // require('material-ui/lib/avatar'); - export import Badge = __MaterialUI.Badge; // require('material-ui/lib/badge'); - export import BeforeAfterWrapper = __MaterialUI.BeforeAfterWrapper; // require('material-ui/lib/before-after-wrapper'); - export import Card = __MaterialUI.Card.Card; // require('material-ui/lib/card/card'); - export import CardActions = __MaterialUI.Card.CardActions; // require('material-ui/lib/card/card-actions'); - export import CardExpandable = __MaterialUI.Card.CardExpandable; // require('material-ui/lib/card/card-expandable'); - export import CardHeader = __MaterialUI.Card.CardHeader; // require('material-ui/lib/card/card-header'); - export import CardMedia = __MaterialUI.Card.CardMedia; // require('material-ui/lib/card/card-media'); - export import CardText = __MaterialUI.Card.CardText; // require('material-ui/lib/card/card-text'); - export import CardTitle = __MaterialUI.Card.CardTitle; // require('material-ui/lib/card/card-title'); - export import Checkbox = __MaterialUI.Checkbox; // require('material-ui/lib/checkbox'); - export import CircularProgress = __MaterialUI.CircularProgress; // require('material-ui/lib/circular-progress'); - export import ClearFix = __MaterialUI.ClearFix; // require('material-ui/lib/clearfix'); - export import DatePicker = __MaterialUI.DatePicker.DatePicker; // require('material-ui/lib/date-picker/date-picker'); - export import DatePickerDialog = __MaterialUI.DatePicker.DatePickerDialog; // require('material-ui/lib/date-picker/date-picker-dialog'); - export import Dialog = __MaterialUI.Dialog // require('material-ui/lib/dialog'); - export import Divider = __MaterialUI.Divider // require('material-ui/lib/divider'); - export import DropDownMenu = __MaterialUI.Menus.DropDownMenu; // require('material-ui/lib/DropDownMenu/DropDownMenu'); - export import EnhancedButton = __MaterialUI.EnhancedButton; // require('material-ui/lib/enhanced-button'); - export import FlatButton = __MaterialUI.FlatButton; // require('material-ui/lib/flat-button'); - export import FloatingActionButton = __MaterialUI.FloatingActionButton; // require('material-ui/lib/floating-action-button'); - export import FontIcon = __MaterialUI.FontIcon; // require('material-ui/lib/font-icon'); - export import GridList = __MaterialUI.GridList.GridList; // require('material-ui/lib/gridlist/grid-list'); - export import GridTile = __MaterialUI.GridList.GridTile; // require('material-ui/lib/gridlist/grid-tile'); - export import IconButton = __MaterialUI.IconButton; // require('material-ui/lib/icon-button'); - export import IconMenu = __MaterialUI.Menus.IconMenu; // require('material-ui/lib/menus/icon-menu'); - export import LeftNav = __MaterialUI.LeftNav; // require('material-ui/lib/left-nav'); - export import LinearProgress = __MaterialUI.LinearProgress; // require('material-ui/lib/linear-progress'); - export import List = __MaterialUI.Lists.List; // require('material-ui/lib/lists/list'); - export import ListDivider = __MaterialUI.Lists.ListDivider; // require('material-ui/lib/lists/list-divider'); - export import ListItem = __MaterialUI.Lists.ListItem; // require('material-ui/lib/lists/list-item'); - export import Menu = __MaterialUI.Menus.Menu; // require('material-ui/lib/menus/menu'); - export import MenuItem = __MaterialUI.Menus.MenuItem; // require('material-ui/lib/menus/menu-item'); - export import Mixins = __MaterialUI.Mixins; // require('material-ui/lib/mixins'); - export import Overlay = __MaterialUI.Overlay; // require('material-ui/lib/overlay'); - export import Paper = __MaterialUI.Paper; // require('material-ui/lib/paper'); - export import Popover = __MaterialUI.Popover.Popover; // require('material-ui/lib/popover/popover'); - export import RadioButton = __MaterialUI.RadioButton; // require('material-ui/lib/radio-button'); - export import RadioButtonGroup = __MaterialUI.RadioButtonGroup; // require('material-ui/lib/radio-button-group'); - export import RaisedButton = __MaterialUI.RaisedButton; // require('material-ui/lib/raised-button'); - export import RefreshIndicator = __MaterialUI.RefreshIndicator; // require('material-ui/lib/refresh-indicator'); - export import Ripples = __MaterialUI.Ripples; // require('material-ui/lib/ripples'); - export import SelectField = __MaterialUI.SelectField; // require('material-ui/lib/select-field'); - export import SelectableContainerEnhance = __MaterialUI.Hoc.SelectableContainerEnhance; // require('material-ui/lib/hoc/selectable-enhance'); - export import Slider = __MaterialUI.Slider; // require('material-ui/lib/slider'); - export import SvgIcon = __MaterialUI.SvgIcon; // require('material-ui/lib/svg-icon'); - export import Styles = __MaterialUI.Styles; // require('material-ui/lib/styles'); - export import Snackbar = __MaterialUI.Snackbar; // require('material-ui/lib/snackbar'); - export import Tab = __MaterialUI.Tabs.Tab; // require('material-ui/lib/tabs/tab'); - export import Tabs = __MaterialUI.Tabs.Tabs; // require('material-ui/lib/tabs/tabs'); - export import Table = __MaterialUI.Table.Table; // require('material-ui/lib/table/table'); - export import TableBody = __MaterialUI.Table.TableBody; // require('material-ui/lib/table/table-body'); - export import TableFooter = __MaterialUI.Table.TableFooter; // require('material-ui/lib/table/table-footer'); - export import TableHeader = __MaterialUI.Table.TableHeader; // require('material-ui/lib/table/table-header'); - export import TableHeaderColumn = __MaterialUI.Table.TableHeaderColumn; // require('material-ui/lib/table/table-header-column'); - export import TableRow = __MaterialUI.Table.TableRow; // require('material-ui/lib/table/table-row'); - export import TableRowColumn = __MaterialUI.Table.TableRowColumn; // require('material-ui/lib/table/table-row-column'); - export import Toggle = __MaterialUI.Toggle; // require('material-ui/lib/toggle'); - export import ThemeWrapper = __MaterialUI.ThemeWrapper; // require('material-ui/lib/theme-wrapper'); - export import TimePicker = __MaterialUI.TimePicker; // require('material-ui/lib/time-picker'); - export import TextField = __MaterialUI.TextField; // require('material-ui/lib/text-field'); - export import Toolbar = __MaterialUI.Toolbar.Toolbar; // require('material-ui/lib/toolbar/toolbar'); - export import ToolbarGroup = __MaterialUI.Toolbar.ToolbarGroup; // require('material-ui/lib/toolbar/toolbar-group'); - export import ToolbarSeparator = __MaterialUI.Toolbar.ToolbarSeparator; // require('material-ui/lib/toolbar/toolbar-separator'); - export import ToolbarTitle = __MaterialUI.Toolbar.ToolbarTitle; // require('material-ui/lib/toolbar/toolbar-title'); - export import Tooltip = __MaterialUI.Tooltip; // require('material-ui/lib/tooltip'); - export import Utils = __MaterialUI.Utils; // require('material-ui/lib/utils'); - - // svg icons - import NavigationMenu = __MaterialUI.SvgIcon; // require('material-ui/lib/svg-icon/navigation/menu'); - import NavigationChevronLeft = __MaterialUI.SvgIcon; // require('material-ui/lib/svg-icon/navigation/chevron-left'); - import NavigationChevronRight = __MaterialUI.SvgIcon; // require('material-ui/lib/svg-icon/navigation/chevron-right'); - - export const Icons: { - NavigationMenu: NavigationMenu, - NavigationChevronLeft: NavigationChevronLeft, - NavigationChevronRight: NavigationChevronRight, - }; - - // export type definitions - export type TouchTapEvent = __MaterialUI.TouchTapEvent; - export type TouchTapEventHandler = __MaterialUI.TouchTapEventHandler; - export type DialogAction = __MaterialUI.DialogAction; -} - -declare namespace __MaterialUI { - export import React = __React; - - // ReactLink is from "react/addons" - interface ReactLink { - value: T; - requestChange(newValue: T): void; - } - - // What's common between React.TouchEvent and React.MouseEvent - interface TouchTapEvent extends React.SyntheticEvent { - altKey: boolean; - ctrlKey: boolean; - getModifierState(key: string): boolean; - metaKey: boolean; - shiftKey: boolean; - } - - // What's common between React.TouchEventHandler and React.MouseEventHandler - interface TouchTapEventHandler extends React.EventHandler { } - - interface ThemeWrapperProps extends React.Props { - theme: Styles.MuiTheme; - } - export class ThemeWrapper extends React.Component { - } - - export namespace Styles { - interface AutoPrefix { - all(styles: React.CSSProperties): React.CSSProperties; - set(style: React.CSSProperties, key: string, value: string | number): void; - single(key: string): string; - singleHyphened(key: string): string; - } - export var AutoPrefix: AutoPrefix; - - interface Spacing { - iconSize?: number; - - desktopGutter?: number; - desktopGutterMore?: number; - desktopGutterLess?: number; - desktopGutterMini?: number; - desktopKeylineIncrement?: number; - desktopDropDownMenuItemHeight?: number; - desktopDropDownMenuFontSize?: number; - desktopLeftNavMenuItemHeight?: number; - desktopSubheaderHeight?: number; - desktopToolbarHeight?: number; - } - export var Spacing: Spacing; - - interface ThemePalette { - primary1Color?: string; - primary2Color?: string; - primary3Color?: string; - accent1Color?: string; - accent2Color?: string; - accent3Color?: string; - textColor?: string; - alternateTextColor?: string; - canvasColor?: string; - borderColor?: string; - disabledColor?: string; - pickerHeaderColor?: string; - clockCircleColor?: string; - shadowColor?: string; - } - interface MuiTheme { - isRtl?: boolean; - userAgent?: any; - zIndex?: zIndex; - baseTheme?: RawTheme; - rawTheme?: RawTheme; - appBar?: { - color?: string, - textColor?: string, - height?: number, - }; - avatar?: { - borderColor?: string, - } - badge?: { - color?: string, - textColor?: string, - primaryColor?: string, - primaryTextColor?: string, - secondaryColor?: string, - secondaryTextColor?: string, - }, - button?: { - height?: number, - minWidth?: number, - iconButtonSize?: number, - }, - cardText?: { - textColor?: string, - }, - checkbox?: { - boxColor?: string, - checkedColor?: string, - requiredColor?: string, - disabledColor?: string, - labelColor?: string, - labelDisabledColor?: string, - }, - datePicker?: { - color?: string, - textColor?: string, - calendarTextColor?: string, - selectColor?: string, - selectTextColor?: string, - }, - dropDownMenu?: { - accentColor?: string, - }, - flatButton?: { - color?: string, - buttonFilterColor?: string, - disabledColor?: string, - textColor?: string, - primaryTextColor?: string, - secondaryTextColor?: string, - }, - floatingActionButton?: { - buttonSize?: number, - miniSize?: number, - color?: string, - iconColor?: string, - secondaryColor?: string, - secondaryIconColor?: string, - disabledColor?: string, - disabledTextColor?: string, - }, - gridTile?: { - textColor?: string, - }, - inkBar?: { - backgroundColor?: string, - }, - leftNav?: { - width?: number, - color?: string, - }, - listItem?: { - nestedLevelDepth?: number, - }, - menu?: { - backgroundColor?: string, - containerBackgroundColor?: string, - }, - menuItem?: { - dataHeight?: number, - height?: number, - hoverColor?: string, - padding?: number, - selectedTextColor?: string, - }, - menuSubheader?: { - padding?: number, - borderColor?: string, - textColor?: string, - }, - paper?: { - backgroundColor?: string, - zDepthShadows?: string[], - }, - radioButton?: { - borderColor?: string, - backgroundColor?: string, - checkedColor?: string, - requiredColor?: string, - disabledColor?: string, - size?: number, - labelColor?: string, - labelDisabledColor?: string, - }, - raisedButton?: { - color?: string, - textColor?: string, - primaryColor?: string, - primaryTextColor?: string, - secondaryColor?: string, - secondaryTextColor?: string, - disabledColor?: string, - disabledTextColor?: string, - }, - refreshIndicator?: { - strokeColor?: string, - loadingStrokeColor?: string, - }; - slider?: { - trackSize?: number, - trackColor?: string, - trackColorSelected?: string, - handleSize?: number, - handleSizeDisabled?: number, - handleSizeActive?: number, - handleColorZero?: string, - handleFillColor?: string, - selectionColor?: string, - rippleColor?: string, - }, - snackbar?: { - textColor?: string, - backgroundColor?: string, - actionColor?: string, - }, - table?: { - backgroundColor?: string; - }; - tableHeader?: { - borderColor?: string; - }; - tableHeaderColumn?: { - textColor?: string; - height?: number; - spacing?: number; - }; - tableFooter?: { - borderColor?: string; - textColor?: string; - }; - tableRow?: { - hoverColor?: string; - stripeColor?: string; - selectedColor?: string; - textColor?: string; - borderColor?: string; - height?: number; - }; - tableRowColumn?: { - height?: number; - spacing?: number; - }; - timePicker?: { - color?: string; - textColor?: string; - accentColor?: string; - clockColor?: string; - clockCircleColor?: string; - headerColor?: string; - selectColor?: string; - selectTextColor?: string; - }; - toggle?: { - thumbOnColor?: string, - thumbOffColor?: string, - thumbDisabledColor?: string, - thumbRequiredColor?: string, - trackOnColor?: string, - trackOffColor?: string, - trackDisabledColor?: string, - labelColor?: string, - labelDisabledColor?: string - trackRequiredColor?: string, - }, - toolbar?: { - backgroundColor?: string, - height?: number, - titleFontSize?: number, - iconColor?: string, - separatorColor?: string, - menuHoverColor?: string, - }; - tabs?: { - backgroundColor?: string, - textColor?: string, - selectedTextColor?: string, - }; - textField?: { - textColor?: string; - hintColor?: string; - floatingLabelColor?: string; - disabledTextColor?: string; - errorColor?: string; - focusColor?: string; - backgroundColor?: string; - borderColor?: string; - }; - } - - interface zIndex { - menu: number; - appBar: number; - leftNavOverlay: number; - leftNav: number; - dialogOverlay: number; - dialog: number; - layer: number; - popover: number; - snackbar: number; - tooltip: number; - } - export var zIndex: zIndex; - - interface RawTheme { - spacing?: Spacing; - fontFamily?: string; - palette?: ThemePalette; - zIndex?: zIndex; - } - var lightBaseTheme: RawTheme; - var darkBaseTheme: RawTheme; - - export function ThemeDecorator(muiTheme: Styles.MuiTheme): (Component: TFunction) => TFunction; - - export function getMuiTheme(baseTheme: RawTheme, muiTheme ?: MuiTheme): MuiTheme; - - interface ThemeManager { - getMuiTheme(baseTheme: RawTheme, muiTheme?: MuiTheme): MuiTheme; - modifyRawThemeSpacing(muiTheme: MuiTheme, newSpacing: Spacing): MuiTheme; - modifyRawThemePalette(muiTheme: MuiTheme, newPaletteKeys: ThemePalette): MuiTheme; - modifyRawThemeFontFamily(muiTheme: MuiTheme, newFontFamily: string): MuiTheme; - } - export var ThemeManager: ThemeManager; - - interface Transitions { - easeOut(duration?: string, property?: string | string[], delay?: string, easeFunction?: string): string; - create(duration?: string, property?: string, delay?: string, easeFunction?: string): string; - easeOutFunction: string; - easeInOutFunction: string; - } - export var Transitions: Transitions; - - interface Typography { - textFullBlack: string; - textDarkBlack: string; - textLightBlack: string; - textMinBlack: string; - textFullWhite: string; - textDarkWhite: string; - textLightWhite: string; - - // font weight - fontWeightLight: number; - fontWeightNormal: number; - fontWeightMedium: number; - - fontStyleButtonFontSize: number; - } - export var Typography: Typography; - - export var DarkRawTheme: RawTheme; - export var LightRawTheme: RawTheme; - } - - interface AppBarProps extends React.Props { - className?: string; - iconClassNameLeft?: string; - iconClassNameRight?: string; - iconElementLeft?: React.ReactElement; - iconElementRight?: React.ReactElement; - iconStyleRight?: string; - onLeftIconButtonTouchTap?: TouchTapEventHandler; - onRightIconButtonTouchTap?: TouchTapEventHandler; - onTitleTouchTap?: TouchTapEventHandler; - showMenuIconButton?: boolean; - style?: React.CSSProperties; - title?: React.ReactNode; - titleStyle?: React.CSSProperties; - zDepth?: number; - } - export class AppBar extends React.Component{ - } - - interface AppCanvasProps extends React.Props { - } - export class AppCanvas extends React.Component { - } - - interface Origin { - horizontal: string; // oneOf(['left', 'middle', 'right']) - vertical: string; // oneOf(['top', 'center', 'bottom']) - } - - type AutoCompleteDataItem = { text: string, value: React.ReactNode } | string; - type AutoCompleteDataSource = { text: string, value: React.ReactNode }[] | string[]; - interface AutoCompleteProps extends React.Props { - anchorOrigin?: Origin; - animated?: boolean; - dataSource?: AutoCompleteDataSource; - disableFocusRipple?: boolean; - errorStyle?: React.CSSProperties; - errorText?: string; - filter?: (searchText: string, key: string, item: AutoCompleteDataItem) => boolean; - floatingLabelText?: string; - fullWidth?: boolean; - hintText?: string; - listStyle?: React.CSSProperties; - menuCloseDelay?: number; - menuProps?: any; - menuStyle?: React.CSSProperties; - onNewRequest?: (chosenRequest: string, index: number) => void; - onUpdateInput?: (searchText: string, dataSource: AutoCompleteDataSource) => void; - open?: boolean; - searchText?: string; - /** @deprecated use noFilter instead */ - showAllItems?: boolean; - style?: React.CSSProperties; - targetOrigin?: Origin; - touchTapCloseDelay?: number; - triggerUpdateOnFocus?: boolean; - /** @deprecated updateWhenFocused has been renamed to triggerUpdateOnFocus */ - updateWhenFocused?: boolean; - } - export class AutoComplete extends React.Component { - static noFilter: () => boolean; - static defaultFilter: (searchText: string, key: string) => boolean; - static caseSensitiveFilter: (searchText: string, key: string) => boolean; - static caseInsensitiveFilter: (searchText: string, key: string) => boolean; - static levenshteinDistanceFilter(distanceLessThan: number): (searchText: string, key: string) => boolean; - static fuzzyFilter: (searchText: string, key: string) => boolean; - static Item: Menus.MenuItem; - static Divider: Divider; - } - - interface AvatarProps extends React.Props { - backgroundColor?: string; - className?: string; - color?: string; - icon?: React.ReactElement; - size?: number; - src?: string; - style?: React.CSSProperties; - } - export class Avatar extends React.Component { - } - - interface BadgeProps extends React.Props { - badgeContent: React.ReactNode; - badgeStyle?: React.CSSProperties; - className?: string; - primary?: boolean; - secondary?: boolean; - style?: React.CSSProperties; - } - export class Badge extends React.Component { - } - - interface BeforeAfterWrapperProps extends React.Props { - afterElementType?: string; - afterStyle?: React.CSSProperties; - beforeElementType?: string; - beforeStyle?: React.CSSProperties; - elementType?: string; - style?: React.CSSProperties; - } - export class BeforeAfterWrapper extends React.Component { - } - - // non generally overridden elements of EnhancedButton - interface SharedEnhancedButtonProps extends React.Props { - centerRipple?: boolean; - disableFocusRipple?: boolean; - disableKeyboardFocus?: boolean; - disableTouchRipple?: boolean; - focusRippleColor?: string; - focusRippleOpacity?: number; - keyboardFocused?: boolean; - linkButton?: boolean; - onBlur?: React.FocusEventHandler; - onFocus?: React.FocusEventHandler; - onKeyboardFocus?: (e: React.FocusEvent, isKeyboardFocused: boolean) => void; - onKeyDown?: React.KeyboardEventHandler; - onKeyUp?: React.KeyboardEventHandler; - onTouchTap?: TouchTapEventHandler; - style?: React.CSSProperties; - tabIndex?: number; - touchRippleColor?: string; - touchRippleOpacity?: number; - type?: string; - } - - interface EnhancedButtonProps extends React.HTMLAttributes, SharedEnhancedButtonProps { - // container element,